1 /* dwarf.h - DWARF support header file
2 Copyright (C) 2005-2021 Free Software Foundation, Inc.
3
4 This file is part of GNU Binutils.
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
19 MA 02110-1301, USA. */
20
21 #include "dwarf2.h" /* for enum dwarf_unit_type */
22
23 typedef unsigned HOST_WIDEST_INT dwarf_vma;
24 typedef HOST_WIDEST_INT dwarf_signed_vma;
25 typedef unsigned HOST_WIDEST_INT dwarf_size_type;
26
27 /* Structure found in the .debug_line section. */
28 typedef struct
29 {
30 dwarf_vma li_length;
31 unsigned short li_version;
32 unsigned char li_address_size;
33 unsigned char li_segment_size;
34 dwarf_vma li_prologue_length;
35 unsigned char li_min_insn_length;
36 unsigned char li_max_ops_per_insn;
37 unsigned char li_default_is_stmt;
38 int li_line_base;
39 unsigned char li_line_range;
40 unsigned char li_opcode_base;
41 unsigned int li_offset_size;
42 }
43 DWARF2_Internal_LineInfo;
44
45 /* Structure found in .debug_pubnames section. */
46 typedef struct
47 {
48 dwarf_vma pn_length;
49 unsigned short pn_version;
50 dwarf_vma pn_offset;
51 dwarf_vma pn_size;
52 }
53 DWARF2_Internal_PubNames;
54
55 /* Structure found in .debug_info section. */
56 typedef struct
57 {
58 dwarf_vma cu_length;
59 unsigned short cu_version;
60 dwarf_vma cu_abbrev_offset;
61 unsigned char cu_pointer_size;
62 enum dwarf_unit_type cu_unit_type;
63 }
64 DWARF2_Internal_CompUnit;
65
66 /* Structure found in .debug_aranges section. */
67 typedef struct
68 {
69 dwarf_vma ar_length;
70 unsigned short ar_version;
71 dwarf_vma ar_info_offset;
72 unsigned char ar_pointer_size;
73 unsigned char ar_segment_size;
74 }
75 DWARF2_Internal_ARange;
76
77 /* N.B. The order here must match the order in debug_displays. */
78
79 enum dwarf_section_display_enum
80 {
81 abbrev = 0,
82 aranges,
83 frame,
84 info,
85 line,
86 pubnames,
87 gnu_pubnames,
88 eh_frame,
89 macinfo,
90 macro,
91 str,
92 line_str,
93 loc,
94 loclists,
95 pubtypes,
96 gnu_pubtypes,
97 ranges,
98 rnglists,
99 static_func,
100 static_vars,
101 types,
102 weaknames,
103 gdb_index,
104 debug_names,
105 trace_info,
106 trace_abbrev,
107 trace_aranges,
108 info_dwo,
109 abbrev_dwo,
110 types_dwo,
111 line_dwo,
112 loc_dwo,
113 macro_dwo,
114 macinfo_dwo,
115 str_dwo,
116 str_index,
117 str_index_dwo,
118 debug_addr,
119 dwp_cu_index,
120 dwp_tu_index,
121 gnu_debuglink,
122 gnu_debugaltlink,
123 debug_sup,
124 separate_debug_str,
125 max
126 };
127
128 struct dwarf_section
129 {
130 /* A debug section has a different name when it's stored compressed
131 or not. COMPRESSED_NAME and UNCOMPRESSED_NAME are the two
132 possibilities. NAME is set to whichever one is used for this
133 input file, as determined by load_debug_section(). */
134 const char * uncompressed_name;
135 const char * compressed_name;
136 const char * name;
137 /* If non-NULL then FILENAME is the name of the separate debug info
138 file containing the section. */
139 const char * filename;
140 unsigned char * start;
141 dwarf_vma address;
142 dwarf_size_type size;
143 enum dwarf_section_display_enum abbrev_sec;
144 /* Used by clients to help them implement the reloc_at callback. */
145 void * reloc_info;
146 unsigned long num_relocs;
147 };
148
149 /* A structure containing the name of a debug section
150 and a pointer to a function that can decode it. */
151 struct dwarf_section_display
152 {
153 struct dwarf_section section;
154 int (*display) (struct dwarf_section *, void *);
155 int *enabled;
156 bool relocate;
157 };
158
159 extern struct dwarf_section_display debug_displays [];
160
161 /* This structure records the information that
162 we extract from the.debug_info section. */
163 typedef struct
164 {
165 unsigned int pointer_size;
166 unsigned int offset_size;
167 int dwarf_version;
168 dwarf_vma cu_offset;
169 dwarf_vma base_address;
170 /* This field is filled in when reading the attribute DW_AT_GNU_addr_base and
171 is used with the form DW_FORM_GNU_addr_index. */
172 dwarf_vma addr_base;
173 /* This field is filled in when reading the attribute DW_AT_GNU_ranges_base and
174 is used when calculating ranges. */
175 dwarf_vma ranges_base;
176 /* This is an array of offsets to the location list table. */
177 dwarf_vma * loc_offsets;
178 /* This is an array of offsets to the location view table. */
179 dwarf_vma * loc_views;
180 int * have_frame_base;
181 unsigned int num_loc_offsets;
182 unsigned int max_loc_offsets;
183 unsigned int num_loc_views;
184 /* List of .debug_ranges offsets seen in this .debug_info. */
185 dwarf_vma * range_lists;
186 unsigned int num_range_lists;
187 unsigned int max_range_lists;
188 }
189 debug_info;
190
191 typedef struct separate_info
192 {
193 void * handle; /* The pointer returned by open_debug_file(). */
194 const char * filename;
195 struct separate_info * next;
196 } separate_info;
197
198 extern separate_info * first_separate_info;
199
200 extern unsigned int eh_addr_size;
201
202 extern int do_debug_info;
203 extern int do_debug_abbrevs;
204 extern int do_debug_lines;
205 extern int do_debug_pubnames;
206 extern int do_debug_pubtypes;
207 extern int do_debug_aranges;
208 extern int do_debug_ranges;
209 extern int do_debug_frames;
210 extern int do_debug_frames_interp;
211 extern int do_debug_macinfo;
212 extern int do_debug_str;
213 extern int do_debug_str_offsets;
214 extern int do_debug_loc;
215 extern int do_gdb_index;
216 extern int do_trace_info;
217 extern int do_trace_abbrevs;
218 extern int do_trace_aranges;
219 extern int do_debug_addr;
220 extern int do_debug_cu_index;
221 extern int do_wide;
222 extern int do_debug_links;
223 extern int do_follow_links;
224 extern bool do_checks;
225
226 extern int dwarf_cutoff_level;
227 extern unsigned long dwarf_start_die;
228
229 extern int dwarf_check;
230
231 extern void init_dwarf_regnames_by_elf_machine_code (unsigned int);
232 extern void init_dwarf_regnames_by_bfd_arch_and_mach (enum bfd_architecture arch,
233 unsigned long mach);
234
235 extern bool load_debug_section (enum dwarf_section_display_enum, void *);
236 extern void free_debug_section (enum dwarf_section_display_enum);
237 extern bool load_separate_debug_files (void *, const char *);
238 extern void close_debug_file (void *);
239 extern void *open_debug_file (const char *);
240
241 extern void free_debug_memory (void);
242
243 extern void dwarf_select_sections_by_names (const char *);
244 extern void dwarf_select_sections_by_letters (const char *);
245 extern void dwarf_select_sections_all (void);
246
247 extern unsigned int * find_cu_tu_set (void *, unsigned int);
248
249 extern void * cmalloc (size_t, size_t);
250 extern void * xcalloc2 (size_t, size_t);
251 extern void * xcmalloc (size_t, size_t);
252 extern void * xcrealloc (void *, size_t, size_t);
253
254 /* A callback into the client. Returns TRUE if there is a
255 relocation against the given debug section at the given
256 offset. */
257 extern bool reloc_at (struct dwarf_section *, dwarf_vma);
258
259 extern dwarf_vma read_leb128 (unsigned char *, const unsigned char *const,
260 bool, unsigned int *, int *);
261
262 #if HAVE_LIBDEBUGINFOD
263 extern unsigned char * get_build_id (void *);
264 #endif
265
266 static inline void
report_leb_status(int status,const char * file,unsigned long lnum)267 report_leb_status (int status, const char *file, unsigned long lnum)
268 {
269 if ((status & 1) != 0)
270 error (_("%s:%lu: end of data encountered whilst reading LEB\n"), file, lnum);
271 else if ((status & 2) != 0)
272 error (_("%s:%lu: read LEB value is too large to store in destination variable\n"), file, lnum);
273 }
274
275 #define SKIP_ULEB(start, end) \
276 do \
277 { \
278 unsigned int _len; \
279 read_leb128 (start, end, false, &_len, NULL); \
280 start += _len; \
281 } \
282 while (0)
283
284 #define SKIP_SLEB(start, end) \
285 do \
286 { \
287 unsigned int _len; \
288 read_leb128 (start, end, true, &_len, NULL); \
289 start += _len; \
290 } \
291 while (0)
292
293 #define READ_ULEB(var, start, end) \
294 do \
295 { \
296 dwarf_vma _val; \
297 unsigned int _len; \
298 int _status; \
299 \
300 _val = read_leb128 (start, end, false, &_len, &_status); \
301 start += _len; \
302 (var) = _val; \
303 if ((var) != _val) \
304 _status |= 2; \
305 report_leb_status (_status, __FILE__, __LINE__); \
306 } \
307 while (0)
308
309 #define READ_SLEB(var, start, end) \
310 do \
311 { \
312 dwarf_signed_vma _val; \
313 unsigned int _len; \
314 int _status; \
315 \
316 _val = read_leb128 (start, end, true, &_len, &_status); \
317 start += _len; \
318 (var) = _val; \
319 if ((var) != _val) \
320 _status |= 2; \
321 report_leb_status (_status, __FILE__, __LINE__); \
322 } \
323 while (0)
324