2 * Copyright (c) 2009 Kai Wang
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/param.h>
42 ELFTC_VCSID("$Id: addr2line.c 3197 2015-05-12 21:01:31Z emaste $");
44 static struct option longopts[] = {
45 {"target" , required_argument, NULL, 'b'},
46 {"demangle", no_argument, NULL, 'C'},
47 {"exe", required_argument, NULL, 'e'},
48 {"functions", no_argument, NULL, 'f'},
49 {"section", required_argument, NULL, 'j'},
50 {"basename", no_argument, NULL, 's'},
51 {"help", no_argument, NULL, 'H'},
52 {"version", no_argument, NULL, 'V'},
55 static int demangle, func, base;
56 static char unknown[] = { '?', '?', '\0' };
57 static Dwarf_Addr section_base;
59 #define USAGE_MESSAGE "\
60 Usage: %s [options] hexaddress...\n\
61 Map program addresses to source file names and line numbers.\n\n\
63 -b TGT | --target=TGT (Accepted but ignored).\n\
64 -e EXE | --exec=EXE Use program \"EXE\" to translate addresses.\n\
65 -f | --functions Display function names.\n\
66 -j NAME | --section=NAME Values are offsets into section \"NAME\".\n\
67 -s | --basename Only show the base name for each file name.\n\
68 -C | --demangle Demangle C++ names.\n\
69 -H | --help Print a help message.\n\
70 -V | --version Print a version identifier and exit.\n"
75 (void) fprintf(stderr, USAGE_MESSAGE, ELFTC_GETPROGNAME());
83 fprintf(stderr, "%s (%s)\n", ELFTC_GETPROGNAME(), elftc_version());
88 * Handle DWARF 4 'offset from' DW_AT_high_pc. Although we don't
89 * fully support DWARF 4, some compilers (like FreeBSD Clang 3.5.1)
90 * generate DW_AT_high_pc as an offset from DW_AT_low_pc.
92 * "If the value of the DW_AT_high_pc is of class address, it is the
93 * relocated address of the first location past the last instruction
94 * associated with the entity; if it is of class constant, the value
95 * is an unsigned integer offset which when added to the low PC gives
96 * the address of the first location past the last instruction
97 * associated with the entity."
99 * DWARF4 spec, section 2.17.2.
102 handle_high_pc(Dwarf_Die die, Dwarf_Unsigned lopc, Dwarf_Unsigned *hipc)
109 ret = dwarf_attr(die, DW_AT_high_pc, &at, &de);
110 if (ret == DW_DLV_ERROR) {
111 warnx("dwarf_attr failed: %s", dwarf_errmsg(de));
114 ret = dwarf_whatform(at, &form, &de);
115 if (ret == DW_DLV_ERROR) {
116 warnx("dwarf_whatform failed: %s", dwarf_errmsg(de));
119 if (dwarf_get_form_class(2, 0, 0, form) == DW_FORM_CLASS_CONSTANT)
126 search_func(Dwarf_Debug dbg, Dwarf_Die die, Dwarf_Addr addr,
127 const char **rlt_func)
129 Dwarf_Die ret_die, spec_die;
132 Dwarf_Unsigned lopc, hipc;
134 Dwarf_Attribute sub_at, spec_at;
138 if (*rlt_func != NULL)
141 if (dwarf_tag(die, &tag, &de)) {
142 warnx("dwarf_tag: %s", dwarf_errmsg(de));
145 if (tag == DW_TAG_subprogram) {
146 if (dwarf_attrval_unsigned(die, DW_AT_low_pc, &lopc, &de) ||
147 dwarf_attrval_unsigned(die, DW_AT_high_pc, &hipc, &de))
149 if (handle_high_pc(die, lopc, &hipc) != DW_DLV_OK)
151 if (addr < lopc || addr >= hipc)
157 ret = dwarf_attr(die, DW_AT_name, &sub_at, &de);
158 if (ret == DW_DLV_ERROR)
160 if (ret == DW_DLV_OK) {
161 if (dwarf_formstring(sub_at, &func0, &de))
169 * If DW_AT_name is not present, but DW_AT_specification is
170 * present, then probably the actual name is in the DIE
171 * referenced by DW_AT_specification.
173 if (dwarf_attr(die, DW_AT_specification, &spec_at, &de))
175 if (dwarf_global_formref(spec_at, &ref, &de))
177 if (dwarf_offdie(dbg, ref, &spec_die, &de))
179 if (dwarf_attrval_string(spec_die, DW_AT_name, rlt_func, &de))
187 /* Search children. */
188 ret = dwarf_child(die, &ret_die, &de);
189 if (ret == DW_DLV_ERROR)
190 errx(EXIT_FAILURE, "dwarf_child: %s", dwarf_errmsg(de));
191 else if (ret == DW_DLV_OK)
192 search_func(dbg, ret_die, addr, rlt_func);
194 /* Search sibling. */
195 ret = dwarf_siblingof(dbg, die, &ret_die, &de);
196 if (ret == DW_DLV_ERROR)
197 errx(EXIT_FAILURE, "dwarf_siblingof: %s", dwarf_errmsg(de));
198 else if (ret == DW_DLV_OK)
199 search_func(dbg, ret_die, addr, rlt_func);
203 translate(Dwarf_Debug dbg, const char* addrstr)
209 Dwarf_Unsigned lopc, hipc, addr, lineno, plineno;
211 Dwarf_Addr lineaddr, plineaddr;
212 const char *funcname;
213 char *file, *file0, *pfile;
214 char demangled[1024];
217 addr = strtoull(addrstr, NULL, 16);
218 addr += section_base;
222 while ((ret = dwarf_next_cu_header(dbg, NULL, NULL, NULL, NULL, NULL,
223 &de)) == DW_DLV_OK) {
225 while (dwarf_siblingof(dbg, die, &die, &de) == DW_DLV_OK) {
226 if (dwarf_tag(die, &tag, &de) != DW_DLV_OK) {
227 warnx("dwarf_tag failed: %s",
231 /* XXX: What about DW_TAG_partial_unit? */
232 if (tag == DW_TAG_compile_unit)
236 warnx("could not find DW_TAG_compile_unit die");
239 if (!dwarf_attrval_unsigned(die, DW_AT_low_pc, &lopc, &de) &&
240 !dwarf_attrval_unsigned(die, DW_AT_high_pc, &hipc, &de)) {
242 * Check if the address falls into the PC range of
245 if (handle_high_pc(die, lopc, &hipc) != DW_DLV_OK)
247 if (addr < lopc || addr >= hipc)
251 if (dwarf_srclines(die, &lbuf, &lcount, &de) != DW_DLV_OK) {
252 warnx("dwarf_srclines: %s", dwarf_errmsg(de));
259 for (i = 0; i < lcount; i++) {
260 if (dwarf_lineaddr(lbuf[i], &lineaddr, &de)) {
261 warnx("dwarf_lineaddr: %s",
265 if (dwarf_lineno(lbuf[i], &lineno, &de)) {
266 warnx("dwarf_lineno: %s",
270 if (dwarf_linesrc(lbuf[i], &file0, &de)) {
271 warnx("dwarf_linesrc: %s",
275 if (addr == lineaddr)
277 else if (addr < lineaddr && addr > plineaddr) {
282 plineaddr = lineaddr;
290 if (ret == DW_DLV_OK && func)
291 search_func(dbg, die, addr, &funcname);
294 if (funcname == NULL)
297 !elftc_demangle(funcname, demangled, sizeof(demangled), 0))
298 printf("%s\n", demangled);
300 printf("%s\n", funcname);
303 (void) printf("%s:%ju\n", base ? basename(file) : file, lineno);
306 * Reset internal CU pointer, so we will start from the first CU
309 while (ret != DW_DLV_NO_ENTRY) {
310 if (ret == DW_DLV_ERROR)
311 errx(EXIT_FAILURE, "dwarf_next_cu_header: %s",
313 ret = dwarf_next_cu_header(dbg, NULL, NULL, NULL, NULL, NULL,
319 find_section_base(const char *exe, Elf *e, const char *section)
329 if (gelf_getehdr(e, &eh) != &eh) {
330 warnx("gelf_getehdr failed: %s", elf_errmsg(-1));
334 if (!elf_getshstrndx(e, &shstrndx)) {
335 warnx("elf_getshstrndx failed: %s", elf_errmsg(-1));
342 while ((scn = elf_nextscn(e, scn)) != NULL) {
343 if (gelf_getshdr(scn, &sh) == NULL) {
344 warnx("gelf_getshdr failed: %s", elf_errmsg(-1));
347 if ((name = elf_strptr(e, shstrndx, sh.sh_name)) == NULL)
349 if (!strcmp(section, name)) {
350 if (eh.e_type == ET_EXEC || eh.e_type == ET_DYN) {
352 * For executables, section base is the virtual
353 * address of the specified section.
355 section_base = sh.sh_addr;
356 } else if (eh.e_type == ET_REL) {
358 * For relocatables, section base is the
359 * relative offset of the specified section
360 * to the start of the first section.
364 warnx("unknown e_type %u", eh.e_type);
370 elferr = elf_errno();
372 warnx("elf_nextscn failed: %s", elf_errmsg(elferr));
374 errx(EXIT_FAILURE, "%s: cannot find section %s", exe, section);
378 main(int argc, char **argv)
383 const char *exe, *section;
389 while ((opt = getopt_long(argc, argv, "b:Ce:fj:sHV", longopts, NULL)) !=
425 if ((fd = open(exe, O_RDONLY)) < 0)
426 err(EXIT_FAILURE, "%s", exe);
428 if (dwarf_init(fd, DW_DLC_READ, NULL, NULL, &dbg, &de))
429 errx(EXIT_FAILURE, "dwarf_init: %s", dwarf_errmsg(de));
431 if (dwarf_get_elf(dbg, &e, &de) != DW_DLV_OK)
432 errx(EXIT_FAILURE, "dwarf_get_elf: %s", dwarf_errmsg(de));
435 find_section_base(exe, e, section);
440 for (i = 0; i < argc; i++)
441 translate(dbg, argv[i]);
443 while (fgets(line, sizeof(line), stdin) != NULL) {
444 translate(dbg, line);
448 dwarf_finish(dbg, &de);