Branch data Line data Source code
1 : : /* Internal definitions for libdw.
2 : : Copyright (C) 2002-2011, 2013-2018 Red Hat, Inc.
3 : : This file is part of elfutils.
4 : :
5 : : This file is free software; you can redistribute it and/or modify
6 : : it under the terms of either
7 : :
8 : : * the GNU Lesser General Public License as published by the Free
9 : : Software Foundation; either version 3 of the License, or (at
10 : : your option) any later version
11 : :
12 : : or
13 : :
14 : : * the GNU General Public License as published by the Free
15 : : Software Foundation; either version 2 of the License, or (at
16 : : your option) any later version
17 : :
18 : : or both in parallel, as here.
19 : :
20 : : elfutils is distributed in the hope that it will be useful, but
21 : : WITHOUT ANY WARRANTY; without even the implied warranty of
22 : : MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 : : General Public License for more details.
24 : :
25 : : You should have received copies of the GNU General Public License and
26 : : the GNU Lesser General Public License along with this program. If
27 : : not, see <http://www.gnu.org/licenses/>. */
28 : :
29 : : #ifndef _LIBDWP_H
30 : : #define _LIBDWP_H 1
31 : :
32 : : #include <stdbool.h>
33 : : #include <pthread.h>
34 : :
35 : : #include <libdw.h>
36 : : #include <dwarf.h>
37 : : #include "eu-search.h"
38 : :
39 : :
40 : : /* Known location expressions already decoded. */
41 : : struct loc_s
42 : : {
43 : : void *addr;
44 : : Dwarf_Op *loc;
45 : : size_t nloc;
46 : : };
47 : :
48 : : /* Known DW_OP_implicit_value blocks already decoded.
49 : : This overlaps struct loc_s exactly, but only the
50 : : first member really has to match. */
51 : : struct loc_block_s
52 : : {
53 : : void *addr;
54 : : unsigned char *data;
55 : : size_t length;
56 : : };
57 : :
58 : : /* Already decoded .debug_line units. */
59 : : struct files_lines_s
60 : : {
61 : : Dwarf_Off debug_line_offset;
62 : : Dwarf_Files *files;
63 : : Dwarf_Lines *lines;
64 : : };
65 : :
66 : : /* Valid indices for the section data. */
67 : : enum
68 : : {
69 : : IDX_debug_info = 0,
70 : : IDX_debug_types,
71 : : IDX_debug_abbrev,
72 : : IDX_debug_aranges,
73 : : IDX_debug_addr,
74 : : IDX_debug_line,
75 : : IDX_debug_line_str,
76 : : IDX_debug_frame,
77 : : IDX_debug_loc,
78 : : IDX_debug_loclists,
79 : : IDX_debug_pubnames,
80 : : IDX_debug_str,
81 : : IDX_debug_str_offsets,
82 : : IDX_debug_macinfo,
83 : : IDX_debug_macro,
84 : : IDX_debug_ranges,
85 : : IDX_debug_rnglists,
86 : : IDX_debug_cu_index,
87 : : IDX_debug_tu_index,
88 : : IDX_gnu_debugaltlink,
89 : : IDX_last
90 : : };
91 : :
92 : : /* Valid indices for the string section's information. */
93 : : enum string_section_index
94 : : {
95 : : STR_SCN_IDX_debug_line_str,
96 : : STR_SCN_IDX_debug_str,
97 : : STR_SCN_IDX_last
98 : : };
99 : :
100 : : /* Error values. */
101 : : enum
102 : : {
103 : : DWARF_E_NOERROR = 0,
104 : : DWARF_E_UNKNOWN_ERROR,
105 : : DWARF_E_INVALID_ACCESS,
106 : : DWARF_E_NO_REGFILE,
107 : : DWARF_E_IO_ERROR,
108 : : DWARF_E_INVALID_ELF,
109 : : DWARF_E_NO_DWARF,
110 : : DWARF_E_COMPRESSED_ERROR,
111 : : DWARF_E_NOELF,
112 : : DWARF_E_GETEHDR_ERROR,
113 : : DWARF_E_NOMEM,
114 : : DWARF_E_UNIMPL,
115 : : DWARF_E_INVALID_CMD,
116 : : DWARF_E_INVALID_VERSION,
117 : : DWARF_E_INVALID_FILE,
118 : : DWARF_E_NO_ENTRY,
119 : : DWARF_E_INVALID_DWARF,
120 : : DWARF_E_NO_STRING,
121 : : DWARF_E_NO_DEBUG_STR,
122 : : DWARF_E_NO_DEBUG_LINE_STR,
123 : : DWARF_E_NO_STR_OFFSETS,
124 : : DWARF_E_NO_ADDR,
125 : : DWARF_E_NO_CONSTANT,
126 : : DWARF_E_NO_REFERENCE,
127 : : DWARF_E_INVALID_REFERENCE,
128 : : DWARF_E_NO_DEBUG_LINE,
129 : : DWARF_E_INVALID_DEBUG_LINE,
130 : : DWARF_E_TOO_BIG,
131 : : DWARF_E_VERSION,
132 : : DWARF_E_INVALID_DIR_IDX,
133 : : DWARF_E_ADDR_OUTOFRANGE,
134 : : DWARF_E_NO_DEBUG_LOC,
135 : : DWARF_E_NO_DEBUG_LOCLISTS,
136 : : DWARF_E_NO_LOC_VALUE,
137 : : DWARF_E_NO_BLOCK,
138 : : DWARF_E_INVALID_LINE_IDX,
139 : : DWARF_E_INVALID_ARANGE_IDX,
140 : : DWARF_E_NO_MATCH,
141 : : DWARF_E_NO_FLAG,
142 : : DWARF_E_INVALID_OFFSET,
143 : : DWARF_E_NO_DEBUG_RANGES,
144 : : DWARF_E_NO_DEBUG_RNGLISTS,
145 : : DWARF_E_INVALID_CFI,
146 : : DWARF_E_NO_ALT_DEBUGLINK,
147 : : DWARF_E_INVALID_OPCODE,
148 : : DWARF_E_NOT_CUDIE,
149 : : DWARF_E_UNKNOWN_LANGUAGE,
150 : : DWARF_E_NO_DEBUG_ADDR,
151 : : DWARF_E_UNKNOWN_SECTION,
152 : : };
153 : :
154 : :
155 : : #include "dwarf_sig8_hash.h"
156 : :
157 : : /* The type of Dwarf object, sorted by preference
158 : : (if there is a higher order type, we pick that one over the others). */
159 : : enum dwarf_type
160 : : {
161 : : TYPE_UNKNOWN = 0,
162 : : TYPE_GNU_LTO = 16,
163 : : TYPE_DWO = 32,
164 : : TYPE_PLAIN = 64,
165 : : };
166 : :
167 : : /* This is the structure representing the debugging state. */
168 : : struct Dwarf
169 : : {
170 : : /* The underlying ELF file. */
171 : : Elf *elf;
172 : :
173 : : /* The (absolute) path to the ELF file, if known. To help locating
174 : : dwp files. */
175 : : char *elfpath;
176 : :
177 : : /* The (absolute) path to the ELF dir, if known. To help locating
178 : : alt and dwo files. */
179 : : char *debugdir;
180 : :
181 : : /* dwz alternate DWARF file. */
182 : : Dwarf *alt_dwarf;
183 : :
184 : : /* DWARF package file. */
185 : : Dwarf *dwp_dwarf;
186 : :
187 : : /* The section data. */
188 : : Elf_Data *sectiondata[IDX_last];
189 : :
190 : : /* Size of a prefix of string sections, where any string will be
191 : : null-terminated. */
192 : : size_t string_section_size[STR_SCN_IDX_last];
193 : :
194 : : /* True if the file has a byte order different from the host. */
195 : : bool other_byte_order;
196 : :
197 : : /* If true, we allocated the ELF descriptor ourselves. */
198 : : bool free_elf;
199 : :
200 : : /* If >= 0, we allocated the alt_dwarf ourselves and must end it and
201 : : close this file descriptor. */
202 : : int alt_fd;
203 : :
204 : : /* File descriptor of DWARF package file. */
205 : : int dwp_fd;
206 : :
207 : : /* Information for traversing the .debug_pubnames section. This is
208 : : an array and separately allocated with malloc. */
209 : : struct pubnames_s
210 : : {
211 : : Dwarf_Off cu_offset;
212 : : Dwarf_Off set_start;
213 : : unsigned int cu_header_size;
214 : : int address_len;
215 : : } *pubnames_sets;
216 : : size_t pubnames_nsets;
217 : :
218 : : /* Search tree for the CUs. */
219 : : search_tree cu_tree;
220 : : Dwarf_Off next_cu_offset;
221 : :
222 : : /* Search tree and sig8 hash table for .debug_types type units. */
223 : : search_tree tu_tree;
224 : : Dwarf_Off next_tu_offset;
225 : : Dwarf_Sig8_Hash sig8_hash;
226 : :
227 : : /* Search tree for split Dwarf associated with CUs in this debug. */
228 : : search_tree split_tree;
229 : :
230 : : /* Search tree for .debug_macro operator tables. */
231 : : search_tree macro_ops_tree;
232 : :
233 : : /* Search tree for decoded .debug_line units. */
234 : : search_tree files_lines_tree;
235 : :
236 : : /* Address ranges read from .debug_aranges. */
237 : : Dwarf_Aranges *aranges;
238 : :
239 : : /* Address ranges inferred from CUs. */
240 : : Dwarf_Aranges *dieranges;
241 : :
242 : : /* Cached info from the CFI section. */
243 : : struct Dwarf_CFI_s *cfi;
244 : :
245 : : /* DWARF package file CU index section. */
246 : : struct Dwarf_Package_Index_s *cu_index;
247 : : /* DWARF package file TU index section. */
248 : : struct Dwarf_Package_Index_s *tu_index;
249 : :
250 : : /* Fake loc CU. Used when synthesizing attributes for Dwarf_Ops that
251 : : came from a location list entry in dwarf_getlocation_attr.
252 : : Depending on version this is the .debug_loc or .debug_loclists
253 : : section (could be both if mixing CUs with different DWARF versions). */
254 : : struct Dwarf_CU *fake_loc_cu;
255 : : struct Dwarf_CU *fake_loclists_cu;
256 : :
257 : : /* Similar for addrx/constx, which will come from .debug_addr section. */
258 : : struct Dwarf_CU *fake_addr_cu;
259 : :
260 : : enum dwarf_type type;
261 : :
262 : : /* Supporting lock for internal memory handling. Ensures threads that have
263 : : an entry in the mem_tails array are not disturbed by new threads doing
264 : : allocations for this Dwarf. */
265 : : pthread_rwlock_t mem_rwl;
266 : :
267 : : /* The dwarf_lock is a read-write lock designed to ensure thread-safe access
268 : : and modification of an entire Dwarf object. */
269 : : rwlock_define(, dwarf_lock);
270 : :
271 : : /* Internal memory handling. This is basically a simplified thread-local
272 : : reimplementation of obstacks. Unfortunately the standard obstack
273 : : implementation is not usable in libraries. */
274 : : size_t mem_stacks;
275 : : struct libdw_memblock
276 : : {
277 : : size_t size;
278 : : size_t remaining;
279 : : struct libdw_memblock *prev;
280 : : char mem[0];
281 : : } **mem_tails;
282 : :
283 : : /* Default size of allocated memory blocks. */
284 : : size_t mem_default_size;
285 : :
286 : : /* Registered OOM handler. */
287 : : Dwarf_OOM oom_handler;
288 : : };
289 : :
290 : :
291 : : /* Abbreviation representation. */
292 : : struct Dwarf_Abbrev
293 : : {
294 : : Dwarf_Off offset; /* Offset to start of abbrev into .debug_abbrev. */
295 : : unsigned char *attrp; /* Pointer to start of attribute name/form pairs. */
296 : : bool has_children : 1; /* Whether or not the DIE has children. */
297 : : unsigned int code : 31; /* The (unique) abbrev code. */
298 : : unsigned int tag; /* The tag of the DIE. */
299 : : } attribute_packed;
300 : :
301 : : #include "dwarf_abbrev_hash.h"
302 : :
303 : :
304 : : /* Files in line information records. */
305 : : struct Dwarf_Files_s
306 : : {
307 : : unsigned int ndirs;
308 : : unsigned int nfiles;
309 : : struct Dwarf_Fileinfo_s
310 : : {
311 : : char *name;
312 : : Dwarf_Word mtime;
313 : : Dwarf_Word length;
314 : : } info[0];
315 : : /* nfiles of those, followed by char *[ndirs]. */
316 : : };
317 : : typedef struct Dwarf_Fileinfo_s Dwarf_Fileinfo;
318 : :
319 : :
320 : : /* Representation of a row in the line table. */
321 : :
322 : : struct Dwarf_Line_s
323 : : {
324 : : Dwarf_Files *files;
325 : :
326 : : Dwarf_Addr addr;
327 : : unsigned int file;
328 : : int line;
329 : : unsigned short int column;
330 : : unsigned int is_stmt:1;
331 : : unsigned int basic_block:1;
332 : : unsigned int end_sequence:1;
333 : : unsigned int prologue_end:1;
334 : : unsigned int epilogue_begin:1;
335 : : /* The remaining bit fields are not flags, but hold values presumed to be
336 : : small. All the flags and other bit fields should add up to 48 bits
337 : : to give the whole struct a nice round size. */
338 : : unsigned int op_index:8;
339 : : unsigned int isa:8;
340 : : unsigned int discriminator:24;
341 : : /* These are currently only used for the NVIDIA extensions. */
342 : : unsigned int context;
343 : : unsigned int function_name;
344 : : };
345 : :
346 : : struct Dwarf_Lines_s
347 : : {
348 : : size_t nlines;
349 : : struct Dwarf_Line_s info[0];
350 : : };
351 : :
352 : : /* Representation of address ranges. */
353 : : struct Dwarf_Aranges_s
354 : : {
355 : : Dwarf *dbg;
356 : : size_t naranges;
357 : :
358 : : struct Dwarf_Arange_s
359 : : {
360 : : Dwarf_Addr addr;
361 : : Dwarf_Word length;
362 : : Dwarf_Off offset;
363 : : } info[0];
364 : : };
365 : :
366 : : /* DWARF package file unit index. */
367 : : typedef struct Dwarf_Package_Index_s
368 : : {
369 : : Dwarf *dbg;
370 : : uint32_t section_count;
371 : : uint32_t unit_count;
372 : : uint32_t slot_count;
373 : : /* Mapping from DW_SECT_* - 1 to column number in the section tables, or
374 : : UINT32_MAX if not present. */
375 : : uint32_t sections[DW_SECT_RNGLISTS];
376 : : /* Row number of last unit found in the index. */
377 : : uint32_t last_unit_found;
378 : : const unsigned char *hash_table;
379 : : const unsigned char *indices;
380 : : const unsigned char *section_offsets;
381 : : const unsigned char *section_sizes;
382 : : /* If DW_SECT_INFO section offsets were truncated to 32 bits, recovered
383 : : 64-bit offsets. */
384 : : Dwarf_Off *debug_info_offsets;
385 : : } Dwarf_Package_Index;
386 : :
387 : : /* CU representation. */
388 : : struct Dwarf_CU
389 : : {
390 : : Dwarf *dbg;
391 : : Dwarf_Off start;
392 : : Dwarf_Off end;
393 : : /* Row number of this unit in DWARF package file index. */
394 : : uint32_t dwp_row;
395 : : uint8_t address_size;
396 : : uint8_t offset_size;
397 : : uint16_t version;
398 : :
399 : : size_t sec_idx; /* Normally .debug_info, could be .debug_type or "fake". */
400 : :
401 : : /* The unit type if version >= 5. Otherwise 0 for normal CUs (from
402 : : .debug_info) or 1 for v4 type units (from .debug_types). */
403 : : uint8_t unit_type;
404 : :
405 : : /* Zero if the unit type doesn't support a die/type offset and/or id/sig.
406 : : Nonzero if it is a v4 type unit or for DWARFv5 units depending on
407 : : unit_type. */
408 : : size_t subdie_offset;
409 : : uint64_t unit_id8;
410 : :
411 : : /* If this is a skeleton unit this points to the split compile unit.
412 : : Or the other way around if this is a split compile unit. Set to -1
413 : : if not yet searched. Always use __libdw_find_split_unit to access
414 : : this field. */
415 : : struct Dwarf_CU *split;
416 : :
417 : : /* Hash table for the abbreviations. */
418 : : Dwarf_Abbrev_Hash abbrev_hash;
419 : : /* Offset of the first abbreviation. */
420 : : size_t orig_abbrev_offset;
421 : : /* Offset past last read abbreviation. */
422 : : size_t last_abbrev_offset;
423 : :
424 : : /* The srcline information. */
425 : : Dwarf_Lines *lines;
426 : :
427 : : /* The source file information. */
428 : : Dwarf_Files *files;
429 : :
430 : : /* Known location lists. */
431 : : search_tree locs_tree;
432 : :
433 : : /* Base address for use with ranges and locs.
434 : : Don't access directly, call __libdw_cu_base_address. */
435 : : Dwarf_Addr base_address;
436 : :
437 : : /* The offset into the .debug_addr section where index zero begins.
438 : : Don't access directly, call __libdw_cu_addr_base. */
439 : : Dwarf_Off addr_base;
440 : :
441 : : /* The offset into the .debug_str_offsets section where index zero begins.
442 : : Don't access directly, call __libdw_cu_str_off_base. */
443 : : Dwarf_Off str_off_base;
444 : :
445 : : /* The offset into the .debug_ranges section to use for GNU
446 : : DebugFission split units. Don't access directly, call
447 : : __libdw_cu_ranges_base. */
448 : : Dwarf_Off ranges_base;
449 : :
450 : : /* The start of the offset table in .debug_loclists.
451 : : Don't access directly, call __libdw_cu_locs_base. */
452 : : Dwarf_Off locs_base;
453 : :
454 : : /* Synchronize access to the abbrev member of a Dwarf_Die that
455 : : refers to this Dwarf_CU. */
456 : : rwlock_define(, abbrev_lock);
457 : :
458 : : /* Synchronize access to the split member of this Dwarf_CU. */
459 : : rwlock_define(, split_lock);
460 : :
461 : : /* Memory boundaries of this CU. */
462 : : void *startp;
463 : : void *endp;
464 : : };
465 : :
466 : : /* Aliases to avoid PLTs. */
467 : : INTDECL (dwarf_aggregate_size)
468 : : INTDECL (dwarf_attr)
469 : : INTDECL (dwarf_attr_integrate)
470 : : INTDECL (dwarf_begin)
471 : : INTDECL (dwarf_begin_elf)
472 : : INTDECL (dwarf_child)
473 : : INTDECL (dwarf_cu_dwp_section_info)
474 : : INTDECL (dwarf_default_lower_bound)
475 : : INTDECL (dwarf_dieoffset)
476 : : INTDECL (dwarf_diename)
477 : : INTDECL (dwarf_end)
478 : : INTDECL (dwarf_entrypc)
479 : : INTDECL (dwarf_errmsg)
480 : : INTDECL (dwarf_formaddr)
481 : : INTDECL (dwarf_formblock)
482 : : INTDECL (dwarf_formref_die)
483 : : INTDECL (dwarf_formsdata)
484 : : INTDECL (dwarf_formstring)
485 : : INTDECL (dwarf_formudata)
486 : : INTDECL (dwarf_getabbrevattr_data)
487 : : INTDECL (dwarf_getalt)
488 : : INTDECL (dwarf_getarange_addr)
489 : : INTDECL (dwarf_getarangeinfo)
490 : : INTDECL (dwarf_getaranges)
491 : : INTDECL (dwarf_getlocation_die)
492 : : INTDECL (dwarf_getsrcfiles)
493 : : INTDECL (dwarf_getsrclines)
494 : : INTDECL (dwarf_get_units)
495 : : INTDECL (dwarf_hasattr)
496 : : INTDECL (dwarf_haschildren)
497 : : INTDECL (dwarf_haspc)
498 : : INTDECL (dwarf_highpc)
499 : : INTDECL (dwarf_language)
500 : : INTDECL (dwarf_language_lower_bound)
501 : : INTDECL (dwarf_lowpc)
502 : : INTDECL (dwarf_nextcu)
503 : : INTDECL (dwarf_next_unit)
504 : : INTDECL (dwarf_offdie)
505 : : INTDECL (dwarf_peel_type)
506 : : INTDECL (dwarf_ranges)
507 : : INTDECL (dwarf_setalt)
508 : : INTDECL (dwarf_siblingof)
509 : : INTDECL (dwarf_srclang)
510 : : INTDECL (dwarf_tag)
511 : :
512 : : #define ISV4TU(cu) ((cu)->version == 4 && (cu)->sec_idx == IDX_debug_types)
513 : :
514 : : /* Compute the offset of a CU's first DIE from the CU offset.
515 : : CU must be a valid/known version/unit_type. */
516 : : static inline Dwarf_Off
517 : 7901262 : __libdw_first_die_from_cu_start (Dwarf_Off cu_start,
518 : : uint8_t offset_size,
519 : : uint16_t version,
520 : : uint8_t unit_type)
521 : : {
522 : : /*
523 : : assert (offset_size == 4 || offset_size == 8);
524 : : assert (version >= 2 && version <= 5);
525 : : assert (unit_type == DW_UT_compile
526 : : || unit_type == DW_UT_partial
527 : : || unit_type == DW_UT_skeleton
528 : : || unit_type == DW_UT_split_compile
529 : : || unit_type == DW_UT_type
530 : : || unit_type == DW_UT_split_type);
531 : : */
532 : :
533 : 7901262 : Dwarf_Off off = cu_start;
534 [ + + ]: 7901262 : if (version < 5)
535 : : {
536 : : /*
537 : : LEN VER OFFSET ADDR
538 : : 4-bytes + 2-bytes + 4-bytes + 1-byte for 32-bit dwarf
539 : : 12-bytes + 2-bytes + 8-bytes + 1-byte for 64-bit dwarf
540 : : or in .debug_types, SIGNATURE TYPE-OFFSET
541 : : 4-bytes + 2-bytes + 4-bytes + 1-byte + 8-bytes + 4-bytes for 32-bit
542 : : 12-bytes + 2-bytes + 8-bytes + 1-byte + 8-bytes + 8-bytes for 64-bit
543 : :
544 : : Note the trick in the computation. If the offset_size is 4
545 : : the '- 4' term changes the '3 *' (or '4 *') into a '2 *' (or '3 *).
546 : : If the offset_size is 8 it accounts for the 4-byte escape value
547 : : used at the start of the length. */
548 [ + + ]: 214004 : if (unit_type != DW_UT_type)
549 : 213898 : off += 3 * offset_size - 4 + 3;
550 : : else
551 : 106 : off += 4 * offset_size - 4 + 3 + 8;
552 : : }
553 : : else
554 : : {
555 : : /*
556 : : LEN VER TYPE ADDR OFFSET SIGNATURE TYPE-OFFSET
557 : : 4-bytes + 2-bytes + 1-byte + 1-byte + 4-bytes + 8-bytes + 4-bytes 32-bit
558 : : 12-bytes + 2-bytes + 1-byte + 1-byte + 8-bytes + 8-bytes + 8-bytes 64-bit
559 : : Both signature and type offset are optional.
560 : :
561 : : Note same 4/8 offset size trick as above.
562 : : We explicitly ignore unknown unit types (see asserts above). */
563 : 7687258 : off += 3 * offset_size - 4 + 4;
564 : 7687258 : if (unit_type == DW_UT_skeleton || unit_type == DW_UT_split_compile
565 [ + + + + ]: 7687258 : || unit_type == DW_UT_type || unit_type == DW_UT_split_type)
566 : : {
567 : 2952 : off += 8;
568 [ + + ]: 2952 : if (unit_type == DW_UT_type || unit_type == DW_UT_split_type)
569 : 38 : off += offset_size;
570 : : }
571 : : }
572 : :
573 : 7901262 : return off;
574 : : }
575 : :
576 : : static inline Dwarf_Off
577 : 7752864 : __libdw_first_die_off_from_cu (struct Dwarf_CU *cu)
578 : : {
579 : 7752864 : return __libdw_first_die_from_cu_start (cu->start,
580 : 7752864 : cu->offset_size,
581 : 7752864 : cu->version,
582 : 7752864 : cu->unit_type);
583 : : }
584 : :
585 : : #define CUDIE(fromcu) \
586 : : ((Dwarf_Die) \
587 : : { \
588 : : .cu = (fromcu), \
589 : : .addr = ((char *) (fromcu)->dbg->sectiondata[cu_sec_idx (fromcu)]->d_buf \
590 : : + __libdw_first_die_off_from_cu (fromcu)) \
591 : : })
592 : :
593 : : #define SUBDIE(fromcu) \
594 : : ((Dwarf_Die) \
595 : : { \
596 : : .cu = (fromcu), \
597 : : .addr = ((char *) (fromcu)->dbg->sectiondata[cu_sec_idx (fromcu)]->d_buf \
598 : : + (fromcu)->start + (fromcu)->subdie_offset) \
599 : : })
600 : :
601 : :
602 : : /* Prototype of a single .debug_macro operator. */
603 : : typedef struct
604 : : {
605 : : Dwarf_Word nforms;
606 : : unsigned char const *forms;
607 : : } Dwarf_Macro_Op_Proto;
608 : :
609 : : /* Prototype table. */
610 : : typedef struct
611 : : {
612 : : Dwarf *dbg;
613 : :
614 : : /* Offset of .debug_macro section. */
615 : : Dwarf_Off offset;
616 : :
617 : : /* Offset of associated .debug_line section. */
618 : : Dwarf_Off line_offset;
619 : :
620 : : /* The source file information. */
621 : : Dwarf_Files *files;
622 : :
623 : : /* If this macro unit was opened through dwarf_getmacros or
624 : : dwarf_getmacros_die, this caches value of DW_AT_comp_dir, if
625 : : present. */
626 : : const char *comp_dir;
627 : :
628 : : /* Header length. */
629 : : Dwarf_Half header_len;
630 : :
631 : : uint16_t version;
632 : : uint8_t address_size;
633 : : uint8_t offset_size;
634 : : uint8_t sec_index; /* IDX_debug_macro or IDX_debug_macinfo. */
635 : :
636 : : /* Shows where in TABLE each opcode is defined. Since opcode 0 is
637 : : never used, it stores index of opcode X in X-1'th element. The
638 : : value of 0xff means not stored at all. */
639 : : unsigned char opcodes[255];
640 : :
641 : : /* Individual opcode prototypes. */
642 : : Dwarf_Macro_Op_Proto table[];
643 : : } Dwarf_Macro_Op_Table;
644 : :
645 : : struct Dwarf_Macro_s
646 : : {
647 : : Dwarf_Macro_Op_Table *table;
648 : : Dwarf_Attribute *attributes;
649 : : uint8_t opcode;
650 : : };
651 : :
652 : : static inline Dwarf_Word
653 : 6852 : libdw_macro_nforms (Dwarf_Macro *macro)
654 : : {
655 [ + - ]: 6852 : return macro->table->table[macro->table->opcodes[macro->opcode - 1]].nforms;
656 : : }
657 : :
658 : : /* Returns true for any allowed FORM in the opcode_operands_table as
659 : : mentioned in the DWARF5 spec (6.3.1 Macro Information Header).
660 : : Or those mentioned in DWARF5 spec (6.2.4.2 Vendor-defined Content
661 : : Descriptions) for the directory/file table (plus DW_FORM_strp_sup). */
662 : : static inline bool
663 : 172990 : libdw_valid_user_form (int form)
664 : : {
665 [ - + ]: 172990 : switch (form)
666 : : {
667 : : case DW_FORM_block:
668 : : case DW_FORM_block1:
669 : : case DW_FORM_block2:
670 : : case DW_FORM_block4:
671 : : case DW_FORM_data1:
672 : : case DW_FORM_data2:
673 : : case DW_FORM_data4:
674 : : case DW_FORM_data8:
675 : : case DW_FORM_data16:
676 : : case DW_FORM_flag:
677 : : case DW_FORM_line_strp:
678 : : case DW_FORM_sdata:
679 : : case DW_FORM_sec_offset:
680 : : case DW_FORM_string:
681 : : case DW_FORM_strp:
682 : : case DW_FORM_strp_sup:
683 : : case DW_FORM_strx:
684 : : case DW_FORM_strx1:
685 : : case DW_FORM_strx2:
686 : : case DW_FORM_strx3:
687 : : case DW_FORM_strx4:
688 : : case DW_FORM_udata:
689 : : return true;
690 : 0 : default:
691 : 0 : return false;
692 : : }
693 : : }
694 : :
695 : :
696 : : /* We have to include the file at this point because the inline
697 : : functions access internals of the Dwarf structure. */
698 : : #include "memory-access.h"
699 : :
700 : :
701 : : /* Set error value. */
702 : : extern void __libdw_seterrno (int value) internal_function;
703 : :
704 : :
705 : : /* Memory handling, the easy parts. */
706 : : #define libdw_alloc(dbg, type, tsize, cnt) \
707 : : ({ struct libdw_memblock *_tail = __libdw_alloc_tail(dbg); \
708 : : size_t _required = (tsize) * (cnt); \
709 : : type *_result = (type *) (_tail->mem + (_tail->size - _tail->remaining));\
710 : : size_t _padding = ((__alignof (type) \
711 : : - ((uintptr_t) _result & (__alignof (type) - 1))) \
712 : : & (__alignof (type) - 1)); \
713 : : if (unlikely (_tail->remaining < _required + _padding)) \
714 : : _result = (type *) __libdw_allocate (dbg, _required, __alignof (type));\
715 : : else \
716 : : { \
717 : : _required += _padding; \
718 : : _result = (type *) ((char *) _result + _padding); \
719 : : _tail->remaining -= _required; \
720 : : } \
721 : : _result; })
722 : :
723 : : #define libdw_typed_alloc(dbg, type) \
724 : : libdw_alloc (dbg, type, sizeof (type), 1)
725 : :
726 : : /* Can only be used to undo the last libdw_alloc. */
727 : : #define libdw_unalloc(dbg, type, tsize, cnt) \
728 : : ({ struct libdw_memblock *_tail = __libdw_thread_tail (dbg); \
729 : : size_t _required = (tsize) * (cnt); \
730 : : /* We cannot know the padding, it is lost. */ \
731 : : _tail->remaining += _required; }) \
732 : :
733 : : #define libdw_typed_unalloc(dbg, type) \
734 : : libdw_unalloc (dbg, type, sizeof (type), 1)
735 : :
736 : : /* Callback to choose a thread-local memory allocation stack. */
737 : : extern struct libdw_memblock *__libdw_alloc_tail (Dwarf* dbg)
738 : : __nonnull_attribute__ (1);
739 : :
740 : : extern struct libdw_memblock *__libdw_thread_tail (Dwarf* dbg)
741 : : __nonnull_attribute__ (1);
742 : :
743 : : /* Callback to allocate more. */
744 : : extern void *__libdw_allocate (Dwarf *dbg, size_t minsize, size_t align)
745 : : __attribute__ ((__malloc__)) __nonnull_attribute__ (1);
746 : :
747 : : /* Default OOM handler. */
748 : : extern void __libdw_oom (void) __attribute ((noreturn)) attribute_hidden;
749 : :
750 : : /* Read next unit (or v4 debug type) and return next offset. Doesn't
751 : : create an actual Dwarf_CU just provides necessary header fields. */
752 : : extern int
753 : : internal_function
754 : : __libdw_next_unit (Dwarf *dbg, bool v4_debug_types, Dwarf_Off off,
755 : : Dwarf_Off *next_off, size_t *header_sizep,
756 : : Dwarf_Half *versionp, uint8_t *unit_typep,
757 : : Dwarf_Off *abbrev_offsetp, uint8_t *address_sizep,
758 : : uint8_t *offset_sizep, uint64_t *unit_id8p,
759 : : Dwarf_Off *subdie_offsetp)
760 : : __nonnull_attribute__ (4) internal_function;
761 : :
762 : : /* Allocate the internal data for a unit not seen before. */
763 : : extern struct Dwarf_CU *__libdw_intern_next_unit (Dwarf *dbg, bool debug_types)
764 : : __nonnull_attribute__ (1) internal_function;
765 : :
766 : : /* Find CU for given offset. */
767 : : extern struct Dwarf_CU *__libdw_findcu (Dwarf *dbg, Dwarf_Off offset, bool tu)
768 : : __nonnull_attribute__ (1) internal_function;
769 : :
770 : : /* Find CU for given DIE address. */
771 : : extern struct Dwarf_CU *__libdw_findcu_addr (Dwarf *dbg, void *addr)
772 : : __nonnull_attribute__ (1) internal_function;
773 : :
774 : : /* Find split Dwarf for given DIE address. */
775 : : extern struct Dwarf *__libdw_find_split_dbg_addr (Dwarf *dbg, void *addr)
776 : : __nonnull_attribute__ (1) internal_function;
777 : :
778 : : /* Find the split (or skeleton) unit. */
779 : : extern struct Dwarf_CU *__libdw_find_split_unit (Dwarf_CU *cu)
780 : : internal_function;
781 : :
782 : : /* Find a unit in a DWARF package file for __libdw_intern_next_unit. */
783 : : extern int __libdw_dwp_find_unit (Dwarf *dbg, bool debug_types, Dwarf_Off off,
784 : : uint16_t version, uint8_t unit_type,
785 : : uint64_t unit_id8, uint32_t *unit_rowp,
786 : : Dwarf_Off *abbrev_offsetp)
787 : : __nonnull_attribute__ (1, 7, 8) internal_function;
788 : :
789 : : /* Find the compilation unit in a DWARF package file with the given id. */
790 : : extern Dwarf_CU *__libdw_dwp_findcu_id (Dwarf *dbg, uint64_t unit_id8)
791 : : __nonnull_attribute__ (1) internal_function;
792 : :
793 : : /* Get abbreviation with given code. */
794 : : extern Dwarf_Abbrev *__libdw_findabbrev (struct Dwarf_CU *cu,
795 : : unsigned int code)
796 : : __nonnull_attribute__ (1) internal_function;
797 : :
798 : : /* Get abbreviation at given offset. */
799 : : extern Dwarf_Abbrev *__libdw_getabbrev (Dwarf *dbg, struct Dwarf_CU *cu,
800 : : Dwarf_Off offset, size_t *lengthp)
801 : : __nonnull_attribute__ (1) internal_function;
802 : :
803 : : /* Get abbreviation of given DIE, and optionally set *READP to the DIE memory
804 : : just past the abbreviation code. */
805 : : static inline Dwarf_Abbrev *
806 : : __nonnull_attribute__ (1)
807 : 137493426 : __libdw_dieabbrev (Dwarf_Die *die, const unsigned char **readp)
808 : : {
809 [ + + ]: 137493426 : if (unlikely (die->cu == NULL))
810 : : {
811 : 26086 : die->abbrev = DWARF_END_ABBREV;
812 : 26086 : return DWARF_END_ABBREV;
813 : : }
814 : :
815 : 137467340 : rwlock_wrlock (die->cu->abbrev_lock);
816 : :
817 : : /* Do we need to get the abbreviation, or need to read after the code? */
818 [ + + + + ]: 137467340 : if (die->abbrev == NULL || readp != NULL)
819 : : {
820 : : /* Get the abbreviation code. */
821 : 75295996 : unsigned int code;
822 : 75295996 : const unsigned char *addr = die->addr;
823 : :
824 [ - + ]: 75295996 : if (addr >= (const unsigned char *) die->cu->endp)
825 : : {
826 : 0 : die->abbrev = DWARF_END_ABBREV;
827 : 0 : rwlock_unlock (die->cu->abbrev_lock);
828 : 0 : return DWARF_END_ABBREV;
829 : : }
830 : :
831 : 75295996 : get_uleb128 (code, addr, die->cu->endp);
832 [ + + ]: 75295996 : if (readp != NULL)
833 : 49505310 : *readp = addr;
834 : :
835 : : /* Find the abbreviation. */
836 [ + + ]: 75295996 : if (die->abbrev == NULL)
837 : 33583000 : die->abbrev = __libdw_findabbrev (die->cu, code);
838 : : }
839 : :
840 : 137467340 : Dwarf_Abbrev *result = die->abbrev;
841 : 137467340 : rwlock_unlock (die->cu->abbrev_lock);
842 : :
843 : 137467340 : return result;
844 : : }
845 : :
846 : : /* Helper functions for form handling. */
847 : : extern size_t __libdw_form_val_compute_len (struct Dwarf_CU *cu,
848 : : unsigned int form,
849 : : const unsigned char *valp)
850 : : __nonnull_attribute__ (1, 3) internal_function;
851 : :
852 : : /* Find the length of a form attribute in DIE/info data. */
853 : : static inline size_t
854 : : __nonnull_attribute__ (1, 3)
855 : 194893496 : __libdw_form_val_len (struct Dwarf_CU *cu, unsigned int form,
856 : : const unsigned char *valp)
857 : : {
858 : : /* Small lookup table of forms with fixed lengths. Absent indexes are
859 : : initialized 0, so any truly desired 0 is set to 0x80 and masked. */
860 : 194893496 : static const uint8_t form_lengths[] =
861 : : {
862 : : [DW_FORM_flag_present] = 0x80,
863 : : [DW_FORM_implicit_const] = 0x80, /* Value is in abbrev, not in info. */
864 : :
865 : : [DW_FORM_flag] = 1,
866 : : [DW_FORM_data1] = 1, [DW_FORM_ref1] = 1,
867 : : [DW_FORM_addrx1] = 1, [DW_FORM_strx1] = 1,
868 : :
869 : : [DW_FORM_data2] = 2, [DW_FORM_ref2] = 2,
870 : : [DW_FORM_addrx2] = 2, [DW_FORM_strx2] = 2,
871 : :
872 : : [DW_FORM_addrx3] = 3, [DW_FORM_strx3] = 3,
873 : :
874 : : [DW_FORM_data4] = 4, [DW_FORM_ref4] = 4, [DW_FORM_ref_sup4] = 4,
875 : : [DW_FORM_addrx4] = 4, [DW_FORM_strx4] = 4,
876 : :
877 : : [DW_FORM_ref_sig8] = 8,
878 : : [DW_FORM_data8] = 8, [DW_FORM_ref8] = 8, [DW_FORM_ref_sup8] = 8,
879 : :
880 : : [DW_FORM_data16] = 16,
881 : : };
882 : :
883 : : /* Return immediately for forms with fixed lengths. */
884 [ + + ]: 194893496 : if (form < sizeof form_lengths / sizeof form_lengths[0])
885 : : {
886 : 194876212 : uint8_t len = form_lengths[form];
887 [ + + ]: 194876212 : if (len != 0)
888 : : {
889 : 140145946 : const unsigned char *endp = cu->endp;
890 : 140145946 : len &= 0x7f; /* Mask to allow 0x80 -> 0. */
891 [ - + ]: 140145946 : if (unlikely (len > (size_t) (endp - valp)))
892 : : {
893 : 0 : __libdw_seterrno (DWARF_E_INVALID_DWARF);
894 : 0 : return -1;
895 : : }
896 : : return len;
897 : : }
898 : : }
899 : :
900 : : /* Other forms require some computation. */
901 : 54747550 : return __libdw_form_val_compute_len (cu, form, valp);
902 : : }
903 : :
904 : : /* Helper function for DW_FORM_ref* handling. */
905 : : extern int __libdw_formref (Dwarf_Attribute *attr, Dwarf_Off *return_offset)
906 : : __nonnull_attribute__ (1, 2) internal_function;
907 : :
908 : :
909 : : /* Helper function to locate attribute. */
910 : : extern unsigned char *__libdw_find_attr (Dwarf_Die *die,
911 : : unsigned int search_name,
912 : : unsigned int *codep,
913 : : unsigned int *formp)
914 : : __nonnull_attribute__ (1) internal_function;
915 : :
916 : : /* Helper function to access integer attribute. */
917 : : extern int __libdw_attr_intval (Dwarf_Die *die, int *valp, int attval)
918 : : __nonnull_attribute__ (1, 2) internal_function;
919 : :
920 : : /* Helper function to walk scopes. */
921 : : struct Dwarf_Die_Chain
922 : : {
923 : : Dwarf_Die die;
924 : : struct Dwarf_Die_Chain *parent;
925 : : bool prune; /* The PREVISIT function can set this. */
926 : : };
927 : : extern int __libdw_visit_scopes (unsigned int depth,
928 : : struct Dwarf_Die_Chain *root,
929 : : struct Dwarf_Die_Chain *imports,
930 : : int (*previsit) (unsigned int depth,
931 : : struct Dwarf_Die_Chain *,
932 : : void *arg),
933 : : int (*postvisit) (unsigned int depth,
934 : : struct Dwarf_Die_Chain *,
935 : : void *arg),
936 : : void *arg)
937 : : __nonnull_attribute__ (2, 4) internal_function;
938 : :
939 : : /* Parse a DWARF Dwarf_Block into an array of Dwarf_Op's,
940 : : and cache the result (via tsearch). */
941 : : extern int __libdw_intern_expression (Dwarf *dbg,
942 : : bool other_byte_order,
943 : : unsigned int address_size,
944 : : unsigned int ref_size,
945 : : search_tree *cache,
946 : : const Dwarf_Block *block,
947 : : bool cfap, bool valuep,
948 : : Dwarf_Op **llbuf, size_t *listlen,
949 : : int sec_index)
950 : : __nonnull_attribute__ (5, 6, 9, 10) internal_function;
951 : :
952 : : extern Dwarf_Die *__libdw_offdie (Dwarf *dbg, Dwarf_Off offset,
953 : : Dwarf_Die *result, bool debug_types)
954 : : internal_function;
955 : :
956 : :
957 : : /* Return error code of last failing function call. This value is kept
958 : : separately for each thread. */
959 : : extern int __dwarf_errno_internal (void);
960 : :
961 : :
962 : : /* Reader hooks. */
963 : :
964 : : /* Relocation hooks return -1 on error (in that case the error code
965 : : must already have been set), 0 if there is no relocation and 1 if a
966 : : relocation was present.*/
967 : :
968 : : static inline int
969 : : __libdw_relocate_address (Dwarf *dbg __attribute__ ((unused)),
970 : : int sec_index __attribute__ ((unused)),
971 : : const void *addr __attribute__ ((unused)),
972 : : int width __attribute__ ((unused)),
973 : : Dwarf_Addr *val __attribute__ ((unused)))
974 : : {
975 : : return 0;
976 : : }
977 : :
978 : : static inline int
979 : : __libdw_relocate_offset (Dwarf *dbg __attribute__ ((unused)),
980 : : int sec_index __attribute__ ((unused)),
981 : : const void *addr __attribute__ ((unused)),
982 : : int width __attribute__ ((unused)),
983 : : Dwarf_Off *val __attribute__ ((unused)))
984 : : {
985 : : return 0;
986 : : }
987 : :
988 : : static inline Elf_Data *
989 : 10065290 : __libdw_checked_get_data (Dwarf *dbg, int sec_index)
990 : : {
991 : 10065290 : Elf_Data *data = dbg->sectiondata[sec_index];
992 [ + - ]: 10065290 : if (unlikely (data == NULL)
993 [ - + ]: 10065290 : || unlikely (data->d_buf == NULL))
994 : : {
995 : 0 : __libdw_seterrno (DWARF_E_INVALID_DWARF);
996 : 0 : return NULL;
997 : : }
998 : : return data;
999 : : }
1000 : :
1001 : : static inline int
1002 : 4767406 : __libdw_offset_in_section (Dwarf *dbg, int sec_index,
1003 : : Dwarf_Off offset, size_t size)
1004 : : {
1005 : 4767406 : Elf_Data *data = __libdw_checked_get_data (dbg, sec_index);
1006 [ - + ]: 4767406 : if (data == NULL)
1007 : : return -1;
1008 [ + - ]: 4767406 : if (unlikely (offset > data->d_size)
1009 [ + - ]: 4767406 : || unlikely (data->d_size < size)
1010 [ - + ]: 4767406 : || unlikely (offset > data->d_size - size))
1011 : : {
1012 : 0 : __libdw_seterrno (DWARF_E_INVALID_OFFSET);
1013 : 0 : return -1;
1014 : : }
1015 : :
1016 : : return 0;
1017 : : }
1018 : :
1019 : : static inline bool
1020 : 5246308 : __libdw_in_section (Dwarf *dbg, int sec_index,
1021 : : const void *addr, size_t size)
1022 : : {
1023 : 5246308 : Elf_Data *data = __libdw_checked_get_data (dbg, sec_index);
1024 [ - + ]: 5246308 : if (data == NULL)
1025 : : return false;
1026 [ + - ]: 5246308 : if (unlikely (addr < data->d_buf)
1027 [ + - ]: 5246308 : || unlikely (data->d_size < size)
1028 [ - + ]: 5246308 : || unlikely ((size_t)(addr - data->d_buf) > data->d_size - size))
1029 : : {
1030 : 0 : __libdw_seterrno (DWARF_E_INVALID_OFFSET);
1031 : 0 : return false;
1032 : : }
1033 : :
1034 : : return true;
1035 : : }
1036 : :
1037 : : #define READ_AND_RELOCATE(RELOC_HOOK, VAL) \
1038 : : ({ \
1039 : : if (!__libdw_in_section (dbg, sec_index, addr, width)) \
1040 : : return -1; \
1041 : : \
1042 : : const unsigned char *orig_addr = addr; \
1043 : : if (width == 4) \
1044 : : VAL = read_4ubyte_unaligned_inc (dbg, addr); \
1045 : : else \
1046 : : VAL = read_8ubyte_unaligned_inc (dbg, addr); \
1047 : : \
1048 : : int status = RELOC_HOOK (dbg, sec_index, orig_addr, width, &VAL); \
1049 : : if (status < 0) \
1050 : : return status; \
1051 : : status > 0; \
1052 : : })
1053 : :
1054 : : static inline int
1055 : 116156 : __libdw_read_address_inc (Dwarf *dbg,
1056 : : int sec_index, const unsigned char **addrp,
1057 : : int width, Dwarf_Addr *ret)
1058 : : {
1059 : 116156 : const unsigned char *addr = *addrp;
1060 [ + - + + : 116156 : READ_AND_RELOCATE (__libdw_relocate_address, (*ret));
+ + + + ]
1061 : 116156 : *addrp = addr;
1062 : 116156 : return 0;
1063 : : }
1064 : :
1065 : : static inline int
1066 : 413536 : __libdw_read_address (Dwarf *dbg,
1067 : : int sec_index, const unsigned char *addr,
1068 : : int width, Dwarf_Addr *ret)
1069 : : {
1070 [ + - + + : 413536 : READ_AND_RELOCATE (__libdw_relocate_address, (*ret));
+ + + + ]
1071 : : return 0;
1072 : : }
1073 : :
1074 : : static inline int
1075 : 155864 : __libdw_read_offset_inc (Dwarf *dbg,
1076 : : int sec_index, const unsigned char **addrp,
1077 : : int width, Dwarf_Off *ret, int sec_ret,
1078 : : size_t size)
1079 : : {
1080 : 155864 : const unsigned char *addr = *addrp;
1081 [ + - + - : 155864 : READ_AND_RELOCATE (__libdw_relocate_offset, (*ret));
+ + - - ]
1082 : 155864 : *addrp = addr;
1083 : 155864 : return __libdw_offset_in_section (dbg, sec_ret, *ret, size);
1084 : : }
1085 : :
1086 : : static inline int
1087 : 4559756 : __libdw_read_offset (Dwarf *dbg, Dwarf *dbg_ret,
1088 : : int sec_index, const unsigned char *addr,
1089 : : int width, Dwarf_Off *ret, int sec_ret,
1090 : : size_t size)
1091 : : {
1092 [ + - + - : 4559756 : READ_AND_RELOCATE (__libdw_relocate_offset, (*ret));
+ + - - ]
1093 : 4559756 : return __libdw_offset_in_section (dbg_ret, sec_ret, *ret, size);
1094 : : }
1095 : :
1096 : : static inline size_t
1097 : 12524760 : cu_sec_idx (struct Dwarf_CU *cu)
1098 : : {
1099 [ + + ]: 10691948 : return cu->sec_idx;
1100 : : }
1101 : :
1102 : : static inline bool
1103 : 6241466 : is_cudie (Dwarf_Die *cudie)
1104 : : {
1105 [ + + + + ]: 6241466 : return cudie->cu != NULL && CUDIE (cudie->cu).addr == cudie->addr;
1106 : : }
1107 : :
1108 : : /* Read up begin/end pair and increment read pointer.
1109 : : - If it's normal range record, set up *BEGINP and *ENDP and return 0.
1110 : : - If it's base address selection record, set up *BASEP and return 1.
1111 : : - If it's end of rangelist, don't set anything and return 2
1112 : : - If an error occurs, don't set anything and return <0. */
1113 : : int __libdw_read_begin_end_pair_inc (Dwarf_CU *cu, int sec_index,
1114 : : const unsigned char **readp,
1115 : : const unsigned char *readend,
1116 : : int width,
1117 : : Dwarf_Addr *beginp, Dwarf_Addr *endp,
1118 : : Dwarf_Addr *basep)
1119 : : internal_function;
1120 : :
1121 : : const unsigned char * __libdw_formptr (Dwarf_Attribute *attr, int sec_index,
1122 : : int err_nodata,
1123 : : const unsigned char **endpp,
1124 : : Dwarf_Off *offsetp)
1125 : : internal_function;
1126 : :
1127 : : /* Fills in the given attribute to point at an empty location expression. */
1128 : : void __libdw_empty_loc_attr (Dwarf_Attribute *attr)
1129 : : internal_function;
1130 : :
1131 : : /* Load .debug_line unit at DEBUG_LINE_OFFSET. COMP_DIR is a value of
1132 : : DW_AT_comp_dir or NULL if that attribute is not available. Caches
1133 : : the loaded unit and optionally set *LINESP and/or *FILESP (if not
1134 : : NULL) with loaded information. Returns 0 for success or a negative
1135 : : value for failure. */
1136 : : int __libdw_getsrclines (Dwarf *dbg, Dwarf_Off debug_line_offset,
1137 : : const char *comp_dir, unsigned address_size,
1138 : : Dwarf_Lines **linesp, Dwarf_Files **filesp)
1139 : : internal_function
1140 : : __nonnull_attribute__ (1);
1141 : :
1142 : : /* Load .debug_line unit at DEBUG_LINE_OFFSET. COMP_DIR is a value of
1143 : : DW_AT_comp_dir or NULL if that attribute is not available. Caches
1144 : : the loaded unit and set *FILESP with loaded information. Returns 0
1145 : : for success or a negative value for failure. */
1146 : : int __libdw_getsrcfiles (Dwarf *dbg, Dwarf_Off debug_line_offset,
1147 : : const char *comp_dir, unsigned address_size,
1148 : : Dwarf_Files **filesp)
1149 : : internal_function
1150 : : __nonnull_attribute__ (1);
1151 : :
1152 : : /* Load and return value of DW_AT_comp_dir from CUDIE. */
1153 : : const char *__libdw_getcompdir (Dwarf_Die *cudie);
1154 : :
1155 : : /* Get the base address for the CU, fetches it when not yet set.
1156 : : This is used as initial base address for ranges and loclists. */
1157 : : Dwarf_Addr __libdw_cu_base_address (Dwarf_CU *cu);
1158 : :
1159 : : /* Get the address base for the CU, fetches it when not yet set. */
1160 : : static inline Dwarf_Off
1161 : 1964 : __libdw_cu_addr_base (Dwarf_CU *cu)
1162 : : {
1163 [ + + ]: 1964 : if (cu->addr_base == (Dwarf_Off) -1)
1164 : : {
1165 : 182 : Dwarf_Die cu_die = CUDIE(cu);
1166 : 182 : Dwarf_Attribute attr;
1167 : 182 : Dwarf_Off offset = 0;
1168 [ + + ]: 182 : if (dwarf_attr (&cu_die, DW_AT_GNU_addr_base, &attr) != NULL
1169 [ + - ]: 90 : || dwarf_attr (&cu_die, DW_AT_addr_base, &attr) != NULL)
1170 : : {
1171 : 182 : Dwarf_Word off;
1172 [ + - ]: 182 : if (dwarf_formudata (&attr, &off) == 0)
1173 : 182 : offset = off;
1174 : : }
1175 : 182 : cu->addr_base = offset;
1176 : : }
1177 : :
1178 : 1964 : return cu->addr_base;
1179 : : }
1180 : :
1181 : : /* Gets the .debug_str_offsets base offset to use. static inline to
1182 : : be shared between libdw and eu-readelf. */
1183 : : static inline Dwarf_Off
1184 : 13970 : str_offsets_base_off (Dwarf *dbg, Dwarf_CU *cu)
1185 : : {
1186 : : /* If we don't have a CU, then find and use the first one in the
1187 : : debug file (when we support .dwp files, we must actually find the
1188 : : one matching our "caller" - aka macro or line). If we (now) have
1189 : : a cu and str_offsets_base attribute, just use that. Otherwise
1190 : : use the first offset. But we might have to parse the header
1191 : : first, but only if this is version 5. Assume if all else fails,
1192 : : this is version 4, without header. */
1193 : :
1194 [ + + ]: 13970 : if (cu == NULL && dbg != NULL)
1195 : : {
1196 : 3904 : Dwarf_CU *first_cu;
1197 [ + + ]: 3904 : if (dwarf_get_units (dbg, NULL, &first_cu, NULL, NULL, NULL, NULL) == 0)
1198 : 3902 : cu = first_cu;
1199 : : }
1200 : :
1201 : 13970 : Dwarf_Off off = 0;
1202 [ + + ]: 13970 : if (cu != NULL)
1203 : : {
1204 [ + + ]: 13968 : if (cu->str_off_base == (Dwarf_Off) -1)
1205 : : {
1206 : 286 : Dwarf_Off dwp_offset;
1207 [ + - ]: 286 : if (dwarf_cu_dwp_section_info (cu, DW_SECT_STR_OFFSETS, &dwp_offset,
1208 : : NULL) == 0)
1209 : 286 : off = dwp_offset;
1210 : 286 : Dwarf_Die cu_die = CUDIE(cu);
1211 : 286 : Dwarf_Attribute attr;
1212 [ + + ]: 286 : if (dwarf_attr (&cu_die, DW_AT_str_offsets_base, &attr) != NULL)
1213 : : {
1214 : 18 : Dwarf_Word base;
1215 [ + - ]: 18 : if (dwarf_formudata (&attr, &base) == 0)
1216 : : {
1217 : 18 : cu->str_off_base = off + base;
1218 : 18 : return cu->str_off_base;
1219 : : }
1220 : : }
1221 : : /* For older DWARF simply assume zero (no header). */
1222 [ + + ]: 268 : if (cu->version < 5)
1223 : : {
1224 : 166 : cu->str_off_base = off;
1225 : 166 : return cu->str_off_base;
1226 : : }
1227 : :
1228 [ + + ]: 102 : if (dbg == NULL)
1229 : 68 : dbg = cu->dbg;
1230 : : }
1231 : : else
1232 : : return cu->str_off_base;
1233 : : }
1234 : :
1235 : : /* No str_offsets_base attribute, we have to assume "zero".
1236 : : But there could be a header first. */
1237 [ - + ]: 104 : if (dbg == NULL)
1238 : 0 : goto no_header;
1239 : :
1240 : 104 : Elf_Data *data = dbg->sectiondata[IDX_debug_str_offsets];
1241 [ + + ]: 104 : if (data == NULL)
1242 : 36 : goto no_header;
1243 : :
1244 : 68 : const unsigned char *start;
1245 : 68 : const unsigned char *readp;
1246 : 68 : const unsigned char *readendp;
1247 : 68 : start = readp = (const unsigned char *) data->d_buf;
1248 : 68 : readendp = (const unsigned char *) data->d_buf + data->d_size;
1249 : :
1250 : 68 : uint64_t unit_length;
1251 : 68 : uint16_t version;
1252 : :
1253 [ - + ]: 68 : unit_length = read_4ubyte_unaligned_inc (dbg, readp);
1254 [ - + ]: 68 : if (unlikely (unit_length == 0xffffffff))
1255 : : {
1256 [ # # ]: 0 : if (unlikely (readendp - readp < 8))
1257 : 0 : goto no_header;
1258 [ # # ]: 0 : unit_length = read_8ubyte_unaligned_inc (dbg, readp);
1259 : : /* In theory the offset size could be different
1260 : : between CU and str_offsets unit. But we just
1261 : : ignore that here. */
1262 : : }
1263 : :
1264 : : /* We need at least 2-bytes (version) + 2-bytes (padding) =
1265 : : 4 bytes to complete the header. And this unit cannot go
1266 : : beyond the section data. */
1267 [ + - ]: 68 : if (readendp - readp < 4
1268 [ + - ]: 68 : || unit_length < 4
1269 [ - + ]: 68 : || (uint64_t) (readendp - readp) < unit_length)
1270 : 0 : goto no_header;
1271 : :
1272 [ - + ]: 68 : version = read_2ubyte_unaligned_inc (dbg, readp);
1273 [ - + ]: 68 : if (version != 5)
1274 : 0 : goto no_header;
1275 : : /* padding */
1276 : 68 : read_2ubyte_unaligned_inc (dbg, readp);
1277 : :
1278 : 68 : off += (Dwarf_Off) (readp - start);
1279 : :
1280 : 104 : no_header:
1281 [ + + ]: 104 : if (cu != NULL)
1282 : 102 : cu->str_off_base = off;
1283 : :
1284 : : return off;
1285 : : }
1286 : :
1287 : :
1288 : : /* Get the string offsets base for the CU, fetches it when not yet set. */
1289 : 3402 : static inline Dwarf_Off __libdw_cu_str_off_base (Dwarf_CU *cu)
1290 : : {
1291 : 3402 : return str_offsets_base_off (NULL, cu);
1292 : : }
1293 : :
1294 : :
1295 : : /* Either a direct offset into .debug_ranges for version < 5, or the
1296 : : start of the offset table in .debug_rnglists for version > 5. */
1297 : : static inline Dwarf_Off
1298 : 90 : __libdw_cu_ranges_base (Dwarf_CU *cu)
1299 : : {
1300 [ + + ]: 90 : if (cu->ranges_base == (Dwarf_Off) -1)
1301 : : {
1302 : 18 : Dwarf_Off offset = 0;
1303 : 18 : Dwarf_Die cu_die = CUDIE(cu);
1304 : 18 : Dwarf_Attribute attr;
1305 [ + + ]: 18 : if (cu->version < 5)
1306 : : {
1307 [ + - ]: 12 : if (dwarf_attr (&cu_die, DW_AT_GNU_ranges_base, &attr) != NULL)
1308 : : {
1309 : 12 : Dwarf_Word off;
1310 [ + - ]: 12 : if (dwarf_formudata (&attr, &off) == 0)
1311 : 12 : offset = off;
1312 : : }
1313 : : }
1314 : : else
1315 : : {
1316 : 6 : Dwarf_Off dwp_offset;
1317 [ + - ]: 6 : if (dwarf_cu_dwp_section_info (cu, DW_SECT_RNGLISTS, &dwp_offset,
1318 : : NULL) == 0)
1319 : 6 : offset = dwp_offset;
1320 : :
1321 [ + + ]: 6 : if (dwarf_attr (&cu_die, DW_AT_rnglists_base, &attr) != NULL)
1322 : : {
1323 : 2 : Dwarf_Word off;
1324 [ + - ]: 2 : if (dwarf_formudata (&attr, &off) == 0)
1325 : 2 : offset += off;
1326 : : }
1327 : :
1328 : : /* There wasn't an rnglists_base, if the Dwarf does have a
1329 : : .debug_rnglists section, then it might be we need the
1330 : : base after the first header. */
1331 : 6 : Elf_Data *data = cu->dbg->sectiondata[IDX_debug_rnglists];
1332 [ + + + - ]: 6 : if (offset == dwp_offset && data != NULL)
1333 : : {
1334 : 4 : Dwarf *dbg = cu->dbg;
1335 : 4 : const unsigned char *readp = data->d_buf;
1336 : 4 : const unsigned char *const dataend
1337 : 4 : = (unsigned char *) data->d_buf + data->d_size;
1338 : :
1339 [ - + ]: 4 : uint64_t unit_length = read_4ubyte_unaligned_inc (dbg, readp);
1340 : 4 : unsigned int offset_size = 4;
1341 [ - + ]: 4 : if (unlikely (unit_length == 0xffffffff))
1342 : : {
1343 [ # # ]: 0 : if (unlikely (readp > dataend - 8))
1344 : 0 : goto no_header;
1345 : :
1346 [ # # ]: 0 : unit_length = read_8ubyte_unaligned_inc (dbg, readp);
1347 : 0 : offset_size = 8;
1348 : : }
1349 : :
1350 [ + - ]: 4 : if (readp > dataend - 8
1351 [ + - ]: 4 : || unit_length < 8
1352 [ - + ]: 4 : || unit_length > (uint64_t) (dataend - readp))
1353 : 0 : goto no_header;
1354 : :
1355 [ - + ]: 4 : uint16_t version = read_2ubyte_unaligned_inc (dbg, readp);
1356 [ - + ]: 4 : if (version != 5)
1357 : 0 : goto no_header;
1358 : :
1359 : 4 : uint8_t address_size = *readp++;
1360 [ - + ]: 4 : if (address_size != 4 && address_size != 8)
1361 : 0 : goto no_header;
1362 : :
1363 : 4 : uint8_t segment_size = *readp++;
1364 [ - + ]: 4 : if (segment_size != 0)
1365 : 0 : goto no_header;
1366 : :
1367 : 4 : uint32_t offset_entry_count;
1368 [ - + ]: 4 : offset_entry_count = read_4ubyte_unaligned_inc (dbg, readp);
1369 : :
1370 : 4 : const unsigned char *offset_array_start = readp;
1371 [ - + ]: 4 : if (offset_entry_count <= 0)
1372 : 0 : goto no_header;
1373 : :
1374 : 4 : uint64_t needed = offset_entry_count * offset_size;
1375 [ - + ]: 4 : if (unit_length - 8 < needed)
1376 : 0 : goto no_header;
1377 : :
1378 : 4 : offset += (Dwarf_Off) (offset_array_start
1379 : 4 : - (unsigned char *) data->d_buf);
1380 : : }
1381 : : }
1382 : 18 : no_header:
1383 : 18 : cu->ranges_base = offset;
1384 : : }
1385 : :
1386 : 90 : return cu->ranges_base;
1387 : : }
1388 : :
1389 : :
1390 : : /* The start of the offset table in .debug_loclists for DWARF5. */
1391 : : static inline Dwarf_Off
1392 : 218 : __libdw_cu_locs_base (Dwarf_CU *cu)
1393 : : {
1394 [ + + ]: 218 : if (cu->locs_base == (Dwarf_Off) -1)
1395 : : {
1396 : 8 : Dwarf_Off offset = 0;
1397 : 8 : Dwarf_Off dwp_offset;
1398 [ + - ]: 8 : if (dwarf_cu_dwp_section_info (cu, DW_SECT_LOCLISTS, &dwp_offset, NULL)
1399 : : == 0)
1400 : 8 : offset = dwp_offset;
1401 : :
1402 : 8 : Dwarf_Die cu_die = CUDIE(cu);
1403 : 8 : Dwarf_Attribute attr;
1404 [ + + ]: 8 : if (dwarf_attr (&cu_die, DW_AT_loclists_base, &attr) != NULL)
1405 : : {
1406 : 4 : Dwarf_Word off;
1407 [ + - ]: 4 : if (dwarf_formudata (&attr, &off) == 0)
1408 : 4 : offset += off;
1409 : : }
1410 : :
1411 : : /* There wasn't an loclists_base, if the Dwarf does have a
1412 : : .debug_loclists section, then it might be we need the
1413 : : base after the first header. */
1414 : 8 : Elf_Data *data = cu->dbg->sectiondata[IDX_debug_loclists];
1415 [ - + - + ]: 8 : if (offset == dwp_offset && data != NULL)
1416 : : {
1417 : 8 : Dwarf *dbg = cu->dbg;
1418 : 8 : const unsigned char *readp = data->d_buf;
1419 : 8 : const unsigned char *const dataend
1420 : 8 : = (unsigned char *) data->d_buf + data->d_size;
1421 : :
1422 [ - + ]: 8 : uint64_t unit_length = read_4ubyte_unaligned_inc (dbg, readp);
1423 : 8 : unsigned int offset_size = 4;
1424 [ - + ]: 8 : if (unlikely (unit_length == 0xffffffff))
1425 : : {
1426 [ # # ]: 0 : if (unlikely (readp > dataend - 8))
1427 : 0 : goto no_header;
1428 : :
1429 [ # # ]: 0 : unit_length = read_8ubyte_unaligned_inc (dbg, readp);
1430 : 0 : offset_size = 8;
1431 : : }
1432 : :
1433 [ + - ]: 8 : if (readp > dataend - 8
1434 [ + - ]: 8 : || unit_length < 8
1435 [ - + ]: 8 : || unit_length > (uint64_t) (dataend - readp))
1436 : 0 : goto no_header;
1437 : :
1438 [ - + ]: 8 : uint16_t version = read_2ubyte_unaligned_inc (dbg, readp);
1439 [ - + ]: 8 : if (version != 5)
1440 : 0 : goto no_header;
1441 : :
1442 : 8 : uint8_t address_size = *readp++;
1443 [ - + ]: 8 : if (address_size != 4 && address_size != 8)
1444 : 0 : goto no_header;
1445 : :
1446 : 8 : uint8_t segment_size = *readp++;
1447 [ - + ]: 8 : if (segment_size != 0)
1448 : 0 : goto no_header;
1449 : :
1450 : 8 : uint32_t offset_entry_count;
1451 [ - + ]: 8 : offset_entry_count = read_4ubyte_unaligned_inc (dbg, readp);
1452 : :
1453 : 8 : const unsigned char *offset_array_start = readp;
1454 [ - + ]: 8 : if (offset_entry_count <= 0)
1455 : 0 : goto no_header;
1456 : :
1457 : 8 : uint64_t needed = offset_entry_count * offset_size;
1458 [ - + ]: 8 : if (unit_length - 8 < needed)
1459 : 0 : goto no_header;
1460 : :
1461 : 8 : offset += (Dwarf_Off) (offset_array_start
1462 : 8 : - (unsigned char *) data->d_buf);
1463 : : }
1464 : :
1465 : 0 : no_header:
1466 : 8 : cu->locs_base = offset;
1467 : : }
1468 : :
1469 : 218 : return cu->locs_base;
1470 : : }
1471 : :
1472 : : /* Helper function for tsearch/tfind split_tree Dwarf. */
1473 : : int __libdw_finddbg_cb (const void *arg1, const void *arg2);
1474 : :
1475 : : /* Link skeleton and split compile units. */
1476 : : static inline void
1477 : 170 : __libdw_link_skel_split (Dwarf_CU *skel, Dwarf_CU *split)
1478 : : {
1479 : 170 : skel->split = split;
1480 : 170 : split->split = skel;
1481 : :
1482 : : /* Get .debug_addr and addr_base greedy.
1483 : : We also need it for the fake addr cu.
1484 : : This needs to be done for each split unit (one per .dwo file, or multiple
1485 : : per .dwp file). */
1486 : 170 : Dwarf *dbg = skel->dbg;
1487 : 170 : Dwarf *sdbg = split->dbg;
1488 [ + - ]: 170 : if (dbg->sectiondata[IDX_debug_addr] != NULL
1489 : : /* If this split file hasn't been linked yet... */
1490 [ + + ]: 170 : && (sdbg->sectiondata[IDX_debug_addr] == NULL
1491 : : /* ... or it was linked to the same skeleton file for another
1492 : : unit... */
1493 [ + - ]: 44 : || (sdbg->sectiondata[IDX_debug_addr]
1494 : : == dbg->sectiondata[IDX_debug_addr])))
1495 : : {
1496 : : /* ... then link the address information for this file and unit. */
1497 : 170 : sdbg->sectiondata[IDX_debug_addr]
1498 : 170 : = dbg->sectiondata[IDX_debug_addr];
1499 : 170 : split->addr_base = __libdw_cu_addr_base (skel);
1500 : 170 : sdbg->fake_addr_cu = dbg->fake_addr_cu;
1501 : : }
1502 : 170 : }
1503 : :
1504 : :
1505 : : /* Given an address index for a CU return the address.
1506 : : Returns -1 and sets libdw_errno if an error occurs. */
1507 : : int __libdw_addrx (Dwarf_CU *cu, Dwarf_Word idx, Dwarf_Addr *addr);
1508 : :
1509 : :
1510 : : /* Helper function to set elfpath field in Dwarf, used from dwarf_begin_elf
1511 : : and libdwfl process_file. */
1512 : : char * __libdw_elfpath (int fd);
1513 : :
1514 : : /* Helper function to set debugdir field in Dwarf after elfpath field has been
1515 : : set. */
1516 : : void __libdw_set_debugdir (Dwarf *dbg);
1517 : :
1518 : :
1519 : : /* Given the directory of a debug file, an absolute or relative dir
1520 : : to look in, and file returns a full path.
1521 : :
1522 : : If the file is absolute (starts with a /) a copy of file is returned.
1523 : : the file isn't absolute, but dir is absolute, then a path that is
1524 : : the concatenation of dir and file is returned. If neither file,
1525 : : nor dir is absolute, the path will be constructed using dir (if not
1526 : : NULL) and file relative to the debugdir (if valid).
1527 : :
1528 : : The debugdir and the dir may be NULL (in which case they aren't used).
1529 : : If file is NULL, or no full path can be constructed NULL is returned.
1530 : :
1531 : : The caller is responsible for freeing the result if not NULL. */
1532 : : char * __libdw_filepath (const char *debugdir, const char *dir,
1533 : : const char *file)
1534 : : internal_function;
1535 : :
1536 : : /* Like dwarf_getaranges but aranges are generated from CU address
1537 : : ranges instead of being read from .debug_aranges.
1538 : :
1539 : : Returns 0 if successful and updates ARANGES and NARANGES. Otherwise
1540 : : returns -1 and sets libdw_errno.
1541 : : */
1542 : : int __libdw_getdieranges (Dwarf *dbg, Dwarf_Aranges **aranges, size_t *naranges);
1543 : : #endif /* libdwP.h */
|
