1 /* dwarf.c -- Get file/line information from DWARF for backtraces.
2 Copyright (C) 2012-2024 Free Software Foundation, Inc.
3 Written by Ian Lance Taylor, Google.
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions are
9 (1) Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
12 (2) Redistributions in binary form must reproduce the above copyright
13 notice, this list of conditions and the following disclaimer in
14 the documentation and/or other materials provided with the
17 (3) The name of the author may not be used to
18 endorse or promote products derived from this software without
19 specific prior written permission.
21 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
25 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
30 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 POSSIBILITY OF SUCH DAMAGE. */
38 #include <sys/types.h>
41 #include "filenames.h"
43 #include "backtrace.h"
46 #if !defined(HAVE_DECL_STRNLEN) || !HAVE_DECL_STRNLEN
48 /* If strnlen is not declared, provide our own version. */
51 xstrnlen (const char *s
, size_t maxlen
)
55 for (i
= 0; i
< maxlen
; ++i
)
61 #define strnlen xstrnlen
65 /* A buffer to read DWARF info. */
69 /* Buffer name for error messages. */
71 /* Start of the buffer. */
72 const unsigned char *start
;
73 /* Next byte to read. */
74 const unsigned char *buf
;
75 /* The number of bytes remaining. */
77 /* Whether the data is big-endian. */
79 /* Error callback routine. */
80 backtrace_error_callback error_callback
;
81 /* Data for error_callback. */
83 /* Non-zero if we've reported an underflow error. */
84 int reported_underflow
;
87 /* A single attribute in a DWARF abbreviation. */
91 /* The attribute name. */
92 enum dwarf_attribute name
;
93 /* The attribute form. */
95 /* The attribute value, for DW_FORM_implicit_const. */
99 /* A single DWARF abbreviation. */
103 /* The abbrev code--the number used to refer to the abbrev. */
107 /* Non-zero if this abbrev has child entries. */
109 /* The number of attributes. */
111 /* The attributes. */
115 /* The DWARF abbreviations for a compilation unit. This structure
116 only exists while reading the compilation unit. Most DWARF readers
117 seem to a hash table to map abbrev ID's to abbrev entries.
118 However, we primarily care about GCC, and GCC simply issues ID's in
119 numerical order starting at 1. So we simply keep a sorted vector,
120 and try to just look up the code. */
124 /* The number of abbrevs in the vector. */
126 /* The abbrevs, sorted by the code field. */
127 struct abbrev
*abbrevs
;
130 /* The different kinds of attribute values. */
132 enum attr_val_encoding
134 /* No attribute value. */
138 /* An index into the .debug_addr section, whose value is relative to
139 the DW_AT_addr_base attribute of the compilation unit. */
140 ATTR_VAL_ADDRESS_INDEX
,
141 /* A unsigned integer. */
143 /* A sigd integer. */
147 /* An index into the .debug_str_offsets section. */
148 ATTR_VAL_STRING_INDEX
,
149 /* An offset to other data in the containing unit. */
151 /* An offset to other data within the .debug_info section. */
153 /* An offset to other data within the alt .debug_info section. */
154 ATTR_VAL_REF_ALT_INFO
,
155 /* An offset to data in some other section. */
156 ATTR_VAL_REF_SECTION
,
157 /* A type signature. */
159 /* An index into the .debug_rnglists section. */
160 ATTR_VAL_RNGLISTS_INDEX
,
161 /* A block of data (not represented). */
163 /* An expression (not represented). */
167 /* An attribute value. */
171 /* How the value is stored in the field u. */
172 enum attr_val_encoding encoding
;
175 /* ATTR_VAL_ADDRESS*, ATTR_VAL_UINT, ATTR_VAL_REF*. */
179 /* ATTR_VAL_STRING. */
181 /* ATTR_VAL_BLOCK not stored. */
185 /* The line number program header. */
189 /* The version of the line number information. */
193 /* The minimum instruction length. */
194 unsigned int min_insn_len
;
195 /* The maximum number of ops per instruction. */
196 unsigned int max_ops_per_insn
;
197 /* The line base for special opcodes. */
199 /* The line range for special opcodes. */
200 unsigned int line_range
;
201 /* The opcode base--the first special opcode. */
202 unsigned int opcode_base
;
203 /* Opcode lengths, indexed by opcode - 1. */
204 const unsigned char *opcode_lengths
;
205 /* The number of directory entries. */
207 /* The directory entries. */
209 /* The number of filenames. */
210 size_t filenames_count
;
212 const char **filenames
;
215 /* A format description from a line header. */
217 struct line_header_format
219 int lnct
; /* LNCT code. */
220 enum dwarf_form form
; /* Form of entry data. */
223 /* Map a single PC value to a file/line. We will keep a vector of
224 these sorted by PC value. Each file/line will be correct from the
225 PC up to the PC of the next entry if there is one. We allocate one
226 extra entry at the end so that we can use bsearch. */
232 /* File name. Many entries in the array are expected to point to
233 the same file name. */
234 const char *filename
;
237 /* Index of the object in the original array read from the DWARF
238 section, before it has been sorted. The index makes it possible
239 to use Quicksort and maintain stability. */
243 /* A growable vector of line number information. This is used while
244 reading the line numbers. */
248 /* Memory. This is an array of struct line. */
249 struct backtrace_vector vec
;
250 /* Number of valid mappings. */
254 /* A function described in the debug info. */
258 /* The name of the function. */
260 /* If this is an inlined function, the filename of the call
262 const char *caller_filename
;
263 /* If this is an inlined function, the line number of the call
266 /* Map PC ranges to inlined functions. */
267 struct function_addrs
*function_addrs
;
268 size_t function_addrs_count
;
271 /* An address range for a function. This maps a PC value to a
272 specific function. */
274 struct function_addrs
276 /* Range is LOW <= PC < HIGH. */
279 /* Function for this address range. */
280 struct function
*function
;
283 /* A growable vector of function address ranges. */
285 struct function_vector
287 /* Memory. This is an array of struct function_addrs. */
288 struct backtrace_vector vec
;
289 /* Number of address ranges present. */
293 /* A DWARF compilation unit. This only holds the information we need
294 to map a PC to a file and line. */
298 /* The first entry for this compilation unit. */
299 const unsigned char *unit_data
;
300 /* The length of the data for this compilation unit. */
301 size_t unit_data_len
;
302 /* The offset of UNIT_DATA from the start of the information for
303 this compilation unit. */
304 size_t unit_data_offset
;
305 /* Offset of the start of the compilation unit from the start of the
306 .debug_info section. */
308 /* Offset of the end of the compilation unit from the start of the
309 .debug_info section. */
313 /* Whether unit is DWARF64. */
317 /* Offset into line number information. */
319 /* Offset of compilation unit in .debug_str_offsets. */
320 uint64_t str_offsets_base
;
321 /* Offset of compilation unit in .debug_addr. */
323 /* Offset of compilation unit in .debug_rnglists. */
324 uint64_t rnglists_base
;
325 /* Primary source file. */
326 const char *filename
;
327 /* Compilation command working directory. */
328 const char *comp_dir
;
329 /* Absolute file name, only set if needed. */
330 const char *abs_filename
;
331 /* The abbreviations for this unit. */
332 struct abbrevs abbrevs
;
334 /* The fields above this point are read in during initialization and
335 may be accessed freely. The fields below this point are read in
336 as needed, and therefore require care, as different threads may
337 try to initialize them simultaneously. */
339 /* PC to line number mapping. This is NULL if the values have not
340 been read. This is (struct line *) -1 if there was an error
341 reading the values. */
343 /* Number of entries in lines. */
345 /* PC ranges to function. */
346 struct function_addrs
*function_addrs
;
347 size_t function_addrs_count
;
350 /* An address range for a compilation unit. This maps a PC value to a
351 specific compilation unit. Note that we invert the representation
352 in DWARF: instead of listing the units and attaching a list of
353 ranges, we list the ranges and have each one point to the unit.
354 This lets us do a binary search to find the unit. */
358 /* Range is LOW <= PC < HIGH. */
361 /* Compilation unit for this address range. */
365 /* A growable vector of compilation unit address ranges. */
367 struct unit_addrs_vector
369 /* Memory. This is an array of struct unit_addrs. */
370 struct backtrace_vector vec
;
371 /* Number of address ranges present. */
375 /* A growable vector of compilation unit pointer. */
379 struct backtrace_vector vec
;
383 /* The information we need to map a PC to a file and line. */
387 /* The data for the next file we know about. */
388 struct dwarf_data
*next
;
389 /* The data for .gnu_debugaltlink. */
390 struct dwarf_data
*altlink
;
391 /* The base address mapping for this file. */
392 struct libbacktrace_base_address base_address
;
393 /* A sorted list of address ranges. */
394 struct unit_addrs
*addrs
;
395 /* Number of address ranges in list. */
397 /* A sorted list of units. */
399 /* Number of units in the list. */
401 /* The unparsed DWARF debug data. */
402 struct dwarf_sections dwarf_sections
;
403 /* Whether the data is big-endian or not. */
405 /* A vector used for function addresses. We keep this here so that
406 we can grow the vector as we read more functions. */
407 struct function_vector fvec
;
410 /* Report an error for a DWARF buffer. */
413 dwarf_buf_error (struct dwarf_buf
*buf
, const char *msg
, int errnum
)
417 snprintf (b
, sizeof b
, "%s in %s at %d",
418 msg
, buf
->name
, (int) (buf
->buf
- buf
->start
));
419 buf
->error_callback (buf
->data
, b
, errnum
);
422 /* Require at least COUNT bytes in BUF. Return 1 if all is well, 0 on
426 require (struct dwarf_buf
*buf
, size_t count
)
428 if (buf
->left
>= count
)
431 if (!buf
->reported_underflow
)
433 dwarf_buf_error (buf
, "DWARF underflow", 0);
434 buf
->reported_underflow
= 1;
440 /* Advance COUNT bytes in BUF. Return 1 if all is well, 0 on
444 advance (struct dwarf_buf
*buf
, size_t count
)
446 if (!require (buf
, count
))
453 /* Read one zero-terminated string from BUF and advance past the string. */
456 read_string (struct dwarf_buf
*buf
)
458 const char *p
= (const char *)buf
->buf
;
459 size_t len
= strnlen (p
, buf
->left
);
461 /* - If len == left, we ran out of buffer before finding the zero terminator.
462 Generate an error by advancing len + 1.
463 - If len < left, advance by len + 1 to skip past the zero terminator. */
464 size_t count
= len
+ 1;
466 if (!advance (buf
, count
))
472 /* Read one byte from BUF and advance 1 byte. */
475 read_byte (struct dwarf_buf
*buf
)
477 const unsigned char *p
= buf
->buf
;
479 if (!advance (buf
, 1))
484 /* Read a signed char from BUF and advance 1 byte. */
487 read_sbyte (struct dwarf_buf
*buf
)
489 const unsigned char *p
= buf
->buf
;
491 if (!advance (buf
, 1))
493 return (*p
^ 0x80) - 0x80;
496 /* Read a uint16 from BUF and advance 2 bytes. */
499 read_uint16 (struct dwarf_buf
*buf
)
501 const unsigned char *p
= buf
->buf
;
503 if (!advance (buf
, 2))
505 if (buf
->is_bigendian
)
506 return ((uint16_t) p
[0] << 8) | (uint16_t) p
[1];
508 return ((uint16_t) p
[1] << 8) | (uint16_t) p
[0];
511 /* Read a 24 bit value from BUF and advance 3 bytes. */
514 read_uint24 (struct dwarf_buf
*buf
)
516 const unsigned char *p
= buf
->buf
;
518 if (!advance (buf
, 3))
520 if (buf
->is_bigendian
)
521 return (((uint32_t) p
[0] << 16) | ((uint32_t) p
[1] << 8)
524 return (((uint32_t) p
[2] << 16) | ((uint32_t) p
[1] << 8)
528 /* Read a uint32 from BUF and advance 4 bytes. */
531 read_uint32 (struct dwarf_buf
*buf
)
533 const unsigned char *p
= buf
->buf
;
535 if (!advance (buf
, 4))
537 if (buf
->is_bigendian
)
538 return (((uint32_t) p
[0] << 24) | ((uint32_t) p
[1] << 16)
539 | ((uint32_t) p
[2] << 8) | (uint32_t) p
[3]);
541 return (((uint32_t) p
[3] << 24) | ((uint32_t) p
[2] << 16)
542 | ((uint32_t) p
[1] << 8) | (uint32_t) p
[0]);
545 /* Read a uint64 from BUF and advance 8 bytes. */
548 read_uint64 (struct dwarf_buf
*buf
)
550 const unsigned char *p
= buf
->buf
;
552 if (!advance (buf
, 8))
554 if (buf
->is_bigendian
)
555 return (((uint64_t) p
[0] << 56) | ((uint64_t) p
[1] << 48)
556 | ((uint64_t) p
[2] << 40) | ((uint64_t) p
[3] << 32)
557 | ((uint64_t) p
[4] << 24) | ((uint64_t) p
[5] << 16)
558 | ((uint64_t) p
[6] << 8) | (uint64_t) p
[7]);
560 return (((uint64_t) p
[7] << 56) | ((uint64_t) p
[6] << 48)
561 | ((uint64_t) p
[5] << 40) | ((uint64_t) p
[4] << 32)
562 | ((uint64_t) p
[3] << 24) | ((uint64_t) p
[2] << 16)
563 | ((uint64_t) p
[1] << 8) | (uint64_t) p
[0]);
566 /* Read an offset from BUF and advance the appropriate number of
570 read_offset (struct dwarf_buf
*buf
, int is_dwarf64
)
573 return read_uint64 (buf
);
575 return read_uint32 (buf
);
578 /* Read an address from BUF and advance the appropriate number of
582 read_address (struct dwarf_buf
*buf
, int addrsize
)
587 return read_byte (buf
);
589 return read_uint16 (buf
);
591 return read_uint32 (buf
);
593 return read_uint64 (buf
);
595 dwarf_buf_error (buf
, "unrecognized address size", 0);
600 /* Return whether a value is the highest possible address, given the
604 is_highest_address (uint64_t address
, int addrsize
)
609 return address
== (unsigned char) -1;
611 return address
== (uint16_t) -1;
613 return address
== (uint32_t) -1;
615 return address
== (uint64_t) -1;
621 /* Read an unsigned LEB128 number. */
624 read_uleb128 (struct dwarf_buf
*buf
)
636 const unsigned char *p
;
639 if (!advance (buf
, 1))
643 ret
|= ((uint64_t) (b
& 0x7f)) << shift
;
646 dwarf_buf_error (buf
, "LEB128 overflows uint64_t", 0);
651 while ((b
& 0x80) != 0);
656 /* Read a signed LEB128 number. */
659 read_sleb128 (struct dwarf_buf
*buf
)
671 const unsigned char *p
;
674 if (!advance (buf
, 1))
678 val
|= ((uint64_t) (b
& 0x7f)) << shift
;
681 dwarf_buf_error (buf
, "signed LEB128 overflows uint64_t", 0);
686 while ((b
& 0x80) != 0);
688 if ((b
& 0x40) != 0 && shift
< 64)
689 val
|= ((uint64_t) -1) << shift
;
691 return (int64_t) val
;
694 /* Return the length of an LEB128 number. */
697 leb128_len (const unsigned char *p
)
702 while ((*p
& 0x80) != 0)
710 /* Read initial_length from BUF and advance the appropriate number of bytes. */
713 read_initial_length (struct dwarf_buf
*buf
, int *is_dwarf64
)
717 len
= read_uint32 (buf
);
718 if (len
== 0xffffffff)
720 len
= read_uint64 (buf
);
729 /* Free an abbreviations structure. */
732 free_abbrevs (struct backtrace_state
*state
, struct abbrevs
*abbrevs
,
733 backtrace_error_callback error_callback
, void *data
)
737 for (i
= 0; i
< abbrevs
->num_abbrevs
; ++i
)
738 backtrace_free (state
, abbrevs
->abbrevs
[i
].attrs
,
739 abbrevs
->abbrevs
[i
].num_attrs
* sizeof (struct attr
),
740 error_callback
, data
);
741 backtrace_free (state
, abbrevs
->abbrevs
,
742 abbrevs
->num_abbrevs
* sizeof (struct abbrev
),
743 error_callback
, data
);
744 abbrevs
->num_abbrevs
= 0;
745 abbrevs
->abbrevs
= NULL
;
748 /* Read an attribute value. Returns 1 on success, 0 on failure. If
749 the value can be represented as a uint64_t, sets *VAL and sets
750 *IS_VALID to 1. We don't try to store the value of other attribute
751 forms, because we don't care about them. */
754 read_attribute (enum dwarf_form form
, uint64_t implicit_val
,
755 struct dwarf_buf
*buf
, int is_dwarf64
, int version
,
756 int addrsize
, const struct dwarf_sections
*dwarf_sections
,
757 struct dwarf_data
*altlink
, struct attr_val
*val
)
759 /* Avoid warnings about val.u.FIELD may be used uninitialized if
760 this function is inlined. The warnings aren't valid but can
761 occur because the different fields are set and used
763 memset (val
, 0, sizeof *val
);
768 val
->encoding
= ATTR_VAL_ADDRESS
;
769 val
->u
.uint
= read_address (buf
, addrsize
);
772 val
->encoding
= ATTR_VAL_BLOCK
;
773 return advance (buf
, read_uint16 (buf
));
775 val
->encoding
= ATTR_VAL_BLOCK
;
776 return advance (buf
, read_uint32 (buf
));
778 val
->encoding
= ATTR_VAL_UINT
;
779 val
->u
.uint
= read_uint16 (buf
);
782 val
->encoding
= ATTR_VAL_UINT
;
783 val
->u
.uint
= read_uint32 (buf
);
786 val
->encoding
= ATTR_VAL_UINT
;
787 val
->u
.uint
= read_uint64 (buf
);
790 val
->encoding
= ATTR_VAL_BLOCK
;
791 return advance (buf
, 16);
793 val
->encoding
= ATTR_VAL_STRING
;
794 val
->u
.string
= read_string (buf
);
795 return val
->u
.string
== NULL
? 0 : 1;
797 val
->encoding
= ATTR_VAL_BLOCK
;
798 return advance (buf
, read_uleb128 (buf
));
800 val
->encoding
= ATTR_VAL_BLOCK
;
801 return advance (buf
, read_byte (buf
));
803 val
->encoding
= ATTR_VAL_UINT
;
804 val
->u
.uint
= read_byte (buf
);
807 val
->encoding
= ATTR_VAL_UINT
;
808 val
->u
.uint
= read_byte (buf
);
811 val
->encoding
= ATTR_VAL_SINT
;
812 val
->u
.sint
= read_sleb128 (buf
);
818 offset
= read_offset (buf
, is_dwarf64
);
819 if (offset
>= dwarf_sections
->size
[DEBUG_STR
])
821 dwarf_buf_error (buf
, "DW_FORM_strp out of range", 0);
824 val
->encoding
= ATTR_VAL_STRING
;
826 (const char *) dwarf_sections
->data
[DEBUG_STR
] + offset
;
829 case DW_FORM_line_strp
:
833 offset
= read_offset (buf
, is_dwarf64
);
834 if (offset
>= dwarf_sections
->size
[DEBUG_LINE_STR
])
836 dwarf_buf_error (buf
, "DW_FORM_line_strp out of range", 0);
839 val
->encoding
= ATTR_VAL_STRING
;
841 (const char *) dwarf_sections
->data
[DEBUG_LINE_STR
] + offset
;
845 val
->encoding
= ATTR_VAL_UINT
;
846 val
->u
.uint
= read_uleb128 (buf
);
848 case DW_FORM_ref_addr
:
849 val
->encoding
= ATTR_VAL_REF_INFO
;
851 val
->u
.uint
= read_address (buf
, addrsize
);
853 val
->u
.uint
= read_offset (buf
, is_dwarf64
);
856 val
->encoding
= ATTR_VAL_REF_UNIT
;
857 val
->u
.uint
= read_byte (buf
);
860 val
->encoding
= ATTR_VAL_REF_UNIT
;
861 val
->u
.uint
= read_uint16 (buf
);
864 val
->encoding
= ATTR_VAL_REF_UNIT
;
865 val
->u
.uint
= read_uint32 (buf
);
868 val
->encoding
= ATTR_VAL_REF_UNIT
;
869 val
->u
.uint
= read_uint64 (buf
);
871 case DW_FORM_ref_udata
:
872 val
->encoding
= ATTR_VAL_REF_UNIT
;
873 val
->u
.uint
= read_uleb128 (buf
);
875 case DW_FORM_indirect
:
879 form
= read_uleb128 (buf
);
880 if (form
== DW_FORM_implicit_const
)
882 dwarf_buf_error (buf
,
883 "DW_FORM_indirect to DW_FORM_implicit_const",
887 return read_attribute ((enum dwarf_form
) form
, 0, buf
, is_dwarf64
,
888 version
, addrsize
, dwarf_sections
, altlink
,
891 case DW_FORM_sec_offset
:
892 val
->encoding
= ATTR_VAL_REF_SECTION
;
893 val
->u
.uint
= read_offset (buf
, is_dwarf64
);
895 case DW_FORM_exprloc
:
896 val
->encoding
= ATTR_VAL_EXPR
;
897 return advance (buf
, read_uleb128 (buf
));
898 case DW_FORM_flag_present
:
899 val
->encoding
= ATTR_VAL_UINT
;
902 case DW_FORM_ref_sig8
:
903 val
->encoding
= ATTR_VAL_REF_TYPE
;
904 val
->u
.uint
= read_uint64 (buf
);
906 case DW_FORM_strx
: case DW_FORM_strx1
: case DW_FORM_strx2
:
907 case DW_FORM_strx3
: case DW_FORM_strx4
:
914 offset
= read_uleb128 (buf
);
917 offset
= read_byte (buf
);
920 offset
= read_uint16 (buf
);
923 offset
= read_uint24 (buf
);
926 offset
= read_uint32 (buf
);
929 /* This case can't happen. */
932 val
->encoding
= ATTR_VAL_STRING_INDEX
;
933 val
->u
.uint
= offset
;
936 case DW_FORM_addrx
: case DW_FORM_addrx1
: case DW_FORM_addrx2
:
937 case DW_FORM_addrx3
: case DW_FORM_addrx4
:
944 offset
= read_uleb128 (buf
);
947 offset
= read_byte (buf
);
950 offset
= read_uint16 (buf
);
953 offset
= read_uint24 (buf
);
956 offset
= read_uint32 (buf
);
959 /* This case can't happen. */
962 val
->encoding
= ATTR_VAL_ADDRESS_INDEX
;
963 val
->u
.uint
= offset
;
966 case DW_FORM_ref_sup4
:
967 val
->encoding
= ATTR_VAL_REF_SECTION
;
968 val
->u
.uint
= read_uint32 (buf
);
970 case DW_FORM_ref_sup8
:
971 val
->encoding
= ATTR_VAL_REF_SECTION
;
972 val
->u
.uint
= read_uint64 (buf
);
974 case DW_FORM_implicit_const
:
975 val
->encoding
= ATTR_VAL_UINT
;
976 val
->u
.uint
= implicit_val
;
978 case DW_FORM_loclistx
:
979 /* We don't distinguish this from DW_FORM_sec_offset. It
980 * shouldn't matter since we don't care about loclists. */
981 val
->encoding
= ATTR_VAL_REF_SECTION
;
982 val
->u
.uint
= read_uleb128 (buf
);
984 case DW_FORM_rnglistx
:
985 val
->encoding
= ATTR_VAL_RNGLISTS_INDEX
;
986 val
->u
.uint
= read_uleb128 (buf
);
988 case DW_FORM_GNU_addr_index
:
989 val
->encoding
= ATTR_VAL_REF_SECTION
;
990 val
->u
.uint
= read_uleb128 (buf
);
992 case DW_FORM_GNU_str_index
:
993 val
->encoding
= ATTR_VAL_REF_SECTION
;
994 val
->u
.uint
= read_uleb128 (buf
);
996 case DW_FORM_GNU_ref_alt
:
997 val
->u
.uint
= read_offset (buf
, is_dwarf64
);
1000 val
->encoding
= ATTR_VAL_NONE
;
1003 val
->encoding
= ATTR_VAL_REF_ALT_INFO
;
1005 case DW_FORM_strp_sup
: case DW_FORM_GNU_strp_alt
:
1009 offset
= read_offset (buf
, is_dwarf64
);
1010 if (altlink
== NULL
)
1012 val
->encoding
= ATTR_VAL_NONE
;
1015 if (offset
>= altlink
->dwarf_sections
.size
[DEBUG_STR
])
1017 dwarf_buf_error (buf
, "DW_FORM_strp_sup out of range", 0);
1020 val
->encoding
= ATTR_VAL_STRING
;
1022 (const char *) altlink
->dwarf_sections
.data
[DEBUG_STR
] + offset
;
1026 dwarf_buf_error (buf
, "unrecognized DWARF form", -1);
1031 /* If we can determine the value of a string attribute, set *STRING to
1032 point to the string. Return 1 on success, 0 on error. If we don't
1033 know the value, we consider that a success, and we don't change
1034 *STRING. An error is only reported for some sort of out of range
1038 resolve_string (const struct dwarf_sections
*dwarf_sections
, int is_dwarf64
,
1039 int is_bigendian
, uint64_t str_offsets_base
,
1040 const struct attr_val
*val
,
1041 backtrace_error_callback error_callback
, void *data
,
1042 const char **string
)
1044 switch (val
->encoding
)
1046 case ATTR_VAL_STRING
:
1047 *string
= val
->u
.string
;
1050 case ATTR_VAL_STRING_INDEX
:
1053 struct dwarf_buf offset_buf
;
1055 offset
= val
->u
.uint
* (is_dwarf64
? 8 : 4) + str_offsets_base
;
1056 if (offset
+ (is_dwarf64
? 8 : 4)
1057 > dwarf_sections
->size
[DEBUG_STR_OFFSETS
])
1059 error_callback (data
, "DW_FORM_strx value out of range", 0);
1063 offset_buf
.name
= ".debug_str_offsets";
1064 offset_buf
.start
= dwarf_sections
->data
[DEBUG_STR_OFFSETS
];
1065 offset_buf
.buf
= dwarf_sections
->data
[DEBUG_STR_OFFSETS
] + offset
;
1066 offset_buf
.left
= dwarf_sections
->size
[DEBUG_STR_OFFSETS
] - offset
;
1067 offset_buf
.is_bigendian
= is_bigendian
;
1068 offset_buf
.error_callback
= error_callback
;
1069 offset_buf
.data
= data
;
1070 offset_buf
.reported_underflow
= 0;
1072 offset
= read_offset (&offset_buf
, is_dwarf64
);
1073 if (offset
>= dwarf_sections
->size
[DEBUG_STR
])
1075 dwarf_buf_error (&offset_buf
,
1076 "DW_FORM_strx offset out of range",
1080 *string
= (const char *) dwarf_sections
->data
[DEBUG_STR
] + offset
;
1089 /* Set *ADDRESS to the real address for a ATTR_VAL_ADDRESS_INDEX.
1090 Return 1 on success, 0 on error. */
1093 resolve_addr_index (const struct dwarf_sections
*dwarf_sections
,
1094 uint64_t addr_base
, int addrsize
, int is_bigendian
,
1095 uint64_t addr_index
,
1096 backtrace_error_callback error_callback
, void *data
,
1100 struct dwarf_buf addr_buf
;
1102 offset
= addr_index
* addrsize
+ addr_base
;
1103 if (offset
+ addrsize
> dwarf_sections
->size
[DEBUG_ADDR
])
1105 error_callback (data
, "DW_FORM_addrx value out of range", 0);
1109 addr_buf
.name
= ".debug_addr";
1110 addr_buf
.start
= dwarf_sections
->data
[DEBUG_ADDR
];
1111 addr_buf
.buf
= dwarf_sections
->data
[DEBUG_ADDR
] + offset
;
1112 addr_buf
.left
= dwarf_sections
->size
[DEBUG_ADDR
] - offset
;
1113 addr_buf
.is_bigendian
= is_bigendian
;
1114 addr_buf
.error_callback
= error_callback
;
1115 addr_buf
.data
= data
;
1116 addr_buf
.reported_underflow
= 0;
1118 *address
= (uintptr_t) read_address (&addr_buf
, addrsize
);
1122 /* Compare a unit offset against a unit for bsearch. */
1125 units_search (const void *vkey
, const void *ventry
)
1127 const size_t *key
= (const size_t *) vkey
;
1128 const struct unit
*entry
= *((const struct unit
*const *) ventry
);
1132 if (offset
< entry
->low_offset
)
1134 else if (offset
>= entry
->high_offset
)
1140 /* Find a unit in PU containing OFFSET. */
1142 static struct unit
*
1143 find_unit (struct unit
**pu
, size_t units_count
, size_t offset
)
1146 u
= bsearch (&offset
, pu
, units_count
, sizeof (struct unit
*), units_search
);
1147 return u
== NULL
? NULL
: *u
;
1150 /* Compare function_addrs for qsort. When ranges are nested, make the
1151 smallest one sort last. */
1154 function_addrs_compare (const void *v1
, const void *v2
)
1156 const struct function_addrs
*a1
= (const struct function_addrs
*) v1
;
1157 const struct function_addrs
*a2
= (const struct function_addrs
*) v2
;
1159 if (a1
->low
< a2
->low
)
1161 if (a1
->low
> a2
->low
)
1163 if (a1
->high
< a2
->high
)
1165 if (a1
->high
> a2
->high
)
1167 return strcmp (a1
->function
->name
, a2
->function
->name
);
1170 /* Compare a PC against a function_addrs for bsearch. We always
1171 allocate an entra entry at the end of the vector, so that this
1172 routine can safely look at the next entry. Note that if there are
1173 multiple ranges containing PC, which one will be returned is
1174 unpredictable. We compensate for that in dwarf_fileline. */
1177 function_addrs_search (const void *vkey
, const void *ventry
)
1179 const uintptr_t *key
= (const uintptr_t *) vkey
;
1180 const struct function_addrs
*entry
= (const struct function_addrs
*) ventry
;
1184 if (pc
< entry
->low
)
1186 else if (pc
> (entry
+ 1)->low
)
1192 /* Add a new compilation unit address range to a vector. This is
1193 called via add_ranges. Returns 1 on success, 0 on failure. */
1196 add_unit_addr (struct backtrace_state
*state
, void *rdata
,
1197 uintptr_t lowpc
, uintptr_t highpc
,
1198 backtrace_error_callback error_callback
, void *data
,
1201 struct unit
*u
= (struct unit
*) rdata
;
1202 struct unit_addrs_vector
*vec
= (struct unit_addrs_vector
*) pvec
;
1203 struct unit_addrs
*p
;
1205 /* Try to merge with the last entry. */
1208 p
= (struct unit_addrs
*) vec
->vec
.base
+ (vec
->count
- 1);
1209 if ((lowpc
== p
->high
|| lowpc
== p
->high
+ 1)
1212 if (highpc
> p
->high
)
1218 p
= ((struct unit_addrs
*)
1219 backtrace_vector_grow (state
, sizeof (struct unit_addrs
),
1220 error_callback
, data
, &vec
->vec
));
1233 /* Compare unit_addrs for qsort. When ranges are nested, make the
1234 smallest one sort last. */
1237 unit_addrs_compare (const void *v1
, const void *v2
)
1239 const struct unit_addrs
*a1
= (const struct unit_addrs
*) v1
;
1240 const struct unit_addrs
*a2
= (const struct unit_addrs
*) v2
;
1242 if (a1
->low
< a2
->low
)
1244 if (a1
->low
> a2
->low
)
1246 if (a1
->high
< a2
->high
)
1248 if (a1
->high
> a2
->high
)
1250 if (a1
->u
->lineoff
< a2
->u
->lineoff
)
1252 if (a1
->u
->lineoff
> a2
->u
->lineoff
)
1257 /* Compare a PC against a unit_addrs for bsearch. We always allocate
1258 an entry entry at the end of the vector, so that this routine can
1259 safely look at the next entry. Note that if there are multiple
1260 ranges containing PC, which one will be returned is unpredictable.
1261 We compensate for that in dwarf_fileline. */
1264 unit_addrs_search (const void *vkey
, const void *ventry
)
1266 const uintptr_t *key
= (const uintptr_t *) vkey
;
1267 const struct unit_addrs
*entry
= (const struct unit_addrs
*) ventry
;
1271 if (pc
< entry
->low
)
1273 else if (pc
> (entry
+ 1)->low
)
1279 /* Fill in overlapping ranges as needed. This is a subroutine of
1280 resolve_unit_addrs_overlap. */
1283 resolve_unit_addrs_overlap_walk (struct backtrace_state
*state
,
1284 size_t *pfrom
, size_t *pto
,
1285 struct unit_addrs
*enclosing
,
1286 struct unit_addrs_vector
*old_vec
,
1287 backtrace_error_callback error_callback
,
1289 struct unit_addrs_vector
*new_vec
)
1291 struct unit_addrs
*old_addrs
;
1293 struct unit_addrs
*new_addrs
;
1297 old_addrs
= (struct unit_addrs
*) old_vec
->vec
.base
;
1298 old_count
= old_vec
->count
;
1299 new_addrs
= (struct unit_addrs
*) new_vec
->vec
.base
;
1301 for (from
= *pfrom
, to
= *pto
; from
< old_count
; from
++, to
++)
1303 /* If we are in the scope of a larger range that can no longer
1304 cover any further ranges, return back to the caller. */
1306 if (enclosing
!= NULL
1307 && enclosing
->high
<= old_addrs
[from
].low
)
1314 new_addrs
[to
] = old_addrs
[from
];
1316 /* If we are in scope of a larger range, fill in any gaps
1317 between this entry and the next one.
1319 There is an extra entry at the end of the vector, so it's
1320 always OK to refer to from + 1. */
1322 if (enclosing
!= NULL
1323 && enclosing
->high
> old_addrs
[from
].high
1324 && old_addrs
[from
].high
< old_addrs
[from
+ 1].low
)
1329 grew
= backtrace_vector_grow (state
, sizeof (struct unit_addrs
),
1330 error_callback
, data
, &new_vec
->vec
);
1333 new_addrs
= (struct unit_addrs
*) new_vec
->vec
.base
;
1335 new_addrs
[to
].low
= old_addrs
[from
].high
;
1336 new_high
= old_addrs
[from
+ 1].low
;
1337 if (enclosing
->high
< new_high
)
1338 new_high
= enclosing
->high
;
1339 new_addrs
[to
].high
= new_high
;
1340 new_addrs
[to
].u
= enclosing
->u
;
1343 /* If this range has a larger scope than the next one, use it to
1344 fill in any gaps. */
1346 if (old_addrs
[from
].high
> old_addrs
[from
+ 1].high
)
1350 if (!resolve_unit_addrs_overlap_walk (state
, pfrom
, pto
,
1351 &old_addrs
[from
], old_vec
,
1352 error_callback
, data
, new_vec
))
1357 /* Undo the increment the loop is about to do. */
1363 if (enclosing
== NULL
)
1365 struct unit_addrs
*pa
;
1367 /* Add trailing entry. */
1369 pa
= ((struct unit_addrs
*)
1370 backtrace_vector_grow (state
, sizeof (struct unit_addrs
),
1371 error_callback
, data
, &new_vec
->vec
));
1379 new_vec
->count
= to
;
1385 /* It is possible for the unit_addrs list to contain overlaps, as in
1387 10: low == 10, high == 20, unit 1
1388 11: low == 12, high == 15, unit 2
1389 12: low == 20, high == 30, unit 1
1391 In such a case, for pc == 17, a search using units_addr_search will
1392 return entry 11. However, pc == 17 doesn't fit in that range. We
1393 actually want range 10.
1395 It seems that in general we might have an arbitrary number of
1396 ranges in between 10 and 12.
1398 To handle this we look for cases where range R1 is followed by
1399 range R2 such that R2 is a strict subset of R1. In such cases we
1400 insert a new range R3 following R2 that fills in the remainder of
1401 the address space covered by R1. That lets a relatively simple
1402 search find the correct range.
1404 These overlaps can occur because of the range merging we do in
1405 add_unit_addr. When the linker de-duplicates functions, it can
1406 leave behind an address range that refers to the address range of
1407 the retained duplicate. If the retained duplicate address range is
1408 merged with others, then after sorting we can see overlapping
1411 See https://github.com/ianlancetaylor/libbacktrace/issues/137. */
1414 resolve_unit_addrs_overlap (struct backtrace_state
*state
,
1415 backtrace_error_callback error_callback
,
1416 void *data
, struct unit_addrs_vector
*addrs_vec
)
1418 struct unit_addrs
*addrs
;
1421 struct unit_addrs
*entry
;
1423 struct unit_addrs_vector new_vec
;
1428 addrs
= (struct unit_addrs
*) addrs_vec
->vec
.base
;
1429 count
= addrs_vec
->count
;
1434 /* Optimistically assume that overlaps are rare. */
1437 for (i
= 0; i
< count
- 1; i
++)
1439 if (entry
->low
< (entry
+ 1)->low
1440 && entry
->high
> (entry
+ 1)->high
)
1450 memset (&new_vec
, 0, sizeof new_vec
);
1451 grew
= backtrace_vector_grow (state
,
1452 count
* sizeof (struct unit_addrs
),
1453 error_callback
, data
, &new_vec
.vec
);
1459 resolve_unit_addrs_overlap_walk (state
, &from
, &to
, NULL
, addrs_vec
,
1460 error_callback
, data
, &new_vec
);
1461 backtrace_vector_free (state
, &addrs_vec
->vec
, error_callback
, data
);
1462 *addrs_vec
= new_vec
;
1467 /* Sort the line vector by PC. We want a stable sort here to maintain
1468 the order of lines for the same PC values. Since the sequence is
1469 being sorted in place, their addresses cannot be relied on to
1470 maintain stability. That is the purpose of the index member. */
1473 line_compare (const void *v1
, const void *v2
)
1475 const struct line
*ln1
= (const struct line
*) v1
;
1476 const struct line
*ln2
= (const struct line
*) v2
;
1478 if (ln1
->pc
< ln2
->pc
)
1480 else if (ln1
->pc
> ln2
->pc
)
1482 else if (ln1
->idx
< ln2
->idx
)
1484 else if (ln1
->idx
> ln2
->idx
)
1490 /* Find a PC in a line vector. We always allocate an extra entry at
1491 the end of the lines vector, so that this routine can safely look
1492 at the next entry. Note that when there are multiple mappings for
1493 the same PC value, this will return the last one. */
1496 line_search (const void *vkey
, const void *ventry
)
1498 const uintptr_t *key
= (const uintptr_t *) vkey
;
1499 const struct line
*entry
= (const struct line
*) ventry
;
1505 else if (pc
>= (entry
+ 1)->pc
)
1511 /* Sort the abbrevs by the abbrev code. This function is passed to
1512 both qsort and bsearch. */
1515 abbrev_compare (const void *v1
, const void *v2
)
1517 const struct abbrev
*a1
= (const struct abbrev
*) v1
;
1518 const struct abbrev
*a2
= (const struct abbrev
*) v2
;
1520 if (a1
->code
< a2
->code
)
1522 else if (a1
->code
> a2
->code
)
1526 /* This really shouldn't happen. It means there are two
1527 different abbrevs with the same code, and that means we don't
1528 know which one lookup_abbrev should return. */
1533 /* Read the abbreviation table for a compilation unit. Returns 1 on
1534 success, 0 on failure. */
1537 read_abbrevs (struct backtrace_state
*state
, uint64_t abbrev_offset
,
1538 const unsigned char *dwarf_abbrev
, size_t dwarf_abbrev_size
,
1539 int is_bigendian
, backtrace_error_callback error_callback
,
1540 void *data
, struct abbrevs
*abbrevs
)
1542 struct dwarf_buf abbrev_buf
;
1543 struct dwarf_buf count_buf
;
1546 abbrevs
->num_abbrevs
= 0;
1547 abbrevs
->abbrevs
= NULL
;
1549 if (abbrev_offset
>= dwarf_abbrev_size
)
1551 error_callback (data
, "abbrev offset out of range", 0);
1555 abbrev_buf
.name
= ".debug_abbrev";
1556 abbrev_buf
.start
= dwarf_abbrev
;
1557 abbrev_buf
.buf
= dwarf_abbrev
+ abbrev_offset
;
1558 abbrev_buf
.left
= dwarf_abbrev_size
- abbrev_offset
;
1559 abbrev_buf
.is_bigendian
= is_bigendian
;
1560 abbrev_buf
.error_callback
= error_callback
;
1561 abbrev_buf
.data
= data
;
1562 abbrev_buf
.reported_underflow
= 0;
1564 /* Count the number of abbrevs in this list. */
1566 count_buf
= abbrev_buf
;
1568 while (read_uleb128 (&count_buf
) != 0)
1570 if (count_buf
.reported_underflow
)
1574 read_uleb128 (&count_buf
);
1575 // Skip has_children.
1576 read_byte (&count_buf
);
1578 while (read_uleb128 (&count_buf
) != 0)
1582 form
= read_uleb128 (&count_buf
);
1583 if ((enum dwarf_form
) form
== DW_FORM_implicit_const
)
1584 read_sleb128 (&count_buf
);
1586 // Skip form of last attribute.
1587 read_uleb128 (&count_buf
);
1590 if (count_buf
.reported_underflow
)
1593 if (num_abbrevs
== 0)
1596 abbrevs
->abbrevs
= ((struct abbrev
*)
1597 backtrace_alloc (state
,
1598 num_abbrevs
* sizeof (struct abbrev
),
1599 error_callback
, data
));
1600 if (abbrevs
->abbrevs
== NULL
)
1602 abbrevs
->num_abbrevs
= num_abbrevs
;
1603 memset (abbrevs
->abbrevs
, 0, num_abbrevs
* sizeof (struct abbrev
));
1613 if (abbrev_buf
.reported_underflow
)
1616 code
= read_uleb128 (&abbrev_buf
);
1621 a
.tag
= (enum dwarf_tag
) read_uleb128 (&abbrev_buf
);
1622 a
.has_children
= read_byte (&abbrev_buf
);
1624 count_buf
= abbrev_buf
;
1626 while (read_uleb128 (&count_buf
) != 0)
1631 form
= read_uleb128 (&count_buf
);
1632 if ((enum dwarf_form
) form
== DW_FORM_implicit_const
)
1633 read_sleb128 (&count_buf
);
1639 read_uleb128 (&abbrev_buf
);
1640 read_uleb128 (&abbrev_buf
);
1644 attrs
= ((struct attr
*)
1645 backtrace_alloc (state
, num_attrs
* sizeof *attrs
,
1646 error_callback
, data
));
1655 name
= read_uleb128 (&abbrev_buf
);
1656 form
= read_uleb128 (&abbrev_buf
);
1659 attrs
[num_attrs
].name
= (enum dwarf_attribute
) name
;
1660 attrs
[num_attrs
].form
= (enum dwarf_form
) form
;
1661 if ((enum dwarf_form
) form
== DW_FORM_implicit_const
)
1662 attrs
[num_attrs
].val
= read_sleb128 (&abbrev_buf
);
1664 attrs
[num_attrs
].val
= 0;
1669 a
.num_attrs
= num_attrs
;
1672 abbrevs
->abbrevs
[num_abbrevs
] = a
;
1676 backtrace_qsort (abbrevs
->abbrevs
, abbrevs
->num_abbrevs
,
1677 sizeof (struct abbrev
), abbrev_compare
);
1682 free_abbrevs (state
, abbrevs
, error_callback
, data
);
1686 /* Return the abbrev information for an abbrev code. */
1688 static const struct abbrev
*
1689 lookup_abbrev (struct abbrevs
*abbrevs
, uint64_t code
,
1690 backtrace_error_callback error_callback
, void *data
)
1695 /* With GCC, where abbrevs are simply numbered in order, we should
1696 be able to just look up the entry. */
1697 if (code
- 1 < abbrevs
->num_abbrevs
1698 && abbrevs
->abbrevs
[code
- 1].code
== code
)
1699 return &abbrevs
->abbrevs
[code
- 1];
1701 /* Otherwise we have to search. */
1702 memset (&key
, 0, sizeof key
);
1704 p
= bsearch (&key
, abbrevs
->abbrevs
, abbrevs
->num_abbrevs
,
1705 sizeof (struct abbrev
), abbrev_compare
);
1708 error_callback (data
, "invalid abbreviation code", 0);
1711 return (const struct abbrev
*) p
;
1714 /* This struct is used to gather address range information while
1715 reading attributes. We use this while building a mapping from
1716 address ranges to compilation units and then again while mapping
1717 from address ranges to function entries. Normally either
1718 lowpc/highpc is set or ranges is set. */
1721 uintptr_t lowpc
; /* The low PC value. */
1722 int have_lowpc
; /* Whether a low PC value was found. */
1723 int lowpc_is_addr_index
; /* Whether lowpc is in .debug_addr. */
1724 uintptr_t highpc
; /* The high PC value. */
1725 int have_highpc
; /* Whether a high PC value was found. */
1726 int highpc_is_relative
; /* Whether highpc is relative to lowpc. */
1727 int highpc_is_addr_index
; /* Whether highpc is in .debug_addr. */
1728 uint64_t ranges
; /* Offset in ranges section. */
1729 int have_ranges
; /* Whether ranges is valid. */
1730 int ranges_is_index
; /* Whether ranges is DW_FORM_rnglistx. */
1733 /* Update PCRANGE from an attribute value. */
1736 update_pcrange (const struct attr
* attr
, const struct attr_val
* val
,
1737 struct pcrange
*pcrange
)
1742 if (val
->encoding
== ATTR_VAL_ADDRESS
)
1744 pcrange
->lowpc
= (uintptr_t) val
->u
.uint
;
1745 pcrange
->have_lowpc
= 1;
1747 else if (val
->encoding
== ATTR_VAL_ADDRESS_INDEX
)
1749 pcrange
->lowpc
= (uintptr_t) val
->u
.uint
;
1750 pcrange
->have_lowpc
= 1;
1751 pcrange
->lowpc_is_addr_index
= 1;
1756 if (val
->encoding
== ATTR_VAL_ADDRESS
)
1758 pcrange
->highpc
= (uintptr_t) val
->u
.uint
;
1759 pcrange
->have_highpc
= 1;
1761 else if (val
->encoding
== ATTR_VAL_UINT
)
1763 pcrange
->highpc
= (uintptr_t) val
->u
.uint
;
1764 pcrange
->have_highpc
= 1;
1765 pcrange
->highpc_is_relative
= 1;
1767 else if (val
->encoding
== ATTR_VAL_ADDRESS_INDEX
)
1769 pcrange
->highpc
= (uintptr_t) val
->u
.uint
;
1770 pcrange
->have_highpc
= 1;
1771 pcrange
->highpc_is_addr_index
= 1;
1776 if (val
->encoding
== ATTR_VAL_UINT
1777 || val
->encoding
== ATTR_VAL_REF_SECTION
)
1779 pcrange
->ranges
= val
->u
.uint
;
1780 pcrange
->have_ranges
= 1;
1782 else if (val
->encoding
== ATTR_VAL_RNGLISTS_INDEX
)
1784 pcrange
->ranges
= val
->u
.uint
;
1785 pcrange
->have_ranges
= 1;
1786 pcrange
->ranges_is_index
= 1;
1795 /* Call ADD_RANGE for a low/high PC pair. Returns 1 on success, 0 on
1799 add_low_high_range (struct backtrace_state
*state
,
1800 const struct dwarf_sections
*dwarf_sections
,
1801 struct libbacktrace_base_address base_address
,
1802 int is_bigendian
, struct unit
*u
,
1803 const struct pcrange
*pcrange
,
1804 int (*add_range
) (struct backtrace_state
*state
,
1805 void *rdata
, uintptr_t lowpc
,
1807 backtrace_error_callback error_callback
,
1808 void *data
, void *vec
),
1810 backtrace_error_callback error_callback
, void *data
,
1816 lowpc
= pcrange
->lowpc
;
1817 if (pcrange
->lowpc_is_addr_index
)
1819 if (!resolve_addr_index (dwarf_sections
, u
->addr_base
, u
->addrsize
,
1820 is_bigendian
, lowpc
, error_callback
, data
,
1825 highpc
= pcrange
->highpc
;
1826 if (pcrange
->highpc_is_addr_index
)
1828 if (!resolve_addr_index (dwarf_sections
, u
->addr_base
, u
->addrsize
,
1829 is_bigendian
, highpc
, error_callback
, data
,
1833 if (pcrange
->highpc_is_relative
)
1836 /* Add in the base address of the module when recording PC values,
1837 so that we can look up the PC directly. */
1838 lowpc
= libbacktrace_add_base (lowpc
, base_address
);
1839 highpc
= libbacktrace_add_base (highpc
, base_address
);
1841 return add_range (state
, rdata
, lowpc
, highpc
, error_callback
, data
, vec
);
1844 /* Call ADD_RANGE for each range read from .debug_ranges, as used in
1845 DWARF versions 2 through 4. */
1848 add_ranges_from_ranges (
1849 struct backtrace_state
*state
,
1850 const struct dwarf_sections
*dwarf_sections
,
1851 struct libbacktrace_base_address base_address
, int is_bigendian
,
1852 struct unit
*u
, uintptr_t base
,
1853 const struct pcrange
*pcrange
,
1854 int (*add_range
) (struct backtrace_state
*state
, void *rdata
,
1855 uintptr_t lowpc
, uintptr_t highpc
,
1856 backtrace_error_callback error_callback
, void *data
,
1859 backtrace_error_callback error_callback
, void *data
,
1862 struct dwarf_buf ranges_buf
;
1864 if (pcrange
->ranges
>= dwarf_sections
->size
[DEBUG_RANGES
])
1866 error_callback (data
, "ranges offset out of range", 0);
1870 ranges_buf
.name
= ".debug_ranges";
1871 ranges_buf
.start
= dwarf_sections
->data
[DEBUG_RANGES
];
1872 ranges_buf
.buf
= dwarf_sections
->data
[DEBUG_RANGES
] + pcrange
->ranges
;
1873 ranges_buf
.left
= dwarf_sections
->size
[DEBUG_RANGES
] - pcrange
->ranges
;
1874 ranges_buf
.is_bigendian
= is_bigendian
;
1875 ranges_buf
.error_callback
= error_callback
;
1876 ranges_buf
.data
= data
;
1877 ranges_buf
.reported_underflow
= 0;
1884 if (ranges_buf
.reported_underflow
)
1887 low
= read_address (&ranges_buf
, u
->addrsize
);
1888 high
= read_address (&ranges_buf
, u
->addrsize
);
1890 if (low
== 0 && high
== 0)
1893 if (is_highest_address (low
, u
->addrsize
))
1894 base
= (uintptr_t) high
;
1899 rl
= libbacktrace_add_base ((uintptr_t) low
+ base
, base_address
);
1900 rh
= libbacktrace_add_base ((uintptr_t) high
+ base
, base_address
);
1901 if (!add_range (state
, rdata
, rl
, rh
, error_callback
, data
, vec
))
1906 if (ranges_buf
.reported_underflow
)
1912 /* Call ADD_RANGE for each range read from .debug_rnglists, as used in
1916 add_ranges_from_rnglists (
1917 struct backtrace_state
*state
,
1918 const struct dwarf_sections
*dwarf_sections
,
1919 struct libbacktrace_base_address base_address
, int is_bigendian
,
1920 struct unit
*u
, uintptr_t base
,
1921 const struct pcrange
*pcrange
,
1922 int (*add_range
) (struct backtrace_state
*state
, void *rdata
,
1923 uintptr_t lowpc
, uintptr_t highpc
,
1924 backtrace_error_callback error_callback
, void *data
,
1927 backtrace_error_callback error_callback
, void *data
,
1931 struct dwarf_buf rnglists_buf
;
1933 if (!pcrange
->ranges_is_index
)
1934 offset
= pcrange
->ranges
;
1936 offset
= u
->rnglists_base
+ pcrange
->ranges
* (u
->is_dwarf64
? 8 : 4);
1937 if (offset
>= dwarf_sections
->size
[DEBUG_RNGLISTS
])
1939 error_callback (data
, "rnglists offset out of range", 0);
1943 rnglists_buf
.name
= ".debug_rnglists";
1944 rnglists_buf
.start
= dwarf_sections
->data
[DEBUG_RNGLISTS
];
1945 rnglists_buf
.buf
= dwarf_sections
->data
[DEBUG_RNGLISTS
] + offset
;
1946 rnglists_buf
.left
= dwarf_sections
->size
[DEBUG_RNGLISTS
] - offset
;
1947 rnglists_buf
.is_bigendian
= is_bigendian
;
1948 rnglists_buf
.error_callback
= error_callback
;
1949 rnglists_buf
.data
= data
;
1950 rnglists_buf
.reported_underflow
= 0;
1952 if (pcrange
->ranges_is_index
)
1954 offset
= read_offset (&rnglists_buf
, u
->is_dwarf64
);
1955 offset
+= u
->rnglists_base
;
1956 if (offset
>= dwarf_sections
->size
[DEBUG_RNGLISTS
])
1958 error_callback (data
, "rnglists index offset out of range", 0);
1961 rnglists_buf
.buf
= dwarf_sections
->data
[DEBUG_RNGLISTS
] + offset
;
1962 rnglists_buf
.left
= dwarf_sections
->size
[DEBUG_RNGLISTS
] - offset
;
1969 rle
= read_byte (&rnglists_buf
);
1970 if (rle
== DW_RLE_end_of_list
)
1974 case DW_RLE_base_addressx
:
1978 index
= read_uleb128 (&rnglists_buf
);
1979 if (!resolve_addr_index (dwarf_sections
, u
->addr_base
,
1980 u
->addrsize
, is_bigendian
, index
,
1981 error_callback
, data
, &base
))
1986 case DW_RLE_startx_endx
:
1992 index
= read_uleb128 (&rnglists_buf
);
1993 if (!resolve_addr_index (dwarf_sections
, u
->addr_base
,
1994 u
->addrsize
, is_bigendian
, index
,
1995 error_callback
, data
, &low
))
1997 index
= read_uleb128 (&rnglists_buf
);
1998 if (!resolve_addr_index (dwarf_sections
, u
->addr_base
,
1999 u
->addrsize
, is_bigendian
, index
,
2000 error_callback
, data
, &high
))
2002 if (!add_range (state
, rdata
,
2003 libbacktrace_add_base (low
, base_address
),
2004 libbacktrace_add_base (high
, base_address
),
2005 error_callback
, data
, vec
))
2010 case DW_RLE_startx_length
:
2016 index
= read_uleb128 (&rnglists_buf
);
2017 if (!resolve_addr_index (dwarf_sections
, u
->addr_base
,
2018 u
->addrsize
, is_bigendian
, index
,
2019 error_callback
, data
, &low
))
2021 length
= read_uleb128 (&rnglists_buf
);
2022 low
= libbacktrace_add_base (low
, base_address
);
2023 if (!add_range (state
, rdata
, low
, low
+ length
,
2024 error_callback
, data
, vec
))
2029 case DW_RLE_offset_pair
:
2034 low
= read_uleb128 (&rnglists_buf
);
2035 high
= read_uleb128 (&rnglists_buf
);
2036 if (!add_range (state
, rdata
,
2037 libbacktrace_add_base (low
+ base
, base_address
),
2038 libbacktrace_add_base (high
+ base
, base_address
),
2039 error_callback
, data
, vec
))
2044 case DW_RLE_base_address
:
2045 base
= (uintptr_t) read_address (&rnglists_buf
, u
->addrsize
);
2048 case DW_RLE_start_end
:
2053 low
= (uintptr_t) read_address (&rnglists_buf
, u
->addrsize
);
2054 high
= (uintptr_t) read_address (&rnglists_buf
, u
->addrsize
);
2055 if (!add_range (state
, rdata
,
2056 libbacktrace_add_base (low
, base_address
),
2057 libbacktrace_add_base (high
, base_address
),
2058 error_callback
, data
, vec
))
2063 case DW_RLE_start_length
:
2068 low
= (uintptr_t) read_address (&rnglists_buf
, u
->addrsize
);
2069 length
= (uintptr_t) read_uleb128 (&rnglists_buf
);
2070 low
= libbacktrace_add_base (low
, base_address
);
2071 if (!add_range (state
, rdata
, low
, low
+ length
,
2072 error_callback
, data
, vec
))
2078 dwarf_buf_error (&rnglists_buf
, "unrecognized DW_RLE value", -1);
2083 if (rnglists_buf
.reported_underflow
)
2089 /* Call ADD_RANGE for each lowpc/highpc pair in PCRANGE. RDATA is
2090 passed to ADD_RANGE, and is either a struct unit * or a struct
2091 function *. VEC is the vector we are adding ranges to, and is
2092 either a struct unit_addrs_vector * or a struct function_vector *.
2093 Returns 1 on success, 0 on error. */
2096 add_ranges (struct backtrace_state
*state
,
2097 const struct dwarf_sections
*dwarf_sections
,
2098 struct libbacktrace_base_address base_address
, int is_bigendian
,
2099 struct unit
*u
, uintptr_t base
, const struct pcrange
*pcrange
,
2100 int (*add_range
) (struct backtrace_state
*state
, void *rdata
,
2101 uintptr_t lowpc
, uintptr_t highpc
,
2102 backtrace_error_callback error_callback
,
2103 void *data
, void *vec
),
2105 backtrace_error_callback error_callback
, void *data
,
2108 if (pcrange
->have_lowpc
&& pcrange
->have_highpc
)
2109 return add_low_high_range (state
, dwarf_sections
, base_address
,
2110 is_bigendian
, u
, pcrange
, add_range
, rdata
,
2111 error_callback
, data
, vec
);
2113 if (!pcrange
->have_ranges
)
2115 /* Did not find any address ranges to add. */
2120 return add_ranges_from_ranges (state
, dwarf_sections
, base_address
,
2121 is_bigendian
, u
, base
, pcrange
, add_range
,
2122 rdata
, error_callback
, data
, vec
);
2124 return add_ranges_from_rnglists (state
, dwarf_sections
, base_address
,
2125 is_bigendian
, u
, base
, pcrange
, add_range
,
2126 rdata
, error_callback
, data
, vec
);
2129 /* Find the address range covered by a compilation unit, reading from
2130 UNIT_BUF and adding values to U. Returns 1 if all data could be
2131 read, 0 if there is some error. */
2134 find_address_ranges (struct backtrace_state
*state
,
2135 struct libbacktrace_base_address base_address
,
2136 struct dwarf_buf
*unit_buf
,
2137 const struct dwarf_sections
*dwarf_sections
,
2138 int is_bigendian
, struct dwarf_data
*altlink
,
2139 backtrace_error_callback error_callback
, void *data
,
2140 struct unit
*u
, struct unit_addrs_vector
*addrs
,
2141 enum dwarf_tag
*unit_tag
)
2143 while (unit_buf
->left
> 0)
2146 const struct abbrev
*abbrev
;
2147 struct pcrange pcrange
;
2148 struct attr_val name_val
;
2150 struct attr_val comp_dir_val
;
2151 int have_comp_dir_val
;
2154 code
= read_uleb128 (unit_buf
);
2158 abbrev
= lookup_abbrev (&u
->abbrevs
, code
, error_callback
, data
);
2162 if (unit_tag
!= NULL
)
2163 *unit_tag
= abbrev
->tag
;
2165 memset (&pcrange
, 0, sizeof pcrange
);
2166 memset (&name_val
, 0, sizeof name_val
);
2168 memset (&comp_dir_val
, 0, sizeof comp_dir_val
);
2169 have_comp_dir_val
= 0;
2170 for (i
= 0; i
< abbrev
->num_attrs
; ++i
)
2172 struct attr_val val
;
2174 if (!read_attribute (abbrev
->attrs
[i
].form
, abbrev
->attrs
[i
].val
,
2175 unit_buf
, u
->is_dwarf64
, u
->version
,
2176 u
->addrsize
, dwarf_sections
, altlink
, &val
))
2179 switch (abbrev
->attrs
[i
].name
)
2181 case DW_AT_low_pc
: case DW_AT_high_pc
: case DW_AT_ranges
:
2182 update_pcrange (&abbrev
->attrs
[i
], &val
, &pcrange
);
2185 case DW_AT_stmt_list
:
2186 if ((abbrev
->tag
== DW_TAG_compile_unit
2187 || abbrev
->tag
== DW_TAG_skeleton_unit
)
2188 && (val
.encoding
== ATTR_VAL_UINT
2189 || val
.encoding
== ATTR_VAL_REF_SECTION
))
2190 u
->lineoff
= val
.u
.uint
;
2194 if (abbrev
->tag
== DW_TAG_compile_unit
2195 || abbrev
->tag
== DW_TAG_skeleton_unit
)
2202 case DW_AT_comp_dir
:
2203 if (abbrev
->tag
== DW_TAG_compile_unit
2204 || abbrev
->tag
== DW_TAG_skeleton_unit
)
2207 have_comp_dir_val
= 1;
2211 case DW_AT_str_offsets_base
:
2212 if ((abbrev
->tag
== DW_TAG_compile_unit
2213 || abbrev
->tag
== DW_TAG_skeleton_unit
)
2214 && val
.encoding
== ATTR_VAL_REF_SECTION
)
2215 u
->str_offsets_base
= val
.u
.uint
;
2218 case DW_AT_addr_base
:
2219 if ((abbrev
->tag
== DW_TAG_compile_unit
2220 || abbrev
->tag
== DW_TAG_skeleton_unit
)
2221 && val
.encoding
== ATTR_VAL_REF_SECTION
)
2222 u
->addr_base
= val
.u
.uint
;
2225 case DW_AT_rnglists_base
:
2226 if ((abbrev
->tag
== DW_TAG_compile_unit
2227 || abbrev
->tag
== DW_TAG_skeleton_unit
)
2228 && val
.encoding
== ATTR_VAL_REF_SECTION
)
2229 u
->rnglists_base
= val
.u
.uint
;
2237 // Resolve strings after we're sure that we have seen
2238 // DW_AT_str_offsets_base.
2241 if (!resolve_string (dwarf_sections
, u
->is_dwarf64
, is_bigendian
,
2242 u
->str_offsets_base
, &name_val
,
2243 error_callback
, data
, &u
->filename
))
2246 if (have_comp_dir_val
)
2248 if (!resolve_string (dwarf_sections
, u
->is_dwarf64
, is_bigendian
,
2249 u
->str_offsets_base
, &comp_dir_val
,
2250 error_callback
, data
, &u
->comp_dir
))
2254 if (abbrev
->tag
== DW_TAG_compile_unit
2255 || abbrev
->tag
== DW_TAG_subprogram
2256 || abbrev
->tag
== DW_TAG_skeleton_unit
)
2258 if (!add_ranges (state
, dwarf_sections
, base_address
,
2259 is_bigendian
, u
, pcrange
.lowpc
, &pcrange
,
2260 add_unit_addr
, (void *) u
, error_callback
, data
,
2264 /* If we found the PC range in the DW_TAG_compile_unit or
2265 DW_TAG_skeleton_unit, we can stop now. */
2266 if ((abbrev
->tag
== DW_TAG_compile_unit
2267 || abbrev
->tag
== DW_TAG_skeleton_unit
)
2268 && (pcrange
.have_ranges
2269 || (pcrange
.have_lowpc
&& pcrange
.have_highpc
)))
2273 if (abbrev
->has_children
)
2275 if (!find_address_ranges (state
, base_address
, unit_buf
,
2276 dwarf_sections
, is_bigendian
, altlink
,
2277 error_callback
, data
, u
, addrs
, NULL
))
2285 /* Build a mapping from address ranges to the compilation units where
2286 the line number information for that range can be found. Returns 1
2287 on success, 0 on failure. */
2290 build_address_map (struct backtrace_state
*state
,
2291 struct libbacktrace_base_address base_address
,
2292 const struct dwarf_sections
*dwarf_sections
,
2293 int is_bigendian
, struct dwarf_data
*altlink
,
2294 backtrace_error_callback error_callback
, void *data
,
2295 struct unit_addrs_vector
*addrs
,
2296 struct unit_vector
*unit_vec
)
2298 struct dwarf_buf info
;
2299 struct backtrace_vector units
;
2303 size_t unit_offset
= 0;
2304 struct unit_addrs
*pa
;
2306 memset (&addrs
->vec
, 0, sizeof addrs
->vec
);
2307 memset (&unit_vec
->vec
, 0, sizeof unit_vec
->vec
);
2309 unit_vec
->count
= 0;
2311 /* Read through the .debug_info section. FIXME: Should we use the
2312 .debug_aranges section? gdb and addr2line don't use it, but I'm
2315 info
.name
= ".debug_info";
2316 info
.start
= dwarf_sections
->data
[DEBUG_INFO
];
2317 info
.buf
= info
.start
;
2318 info
.left
= dwarf_sections
->size
[DEBUG_INFO
];
2319 info
.is_bigendian
= is_bigendian
;
2320 info
.error_callback
= error_callback
;
2322 info
.reported_underflow
= 0;
2324 memset (&units
, 0, sizeof units
);
2327 while (info
.left
> 0)
2329 const unsigned char *unit_data_start
;
2332 struct dwarf_buf unit_buf
;
2335 uint64_t abbrev_offset
;
2338 enum dwarf_tag unit_tag
;
2340 if (info
.reported_underflow
)
2343 unit_data_start
= info
.buf
;
2345 len
= read_initial_length (&info
, &is_dwarf64
);
2347 unit_buf
.left
= len
;
2349 if (!advance (&info
, len
))
2352 version
= read_uint16 (&unit_buf
);
2353 if (version
< 2 || version
> 5)
2355 dwarf_buf_error (&unit_buf
, "unrecognized DWARF version", -1);
2363 unit_type
= read_byte (&unit_buf
);
2364 if (unit_type
== DW_UT_type
|| unit_type
== DW_UT_split_type
)
2366 /* This unit doesn't have anything we need. */
2371 pu
= ((struct unit
**)
2372 backtrace_vector_grow (state
, sizeof (struct unit
*),
2373 error_callback
, data
, &units
));
2377 u
= ((struct unit
*)
2378 backtrace_alloc (state
, sizeof *u
, error_callback
, data
));
2386 addrsize
= 0; /* Set below. */
2388 addrsize
= read_byte (&unit_buf
);
2390 memset (&u
->abbrevs
, 0, sizeof u
->abbrevs
);
2391 abbrev_offset
= read_offset (&unit_buf
, is_dwarf64
);
2392 if (!read_abbrevs (state
, abbrev_offset
,
2393 dwarf_sections
->data
[DEBUG_ABBREV
],
2394 dwarf_sections
->size
[DEBUG_ABBREV
],
2395 is_bigendian
, error_callback
, data
, &u
->abbrevs
))
2399 addrsize
= read_byte (&unit_buf
);
2405 case DW_UT_compile
: case DW_UT_partial
:
2407 case DW_UT_skeleton
: case DW_UT_split_compile
:
2408 read_uint64 (&unit_buf
); /* dwo_id */
2414 u
->low_offset
= unit_offset
;
2415 unit_offset
+= len
+ (is_dwarf64
? 12 : 4);
2416 u
->high_offset
= unit_offset
;
2417 u
->unit_data
= unit_buf
.buf
;
2418 u
->unit_data_len
= unit_buf
.left
;
2419 u
->unit_data_offset
= unit_buf
.buf
- unit_data_start
;
2420 u
->version
= version
;
2421 u
->is_dwarf64
= is_dwarf64
;
2422 u
->addrsize
= addrsize
;
2425 u
->abs_filename
= NULL
;
2427 u
->str_offsets_base
= 0;
2429 u
->rnglists_base
= 0;
2431 /* The actual line number mappings will be read as needed. */
2434 u
->function_addrs
= NULL
;
2435 u
->function_addrs_count
= 0;
2437 if (!find_address_ranges (state
, base_address
, &unit_buf
, dwarf_sections
,
2438 is_bigendian
, altlink
, error_callback
, data
,
2439 u
, addrs
, &unit_tag
))
2442 if (unit_buf
.reported_underflow
)
2445 if (info
.reported_underflow
)
2448 /* Add a trailing addrs entry, but don't include it in addrs->count. */
2449 pa
= ((struct unit_addrs
*)
2450 backtrace_vector_grow (state
, sizeof (struct unit_addrs
),
2451 error_callback
, data
, &addrs
->vec
));
2459 unit_vec
->vec
= units
;
2460 unit_vec
->count
= units_count
;
2464 if (units_count
> 0)
2466 pu
= (struct unit
**) units
.base
;
2467 for (i
= 0; i
< units_count
; i
++)
2469 free_abbrevs (state
, &pu
[i
]->abbrevs
, error_callback
, data
);
2470 backtrace_free (state
, pu
[i
], sizeof **pu
, error_callback
, data
);
2472 backtrace_vector_free (state
, &units
, error_callback
, data
);
2474 if (addrs
->count
> 0)
2476 backtrace_vector_free (state
, &addrs
->vec
, error_callback
, data
);
2482 /* Add a new mapping to the vector of line mappings that we are
2483 building. Returns 1 on success, 0 on failure. */
2486 add_line (struct backtrace_state
*state
, struct dwarf_data
*ddata
,
2487 uintptr_t pc
, const char *filename
, int lineno
,
2488 backtrace_error_callback error_callback
, void *data
,
2489 struct line_vector
*vec
)
2493 /* If we are adding the same mapping, ignore it. This can happen
2494 when using discriminators. */
2497 ln
= (struct line
*) vec
->vec
.base
+ (vec
->count
- 1);
2498 if (pc
== ln
->pc
&& filename
== ln
->filename
&& lineno
== ln
->lineno
)
2502 ln
= ((struct line
*)
2503 backtrace_vector_grow (state
, sizeof (struct line
), error_callback
,
2508 /* Add in the base address here, so that we can look up the PC
2510 ln
->pc
= libbacktrace_add_base (pc
, ddata
->base_address
);
2512 ln
->filename
= filename
;
2513 ln
->lineno
= lineno
;
2514 ln
->idx
= vec
->count
;
2521 /* Free the line header information. */
2524 free_line_header (struct backtrace_state
*state
, struct line_header
*hdr
,
2525 backtrace_error_callback error_callback
, void *data
)
2527 if (hdr
->dirs_count
!= 0)
2528 backtrace_free (state
, hdr
->dirs
, hdr
->dirs_count
* sizeof (const char *),
2529 error_callback
, data
);
2530 backtrace_free (state
, hdr
->filenames
,
2531 hdr
->filenames_count
* sizeof (char *),
2532 error_callback
, data
);
2535 /* Read the directories and file names for a line header for version
2536 2, setting fields in HDR. Return 1 on success, 0 on failure. */
2539 read_v2_paths (struct backtrace_state
*state
, struct unit
*u
,
2540 struct dwarf_buf
*hdr_buf
, struct line_header
*hdr
)
2542 const unsigned char *p
;
2543 const unsigned char *pend
;
2546 /* Count the number of directory entries. */
2547 hdr
->dirs_count
= 0;
2549 pend
= p
+ hdr_buf
->left
;
2550 while (p
< pend
&& *p
!= '\0')
2552 p
+= strnlen((const char *) p
, pend
- p
) + 1;
2556 /* The index of the first entry in the list of directories is 1. Index 0 is
2557 used for the current directory of the compilation. To simplify index
2558 handling, we set entry 0 to the compilation unit directory. */
2560 hdr
->dirs
= ((const char **)
2561 backtrace_alloc (state
,
2562 hdr
->dirs_count
* sizeof (const char *),
2563 hdr_buf
->error_callback
,
2565 if (hdr
->dirs
== NULL
)
2568 hdr
->dirs
[0] = u
->comp_dir
;
2570 while (*hdr_buf
->buf
!= '\0')
2572 if (hdr_buf
->reported_underflow
)
2575 hdr
->dirs
[i
] = read_string (hdr_buf
);
2576 if (hdr
->dirs
[i
] == NULL
)
2580 if (!advance (hdr_buf
, 1))
2583 /* Count the number of file entries. */
2584 hdr
->filenames_count
= 0;
2586 pend
= p
+ hdr_buf
->left
;
2587 while (p
< pend
&& *p
!= '\0')
2589 p
+= strnlen ((const char *) p
, pend
- p
) + 1;
2590 p
+= leb128_len (p
);
2591 p
+= leb128_len (p
);
2592 p
+= leb128_len (p
);
2593 ++hdr
->filenames_count
;
2596 /* The index of the first entry in the list of file names is 1. Index 0 is
2597 used for the DW_AT_name of the compilation unit. To simplify index
2598 handling, we set entry 0 to the compilation unit file name. */
2599 ++hdr
->filenames_count
;
2600 hdr
->filenames
= ((const char **)
2601 backtrace_alloc (state
,
2602 hdr
->filenames_count
* sizeof (char *),
2603 hdr_buf
->error_callback
,
2605 if (hdr
->filenames
== NULL
)
2607 hdr
->filenames
[0] = u
->filename
;
2609 while (*hdr_buf
->buf
!= '\0')
2611 const char *filename
;
2614 if (hdr_buf
->reported_underflow
)
2617 filename
= read_string (hdr_buf
);
2618 if (filename
== NULL
)
2620 dir_index
= read_uleb128 (hdr_buf
);
2621 if (IS_ABSOLUTE_PATH (filename
)
2622 || (dir_index
< hdr
->dirs_count
&& hdr
->dirs
[dir_index
] == NULL
))
2623 hdr
->filenames
[i
] = filename
;
2628 size_t filename_len
;
2631 if (dir_index
< hdr
->dirs_count
)
2632 dir
= hdr
->dirs
[dir_index
];
2635 dwarf_buf_error (hdr_buf
,
2636 ("invalid directory index in "
2637 "line number program header"),
2641 dir_len
= strlen (dir
);
2642 filename_len
= strlen (filename
);
2643 s
= ((char *) backtrace_alloc (state
, dir_len
+ filename_len
+ 2,
2644 hdr_buf
->error_callback
,
2648 memcpy (s
, dir
, dir_len
);
2649 /* FIXME: If we are on a DOS-based file system, and the
2650 directory or the file name use backslashes, then we
2651 should use a backslash here. */
2653 memcpy (s
+ dir_len
+ 1, filename
, filename_len
+ 1);
2654 hdr
->filenames
[i
] = s
;
2657 /* Ignore the modification time and size. */
2658 read_uleb128 (hdr_buf
);
2659 read_uleb128 (hdr_buf
);
2667 /* Read a single version 5 LNCT entry for a directory or file name in a
2668 line header. Sets *STRING to the resulting name, ignoring other
2669 data. Return 1 on success, 0 on failure. */
2672 read_lnct (struct backtrace_state
*state
, struct dwarf_data
*ddata
,
2673 struct unit
*u
, struct dwarf_buf
*hdr_buf
,
2674 const struct line_header
*hdr
, size_t formats_count
,
2675 const struct line_header_format
*formats
, const char **string
)
2683 for (i
= 0; i
< formats_count
; i
++)
2685 struct attr_val val
;
2687 if (!read_attribute (formats
[i
].form
, 0, hdr_buf
, u
->is_dwarf64
,
2688 u
->version
, hdr
->addrsize
, &ddata
->dwarf_sections
,
2689 ddata
->altlink
, &val
))
2691 switch (formats
[i
].lnct
)
2694 if (!resolve_string (&ddata
->dwarf_sections
, u
->is_dwarf64
,
2695 ddata
->is_bigendian
, u
->str_offsets_base
,
2696 &val
, hdr_buf
->error_callback
, hdr_buf
->data
,
2700 case DW_LNCT_directory_index
:
2701 if (val
.encoding
== ATTR_VAL_UINT
)
2703 if (val
.u
.uint
>= hdr
->dirs_count
)
2705 dwarf_buf_error (hdr_buf
,
2706 ("invalid directory index in "
2707 "line number program header"),
2711 dir
= hdr
->dirs
[val
.u
.uint
];
2715 /* We don't care about timestamps or sizes or hashes. */
2722 dwarf_buf_error (hdr_buf
,
2723 "missing file name in line number program header",
2736 dir_len
= strlen (dir
);
2737 path_len
= strlen (path
);
2738 s
= (char *) backtrace_alloc (state
, dir_len
+ path_len
+ 2,
2739 hdr_buf
->error_callback
, hdr_buf
->data
);
2742 memcpy (s
, dir
, dir_len
);
2743 /* FIXME: If we are on a DOS-based file system, and the
2744 directory or the path name use backslashes, then we should
2745 use a backslash here. */
2747 memcpy (s
+ dir_len
+ 1, path
, path_len
+ 1);
2754 /* Read a set of DWARF 5 line header format entries, setting *PCOUNT
2755 and *PPATHS. Return 1 on success, 0 on failure. */
2758 read_line_header_format_entries (struct backtrace_state
*state
,
2759 struct dwarf_data
*ddata
,
2761 struct dwarf_buf
*hdr_buf
,
2762 struct line_header
*hdr
,
2764 const char ***ppaths
)
2766 size_t formats_count
;
2767 struct line_header_format
*formats
;
2773 formats_count
= read_byte (hdr_buf
);
2774 if (formats_count
== 0)
2778 formats
= ((struct line_header_format
*)
2779 backtrace_alloc (state
,
2781 * sizeof (struct line_header_format
)),
2782 hdr_buf
->error_callback
,
2784 if (formats
== NULL
)
2787 for (i
= 0; i
< formats_count
; i
++)
2789 formats
[i
].lnct
= (int) read_uleb128(hdr_buf
);
2790 formats
[i
].form
= (enum dwarf_form
) read_uleb128 (hdr_buf
);
2794 paths_count
= read_uleb128 (hdr_buf
);
2795 if (paths_count
== 0)
2803 paths
= ((const char **)
2804 backtrace_alloc (state
, paths_count
* sizeof (const char *),
2805 hdr_buf
->error_callback
, hdr_buf
->data
));
2811 for (i
= 0; i
< paths_count
; i
++)
2813 if (!read_lnct (state
, ddata
, u
, hdr_buf
, hdr
, formats_count
,
2814 formats
, &paths
[i
]))
2816 backtrace_free (state
, paths
,
2817 paths_count
* sizeof (const char *),
2818 hdr_buf
->error_callback
, hdr_buf
->data
);
2824 *pcount
= paths_count
;
2830 if (formats
!= NULL
)
2831 backtrace_free (state
, formats
,
2832 formats_count
* sizeof (struct line_header_format
),
2833 hdr_buf
->error_callback
, hdr_buf
->data
);
2838 /* Read the line header. Return 1 on success, 0 on failure. */
2841 read_line_header (struct backtrace_state
*state
, struct dwarf_data
*ddata
,
2842 struct unit
*u
, int is_dwarf64
, struct dwarf_buf
*line_buf
,
2843 struct line_header
*hdr
)
2846 struct dwarf_buf hdr_buf
;
2848 hdr
->version
= read_uint16 (line_buf
);
2849 if (hdr
->version
< 2 || hdr
->version
> 5)
2851 dwarf_buf_error (line_buf
, "unsupported line number version", -1);
2855 if (hdr
->version
< 5)
2856 hdr
->addrsize
= u
->addrsize
;
2859 hdr
->addrsize
= read_byte (line_buf
);
2860 /* We could support a non-zero segment_selector_size but I doubt
2861 we'll ever see it. */
2862 if (read_byte (line_buf
) != 0)
2864 dwarf_buf_error (line_buf
,
2865 "non-zero segment_selector_size not supported",
2871 hdrlen
= read_offset (line_buf
, is_dwarf64
);
2873 hdr_buf
= *line_buf
;
2874 hdr_buf
.left
= hdrlen
;
2876 if (!advance (line_buf
, hdrlen
))
2879 hdr
->min_insn_len
= read_byte (&hdr_buf
);
2880 if (hdr
->version
< 4)
2881 hdr
->max_ops_per_insn
= 1;
2883 hdr
->max_ops_per_insn
= read_byte (&hdr_buf
);
2885 /* We don't care about default_is_stmt. */
2886 read_byte (&hdr_buf
);
2888 hdr
->line_base
= read_sbyte (&hdr_buf
);
2889 hdr
->line_range
= read_byte (&hdr_buf
);
2891 hdr
->opcode_base
= read_byte (&hdr_buf
);
2892 hdr
->opcode_lengths
= hdr_buf
.buf
;
2893 if (!advance (&hdr_buf
, hdr
->opcode_base
- 1))
2896 if (hdr
->version
< 5)
2898 if (!read_v2_paths (state
, u
, &hdr_buf
, hdr
))
2903 if (!read_line_header_format_entries (state
, ddata
, u
, &hdr_buf
, hdr
,
2907 if (!read_line_header_format_entries (state
, ddata
, u
, &hdr_buf
, hdr
,
2908 &hdr
->filenames_count
,
2913 if (hdr_buf
.reported_underflow
)
2919 /* Read the line program, adding line mappings to VEC. Return 1 on
2920 success, 0 on failure. */
2923 read_line_program (struct backtrace_state
*state
, struct dwarf_data
*ddata
,
2924 const struct line_header
*hdr
, struct dwarf_buf
*line_buf
,
2925 struct line_vector
*vec
)
2928 unsigned int op_index
;
2929 const char *reset_filename
;
2930 const char *filename
;
2935 if (hdr
->filenames_count
> 1)
2936 reset_filename
= hdr
->filenames
[1];
2938 reset_filename
= "";
2939 filename
= reset_filename
;
2941 while (line_buf
->left
> 0)
2945 op
= read_byte (line_buf
);
2946 if (op
>= hdr
->opcode_base
)
2948 unsigned int advance
;
2950 /* Special opcode. */
2951 op
-= hdr
->opcode_base
;
2952 advance
= op
/ hdr
->line_range
;
2953 address
+= (hdr
->min_insn_len
* (op_index
+ advance
)
2954 / hdr
->max_ops_per_insn
);
2955 op_index
= (op_index
+ advance
) % hdr
->max_ops_per_insn
;
2956 lineno
+= hdr
->line_base
+ (int) (op
% hdr
->line_range
);
2957 add_line (state
, ddata
, address
, filename
, lineno
,
2958 line_buf
->error_callback
, line_buf
->data
, vec
);
2960 else if (op
== DW_LNS_extended_op
)
2964 len
= read_uleb128 (line_buf
);
2965 op
= read_byte (line_buf
);
2968 case DW_LNE_end_sequence
:
2969 /* FIXME: Should we mark the high PC here? It seems
2970 that we already have that information from the
2971 compilation unit. */
2974 filename
= reset_filename
;
2977 case DW_LNE_set_address
:
2978 address
= read_address (line_buf
, hdr
->addrsize
);
2980 case DW_LNE_define_file
:
2983 unsigned int dir_index
;
2985 f
= read_string (line_buf
);
2988 dir_index
= read_uleb128 (line_buf
);
2989 /* Ignore that time and length. */
2990 read_uleb128 (line_buf
);
2991 read_uleb128 (line_buf
);
2992 if (IS_ABSOLUTE_PATH (f
))
3001 if (dir_index
< hdr
->dirs_count
)
3002 dir
= hdr
->dirs
[dir_index
];
3005 dwarf_buf_error (line_buf
,
3006 ("invalid directory index "
3007 "in line number program"),
3011 dir_len
= strlen (dir
);
3014 backtrace_alloc (state
, dir_len
+ f_len
+ 2,
3015 line_buf
->error_callback
,
3019 memcpy (p
, dir
, dir_len
);
3020 /* FIXME: If we are on a DOS-based file system,
3021 and the directory or the file name use
3022 backslashes, then we should use a backslash
3025 memcpy (p
+ dir_len
+ 1, f
, f_len
+ 1);
3030 case DW_LNE_set_discriminator
:
3031 /* We don't care about discriminators. */
3032 read_uleb128 (line_buf
);
3035 if (!advance (line_buf
, len
- 1))
3045 add_line (state
, ddata
, address
, filename
, lineno
,
3046 line_buf
->error_callback
, line_buf
->data
, vec
);
3048 case DW_LNS_advance_pc
:
3052 advance
= read_uleb128 (line_buf
);
3053 address
+= (hdr
->min_insn_len
* (op_index
+ advance
)
3054 / hdr
->max_ops_per_insn
);
3055 op_index
= (op_index
+ advance
) % hdr
->max_ops_per_insn
;
3058 case DW_LNS_advance_line
:
3059 lineno
+= (int) read_sleb128 (line_buf
);
3061 case DW_LNS_set_file
:
3065 fileno
= read_uleb128 (line_buf
);
3066 if (fileno
>= hdr
->filenames_count
)
3068 dwarf_buf_error (line_buf
,
3069 ("invalid file number in "
3070 "line number program"),
3074 filename
= hdr
->filenames
[fileno
];
3077 case DW_LNS_set_column
:
3078 read_uleb128 (line_buf
);
3080 case DW_LNS_negate_stmt
:
3082 case DW_LNS_set_basic_block
:
3084 case DW_LNS_const_add_pc
:
3086 unsigned int advance
;
3088 op
= 255 - hdr
->opcode_base
;
3089 advance
= op
/ hdr
->line_range
;
3090 address
+= (hdr
->min_insn_len
* (op_index
+ advance
)
3091 / hdr
->max_ops_per_insn
);
3092 op_index
= (op_index
+ advance
) % hdr
->max_ops_per_insn
;
3095 case DW_LNS_fixed_advance_pc
:
3096 address
+= read_uint16 (line_buf
);
3099 case DW_LNS_set_prologue_end
:
3101 case DW_LNS_set_epilogue_begin
:
3103 case DW_LNS_set_isa
:
3104 read_uleb128 (line_buf
);
3110 for (i
= hdr
->opcode_lengths
[op
- 1]; i
> 0; --i
)
3111 read_uleb128 (line_buf
);
3121 /* Read the line number information for a compilation unit. Returns 1
3122 on success, 0 on failure. */
3125 read_line_info (struct backtrace_state
*state
, struct dwarf_data
*ddata
,
3126 backtrace_error_callback error_callback
, void *data
,
3127 struct unit
*u
, struct line_header
*hdr
, struct line
**lines
,
3128 size_t *lines_count
)
3130 struct line_vector vec
;
3131 struct dwarf_buf line_buf
;
3136 memset (&vec
.vec
, 0, sizeof vec
.vec
);
3139 memset (hdr
, 0, sizeof *hdr
);
3141 if (u
->lineoff
!= (off_t
) (size_t) u
->lineoff
3142 || (size_t) u
->lineoff
>= ddata
->dwarf_sections
.size
[DEBUG_LINE
])
3144 error_callback (data
, "unit line offset out of range", 0);
3148 line_buf
.name
= ".debug_line";
3149 line_buf
.start
= ddata
->dwarf_sections
.data
[DEBUG_LINE
];
3150 line_buf
.buf
= ddata
->dwarf_sections
.data
[DEBUG_LINE
] + u
->lineoff
;
3151 line_buf
.left
= ddata
->dwarf_sections
.size
[DEBUG_LINE
] - u
->lineoff
;
3152 line_buf
.is_bigendian
= ddata
->is_bigendian
;
3153 line_buf
.error_callback
= error_callback
;
3154 line_buf
.data
= data
;
3155 line_buf
.reported_underflow
= 0;
3157 len
= read_initial_length (&line_buf
, &is_dwarf64
);
3158 line_buf
.left
= len
;
3160 if (!read_line_header (state
, ddata
, u
, is_dwarf64
, &line_buf
, hdr
))
3163 if (!read_line_program (state
, ddata
, hdr
, &line_buf
, &vec
))
3166 if (line_buf
.reported_underflow
)
3171 /* This is not a failure in the sense of generating an error,
3172 but it is a failure in that sense that we have no useful
3177 /* Allocate one extra entry at the end. */
3178 ln
= ((struct line
*)
3179 backtrace_vector_grow (state
, sizeof (struct line
), error_callback
,
3183 ln
->pc
= (uintptr_t) -1;
3184 ln
->filename
= NULL
;
3188 if (!backtrace_vector_release (state
, &vec
.vec
, error_callback
, data
))
3191 ln
= (struct line
*) vec
.vec
.base
;
3192 backtrace_qsort (ln
, vec
.count
, sizeof (struct line
), line_compare
);
3195 *lines_count
= vec
.count
;
3200 backtrace_vector_free (state
, &vec
.vec
, error_callback
, data
);
3201 free_line_header (state
, hdr
, error_callback
, data
);
3202 *lines
= (struct line
*) (uintptr_t) -1;
3207 static const char *read_referenced_name (struct dwarf_data
*, struct unit
*,
3208 uint64_t, backtrace_error_callback
,
3211 /* Read the name of a function from a DIE referenced by ATTR with VAL. */
3214 read_referenced_name_from_attr (struct dwarf_data
*ddata
, struct unit
*u
,
3215 struct attr
*attr
, struct attr_val
*val
,
3216 backtrace_error_callback error_callback
,
3221 case DW_AT_abstract_origin
:
3222 case DW_AT_specification
:
3228 if (attr
->form
== DW_FORM_ref_sig8
)
3231 if (val
->encoding
== ATTR_VAL_REF_INFO
)
3234 = find_unit (ddata
->units
, ddata
->units_count
,
3239 uint64_t offset
= val
->u
.uint
- unit
->low_offset
;
3240 return read_referenced_name (ddata
, unit
, offset
, error_callback
, data
);
3243 if (val
->encoding
== ATTR_VAL_UINT
3244 || val
->encoding
== ATTR_VAL_REF_UNIT
)
3245 return read_referenced_name (ddata
, u
, val
->u
.uint
, error_callback
, data
);
3247 if (val
->encoding
== ATTR_VAL_REF_ALT_INFO
)
3249 struct unit
*alt_unit
3250 = find_unit (ddata
->altlink
->units
, ddata
->altlink
->units_count
,
3252 if (alt_unit
== NULL
)
3255 uint64_t offset
= val
->u
.uint
- alt_unit
->low_offset
;
3256 return read_referenced_name (ddata
->altlink
, alt_unit
, offset
,
3257 error_callback
, data
);
3263 /* Read the name of a function from a DIE referenced by a
3264 DW_AT_abstract_origin or DW_AT_specification tag. OFFSET is within
3265 the same compilation unit. */
3268 read_referenced_name (struct dwarf_data
*ddata
, struct unit
*u
,
3269 uint64_t offset
, backtrace_error_callback error_callback
,
3272 struct dwarf_buf unit_buf
;
3274 const struct abbrev
*abbrev
;
3278 /* OFFSET is from the start of the data for this compilation unit.
3279 U->unit_data is the data, but it starts U->unit_data_offset bytes
3280 from the beginning. */
3282 if (offset
< u
->unit_data_offset
3283 || offset
- u
->unit_data_offset
>= u
->unit_data_len
)
3285 error_callback (data
,
3286 "abstract origin or specification out of range",
3291 offset
-= u
->unit_data_offset
;
3293 unit_buf
.name
= ".debug_info";
3294 unit_buf
.start
= ddata
->dwarf_sections
.data
[DEBUG_INFO
];
3295 unit_buf
.buf
= u
->unit_data
+ offset
;
3296 unit_buf
.left
= u
->unit_data_len
- offset
;
3297 unit_buf
.is_bigendian
= ddata
->is_bigendian
;
3298 unit_buf
.error_callback
= error_callback
;
3299 unit_buf
.data
= data
;
3300 unit_buf
.reported_underflow
= 0;
3302 code
= read_uleb128 (&unit_buf
);
3305 dwarf_buf_error (&unit_buf
,
3306 "invalid abstract origin or specification",
3311 abbrev
= lookup_abbrev (&u
->abbrevs
, code
, error_callback
, data
);
3316 for (i
= 0; i
< abbrev
->num_attrs
; ++i
)
3318 struct attr_val val
;
3320 if (!read_attribute (abbrev
->attrs
[i
].form
, abbrev
->attrs
[i
].val
,
3321 &unit_buf
, u
->is_dwarf64
, u
->version
, u
->addrsize
,
3322 &ddata
->dwarf_sections
, ddata
->altlink
, &val
))
3325 switch (abbrev
->attrs
[i
].name
)
3328 /* Third name preference: don't override. A name we found in some
3329 other way, will normally be more useful -- e.g., this name is
3330 normally not mangled. */
3333 if (!resolve_string (&ddata
->dwarf_sections
, u
->is_dwarf64
,
3334 ddata
->is_bigendian
, u
->str_offsets_base
,
3335 &val
, error_callback
, data
, &ret
))
3339 case DW_AT_linkage_name
:
3340 case DW_AT_MIPS_linkage_name
:
3341 /* First name preference: override all. */
3346 if (!resolve_string (&ddata
->dwarf_sections
, u
->is_dwarf64
,
3347 ddata
->is_bigendian
, u
->str_offsets_base
,
3348 &val
, error_callback
, data
, &s
))
3355 case DW_AT_specification
:
3356 /* Second name preference: override DW_AT_name, don't override
3357 DW_AT_linkage_name. */
3361 name
= read_referenced_name_from_attr (ddata
, u
, &abbrev
->attrs
[i
],
3362 &val
, error_callback
, data
);
3376 /* Add a range to a unit that maps to a function. This is called via
3377 add_ranges. Returns 1 on success, 0 on error. */
3380 add_function_range (struct backtrace_state
*state
, void *rdata
,
3381 uintptr_t lowpc
, uintptr_t highpc
,
3382 backtrace_error_callback error_callback
, void *data
,
3385 struct function
*function
= (struct function
*) rdata
;
3386 struct function_vector
*vec
= (struct function_vector
*) pvec
;
3387 struct function_addrs
*p
;
3391 p
= (struct function_addrs
*) vec
->vec
.base
+ (vec
->count
- 1);
3392 if ((lowpc
== p
->high
|| lowpc
== p
->high
+ 1)
3393 && function
== p
->function
)
3395 if (highpc
> p
->high
)
3401 p
= ((struct function_addrs
*)
3402 backtrace_vector_grow (state
, sizeof (struct function_addrs
),
3403 error_callback
, data
, &vec
->vec
));
3409 p
->function
= function
;
3416 /* Read one entry plus all its children. Add function addresses to
3417 VEC. Returns 1 on success, 0 on error. */
3420 read_function_entry (struct backtrace_state
*state
, struct dwarf_data
*ddata
,
3421 struct unit
*u
, uintptr_t base
, struct dwarf_buf
*unit_buf
,
3422 const struct line_header
*lhdr
,
3423 backtrace_error_callback error_callback
, void *data
,
3424 struct function_vector
*vec_function
,
3425 struct function_vector
*vec_inlined
)
3427 while (unit_buf
->left
> 0)
3430 const struct abbrev
*abbrev
;
3432 struct function
*function
;
3433 struct function_vector
*vec
;
3435 struct pcrange pcrange
;
3436 int have_linkage_name
;
3438 code
= read_uleb128 (unit_buf
);
3442 abbrev
= lookup_abbrev (&u
->abbrevs
, code
, error_callback
, data
);
3446 is_function
= (abbrev
->tag
== DW_TAG_subprogram
3447 || abbrev
->tag
== DW_TAG_entry_point
3448 || abbrev
->tag
== DW_TAG_inlined_subroutine
);
3450 if (abbrev
->tag
== DW_TAG_inlined_subroutine
)
3458 function
= ((struct function
*)
3459 backtrace_alloc (state
, sizeof *function
,
3460 error_callback
, data
));
3461 if (function
== NULL
)
3463 memset (function
, 0, sizeof *function
);
3466 memset (&pcrange
, 0, sizeof pcrange
);
3467 have_linkage_name
= 0;
3468 for (i
= 0; i
< abbrev
->num_attrs
; ++i
)
3470 struct attr_val val
;
3472 if (!read_attribute (abbrev
->attrs
[i
].form
, abbrev
->attrs
[i
].val
,
3473 unit_buf
, u
->is_dwarf64
, u
->version
,
3474 u
->addrsize
, &ddata
->dwarf_sections
,
3475 ddata
->altlink
, &val
))
3478 /* The compile unit sets the base address for any address
3479 ranges in the function entries. */
3480 if ((abbrev
->tag
== DW_TAG_compile_unit
3481 || abbrev
->tag
== DW_TAG_skeleton_unit
)
3482 && abbrev
->attrs
[i
].name
== DW_AT_low_pc
)
3484 if (val
.encoding
== ATTR_VAL_ADDRESS
)
3485 base
= (uintptr_t) val
.u
.uint
;
3486 else if (val
.encoding
== ATTR_VAL_ADDRESS_INDEX
)
3488 if (!resolve_addr_index (&ddata
->dwarf_sections
,
3489 u
->addr_base
, u
->addrsize
,
3490 ddata
->is_bigendian
, val
.u
.uint
,
3491 error_callback
, data
, &base
))
3498 switch (abbrev
->attrs
[i
].name
)
3500 case DW_AT_call_file
:
3501 if (val
.encoding
== ATTR_VAL_UINT
)
3503 if (val
.u
.uint
>= lhdr
->filenames_count
)
3505 dwarf_buf_error (unit_buf
,
3506 ("invalid file number in "
3507 "DW_AT_call_file attribute"),
3511 function
->caller_filename
= lhdr
->filenames
[val
.u
.uint
];
3515 case DW_AT_call_line
:
3516 if (val
.encoding
== ATTR_VAL_UINT
)
3517 function
->caller_lineno
= val
.u
.uint
;
3520 case DW_AT_abstract_origin
:
3521 case DW_AT_specification
:
3522 /* Second name preference: override DW_AT_name, don't override
3523 DW_AT_linkage_name. */
3524 if (have_linkage_name
)
3530 = read_referenced_name_from_attr (ddata
, u
,
3531 &abbrev
->attrs
[i
], &val
,
3532 error_callback
, data
);
3534 function
->name
= name
;
3539 /* Third name preference: don't override. */
3540 if (function
->name
!= NULL
)
3542 if (!resolve_string (&ddata
->dwarf_sections
, u
->is_dwarf64
,
3543 ddata
->is_bigendian
,
3544 u
->str_offsets_base
, &val
,
3545 error_callback
, data
, &function
->name
))
3549 case DW_AT_linkage_name
:
3550 case DW_AT_MIPS_linkage_name
:
3551 /* First name preference: override all. */
3556 if (!resolve_string (&ddata
->dwarf_sections
, u
->is_dwarf64
,
3557 ddata
->is_bigendian
,
3558 u
->str_offsets_base
, &val
,
3559 error_callback
, data
, &s
))
3564 have_linkage_name
= 1;
3569 case DW_AT_low_pc
: case DW_AT_high_pc
: case DW_AT_ranges
:
3570 update_pcrange (&abbrev
->attrs
[i
], &val
, &pcrange
);
3579 /* If we couldn't find a name for the function, we have no use
3581 if (is_function
&& function
->name
== NULL
)
3583 backtrace_free (state
, function
, sizeof *function
,
3584 error_callback
, data
);
3590 if (pcrange
.have_ranges
3591 || (pcrange
.have_lowpc
&& pcrange
.have_highpc
))
3593 if (!add_ranges (state
, &ddata
->dwarf_sections
,
3594 ddata
->base_address
, ddata
->is_bigendian
,
3595 u
, base
, &pcrange
, add_function_range
,
3596 (void *) function
, error_callback
, data
,
3602 backtrace_free (state
, function
, sizeof *function
,
3603 error_callback
, data
);
3608 if (abbrev
->has_children
)
3612 if (!read_function_entry (state
, ddata
, u
, base
, unit_buf
, lhdr
,
3613 error_callback
, data
, vec_function
,
3619 struct function_vector fvec
;
3621 /* Gather any information for inlined functions in
3624 memset (&fvec
, 0, sizeof fvec
);
3626 if (!read_function_entry (state
, ddata
, u
, base
, unit_buf
, lhdr
,
3627 error_callback
, data
, vec_function
,
3633 struct function_addrs
*p
;
3634 struct function_addrs
*faddrs
;
3636 /* Allocate a trailing entry, but don't include it
3638 p
= ((struct function_addrs
*)
3639 backtrace_vector_grow (state
,
3640 sizeof (struct function_addrs
),
3641 error_callback
, data
,
3650 if (!backtrace_vector_release (state
, &fvec
.vec
,
3651 error_callback
, data
))
3654 faddrs
= (struct function_addrs
*) fvec
.vec
.base
;
3655 backtrace_qsort (faddrs
, fvec
.count
,
3656 sizeof (struct function_addrs
),
3657 function_addrs_compare
);
3659 function
->function_addrs
= faddrs
;
3660 function
->function_addrs_count
= fvec
.count
;
3669 /* Read function name information for a compilation unit. We look
3670 through the whole unit looking for function tags. */
3673 read_function_info (struct backtrace_state
*state
, struct dwarf_data
*ddata
,
3674 const struct line_header
*lhdr
,
3675 backtrace_error_callback error_callback
, void *data
,
3676 struct unit
*u
, struct function_vector
*fvec
,
3677 struct function_addrs
**ret_addrs
,
3678 size_t *ret_addrs_count
)
3680 struct function_vector lvec
;
3681 struct function_vector
*pfvec
;
3682 struct dwarf_buf unit_buf
;
3683 struct function_addrs
*p
;
3684 struct function_addrs
*addrs
;
3687 /* Use FVEC if it is not NULL. Otherwise use our own vector. */
3692 memset (&lvec
, 0, sizeof lvec
);
3696 unit_buf
.name
= ".debug_info";
3697 unit_buf
.start
= ddata
->dwarf_sections
.data
[DEBUG_INFO
];
3698 unit_buf
.buf
= u
->unit_data
;
3699 unit_buf
.left
= u
->unit_data_len
;
3700 unit_buf
.is_bigendian
= ddata
->is_bigendian
;
3701 unit_buf
.error_callback
= error_callback
;
3702 unit_buf
.data
= data
;
3703 unit_buf
.reported_underflow
= 0;
3705 while (unit_buf
.left
> 0)
3707 if (!read_function_entry (state
, ddata
, u
, 0, &unit_buf
, lhdr
,
3708 error_callback
, data
, pfvec
, pfvec
))
3712 if (pfvec
->count
== 0)
3715 /* Allocate a trailing entry, but don't include it in
3717 p
= ((struct function_addrs
*)
3718 backtrace_vector_grow (state
, sizeof (struct function_addrs
),
3719 error_callback
, data
, &pfvec
->vec
));
3727 addrs_count
= pfvec
->count
;
3731 if (!backtrace_vector_release (state
, &lvec
.vec
, error_callback
, data
))
3733 addrs
= (struct function_addrs
*) pfvec
->vec
.base
;
3737 /* Finish this list of addresses, but leave the remaining space in
3738 the vector available for the next function unit. */
3739 addrs
= ((struct function_addrs
*)
3740 backtrace_vector_finish (state
, &fvec
->vec
,
3741 error_callback
, data
));
3747 backtrace_qsort (addrs
, addrs_count
, sizeof (struct function_addrs
),
3748 function_addrs_compare
);
3751 *ret_addrs_count
= addrs_count
;
3754 /* See if PC is inlined in FUNCTION. If it is, print out the inlined
3755 information, and update FILENAME and LINENO for the caller.
3756 Returns whatever CALLBACK returns, or 0 to keep going. */
3759 report_inlined_functions (uintptr_t pc
, struct function
*function
,
3760 backtrace_full_callback callback
, void *data
,
3761 const char **filename
, int *lineno
)
3763 struct function_addrs
*p
;
3764 struct function_addrs
*match
;
3765 struct function
*inlined
;
3768 if (function
->function_addrs_count
== 0)
3771 /* Our search isn't safe if pc == -1, as that is the sentinel
3776 p
= ((struct function_addrs
*)
3777 bsearch (&pc
, function
->function_addrs
,
3778 function
->function_addrs_count
,
3779 sizeof (struct function_addrs
),
3780 function_addrs_search
));
3784 /* Here pc >= p->low && pc < (p + 1)->low. The function_addrs are
3785 sorted by low, so if pc > p->low we are at the end of a range of
3786 function_addrs with the same low value. If pc == p->low walk
3787 forward to the end of the range with that low value. Then walk
3788 backward and use the first range that includes pc. */
3789 while (pc
== (p
+ 1)->low
)
3799 if (p
== function
->function_addrs
)
3801 if ((p
- 1)->low
< p
->low
)
3808 /* We found an inlined call. */
3810 inlined
= match
->function
;
3812 /* Report any calls inlined into this one. */
3813 ret
= report_inlined_functions (pc
, inlined
, callback
, data
,
3818 /* Report this inlined call. */
3819 ret
= callback (data
, pc
, *filename
, *lineno
, inlined
->name
);
3823 /* Our caller will report the caller of the inlined function; tell
3824 it the appropriate filename and line number. */
3825 *filename
= inlined
->caller_filename
;
3826 *lineno
= inlined
->caller_lineno
;
3831 /* Look for a PC in the DWARF mapping for one module. On success,
3832 call CALLBACK and return whatever it returns. On error, call
3833 ERROR_CALLBACK and return 0. Sets *FOUND to 1 if the PC is found,
3837 dwarf_lookup_pc (struct backtrace_state
*state
, struct dwarf_data
*ddata
,
3838 uintptr_t pc
, backtrace_full_callback callback
,
3839 backtrace_error_callback error_callback
, void *data
,
3842 struct unit_addrs
*entry
;
3848 struct function_addrs
*p
;
3849 struct function_addrs
*fmatch
;
3850 struct function
*function
;
3851 const char *filename
;
3857 /* Find an address range that includes PC. Our search isn't safe if
3858 PC == -1, as we use that as a sentinel value, so skip the search
3860 entry
= (ddata
->addrs_count
== 0 || pc
+ 1 == 0
3862 : bsearch (&pc
, ddata
->addrs
, ddata
->addrs_count
,
3863 sizeof (struct unit_addrs
), unit_addrs_search
));
3871 /* Here pc >= entry->low && pc < (entry + 1)->low. The unit_addrs
3872 are sorted by low, so if pc > p->low we are at the end of a range
3873 of unit_addrs with the same low value. If pc == p->low walk
3874 forward to the end of the range with that low value. Then walk
3875 backward and use the first range that includes pc. */
3876 while (pc
== (entry
+ 1)->low
)
3881 if (pc
< entry
->high
)
3886 if (entry
== ddata
->addrs
)
3888 if ((entry
- 1)->low
< entry
->low
)
3898 /* We need the lines, lines_count, function_addrs,
3899 function_addrs_count fields of u. If they are not set, we need
3900 to set them. When running in threaded mode, we need to allow for
3901 the possibility that some other thread is setting them
3907 /* Skip units with no useful line number information by walking
3908 backward. Useless line number information is marked by setting
3910 while (entry
> ddata
->addrs
3911 && pc
>= (entry
- 1)->low
3912 && pc
< (entry
- 1)->high
)
3914 if (state
->threaded
)
3915 lines
= (struct line
*) backtrace_atomic_load_pointer (&u
->lines
);
3917 if (lines
!= (struct line
*) (uintptr_t) -1)
3926 if (state
->threaded
)
3927 lines
= backtrace_atomic_load_pointer (&u
->lines
);
3932 struct function_addrs
*function_addrs
;
3933 size_t function_addrs_count
;
3934 struct line_header lhdr
;
3937 /* We have never read the line information for this unit. Read
3940 function_addrs
= NULL
;
3941 function_addrs_count
= 0;
3942 if (read_line_info (state
, ddata
, error_callback
, data
, entry
->u
, &lhdr
,
3945 struct function_vector
*pfvec
;
3947 /* If not threaded, reuse DDATA->FVEC for better memory
3949 if (state
->threaded
)
3952 pfvec
= &ddata
->fvec
;
3953 read_function_info (state
, ddata
, &lhdr
, error_callback
, data
,
3954 entry
->u
, pfvec
, &function_addrs
,
3955 &function_addrs_count
);
3956 free_line_header (state
, &lhdr
, error_callback
, data
);
3960 /* Atomically store the information we just read into the unit.
3961 If another thread is simultaneously writing, it presumably
3962 read the same information, and we don't care which one we
3963 wind up with; we just leak the other one. We do have to
3964 write the lines field last, so that the acquire-loads above
3965 ensure that the other fields are set. */
3967 if (!state
->threaded
)
3969 u
->lines_count
= count
;
3970 u
->function_addrs
= function_addrs
;
3971 u
->function_addrs_count
= function_addrs_count
;
3976 backtrace_atomic_store_size_t (&u
->lines_count
, count
);
3977 backtrace_atomic_store_pointer (&u
->function_addrs
, function_addrs
);
3978 backtrace_atomic_store_size_t (&u
->function_addrs_count
,
3979 function_addrs_count
);
3980 backtrace_atomic_store_pointer (&u
->lines
, lines
);
3984 /* Now all fields of U have been initialized. */
3986 if (lines
== (struct line
*) (uintptr_t) -1)
3988 /* If reading the line number information failed in some way,
3989 try again to see if there is a better compilation unit for
3992 return dwarf_lookup_pc (state
, ddata
, pc
, callback
, error_callback
,
3994 return callback (data
, pc
, NULL
, 0, NULL
);
3997 /* Search for PC within this unit. */
3999 ln
= (struct line
*) bsearch (&pc
, lines
, entry
->u
->lines_count
,
4000 sizeof (struct line
), line_search
);
4003 /* The PC is between the low_pc and high_pc attributes of the
4004 compilation unit, but no entry in the line table covers it.
4005 This implies that the start of the compilation unit has no
4006 line number information. */
4008 if (entry
->u
->abs_filename
== NULL
)
4010 const char *filename
;
4012 filename
= entry
->u
->filename
;
4013 if (filename
!= NULL
4014 && !IS_ABSOLUTE_PATH (filename
)
4015 && entry
->u
->comp_dir
!= NULL
)
4017 size_t filename_len
;
4022 filename_len
= strlen (filename
);
4023 dir
= entry
->u
->comp_dir
;
4024 dir_len
= strlen (dir
);
4025 s
= (char *) backtrace_alloc (state
, dir_len
+ filename_len
+ 2,
4026 error_callback
, data
);
4032 memcpy (s
, dir
, dir_len
);
4033 /* FIXME: Should use backslash if DOS file system. */
4035 memcpy (s
+ dir_len
+ 1, filename
, filename_len
+ 1);
4038 entry
->u
->abs_filename
= filename
;
4041 return callback (data
, pc
, entry
->u
->abs_filename
, 0, NULL
);
4044 /* Search for function name within this unit. */
4046 if (entry
->u
->function_addrs_count
== 0)
4047 return callback (data
, pc
, ln
->filename
, ln
->lineno
, NULL
);
4049 p
= ((struct function_addrs
*)
4050 bsearch (&pc
, entry
->u
->function_addrs
,
4051 entry
->u
->function_addrs_count
,
4052 sizeof (struct function_addrs
),
4053 function_addrs_search
));
4055 return callback (data
, pc
, ln
->filename
, ln
->lineno
, NULL
);
4057 /* Here pc >= p->low && pc < (p + 1)->low. The function_addrs are
4058 sorted by low, so if pc > p->low we are at the end of a range of
4059 function_addrs with the same low value. If pc == p->low walk
4060 forward to the end of the range with that low value. Then walk
4061 backward and use the first range that includes pc. */
4062 while (pc
== (p
+ 1)->low
)
4072 if (p
== entry
->u
->function_addrs
)
4074 if ((p
- 1)->low
< p
->low
)
4079 return callback (data
, pc
, ln
->filename
, ln
->lineno
, NULL
);
4081 function
= fmatch
->function
;
4083 filename
= ln
->filename
;
4084 lineno
= ln
->lineno
;
4086 ret
= report_inlined_functions (pc
, function
, callback
, data
,
4087 &filename
, &lineno
);
4091 return callback (data
, pc
, filename
, lineno
, function
->name
);
4095 /* Return the file/line information for a PC using the DWARF mapping
4096 we built earlier. */
4099 dwarf_fileline (struct backtrace_state
*state
, uintptr_t pc
,
4100 backtrace_full_callback callback
,
4101 backtrace_error_callback error_callback
, void *data
)
4103 struct dwarf_data
*ddata
;
4107 if (!state
->threaded
)
4109 for (ddata
= (struct dwarf_data
*) state
->fileline_data
;
4111 ddata
= ddata
->next
)
4113 ret
= dwarf_lookup_pc (state
, ddata
, pc
, callback
, error_callback
,
4115 if (ret
!= 0 || found
)
4121 struct dwarf_data
**pp
;
4123 pp
= (struct dwarf_data
**) (void *) &state
->fileline_data
;
4126 ddata
= backtrace_atomic_load_pointer (pp
);
4130 ret
= dwarf_lookup_pc (state
, ddata
, pc
, callback
, error_callback
,
4132 if (ret
!= 0 || found
)
4139 /* FIXME: See if any libraries have been dlopen'ed. */
4141 return callback (data
, pc
, NULL
, 0, NULL
);
4144 /* Initialize our data structures from the DWARF debug info for a
4145 file. Return NULL on failure. */
4147 static struct dwarf_data
*
4148 build_dwarf_data (struct backtrace_state
*state
,
4149 struct libbacktrace_base_address base_address
,
4150 const struct dwarf_sections
*dwarf_sections
,
4152 struct dwarf_data
*altlink
,
4153 backtrace_error_callback error_callback
,
4156 struct unit_addrs_vector addrs_vec
;
4157 struct unit_vector units_vec
;
4158 struct dwarf_data
*fdata
;
4160 if (!build_address_map (state
, base_address
, dwarf_sections
, is_bigendian
,
4161 altlink
, error_callback
, data
, &addrs_vec
,
4165 if (!backtrace_vector_release (state
, &addrs_vec
.vec
, error_callback
, data
))
4167 if (!backtrace_vector_release (state
, &units_vec
.vec
, error_callback
, data
))
4170 backtrace_qsort ((struct unit_addrs
*) addrs_vec
.vec
.base
, addrs_vec
.count
,
4171 sizeof (struct unit_addrs
), unit_addrs_compare
);
4172 if (!resolve_unit_addrs_overlap (state
, error_callback
, data
, &addrs_vec
))
4175 /* No qsort for units required, already sorted. */
4177 fdata
= ((struct dwarf_data
*)
4178 backtrace_alloc (state
, sizeof (struct dwarf_data
),
4179 error_callback
, data
));
4184 fdata
->altlink
= altlink
;
4185 fdata
->base_address
= base_address
;
4186 fdata
->addrs
= (struct unit_addrs
*) addrs_vec
.vec
.base
;
4187 fdata
->addrs_count
= addrs_vec
.count
;
4188 fdata
->units
= (struct unit
**) units_vec
.vec
.base
;
4189 fdata
->units_count
= units_vec
.count
;
4190 fdata
->dwarf_sections
= *dwarf_sections
;
4191 fdata
->is_bigendian
= is_bigendian
;
4192 memset (&fdata
->fvec
, 0, sizeof fdata
->fvec
);
4197 /* Build our data structures from the DWARF sections for a module.
4198 Set FILELINE_FN and STATE->FILELINE_DATA. Return 1 on success, 0
4202 backtrace_dwarf_add (struct backtrace_state
*state
,
4203 struct libbacktrace_base_address base_address
,
4204 const struct dwarf_sections
*dwarf_sections
,
4206 struct dwarf_data
*fileline_altlink
,
4207 backtrace_error_callback error_callback
,
4208 void *data
, fileline
*fileline_fn
,
4209 struct dwarf_data
**fileline_entry
)
4211 struct dwarf_data
*fdata
;
4213 fdata
= build_dwarf_data (state
, base_address
, dwarf_sections
, is_bigendian
,
4214 fileline_altlink
, error_callback
, data
);
4218 if (fileline_entry
!= NULL
)
4219 *fileline_entry
= fdata
;
4221 if (!state
->threaded
)
4223 struct dwarf_data
**pp
;
4225 for (pp
= (struct dwarf_data
**) (void *) &state
->fileline_data
;
4235 struct dwarf_data
**pp
;
4237 pp
= (struct dwarf_data
**) (void *) &state
->fileline_data
;
4241 struct dwarf_data
*p
;
4243 p
= backtrace_atomic_load_pointer (pp
);
4251 if (__sync_bool_compare_and_swap (pp
, NULL
, fdata
))
4256 *fileline_fn
= dwarf_fileline
;