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