_libdwarf.h revision 1.3
1/*	$NetBSD: _libdwarf.h,v 1.3 2016/02/20 02:43:41 christos Exp $	*/
2
3/*-
4 * Copyright (c) 2007 John Birrell (jb@freebsd.org)
5 * Copyright (c) 2009-2014 Kai Wang
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * Id: _libdwarf.h 3298 2016-01-09 15:43:31Z jkoshy
30 */
31
32#ifndef	__LIBDWARF_H_
33#define	__LIBDWARF_H_
34
35#if HAVE_NBTOOL_CONFIG_H
36# include "nbtool_config.h"
37#endif
38
39#include <sys/param.h>
40#include <sys/queue.h>
41#include <assert.h>
42#include <limits.h>
43#include <stdio.h>
44#include <stdlib.h>
45#include <string.h>
46#include <gelf.h>
47#include "dwarf.h"
48#include "libdwarf.h"
49#include "uthash.h"
50
51#include "_elftc.h"
52
53#define DWARF_DIE_HASH_SIZE		8191
54
55struct _libdwarf_globals {
56	Dwarf_Handler	errhand;
57	Dwarf_Ptr	errarg;
58	int		applyreloc;
59};
60
61extern struct _libdwarf_globals _libdwarf;
62
63#define	_DWARF_SET_ERROR(_d, _e, _err, _elf_err)			\
64	_dwarf_set_error(_d, _e, _err, _elf_err, __func__, __LINE__)
65#define	DWARF_SET_ERROR(_d, _e, _err)					\
66	_DWARF_SET_ERROR(_d, _e, _err, 0)
67#define	DWARF_SET_ELF_ERROR(_d, _e)					\
68	_DWARF_SET_ERROR(_d, _e, DW_DLE_ELF, elf_errno())
69
70/*
71 * Convenient macros for producer bytes stream generation.
72 */
73#define	WRITE_VALUE(value, bytes)					\
74	dbg->write_alloc(&ds->ds_data, &ds->ds_cap, &ds->ds_size,	\
75	    (value), (bytes), error)
76#define	WRITE_ULEB128(value)						\
77	_dwarf_write_uleb128_alloc(&ds->ds_data, &ds->ds_cap,		\
78	    &ds->ds_size, (value), error)
79#define	WRITE_SLEB128(value)						\
80	_dwarf_write_sleb128_alloc(&ds->ds_data, &ds->ds_cap,		\
81	    &ds->ds_size, (value), error)
82#define	WRITE_STRING(string)						\
83	_dwarf_write_string_alloc(&ds->ds_data, &ds->ds_cap,		\
84	    &ds->ds_size, (string), error)
85#define	WRITE_BLOCK(blk, size)						\
86	_dwarf_write_block_alloc(&ds->ds_data, &ds->ds_cap,		\
87	    &ds->ds_size, (blk), (size), error)
88#define	WRITE_PADDING(byte, cnt)					\
89	_dwarf_write_padding_alloc(&ds->ds_data, &ds->ds_cap,		\
90	    &ds->ds_size, (byte), (cnt), error)
91#define	RCHECK(expr)							\
92	do {								\
93		ret = expr;						\
94		if (ret != DW_DLE_NONE)					\
95			goto gen_fail;					\
96	} while (/*CONSTCOND*/0)
97
98typedef struct _Dwarf_CU *Dwarf_CU;
99
100struct _Dwarf_AttrDef {
101	Dwarf_Half	ad_attrib;		/* DW_AT_XXX */
102	Dwarf_Half	ad_form;		/* DW_FORM_XXX */
103	uint64_t	ad_offset;		/* Offset in abbrev section. */
104	STAILQ_ENTRY(_Dwarf_AttrDef) ad_next;	/* Next attribute define. */
105};
106
107struct _Dwarf_Attribute {
108	Dwarf_Die		at_die;		/* Ptr to containing DIE. */
109	Dwarf_Die		at_refdie;	/* Ptr to reference DIE. */
110	uint64_t		at_offset;	/* Offset in info section. */
111	Dwarf_Half		at_attrib;	/* DW_AT_XXX */
112	Dwarf_Half		at_form;	/* DW_FORM_XXX */
113	int			at_indirect;	/* Has indirect form. */
114	union {
115		uint64_t	u64;		/* Unsigned value. */
116		int64_t		s64;		/* Signed value. */
117		char		*s;   		/* String. */
118		uint8_t		*u8p;		/* Block data. */
119	} u[2];					/* Value. */
120	Dwarf_Block		at_block;	/* Block. */
121	Dwarf_Locdesc		*at_ld;		/* at value is locdesc. */
122	Dwarf_P_Expr		at_expr;	/* at value is expr. */
123	uint64_t		at_relsym;	/* Relocation symbol index. */
124	const char		*at_relsec;	/* Rel. to dwarf section. */
125	STAILQ_ENTRY(_Dwarf_Attribute) at_next;	/* Next attribute. */
126};
127
128struct _Dwarf_Abbrev {
129	uint64_t	ab_entry;	/* Abbrev entry. */
130	uint64_t	ab_tag;		/* Tag: DW_TAG_ */
131	uint8_t		ab_children;	/* DW_CHILDREN_no or DW_CHILDREN_yes */
132	uint64_t	ab_offset;	/* Offset in abbrev section. */
133	uint64_t	ab_length;	/* Length of this abbrev entry. */
134	uint64_t	ab_atnum;	/* Number of attribute defines. */
135	UT_hash_handle	ab_hh;		/* Uthash handle. */
136	STAILQ_HEAD(, _Dwarf_AttrDef) ab_attrdef; /* List of attribute defs. */
137};
138
139struct _Dwarf_Die {
140	Dwarf_Die	die_parent;	/* Parent DIE. */
141	Dwarf_Die	die_child;	/* First child DIE. */
142	Dwarf_Die	die_left;	/* Left sibling DIE. */
143	Dwarf_Die	die_right;	/* Right sibling DIE. */
144	uint64_t	die_offset;	/* DIE offset in section. */
145	uint64_t	die_next_off;	/* Next DIE offset in section. */
146	uint64_t	die_abnum;	/* Abbrev number. */
147	Dwarf_Abbrev	die_ab;		/* Abbrev pointer. */
148	Dwarf_Tag	die_tag;	/* DW_TAG_ */
149	Dwarf_Debug	die_dbg;	/* Dwarf_Debug pointer. */
150	Dwarf_CU	die_cu;		/* Compilation unit pointer. */
151	char		*die_name;	/* Ptr to the name string. */
152	Dwarf_Attribute	*die_attrarray;	/* Array of attributes. */
153	STAILQ_HEAD(, _Dwarf_Attribute)	die_attr; /* List of attributes. */
154	STAILQ_ENTRY(_Dwarf_Die) die_pro_next; /* Next die in pro-die list. */
155};
156
157struct _Dwarf_P_Expr_Entry {
158	Dwarf_Loc	ee_loc;		/* Location expression. */
159	Dwarf_Unsigned	ee_sym;		/* Optional related reloc sym index. */
160	STAILQ_ENTRY(_Dwarf_P_Expr_Entry) ee_next; /* Next entry in list. */
161};
162
163struct _Dwarf_P_Expr {
164	Dwarf_Debug	pe_dbg;		/* Dwarf_Debug pointer. */
165	uint8_t		*pe_block;	/* Expression block data. */
166	int		pe_invalid;	/* Block data is up-to-date or not. */
167	Dwarf_Unsigned	pe_length;	/* Length of the block. */
168	STAILQ_HEAD(, _Dwarf_P_Expr_Entry) pe_eelist; /* List of entries. */
169	STAILQ_ENTRY(_Dwarf_P_Expr) pe_next; /* Next expr in list. */
170};
171
172struct _Dwarf_Line {
173	Dwarf_LineInfo	ln_li;		/* Ptr to line info. */
174	Dwarf_Addr	ln_addr;	/* Line address. */
175	Dwarf_Unsigned	ln_symndx;	/* Symbol index for relocation. */
176	Dwarf_Unsigned	ln_fileno;	/* File number. */
177	Dwarf_Unsigned	ln_lineno;	/* Line number. */
178	Dwarf_Signed	ln_column;	/* Column number. */
179	Dwarf_Bool	ln_bblock;	/* Basic block flag. */
180	Dwarf_Bool	ln_stmt;	/* Begin statement flag. */
181	Dwarf_Bool	ln_endseq;	/* End sequence flag. */
182	STAILQ_ENTRY(_Dwarf_Line) ln_next; /* Next line in list. */
183};
184
185struct _Dwarf_LineFile {
186	char		*lf_fname;	/* Filename. */
187	char		*lf_fullpath;	/* Full pathname of the file. */
188	Dwarf_Unsigned	lf_dirndx;	/* Dir index. */
189	Dwarf_Unsigned	lf_mtime;	/* Modification time. */
190	Dwarf_Unsigned	lf_size;	/* File size. */
191	STAILQ_ENTRY(_Dwarf_LineFile) lf_next; /* Next file in list. */
192};
193
194struct _Dwarf_LineInfo {
195	Dwarf_Unsigned	li_length;	/* Length of line info data. */
196	Dwarf_Half	li_version;	/* Version of line info. */
197	Dwarf_Unsigned	li_hdrlen;	/* Length of line info header. */
198	Dwarf_Small	li_minlen;	/* Minimum instrutction length. */
199	Dwarf_Small	li_maxop;	/* Maximum operations per inst. */
200	Dwarf_Small	li_defstmt;	/* Default value of is_stmt. */
201	int8_t		li_lbase;    	/* Line base for special opcode. */
202	Dwarf_Small	li_lrange;    	/* Line range for special opcode. */
203	Dwarf_Small	li_opbase;	/* Fisrt std opcode number. */
204	Dwarf_Small	*li_oplen;	/* Array of std opcode len. */
205	char		**li_incdirs;	/* Array of include dirs. */
206	Dwarf_Unsigned	li_inclen;	/* Length of inc dir array. */
207	char		**li_lfnarray;	/* Array of file names. */
208	Dwarf_Unsigned	li_lflen;	/* Length of filename array. */
209	STAILQ_HEAD(, _Dwarf_LineFile) li_lflist; /* List of files. */
210	Dwarf_Line	*li_lnarray;	/* Array of lines. */
211	Dwarf_Unsigned	li_lnlen;	/* Length of the line array. */
212	STAILQ_HEAD(, _Dwarf_Line) li_lnlist; /* List of lines. */
213};
214
215struct _Dwarf_NamePair {
216	Dwarf_NameTbl	np_nt;		/* Ptr to containing name table. */
217	Dwarf_Die	np_die;		/* Ptr to Ref. Die. */
218	Dwarf_Unsigned	np_offset;	/* Offset in CU. */
219	char		*np_name;	/* Object/Type name. */
220	STAILQ_ENTRY(_Dwarf_NamePair) np_next; /* Next pair in the list. */
221};
222
223struct _Dwarf_NameTbl {
224	Dwarf_Unsigned	nt_length;	/* Name lookup table length. */
225	Dwarf_Half	nt_version;	/* Name lookup table version. */
226	Dwarf_CU	nt_cu;		/* Ptr to Ref. CU. */
227	Dwarf_Off	nt_cu_offset;	/* Ref. CU offset in .debug_info */
228	Dwarf_Unsigned	nt_cu_length;	/* Ref. CU length. */
229	STAILQ_HEAD(, _Dwarf_NamePair) nt_nplist; /* List of offset+name pairs. */
230	STAILQ_ENTRY(_Dwarf_NameTbl) nt_next; /* Next name table in the list. */
231};
232
233struct _Dwarf_NameSec {
234	STAILQ_HEAD(, _Dwarf_NameTbl) ns_ntlist; /* List of name tables. */
235	Dwarf_NamePair	*ns_array;	/* Array of pairs of all tables. */
236	Dwarf_Unsigned	ns_len;		/* Length of the pair array. */
237};
238
239struct _Dwarf_Fde {
240	Dwarf_Debug	fde_dbg;	/* Ptr to containing dbg. */
241	Dwarf_Cie	fde_cie;	/* Ptr to associated CIE. */
242	Dwarf_FrameSec	fde_fs;		/* Ptr to containing .debug_frame. */
243	Dwarf_Ptr	fde_addr;	/* Ptr to start of the FDE. */
244	Dwarf_Unsigned	fde_offset;	/* Offset of the FDE. */
245	Dwarf_Unsigned	fde_length;	/* Length of the FDE. */
246	Dwarf_Unsigned	fde_cieoff;	/* Offset of associated CIE. */
247	Dwarf_Unsigned	fde_initloc;	/* Initial location. */
248	Dwarf_Unsigned	fde_adrange;	/* Address range. */
249	Dwarf_Unsigned	fde_auglen;	/* Augmentation length. */
250	uint8_t		*fde_augdata;	/* Augmentation data. */
251	uint8_t		*fde_inst;	/* Instructions. */
252	Dwarf_Unsigned	fde_instlen;	/* Length of instructions. */
253	Dwarf_Unsigned	fde_instcap;	/* Capacity of inst buffer. */
254	Dwarf_Unsigned	fde_symndx;	/* Symbol index for relocation. */
255	Dwarf_Unsigned	fde_esymndx;	/* End symbol index for relocation. */
256	Dwarf_Addr	fde_eoff;	/* Offset from the end symbol. */
257	STAILQ_ENTRY(_Dwarf_Fde) fde_next; /* Next FDE in list. */
258};
259
260struct _Dwarf_Cie {
261	Dwarf_Debug	cie_dbg;	/* Ptr to containing dbg. */
262	Dwarf_Unsigned	cie_index;	/* Index of the CIE. */
263	Dwarf_Unsigned	cie_offset;	/* Offset of the CIE. */
264	Dwarf_Unsigned	cie_length;	/* Length of the CIE. */
265	Dwarf_Half	cie_version;	/* CIE version. */
266	uint8_t		*cie_augment;	/* CIE augmentation (UTF-8). */
267	Dwarf_Unsigned	cie_ehdata;	/* Optional EH Data. */
268	uint8_t		cie_addrsize;	/* Address size. (DWARF4) */
269	uint8_t		cie_segmentsize; /* Segment size. (DWARF4) */
270	Dwarf_Unsigned	cie_caf;	/* Code alignment factor. */
271	Dwarf_Signed	cie_daf;	/* Data alignment factor. */
272	Dwarf_Unsigned	cie_ra;		/* Return address register. */
273	Dwarf_Unsigned	cie_auglen;	/* Augmentation length. */
274	uint8_t		*cie_augdata;	/* Augmentation data; */
275	uint8_t		cie_fde_encode; /* FDE PC start/range encode. */
276	Dwarf_Ptr	cie_initinst;	/* Initial instructions. */
277	Dwarf_Unsigned	cie_instlen;	/* Length of init instructions. */
278	STAILQ_ENTRY(_Dwarf_Cie) cie_next;  /* Next CIE in list. */
279};
280
281struct _Dwarf_FrameSec {
282	STAILQ_HEAD(, _Dwarf_Cie) fs_cielist; /* List of CIE. */
283	STAILQ_HEAD(, _Dwarf_Fde) fs_fdelist; /* List of FDE. */
284	Dwarf_Cie	*fs_ciearray;	/* Array of CIE. */
285	Dwarf_Unsigned	fs_cielen;	/* Length of CIE array. */
286	Dwarf_Fde	*fs_fdearray;	/* Array of FDE.*/
287	Dwarf_Unsigned	fs_fdelen;	/* Length of FDE array. */
288};
289
290struct _Dwarf_Arange {
291	Dwarf_ArangeSet	ar_as;		/* Ptr to the set it belongs to. */
292	Dwarf_Unsigned	ar_address;	/* Start PC. */
293	Dwarf_Unsigned	ar_range;	/* PC range. */
294	Dwarf_Unsigned	ar_symndx;	/* First symbol index for reloc. */
295	Dwarf_Unsigned	ar_esymndx;	/* Second symbol index for reloc. */
296	Dwarf_Addr	ar_eoff;	/* Offset from second symbol. */
297	STAILQ_ENTRY(_Dwarf_Arange) ar_next; /* Next arange in list. */
298};
299
300struct _Dwarf_ArangeSet {
301	Dwarf_Unsigned	as_length;	/* Length of the arange set. */
302	Dwarf_Half	as_version;	/* Version of the arange set. */
303	Dwarf_Off	as_cu_offset;	/* Offset of associated CU. */
304	Dwarf_CU	as_cu;		/* Ptr to associated CU. */
305	Dwarf_Small	as_addrsz;	/* Target address size. */
306	Dwarf_Small	as_segsz;	/* Target segment size. */
307	STAILQ_HEAD (, _Dwarf_Arange) as_arlist; /* List of ae entries. */
308	STAILQ_ENTRY(_Dwarf_ArangeSet) as_next; /* Next set in list. */
309};
310
311struct _Dwarf_MacroSet {
312	Dwarf_Macro_Details *ms_mdlist; /* Array of macinfo entries. */
313	Dwarf_Unsigned	ms_cnt;		/* Length of the array. */
314	STAILQ_ENTRY(_Dwarf_MacroSet) ms_next; /* Next set in list. */
315};
316
317struct _Dwarf_Rangelist {
318	Dwarf_CU	rl_cu;		/* Ptr to associated CU. */
319	Dwarf_Unsigned	rl_offset;	/* Offset of the rangelist. */
320	Dwarf_Ranges	*rl_rgarray;	/* Array of ranges. */
321	Dwarf_Unsigned	rl_rglen;	/* Length of the ranges array. */
322	STAILQ_ENTRY(_Dwarf_Rangelist) rl_next; /* Next rangelist in list. */
323};
324
325struct _Dwarf_CU {
326	Dwarf_Debug	cu_dbg;		/* Ptr to containing dbg. */
327	Dwarf_Off	cu_offset;	/* Offset to the this CU. */
328	uint32_t	cu_length;	/* Length of CU data. */
329	uint16_t	cu_length_size; /* Size in bytes of the length field. */
330	uint16_t	cu_version;	/* DWARF version. */
331	uint64_t	cu_abbrev_offset; /* Offset into .debug_abbrev. */
332	uint64_t	cu_abbrev_offset_cur; /* Current abbrev offset. */
333	int		cu_abbrev_loaded; /* Abbrev table parsed. */
334	uint64_t	cu_abbrev_cnt;	/* Abbrev entry count. */
335	uint64_t	cu_lineno_offset; /* Offset into .debug_lineno. */
336	uint8_t		cu_pointer_size;/* Number of bytes in pointer. */
337	uint8_t		cu_dwarf_size;	/* CU section dwarf size. */
338	Dwarf_Sig8	cu_type_sig;	/* Type unit's signature. */
339	uint64_t	cu_type_offset; /* Type unit's type offset. */
340	Dwarf_Off	cu_next_offset; /* Offset to the next CU. */
341	uint64_t	cu_1st_offset;	/* First DIE offset. */
342	int		cu_pass2;	/* Two pass DIE traverse. */
343	Dwarf_LineInfo	cu_lineinfo;	/* Ptr to Dwarf_LineInfo. */
344	Dwarf_Abbrev	cu_abbrev_hash; /* Abbrev hash table. */
345	Dwarf_Bool	cu_is_info;	/* Compilation/type unit flag. */
346	STAILQ_ENTRY(_Dwarf_CU) cu_next; /* Next compilation unit. */
347};
348
349typedef struct _Dwarf_Section {
350	const char	*ds_name;	/* Section name. */
351	Dwarf_Small	*ds_data;	/* Section data. */
352	Dwarf_Unsigned	ds_addr;	/* Section virtual addr. */
353	Dwarf_Unsigned	ds_size;	/* Section size. */
354} Dwarf_Section;
355
356typedef struct _Dwarf_P_Section {
357	char		*ds_name;	/* Section name. */
358	Dwarf_Small	*ds_data;	/* Section data. */
359	Dwarf_Unsigned	ds_size;	/* Section size. */
360	Dwarf_Unsigned	ds_cap;		/* Section capacity. */
361	Dwarf_Unsigned	ds_ndx;		/* ELF section index. */
362	Dwarf_Unsigned	ds_symndx;	/* Section symbol index. (for reloc) */
363	STAILQ_ENTRY(_Dwarf_P_Section) ds_next; /* Next section in the list. */
364} *Dwarf_P_Section;
365
366typedef struct _Dwarf_Rel_Entry {
367	unsigned char	dre_type;	/* Reloc type. */
368	unsigned char	dre_length;	/* Reloc storage unit length. */
369	Dwarf_Unsigned	dre_offset;	/* Reloc storage unit offset. */
370	Dwarf_Unsigned	dre_addend;	/* Reloc addend. */
371	Dwarf_Unsigned	dre_symndx;	/* Reloc symbol index. */
372	const char	*dre_secname;	/* Refer to some debug section. */
373	STAILQ_ENTRY(_Dwarf_Rel_Entry) dre_next; /* Next reloc entry. */
374} *Dwarf_Rel_Entry;
375
376typedef struct _Dwarf_Rel_Section {
377	struct _Dwarf_P_Section *drs_ds; /* Ptr to actual reloc ELF section. */
378	struct _Dwarf_P_Section *drs_ref; /* Which debug section it refers. */
379	struct Dwarf_Relocation_Data_s *drs_drd; /* Reloc data array. */
380	STAILQ_HEAD(, _Dwarf_Rel_Entry) drs_dre; /* Reloc entry list. */
381	Dwarf_Unsigned	drs_drecnt;	/* Count of entries. */
382	Dwarf_Unsigned	drs_size;	/* Size of ELF section in bytes. */
383	int		drs_addend;	/* Elf_Rel or Elf_Rela */
384	STAILQ_ENTRY(_Dwarf_Rel_Section) drs_next; /* Next reloc section. */
385} *Dwarf_Rel_Section;
386
387typedef struct {
388	Elf_Data *ed_data;
389	void *ed_alloc;
390} Dwarf_Elf_Data;
391
392typedef struct {
393	Elf		*eo_elf;
394	GElf_Ehdr	eo_ehdr;
395	GElf_Shdr	*eo_shdr;
396	Dwarf_Elf_Data	*eo_data;
397	Dwarf_Unsigned	eo_seccnt;
398	size_t		eo_strndx;
399	Dwarf_Obj_Access_Methods eo_methods;
400} Dwarf_Elf_Object;
401
402struct _Dwarf_Debug {
403	Dwarf_Obj_Access_Interface *dbg_iface;
404	Dwarf_Section	*dbg_section;	/* Dwarf section list. */
405	Dwarf_Section	*dbg_info_sec;	/* Pointer to info section. */
406	Dwarf_Off	dbg_info_off;	/* Current info section offset. */
407	Dwarf_Section	*dbg_types_sec; /* Pointer to type section. */
408	Dwarf_Off	dbg_types_off;	/* Current types section offset. */
409	Dwarf_Unsigned	dbg_seccnt;	/* Total number of dwarf sections. */
410	int		dbg_mode;	/* Access mode. */
411	int		dbg_pointer_size; /* Object address size. */
412	int		dbg_offset_size;  /* DWARF offset size. */
413	int		dbg_info_loaded; /* Flag indicating all CU loaded. */
414	int		dbg_types_loaded; /* Flag indicating all TU loaded. */
415	Dwarf_Half	dbg_machine;	/* ELF machine architecture. */
416	Dwarf_Handler	dbg_errhand;	/* Error handler. */
417	Dwarf_Ptr	dbg_errarg;	/* Argument to the error handler. */
418	STAILQ_HEAD(, _Dwarf_CU) dbg_cu;/* List of compilation units. */
419	STAILQ_HEAD(, _Dwarf_CU) dbg_tu;/* List of type units. */
420	Dwarf_CU	dbg_cu_current; /* Ptr to the current CU. */
421	Dwarf_CU	dbg_tu_current; /* Ptr to the current TU. */
422	Dwarf_NameSec	dbg_globals;	/* Ptr to pubnames lookup section. */
423	Dwarf_NameSec	dbg_pubtypes;	/* Ptr to pubtypes lookup section. */
424	Dwarf_NameSec	dbg_weaks;	/* Ptr to weaknames lookup section. */
425	Dwarf_NameSec	dbg_funcs;	/* Ptr to static funcs lookup sect. */
426	Dwarf_NameSec	dbg_vars;	/* Ptr to static vars lookup sect. */
427	Dwarf_NameSec	dbg_types;	/* Ptr to types lookup section. */
428	Dwarf_FrameSec	dbg_frame;	/* Ptr to .debug_frame section. */
429	Dwarf_FrameSec	dbg_eh_frame;	/* Ptr to .eh_frame section. */
430	STAILQ_HEAD(, _Dwarf_ArangeSet) dbg_aslist; /* List of arange set. */
431	Dwarf_Arange	*dbg_arange_array; /* Array of arange. */
432	Dwarf_Unsigned	dbg_arange_cnt;	/* Length of the arange array. */
433	char		*dbg_strtab;	/* Dwarf string table. */
434	Dwarf_Unsigned	dbg_strtab_cap; /* Dwarf string table capacity. */
435	Dwarf_Unsigned	dbg_strtab_size; /* Dwarf string table size. */
436	STAILQ_HEAD(, _Dwarf_MacroSet) dbg_mslist; /* List of macro set. */
437	STAILQ_HEAD(, _Dwarf_Rangelist) dbg_rllist; /* List of rangelist. */
438	uint64_t	(*read)(uint8_t *, uint64_t *, int);
439	void		(*write)(uint8_t *, uint64_t *, uint64_t, int);
440	int		(*write_alloc)(uint8_t **, uint64_t *, uint64_t *,
441			    uint64_t, int, Dwarf_Error *);
442	uint64_t	(*decode)(uint8_t **, int);
443
444	Dwarf_Half	dbg_frame_rule_table_size;
445	Dwarf_Half	dbg_frame_rule_initial_value;
446	Dwarf_Half	dbg_frame_cfa_value;
447	Dwarf_Half	dbg_frame_same_value;
448	Dwarf_Half	dbg_frame_undefined_value;
449
450	Dwarf_Regtable3	*dbg_internal_reg_table;
451
452	/*
453	 * Fields used by libdwarf producer.
454	 */
455
456	Dwarf_Unsigned	dbgp_flags;
457	Dwarf_Unsigned	dbgp_isa;
458	Dwarf_Callback_Func dbgp_func;
459	Dwarf_Callback_Func_b dbgp_func_b;
460	Dwarf_Die	dbgp_root_die;
461	STAILQ_HEAD(, _Dwarf_Die) dbgp_dielist;
462	STAILQ_HEAD(, _Dwarf_P_Expr) dbgp_pelist;
463	Dwarf_LineInfo	dbgp_lineinfo;
464	Dwarf_ArangeSet dbgp_as;
465	Dwarf_Macro_Details *dbgp_mdlist;
466	Dwarf_Unsigned	dbgp_mdcnt;
467	STAILQ_HEAD(, _Dwarf_Cie) dbgp_cielist;
468	STAILQ_HEAD(, _Dwarf_Fde) dbgp_fdelist;
469	Dwarf_Unsigned	dbgp_cielen;
470	Dwarf_Unsigned	dbgp_fdelen;
471	Dwarf_NameTbl	dbgp_pubs;
472	Dwarf_NameTbl	dbgp_weaks;
473	Dwarf_NameTbl	dbgp_funcs;
474	Dwarf_NameTbl	dbgp_types;
475	Dwarf_NameTbl	dbgp_vars;
476	STAILQ_HEAD(, _Dwarf_P_Section) dbgp_seclist;
477	Dwarf_Unsigned	dbgp_seccnt;
478	Dwarf_P_Section	dbgp_secpos;
479	Dwarf_P_Section	dbgp_info;
480	STAILQ_HEAD(, _Dwarf_Rel_Section) dbgp_drslist;
481	Dwarf_Unsigned	dbgp_drscnt;
482	Dwarf_Rel_Section dbgp_drspos;
483};
484
485/*
486 * Internal function prototypes.
487 */
488
489int		_dwarf_abbrev_add(Dwarf_CU, uint64_t, uint64_t, uint8_t,
490		    uint64_t, Dwarf_Abbrev *, Dwarf_Error *);
491void		_dwarf_abbrev_cleanup(Dwarf_CU);
492int		_dwarf_abbrev_find(Dwarf_CU, uint64_t, Dwarf_Abbrev *,
493		    Dwarf_Error *);
494int		_dwarf_abbrev_gen(Dwarf_P_Debug, Dwarf_Error *);
495int		_dwarf_abbrev_parse(Dwarf_Debug, Dwarf_CU, Dwarf_Unsigned *,
496		    Dwarf_Abbrev *, Dwarf_Error *);
497int		_dwarf_add_AT_dataref(Dwarf_P_Debug, Dwarf_P_Die, Dwarf_Half,
498		    Dwarf_Unsigned, Dwarf_Unsigned, const char *,
499		    Dwarf_P_Attribute *, Dwarf_Error *);
500int		_dwarf_add_string_attr(Dwarf_P_Die, Dwarf_P_Attribute *,
501		    Dwarf_Half, char *, Dwarf_Error *);
502int		_dwarf_alloc(Dwarf_Debug *, int, Dwarf_Error *);
503void		_dwarf_arange_cleanup(Dwarf_Debug);
504int		_dwarf_arange_gen(Dwarf_P_Debug, Dwarf_Error *);
505int		_dwarf_arange_init(Dwarf_Debug, Dwarf_Error *);
506void		_dwarf_arange_pro_cleanup(Dwarf_P_Debug);
507int		_dwarf_attr_alloc(Dwarf_Die, Dwarf_Attribute *, Dwarf_Error *);
508Dwarf_Attribute	_dwarf_attr_find(Dwarf_Die, Dwarf_Half);
509int		_dwarf_attr_gen(Dwarf_P_Debug, Dwarf_P_Section, Dwarf_Rel_Section,
510		    Dwarf_CU, Dwarf_Die, int, Dwarf_Error *);
511int		_dwarf_attr_init(Dwarf_Debug, Dwarf_Section *, uint64_t *, int,
512		    Dwarf_CU, Dwarf_Die, Dwarf_AttrDef, uint64_t, int,
513		    Dwarf_Error *);
514int		_dwarf_attrdef_add(Dwarf_Debug, Dwarf_Abbrev, uint64_t,
515		    uint64_t, uint64_t, Dwarf_AttrDef *, Dwarf_Error *);
516uint64_t	_dwarf_decode_lsb(uint8_t **, int);
517uint64_t	_dwarf_decode_msb(uint8_t **, int);
518int64_t		_dwarf_decode_sleb128(uint8_t **);
519uint64_t	_dwarf_decode_uleb128(uint8_t **);
520void		_dwarf_deinit(Dwarf_Debug);
521int		_dwarf_die_alloc(Dwarf_Debug, Dwarf_Die *, Dwarf_Error *);
522int		_dwarf_die_count_links(Dwarf_P_Die, Dwarf_P_Die,
523		    Dwarf_P_Die, Dwarf_P_Die);
524Dwarf_Die	_dwarf_die_find(Dwarf_Die, Dwarf_Unsigned);
525int		_dwarf_die_gen(Dwarf_P_Debug, Dwarf_CU, Dwarf_Rel_Section,
526		    Dwarf_Error *);
527void		_dwarf_die_link(Dwarf_P_Die, Dwarf_P_Die, Dwarf_P_Die,
528		    Dwarf_P_Die, Dwarf_P_Die);
529int		_dwarf_die_parse(Dwarf_Debug, Dwarf_Section *, Dwarf_CU, int,
530		    uint64_t, uint64_t, Dwarf_Die *, int, Dwarf_Error *);
531void		_dwarf_die_pro_cleanup(Dwarf_P_Debug);
532void		_dwarf_elf_deinit(Dwarf_Debug);
533int		_dwarf_elf_init(Dwarf_Debug, Elf *, Dwarf_Error *);
534int		_dwarf_elf_load_section(void *, Dwarf_Half, Dwarf_Small **,
535		    int *);
536Dwarf_Endianness _dwarf_elf_get_byte_order(void *);
537Dwarf_Small	_dwarf_elf_get_length_size(void *);
538Dwarf_Small	_dwarf_elf_get_pointer_size(void *);
539Dwarf_Unsigned	_dwarf_elf_get_section_count(void *);
540int		_dwarf_elf_get_section_info(void *, Dwarf_Half,
541		    Dwarf_Obj_Access_Section *, int *);
542void		_dwarf_expr_cleanup(Dwarf_P_Debug);
543int		_dwarf_expr_into_block(Dwarf_P_Expr, Dwarf_Error *);
544Dwarf_Section	*_dwarf_find_next_types_section(Dwarf_Debug, Dwarf_Section *);
545Dwarf_Section	*_dwarf_find_section(Dwarf_Debug, const char *);
546void		_dwarf_frame_cleanup(Dwarf_Debug);
547int		_dwarf_frame_fde_add_inst(Dwarf_P_Fde, Dwarf_Small,
548		    Dwarf_Unsigned, Dwarf_Unsigned, Dwarf_Error *);
549int		_dwarf_frame_gen(Dwarf_P_Debug, Dwarf_Error *);
550int		_dwarf_frame_get_fop(Dwarf_Debug, uint8_t, uint8_t *,
551		    Dwarf_Unsigned, Dwarf_Frame_Op **, Dwarf_Signed *,
552		    Dwarf_Error *);
553int		_dwarf_frame_get_internal_table(Dwarf_Fde, Dwarf_Addr,
554		    Dwarf_Regtable3 **, Dwarf_Addr *, Dwarf_Error *);
555int		_dwarf_frame_interal_table_init(Dwarf_Debug, Dwarf_Error *);
556void		_dwarf_frame_params_init(Dwarf_Debug);
557void		_dwarf_frame_pro_cleanup(Dwarf_P_Debug);
558int		_dwarf_frame_regtable_copy(Dwarf_Debug, Dwarf_Regtable3 **,
559		    Dwarf_Regtable3 *, Dwarf_Error *);
560int		_dwarf_frame_section_load(Dwarf_Debug, Dwarf_Error *);
561int		_dwarf_frame_section_load_eh(Dwarf_Debug, Dwarf_Error *);
562int		_dwarf_generate_sections(Dwarf_P_Debug, Dwarf_Error *);
563Dwarf_Unsigned	_dwarf_get_reloc_type(Dwarf_P_Debug, int);
564int		_dwarf_get_reloc_size(Dwarf_Debug, Dwarf_Unsigned);
565void		_dwarf_info_cleanup(Dwarf_Debug);
566int		_dwarf_info_first_cu(Dwarf_Debug, Dwarf_Error *);
567int		_dwarf_info_first_tu(Dwarf_Debug, Dwarf_Error *);
568int		_dwarf_info_gen(Dwarf_P_Debug, Dwarf_Error *);
569int		_dwarf_info_load(Dwarf_Debug, Dwarf_Bool, Dwarf_Bool,
570		    Dwarf_Error *);
571int		_dwarf_info_next_cu(Dwarf_Debug, Dwarf_Error *);
572int		_dwarf_info_next_tu(Dwarf_Debug, Dwarf_Error *);
573void		_dwarf_info_pro_cleanup(Dwarf_P_Debug);
574int		_dwarf_init(Dwarf_Debug, Dwarf_Unsigned, Dwarf_Handler,
575		    Dwarf_Ptr, Dwarf_Error *);
576int		_dwarf_lineno_gen(Dwarf_P_Debug, Dwarf_Error *);
577int		_dwarf_lineno_init(Dwarf_Die, uint64_t, Dwarf_Error *);
578void		_dwarf_lineno_cleanup(Dwarf_LineInfo);
579void		_dwarf_lineno_pro_cleanup(Dwarf_P_Debug);
580int		_dwarf_loc_fill_locdesc(Dwarf_Debug, Dwarf_Locdesc *,
581		    uint8_t *, uint64_t, uint8_t, uint8_t, uint8_t,
582		    Dwarf_Error *);
583int		_dwarf_loc_fill_locexpr(Dwarf_Debug, Dwarf_Locdesc **,
584		    uint8_t *, uint64_t, uint8_t, uint8_t, uint8_t,
585		    Dwarf_Error *);
586int		_dwarf_loc_add(Dwarf_Die, Dwarf_Attribute, Dwarf_Error *);
587int		_dwarf_loc_expr_add_atom(Dwarf_Debug, uint8_t *, uint8_t *,
588		    Dwarf_Small, Dwarf_Unsigned, Dwarf_Unsigned, int *,
589		    Dwarf_Error *);
590int		_dwarf_loclist_find(Dwarf_Debug, Dwarf_CU, uint64_t,
591		    Dwarf_Locdesc ***, Dwarf_Signed *, Dwarf_Unsigned *,
592		    Dwarf_Error *);
593void		_dwarf_macinfo_cleanup(Dwarf_Debug);
594int		_dwarf_macinfo_gen(Dwarf_P_Debug, Dwarf_Error *);
595int		_dwarf_macinfo_init(Dwarf_Debug, Dwarf_Error *);
596void		_dwarf_macinfo_pro_cleanup(Dwarf_P_Debug);
597int		_dwarf_nametbl_init(Dwarf_Debug, Dwarf_NameSec *,
598		    Dwarf_Section *, Dwarf_Error *);
599void		_dwarf_nametbl_cleanup(Dwarf_NameSec *);
600int		_dwarf_nametbl_gen(Dwarf_P_Debug, const char *, Dwarf_NameTbl,
601		    Dwarf_Error *);
602void		_dwarf_nametbl_pro_cleanup(Dwarf_NameTbl *);
603int		_dwarf_pro_callback(Dwarf_P_Debug, char *, int, Dwarf_Unsigned,
604		    Dwarf_Unsigned, Dwarf_Unsigned, Dwarf_Unsigned,
605		    Dwarf_Unsigned *, int *);
606Dwarf_P_Section	_dwarf_pro_find_section(Dwarf_P_Debug, const char *);
607int		_dwarf_ranges_add(Dwarf_Debug, Dwarf_CU, uint64_t,
608		    Dwarf_Rangelist *, Dwarf_Error *);
609void		_dwarf_ranges_cleanup(Dwarf_Debug);
610int		_dwarf_ranges_find(Dwarf_Debug, uint64_t, Dwarf_Rangelist *);
611uint64_t	_dwarf_read_lsb(uint8_t *, uint64_t *, int);
612uint64_t	_dwarf_read_msb(uint8_t *, uint64_t *, int);
613int64_t		_dwarf_read_sleb128(uint8_t *, uint64_t *);
614uint64_t	_dwarf_read_uleb128(uint8_t *, uint64_t *);
615char		*_dwarf_read_string(void *, Dwarf_Unsigned, uint64_t *);
616uint8_t		*_dwarf_read_block(void *, uint64_t *, uint64_t);
617int		_dwarf_reloc_section_finalize(Dwarf_P_Debug, Dwarf_Rel_Section,
618		    Dwarf_Error *);
619int		_dwarf_reloc_entry_add(Dwarf_P_Debug, Dwarf_Rel_Section,
620		    Dwarf_P_Section, unsigned char, unsigned char,
621		    Dwarf_Unsigned, Dwarf_Unsigned, Dwarf_Unsigned,
622		    const char *, Dwarf_Error *);
623int		_dwarf_reloc_entry_add_pair(Dwarf_P_Debug, Dwarf_Rel_Section,
624		    Dwarf_P_Section, unsigned char, Dwarf_Unsigned,
625		    Dwarf_Unsigned, Dwarf_Unsigned, Dwarf_Unsigned,
626		    Dwarf_Unsigned, Dwarf_Error *);
627void		_dwarf_reloc_cleanup(Dwarf_P_Debug);
628int		_dwarf_reloc_gen(Dwarf_P_Debug, Dwarf_Error *);
629int		_dwarf_reloc_section_gen(Dwarf_P_Debug, Dwarf_Rel_Section,
630		    Dwarf_Error *);
631int		_dwarf_reloc_section_init(Dwarf_P_Debug, Dwarf_Rel_Section *,
632		    Dwarf_P_Section, Dwarf_Error *);
633void		_dwarf_reloc_section_free(Dwarf_P_Debug, Dwarf_Rel_Section *);
634void		_dwarf_section_cleanup(Dwarf_P_Debug);
635int		_dwarf_section_callback(Dwarf_P_Debug, Dwarf_P_Section,
636		    Dwarf_Unsigned, Dwarf_Unsigned, Dwarf_Unsigned,
637		    Dwarf_Unsigned, Dwarf_Error *);
638void		_dwarf_section_free(Dwarf_P_Debug, Dwarf_P_Section *);
639int		_dwarf_section_init(Dwarf_P_Debug, Dwarf_P_Section *,
640		    const char *, int, Dwarf_Error *);
641void		_dwarf_set_error(Dwarf_Debug, Dwarf_Error *, int, int,
642		    const char *, int);
643int		_dwarf_strtab_add(Dwarf_Debug, char *, uint64_t *,
644		    Dwarf_Error *);
645void		_dwarf_strtab_cleanup(Dwarf_Debug);
646int		_dwarf_strtab_gen(Dwarf_P_Debug, Dwarf_Error *);
647char		*_dwarf_strtab_get_table(Dwarf_Debug);
648int		_dwarf_strtab_init(Dwarf_Debug, Dwarf_Error *);
649void		_dwarf_type_unit_cleanup(Dwarf_Debug);
650void		_dwarf_write_block(void *, uint64_t *, uint8_t *, uint64_t);
651int		_dwarf_write_block_alloc(uint8_t **, uint64_t *, uint64_t *,
652		    uint8_t *, uint64_t, Dwarf_Error *);
653void		_dwarf_write_lsb(uint8_t *, uint64_t *, uint64_t, int);
654int		_dwarf_write_lsb_alloc(uint8_t **, uint64_t *, uint64_t *,
655		    uint64_t, int, Dwarf_Error *);
656void		_dwarf_write_msb(uint8_t *, uint64_t *, uint64_t, int);
657int		_dwarf_write_msb_alloc(uint8_t **, uint64_t *, uint64_t *,
658		    uint64_t, int, Dwarf_Error *);
659void		_dwarf_write_padding(void *, uint64_t *, uint8_t, uint64_t);
660int		_dwarf_write_padding_alloc(uint8_t **, uint64_t *, uint64_t *,
661		    uint8_t, uint64_t, Dwarf_Error *);
662void		_dwarf_write_string(void *, uint64_t *, char *);
663int		_dwarf_write_string_alloc(uint8_t **, uint64_t *, uint64_t *,
664		    char *, Dwarf_Error *);
665int		_dwarf_write_sleb128(uint8_t *, uint8_t *, int64_t);
666int		_dwarf_write_sleb128_alloc(uint8_t **, uint64_t *, uint64_t *,
667		    int64_t, Dwarf_Error *);
668int		_dwarf_write_uleb128(uint8_t *, uint8_t *, uint64_t);
669int		_dwarf_write_uleb128_alloc(uint8_t **, uint64_t *, uint64_t *,
670		    uint64_t, Dwarf_Error *);
671
672#endif /* !__LIBDWARF_H_ */
673