Fix compilation of server.cc on hpux.
[official-gcc.git] / libbacktrace / dwarf.c
blob45cc9e77e402928e89a94a53020aec136f531dec
1 /* dwarf.c -- Get file/line information from DWARF for backtraces.
2 Copyright (C) 2012-2022 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
7 met:
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
15 distribution.
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. */
33 #include "config.h"
35 #include <errno.h>
36 #include <stdlib.h>
37 #include <string.h>
38 #include <sys/types.h>
40 #include "dwarf2.h"
41 #include "filenames.h"
43 #include "backtrace.h"
44 #include "internal.h"
46 #if !defined(HAVE_DECL_STRNLEN) || !HAVE_DECL_STRNLEN
48 /* If strnlen is not declared, provide our own version. */
50 static size_t
51 xstrnlen (const char *s, size_t maxlen)
53 size_t i;
55 for (i = 0; i < maxlen; ++i)
56 if (s[i] == '\0')
57 break;
58 return i;
61 #define strnlen xstrnlen
63 #endif
65 /* A buffer to read DWARF info. */
67 struct dwarf_buf
69 /* Buffer name for error messages. */
70 const char *name;
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. */
76 size_t left;
77 /* Whether the data is big-endian. */
78 int is_bigendian;
79 /* Error callback routine. */
80 backtrace_error_callback error_callback;
81 /* Data for error_callback. */
82 void *data;
83 /* Non-zero if we've reported an underflow error. */
84 int reported_underflow;
87 /* A single attribute in a DWARF abbreviation. */
89 struct attr
91 /* The attribute name. */
92 enum dwarf_attribute name;
93 /* The attribute form. */
94 enum dwarf_form form;
95 /* The attribute value, for DW_FORM_implicit_const. */
96 int64_t val;
99 /* A single DWARF abbreviation. */
101 struct abbrev
103 /* The abbrev code--the number used to refer to the abbrev. */
104 uint64_t code;
105 /* The entry tag. */
106 enum dwarf_tag tag;
107 /* Non-zero if this abbrev has child entries. */
108 int has_children;
109 /* The number of attributes. */
110 size_t num_attrs;
111 /* The attributes. */
112 struct attr *attrs;
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. */
122 struct abbrevs
124 /* The number of abbrevs in the vector. */
125 size_t num_abbrevs;
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. */
135 ATTR_VAL_NONE,
136 /* An address. */
137 ATTR_VAL_ADDRESS,
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. */
142 ATTR_VAL_UINT,
143 /* A sigd integer. */
144 ATTR_VAL_SINT,
145 /* A string. */
146 ATTR_VAL_STRING,
147 /* An index into the .debug_str_offsets section. */
148 ATTR_VAL_STRING_INDEX,
149 /* An offset to other data in the containing unit. */
150 ATTR_VAL_REF_UNIT,
151 /* An offset to other data within the .debug_info section. */
152 ATTR_VAL_REF_INFO,
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. */
158 ATTR_VAL_REF_TYPE,
159 /* An index into the .debug_rnglists section. */
160 ATTR_VAL_RNGLISTS_INDEX,
161 /* A block of data (not represented). */
162 ATTR_VAL_BLOCK,
163 /* An expression (not represented). */
164 ATTR_VAL_EXPR,
167 /* An attribute value. */
169 struct attr_val
171 /* How the value is stored in the field u. */
172 enum attr_val_encoding encoding;
173 union
175 /* ATTR_VAL_ADDRESS*, ATTR_VAL_UINT, ATTR_VAL_REF*. */
176 uint64_t uint;
177 /* ATTR_VAL_SINT. */
178 int64_t sint;
179 /* ATTR_VAL_STRING. */
180 const char *string;
181 /* ATTR_VAL_BLOCK not stored. */
182 } u;
185 /* The line number program header. */
187 struct line_header
189 /* The version of the line number information. */
190 int version;
191 /* Address size. */
192 int addrsize;
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. */
198 int line_base;
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. */
206 size_t dirs_count;
207 /* The directory entries. */
208 const char **dirs;
209 /* The number of filenames. */
210 size_t filenames_count;
211 /* The filenames. */
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. */
228 struct line
230 /* PC. */
231 uintptr_t pc;
232 /* File name. Many entries in the array are expected to point to
233 the same file name. */
234 const char *filename;
235 /* Line number. */
236 int lineno;
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. */
240 int idx;
243 /* A growable vector of line number information. This is used while
244 reading the line numbers. */
246 struct line_vector
248 /* Memory. This is an array of struct line. */
249 struct backtrace_vector vec;
250 /* Number of valid mappings. */
251 size_t count;
254 /* A function described in the debug info. */
256 struct function
258 /* The name of the function. */
259 const char *name;
260 /* If this is an inlined function, the filename of the call
261 site. */
262 const char *caller_filename;
263 /* If this is an inlined function, the line number of the call
264 site. */
265 int caller_lineno;
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. */
277 uint64_t low;
278 uint64_t 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. */
290 size_t count;
293 /* A DWARF compilation unit. This only holds the information we need
294 to map a PC to a file and line. */
296 struct unit
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. */
307 size_t low_offset;
308 /* Offset of the end of the compilation unit from the start of the
309 .debug_info section. */
310 size_t high_offset;
311 /* DWARF version. */
312 int version;
313 /* Whether unit is DWARF64. */
314 int is_dwarf64;
315 /* Address size. */
316 int addrsize;
317 /* Offset into line number information. */
318 off_t lineoff;
319 /* Offset of compilation unit in .debug_str_offsets. */
320 uint64_t str_offsets_base;
321 /* Offset of compilation unit in .debug_addr. */
322 uint64_t addr_base;
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. */
342 struct line *lines;
343 /* Number of entries in lines. */
344 size_t lines_count;
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. */
356 struct unit_addrs
358 /* Range is LOW <= PC < HIGH. */
359 uint64_t low;
360 uint64_t high;
361 /* Compilation unit for this address range. */
362 struct unit *u;
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. */
372 size_t count;
375 /* A growable vector of compilation unit pointer. */
377 struct unit_vector
379 struct backtrace_vector vec;
380 size_t count;
383 /* The information we need to map a PC to a file and line. */
385 struct dwarf_data
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 for this file. */
392 uintptr_t base_address;
393 /* A sorted list of address ranges. */
394 struct unit_addrs *addrs;
395 /* Number of address ranges in list. */
396 size_t addrs_count;
397 /* A sorted list of units. */
398 struct unit **units;
399 /* Number of units in the list. */
400 size_t units_count;
401 /* The unparsed DWARF debug data. */
402 struct dwarf_sections dwarf_sections;
403 /* Whether the data is big-endian or not. */
404 int is_bigendian;
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. */
412 static void
413 dwarf_buf_error (struct dwarf_buf *buf, const char *msg, int errnum)
415 char b[200];
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
423 error. */
425 static int
426 require (struct dwarf_buf *buf, size_t count)
428 if (buf->left >= count)
429 return 1;
431 if (!buf->reported_underflow)
433 dwarf_buf_error (buf, "DWARF underflow", 0);
434 buf->reported_underflow = 1;
437 return 0;
440 /* Advance COUNT bytes in BUF. Return 1 if all is well, 0 on
441 error. */
443 static int
444 advance (struct dwarf_buf *buf, size_t count)
446 if (!require (buf, count))
447 return 0;
448 buf->buf += count;
449 buf->left -= count;
450 return 1;
453 /* Read one zero-terminated string from BUF and advance past the string. */
455 static const char *
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))
467 return NULL;
469 return p;
472 /* Read one byte from BUF and advance 1 byte. */
474 static unsigned char
475 read_byte (struct dwarf_buf *buf)
477 const unsigned char *p = buf->buf;
479 if (!advance (buf, 1))
480 return 0;
481 return p[0];
484 /* Read a signed char from BUF and advance 1 byte. */
486 static signed char
487 read_sbyte (struct dwarf_buf *buf)
489 const unsigned char *p = buf->buf;
491 if (!advance (buf, 1))
492 return 0;
493 return (*p ^ 0x80) - 0x80;
496 /* Read a uint16 from BUF and advance 2 bytes. */
498 static uint16_t
499 read_uint16 (struct dwarf_buf *buf)
501 const unsigned char *p = buf->buf;
503 if (!advance (buf, 2))
504 return 0;
505 if (buf->is_bigendian)
506 return ((uint16_t) p[0] << 8) | (uint16_t) p[1];
507 else
508 return ((uint16_t) p[1] << 8) | (uint16_t) p[0];
511 /* Read a 24 bit value from BUF and advance 3 bytes. */
513 static uint32_t
514 read_uint24 (struct dwarf_buf *buf)
516 const unsigned char *p = buf->buf;
518 if (!advance (buf, 3))
519 return 0;
520 if (buf->is_bigendian)
521 return (((uint32_t) p[0] << 16) | ((uint32_t) p[1] << 8)
522 | (uint32_t) p[2]);
523 else
524 return (((uint32_t) p[2] << 16) | ((uint32_t) p[1] << 8)
525 | (uint32_t) p[0]);
528 /* Read a uint32 from BUF and advance 4 bytes. */
530 static uint32_t
531 read_uint32 (struct dwarf_buf *buf)
533 const unsigned char *p = buf->buf;
535 if (!advance (buf, 4))
536 return 0;
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]);
540 else
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. */
547 static uint64_t
548 read_uint64 (struct dwarf_buf *buf)
550 const unsigned char *p = buf->buf;
552 if (!advance (buf, 8))
553 return 0;
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]);
559 else
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
567 bytes. */
569 static uint64_t
570 read_offset (struct dwarf_buf *buf, int is_dwarf64)
572 if (is_dwarf64)
573 return read_uint64 (buf);
574 else
575 return read_uint32 (buf);
578 /* Read an address from BUF and advance the appropriate number of
579 bytes. */
581 static uint64_t
582 read_address (struct dwarf_buf *buf, int addrsize)
584 switch (addrsize)
586 case 1:
587 return read_byte (buf);
588 case 2:
589 return read_uint16 (buf);
590 case 4:
591 return read_uint32 (buf);
592 case 8:
593 return read_uint64 (buf);
594 default:
595 dwarf_buf_error (buf, "unrecognized address size", 0);
596 return 0;
600 /* Return whether a value is the highest possible address, given the
601 address size. */
603 static int
604 is_highest_address (uint64_t address, int addrsize)
606 switch (addrsize)
608 case 1:
609 return address == (unsigned char) -1;
610 case 2:
611 return address == (uint16_t) -1;
612 case 4:
613 return address == (uint32_t) -1;
614 case 8:
615 return address == (uint64_t) -1;
616 default:
617 return 0;
621 /* Read an unsigned LEB128 number. */
623 static uint64_t
624 read_uleb128 (struct dwarf_buf *buf)
626 uint64_t ret;
627 unsigned int shift;
628 int overflow;
629 unsigned char b;
631 ret = 0;
632 shift = 0;
633 overflow = 0;
636 const unsigned char *p;
638 p = buf->buf;
639 if (!advance (buf, 1))
640 return 0;
641 b = *p;
642 if (shift < 64)
643 ret |= ((uint64_t) (b & 0x7f)) << shift;
644 else if (!overflow)
646 dwarf_buf_error (buf, "LEB128 overflows uint64_t", 0);
647 overflow = 1;
649 shift += 7;
651 while ((b & 0x80) != 0);
653 return ret;
656 /* Read a signed LEB128 number. */
658 static int64_t
659 read_sleb128 (struct dwarf_buf *buf)
661 uint64_t val;
662 unsigned int shift;
663 int overflow;
664 unsigned char b;
666 val = 0;
667 shift = 0;
668 overflow = 0;
671 const unsigned char *p;
673 p = buf->buf;
674 if (!advance (buf, 1))
675 return 0;
676 b = *p;
677 if (shift < 64)
678 val |= ((uint64_t) (b & 0x7f)) << shift;
679 else if (!overflow)
681 dwarf_buf_error (buf, "signed LEB128 overflows uint64_t", 0);
682 overflow = 1;
684 shift += 7;
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. */
696 static size_t
697 leb128_len (const unsigned char *p)
699 size_t ret;
701 ret = 1;
702 while ((*p & 0x80) != 0)
704 ++p;
705 ++ret;
707 return ret;
710 /* Read initial_length from BUF and advance the appropriate number of bytes. */
712 static uint64_t
713 read_initial_length (struct dwarf_buf *buf, int *is_dwarf64)
715 uint64_t len;
717 len = read_uint32 (buf);
718 if (len == 0xffffffff)
720 len = read_uint64 (buf);
721 *is_dwarf64 = 1;
723 else
724 *is_dwarf64 = 0;
726 return len;
729 /* Free an abbreviations structure. */
731 static void
732 free_abbrevs (struct backtrace_state *state, struct abbrevs *abbrevs,
733 backtrace_error_callback error_callback, void *data)
735 size_t i;
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. */
753 static int
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
762 conditionally. */
763 memset (val, 0, sizeof *val);
765 switch (form)
767 case DW_FORM_addr:
768 val->encoding = ATTR_VAL_ADDRESS;
769 val->u.uint = read_address (buf, addrsize);
770 return 1;
771 case DW_FORM_block2:
772 val->encoding = ATTR_VAL_BLOCK;
773 return advance (buf, read_uint16 (buf));
774 case DW_FORM_block4:
775 val->encoding = ATTR_VAL_BLOCK;
776 return advance (buf, read_uint32 (buf));
777 case DW_FORM_data2:
778 val->encoding = ATTR_VAL_UINT;
779 val->u.uint = read_uint16 (buf);
780 return 1;
781 case DW_FORM_data4:
782 val->encoding = ATTR_VAL_UINT;
783 val->u.uint = read_uint32 (buf);
784 return 1;
785 case DW_FORM_data8:
786 val->encoding = ATTR_VAL_UINT;
787 val->u.uint = read_uint64 (buf);
788 return 1;
789 case DW_FORM_data16:
790 val->encoding = ATTR_VAL_BLOCK;
791 return advance (buf, 16);
792 case DW_FORM_string:
793 val->encoding = ATTR_VAL_STRING;
794 val->u.string = read_string (buf);
795 return val->u.string == NULL ? 0 : 1;
796 case DW_FORM_block:
797 val->encoding = ATTR_VAL_BLOCK;
798 return advance (buf, read_uleb128 (buf));
799 case DW_FORM_block1:
800 val->encoding = ATTR_VAL_BLOCK;
801 return advance (buf, read_byte (buf));
802 case DW_FORM_data1:
803 val->encoding = ATTR_VAL_UINT;
804 val->u.uint = read_byte (buf);
805 return 1;
806 case DW_FORM_flag:
807 val->encoding = ATTR_VAL_UINT;
808 val->u.uint = read_byte (buf);
809 return 1;
810 case DW_FORM_sdata:
811 val->encoding = ATTR_VAL_SINT;
812 val->u.sint = read_sleb128 (buf);
813 return 1;
814 case DW_FORM_strp:
816 uint64_t offset;
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);
822 return 0;
824 val->encoding = ATTR_VAL_STRING;
825 val->u.string =
826 (const char *) dwarf_sections->data[DEBUG_STR] + offset;
827 return 1;
829 case DW_FORM_line_strp:
831 uint64_t offset;
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);
837 return 0;
839 val->encoding = ATTR_VAL_STRING;
840 val->u.string =
841 (const char *) dwarf_sections->data[DEBUG_LINE_STR] + offset;
842 return 1;
844 case DW_FORM_udata:
845 val->encoding = ATTR_VAL_UINT;
846 val->u.uint = read_uleb128 (buf);
847 return 1;
848 case DW_FORM_ref_addr:
849 val->encoding = ATTR_VAL_REF_INFO;
850 if (version == 2)
851 val->u.uint = read_address (buf, addrsize);
852 else
853 val->u.uint = read_offset (buf, is_dwarf64);
854 return 1;
855 case DW_FORM_ref1:
856 val->encoding = ATTR_VAL_REF_UNIT;
857 val->u.uint = read_byte (buf);
858 return 1;
859 case DW_FORM_ref2:
860 val->encoding = ATTR_VAL_REF_UNIT;
861 val->u.uint = read_uint16 (buf);
862 return 1;
863 case DW_FORM_ref4:
864 val->encoding = ATTR_VAL_REF_UNIT;
865 val->u.uint = read_uint32 (buf);
866 return 1;
867 case DW_FORM_ref8:
868 val->encoding = ATTR_VAL_REF_UNIT;
869 val->u.uint = read_uint64 (buf);
870 return 1;
871 case DW_FORM_ref_udata:
872 val->encoding = ATTR_VAL_REF_UNIT;
873 val->u.uint = read_uleb128 (buf);
874 return 1;
875 case DW_FORM_indirect:
877 uint64_t form;
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",
885 return 0;
887 return read_attribute ((enum dwarf_form) form, 0, buf, is_dwarf64,
888 version, addrsize, dwarf_sections, altlink,
889 val);
891 case DW_FORM_sec_offset:
892 val->encoding = ATTR_VAL_REF_SECTION;
893 val->u.uint = read_offset (buf, is_dwarf64);
894 return 1;
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;
900 val->u.uint = 1;
901 return 1;
902 case DW_FORM_ref_sig8:
903 val->encoding = ATTR_VAL_REF_TYPE;
904 val->u.uint = read_uint64 (buf);
905 return 1;
906 case DW_FORM_strx: case DW_FORM_strx1: case DW_FORM_strx2:
907 case DW_FORM_strx3: case DW_FORM_strx4:
909 uint64_t offset;
911 switch (form)
913 case DW_FORM_strx:
914 offset = read_uleb128 (buf);
915 break;
916 case DW_FORM_strx1:
917 offset = read_byte (buf);
918 break;
919 case DW_FORM_strx2:
920 offset = read_uint16 (buf);
921 break;
922 case DW_FORM_strx3:
923 offset = read_uint24 (buf);
924 break;
925 case DW_FORM_strx4:
926 offset = read_uint32 (buf);
927 break;
928 default:
929 /* This case can't happen. */
930 return 0;
932 val->encoding = ATTR_VAL_STRING_INDEX;
933 val->u.uint = offset;
934 return 1;
936 case DW_FORM_addrx: case DW_FORM_addrx1: case DW_FORM_addrx2:
937 case DW_FORM_addrx3: case DW_FORM_addrx4:
939 uint64_t offset;
941 switch (form)
943 case DW_FORM_addrx:
944 offset = read_uleb128 (buf);
945 break;
946 case DW_FORM_addrx1:
947 offset = read_byte (buf);
948 break;
949 case DW_FORM_addrx2:
950 offset = read_uint16 (buf);
951 break;
952 case DW_FORM_addrx3:
953 offset = read_uint24 (buf);
954 break;
955 case DW_FORM_addrx4:
956 offset = read_uint32 (buf);
957 break;
958 default:
959 /* This case can't happen. */
960 return 0;
962 val->encoding = ATTR_VAL_ADDRESS_INDEX;
963 val->u.uint = offset;
964 return 1;
966 case DW_FORM_ref_sup4:
967 val->encoding = ATTR_VAL_REF_SECTION;
968 val->u.uint = read_uint32 (buf);
969 return 1;
970 case DW_FORM_ref_sup8:
971 val->encoding = ATTR_VAL_REF_SECTION;
972 val->u.uint = read_uint64 (buf);
973 return 1;
974 case DW_FORM_implicit_const:
975 val->encoding = ATTR_VAL_UINT;
976 val->u.uint = implicit_val;
977 return 1;
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);
983 return 1;
984 case DW_FORM_rnglistx:
985 val->encoding = ATTR_VAL_RNGLISTS_INDEX;
986 val->u.uint = read_uleb128 (buf);
987 return 1;
988 case DW_FORM_GNU_addr_index:
989 val->encoding = ATTR_VAL_REF_SECTION;
990 val->u.uint = read_uleb128 (buf);
991 return 1;
992 case DW_FORM_GNU_str_index:
993 val->encoding = ATTR_VAL_REF_SECTION;
994 val->u.uint = read_uleb128 (buf);
995 return 1;
996 case DW_FORM_GNU_ref_alt:
997 val->u.uint = read_offset (buf, is_dwarf64);
998 if (altlink == NULL)
1000 val->encoding = ATTR_VAL_NONE;
1001 return 1;
1003 val->encoding = ATTR_VAL_REF_ALT_INFO;
1004 return 1;
1005 case DW_FORM_strp_sup: case DW_FORM_GNU_strp_alt:
1007 uint64_t offset;
1009 offset = read_offset (buf, is_dwarf64);
1010 if (altlink == NULL)
1012 val->encoding = ATTR_VAL_NONE;
1013 return 1;
1015 if (offset >= altlink->dwarf_sections.size[DEBUG_STR])
1017 dwarf_buf_error (buf, "DW_FORM_strp_sup out of range", 0);
1018 return 0;
1020 val->encoding = ATTR_VAL_STRING;
1021 val->u.string =
1022 (const char *) altlink->dwarf_sections.data[DEBUG_STR] + offset;
1023 return 1;
1025 default:
1026 dwarf_buf_error (buf, "unrecognized DWARF form", -1);
1027 return 0;
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
1035 offset. */
1037 static int
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;
1048 return 1;
1050 case ATTR_VAL_STRING_INDEX:
1052 uint64_t offset;
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);
1060 return 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",
1078 return 0;
1080 *string = (const char *) dwarf_sections->data[DEBUG_STR] + offset;
1081 return 1;
1084 default:
1085 return 1;
1089 /* Set *ADDRESS to the real address for a ATTR_VAL_ADDRESS_INDEX.
1090 Return 1 on success, 0 on error. */
1092 static int
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,
1097 uint64_t *address)
1099 uint64_t offset;
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);
1106 return 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 = read_address (&addr_buf, addrsize);
1119 return 1;
1122 /* Compare a unit offset against a unit for bsearch. */
1124 static int
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);
1129 size_t offset;
1131 offset = *key;
1132 if (offset < entry->low_offset)
1133 return -1;
1134 else if (offset >= entry->high_offset)
1135 return 1;
1136 else
1137 return 0;
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)
1145 struct unit **u;
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. */
1153 static int
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)
1160 return -1;
1161 if (a1->low > a2->low)
1162 return 1;
1163 if (a1->high < a2->high)
1164 return 1;
1165 if (a1->high > a2->high)
1166 return -1;
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. */
1176 static int
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;
1181 uintptr_t pc;
1183 pc = *key;
1184 if (pc < entry->low)
1185 return -1;
1186 else if (pc > (entry + 1)->low)
1187 return 1;
1188 else
1189 return 0;
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. */
1195 static int
1196 add_unit_addr (struct backtrace_state *state, void *rdata,
1197 uint64_t lowpc, uint64_t highpc,
1198 backtrace_error_callback error_callback, void *data,
1199 void *pvec)
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. */
1206 if (vec->count > 0)
1208 p = (struct unit_addrs *) vec->vec.base + (vec->count - 1);
1209 if ((lowpc == p->high || lowpc == p->high + 1)
1210 && u == p->u)
1212 if (highpc > p->high)
1213 p->high = highpc;
1214 return 1;
1218 p = ((struct unit_addrs *)
1219 backtrace_vector_grow (state, sizeof (struct unit_addrs),
1220 error_callback, data, &vec->vec));
1221 if (p == NULL)
1222 return 0;
1224 p->low = lowpc;
1225 p->high = highpc;
1226 p->u = u;
1228 ++vec->count;
1230 return 1;
1233 /* Compare unit_addrs for qsort. When ranges are nested, make the
1234 smallest one sort last. */
1236 static int
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)
1243 return -1;
1244 if (a1->low > a2->low)
1245 return 1;
1246 if (a1->high < a2->high)
1247 return 1;
1248 if (a1->high > a2->high)
1249 return -1;
1250 if (a1->u->lineoff < a2->u->lineoff)
1251 return -1;
1252 if (a1->u->lineoff > a2->u->lineoff)
1253 return 1;
1254 return 0;
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. */
1263 static int
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;
1268 uintptr_t pc;
1270 pc = *key;
1271 if (pc < entry->low)
1272 return -1;
1273 else if (pc > (entry + 1)->low)
1274 return 1;
1275 else
1276 return 0;
1279 /* Sort the line vector by PC. We want a stable sort here to maintain
1280 the order of lines for the same PC values. Since the sequence is
1281 being sorted in place, their addresses cannot be relied on to
1282 maintain stability. That is the purpose of the index member. */
1284 static int
1285 line_compare (const void *v1, const void *v2)
1287 const struct line *ln1 = (const struct line *) v1;
1288 const struct line *ln2 = (const struct line *) v2;
1290 if (ln1->pc < ln2->pc)
1291 return -1;
1292 else if (ln1->pc > ln2->pc)
1293 return 1;
1294 else if (ln1->idx < ln2->idx)
1295 return -1;
1296 else if (ln1->idx > ln2->idx)
1297 return 1;
1298 else
1299 return 0;
1302 /* Find a PC in a line vector. We always allocate an extra entry at
1303 the end of the lines vector, so that this routine can safely look
1304 at the next entry. Note that when there are multiple mappings for
1305 the same PC value, this will return the last one. */
1307 static int
1308 line_search (const void *vkey, const void *ventry)
1310 const uintptr_t *key = (const uintptr_t *) vkey;
1311 const struct line *entry = (const struct line *) ventry;
1312 uintptr_t pc;
1314 pc = *key;
1315 if (pc < entry->pc)
1316 return -1;
1317 else if (pc >= (entry + 1)->pc)
1318 return 1;
1319 else
1320 return 0;
1323 /* Sort the abbrevs by the abbrev code. This function is passed to
1324 both qsort and bsearch. */
1326 static int
1327 abbrev_compare (const void *v1, const void *v2)
1329 const struct abbrev *a1 = (const struct abbrev *) v1;
1330 const struct abbrev *a2 = (const struct abbrev *) v2;
1332 if (a1->code < a2->code)
1333 return -1;
1334 else if (a1->code > a2->code)
1335 return 1;
1336 else
1338 /* This really shouldn't happen. It means there are two
1339 different abbrevs with the same code, and that means we don't
1340 know which one lookup_abbrev should return. */
1341 return 0;
1345 /* Read the abbreviation table for a compilation unit. Returns 1 on
1346 success, 0 on failure. */
1348 static int
1349 read_abbrevs (struct backtrace_state *state, uint64_t abbrev_offset,
1350 const unsigned char *dwarf_abbrev, size_t dwarf_abbrev_size,
1351 int is_bigendian, backtrace_error_callback error_callback,
1352 void *data, struct abbrevs *abbrevs)
1354 struct dwarf_buf abbrev_buf;
1355 struct dwarf_buf count_buf;
1356 size_t num_abbrevs;
1358 abbrevs->num_abbrevs = 0;
1359 abbrevs->abbrevs = NULL;
1361 if (abbrev_offset >= dwarf_abbrev_size)
1363 error_callback (data, "abbrev offset out of range", 0);
1364 return 0;
1367 abbrev_buf.name = ".debug_abbrev";
1368 abbrev_buf.start = dwarf_abbrev;
1369 abbrev_buf.buf = dwarf_abbrev + abbrev_offset;
1370 abbrev_buf.left = dwarf_abbrev_size - abbrev_offset;
1371 abbrev_buf.is_bigendian = is_bigendian;
1372 abbrev_buf.error_callback = error_callback;
1373 abbrev_buf.data = data;
1374 abbrev_buf.reported_underflow = 0;
1376 /* Count the number of abbrevs in this list. */
1378 count_buf = abbrev_buf;
1379 num_abbrevs = 0;
1380 while (read_uleb128 (&count_buf) != 0)
1382 if (count_buf.reported_underflow)
1383 return 0;
1384 ++num_abbrevs;
1385 // Skip tag.
1386 read_uleb128 (&count_buf);
1387 // Skip has_children.
1388 read_byte (&count_buf);
1389 // Skip attributes.
1390 while (read_uleb128 (&count_buf) != 0)
1392 uint64_t form;
1394 form = read_uleb128 (&count_buf);
1395 if ((enum dwarf_form) form == DW_FORM_implicit_const)
1396 read_sleb128 (&count_buf);
1398 // Skip form of last attribute.
1399 read_uleb128 (&count_buf);
1402 if (count_buf.reported_underflow)
1403 return 0;
1405 if (num_abbrevs == 0)
1406 return 1;
1408 abbrevs->abbrevs = ((struct abbrev *)
1409 backtrace_alloc (state,
1410 num_abbrevs * sizeof (struct abbrev),
1411 error_callback, data));
1412 if (abbrevs->abbrevs == NULL)
1413 return 0;
1414 abbrevs->num_abbrevs = num_abbrevs;
1415 memset (abbrevs->abbrevs, 0, num_abbrevs * sizeof (struct abbrev));
1417 num_abbrevs = 0;
1418 while (1)
1420 uint64_t code;
1421 struct abbrev a;
1422 size_t num_attrs;
1423 struct attr *attrs;
1425 if (abbrev_buf.reported_underflow)
1426 goto fail;
1428 code = read_uleb128 (&abbrev_buf);
1429 if (code == 0)
1430 break;
1432 a.code = code;
1433 a.tag = (enum dwarf_tag) read_uleb128 (&abbrev_buf);
1434 a.has_children = read_byte (&abbrev_buf);
1436 count_buf = abbrev_buf;
1437 num_attrs = 0;
1438 while (read_uleb128 (&count_buf) != 0)
1440 uint64_t form;
1442 ++num_attrs;
1443 form = read_uleb128 (&count_buf);
1444 if ((enum dwarf_form) form == DW_FORM_implicit_const)
1445 read_sleb128 (&count_buf);
1448 if (num_attrs == 0)
1450 attrs = NULL;
1451 read_uleb128 (&abbrev_buf);
1452 read_uleb128 (&abbrev_buf);
1454 else
1456 attrs = ((struct attr *)
1457 backtrace_alloc (state, num_attrs * sizeof *attrs,
1458 error_callback, data));
1459 if (attrs == NULL)
1460 goto fail;
1461 num_attrs = 0;
1462 while (1)
1464 uint64_t name;
1465 uint64_t form;
1467 name = read_uleb128 (&abbrev_buf);
1468 form = read_uleb128 (&abbrev_buf);
1469 if (name == 0)
1470 break;
1471 attrs[num_attrs].name = (enum dwarf_attribute) name;
1472 attrs[num_attrs].form = (enum dwarf_form) form;
1473 if ((enum dwarf_form) form == DW_FORM_implicit_const)
1474 attrs[num_attrs].val = read_sleb128 (&abbrev_buf);
1475 else
1476 attrs[num_attrs].val = 0;
1477 ++num_attrs;
1481 a.num_attrs = num_attrs;
1482 a.attrs = attrs;
1484 abbrevs->abbrevs[num_abbrevs] = a;
1485 ++num_abbrevs;
1488 backtrace_qsort (abbrevs->abbrevs, abbrevs->num_abbrevs,
1489 sizeof (struct abbrev), abbrev_compare);
1491 return 1;
1493 fail:
1494 free_abbrevs (state, abbrevs, error_callback, data);
1495 return 0;
1498 /* Return the abbrev information for an abbrev code. */
1500 static const struct abbrev *
1501 lookup_abbrev (struct abbrevs *abbrevs, uint64_t code,
1502 backtrace_error_callback error_callback, void *data)
1504 struct abbrev key;
1505 void *p;
1507 /* With GCC, where abbrevs are simply numbered in order, we should
1508 be able to just look up the entry. */
1509 if (code - 1 < abbrevs->num_abbrevs
1510 && abbrevs->abbrevs[code - 1].code == code)
1511 return &abbrevs->abbrevs[code - 1];
1513 /* Otherwise we have to search. */
1514 memset (&key, 0, sizeof key);
1515 key.code = code;
1516 p = bsearch (&key, abbrevs->abbrevs, abbrevs->num_abbrevs,
1517 sizeof (struct abbrev), abbrev_compare);
1518 if (p == NULL)
1520 error_callback (data, "invalid abbreviation code", 0);
1521 return NULL;
1523 return (const struct abbrev *) p;
1526 /* This struct is used to gather address range information while
1527 reading attributes. We use this while building a mapping from
1528 address ranges to compilation units and then again while mapping
1529 from address ranges to function entries. Normally either
1530 lowpc/highpc is set or ranges is set. */
1532 struct pcrange {
1533 uint64_t lowpc; /* The low PC value. */
1534 int have_lowpc; /* Whether a low PC value was found. */
1535 int lowpc_is_addr_index; /* Whether lowpc is in .debug_addr. */
1536 uint64_t highpc; /* The high PC value. */
1537 int have_highpc; /* Whether a high PC value was found. */
1538 int highpc_is_relative; /* Whether highpc is relative to lowpc. */
1539 int highpc_is_addr_index; /* Whether highpc is in .debug_addr. */
1540 uint64_t ranges; /* Offset in ranges section. */
1541 int have_ranges; /* Whether ranges is valid. */
1542 int ranges_is_index; /* Whether ranges is DW_FORM_rnglistx. */
1545 /* Update PCRANGE from an attribute value. */
1547 static void
1548 update_pcrange (const struct attr* attr, const struct attr_val* val,
1549 struct pcrange *pcrange)
1551 switch (attr->name)
1553 case DW_AT_low_pc:
1554 if (val->encoding == ATTR_VAL_ADDRESS)
1556 pcrange->lowpc = val->u.uint;
1557 pcrange->have_lowpc = 1;
1559 else if (val->encoding == ATTR_VAL_ADDRESS_INDEX)
1561 pcrange->lowpc = val->u.uint;
1562 pcrange->have_lowpc = 1;
1563 pcrange->lowpc_is_addr_index = 1;
1565 break;
1567 case DW_AT_high_pc:
1568 if (val->encoding == ATTR_VAL_ADDRESS)
1570 pcrange->highpc = val->u.uint;
1571 pcrange->have_highpc = 1;
1573 else if (val->encoding == ATTR_VAL_UINT)
1575 pcrange->highpc = val->u.uint;
1576 pcrange->have_highpc = 1;
1577 pcrange->highpc_is_relative = 1;
1579 else if (val->encoding == ATTR_VAL_ADDRESS_INDEX)
1581 pcrange->highpc = val->u.uint;
1582 pcrange->have_highpc = 1;
1583 pcrange->highpc_is_addr_index = 1;
1585 break;
1587 case DW_AT_ranges:
1588 if (val->encoding == ATTR_VAL_UINT
1589 || val->encoding == ATTR_VAL_REF_SECTION)
1591 pcrange->ranges = val->u.uint;
1592 pcrange->have_ranges = 1;
1594 else if (val->encoding == ATTR_VAL_RNGLISTS_INDEX)
1596 pcrange->ranges = val->u.uint;
1597 pcrange->have_ranges = 1;
1598 pcrange->ranges_is_index = 1;
1600 break;
1602 default:
1603 break;
1607 /* Call ADD_RANGE for a low/high PC pair. Returns 1 on success, 0 on
1608 error. */
1610 static int
1611 add_low_high_range (struct backtrace_state *state,
1612 const struct dwarf_sections *dwarf_sections,
1613 uintptr_t base_address, int is_bigendian,
1614 struct unit *u, const struct pcrange *pcrange,
1615 int (*add_range) (struct backtrace_state *state,
1616 void *rdata, uint64_t lowpc,
1617 uint64_t highpc,
1618 backtrace_error_callback error_callback,
1619 void *data, void *vec),
1620 void *rdata,
1621 backtrace_error_callback error_callback, void *data,
1622 void *vec)
1624 uint64_t lowpc;
1625 uint64_t highpc;
1627 lowpc = pcrange->lowpc;
1628 if (pcrange->lowpc_is_addr_index)
1630 if (!resolve_addr_index (dwarf_sections, u->addr_base, u->addrsize,
1631 is_bigendian, lowpc, error_callback, data,
1632 &lowpc))
1633 return 0;
1636 highpc = pcrange->highpc;
1637 if (pcrange->highpc_is_addr_index)
1639 if (!resolve_addr_index (dwarf_sections, u->addr_base, u->addrsize,
1640 is_bigendian, highpc, error_callback, data,
1641 &highpc))
1642 return 0;
1644 if (pcrange->highpc_is_relative)
1645 highpc += lowpc;
1647 /* Add in the base address of the module when recording PC values,
1648 so that we can look up the PC directly. */
1649 lowpc += base_address;
1650 highpc += base_address;
1652 return add_range (state, rdata, lowpc, highpc, error_callback, data, vec);
1655 /* Call ADD_RANGE for each range read from .debug_ranges, as used in
1656 DWARF versions 2 through 4. */
1658 static int
1659 add_ranges_from_ranges (
1660 struct backtrace_state *state,
1661 const struct dwarf_sections *dwarf_sections,
1662 uintptr_t base_address, int is_bigendian,
1663 struct unit *u, uint64_t base,
1664 const struct pcrange *pcrange,
1665 int (*add_range) (struct backtrace_state *state, void *rdata,
1666 uint64_t lowpc, uint64_t highpc,
1667 backtrace_error_callback error_callback, void *data,
1668 void *vec),
1669 void *rdata,
1670 backtrace_error_callback error_callback, void *data,
1671 void *vec)
1673 struct dwarf_buf ranges_buf;
1675 if (pcrange->ranges >= dwarf_sections->size[DEBUG_RANGES])
1677 error_callback (data, "ranges offset out of range", 0);
1678 return 0;
1681 ranges_buf.name = ".debug_ranges";
1682 ranges_buf.start = dwarf_sections->data[DEBUG_RANGES];
1683 ranges_buf.buf = dwarf_sections->data[DEBUG_RANGES] + pcrange->ranges;
1684 ranges_buf.left = dwarf_sections->size[DEBUG_RANGES] - pcrange->ranges;
1685 ranges_buf.is_bigendian = is_bigendian;
1686 ranges_buf.error_callback = error_callback;
1687 ranges_buf.data = data;
1688 ranges_buf.reported_underflow = 0;
1690 while (1)
1692 uint64_t low;
1693 uint64_t high;
1695 if (ranges_buf.reported_underflow)
1696 return 0;
1698 low = read_address (&ranges_buf, u->addrsize);
1699 high = read_address (&ranges_buf, u->addrsize);
1701 if (low == 0 && high == 0)
1702 break;
1704 if (is_highest_address (low, u->addrsize))
1705 base = high;
1706 else
1708 if (!add_range (state, rdata,
1709 low + base + base_address,
1710 high + base + base_address,
1711 error_callback, data, vec))
1712 return 0;
1716 if (ranges_buf.reported_underflow)
1717 return 0;
1719 return 1;
1722 /* Call ADD_RANGE for each range read from .debug_rnglists, as used in
1723 DWARF version 5. */
1725 static int
1726 add_ranges_from_rnglists (
1727 struct backtrace_state *state,
1728 const struct dwarf_sections *dwarf_sections,
1729 uintptr_t base_address, int is_bigendian,
1730 struct unit *u, uint64_t base,
1731 const struct pcrange *pcrange,
1732 int (*add_range) (struct backtrace_state *state, void *rdata,
1733 uint64_t lowpc, uint64_t highpc,
1734 backtrace_error_callback error_callback, void *data,
1735 void *vec),
1736 void *rdata,
1737 backtrace_error_callback error_callback, void *data,
1738 void *vec)
1740 uint64_t offset;
1741 struct dwarf_buf rnglists_buf;
1743 if (!pcrange->ranges_is_index)
1744 offset = pcrange->ranges;
1745 else
1746 offset = u->rnglists_base + pcrange->ranges * (u->is_dwarf64 ? 8 : 4);
1747 if (offset >= dwarf_sections->size[DEBUG_RNGLISTS])
1749 error_callback (data, "rnglists offset out of range", 0);
1750 return 0;
1753 rnglists_buf.name = ".debug_rnglists";
1754 rnglists_buf.start = dwarf_sections->data[DEBUG_RNGLISTS];
1755 rnglists_buf.buf = dwarf_sections->data[DEBUG_RNGLISTS] + offset;
1756 rnglists_buf.left = dwarf_sections->size[DEBUG_RNGLISTS] - offset;
1757 rnglists_buf.is_bigendian = is_bigendian;
1758 rnglists_buf.error_callback = error_callback;
1759 rnglists_buf.data = data;
1760 rnglists_buf.reported_underflow = 0;
1762 if (pcrange->ranges_is_index)
1764 offset = read_offset (&rnglists_buf, u->is_dwarf64);
1765 offset += u->rnglists_base;
1766 if (offset >= dwarf_sections->size[DEBUG_RNGLISTS])
1768 error_callback (data, "rnglists index offset out of range", 0);
1769 return 0;
1771 rnglists_buf.buf = dwarf_sections->data[DEBUG_RNGLISTS] + offset;
1772 rnglists_buf.left = dwarf_sections->size[DEBUG_RNGLISTS] - offset;
1775 while (1)
1777 unsigned char rle;
1779 rle = read_byte (&rnglists_buf);
1780 if (rle == DW_RLE_end_of_list)
1781 break;
1782 switch (rle)
1784 case DW_RLE_base_addressx:
1786 uint64_t index;
1788 index = read_uleb128 (&rnglists_buf);
1789 if (!resolve_addr_index (dwarf_sections, u->addr_base,
1790 u->addrsize, is_bigendian, index,
1791 error_callback, data, &base))
1792 return 0;
1794 break;
1796 case DW_RLE_startx_endx:
1798 uint64_t index;
1799 uint64_t low;
1800 uint64_t high;
1802 index = read_uleb128 (&rnglists_buf);
1803 if (!resolve_addr_index (dwarf_sections, u->addr_base,
1804 u->addrsize, is_bigendian, index,
1805 error_callback, data, &low))
1806 return 0;
1807 index = read_uleb128 (&rnglists_buf);
1808 if (!resolve_addr_index (dwarf_sections, u->addr_base,
1809 u->addrsize, is_bigendian, index,
1810 error_callback, data, &high))
1811 return 0;
1812 if (!add_range (state, rdata, low + base_address,
1813 high + base_address, error_callback, data,
1814 vec))
1815 return 0;
1817 break;
1819 case DW_RLE_startx_length:
1821 uint64_t index;
1822 uint64_t low;
1823 uint64_t length;
1825 index = read_uleb128 (&rnglists_buf);
1826 if (!resolve_addr_index (dwarf_sections, u->addr_base,
1827 u->addrsize, is_bigendian, index,
1828 error_callback, data, &low))
1829 return 0;
1830 length = read_uleb128 (&rnglists_buf);
1831 low += base_address;
1832 if (!add_range (state, rdata, low, low + length,
1833 error_callback, data, vec))
1834 return 0;
1836 break;
1838 case DW_RLE_offset_pair:
1840 uint64_t low;
1841 uint64_t high;
1843 low = read_uleb128 (&rnglists_buf);
1844 high = read_uleb128 (&rnglists_buf);
1845 if (!add_range (state, rdata, low + base + base_address,
1846 high + base + base_address,
1847 error_callback, data, vec))
1848 return 0;
1850 break;
1852 case DW_RLE_base_address:
1853 base = read_address (&rnglists_buf, u->addrsize);
1854 break;
1856 case DW_RLE_start_end:
1858 uint64_t low;
1859 uint64_t high;
1861 low = read_address (&rnglists_buf, u->addrsize);
1862 high = read_address (&rnglists_buf, u->addrsize);
1863 if (!add_range (state, rdata, low + base_address,
1864 high + base_address, error_callback, data,
1865 vec))
1866 return 0;
1868 break;
1870 case DW_RLE_start_length:
1872 uint64_t low;
1873 uint64_t length;
1875 low = read_address (&rnglists_buf, u->addrsize);
1876 length = read_uleb128 (&rnglists_buf);
1877 low += base_address;
1878 if (!add_range (state, rdata, low, low + length,
1879 error_callback, data, vec))
1880 return 0;
1882 break;
1884 default:
1885 dwarf_buf_error (&rnglists_buf, "unrecognized DW_RLE value", -1);
1886 return 0;
1890 if (rnglists_buf.reported_underflow)
1891 return 0;
1893 return 1;
1896 /* Call ADD_RANGE for each lowpc/highpc pair in PCRANGE. RDATA is
1897 passed to ADD_RANGE, and is either a struct unit * or a struct
1898 function *. VEC is the vector we are adding ranges to, and is
1899 either a struct unit_addrs_vector * or a struct function_vector *.
1900 Returns 1 on success, 0 on error. */
1902 static int
1903 add_ranges (struct backtrace_state *state,
1904 const struct dwarf_sections *dwarf_sections,
1905 uintptr_t base_address, int is_bigendian,
1906 struct unit *u, uint64_t base, const struct pcrange *pcrange,
1907 int (*add_range) (struct backtrace_state *state, void *rdata,
1908 uint64_t lowpc, uint64_t highpc,
1909 backtrace_error_callback error_callback,
1910 void *data, void *vec),
1911 void *rdata,
1912 backtrace_error_callback error_callback, void *data,
1913 void *vec)
1915 if (pcrange->have_lowpc && pcrange->have_highpc)
1916 return add_low_high_range (state, dwarf_sections, base_address,
1917 is_bigendian, u, pcrange, add_range, rdata,
1918 error_callback, data, vec);
1920 if (!pcrange->have_ranges)
1922 /* Did not find any address ranges to add. */
1923 return 1;
1926 if (u->version < 5)
1927 return add_ranges_from_ranges (state, dwarf_sections, base_address,
1928 is_bigendian, u, base, pcrange, add_range,
1929 rdata, error_callback, data, vec);
1930 else
1931 return add_ranges_from_rnglists (state, dwarf_sections, base_address,
1932 is_bigendian, u, base, pcrange, add_range,
1933 rdata, error_callback, data, vec);
1936 /* Find the address range covered by a compilation unit, reading from
1937 UNIT_BUF and adding values to U. Returns 1 if all data could be
1938 read, 0 if there is some error. */
1940 static int
1941 find_address_ranges (struct backtrace_state *state, uintptr_t base_address,
1942 struct dwarf_buf *unit_buf,
1943 const struct dwarf_sections *dwarf_sections,
1944 int is_bigendian, struct dwarf_data *altlink,
1945 backtrace_error_callback error_callback, void *data,
1946 struct unit *u, struct unit_addrs_vector *addrs,
1947 enum dwarf_tag *unit_tag)
1949 while (unit_buf->left > 0)
1951 uint64_t code;
1952 const struct abbrev *abbrev;
1953 struct pcrange pcrange;
1954 struct attr_val name_val;
1955 int have_name_val;
1956 struct attr_val comp_dir_val;
1957 int have_comp_dir_val;
1958 size_t i;
1960 code = read_uleb128 (unit_buf);
1961 if (code == 0)
1962 return 1;
1964 abbrev = lookup_abbrev (&u->abbrevs, code, error_callback, data);
1965 if (abbrev == NULL)
1966 return 0;
1968 if (unit_tag != NULL)
1969 *unit_tag = abbrev->tag;
1971 memset (&pcrange, 0, sizeof pcrange);
1972 memset (&name_val, 0, sizeof name_val);
1973 have_name_val = 0;
1974 memset (&comp_dir_val, 0, sizeof comp_dir_val);
1975 have_comp_dir_val = 0;
1976 for (i = 0; i < abbrev->num_attrs; ++i)
1978 struct attr_val val;
1980 if (!read_attribute (abbrev->attrs[i].form, abbrev->attrs[i].val,
1981 unit_buf, u->is_dwarf64, u->version,
1982 u->addrsize, dwarf_sections, altlink, &val))
1983 return 0;
1985 switch (abbrev->attrs[i].name)
1987 case DW_AT_low_pc: case DW_AT_high_pc: case DW_AT_ranges:
1988 update_pcrange (&abbrev->attrs[i], &val, &pcrange);
1989 break;
1991 case DW_AT_stmt_list:
1992 if ((abbrev->tag == DW_TAG_compile_unit
1993 || abbrev->tag == DW_TAG_skeleton_unit)
1994 && (val.encoding == ATTR_VAL_UINT
1995 || val.encoding == ATTR_VAL_REF_SECTION))
1996 u->lineoff = val.u.uint;
1997 break;
1999 case DW_AT_name:
2000 if (abbrev->tag == DW_TAG_compile_unit
2001 || abbrev->tag == DW_TAG_skeleton_unit)
2003 name_val = val;
2004 have_name_val = 1;
2006 break;
2008 case DW_AT_comp_dir:
2009 if (abbrev->tag == DW_TAG_compile_unit
2010 || abbrev->tag == DW_TAG_skeleton_unit)
2012 comp_dir_val = val;
2013 have_comp_dir_val = 1;
2015 break;
2017 case DW_AT_str_offsets_base:
2018 if ((abbrev->tag == DW_TAG_compile_unit
2019 || abbrev->tag == DW_TAG_skeleton_unit)
2020 && val.encoding == ATTR_VAL_REF_SECTION)
2021 u->str_offsets_base = val.u.uint;
2022 break;
2024 case DW_AT_addr_base:
2025 if ((abbrev->tag == DW_TAG_compile_unit
2026 || abbrev->tag == DW_TAG_skeleton_unit)
2027 && val.encoding == ATTR_VAL_REF_SECTION)
2028 u->addr_base = val.u.uint;
2029 break;
2031 case DW_AT_rnglists_base:
2032 if ((abbrev->tag == DW_TAG_compile_unit
2033 || abbrev->tag == DW_TAG_skeleton_unit)
2034 && val.encoding == ATTR_VAL_REF_SECTION)
2035 u->rnglists_base = val.u.uint;
2036 break;
2038 default:
2039 break;
2043 // Resolve strings after we're sure that we have seen
2044 // DW_AT_str_offsets_base.
2045 if (have_name_val)
2047 if (!resolve_string (dwarf_sections, u->is_dwarf64, is_bigendian,
2048 u->str_offsets_base, &name_val,
2049 error_callback, data, &u->filename))
2050 return 0;
2052 if (have_comp_dir_val)
2054 if (!resolve_string (dwarf_sections, u->is_dwarf64, is_bigendian,
2055 u->str_offsets_base, &comp_dir_val,
2056 error_callback, data, &u->comp_dir))
2057 return 0;
2060 if (abbrev->tag == DW_TAG_compile_unit
2061 || abbrev->tag == DW_TAG_subprogram
2062 || abbrev->tag == DW_TAG_skeleton_unit)
2064 if (!add_ranges (state, dwarf_sections, base_address,
2065 is_bigendian, u, pcrange.lowpc, &pcrange,
2066 add_unit_addr, (void *) u, error_callback, data,
2067 (void *) addrs))
2068 return 0;
2070 /* If we found the PC range in the DW_TAG_compile_unit or
2071 DW_TAG_skeleton_unit, we can stop now. */
2072 if ((abbrev->tag == DW_TAG_compile_unit
2073 || abbrev->tag == DW_TAG_skeleton_unit)
2074 && (pcrange.have_ranges
2075 || (pcrange.have_lowpc && pcrange.have_highpc)))
2076 return 1;
2079 if (abbrev->has_children)
2081 if (!find_address_ranges (state, base_address, unit_buf,
2082 dwarf_sections, is_bigendian, altlink,
2083 error_callback, data, u, addrs, NULL))
2084 return 0;
2088 return 1;
2091 /* Build a mapping from address ranges to the compilation units where
2092 the line number information for that range can be found. Returns 1
2093 on success, 0 on failure. */
2095 static int
2096 build_address_map (struct backtrace_state *state, uintptr_t base_address,
2097 const struct dwarf_sections *dwarf_sections,
2098 int is_bigendian, struct dwarf_data *altlink,
2099 backtrace_error_callback error_callback, void *data,
2100 struct unit_addrs_vector *addrs,
2101 struct unit_vector *unit_vec)
2103 struct dwarf_buf info;
2104 struct backtrace_vector units;
2105 size_t units_count;
2106 size_t i;
2107 struct unit **pu;
2108 size_t unit_offset = 0;
2109 struct unit_addrs *pa;
2111 memset (&addrs->vec, 0, sizeof addrs->vec);
2112 memset (&unit_vec->vec, 0, sizeof unit_vec->vec);
2113 addrs->count = 0;
2114 unit_vec->count = 0;
2116 /* Read through the .debug_info section. FIXME: Should we use the
2117 .debug_aranges section? gdb and addr2line don't use it, but I'm
2118 not sure why. */
2120 info.name = ".debug_info";
2121 info.start = dwarf_sections->data[DEBUG_INFO];
2122 info.buf = info.start;
2123 info.left = dwarf_sections->size[DEBUG_INFO];
2124 info.is_bigendian = is_bigendian;
2125 info.error_callback = error_callback;
2126 info.data = data;
2127 info.reported_underflow = 0;
2129 memset (&units, 0, sizeof units);
2130 units_count = 0;
2132 while (info.left > 0)
2134 const unsigned char *unit_data_start;
2135 uint64_t len;
2136 int is_dwarf64;
2137 struct dwarf_buf unit_buf;
2138 int version;
2139 int unit_type;
2140 uint64_t abbrev_offset;
2141 int addrsize;
2142 struct unit *u;
2143 enum dwarf_tag unit_tag;
2145 if (info.reported_underflow)
2146 goto fail;
2148 unit_data_start = info.buf;
2150 len = read_initial_length (&info, &is_dwarf64);
2151 unit_buf = info;
2152 unit_buf.left = len;
2154 if (!advance (&info, len))
2155 goto fail;
2157 version = read_uint16 (&unit_buf);
2158 if (version < 2 || version > 5)
2160 dwarf_buf_error (&unit_buf, "unrecognized DWARF version", -1);
2161 goto fail;
2164 if (version < 5)
2165 unit_type = 0;
2166 else
2168 unit_type = read_byte (&unit_buf);
2169 if (unit_type == DW_UT_type || unit_type == DW_UT_split_type)
2171 /* This unit doesn't have anything we need. */
2172 continue;
2176 pu = ((struct unit **)
2177 backtrace_vector_grow (state, sizeof (struct unit *),
2178 error_callback, data, &units));
2179 if (pu == NULL)
2180 goto fail;
2182 u = ((struct unit *)
2183 backtrace_alloc (state, sizeof *u, error_callback, data));
2184 if (u == NULL)
2185 goto fail;
2187 *pu = u;
2188 ++units_count;
2190 if (version < 5)
2191 addrsize = 0; /* Set below. */
2192 else
2193 addrsize = read_byte (&unit_buf);
2195 memset (&u->abbrevs, 0, sizeof u->abbrevs);
2196 abbrev_offset = read_offset (&unit_buf, is_dwarf64);
2197 if (!read_abbrevs (state, abbrev_offset,
2198 dwarf_sections->data[DEBUG_ABBREV],
2199 dwarf_sections->size[DEBUG_ABBREV],
2200 is_bigendian, error_callback, data, &u->abbrevs))
2201 goto fail;
2203 if (version < 5)
2204 addrsize = read_byte (&unit_buf);
2206 switch (unit_type)
2208 case 0:
2209 break;
2210 case DW_UT_compile: case DW_UT_partial:
2211 break;
2212 case DW_UT_skeleton: case DW_UT_split_compile:
2213 read_uint64 (&unit_buf); /* dwo_id */
2214 break;
2215 default:
2216 break;
2219 u->low_offset = unit_offset;
2220 unit_offset += len + (is_dwarf64 ? 12 : 4);
2221 u->high_offset = unit_offset;
2222 u->unit_data = unit_buf.buf;
2223 u->unit_data_len = unit_buf.left;
2224 u->unit_data_offset = unit_buf.buf - unit_data_start;
2225 u->version = version;
2226 u->is_dwarf64 = is_dwarf64;
2227 u->addrsize = addrsize;
2228 u->filename = NULL;
2229 u->comp_dir = NULL;
2230 u->abs_filename = NULL;
2231 u->lineoff = 0;
2232 u->str_offsets_base = 0;
2233 u->addr_base = 0;
2234 u->rnglists_base = 0;
2236 /* The actual line number mappings will be read as needed. */
2237 u->lines = NULL;
2238 u->lines_count = 0;
2239 u->function_addrs = NULL;
2240 u->function_addrs_count = 0;
2242 if (!find_address_ranges (state, base_address, &unit_buf, dwarf_sections,
2243 is_bigendian, altlink, error_callback, data,
2244 u, addrs, &unit_tag))
2245 goto fail;
2247 if (unit_buf.reported_underflow)
2248 goto fail;
2250 if (info.reported_underflow)
2251 goto fail;
2253 /* Add a trailing addrs entry, but don't include it in addrs->count. */
2254 pa = ((struct unit_addrs *)
2255 backtrace_vector_grow (state, sizeof (struct unit_addrs),
2256 error_callback, data, &addrs->vec));
2257 if (pa == NULL)
2258 goto fail;
2259 pa->low = 0;
2260 --pa->low;
2261 pa->high = pa->low;
2262 pa->u = NULL;
2264 unit_vec->vec = units;
2265 unit_vec->count = units_count;
2266 return 1;
2268 fail:
2269 if (units_count > 0)
2271 pu = (struct unit **) units.base;
2272 for (i = 0; i < units_count; i++)
2274 free_abbrevs (state, &pu[i]->abbrevs, error_callback, data);
2275 backtrace_free (state, pu[i], sizeof **pu, error_callback, data);
2277 backtrace_vector_free (state, &units, error_callback, data);
2279 if (addrs->count > 0)
2281 backtrace_vector_free (state, &addrs->vec, error_callback, data);
2282 addrs->count = 0;
2284 return 0;
2287 /* Add a new mapping to the vector of line mappings that we are
2288 building. Returns 1 on success, 0 on failure. */
2290 static int
2291 add_line (struct backtrace_state *state, struct dwarf_data *ddata,
2292 uintptr_t pc, const char *filename, int lineno,
2293 backtrace_error_callback error_callback, void *data,
2294 struct line_vector *vec)
2296 struct line *ln;
2298 /* If we are adding the same mapping, ignore it. This can happen
2299 when using discriminators. */
2300 if (vec->count > 0)
2302 ln = (struct line *) vec->vec.base + (vec->count - 1);
2303 if (pc == ln->pc && filename == ln->filename && lineno == ln->lineno)
2304 return 1;
2307 ln = ((struct line *)
2308 backtrace_vector_grow (state, sizeof (struct line), error_callback,
2309 data, &vec->vec));
2310 if (ln == NULL)
2311 return 0;
2313 /* Add in the base address here, so that we can look up the PC
2314 directly. */
2315 ln->pc = pc + ddata->base_address;
2317 ln->filename = filename;
2318 ln->lineno = lineno;
2319 ln->idx = vec->count;
2321 ++vec->count;
2323 return 1;
2326 /* Free the line header information. */
2328 static void
2329 free_line_header (struct backtrace_state *state, struct line_header *hdr,
2330 backtrace_error_callback error_callback, void *data)
2332 if (hdr->dirs_count != 0)
2333 backtrace_free (state, hdr->dirs, hdr->dirs_count * sizeof (const char *),
2334 error_callback, data);
2335 backtrace_free (state, hdr->filenames,
2336 hdr->filenames_count * sizeof (char *),
2337 error_callback, data);
2340 /* Read the directories and file names for a line header for version
2341 2, setting fields in HDR. Return 1 on success, 0 on failure. */
2343 static int
2344 read_v2_paths (struct backtrace_state *state, struct unit *u,
2345 struct dwarf_buf *hdr_buf, struct line_header *hdr)
2347 const unsigned char *p;
2348 const unsigned char *pend;
2349 size_t i;
2351 /* Count the number of directory entries. */
2352 hdr->dirs_count = 0;
2353 p = hdr_buf->buf;
2354 pend = p + hdr_buf->left;
2355 while (p < pend && *p != '\0')
2357 p += strnlen((const char *) p, pend - p) + 1;
2358 ++hdr->dirs_count;
2361 /* The index of the first entry in the list of directories is 1. Index 0 is
2362 used for the current directory of the compilation. To simplify index
2363 handling, we set entry 0 to the compilation unit directory. */
2364 ++hdr->dirs_count;
2365 hdr->dirs = ((const char **)
2366 backtrace_alloc (state,
2367 hdr->dirs_count * sizeof (const char *),
2368 hdr_buf->error_callback,
2369 hdr_buf->data));
2370 if (hdr->dirs == NULL)
2371 return 0;
2373 hdr->dirs[0] = u->comp_dir;
2374 i = 1;
2375 while (*hdr_buf->buf != '\0')
2377 if (hdr_buf->reported_underflow)
2378 return 0;
2380 hdr->dirs[i] = read_string (hdr_buf);
2381 if (hdr->dirs[i] == NULL)
2382 return 0;
2383 ++i;
2385 if (!advance (hdr_buf, 1))
2386 return 0;
2388 /* Count the number of file entries. */
2389 hdr->filenames_count = 0;
2390 p = hdr_buf->buf;
2391 pend = p + hdr_buf->left;
2392 while (p < pend && *p != '\0')
2394 p += strnlen ((const char *) p, pend - p) + 1;
2395 p += leb128_len (p);
2396 p += leb128_len (p);
2397 p += leb128_len (p);
2398 ++hdr->filenames_count;
2401 /* The index of the first entry in the list of file names is 1. Index 0 is
2402 used for the DW_AT_name of the compilation unit. To simplify index
2403 handling, we set entry 0 to the compilation unit file name. */
2404 ++hdr->filenames_count;
2405 hdr->filenames = ((const char **)
2406 backtrace_alloc (state,
2407 hdr->filenames_count * sizeof (char *),
2408 hdr_buf->error_callback,
2409 hdr_buf->data));
2410 if (hdr->filenames == NULL)
2411 return 0;
2412 hdr->filenames[0] = u->filename;
2413 i = 1;
2414 while (*hdr_buf->buf != '\0')
2416 const char *filename;
2417 uint64_t dir_index;
2419 if (hdr_buf->reported_underflow)
2420 return 0;
2422 filename = read_string (hdr_buf);
2423 if (filename == NULL)
2424 return 0;
2425 dir_index = read_uleb128 (hdr_buf);
2426 if (IS_ABSOLUTE_PATH (filename)
2427 || (dir_index < hdr->dirs_count && hdr->dirs[dir_index] == NULL))
2428 hdr->filenames[i] = filename;
2429 else
2431 const char *dir;
2432 size_t dir_len;
2433 size_t filename_len;
2434 char *s;
2436 if (dir_index < hdr->dirs_count)
2437 dir = hdr->dirs[dir_index];
2438 else
2440 dwarf_buf_error (hdr_buf,
2441 ("invalid directory index in "
2442 "line number program header"),
2444 return 0;
2446 dir_len = strlen (dir);
2447 filename_len = strlen (filename);
2448 s = ((char *) backtrace_alloc (state, dir_len + filename_len + 2,
2449 hdr_buf->error_callback,
2450 hdr_buf->data));
2451 if (s == NULL)
2452 return 0;
2453 memcpy (s, dir, dir_len);
2454 /* FIXME: If we are on a DOS-based file system, and the
2455 directory or the file name use backslashes, then we
2456 should use a backslash here. */
2457 s[dir_len] = '/';
2458 memcpy (s + dir_len + 1, filename, filename_len + 1);
2459 hdr->filenames[i] = s;
2462 /* Ignore the modification time and size. */
2463 read_uleb128 (hdr_buf);
2464 read_uleb128 (hdr_buf);
2466 ++i;
2469 return 1;
2472 /* Read a single version 5 LNCT entry for a directory or file name in a
2473 line header. Sets *STRING to the resulting name, ignoring other
2474 data. Return 1 on success, 0 on failure. */
2476 static int
2477 read_lnct (struct backtrace_state *state, struct dwarf_data *ddata,
2478 struct unit *u, struct dwarf_buf *hdr_buf,
2479 const struct line_header *hdr, size_t formats_count,
2480 const struct line_header_format *formats, const char **string)
2482 size_t i;
2483 const char *dir;
2484 const char *path;
2486 dir = NULL;
2487 path = NULL;
2488 for (i = 0; i < formats_count; i++)
2490 struct attr_val val;
2492 if (!read_attribute (formats[i].form, 0, hdr_buf, u->is_dwarf64,
2493 u->version, hdr->addrsize, &ddata->dwarf_sections,
2494 ddata->altlink, &val))
2495 return 0;
2496 switch (formats[i].lnct)
2498 case DW_LNCT_path:
2499 if (!resolve_string (&ddata->dwarf_sections, u->is_dwarf64,
2500 ddata->is_bigendian, u->str_offsets_base,
2501 &val, hdr_buf->error_callback, hdr_buf->data,
2502 &path))
2503 return 0;
2504 break;
2505 case DW_LNCT_directory_index:
2506 if (val.encoding == ATTR_VAL_UINT)
2508 if (val.u.uint >= hdr->dirs_count)
2510 dwarf_buf_error (hdr_buf,
2511 ("invalid directory index in "
2512 "line number program header"),
2514 return 0;
2516 dir = hdr->dirs[val.u.uint];
2518 break;
2519 default:
2520 /* We don't care about timestamps or sizes or hashes. */
2521 break;
2525 if (path == NULL)
2527 dwarf_buf_error (hdr_buf,
2528 "missing file name in line number program header",
2530 return 0;
2533 if (dir == NULL)
2534 *string = path;
2535 else
2537 size_t dir_len;
2538 size_t path_len;
2539 char *s;
2541 dir_len = strlen (dir);
2542 path_len = strlen (path);
2543 s = (char *) backtrace_alloc (state, dir_len + path_len + 2,
2544 hdr_buf->error_callback, hdr_buf->data);
2545 if (s == NULL)
2546 return 0;
2547 memcpy (s, dir, dir_len);
2548 /* FIXME: If we are on a DOS-based file system, and the
2549 directory or the path name use backslashes, then we should
2550 use a backslash here. */
2551 s[dir_len] = '/';
2552 memcpy (s + dir_len + 1, path, path_len + 1);
2553 *string = s;
2556 return 1;
2559 /* Read a set of DWARF 5 line header format entries, setting *PCOUNT
2560 and *PPATHS. Return 1 on success, 0 on failure. */
2562 static int
2563 read_line_header_format_entries (struct backtrace_state *state,
2564 struct dwarf_data *ddata,
2565 struct unit *u,
2566 struct dwarf_buf *hdr_buf,
2567 struct line_header *hdr,
2568 size_t *pcount,
2569 const char ***ppaths)
2571 size_t formats_count;
2572 struct line_header_format *formats;
2573 size_t paths_count;
2574 const char **paths;
2575 size_t i;
2576 int ret;
2578 formats_count = read_byte (hdr_buf);
2579 if (formats_count == 0)
2580 formats = NULL;
2581 else
2583 formats = ((struct line_header_format *)
2584 backtrace_alloc (state,
2585 (formats_count
2586 * sizeof (struct line_header_format)),
2587 hdr_buf->error_callback,
2588 hdr_buf->data));
2589 if (formats == NULL)
2590 return 0;
2592 for (i = 0; i < formats_count; i++)
2594 formats[i].lnct = (int) read_uleb128(hdr_buf);
2595 formats[i].form = (enum dwarf_form) read_uleb128 (hdr_buf);
2599 paths_count = read_uleb128 (hdr_buf);
2600 if (paths_count == 0)
2602 *pcount = 0;
2603 *ppaths = NULL;
2604 ret = 1;
2605 goto exit;
2608 paths = ((const char **)
2609 backtrace_alloc (state, paths_count * sizeof (const char *),
2610 hdr_buf->error_callback, hdr_buf->data));
2611 if (paths == NULL)
2613 ret = 0;
2614 goto exit;
2616 for (i = 0; i < paths_count; i++)
2618 if (!read_lnct (state, ddata, u, hdr_buf, hdr, formats_count,
2619 formats, &paths[i]))
2621 backtrace_free (state, paths,
2622 paths_count * sizeof (const char *),
2623 hdr_buf->error_callback, hdr_buf->data);
2624 ret = 0;
2625 goto exit;
2629 *pcount = paths_count;
2630 *ppaths = paths;
2632 ret = 1;
2634 exit:
2635 if (formats != NULL)
2636 backtrace_free (state, formats,
2637 formats_count * sizeof (struct line_header_format),
2638 hdr_buf->error_callback, hdr_buf->data);
2640 return ret;
2643 /* Read the line header. Return 1 on success, 0 on failure. */
2645 static int
2646 read_line_header (struct backtrace_state *state, struct dwarf_data *ddata,
2647 struct unit *u, int is_dwarf64, struct dwarf_buf *line_buf,
2648 struct line_header *hdr)
2650 uint64_t hdrlen;
2651 struct dwarf_buf hdr_buf;
2653 hdr->version = read_uint16 (line_buf);
2654 if (hdr->version < 2 || hdr->version > 5)
2656 dwarf_buf_error (line_buf, "unsupported line number version", -1);
2657 return 0;
2660 if (hdr->version < 5)
2661 hdr->addrsize = u->addrsize;
2662 else
2664 hdr->addrsize = read_byte (line_buf);
2665 /* We could support a non-zero segment_selector_size but I doubt
2666 we'll ever see it. */
2667 if (read_byte (line_buf) != 0)
2669 dwarf_buf_error (line_buf,
2670 "non-zero segment_selector_size not supported",
2671 -1);
2672 return 0;
2676 hdrlen = read_offset (line_buf, is_dwarf64);
2678 hdr_buf = *line_buf;
2679 hdr_buf.left = hdrlen;
2681 if (!advance (line_buf, hdrlen))
2682 return 0;
2684 hdr->min_insn_len = read_byte (&hdr_buf);
2685 if (hdr->version < 4)
2686 hdr->max_ops_per_insn = 1;
2687 else
2688 hdr->max_ops_per_insn = read_byte (&hdr_buf);
2690 /* We don't care about default_is_stmt. */
2691 read_byte (&hdr_buf);
2693 hdr->line_base = read_sbyte (&hdr_buf);
2694 hdr->line_range = read_byte (&hdr_buf);
2696 hdr->opcode_base = read_byte (&hdr_buf);
2697 hdr->opcode_lengths = hdr_buf.buf;
2698 if (!advance (&hdr_buf, hdr->opcode_base - 1))
2699 return 0;
2701 if (hdr->version < 5)
2703 if (!read_v2_paths (state, u, &hdr_buf, hdr))
2704 return 0;
2706 else
2708 if (!read_line_header_format_entries (state, ddata, u, &hdr_buf, hdr,
2709 &hdr->dirs_count,
2710 &hdr->dirs))
2711 return 0;
2712 if (!read_line_header_format_entries (state, ddata, u, &hdr_buf, hdr,
2713 &hdr->filenames_count,
2714 &hdr->filenames))
2715 return 0;
2718 if (hdr_buf.reported_underflow)
2719 return 0;
2721 return 1;
2724 /* Read the line program, adding line mappings to VEC. Return 1 on
2725 success, 0 on failure. */
2727 static int
2728 read_line_program (struct backtrace_state *state, struct dwarf_data *ddata,
2729 const struct line_header *hdr, struct dwarf_buf *line_buf,
2730 struct line_vector *vec)
2732 uint64_t address;
2733 unsigned int op_index;
2734 const char *reset_filename;
2735 const char *filename;
2736 int lineno;
2738 address = 0;
2739 op_index = 0;
2740 if (hdr->filenames_count > 1)
2741 reset_filename = hdr->filenames[1];
2742 else
2743 reset_filename = "";
2744 filename = reset_filename;
2745 lineno = 1;
2746 while (line_buf->left > 0)
2748 unsigned int op;
2750 op = read_byte (line_buf);
2751 if (op >= hdr->opcode_base)
2753 unsigned int advance;
2755 /* Special opcode. */
2756 op -= hdr->opcode_base;
2757 advance = op / hdr->line_range;
2758 address += (hdr->min_insn_len * (op_index + advance)
2759 / hdr->max_ops_per_insn);
2760 op_index = (op_index + advance) % hdr->max_ops_per_insn;
2761 lineno += hdr->line_base + (int) (op % hdr->line_range);
2762 add_line (state, ddata, address, filename, lineno,
2763 line_buf->error_callback, line_buf->data, vec);
2765 else if (op == DW_LNS_extended_op)
2767 uint64_t len;
2769 len = read_uleb128 (line_buf);
2770 op = read_byte (line_buf);
2771 switch (op)
2773 case DW_LNE_end_sequence:
2774 /* FIXME: Should we mark the high PC here? It seems
2775 that we already have that information from the
2776 compilation unit. */
2777 address = 0;
2778 op_index = 0;
2779 filename = reset_filename;
2780 lineno = 1;
2781 break;
2782 case DW_LNE_set_address:
2783 address = read_address (line_buf, hdr->addrsize);
2784 break;
2785 case DW_LNE_define_file:
2787 const char *f;
2788 unsigned int dir_index;
2790 f = read_string (line_buf);
2791 if (f == NULL)
2792 return 0;
2793 dir_index = read_uleb128 (line_buf);
2794 /* Ignore that time and length. */
2795 read_uleb128 (line_buf);
2796 read_uleb128 (line_buf);
2797 if (IS_ABSOLUTE_PATH (f))
2798 filename = f;
2799 else
2801 const char *dir;
2802 size_t dir_len;
2803 size_t f_len;
2804 char *p;
2806 if (dir_index < hdr->dirs_count)
2807 dir = hdr->dirs[dir_index];
2808 else
2810 dwarf_buf_error (line_buf,
2811 ("invalid directory index "
2812 "in line number program"),
2814 return 0;
2816 dir_len = strlen (dir);
2817 f_len = strlen (f);
2818 p = ((char *)
2819 backtrace_alloc (state, dir_len + f_len + 2,
2820 line_buf->error_callback,
2821 line_buf->data));
2822 if (p == NULL)
2823 return 0;
2824 memcpy (p, dir, dir_len);
2825 /* FIXME: If we are on a DOS-based file system,
2826 and the directory or the file name use
2827 backslashes, then we should use a backslash
2828 here. */
2829 p[dir_len] = '/';
2830 memcpy (p + dir_len + 1, f, f_len + 1);
2831 filename = p;
2834 break;
2835 case DW_LNE_set_discriminator:
2836 /* We don't care about discriminators. */
2837 read_uleb128 (line_buf);
2838 break;
2839 default:
2840 if (!advance (line_buf, len - 1))
2841 return 0;
2842 break;
2845 else
2847 switch (op)
2849 case DW_LNS_copy:
2850 add_line (state, ddata, address, filename, lineno,
2851 line_buf->error_callback, line_buf->data, vec);
2852 break;
2853 case DW_LNS_advance_pc:
2855 uint64_t advance;
2857 advance = read_uleb128 (line_buf);
2858 address += (hdr->min_insn_len * (op_index + advance)
2859 / hdr->max_ops_per_insn);
2860 op_index = (op_index + advance) % hdr->max_ops_per_insn;
2862 break;
2863 case DW_LNS_advance_line:
2864 lineno += (int) read_sleb128 (line_buf);
2865 break;
2866 case DW_LNS_set_file:
2868 uint64_t fileno;
2870 fileno = read_uleb128 (line_buf);
2871 if (fileno >= hdr->filenames_count)
2873 dwarf_buf_error (line_buf,
2874 ("invalid file number in "
2875 "line number program"),
2877 return 0;
2879 filename = hdr->filenames[fileno];
2881 break;
2882 case DW_LNS_set_column:
2883 read_uleb128 (line_buf);
2884 break;
2885 case DW_LNS_negate_stmt:
2886 break;
2887 case DW_LNS_set_basic_block:
2888 break;
2889 case DW_LNS_const_add_pc:
2891 unsigned int advance;
2893 op = 255 - hdr->opcode_base;
2894 advance = op / hdr->line_range;
2895 address += (hdr->min_insn_len * (op_index + advance)
2896 / hdr->max_ops_per_insn);
2897 op_index = (op_index + advance) % hdr->max_ops_per_insn;
2899 break;
2900 case DW_LNS_fixed_advance_pc:
2901 address += read_uint16 (line_buf);
2902 op_index = 0;
2903 break;
2904 case DW_LNS_set_prologue_end:
2905 break;
2906 case DW_LNS_set_epilogue_begin:
2907 break;
2908 case DW_LNS_set_isa:
2909 read_uleb128 (line_buf);
2910 break;
2911 default:
2913 unsigned int i;
2915 for (i = hdr->opcode_lengths[op - 1]; i > 0; --i)
2916 read_uleb128 (line_buf);
2918 break;
2923 return 1;
2926 /* Read the line number information for a compilation unit. Returns 1
2927 on success, 0 on failure. */
2929 static int
2930 read_line_info (struct backtrace_state *state, struct dwarf_data *ddata,
2931 backtrace_error_callback error_callback, void *data,
2932 struct unit *u, struct line_header *hdr, struct line **lines,
2933 size_t *lines_count)
2935 struct line_vector vec;
2936 struct dwarf_buf line_buf;
2937 uint64_t len;
2938 int is_dwarf64;
2939 struct line *ln;
2941 memset (&vec.vec, 0, sizeof vec.vec);
2942 vec.count = 0;
2944 memset (hdr, 0, sizeof *hdr);
2946 if (u->lineoff != (off_t) (size_t) u->lineoff
2947 || (size_t) u->lineoff >= ddata->dwarf_sections.size[DEBUG_LINE])
2949 error_callback (data, "unit line offset out of range", 0);
2950 goto fail;
2953 line_buf.name = ".debug_line";
2954 line_buf.start = ddata->dwarf_sections.data[DEBUG_LINE];
2955 line_buf.buf = ddata->dwarf_sections.data[DEBUG_LINE] + u->lineoff;
2956 line_buf.left = ddata->dwarf_sections.size[DEBUG_LINE] - u->lineoff;
2957 line_buf.is_bigendian = ddata->is_bigendian;
2958 line_buf.error_callback = error_callback;
2959 line_buf.data = data;
2960 line_buf.reported_underflow = 0;
2962 len = read_initial_length (&line_buf, &is_dwarf64);
2963 line_buf.left = len;
2965 if (!read_line_header (state, ddata, u, is_dwarf64, &line_buf, hdr))
2966 goto fail;
2968 if (!read_line_program (state, ddata, hdr, &line_buf, &vec))
2969 goto fail;
2971 if (line_buf.reported_underflow)
2972 goto fail;
2974 if (vec.count == 0)
2976 /* This is not a failure in the sense of a generating an error,
2977 but it is a failure in that sense that we have no useful
2978 information. */
2979 goto fail;
2982 /* Allocate one extra entry at the end. */
2983 ln = ((struct line *)
2984 backtrace_vector_grow (state, sizeof (struct line), error_callback,
2985 data, &vec.vec));
2986 if (ln == NULL)
2987 goto fail;
2988 ln->pc = (uintptr_t) -1;
2989 ln->filename = NULL;
2990 ln->lineno = 0;
2991 ln->idx = 0;
2993 if (!backtrace_vector_release (state, &vec.vec, error_callback, data))
2994 goto fail;
2996 ln = (struct line *) vec.vec.base;
2997 backtrace_qsort (ln, vec.count, sizeof (struct line), line_compare);
2999 *lines = ln;
3000 *lines_count = vec.count;
3002 return 1;
3004 fail:
3005 backtrace_vector_free (state, &vec.vec, error_callback, data);
3006 free_line_header (state, hdr, error_callback, data);
3007 *lines = (struct line *) (uintptr_t) -1;
3008 *lines_count = 0;
3009 return 0;
3012 static const char *read_referenced_name (struct dwarf_data *, struct unit *,
3013 uint64_t, backtrace_error_callback,
3014 void *);
3016 /* Read the name of a function from a DIE referenced by ATTR with VAL. */
3018 static const char *
3019 read_referenced_name_from_attr (struct dwarf_data *ddata, struct unit *u,
3020 struct attr *attr, struct attr_val *val,
3021 backtrace_error_callback error_callback,
3022 void *data)
3024 switch (attr->name)
3026 case DW_AT_abstract_origin:
3027 case DW_AT_specification:
3028 break;
3029 default:
3030 return NULL;
3033 if (attr->form == DW_FORM_ref_sig8)
3034 return NULL;
3036 if (val->encoding == ATTR_VAL_REF_INFO)
3038 struct unit *unit
3039 = find_unit (ddata->units, ddata->units_count,
3040 val->u.uint);
3041 if (unit == NULL)
3042 return NULL;
3044 uint64_t offset = val->u.uint - unit->low_offset;
3045 return read_referenced_name (ddata, unit, offset, error_callback, data);
3048 if (val->encoding == ATTR_VAL_UINT
3049 || val->encoding == ATTR_VAL_REF_UNIT)
3050 return read_referenced_name (ddata, u, val->u.uint, error_callback, data);
3052 if (val->encoding == ATTR_VAL_REF_ALT_INFO)
3054 struct unit *alt_unit
3055 = find_unit (ddata->altlink->units, ddata->altlink->units_count,
3056 val->u.uint);
3057 if (alt_unit == NULL)
3058 return NULL;
3060 uint64_t offset = val->u.uint - alt_unit->low_offset;
3061 return read_referenced_name (ddata->altlink, alt_unit, offset,
3062 error_callback, data);
3065 return NULL;
3068 /* Read the name of a function from a DIE referenced by a
3069 DW_AT_abstract_origin or DW_AT_specification tag. OFFSET is within
3070 the same compilation unit. */
3072 static const char *
3073 read_referenced_name (struct dwarf_data *ddata, struct unit *u,
3074 uint64_t offset, backtrace_error_callback error_callback,
3075 void *data)
3077 struct dwarf_buf unit_buf;
3078 uint64_t code;
3079 const struct abbrev *abbrev;
3080 const char *ret;
3081 size_t i;
3083 /* OFFSET is from the start of the data for this compilation unit.
3084 U->unit_data is the data, but it starts U->unit_data_offset bytes
3085 from the beginning. */
3087 if (offset < u->unit_data_offset
3088 || offset - u->unit_data_offset >= u->unit_data_len)
3090 error_callback (data,
3091 "abstract origin or specification out of range",
3093 return NULL;
3096 offset -= u->unit_data_offset;
3098 unit_buf.name = ".debug_info";
3099 unit_buf.start = ddata->dwarf_sections.data[DEBUG_INFO];
3100 unit_buf.buf = u->unit_data + offset;
3101 unit_buf.left = u->unit_data_len - offset;
3102 unit_buf.is_bigendian = ddata->is_bigendian;
3103 unit_buf.error_callback = error_callback;
3104 unit_buf.data = data;
3105 unit_buf.reported_underflow = 0;
3107 code = read_uleb128 (&unit_buf);
3108 if (code == 0)
3110 dwarf_buf_error (&unit_buf,
3111 "invalid abstract origin or specification",
3113 return NULL;
3116 abbrev = lookup_abbrev (&u->abbrevs, code, error_callback, data);
3117 if (abbrev == NULL)
3118 return NULL;
3120 ret = NULL;
3121 for (i = 0; i < abbrev->num_attrs; ++i)
3123 struct attr_val val;
3125 if (!read_attribute (abbrev->attrs[i].form, abbrev->attrs[i].val,
3126 &unit_buf, u->is_dwarf64, u->version, u->addrsize,
3127 &ddata->dwarf_sections, ddata->altlink, &val))
3128 return NULL;
3130 switch (abbrev->attrs[i].name)
3132 case DW_AT_name:
3133 /* Third name preference: don't override. A name we found in some
3134 other way, will normally be more useful -- e.g., this name is
3135 normally not mangled. */
3136 if (ret != NULL)
3137 break;
3138 if (!resolve_string (&ddata->dwarf_sections, u->is_dwarf64,
3139 ddata->is_bigendian, u->str_offsets_base,
3140 &val, error_callback, data, &ret))
3141 return NULL;
3142 break;
3144 case DW_AT_linkage_name:
3145 case DW_AT_MIPS_linkage_name:
3146 /* First name preference: override all. */
3148 const char *s;
3150 s = NULL;
3151 if (!resolve_string (&ddata->dwarf_sections, u->is_dwarf64,
3152 ddata->is_bigendian, u->str_offsets_base,
3153 &val, error_callback, data, &s))
3154 return NULL;
3155 if (s != NULL)
3156 return s;
3158 break;
3160 case DW_AT_specification:
3161 /* Second name preference: override DW_AT_name, don't override
3162 DW_AT_linkage_name. */
3164 const char *name;
3166 name = read_referenced_name_from_attr (ddata, u, &abbrev->attrs[i],
3167 &val, error_callback, data);
3168 if (name != NULL)
3169 ret = name;
3171 break;
3173 default:
3174 break;
3178 return ret;
3181 /* Add a range to a unit that maps to a function. This is called via
3182 add_ranges. Returns 1 on success, 0 on error. */
3184 static int
3185 add_function_range (struct backtrace_state *state, void *rdata,
3186 uint64_t lowpc, uint64_t highpc,
3187 backtrace_error_callback error_callback, void *data,
3188 void *pvec)
3190 struct function *function = (struct function *) rdata;
3191 struct function_vector *vec = (struct function_vector *) pvec;
3192 struct function_addrs *p;
3194 if (vec->count > 0)
3196 p = (struct function_addrs *) vec->vec.base + (vec->count - 1);
3197 if ((lowpc == p->high || lowpc == p->high + 1)
3198 && function == p->function)
3200 if (highpc > p->high)
3201 p->high = highpc;
3202 return 1;
3206 p = ((struct function_addrs *)
3207 backtrace_vector_grow (state, sizeof (struct function_addrs),
3208 error_callback, data, &vec->vec));
3209 if (p == NULL)
3210 return 0;
3212 p->low = lowpc;
3213 p->high = highpc;
3214 p->function = function;
3216 ++vec->count;
3218 return 1;
3221 /* Read one entry plus all its children. Add function addresses to
3222 VEC. Returns 1 on success, 0 on error. */
3224 static int
3225 read_function_entry (struct backtrace_state *state, struct dwarf_data *ddata,
3226 struct unit *u, uint64_t base, struct dwarf_buf *unit_buf,
3227 const struct line_header *lhdr,
3228 backtrace_error_callback error_callback, void *data,
3229 struct function_vector *vec_function,
3230 struct function_vector *vec_inlined)
3232 while (unit_buf->left > 0)
3234 uint64_t code;
3235 const struct abbrev *abbrev;
3236 int is_function;
3237 struct function *function;
3238 struct function_vector *vec;
3239 size_t i;
3240 struct pcrange pcrange;
3241 int have_linkage_name;
3243 code = read_uleb128 (unit_buf);
3244 if (code == 0)
3245 return 1;
3247 abbrev = lookup_abbrev (&u->abbrevs, code, error_callback, data);
3248 if (abbrev == NULL)
3249 return 0;
3251 is_function = (abbrev->tag == DW_TAG_subprogram
3252 || abbrev->tag == DW_TAG_entry_point
3253 || abbrev->tag == DW_TAG_inlined_subroutine);
3255 if (abbrev->tag == DW_TAG_inlined_subroutine)
3256 vec = vec_inlined;
3257 else
3258 vec = vec_function;
3260 function = NULL;
3261 if (is_function)
3263 function = ((struct function *)
3264 backtrace_alloc (state, sizeof *function,
3265 error_callback, data));
3266 if (function == NULL)
3267 return 0;
3268 memset (function, 0, sizeof *function);
3271 memset (&pcrange, 0, sizeof pcrange);
3272 have_linkage_name = 0;
3273 for (i = 0; i < abbrev->num_attrs; ++i)
3275 struct attr_val val;
3277 if (!read_attribute (abbrev->attrs[i].form, abbrev->attrs[i].val,
3278 unit_buf, u->is_dwarf64, u->version,
3279 u->addrsize, &ddata->dwarf_sections,
3280 ddata->altlink, &val))
3281 return 0;
3283 /* The compile unit sets the base address for any address
3284 ranges in the function entries. */
3285 if ((abbrev->tag == DW_TAG_compile_unit
3286 || abbrev->tag == DW_TAG_skeleton_unit)
3287 && abbrev->attrs[i].name == DW_AT_low_pc)
3289 if (val.encoding == ATTR_VAL_ADDRESS)
3290 base = val.u.uint;
3291 else if (val.encoding == ATTR_VAL_ADDRESS_INDEX)
3293 if (!resolve_addr_index (&ddata->dwarf_sections,
3294 u->addr_base, u->addrsize,
3295 ddata->is_bigendian, val.u.uint,
3296 error_callback, data, &base))
3297 return 0;
3301 if (is_function)
3303 switch (abbrev->attrs[i].name)
3305 case DW_AT_call_file:
3306 if (val.encoding == ATTR_VAL_UINT)
3308 if (val.u.uint >= lhdr->filenames_count)
3310 dwarf_buf_error (unit_buf,
3311 ("invalid file number in "
3312 "DW_AT_call_file attribute"),
3314 return 0;
3316 function->caller_filename = lhdr->filenames[val.u.uint];
3318 break;
3320 case DW_AT_call_line:
3321 if (val.encoding == ATTR_VAL_UINT)
3322 function->caller_lineno = val.u.uint;
3323 break;
3325 case DW_AT_abstract_origin:
3326 case DW_AT_specification:
3327 /* Second name preference: override DW_AT_name, don't override
3328 DW_AT_linkage_name. */
3329 if (have_linkage_name)
3330 break;
3332 const char *name;
3334 name
3335 = read_referenced_name_from_attr (ddata, u,
3336 &abbrev->attrs[i], &val,
3337 error_callback, data);
3338 if (name != NULL)
3339 function->name = name;
3341 break;
3343 case DW_AT_name:
3344 /* Third name preference: don't override. */
3345 if (function->name != NULL)
3346 break;
3347 if (!resolve_string (&ddata->dwarf_sections, u->is_dwarf64,
3348 ddata->is_bigendian,
3349 u->str_offsets_base, &val,
3350 error_callback, data, &function->name))
3351 return 0;
3352 break;
3354 case DW_AT_linkage_name:
3355 case DW_AT_MIPS_linkage_name:
3356 /* First name preference: override all. */
3358 const char *s;
3360 s = NULL;
3361 if (!resolve_string (&ddata->dwarf_sections, u->is_dwarf64,
3362 ddata->is_bigendian,
3363 u->str_offsets_base, &val,
3364 error_callback, data, &s))
3365 return 0;
3366 if (s != NULL)
3368 function->name = s;
3369 have_linkage_name = 1;
3372 break;
3374 case DW_AT_low_pc: case DW_AT_high_pc: case DW_AT_ranges:
3375 update_pcrange (&abbrev->attrs[i], &val, &pcrange);
3376 break;
3378 default:
3379 break;
3384 /* If we couldn't find a name for the function, we have no use
3385 for it. */
3386 if (is_function && function->name == NULL)
3388 backtrace_free (state, function, sizeof *function,
3389 error_callback, data);
3390 is_function = 0;
3393 if (is_function)
3395 if (pcrange.have_ranges
3396 || (pcrange.have_lowpc && pcrange.have_highpc))
3398 if (!add_ranges (state, &ddata->dwarf_sections,
3399 ddata->base_address, ddata->is_bigendian,
3400 u, base, &pcrange, add_function_range,
3401 (void *) function, error_callback, data,
3402 (void *) vec))
3403 return 0;
3405 else
3407 backtrace_free (state, function, sizeof *function,
3408 error_callback, data);
3409 is_function = 0;
3413 if (abbrev->has_children)
3415 if (!is_function)
3417 if (!read_function_entry (state, ddata, u, base, unit_buf, lhdr,
3418 error_callback, data, vec_function,
3419 vec_inlined))
3420 return 0;
3422 else
3424 struct function_vector fvec;
3426 /* Gather any information for inlined functions in
3427 FVEC. */
3429 memset (&fvec, 0, sizeof fvec);
3431 if (!read_function_entry (state, ddata, u, base, unit_buf, lhdr,
3432 error_callback, data, vec_function,
3433 &fvec))
3434 return 0;
3436 if (fvec.count > 0)
3438 struct function_addrs *p;
3439 struct function_addrs *faddrs;
3441 /* Allocate a trailing entry, but don't include it
3442 in fvec.count. */
3443 p = ((struct function_addrs *)
3444 backtrace_vector_grow (state,
3445 sizeof (struct function_addrs),
3446 error_callback, data,
3447 &fvec.vec));
3448 if (p == NULL)
3449 return 0;
3450 p->low = 0;
3451 --p->low;
3452 p->high = p->low;
3453 p->function = NULL;
3455 if (!backtrace_vector_release (state, &fvec.vec,
3456 error_callback, data))
3457 return 0;
3459 faddrs = (struct function_addrs *) fvec.vec.base;
3460 backtrace_qsort (faddrs, fvec.count,
3461 sizeof (struct function_addrs),
3462 function_addrs_compare);
3464 function->function_addrs = faddrs;
3465 function->function_addrs_count = fvec.count;
3471 return 1;
3474 /* Read function name information for a compilation unit. We look
3475 through the whole unit looking for function tags. */
3477 static void
3478 read_function_info (struct backtrace_state *state, struct dwarf_data *ddata,
3479 const struct line_header *lhdr,
3480 backtrace_error_callback error_callback, void *data,
3481 struct unit *u, struct function_vector *fvec,
3482 struct function_addrs **ret_addrs,
3483 size_t *ret_addrs_count)
3485 struct function_vector lvec;
3486 struct function_vector *pfvec;
3487 struct dwarf_buf unit_buf;
3488 struct function_addrs *p;
3489 struct function_addrs *addrs;
3490 size_t addrs_count;
3492 /* Use FVEC if it is not NULL. Otherwise use our own vector. */
3493 if (fvec != NULL)
3494 pfvec = fvec;
3495 else
3497 memset (&lvec, 0, sizeof lvec);
3498 pfvec = &lvec;
3501 unit_buf.name = ".debug_info";
3502 unit_buf.start = ddata->dwarf_sections.data[DEBUG_INFO];
3503 unit_buf.buf = u->unit_data;
3504 unit_buf.left = u->unit_data_len;
3505 unit_buf.is_bigendian = ddata->is_bigendian;
3506 unit_buf.error_callback = error_callback;
3507 unit_buf.data = data;
3508 unit_buf.reported_underflow = 0;
3510 while (unit_buf.left > 0)
3512 if (!read_function_entry (state, ddata, u, 0, &unit_buf, lhdr,
3513 error_callback, data, pfvec, pfvec))
3514 return;
3517 if (pfvec->count == 0)
3518 return;
3520 /* Allocate a trailing entry, but don't include it in
3521 pfvec->count. */
3522 p = ((struct function_addrs *)
3523 backtrace_vector_grow (state, sizeof (struct function_addrs),
3524 error_callback, data, &pfvec->vec));
3525 if (p == NULL)
3526 return;
3527 p->low = 0;
3528 --p->low;
3529 p->high = p->low;
3530 p->function = NULL;
3532 addrs_count = pfvec->count;
3534 if (fvec == NULL)
3536 if (!backtrace_vector_release (state, &lvec.vec, error_callback, data))
3537 return;
3538 addrs = (struct function_addrs *) pfvec->vec.base;
3540 else
3542 /* Finish this list of addresses, but leave the remaining space in
3543 the vector available for the next function unit. */
3544 addrs = ((struct function_addrs *)
3545 backtrace_vector_finish (state, &fvec->vec,
3546 error_callback, data));
3547 if (addrs == NULL)
3548 return;
3549 fvec->count = 0;
3552 backtrace_qsort (addrs, addrs_count, sizeof (struct function_addrs),
3553 function_addrs_compare);
3555 *ret_addrs = addrs;
3556 *ret_addrs_count = addrs_count;
3559 /* See if PC is inlined in FUNCTION. If it is, print out the inlined
3560 information, and update FILENAME and LINENO for the caller.
3561 Returns whatever CALLBACK returns, or 0 to keep going. */
3563 static int
3564 report_inlined_functions (uintptr_t pc, struct function *function,
3565 backtrace_full_callback callback, void *data,
3566 const char **filename, int *lineno)
3568 struct function_addrs *p;
3569 struct function_addrs *match;
3570 struct function *inlined;
3571 int ret;
3573 if (function->function_addrs_count == 0)
3574 return 0;
3576 /* Our search isn't safe if pc == -1, as that is the sentinel
3577 value. */
3578 if (pc + 1 == 0)
3579 return 0;
3581 p = ((struct function_addrs *)
3582 bsearch (&pc, function->function_addrs,
3583 function->function_addrs_count,
3584 sizeof (struct function_addrs),
3585 function_addrs_search));
3586 if (p == NULL)
3587 return 0;
3589 /* Here pc >= p->low && pc < (p + 1)->low. The function_addrs are
3590 sorted by low, so if pc > p->low we are at the end of a range of
3591 function_addrs with the same low value. If pc == p->low walk
3592 forward to the end of the range with that low value. Then walk
3593 backward and use the first range that includes pc. */
3594 while (pc == (p + 1)->low)
3595 ++p;
3596 match = NULL;
3597 while (1)
3599 if (pc < p->high)
3601 match = p;
3602 break;
3604 if (p == function->function_addrs)
3605 break;
3606 if ((p - 1)->low < p->low)
3607 break;
3608 --p;
3610 if (match == NULL)
3611 return 0;
3613 /* We found an inlined call. */
3615 inlined = match->function;
3617 /* Report any calls inlined into this one. */
3618 ret = report_inlined_functions (pc, inlined, callback, data,
3619 filename, lineno);
3620 if (ret != 0)
3621 return ret;
3623 /* Report this inlined call. */
3624 ret = callback (data, pc, *filename, *lineno, inlined->name);
3625 if (ret != 0)
3626 return ret;
3628 /* Our caller will report the caller of the inlined function; tell
3629 it the appropriate filename and line number. */
3630 *filename = inlined->caller_filename;
3631 *lineno = inlined->caller_lineno;
3633 return 0;
3636 /* Look for a PC in the DWARF mapping for one module. On success,
3637 call CALLBACK and return whatever it returns. On error, call
3638 ERROR_CALLBACK and return 0. Sets *FOUND to 1 if the PC is found,
3639 0 if not. */
3641 static int
3642 dwarf_lookup_pc (struct backtrace_state *state, struct dwarf_data *ddata,
3643 uintptr_t pc, backtrace_full_callback callback,
3644 backtrace_error_callback error_callback, void *data,
3645 int *found)
3647 struct unit_addrs *entry;
3648 int found_entry;
3649 struct unit *u;
3650 int new_data;
3651 struct line *lines;
3652 struct line *ln;
3653 struct function_addrs *p;
3654 struct function_addrs *fmatch;
3655 struct function *function;
3656 const char *filename;
3657 int lineno;
3658 int ret;
3660 *found = 1;
3662 /* Find an address range that includes PC. Our search isn't safe if
3663 PC == -1, as we use that as a sentinel value, so skip the search
3664 in that case. */
3665 entry = (ddata->addrs_count == 0 || pc + 1 == 0
3666 ? NULL
3667 : bsearch (&pc, ddata->addrs, ddata->addrs_count,
3668 sizeof (struct unit_addrs), unit_addrs_search));
3670 if (entry == NULL)
3672 *found = 0;
3673 return 0;
3676 /* Here pc >= entry->low && pc < (entry + 1)->low. The unit_addrs
3677 are sorted by low, so if pc > p->low we are at the end of a range
3678 of unit_addrs with the same low value. If pc == p->low walk
3679 forward to the end of the range with that low value. Then walk
3680 backward and use the first range that includes pc. */
3681 while (pc == (entry + 1)->low)
3682 ++entry;
3683 found_entry = 0;
3684 while (1)
3686 if (pc < entry->high)
3688 found_entry = 1;
3689 break;
3691 if (entry == ddata->addrs)
3692 break;
3693 if ((entry - 1)->low < entry->low)
3694 break;
3695 --entry;
3697 if (!found_entry)
3699 *found = 0;
3700 return 0;
3703 /* We need the lines, lines_count, function_addrs,
3704 function_addrs_count fields of u. If they are not set, we need
3705 to set them. When running in threaded mode, we need to allow for
3706 the possibility that some other thread is setting them
3707 simultaneously. */
3709 u = entry->u;
3710 lines = u->lines;
3712 /* Skip units with no useful line number information by walking
3713 backward. Useless line number information is marked by setting
3714 lines == -1. */
3715 while (entry > ddata->addrs
3716 && pc >= (entry - 1)->low
3717 && pc < (entry - 1)->high)
3719 if (state->threaded)
3720 lines = (struct line *) backtrace_atomic_load_pointer (&u->lines);
3722 if (lines != (struct line *) (uintptr_t) -1)
3723 break;
3725 --entry;
3727 u = entry->u;
3728 lines = u->lines;
3731 if (state->threaded)
3732 lines = backtrace_atomic_load_pointer (&u->lines);
3734 new_data = 0;
3735 if (lines == NULL)
3737 struct function_addrs *function_addrs;
3738 size_t function_addrs_count;
3739 struct line_header lhdr;
3740 size_t count;
3742 /* We have never read the line information for this unit. Read
3743 it now. */
3745 function_addrs = NULL;
3746 function_addrs_count = 0;
3747 if (read_line_info (state, ddata, error_callback, data, entry->u, &lhdr,
3748 &lines, &count))
3750 struct function_vector *pfvec;
3752 /* If not threaded, reuse DDATA->FVEC for better memory
3753 consumption. */
3754 if (state->threaded)
3755 pfvec = NULL;
3756 else
3757 pfvec = &ddata->fvec;
3758 read_function_info (state, ddata, &lhdr, error_callback, data,
3759 entry->u, pfvec, &function_addrs,
3760 &function_addrs_count);
3761 free_line_header (state, &lhdr, error_callback, data);
3762 new_data = 1;
3765 /* Atomically store the information we just read into the unit.
3766 If another thread is simultaneously writing, it presumably
3767 read the same information, and we don't care which one we
3768 wind up with; we just leak the other one. We do have to
3769 write the lines field last, so that the acquire-loads above
3770 ensure that the other fields are set. */
3772 if (!state->threaded)
3774 u->lines_count = count;
3775 u->function_addrs = function_addrs;
3776 u->function_addrs_count = function_addrs_count;
3777 u->lines = lines;
3779 else
3781 backtrace_atomic_store_size_t (&u->lines_count, count);
3782 backtrace_atomic_store_pointer (&u->function_addrs, function_addrs);
3783 backtrace_atomic_store_size_t (&u->function_addrs_count,
3784 function_addrs_count);
3785 backtrace_atomic_store_pointer (&u->lines, lines);
3789 /* Now all fields of U have been initialized. */
3791 if (lines == (struct line *) (uintptr_t) -1)
3793 /* If reading the line number information failed in some way,
3794 try again to see if there is a better compilation unit for
3795 this PC. */
3796 if (new_data)
3797 return dwarf_lookup_pc (state, ddata, pc, callback, error_callback,
3798 data, found);
3799 return callback (data, pc, NULL, 0, NULL);
3802 /* Search for PC within this unit. */
3804 ln = (struct line *) bsearch (&pc, lines, entry->u->lines_count,
3805 sizeof (struct line), line_search);
3806 if (ln == NULL)
3808 /* The PC is between the low_pc and high_pc attributes of the
3809 compilation unit, but no entry in the line table covers it.
3810 This implies that the start of the compilation unit has no
3811 line number information. */
3813 if (entry->u->abs_filename == NULL)
3815 const char *filename;
3817 filename = entry->u->filename;
3818 if (filename != NULL
3819 && !IS_ABSOLUTE_PATH (filename)
3820 && entry->u->comp_dir != NULL)
3822 size_t filename_len;
3823 const char *dir;
3824 size_t dir_len;
3825 char *s;
3827 filename_len = strlen (filename);
3828 dir = entry->u->comp_dir;
3829 dir_len = strlen (dir);
3830 s = (char *) backtrace_alloc (state, dir_len + filename_len + 2,
3831 error_callback, data);
3832 if (s == NULL)
3834 *found = 0;
3835 return 0;
3837 memcpy (s, dir, dir_len);
3838 /* FIXME: Should use backslash if DOS file system. */
3839 s[dir_len] = '/';
3840 memcpy (s + dir_len + 1, filename, filename_len + 1);
3841 filename = s;
3843 entry->u->abs_filename = filename;
3846 return callback (data, pc, entry->u->abs_filename, 0, NULL);
3849 /* Search for function name within this unit. */
3851 if (entry->u->function_addrs_count == 0)
3852 return callback (data, pc, ln->filename, ln->lineno, NULL);
3854 p = ((struct function_addrs *)
3855 bsearch (&pc, entry->u->function_addrs,
3856 entry->u->function_addrs_count,
3857 sizeof (struct function_addrs),
3858 function_addrs_search));
3859 if (p == NULL)
3860 return callback (data, pc, ln->filename, ln->lineno, NULL);
3862 /* Here pc >= p->low && pc < (p + 1)->low. The function_addrs are
3863 sorted by low, so if pc > p->low we are at the end of a range of
3864 function_addrs with the same low value. If pc == p->low walk
3865 forward to the end of the range with that low value. Then walk
3866 backward and use the first range that includes pc. */
3867 while (pc == (p + 1)->low)
3868 ++p;
3869 fmatch = NULL;
3870 while (1)
3872 if (pc < p->high)
3874 fmatch = p;
3875 break;
3877 if (p == entry->u->function_addrs)
3878 break;
3879 if ((p - 1)->low < p->low)
3880 break;
3881 --p;
3883 if (fmatch == NULL)
3884 return callback (data, pc, ln->filename, ln->lineno, NULL);
3886 function = fmatch->function;
3888 filename = ln->filename;
3889 lineno = ln->lineno;
3891 ret = report_inlined_functions (pc, function, callback, data,
3892 &filename, &lineno);
3893 if (ret != 0)
3894 return ret;
3896 return callback (data, pc, filename, lineno, function->name);
3900 /* Return the file/line information for a PC using the DWARF mapping
3901 we built earlier. */
3903 static int
3904 dwarf_fileline (struct backtrace_state *state, uintptr_t pc,
3905 backtrace_full_callback callback,
3906 backtrace_error_callback error_callback, void *data)
3908 struct dwarf_data *ddata;
3909 int found;
3910 int ret;
3912 if (!state->threaded)
3914 for (ddata = (struct dwarf_data *) state->fileline_data;
3915 ddata != NULL;
3916 ddata = ddata->next)
3918 ret = dwarf_lookup_pc (state, ddata, pc, callback, error_callback,
3919 data, &found);
3920 if (ret != 0 || found)
3921 return ret;
3924 else
3926 struct dwarf_data **pp;
3928 pp = (struct dwarf_data **) (void *) &state->fileline_data;
3929 while (1)
3931 ddata = backtrace_atomic_load_pointer (pp);
3932 if (ddata == NULL)
3933 break;
3935 ret = dwarf_lookup_pc (state, ddata, pc, callback, error_callback,
3936 data, &found);
3937 if (ret != 0 || found)
3938 return ret;
3940 pp = &ddata->next;
3944 /* FIXME: See if any libraries have been dlopen'ed. */
3946 return callback (data, pc, NULL, 0, NULL);
3949 /* Initialize our data structures from the DWARF debug info for a
3950 file. Return NULL on failure. */
3952 static struct dwarf_data *
3953 build_dwarf_data (struct backtrace_state *state,
3954 uintptr_t base_address,
3955 const struct dwarf_sections *dwarf_sections,
3956 int is_bigendian,
3957 struct dwarf_data *altlink,
3958 backtrace_error_callback error_callback,
3959 void *data)
3961 struct unit_addrs_vector addrs_vec;
3962 struct unit_addrs *addrs;
3963 size_t addrs_count;
3964 struct unit_vector units_vec;
3965 struct unit **units;
3966 size_t units_count;
3967 struct dwarf_data *fdata;
3969 if (!build_address_map (state, base_address, dwarf_sections, is_bigendian,
3970 altlink, error_callback, data, &addrs_vec,
3971 &units_vec))
3972 return NULL;
3974 if (!backtrace_vector_release (state, &addrs_vec.vec, error_callback, data))
3975 return NULL;
3976 if (!backtrace_vector_release (state, &units_vec.vec, error_callback, data))
3977 return NULL;
3978 addrs = (struct unit_addrs *) addrs_vec.vec.base;
3979 units = (struct unit **) units_vec.vec.base;
3980 addrs_count = addrs_vec.count;
3981 units_count = units_vec.count;
3982 backtrace_qsort (addrs, addrs_count, sizeof (struct unit_addrs),
3983 unit_addrs_compare);
3984 /* No qsort for units required, already sorted. */
3986 fdata = ((struct dwarf_data *)
3987 backtrace_alloc (state, sizeof (struct dwarf_data),
3988 error_callback, data));
3989 if (fdata == NULL)
3990 return NULL;
3992 fdata->next = NULL;
3993 fdata->altlink = altlink;
3994 fdata->base_address = base_address;
3995 fdata->addrs = addrs;
3996 fdata->addrs_count = addrs_count;
3997 fdata->units = units;
3998 fdata->units_count = units_count;
3999 fdata->dwarf_sections = *dwarf_sections;
4000 fdata->is_bigendian = is_bigendian;
4001 memset (&fdata->fvec, 0, sizeof fdata->fvec);
4003 return fdata;
4006 /* Build our data structures from the DWARF sections for a module.
4007 Set FILELINE_FN and STATE->FILELINE_DATA. Return 1 on success, 0
4008 on failure. */
4011 backtrace_dwarf_add (struct backtrace_state *state,
4012 uintptr_t base_address,
4013 const struct dwarf_sections *dwarf_sections,
4014 int is_bigendian,
4015 struct dwarf_data *fileline_altlink,
4016 backtrace_error_callback error_callback,
4017 void *data, fileline *fileline_fn,
4018 struct dwarf_data **fileline_entry)
4020 struct dwarf_data *fdata;
4022 fdata = build_dwarf_data (state, base_address, dwarf_sections, is_bigendian,
4023 fileline_altlink, error_callback, data);
4024 if (fdata == NULL)
4025 return 0;
4027 if (fileline_entry != NULL)
4028 *fileline_entry = fdata;
4030 if (!state->threaded)
4032 struct dwarf_data **pp;
4034 for (pp = (struct dwarf_data **) (void *) &state->fileline_data;
4035 *pp != NULL;
4036 pp = &(*pp)->next)
4038 *pp = fdata;
4040 else
4042 while (1)
4044 struct dwarf_data **pp;
4046 pp = (struct dwarf_data **) (void *) &state->fileline_data;
4048 while (1)
4050 struct dwarf_data *p;
4052 p = backtrace_atomic_load_pointer (pp);
4054 if (p == NULL)
4055 break;
4057 pp = &p->next;
4060 if (__sync_bool_compare_and_swap (pp, NULL, fdata))
4061 break;
4065 *fileline_fn = dwarf_fileline;
4067 return 1;