]>
Commit | Line | Data |
---|---|---|
1b315056 | 1 | /* dwarf.h - DWARF support header file |
d87bef3a | 2 | Copyright (C) 2005-2023 Free Software Foundation, Inc. |
19e6b90e | 3 | |
32866df7 | 4 | This file is part of GNU Binutils. |
19e6b90e | 5 | |
32866df7 NC |
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. | |
19e6b90e | 10 | |
32866df7 NC |
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. | |
19e6b90e | 15 | |
32866df7 NC |
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. */ | |
19e6b90e | 20 | |
77145576 JK |
21 | #include "dwarf2.h" /* for enum dwarf_unit_type */ |
22 | ||
47704ddf | 23 | /* Structure found in the .debug_line section. */ |
47704ddf KT |
24 | typedef struct |
25 | { | |
329dd2b6 AM |
26 | uint64_t li_length; |
27 | uint16_t li_version; | |
28 | uint8_t li_address_size; | |
29 | uint8_t li_segment_size; | |
30 | uint64_t li_prologue_length; | |
31 | uint8_t li_min_insn_length; | |
32 | uint8_t li_max_ops_per_insn; | |
33 | uint8_t li_default_is_stmt; | |
34 | int8_t li_line_base; | |
35 | uint8_t li_line_range; | |
36 | uint8_t li_opcode_base; | |
37 | /* Not part of the header. 4 for 32-bit dwarf, 8 for 64-bit. */ | |
38 | unsigned int li_offset_size; | |
47704ddf KT |
39 | } |
40 | DWARF2_Internal_LineInfo; | |
41 | ||
42 | /* Structure found in .debug_pubnames section. */ | |
47704ddf KT |
43 | typedef struct |
44 | { | |
31e5a3a3 | 45 | uint64_t pn_length; |
47704ddf | 46 | unsigned short pn_version; |
31e5a3a3 AM |
47 | uint64_t pn_offset; |
48 | uint64_t pn_size; | |
47704ddf KT |
49 | } |
50 | DWARF2_Internal_PubNames; | |
51 | ||
52 | /* Structure found in .debug_info section. */ | |
47704ddf KT |
53 | typedef struct |
54 | { | |
31e5a3a3 | 55 | uint64_t cu_length; |
47704ddf | 56 | unsigned short cu_version; |
31e5a3a3 | 57 | uint64_t cu_abbrev_offset; |
47704ddf | 58 | unsigned char cu_pointer_size; |
77145576 | 59 | enum dwarf_unit_type cu_unit_type; |
47704ddf KT |
60 | } |
61 | DWARF2_Internal_CompUnit; | |
62 | ||
77ef8654 | 63 | /* Structure found in .debug_aranges section. */ |
47704ddf KT |
64 | typedef struct |
65 | { | |
31e5a3a3 | 66 | uint64_t ar_length; |
47704ddf | 67 | unsigned short ar_version; |
31e5a3a3 | 68 | uint64_t ar_info_offset; |
47704ddf KT |
69 | unsigned char ar_pointer_size; |
70 | unsigned char ar_segment_size; | |
71 | } | |
72 | DWARF2_Internal_ARange; | |
73 | ||
459d52c8 DE |
74 | /* N.B. The order here must match the order in debug_displays. */ |
75 | ||
c34f4fc6 NC |
76 | enum dwarf_section_display_enum |
77 | { | |
19e6b90e L |
78 | abbrev = 0, |
79 | aranges, | |
80 | frame, | |
81 | info, | |
82 | line, | |
83 | pubnames, | |
459d52c8 | 84 | gnu_pubnames, |
19e6b90e L |
85 | eh_frame, |
86 | macinfo, | |
4ccf1e31 | 87 | macro, |
19e6b90e | 88 | str, |
77145576 | 89 | line_str, |
19e6b90e | 90 | loc, |
d4620bee | 91 | loclists, |
4694a0e5 | 92 | loclists_dwo, |
19e6b90e | 93 | pubtypes, |
459d52c8 | 94 | gnu_pubtypes, |
19e6b90e | 95 | ranges, |
d4620bee | 96 | rnglists, |
4694a0e5 | 97 | rnglists_dwo, |
19e6b90e L |
98 | static_func, |
99 | static_vars, | |
100 | types, | |
101 | weaknames, | |
48049d1e | 102 | gdb_index, |
61364358 | 103 | debug_names, |
6f875884 TG |
104 | trace_info, |
105 | trace_abbrev, | |
106 | trace_aranges, | |
4723351a CC |
107 | info_dwo, |
108 | abbrev_dwo, | |
109 | types_dwo, | |
110 | line_dwo, | |
111 | loc_dwo, | |
112 | macro_dwo, | |
113 | macinfo_dwo, | |
114 | str_dwo, | |
115 | str_index, | |
116 | str_index_dwo, | |
117 | debug_addr, | |
657d0d47 CC |
118 | dwp_cu_index, |
119 | dwp_tu_index, | |
dda8d76d NC |
120 | gnu_debuglink, |
121 | gnu_debugaltlink, | |
e38332c2 | 122 | debug_sup, |
dda8d76d | 123 | separate_debug_str, |
61ab1364 | 124 | note_gnu_build_id, |
19e6b90e L |
125 | max |
126 | }; | |
127 | ||
4723351a CC |
128 | struct dwarf_section |
129 | { | |
130 | /* A debug section has a different name when it's stored compressed | |
51d29b8c CC |
131 | or not. XCOFF DWARF section also have a special name. |
132 | COMPRESSED_NAME, UNCOMPRESSED_NAME and XCOFF_NAME are the three | |
4723351a CC |
133 | possibilities. NAME is set to whichever one is used for this |
134 | input file, as determined by load_debug_section(). */ | |
dda8d76d NC |
135 | const char * uncompressed_name; |
136 | const char * compressed_name; | |
51d29b8c | 137 | const char * xcoff_name; |
dda8d76d NC |
138 | const char * name; |
139 | /* If non-NULL then FILENAME is the name of the separate debug info | |
140 | file containing the section. */ | |
141 | const char * filename; | |
142 | unsigned char * start; | |
31e5a3a3 AM |
143 | uint64_t address; |
144 | uint64_t size; | |
dda8d76d | 145 | enum dwarf_section_display_enum abbrev_sec; |
d1c4b12b | 146 | /* Used by clients to help them implement the reloc_at callback. */ |
dda8d76d | 147 | void * reloc_info; |
26c527e6 | 148 | uint64_t num_relocs; |
4723351a CC |
149 | }; |
150 | ||
151 | /* A structure containing the name of a debug section | |
152 | and a pointer to a function that can decode it. */ | |
153 | struct dwarf_section_display | |
154 | { | |
015dc7e1 AM |
155 | struct dwarf_section section; |
156 | int (*display) (struct dwarf_section *, void *); | |
157 | int *enabled; | |
158 | bool relocate; | |
4723351a CC |
159 | }; |
160 | ||
19e6b90e L |
161 | extern struct dwarf_section_display debug_displays []; |
162 | ||
163 | /* This structure records the information that | |
164 | we extract from the.debug_info section. */ | |
165 | typedef struct | |
166 | { | |
167 | unsigned int pointer_size; | |
b7807392 JJ |
168 | unsigned int offset_size; |
169 | int dwarf_version; | |
31e5a3a3 AM |
170 | uint64_t cu_offset; |
171 | uint64_t base_address; | |
4723351a | 172 | /* This field is filled in when reading the attribute DW_AT_GNU_addr_base and |
528a4f87 | 173 | is used with the form DW_FORM_GNU_addr_index. */ |
31e5a3a3 | 174 | uint64_t addr_base; |
4723351a CC |
175 | /* This field is filled in when reading the attribute DW_AT_GNU_ranges_base and |
176 | is used when calculating ranges. */ | |
31e5a3a3 | 177 | uint64_t ranges_base; |
19e6b90e | 178 | /* This is an array of offsets to the location list table. */ |
31e5a3a3 | 179 | uint64_t * loc_offsets; |
9f272209 | 180 | /* This is an array of offsets to the location view table. */ |
31e5a3a3 | 181 | uint64_t * loc_views; |
467c65bc | 182 | int * have_frame_base; |
19c26da6 NC |
183 | |
184 | /* Information for associating location lists with CUs. */ | |
19e6b90e L |
185 | unsigned int num_loc_offsets; |
186 | unsigned int max_loc_offsets; | |
9f272209 | 187 | unsigned int num_loc_views; |
31e5a3a3 | 188 | uint64_t loclists_base; |
19c26da6 | 189 | |
01a8f077 | 190 | /* List of .debug_ranges offsets seen in this .debug_info. */ |
31e5a3a3 | 191 | uint64_t * range_lists; |
19e6b90e L |
192 | unsigned int num_range_lists; |
193 | unsigned int max_range_lists; | |
31e5a3a3 AM |
194 | uint64_t rnglists_base; |
195 | uint64_t str_offsets_base; | |
19e6b90e L |
196 | } |
197 | debug_info; | |
198 | ||
24841daa NC |
199 | typedef struct separate_info |
200 | { | |
201 | void * handle; /* The pointer returned by open_debug_file(). */ | |
202 | const char * filename; | |
203 | struct separate_info * next; | |
204 | } separate_info; | |
205 | ||
206 | extern separate_info * first_separate_info; | |
207 | ||
77ef8654 | 208 | extern unsigned int eh_addr_size; |
19e6b90e L |
209 | |
210 | extern int do_debug_info; | |
211 | extern int do_debug_abbrevs; | |
212 | extern int do_debug_lines; | |
213 | extern int do_debug_pubnames; | |
f9f0e732 | 214 | extern int do_debug_pubtypes; |
19e6b90e L |
215 | extern int do_debug_aranges; |
216 | extern int do_debug_ranges; | |
217 | extern int do_debug_frames; | |
218 | extern int do_debug_frames_interp; | |
219 | extern int do_debug_macinfo; | |
220 | extern int do_debug_str; | |
e4b7104b | 221 | extern int do_debug_str_offsets; |
19e6b90e | 222 | extern int do_debug_loc; |
5bbdf3d5 | 223 | extern int do_gdb_index; |
6f875884 TG |
224 | extern int do_trace_info; |
225 | extern int do_trace_abbrevs; | |
226 | extern int do_trace_aranges; | |
657d0d47 CC |
227 | extern int do_debug_addr; |
228 | extern int do_debug_cu_index; | |
c34f4fc6 | 229 | extern int do_wide; |
dda8d76d | 230 | extern int do_debug_links; |
39f0547e | 231 | extern int do_follow_links; |
bed566bb NC |
232 | #ifdef HAVE_LIBDEBUGINFOD |
233 | extern int use_debuginfod; | |
234 | #endif | |
015dc7e1 | 235 | extern bool do_checks; |
19e6b90e | 236 | |
fd2f0033 TT |
237 | extern int dwarf_cutoff_level; |
238 | extern unsigned long dwarf_start_die; | |
239 | ||
4723351a CC |
240 | extern int dwarf_check; |
241 | ||
955ff7fc | 242 | extern void init_dwarf_regnames_by_elf_machine_code (unsigned int); |
229a22cf AB |
243 | extern void init_dwarf_regnames_by_bfd_arch_and_mach (enum bfd_architecture arch, |
244 | unsigned long mach); | |
2dc4cec1 | 245 | |
015dc7e1 AM |
246 | extern bool load_debug_section (enum dwarf_section_display_enum, void *); |
247 | extern void free_debug_section (enum dwarf_section_display_enum); | |
248 | extern bool load_separate_debug_files (void *, const char *); | |
249 | extern void close_debug_file (void *); | |
250 | extern void *open_debug_file (const char *); | |
19e6b90e L |
251 | |
252 | extern void free_debug_memory (void); | |
253 | ||
94585d6d NC |
254 | extern int dwarf_select_sections_by_names (const char *); |
255 | extern int dwarf_select_sections_by_letters (const char *); | |
4cb93e3b TG |
256 | extern void dwarf_select_sections_all (void); |
257 | ||
82b1b41b | 258 | extern unsigned int * find_cu_tu_set (void *, unsigned int); |
657d0d47 | 259 | |
26c527e6 AM |
260 | extern void * cmalloc (uint64_t, size_t); |
261 | extern void * xcalloc2 (uint64_t, size_t); | |
262 | extern void * xcmalloc (uint64_t, size_t); | |
263 | extern void * xcrealloc (void *, uint64_t, size_t); | |
19e6b90e | 264 | |
222c2bf0 | 265 | /* A callback into the client. Returns TRUE if there is a |
d1c4b12b NC |
266 | relocation against the given debug section at the given |
267 | offset. */ | |
31e5a3a3 | 268 | extern bool reloc_at (struct dwarf_section *, uint64_t); |
cd30bcef | 269 | |
31e5a3a3 AM |
270 | extern uint64_t read_leb128 (unsigned char *, const unsigned char *const, |
271 | bool, unsigned int *, int *); | |
cd30bcef | 272 | |
301a9420 AM |
273 | #if HAVE_LIBDEBUGINFOD |
274 | extern unsigned char * get_build_id (void *); | |
275 | #endif | |
276 | ||
cd30bcef | 277 | static inline void |
9039747f | 278 | report_leb_status (int status) |
cd30bcef AM |
279 | { |
280 | if ((status & 1) != 0) | |
9039747f | 281 | error (_("end of data encountered whilst reading LEB\n")); |
cd30bcef | 282 | else if ((status & 2) != 0) |
9039747f | 283 | error (_("read LEB value is too large to store in destination variable\n")); |
cd30bcef AM |
284 | } |
285 | ||
286 | #define SKIP_ULEB(start, end) \ | |
287 | do \ | |
288 | { \ | |
289 | unsigned int _len; \ | |
015dc7e1 | 290 | read_leb128 (start, end, false, &_len, NULL); \ |
cd30bcef | 291 | start += _len; \ |
1b513401 NC |
292 | } \ |
293 | while (0) | |
cd30bcef AM |
294 | |
295 | #define SKIP_SLEB(start, end) \ | |
296 | do \ | |
297 | { \ | |
298 | unsigned int _len; \ | |
015dc7e1 | 299 | read_leb128 (start, end, true, &_len, NULL); \ |
cd30bcef | 300 | start += _len; \ |
1b513401 NC |
301 | } \ |
302 | while (0) | |
cd30bcef AM |
303 | |
304 | #define READ_ULEB(var, start, end) \ | |
305 | do \ | |
306 | { \ | |
31e5a3a3 | 307 | uint64_t _val; \ |
cd30bcef AM |
308 | unsigned int _len; \ |
309 | int _status; \ | |
310 | \ | |
015dc7e1 | 311 | _val = read_leb128 (start, end, false, &_len, &_status); \ |
cd30bcef AM |
312 | start += _len; \ |
313 | (var) = _val; \ | |
314 | if ((var) != _val) \ | |
315 | _status |= 2; \ | |
9039747f | 316 | report_leb_status (_status); \ |
1b513401 NC |
317 | } \ |
318 | while (0) | |
cd30bcef AM |
319 | |
320 | #define READ_SLEB(var, start, end) \ | |
321 | do \ | |
322 | { \ | |
31e5a3a3 | 323 | int64_t _val; \ |
cd30bcef AM |
324 | unsigned int _len; \ |
325 | int _status; \ | |
326 | \ | |
015dc7e1 | 327 | _val = read_leb128 (start, end, true, &_len, &_status); \ |
cd30bcef AM |
328 | start += _len; \ |
329 | (var) = _val; \ | |
330 | if ((var) != _val) \ | |
331 | _status |= 2; \ | |
9039747f | 332 | report_leb_status (_status); \ |
1b513401 NC |
333 | } \ |
334 | while (0) |