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