xref: /freebsd/contrib/elftoolchain/libelftc/libelftc.h (revision bbb29a3c0f2c4565eff6fda70426807b6ed97f8b)
1 /*-
2  * Copyright (c) 2009 Kai Wang
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer
10  *    in this position and unchanged.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD: users/kaiwang27/elftc/libelftc.h 392 2009-05-31 19:17:46Z kaiwang27 $
27  * $Id: libelftc.h 2863 2013-01-06 03:18:32Z jkoshy $
28  */
29 
30 #ifndef	_LIBELFTC_H_
31 #define	_LIBELFTC_H_
32 
33 #include <sys/stat.h>
34 
35 #include <libelf.h>
36 
37 typedef struct _Elftc_Bfd_Target Elftc_Bfd_Target;
38 typedef struct _Elftc_String_Table Elftc_String_Table;
39 
40 /* Target types. */
41 typedef enum {
42 	ETF_NONE,
43 	ETF_ELF,
44 	ETF_BINARY,
45 	ETF_SREC,
46 	ETF_IHEX
47 } Elftc_Bfd_Target_Flavor;
48 
49 /*
50  * Demangler flags.
51  */
52 
53 /* Name mangling style. */
54 #define	ELFTC_DEM_UNKNOWN	0x00000000U /* Not specified. */
55 #define	ELFTC_DEM_ARM		0x00000001U /* C++ Ann. Ref. Manual. */
56 #define	ELFTC_DEM_GNU2		0x00000002U /* GNU version 2. */
57 #define	ELFTC_DEM_GNU3		0x00000004U /* GNU version 3. */
58 
59 /* Demangling behaviour control. */
60 #define ELFTC_DEM_NOPARAM	0x00010000U
61 
62 __BEGIN_DECLS
63 Elftc_Bfd_Target	*elftc_bfd_find_target(const char *_tgt_name);
64 Elftc_Bfd_Target_Flavor	 elftc_bfd_target_flavor(Elftc_Bfd_Target *_tgt);
65 unsigned int	elftc_bfd_target_byteorder(Elftc_Bfd_Target *_tgt);
66 unsigned int	elftc_bfd_target_class(Elftc_Bfd_Target *_tgt);
67 unsigned int	elftc_bfd_target_machine(Elftc_Bfd_Target *_tgt);
68 int		elftc_copyfile(int _srcfd,  int _dstfd);
69 int		elftc_demangle(const char *_mangledname, char *_buffer,
70     size_t _bufsize, unsigned int _flags);
71 int		elftc_set_timestamps(const char *_filename, struct stat *_sb);
72 Elftc_String_Table	*elftc_string_table_create(int _hint);
73 void		elftc_string_table_destroy(Elftc_String_Table *_table);
74 Elftc_String_Table	*elftc_string_table_from_section(Elf_Scn *_scn,
75     int _hint);
76 const char	*elftc_string_table_image(Elftc_String_Table *_table,
77     size_t *_sz);
78 size_t		elftc_string_table_insert(Elftc_String_Table *_table,
79     const char *_string);
80 size_t		elftc_string_table_lookup(Elftc_String_Table *_table,
81     const char *_string);
82 int		elftc_string_table_remove(Elftc_String_Table *_table,
83     const char *_string);
84 const char	*elftc_string_table_to_string(Elftc_String_Table *_table,
85     size_t offset);
86 const char	*elftc_version(void);
87 __END_DECLS
88 
89 #endif	/* _LIBELFTC_H_ */
90