1 /*- 2 * Copyright (c) 2007 Hyogeol Lee <hyogeollee@gmail.com> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer 10 * in this position and unchanged. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 */ 26 27 #include <sys/queue.h> 28 #include <sys/types.h> 29 #include <sys/stat.h> 30 #include <ar.h> 31 #include <assert.h> 32 #include <ctype.h> 33 #include <dwarf.h> 34 #include <err.h> 35 #include <errno.h> 36 #include <fcntl.h> 37 #include <gelf.h> 38 #include <getopt.h> 39 #include <inttypes.h> 40 #include <libdwarf.h> 41 #include <libelftc.h> 42 #include <stdbool.h> 43 #include <stdio.h> 44 #include <stdlib.h> 45 #include <string.h> 46 #include <strings.h> 47 #include <unistd.h> 48 49 #include "_elftc.h" 50 51 ELFTC_VCSID("$Id: nm.c 3124 2014-12-21 05:46:28Z kaiwang27 $"); 52 53 /* symbol information list */ 54 STAILQ_HEAD(sym_head, sym_entry); 55 56 struct sym_entry { 57 char *name; 58 GElf_Sym *sym; 59 STAILQ_ENTRY(sym_entry) sym_entries; 60 }; 61 62 typedef int (*fn_sort)(const void *, const void *); 63 typedef void (*fn_elem_print)(char, const char *, const GElf_Sym *, const char *); 64 typedef void (*fn_sym_print)(const GElf_Sym *); 65 typedef int (*fn_filter)(char, const GElf_Sym *, const char *); 66 67 /* output filter list */ 68 static SLIST_HEAD(filter_head, filter_entry) nm_out_filter = 69 SLIST_HEAD_INITIALIZER(nm_out_filter); 70 71 struct filter_entry { 72 fn_filter fn; 73 SLIST_ENTRY(filter_entry) filter_entries; 74 }; 75 76 struct sym_print_data { 77 struct sym_head *headp; 78 size_t sh_num, list_num; 79 const char *t_table, **s_table, *filename, *objname; 80 }; 81 82 struct nm_prog_info { 83 const char *name; 84 const char *def_filename; 85 }; 86 87 /* List for line number information. */ 88 struct line_info_entry { 89 uint64_t addr; /* address */ 90 uint64_t line; /* line number */ 91 char *file; /* file name with path */ 92 SLIST_ENTRY(line_info_entry) entries; 93 }; 94 SLIST_HEAD(line_info_head, line_info_entry); 95 96 /* List for function line number information. */ 97 struct func_info_entry { 98 char *name; /* function name */ 99 char *file; /* file name with path */ 100 uint64_t lowpc; /* low address */ 101 uint64_t highpc; /* high address */ 102 uint64_t line; /* line number */ 103 SLIST_ENTRY(func_info_entry) entries; 104 }; 105 SLIST_HEAD(func_info_head, func_info_entry); 106 107 /* List for variable line number information. */ 108 struct var_info_entry { 109 char *name; /* variable name */ 110 char *file; /* file name with path */ 111 uint64_t addr; /* address */ 112 uint64_t line; /* line number */ 113 SLIST_ENTRY(var_info_entry) entries; 114 }; 115 SLIST_HEAD(var_info_head, var_info_entry); 116 117 /* output numric type */ 118 enum radix { 119 RADIX_OCT, 120 RADIX_HEX, 121 RADIX_DEC 122 }; 123 124 /* output symbol type, PRINT_SYM_DYN for dynamic symbol only */ 125 enum print_symbol { 126 PRINT_SYM_SYM, 127 PRINT_SYM_DYN 128 }; 129 130 /* output name type */ 131 enum print_name { 132 PRINT_NAME_NONE, 133 PRINT_NAME_FULL, 134 PRINT_NAME_MULTI 135 }; 136 137 struct nm_prog_options { 138 enum print_symbol print_symbol; 139 enum print_name print_name; 140 enum radix t; 141 int demangle_type; 142 bool print_debug; 143 bool print_armap; 144 int print_size; 145 bool debug_line; 146 int def_only; 147 bool undef_only; 148 int sort_size; 149 bool sort_reverse; 150 int no_demangle; 151 152 /* 153 * function pointer to sort symbol list. 154 * possible function - cmp_name, cmp_none, cmp_size, cmp_value 155 */ 156 fn_sort sort_fn; 157 158 /* 159 * function pointer to print symbol elem. 160 * possible function - sym_elem_print_all 161 * sym_elem_print_all_portable 162 * sym_elem_print_all_sysv 163 */ 164 fn_elem_print elem_print_fn; 165 166 fn_sym_print value_print_fn; 167 fn_sym_print size_print_fn; 168 }; 169 170 #define CHECK_SYM_PRINT_DATA(p) (p->headp == NULL || p->sh_num == 0 || \ 171 p->t_table == NULL || p->s_table == NULL || p->filename == NULL) 172 #define IS_SYM_TYPE(t) ((t) == '?' || isalpha((t)) != 0) 173 #define IS_UNDEF_SYM_TYPE(t) ((t) == 'U' || (t) == 'v' || (t) == 'w') 174 #define UNUSED(p) ((void)p) 175 176 static int cmp_name(const void *, const void *); 177 static int cmp_none(const void *, const void *); 178 static int cmp_size(const void *, const void *); 179 static int cmp_value(const void *, const void *); 180 static void filter_dest(void); 181 static int filter_insert(fn_filter); 182 static void get_opt(int, char **); 183 static int get_sym(Elf *, struct sym_head *, int, size_t, size_t, 184 const char *, const char **, int); 185 static const char * get_sym_name(Elf *, const GElf_Sym *, size_t, 186 const char **, int); 187 static char get_sym_type(const GElf_Sym *, const char *); 188 static void global_dest(void); 189 static void global_init(void); 190 static bool is_sec_data(GElf_Shdr *); 191 static bool is_sec_debug(const char *); 192 static bool is_sec_nobits(GElf_Shdr *); 193 static bool is_sec_readonly(GElf_Shdr *); 194 static bool is_sec_text(GElf_Shdr *); 195 static void print_ar_index(int, Elf *); 196 static void print_header(const char *, const char *); 197 static void print_version(void); 198 static int read_elf(Elf *, const char *, Elf_Kind); 199 static int read_object(const char *); 200 static int read_files(int, char **); 201 static void set_opt_value_print_fn(enum radix); 202 static int sym_elem_def(char, const GElf_Sym *, const char *); 203 static int sym_elem_global(char, const GElf_Sym *, const char *); 204 static int sym_elem_global_static(char, const GElf_Sym *, 205 const char *); 206 static int sym_elem_nondebug(char, const GElf_Sym *, const char *); 207 static int sym_elem_nonzero_size(char, const GElf_Sym *, 208 const char *); 209 static void sym_elem_print_all(char, const char *, 210 const GElf_Sym *, const char *); 211 static void sym_elem_print_all_portable(char, const char *, 212 const GElf_Sym *, const char *); 213 static void sym_elem_print_all_sysv(char, const char *, 214 const GElf_Sym *, const char *); 215 static int sym_elem_undef(char, const GElf_Sym *, const char *); 216 static void sym_list_dest(struct sym_head *); 217 static int sym_list_insert(struct sym_head *, const char *, 218 const GElf_Sym *); 219 static void sym_list_print(struct sym_print_data *, 220 struct func_info_head *, struct var_info_head *, 221 struct line_info_head *); 222 static void sym_list_print_each(struct sym_entry *, 223 struct sym_print_data *, struct func_info_head *, 224 struct var_info_head *, struct line_info_head *); 225 static struct sym_entry *sym_list_sort(struct sym_print_data *); 226 static void sym_size_oct_print(const GElf_Sym *); 227 static void sym_size_hex_print(const GElf_Sym *); 228 static void sym_size_dec_print(const GElf_Sym *); 229 static void sym_value_oct_print(const GElf_Sym *); 230 static void sym_value_hex_print(const GElf_Sym *); 231 static void sym_value_dec_print(const GElf_Sym *); 232 static void usage(int); 233 234 static struct nm_prog_info nm_info; 235 static struct nm_prog_options nm_opts; 236 static int nm_elfclass; 237 238 /* 239 * Point to current sym_print_data to use portable qsort function. 240 * (e.g. There is no qsort_r function in NetBSD.) 241 * 242 * Using in sym_list_sort. 243 */ 244 static struct sym_print_data *nm_print_data; 245 246 static const struct option nm_longopts[] = { 247 { "debug-syms", no_argument, NULL, 'a' }, 248 { "defined-only", no_argument, &nm_opts.def_only, 1}, 249 { "demangle", optional_argument, NULL, 'C' }, 250 { "dynamic", no_argument, NULL, 'D' }, 251 { "extern-only", no_argument, NULL, 'g' }, 252 { "format", required_argument, NULL, 'F' }, 253 { "help", no_argument, NULL, 'h' }, 254 { "line-numbers", no_argument, NULL, 'l' }, 255 { "no-demangle", no_argument, &nm_opts.no_demangle, 256 1}, 257 { "no-sort", no_argument, NULL, 'p' }, 258 { "numeric-sort", no_argument, NULL, 'v' }, 259 { "print-armap", no_argument, NULL, 's' }, 260 { "print-file-name", no_argument, NULL, 'A' }, 261 { "print-size", no_argument, NULL, 'S' }, 262 { "radix", required_argument, NULL, 't' }, 263 { "reverse-sort", no_argument, NULL, 'r' }, 264 { "size-sort", no_argument, &nm_opts.sort_size, 1}, 265 { "undefined-only", no_argument, NULL, 'u' }, 266 { "version", no_argument, NULL, 'V' }, 267 { NULL, 0, NULL, 0 } 268 }; 269 270 #if defined(ELFTC_NEED_BYTEORDER_EXTENSIONS) 271 static __inline uint32_t 272 be32dec(const void *pp) 273 { 274 unsigned char const *p = (unsigned char const *)pp; 275 276 return ((p[0] << 24) | (p[1] << 16) | (p[2] << 8) | p[3]); 277 } 278 279 static __inline uint32_t 280 le32dec(const void *pp) 281 { 282 unsigned char const *p = (unsigned char const *)pp; 283 284 return ((p[3] << 24) | (p[2] << 16) | (p[1] << 8) | p[0]); 285 } 286 287 static __inline uint64_t 288 be64dec(const void *pp) 289 { 290 unsigned char const *p = (unsigned char const *)pp; 291 292 return (((uint64_t)be32dec(p) << 32) | be32dec(p + 4)); 293 } 294 295 static __inline uint64_t 296 le64dec(const void *pp) 297 { 298 unsigned char const *p = (unsigned char const *)pp; 299 300 return (((uint64_t)le32dec(p + 4) << 32) | le32dec(p)); 301 } 302 #endif 303 304 static int 305 cmp_name(const void *l, const void *r) 306 { 307 308 assert(l != NULL); 309 assert(r != NULL); 310 assert(((const struct sym_entry *)l)->name != NULL); 311 assert(((const struct sym_entry *)r)->name != NULL); 312 313 return (strcmp(((const struct sym_entry *)l)->name, 314 ((const struct sym_entry *)r)->name)); 315 } 316 317 static int 318 cmp_none(const void *l, const void *r) 319 { 320 321 UNUSED(l); 322 UNUSED(r); 323 324 return (0); 325 } 326 327 /* Size comparison. If l and r have same size, compare their name. */ 328 static int 329 cmp_size(const void *lp, const void *rp) 330 { 331 const struct sym_entry *l, *r; 332 333 l = lp; 334 r = rp; 335 336 assert(l != NULL); 337 assert(l->name != NULL); 338 assert(l->sym != NULL); 339 assert(r != NULL); 340 assert(r->name != NULL); 341 assert(r->sym != NULL); 342 343 if (l->sym->st_size == r->sym->st_size) 344 return (strcmp(l->name, r->name)); 345 346 return (l->sym->st_size - r->sym->st_size); 347 } 348 349 /* Value comparison. Undefined symbols come first. */ 350 static int 351 cmp_value(const void *lp, const void *rp) 352 { 353 const struct sym_entry *l, *r; 354 const char *ttable; 355 int l_is_undef, r_is_undef; 356 357 l = lp; 358 r = rp; 359 360 assert(nm_print_data != NULL); 361 ttable = nm_print_data->t_table; 362 363 assert(l != NULL); 364 assert(l->name != NULL); 365 assert(l->sym != NULL); 366 assert(r != NULL); 367 assert(r->name != NULL); 368 assert(r->sym != NULL); 369 assert(ttable != NULL); 370 371 l_is_undef = IS_UNDEF_SYM_TYPE(get_sym_type(l->sym, ttable)) ? 1 : 0; 372 r_is_undef = IS_UNDEF_SYM_TYPE(get_sym_type(r->sym, ttable)) ? 1 : 0; 373 374 assert(l_is_undef + r_is_undef >= 0); 375 assert(l_is_undef + r_is_undef <= 2); 376 377 switch (l_is_undef + r_is_undef) { 378 case 0: 379 /* Both defined */ 380 if (l->sym->st_value == r->sym->st_value) 381 return (strcmp(l->name, r->name)); 382 return (l->sym->st_value - r->sym->st_value); 383 case 1: 384 /* One undefined */ 385 return (l_is_undef == 0 ? 1 : -1); 386 case 2: 387 /* Both undefined */ 388 return (strcmp(l->name, r->name)); 389 } 390 /* NOTREACHED */ 391 392 return (l->sym->st_value - r->sym->st_value); 393 } 394 395 static void 396 filter_dest(void) 397 { 398 struct filter_entry *e; 399 400 while (!SLIST_EMPTY(&nm_out_filter)) { 401 e = SLIST_FIRST(&nm_out_filter); 402 SLIST_REMOVE_HEAD(&nm_out_filter, filter_entries); 403 free(e); 404 } 405 } 406 407 static int 408 filter_insert(fn_filter filter_fn) 409 { 410 struct filter_entry *e; 411 412 assert(filter_fn != NULL); 413 414 if ((e = malloc(sizeof(struct filter_entry))) == NULL) { 415 warn("malloc"); 416 return (0); 417 } 418 e->fn = filter_fn; 419 SLIST_INSERT_HEAD(&nm_out_filter, e, filter_entries); 420 421 return (1); 422 } 423 424 static int 425 parse_demangle_option(const char *opt) 426 { 427 428 if (opt == NULL) 429 return (ELFTC_DEM_UNKNOWN); 430 else if (!strncasecmp(opt, "gnu-v2", 6)) 431 return (ELFTC_DEM_GNU2); 432 else if (!strncasecmp(opt, "gnu-v3", 6)) 433 return (ELFTC_DEM_GNU3); 434 else if (!strncasecmp(opt, "arm", 3)) 435 return (ELFTC_DEM_ARM); 436 else 437 errx(EXIT_FAILURE, "unknown demangling style '%s'", opt); 438 439 /* NOTREACHED */ 440 return (0); 441 } 442 443 static void 444 get_opt(int argc, char **argv) 445 { 446 int ch; 447 bool is_posix, oflag; 448 449 if (argc <= 0 || argv == NULL) 450 return; 451 452 oflag = is_posix = false; 453 nm_opts.t = RADIX_HEX; 454 while ((ch = getopt_long(argc, argv, "ABCDF:PSVaefghlnoprst:uvx", 455 nm_longopts, NULL)) != -1) { 456 switch (ch) { 457 case 'A': 458 nm_opts.print_name = PRINT_NAME_FULL; 459 break; 460 case 'B': 461 nm_opts.elem_print_fn = &sym_elem_print_all; 462 break; 463 case 'C': 464 nm_opts.demangle_type = parse_demangle_option(optarg); 465 break; 466 case 'D': 467 nm_opts.print_symbol = PRINT_SYM_DYN; 468 break; 469 case 'F': 470 /* sysv, bsd, posix */ 471 switch (optarg[0]) { 472 case 'B': 473 case 'b': 474 nm_opts.elem_print_fn = &sym_elem_print_all; 475 break; 476 case 'P': 477 case 'p': 478 is_posix = true; 479 nm_opts.elem_print_fn = 480 &sym_elem_print_all_portable; 481 break; 482 case 'S': 483 case 's': 484 nm_opts.elem_print_fn = 485 &sym_elem_print_all_sysv; 486 break; 487 default: 488 warnx("%s: Invalid format", optarg); 489 usage(1); 490 } 491 492 break; 493 case 'P': 494 is_posix = true; 495 nm_opts.elem_print_fn = &sym_elem_print_all_portable; 496 break; 497 case 'S': 498 nm_opts.print_size = 1; 499 break; 500 case 'V': 501 print_version(); 502 /* NOTREACHED */ 503 case 'a': 504 nm_opts.print_debug = true; 505 break; 506 case 'e': 507 filter_insert(sym_elem_global_static); 508 break; 509 case 'f': 510 break; 511 case 'g': 512 filter_insert(sym_elem_global); 513 break; 514 case 'h': 515 usage(0); 516 break; 517 case 'l': 518 nm_opts.debug_line = true; 519 break; 520 case 'n': 521 case 'v': 522 nm_opts.sort_fn = &cmp_value; 523 break; 524 case 'o': 525 oflag = true; 526 break; 527 case 'p': 528 nm_opts.sort_fn = &cmp_none; 529 break; 530 case 'r': 531 nm_opts.sort_reverse = true; 532 break; 533 case 's': 534 nm_opts.print_armap = true; 535 break; 536 case 't': 537 /* t require always argument to getopt_long */ 538 switch (optarg[0]) { 539 case 'd': 540 nm_opts.t = RADIX_DEC; 541 break; 542 case 'o': 543 nm_opts.t = RADIX_OCT; 544 break; 545 case 'x': 546 nm_opts.t = RADIX_HEX; 547 break; 548 default: 549 warnx("%s: Invalid radix", optarg); 550 usage(1); 551 } 552 break; 553 case 'u': 554 filter_insert(sym_elem_undef); 555 nm_opts.undef_only = true; 556 break; 557 /* case 'v': see case 'n' above. */ 558 case 'x': 559 nm_opts.t = RADIX_HEX; 560 break; 561 case 0: 562 if (nm_opts.sort_size != 0) { 563 nm_opts.sort_fn = &cmp_size; 564 filter_insert(sym_elem_def); 565 filter_insert(sym_elem_nonzero_size); 566 } 567 if (nm_opts.def_only != 0) 568 filter_insert(sym_elem_def); 569 if (nm_opts.no_demangle != 0) 570 nm_opts.demangle_type = -1; 571 break; 572 default : 573 usage(1); 574 } 575 } 576 577 /* 578 * In POSIX mode, the '-o' option controls the output radix. 579 * In non-POSIX mode, the option is a synonym for the '-A' and 580 * '--print-file-name' options. 581 */ 582 if (oflag) { 583 if (is_posix) 584 nm_opts.t = RADIX_OCT; 585 else 586 nm_opts.print_name = PRINT_NAME_FULL; 587 } 588 589 assert(nm_opts.sort_fn != NULL && "nm_opts.sort_fn is null"); 590 assert(nm_opts.elem_print_fn != NULL && 591 "nm_opts.elem_print_fn is null"); 592 assert(nm_opts.value_print_fn != NULL && 593 "nm_opts.value_print_fn is null"); 594 595 set_opt_value_print_fn(nm_opts.t); 596 597 if (nm_opts.undef_only == true) { 598 if (nm_opts.sort_fn == &cmp_size) 599 errx(EXIT_FAILURE, 600 "--size-sort with -u is meaningless"); 601 if (nm_opts.def_only != 0) 602 errx(EXIT_FAILURE, 603 "-u with --defined-only is meaningless"); 604 } 605 if (nm_opts.print_debug == false) 606 filter_insert(sym_elem_nondebug); 607 if (nm_opts.sort_reverse == true && nm_opts.sort_fn == cmp_none) 608 nm_opts.sort_reverse = false; 609 } 610 611 /* 612 * Get symbol information from elf. 613 */ 614 static int 615 get_sym(Elf *elf, struct sym_head *headp, int shnum, size_t dynndx, 616 size_t strndx, const char *type_table, const char **sec_table, 617 int sec_table_size) 618 { 619 Elf_Scn *scn; 620 Elf_Data *data; 621 GElf_Shdr shdr; 622 GElf_Sym sym; 623 struct filter_entry *fep; 624 size_t ndx; 625 int rtn; 626 const char *sym_name; 627 char type; 628 bool filter; 629 int i, j; 630 631 assert(elf != NULL); 632 assert(headp != NULL); 633 634 rtn = 0; 635 for (i = 1; i < shnum; i++) { 636 if ((scn = elf_getscn(elf, i)) == NULL) { 637 warnx("elf_getscn failed: %s", elf_errmsg(-1)); 638 continue; 639 } 640 if (gelf_getshdr(scn, &shdr) != &shdr) { 641 warnx("gelf_getshdr failed: %s", elf_errmsg(-1)); 642 continue; 643 } 644 if (shdr.sh_type == SHT_SYMTAB) { 645 if (nm_opts.print_symbol != PRINT_SYM_SYM) 646 continue; 647 } else if (shdr.sh_type == SHT_DYNSYM) { 648 if (nm_opts.print_symbol != PRINT_SYM_DYN) 649 continue; 650 } else 651 continue; 652 653 ndx = shdr.sh_type == SHT_DYNSYM ? dynndx : strndx; 654 655 data = NULL; 656 while ((data = elf_getdata(scn, data)) != NULL) { 657 j = 1; 658 while (gelf_getsym(data, j++, &sym) != NULL) { 659 sym_name = get_sym_name(elf, &sym, ndx, 660 sec_table, sec_table_size); 661 filter = false; 662 type = get_sym_type(&sym, type_table); 663 SLIST_FOREACH(fep, &nm_out_filter, 664 filter_entries) { 665 if (!fep->fn(type, &sym, sym_name)) { 666 filter = true; 667 break; 668 } 669 } 670 if (filter == false) { 671 if (sym_list_insert(headp, sym_name, 672 &sym) == 0) 673 return (0); 674 rtn++; 675 } 676 } 677 } 678 } 679 680 return (rtn); 681 } 682 683 static const char * 684 get_sym_name(Elf *elf, const GElf_Sym *sym, size_t ndx, const char **sec_table, 685 int sec_table_size) 686 { 687 const char *sym_name; 688 689 sym_name = NULL; 690 691 /* Show section name as symbol name for STT_SECTION symbols. */ 692 if (GELF_ST_TYPE(sym->st_info) == STT_SECTION) { 693 if (sec_table != NULL && sym->st_shndx < sec_table_size) 694 sym_name = sec_table[sym->st_shndx]; 695 } else 696 sym_name = elf_strptr(elf, ndx, sym->st_name); 697 698 if (sym_name == NULL) 699 sym_name = "(null)"; 700 701 return (sym_name); 702 } 703 704 static char 705 get_sym_type(const GElf_Sym *sym, const char *type_table) 706 { 707 bool is_local; 708 709 if (sym == NULL || type_table == NULL) 710 return ('?'); 711 712 is_local = sym->st_info >> 4 == STB_LOCAL; 713 714 if (sym->st_shndx == SHN_ABS) /* absolute */ 715 return (is_local ? 'a' : 'A'); 716 717 if (sym->st_shndx == SHN_COMMON) /* common */ 718 return ('C'); 719 720 if ((sym->st_info) >> 4 == STB_WEAK) { /* weak */ 721 if ((sym->st_info & 0xf) == STT_OBJECT) 722 return (sym->st_shndx == SHN_UNDEF ? 'v' : 'V'); 723 724 return (sym->st_shndx == SHN_UNDEF ? 'w' : 'W'); 725 } 726 727 if (sym->st_shndx == SHN_UNDEF) /* undefined */ 728 return ('U'); 729 730 return (is_local == true && type_table[sym->st_shndx] != 'N' ? 731 tolower((unsigned char) type_table[sym->st_shndx]) : 732 type_table[sym->st_shndx]); 733 } 734 735 static void 736 global_dest(void) 737 { 738 739 filter_dest(); 740 } 741 742 static void 743 global_init(void) 744 { 745 746 if (elf_version(EV_CURRENT) == EV_NONE) 747 errx(EXIT_FAILURE, "elf_version error"); 748 749 nm_info.name = ELFTC_GETPROGNAME(); 750 nm_info.def_filename = "a.out"; 751 nm_opts.print_symbol = PRINT_SYM_SYM; 752 nm_opts.print_name = PRINT_NAME_NONE; 753 nm_opts.demangle_type = -1; 754 nm_opts.print_debug = false; 755 nm_opts.print_armap = false; 756 nm_opts.print_size = 0; 757 nm_opts.debug_line = false; 758 nm_opts.def_only = 0; 759 nm_opts.undef_only = false; 760 nm_opts.sort_size = 0; 761 nm_opts.sort_reverse = false; 762 nm_opts.no_demangle = 0; 763 nm_opts.sort_fn = &cmp_name; 764 nm_opts.elem_print_fn = &sym_elem_print_all; 765 nm_opts.value_print_fn = &sym_value_dec_print; 766 nm_opts.size_print_fn = &sym_size_dec_print; 767 SLIST_INIT(&nm_out_filter); 768 } 769 770 static bool 771 is_sec_data(GElf_Shdr *s) 772 { 773 774 assert(s != NULL && "shdr is NULL"); 775 776 return (((s->sh_flags & SHF_ALLOC) != 0) && s->sh_type != SHT_NOBITS); 777 } 778 779 static bool 780 is_sec_debug(const char *shname) 781 { 782 const char *dbg_sec[] = { 783 ".debug", 784 ".gnu.linkonce.wi.", 785 ".line", 786 ".rel.debug", 787 ".rela.debug", 788 ".stab", 789 NULL 790 }; 791 const char **p; 792 793 assert(shname != NULL && "shname is NULL"); 794 795 for (p = dbg_sec; *p; p++) { 796 if (!strncmp(shname, *p, strlen(*p))) 797 return (true); 798 } 799 800 return (false); 801 } 802 803 static bool 804 is_sec_nobits(GElf_Shdr *s) 805 { 806 807 assert(s != NULL && "shdr is NULL"); 808 809 return (s->sh_type == SHT_NOBITS); 810 } 811 812 static bool 813 is_sec_readonly(GElf_Shdr *s) 814 { 815 816 assert(s != NULL && "shdr is NULL"); 817 818 return ((s->sh_flags & SHF_WRITE) == 0); 819 } 820 821 static bool 822 is_sec_text(GElf_Shdr *s) 823 { 824 825 assert(s != NULL && "shdr is NULL"); 826 827 return ((s->sh_flags & SHF_EXECINSTR) != 0); 828 } 829 830 static void 831 print_ar_index(int fd, Elf *arf) 832 { 833 Elf *elf; 834 Elf_Arhdr *arhdr; 835 Elf_Arsym *arsym; 836 Elf_Cmd cmd; 837 off_t start; 838 size_t arsym_size; 839 840 if (arf == NULL) 841 return; 842 843 if ((arsym = elf_getarsym(arf, &arsym_size)) == NULL) 844 return; 845 846 printf("\nArchive index:\n"); 847 848 start = arsym->as_off; 849 cmd = ELF_C_READ; 850 while (arsym_size > 1) { 851 if (elf_rand(arf, arsym->as_off) == arsym->as_off && 852 (elf = elf_begin(fd, cmd, arf)) != NULL) { 853 if ((arhdr = elf_getarhdr(elf)) != NULL) 854 printf("%s in %s\n", arsym->as_name, 855 arhdr->ar_name != NULL ? 856 arhdr->ar_name : arhdr->ar_rawname); 857 elf_end(elf); 858 } 859 ++arsym; 860 --arsym_size; 861 } 862 863 elf_rand(arf, start); 864 } 865 866 #define DEMANGLED_BUFFER_SIZE (8 * 1024) 867 #define PRINT_DEMANGLED_NAME(FORMAT, NAME) do { \ 868 char _demangled[DEMANGLED_BUFFER_SIZE]; \ 869 if (nm_opts.demangle_type < 0 || \ 870 elftc_demangle((NAME), _demangled, sizeof(_demangled), \ 871 nm_opts.demangle_type) < 0) \ 872 printf((FORMAT), (NAME)); \ 873 else \ 874 printf((FORMAT), _demangled); \ 875 } while (0) 876 877 static void 878 print_header(const char *file, const char *obj) 879 { 880 881 if (file == NULL) 882 return; 883 884 if (nm_opts.elem_print_fn == &sym_elem_print_all_sysv) { 885 printf("\n\n%s from %s", 886 nm_opts.undef_only == false ? "Symbols" : 887 "Undefined symbols", file); 888 if (obj != NULL) 889 printf("[%s]", obj); 890 printf(":\n\n"); 891 892 printf("\ 893 Name Value Class Type Size Line Section\n\n"); 894 } else { 895 /* archive file without -A option and POSIX */ 896 if (nm_opts.print_name != PRINT_NAME_FULL && obj != NULL) { 897 if (nm_opts.elem_print_fn == 898 sym_elem_print_all_portable) 899 printf("%s[%s]:\n", file, obj); 900 else if (nm_opts.elem_print_fn == sym_elem_print_all) 901 printf("\n%s:\n", obj); 902 /* multiple files(not archive) without -A option */ 903 } else if (nm_opts.print_name == PRINT_NAME_MULTI) { 904 if (nm_opts.elem_print_fn == sym_elem_print_all) 905 printf("\n"); 906 printf("%s:\n", file); 907 } 908 } 909 } 910 911 static void 912 print_version(void) 913 { 914 915 (void) printf("%s (%s)\n", nm_info.name, elftc_version()); 916 exit(0); 917 } 918 919 static uint64_t 920 get_block_value(Dwarf_Debug dbg, Dwarf_Block *block) 921 { 922 Elf *elf; 923 GElf_Ehdr eh; 924 Dwarf_Error de; 925 926 if (dwarf_get_elf(dbg, &elf, &de) != DW_DLV_OK) { 927 warnx("dwarf_get_elf failed: %s", dwarf_errmsg(de)); 928 return (0); 929 } 930 931 if (gelf_getehdr(elf, &eh) != &eh) { 932 warnx("gelf_getehdr failed: %s", elf_errmsg(-1)); 933 return (0); 934 } 935 936 if (block->bl_len == 5) { 937 if (eh.e_ident[EI_DATA] == ELFDATA2LSB) 938 return (le32dec((uint8_t *) block->bl_data + 1)); 939 else 940 return (be32dec((uint8_t *) block->bl_data + 1)); 941 } else if (block->bl_len == 9) { 942 if (eh.e_ident[EI_DATA] == ELFDATA2LSB) 943 return (le64dec((uint8_t *) block->bl_data + 1)); 944 else 945 return (be64dec((uint8_t *) block->bl_data + 1)); 946 } 947 948 return (0); 949 } 950 951 static void 952 search_line_attr(Dwarf_Debug dbg, struct func_info_head *func_info, 953 struct var_info_head *var_info, Dwarf_Die die, char **src_files, 954 Dwarf_Signed filecount) 955 { 956 Dwarf_Attribute at; 957 Dwarf_Unsigned udata; 958 Dwarf_Half tag; 959 Dwarf_Block *block; 960 Dwarf_Bool flag; 961 Dwarf_Die ret_die; 962 Dwarf_Error de; 963 struct func_info_entry *func; 964 struct var_info_entry *var; 965 const char *str; 966 int ret; 967 968 if (dwarf_tag(die, &tag, &de) != DW_DLV_OK) { 969 warnx("dwarf_tag failed: %s", dwarf_errmsg(de)); 970 goto cont_search; 971 } 972 973 /* We're interested in DIEs which define functions or variables. */ 974 if (tag != DW_TAG_subprogram && tag != DW_TAG_entry_point && 975 tag != DW_TAG_inlined_subroutine && tag != DW_TAG_variable) 976 goto cont_search; 977 978 if (tag == DW_TAG_variable) { 979 980 /* Ignore "artificial" variable. */ 981 if (dwarf_attrval_flag(die, DW_AT_artificial, &flag, &de) == 982 DW_DLV_OK && flag) 983 goto cont_search; 984 985 /* Ignore pure declaration. */ 986 if (dwarf_attrval_flag(die, DW_AT_declaration, &flag, &de) == 987 DW_DLV_OK && flag) 988 goto cont_search; 989 990 /* Ignore stack varaibles. */ 991 if (dwarf_attrval_flag(die, DW_AT_external, &flag, &de) != 992 DW_DLV_OK || !flag) 993 goto cont_search; 994 995 if ((var = calloc(1, sizeof(*var))) == NULL) { 996 warn("calloc failed"); 997 goto cont_search; 998 } 999 1000 if (dwarf_attrval_unsigned(die, DW_AT_decl_file, &udata, 1001 &de) == DW_DLV_OK && udata > 0 && 1002 (Dwarf_Signed) (udata - 1) < filecount) { 1003 var->file = strdup(src_files[udata - 1]); 1004 if (var->file == NULL) { 1005 warn("strdup"); 1006 free(var); 1007 goto cont_search; 1008 } 1009 } 1010 1011 if (dwarf_attrval_unsigned(die, DW_AT_decl_line, &udata, &de) == 1012 DW_DLV_OK) 1013 var->line = udata; 1014 1015 if (dwarf_attrval_string(die, DW_AT_name, &str, &de) == 1016 DW_DLV_OK) { 1017 var->name = strdup(str); 1018 if (var->name == NULL) { 1019 warn("strdup"); 1020 if (var->file) 1021 free(var->file); 1022 free(var); 1023 goto cont_search; 1024 } 1025 } 1026 1027 if (dwarf_attr(die, DW_AT_location, &at, &de) == DW_DLV_OK && 1028 dwarf_formblock(at, &block, &de) == DW_DLV_OK) { 1029 /* 1030 * Since we ignored stack variables, the rest are the 1031 * external varaibles which should always use DW_OP_addr 1032 * operator for DW_AT_location value. 1033 */ 1034 if (*((uint8_t *)block->bl_data) == DW_OP_addr) 1035 var->addr = get_block_value(dbg, block); 1036 } 1037 1038 SLIST_INSERT_HEAD(var_info, var, entries); 1039 1040 } else { 1041 1042 if ((func = calloc(1, sizeof(*func))) == NULL) { 1043 warn("calloc failed"); 1044 goto cont_search; 1045 } 1046 1047 /* 1048 * Note that dwarf_attrval_unsigned() handles DW_AT_abstract_origin 1049 * internally, so it can retrieve DW_AT_decl_file/DW_AT_decl_line 1050 * attributes for inlined functions as well. 1051 */ 1052 if (dwarf_attrval_unsigned(die, DW_AT_decl_file, &udata, 1053 &de) == DW_DLV_OK && udata > 0 && 1054 (Dwarf_Signed) (udata - 1) < filecount) { 1055 func->file = strdup(src_files[udata - 1]); 1056 if (func->file == NULL) { 1057 warn("strdup"); 1058 free(func); 1059 goto cont_search; 1060 } 1061 } 1062 1063 if (dwarf_attrval_unsigned(die, DW_AT_decl_line, &udata, &de) == 1064 DW_DLV_OK) 1065 func->line = udata; 1066 1067 if (dwarf_attrval_string(die, DW_AT_name, &str, &de) == 1068 DW_DLV_OK) { 1069 func->name = strdup(str); 1070 if (func->name == NULL) { 1071 warn("strdup"); 1072 if (func->file) 1073 free(func->file); 1074 free(func); 1075 goto cont_search; 1076 } 1077 } 1078 1079 if (dwarf_attrval_unsigned(die, DW_AT_low_pc, &udata, &de) == 1080 DW_DLV_OK) 1081 func->lowpc = udata; 1082 if (dwarf_attrval_unsigned(die, DW_AT_high_pc, &udata, &de) == 1083 DW_DLV_OK) 1084 func->highpc = udata; 1085 1086 SLIST_INSERT_HEAD(func_info, func, entries); 1087 } 1088 1089 cont_search: 1090 1091 /* Search children. */ 1092 ret = dwarf_child(die, &ret_die, &de); 1093 if (ret == DW_DLV_ERROR) 1094 warnx("dwarf_child: %s", dwarf_errmsg(de)); 1095 else if (ret == DW_DLV_OK) 1096 search_line_attr(dbg, func_info, var_info, ret_die, src_files, 1097 filecount); 1098 1099 /* Search sibling. */ 1100 ret = dwarf_siblingof(dbg, die, &ret_die, &de); 1101 if (ret == DW_DLV_ERROR) 1102 warnx("dwarf_siblingof: %s", dwarf_errmsg(de)); 1103 else if (ret == DW_DLV_OK) 1104 search_line_attr(dbg, func_info, var_info, ret_die, src_files, 1105 filecount); 1106 1107 dwarf_dealloc(dbg, die, DW_DLA_DIE); 1108 } 1109 1110 /* 1111 * Read elf file and collect symbol information, sort them, print. 1112 * Return 1 at failed, 0 at success. 1113 */ 1114 static int 1115 read_elf(Elf *elf, const char *filename, Elf_Kind kind) 1116 { 1117 Dwarf_Debug dbg; 1118 Dwarf_Die die; 1119 Dwarf_Error de; 1120 Dwarf_Half tag; 1121 Elf_Arhdr *arhdr; 1122 Elf_Scn *scn; 1123 GElf_Shdr shdr; 1124 GElf_Half i; 1125 Dwarf_Line *lbuf; 1126 Dwarf_Unsigned lineno; 1127 Dwarf_Signed lcount, filecount; 1128 Dwarf_Addr lineaddr; 1129 struct sym_print_data p_data; 1130 struct sym_head list_head; 1131 struct line_info_head *line_info; 1132 struct func_info_head *func_info; 1133 struct var_info_head *var_info; 1134 struct line_info_entry *lie; 1135 struct func_info_entry *func; 1136 struct var_info_entry *var; 1137 const char *shname, *objname; 1138 char *type_table, **sec_table, *sfile, **src_files; 1139 size_t shstrndx, shnum, dynndx, strndx; 1140 int ret, rtn, e_err; 1141 1142 #define OBJNAME (objname == NULL ? filename : objname) 1143 1144 assert(filename != NULL && "filename is null"); 1145 1146 STAILQ_INIT(&list_head); 1147 type_table = NULL; 1148 sec_table = NULL; 1149 line_info = NULL; 1150 func_info = NULL; 1151 var_info = NULL; 1152 objname = NULL; 1153 dynndx = SHN_UNDEF; 1154 strndx = SHN_UNDEF; 1155 rtn = 0; 1156 1157 nm_elfclass = gelf_getclass(elf); 1158 1159 if (kind == ELF_K_AR) { 1160 if ((arhdr = elf_getarhdr(elf)) == NULL) 1161 goto next_cmd; 1162 objname = arhdr->ar_name != NULL ? arhdr->ar_name : 1163 arhdr->ar_rawname; 1164 } 1165 if (!elf_getshnum(elf, &shnum)) { 1166 if ((e_err = elf_errno()) != 0) 1167 warnx("%s: %s", OBJNAME, elf_errmsg(e_err)); 1168 else 1169 warnx("%s: cannot get section number", OBJNAME); 1170 rtn = 1; 1171 goto next_cmd; 1172 } 1173 if (shnum == 0) { 1174 warnx("%s: has no section", OBJNAME); 1175 rtn = 1; 1176 goto next_cmd; 1177 } 1178 if (!elf_getshstrndx(elf, &shstrndx)) { 1179 warnx("%s: cannot get str index", OBJNAME); 1180 rtn = 1; 1181 goto next_cmd; 1182 } 1183 /* type_table for type determine */ 1184 if ((type_table = malloc(sizeof(char) * shnum)) == NULL) { 1185 warn("%s: malloc", OBJNAME); 1186 rtn = 1; 1187 goto next_cmd; 1188 } 1189 /* sec_table for section name to display in sysv format */ 1190 if ((sec_table = calloc(shnum, sizeof(char *))) == NULL) { 1191 warn("%s: calloc", OBJNAME); 1192 rtn = 1; 1193 goto next_cmd; 1194 } 1195 1196 type_table[0] = 'U'; 1197 if ((sec_table[0] = strdup("*UND*")) == NULL) { 1198 warn("strdup"); 1199 goto next_cmd; 1200 } 1201 1202 for (i = 1; i < shnum; ++i) { 1203 type_table[i] = 'U'; 1204 if ((scn = elf_getscn(elf, i)) == NULL) { 1205 if ((e_err = elf_errno()) != 0) 1206 warnx("%s: %s", OBJNAME, elf_errmsg(e_err)); 1207 else 1208 warnx("%s: cannot get section", OBJNAME); 1209 rtn = 1; 1210 goto next_cmd; 1211 } 1212 if (gelf_getshdr(scn, &shdr) == NULL) 1213 goto next_cmd; 1214 1215 /* 1216 * Cannot test by type and attribute for dynstr, strtab 1217 */ 1218 shname = elf_strptr(elf, shstrndx, (size_t) shdr.sh_name); 1219 if (shname != NULL) { 1220 if ((sec_table[i] = strdup(shname)) == NULL) { 1221 warn("strdup"); 1222 goto next_cmd; 1223 } 1224 if (!strncmp(shname, ".dynstr", 7)) { 1225 dynndx = elf_ndxscn(scn); 1226 if (dynndx == SHN_UNDEF) { 1227 warnx("%s: elf_ndxscn failed: %s", 1228 OBJNAME, elf_errmsg(-1)); 1229 goto next_cmd; 1230 } 1231 } 1232 if (!strncmp(shname, ".strtab", 7)) { 1233 strndx = elf_ndxscn(scn); 1234 if (strndx == SHN_UNDEF) { 1235 warnx("%s: elf_ndxscn failed: %s", 1236 OBJNAME, elf_errmsg(-1)); 1237 goto next_cmd; 1238 } 1239 } 1240 } else { 1241 sec_table[i] = strdup("*UND*"); 1242 if (sec_table[i] == NULL) { 1243 warn("strdup"); 1244 goto next_cmd; 1245 } 1246 } 1247 1248 1249 if (is_sec_text(&shdr)) 1250 type_table[i] = 'T'; 1251 else if (is_sec_data(&shdr)) { 1252 if (is_sec_readonly(&shdr)) 1253 type_table[i] = 'R'; 1254 else 1255 type_table[i] = 'D'; 1256 } else if (is_sec_nobits(&shdr)) 1257 type_table[i] = 'B'; 1258 else if (is_sec_debug(shname)) 1259 type_table[i] = 'N'; 1260 else if (is_sec_readonly(&shdr) && !is_sec_nobits(&shdr)) 1261 type_table[i] = 'n'; 1262 } 1263 1264 print_header(filename, objname); 1265 1266 if ((dynndx == SHN_UNDEF && nm_opts.print_symbol == PRINT_SYM_DYN) || 1267 (strndx == SHN_UNDEF && nm_opts.print_symbol == PRINT_SYM_SYM)) { 1268 warnx("%s: no symbols", OBJNAME); 1269 /* This is not an error case */ 1270 goto next_cmd; 1271 } 1272 1273 STAILQ_INIT(&list_head); 1274 1275 if (!nm_opts.debug_line) 1276 goto process_sym; 1277 1278 /* 1279 * Collect dwarf line number information. 1280 */ 1281 1282 if (dwarf_elf_init(elf, DW_DLC_READ, NULL, NULL, &dbg, &de) != 1283 DW_DLV_OK) { 1284 warnx("dwarf_elf_init failed: %s", dwarf_errmsg(de)); 1285 goto process_sym; 1286 } 1287 1288 line_info = malloc(sizeof(struct line_info_head)); 1289 func_info = malloc(sizeof(struct func_info_head)); 1290 var_info = malloc(sizeof(struct var_info_head)); 1291 if (line_info == NULL || func_info == NULL || var_info == NULL) { 1292 warn("malloc"); 1293 (void) dwarf_finish(dbg, &de); 1294 goto process_sym; 1295 } 1296 SLIST_INIT(line_info); 1297 SLIST_INIT(func_info); 1298 SLIST_INIT(var_info); 1299 1300 while ((ret = dwarf_next_cu_header(dbg, NULL, NULL, NULL, NULL, NULL, 1301 &de)) == DW_DLV_OK) { 1302 die = NULL; 1303 while (dwarf_siblingof(dbg, die, &die, &de) == DW_DLV_OK) { 1304 if (dwarf_tag(die, &tag, &de) != DW_DLV_OK) { 1305 warnx("dwarf_tag failed: %s", 1306 dwarf_errmsg(de)); 1307 continue; 1308 } 1309 /* XXX: What about DW_TAG_partial_unit? */ 1310 if (tag == DW_TAG_compile_unit) 1311 break; 1312 } 1313 if (die == NULL) { 1314 warnx("could not find DW_TAG_compile_unit die"); 1315 continue; 1316 } 1317 1318 /* Retrieve source file list. */ 1319 ret = dwarf_srcfiles(die, &src_files, &filecount, &de); 1320 if (ret == DW_DLV_ERROR) 1321 warnx("dwarf_srclines: %s", dwarf_errmsg(de)); 1322 if (ret != DW_DLV_OK) 1323 continue; 1324 1325 /* 1326 * Retrieve line number information from .debug_line section. 1327 */ 1328 1329 ret = dwarf_srclines(die, &lbuf, &lcount, &de); 1330 if (ret == DW_DLV_ERROR) 1331 warnx("dwarf_srclines: %s", dwarf_errmsg(de)); 1332 if (ret != DW_DLV_OK) 1333 goto line_attr; 1334 for (i = 0; (Dwarf_Signed) i < lcount; i++) { 1335 if (dwarf_lineaddr(lbuf[i], &lineaddr, &de)) { 1336 warnx("dwarf_lineaddr: %s", dwarf_errmsg(de)); 1337 continue; 1338 } 1339 if (dwarf_lineno(lbuf[i], &lineno, &de)) { 1340 warnx("dwarf_lineno: %s", dwarf_errmsg(de)); 1341 continue; 1342 } 1343 if (dwarf_linesrc(lbuf[i], &sfile, &de)) { 1344 warnx("dwarf_linesrc: %s", dwarf_errmsg(de)); 1345 continue; 1346 } 1347 if ((lie = malloc(sizeof(*lie))) == NULL) { 1348 warn("malloc"); 1349 continue; 1350 } 1351 lie->addr = lineaddr; 1352 lie->line = lineno; 1353 lie->file = strdup(sfile); 1354 if (lie->file == NULL) { 1355 warn("strdup"); 1356 free(lie); 1357 continue; 1358 } 1359 SLIST_INSERT_HEAD(line_info, lie, entries); 1360 } 1361 1362 line_attr: 1363 /* Retrieve line number information from DIEs. */ 1364 search_line_attr(dbg, func_info, var_info, die, src_files, filecount); 1365 } 1366 1367 (void) dwarf_finish(dbg, &de); 1368 1369 process_sym: 1370 1371 p_data.list_num = get_sym(elf, &list_head, shnum, dynndx, strndx, 1372 type_table, (void *) sec_table, shnum); 1373 1374 if (p_data.list_num == 0) 1375 goto next_cmd; 1376 1377 p_data.headp = &list_head; 1378 p_data.sh_num = shnum; 1379 p_data.t_table = type_table; 1380 p_data.s_table = (void *) sec_table; 1381 p_data.filename = filename; 1382 p_data.objname = objname; 1383 1384 sym_list_print(&p_data, func_info, var_info, line_info); 1385 1386 next_cmd: 1387 if (nm_opts.debug_line) { 1388 if (func_info != NULL) { 1389 while (!SLIST_EMPTY(func_info)) { 1390 func = SLIST_FIRST(func_info); 1391 SLIST_REMOVE_HEAD(func_info, entries); 1392 free(func->file); 1393 free(func->name); 1394 free(func); 1395 } 1396 free(func_info); 1397 func_info = NULL; 1398 } 1399 if (var_info != NULL) { 1400 while (!SLIST_EMPTY(var_info)) { 1401 var = SLIST_FIRST(var_info); 1402 SLIST_REMOVE_HEAD(var_info, entries); 1403 free(var->file); 1404 free(var->name); 1405 free(var); 1406 } 1407 free(var_info); 1408 var_info = NULL; 1409 } 1410 if (line_info != NULL) { 1411 while (!SLIST_EMPTY(line_info)) { 1412 lie = SLIST_FIRST(line_info); 1413 SLIST_REMOVE_HEAD(line_info, entries); 1414 free(lie->file); 1415 free(lie); 1416 } 1417 free(line_info); 1418 line_info = NULL; 1419 } 1420 } 1421 1422 if (sec_table != NULL) 1423 for (i = 0; i < shnum; ++i) 1424 free(sec_table[i]); 1425 free(sec_table); 1426 free(type_table); 1427 1428 sym_list_dest(&list_head); 1429 1430 return (rtn); 1431 1432 #undef OBJNAME 1433 } 1434 1435 static int 1436 read_object(const char *filename) 1437 { 1438 Elf *elf, *arf; 1439 Elf_Cmd elf_cmd; 1440 Elf_Kind kind; 1441 int fd, rtn, e_err; 1442 1443 assert(filename != NULL && "filename is null"); 1444 1445 if ((fd = open(filename, O_RDONLY)) == -1) { 1446 warn("'%s'", filename); 1447 return (1); 1448 } 1449 1450 elf_cmd = ELF_C_READ; 1451 if ((arf = elf_begin(fd, elf_cmd, (Elf *) NULL)) == NULL) { 1452 if ((e_err = elf_errno()) != 0) 1453 warnx("elf_begin error: %s", elf_errmsg(e_err)); 1454 else 1455 warnx("elf_begin error"); 1456 close(fd); 1457 return (1); 1458 } 1459 1460 assert(arf != NULL && "arf is null."); 1461 1462 rtn = 0; 1463 if ((kind = elf_kind(arf)) == ELF_K_NONE) { 1464 warnx("%s: File format not recognized", filename); 1465 elf_end(arf); 1466 close(fd); 1467 return (1); 1468 } 1469 if (kind == ELF_K_AR) { 1470 if (nm_opts.print_name == PRINT_NAME_MULTI && 1471 nm_opts.elem_print_fn == sym_elem_print_all) 1472 printf("\n%s:\n", filename); 1473 if (nm_opts.print_armap == true) 1474 print_ar_index(fd, arf); 1475 } 1476 1477 while ((elf = elf_begin(fd, elf_cmd, arf)) != NULL) { 1478 rtn |= read_elf(elf, filename, kind); 1479 1480 /* 1481 * If file is not archive, elf_next return ELF_C_NULL and 1482 * stop the loop. 1483 */ 1484 elf_cmd = elf_next(elf); 1485 elf_end(elf); 1486 } 1487 1488 elf_end(arf); 1489 close(fd); 1490 1491 return (rtn); 1492 } 1493 1494 static int 1495 read_files(int argc, char **argv) 1496 { 1497 int rtn = 0; 1498 1499 if (argc < 0 || argv == NULL) 1500 return (1); 1501 1502 if (argc == 0) 1503 rtn |= read_object(nm_info.def_filename); 1504 else { 1505 if (nm_opts.print_name == PRINT_NAME_NONE && argc > 1) 1506 nm_opts.print_name = PRINT_NAME_MULTI; 1507 while (argc > 0) { 1508 rtn |= read_object(*argv); 1509 --argc; 1510 ++argv; 1511 } 1512 } 1513 1514 return (rtn); 1515 } 1516 1517 static void 1518 print_lineno(struct sym_entry *ep, struct func_info_head *func_info, 1519 struct var_info_head *var_info, struct line_info_head *line_info) 1520 { 1521 struct func_info_entry *func; 1522 struct var_info_entry *var; 1523 struct line_info_entry *lie; 1524 1525 /* For function symbol, search the function line information list. */ 1526 if ((ep->sym->st_info & 0xf) == STT_FUNC && func_info != NULL) { 1527 SLIST_FOREACH(func, func_info, entries) { 1528 if (!strcmp(ep->name, func->name) && 1529 ep->sym->st_value >= func->lowpc && 1530 ep->sym->st_value < func->highpc) { 1531 printf("\t%s:%" PRIu64, func->file, func->line); 1532 return; 1533 } 1534 } 1535 } 1536 1537 /* For variable symbol, search the variable line information list. */ 1538 if ((ep->sym->st_info & 0xf) == STT_OBJECT && var_info != NULL) { 1539 SLIST_FOREACH(var, var_info, entries) { 1540 if (!strcmp(ep->name, var->name) && 1541 ep->sym->st_value == var->addr) { 1542 printf("\t%s:%" PRIu64, var->file, var->line); 1543 return; 1544 } 1545 } 1546 } 1547 1548 /* Otherwise search line number information the .debug_line section. */ 1549 if (line_info != NULL) { 1550 SLIST_FOREACH(lie, line_info, entries) { 1551 if (ep->sym->st_value == lie->addr) { 1552 printf("\t%s:%" PRIu64, lie->file, lie->line); 1553 return; 1554 } 1555 } 1556 } 1557 } 1558 1559 static void 1560 set_opt_value_print_fn(enum radix t) 1561 { 1562 1563 switch (t) { 1564 case RADIX_OCT: 1565 nm_opts.value_print_fn = &sym_value_oct_print; 1566 nm_opts.size_print_fn = &sym_size_oct_print; 1567 1568 break; 1569 case RADIX_DEC: 1570 nm_opts.value_print_fn = &sym_value_dec_print; 1571 nm_opts.size_print_fn = &sym_size_dec_print; 1572 1573 break; 1574 case RADIX_HEX: 1575 default : 1576 nm_opts.value_print_fn = &sym_value_hex_print; 1577 nm_opts.size_print_fn = &sym_size_hex_print; 1578 } 1579 1580 assert(nm_opts.value_print_fn != NULL && 1581 "nm_opts.value_print_fn is null"); 1582 } 1583 1584 static void 1585 sym_elem_print_all(char type, const char *sec, const GElf_Sym *sym, 1586 const char *name) 1587 { 1588 1589 if (sec == NULL || sym == NULL || name == NULL || 1590 nm_opts.value_print_fn == NULL) 1591 return; 1592 1593 if (IS_UNDEF_SYM_TYPE(type)) { 1594 if (nm_opts.t == RADIX_HEX && nm_elfclass == ELFCLASS32) 1595 printf("%-8s", ""); 1596 else 1597 printf("%-16s", ""); 1598 } else { 1599 switch ((nm_opts.sort_fn == & cmp_size ? 2 : 0) + 1600 nm_opts.print_size) { 1601 case 3: 1602 if (sym->st_size != 0) { 1603 nm_opts.value_print_fn(sym); 1604 printf(" "); 1605 nm_opts.size_print_fn(sym); 1606 } 1607 break; 1608 1609 case 2: 1610 if (sym->st_size != 0) 1611 nm_opts.size_print_fn(sym); 1612 break; 1613 1614 case 1: 1615 nm_opts.value_print_fn(sym); 1616 if (sym->st_size != 0) { 1617 printf(" "); 1618 nm_opts.size_print_fn(sym); 1619 } 1620 break; 1621 1622 case 0: 1623 default: 1624 nm_opts.value_print_fn(sym); 1625 } 1626 } 1627 1628 printf(" %c ", type); 1629 PRINT_DEMANGLED_NAME("%s", name); 1630 } 1631 1632 static void 1633 sym_elem_print_all_portable(char type, const char *sec, const GElf_Sym *sym, 1634 const char *name) 1635 { 1636 1637 if (sec == NULL || sym == NULL || name == NULL || 1638 nm_opts.value_print_fn == NULL) 1639 return; 1640 1641 PRINT_DEMANGLED_NAME("%s", name); 1642 printf(" %c ", type); 1643 if (!IS_UNDEF_SYM_TYPE(type)) { 1644 nm_opts.value_print_fn(sym); 1645 printf(" "); 1646 if (sym->st_size != 0) 1647 nm_opts.size_print_fn(sym); 1648 } else 1649 printf(" "); 1650 } 1651 1652 static void 1653 sym_elem_print_all_sysv(char type, const char *sec, const GElf_Sym *sym, 1654 const char *name) 1655 { 1656 1657 if (sec == NULL || sym == NULL || name == NULL || 1658 nm_opts.value_print_fn == NULL) 1659 return; 1660 1661 PRINT_DEMANGLED_NAME("%-20s|", name); 1662 if (IS_UNDEF_SYM_TYPE(type)) 1663 printf(" "); 1664 else 1665 nm_opts.value_print_fn(sym); 1666 1667 printf("| %c |", type); 1668 1669 switch (sym->st_info & 0xf) { 1670 case STT_OBJECT: 1671 printf("%18s|", "OBJECT"); 1672 break; 1673 1674 case STT_FUNC: 1675 printf("%18s|", "FUNC"); 1676 break; 1677 1678 case STT_SECTION: 1679 printf("%18s|", "SECTION"); 1680 break; 1681 1682 case STT_FILE: 1683 printf("%18s|", "FILE"); 1684 break; 1685 1686 case STT_LOPROC: 1687 printf("%18s|", "LOPROC"); 1688 break; 1689 1690 case STT_HIPROC: 1691 printf("%18s|", "HIPROC"); 1692 break; 1693 1694 case STT_NOTYPE: 1695 default: 1696 printf("%18s|", "NOTYPE"); 1697 }; 1698 1699 if (sym->st_size != 0) 1700 nm_opts.size_print_fn(sym); 1701 else 1702 printf(" "); 1703 1704 printf("| |%s", sec); 1705 } 1706 1707 static int 1708 sym_elem_def(char type, const GElf_Sym *sym, const char *name) 1709 { 1710 1711 assert(IS_SYM_TYPE((unsigned char) type)); 1712 1713 UNUSED(sym); 1714 UNUSED(name); 1715 1716 return (!IS_UNDEF_SYM_TYPE((unsigned char) type)); 1717 } 1718 1719 static int 1720 sym_elem_global(char type, const GElf_Sym *sym, const char *name) 1721 { 1722 1723 assert(IS_SYM_TYPE((unsigned char) type)); 1724 1725 UNUSED(sym); 1726 UNUSED(name); 1727 1728 /* weak symbols resemble global. */ 1729 return (isupper((unsigned char) type) || type == 'w'); 1730 } 1731 1732 static int 1733 sym_elem_global_static(char type, const GElf_Sym *sym, const char *name) 1734 { 1735 unsigned char info; 1736 1737 assert(sym != NULL); 1738 1739 UNUSED(type); 1740 UNUSED(name); 1741 1742 info = sym->st_info >> 4; 1743 1744 return (info == STB_LOCAL || 1745 info == STB_GLOBAL || 1746 info == STB_WEAK); 1747 } 1748 1749 static int 1750 sym_elem_nondebug(char type, const GElf_Sym *sym, const char *name) 1751 { 1752 1753 assert(sym != NULL); 1754 1755 UNUSED(type); 1756 UNUSED(name); 1757 1758 if (sym->st_value == 0 && (sym->st_info & 0xf) == STT_FILE) 1759 return (0); 1760 if (sym->st_name == 0) 1761 return (0); 1762 1763 return (1); 1764 } 1765 1766 static int 1767 sym_elem_nonzero_size(char type, const GElf_Sym *sym, const char *name) 1768 { 1769 1770 assert(sym != NULL); 1771 1772 UNUSED(type); 1773 UNUSED(name); 1774 1775 return (sym->st_size > 0); 1776 } 1777 1778 static int 1779 sym_elem_undef(char type, const GElf_Sym *sym, const char *name) 1780 { 1781 1782 assert(IS_SYM_TYPE((unsigned char) type)); 1783 1784 UNUSED(sym); 1785 UNUSED(name); 1786 1787 return (IS_UNDEF_SYM_TYPE((unsigned char) type)); 1788 } 1789 1790 static void 1791 sym_list_dest(struct sym_head *headp) 1792 { 1793 struct sym_entry *ep, *ep_n; 1794 1795 if (headp == NULL) 1796 return; 1797 1798 ep = STAILQ_FIRST(headp); 1799 while (ep != NULL) { 1800 ep_n = STAILQ_NEXT(ep, sym_entries); 1801 free(ep->sym); 1802 free(ep->name); 1803 free(ep); 1804 ep = ep_n; 1805 } 1806 } 1807 1808 static int 1809 sym_list_insert(struct sym_head *headp, const char *name, const GElf_Sym *sym) 1810 { 1811 struct sym_entry *e; 1812 1813 if (headp == NULL || name == NULL || sym == NULL) 1814 return (0); 1815 if ((e = malloc(sizeof(struct sym_entry))) == NULL) { 1816 warn("malloc"); 1817 return (0); 1818 } 1819 if ((e->name = strdup(name)) == NULL) { 1820 warn("strdup"); 1821 free(e); 1822 return (0); 1823 } 1824 if ((e->sym = malloc(sizeof(GElf_Sym))) == NULL) { 1825 warn("malloc"); 1826 free(e->name); 1827 free(e); 1828 return (0); 1829 } 1830 1831 memcpy(e->sym, sym, sizeof(GElf_Sym)); 1832 1833 /* Display size instead of value for common symbol. */ 1834 if (sym->st_shndx == SHN_COMMON) 1835 e->sym->st_value = sym->st_size; 1836 1837 STAILQ_INSERT_TAIL(headp, e, sym_entries); 1838 1839 return (1); 1840 } 1841 1842 /* If file has not .debug_info, line_info will be NULL */ 1843 static void 1844 sym_list_print(struct sym_print_data *p, struct func_info_head *func_info, 1845 struct var_info_head *var_info, struct line_info_head *line_info) 1846 { 1847 struct sym_entry *e_v; 1848 size_t si; 1849 int i; 1850 1851 if (p == NULL || CHECK_SYM_PRINT_DATA(p)) 1852 return; 1853 if ((e_v = sym_list_sort(p)) == NULL) 1854 return; 1855 if (nm_opts.sort_reverse == false) 1856 for (si = 0; si != p->list_num; ++si) 1857 sym_list_print_each(&e_v[si], p, func_info, var_info, 1858 line_info); 1859 else 1860 for (i = p->list_num - 1; i != -1; --i) 1861 sym_list_print_each(&e_v[i], p, func_info, var_info, 1862 line_info); 1863 1864 free(e_v); 1865 } 1866 1867 /* If file has not .debug_info, line_info will be NULL */ 1868 static void 1869 sym_list_print_each(struct sym_entry *ep, struct sym_print_data *p, 1870 struct func_info_head *func_info, struct var_info_head *var_info, 1871 struct line_info_head *line_info) 1872 { 1873 const char *sec; 1874 char type; 1875 1876 if (ep == NULL || CHECK_SYM_PRINT_DATA(p)) 1877 return; 1878 1879 assert(ep->name != NULL); 1880 assert(ep->sym != NULL); 1881 1882 type = get_sym_type(ep->sym, p->t_table); 1883 1884 if (nm_opts.print_name == PRINT_NAME_FULL) { 1885 printf("%s", p->filename); 1886 if (nm_opts.elem_print_fn == &sym_elem_print_all_portable) { 1887 if (p->objname != NULL) 1888 printf("[%s]", p->objname); 1889 printf(": "); 1890 } else { 1891 if (p->objname != NULL) 1892 printf(":%s", p->objname); 1893 printf(":"); 1894 } 1895 } 1896 1897 switch (ep->sym->st_shndx) { 1898 case SHN_LOPROC: 1899 /* LOPROC or LORESERVE */ 1900 sec = "*LOPROC*"; 1901 break; 1902 case SHN_HIPROC: 1903 sec = "*HIPROC*"; 1904 break; 1905 case SHN_LOOS: 1906 sec = "*LOOS*"; 1907 break; 1908 case SHN_HIOS: 1909 sec = "*HIOS*"; 1910 break; 1911 case SHN_ABS: 1912 sec = "*ABS*"; 1913 break; 1914 case SHN_COMMON: 1915 sec = "*COM*"; 1916 break; 1917 case SHN_HIRESERVE: 1918 /* HIRESERVE or XINDEX */ 1919 sec = "*HIRESERVE*"; 1920 break; 1921 default: 1922 if (ep->sym->st_shndx > p->sh_num) 1923 return; 1924 sec = p->s_table[ep->sym->st_shndx]; 1925 break; 1926 }; 1927 1928 nm_opts.elem_print_fn(type, sec, ep->sym, ep->name); 1929 1930 if (nm_opts.debug_line == true && !IS_UNDEF_SYM_TYPE(type)) 1931 print_lineno(ep, func_info, var_info, line_info); 1932 1933 printf("\n"); 1934 } 1935 1936 static struct sym_entry * 1937 sym_list_sort(struct sym_print_data *p) 1938 { 1939 struct sym_entry *ep, *e_v; 1940 int idx; 1941 1942 if (p == NULL || CHECK_SYM_PRINT_DATA(p)) 1943 return (NULL); 1944 1945 if ((e_v = malloc(sizeof(struct sym_entry) * p->list_num)) == NULL) { 1946 warn("malloc"); 1947 return (NULL); 1948 } 1949 1950 idx = 0; 1951 STAILQ_FOREACH(ep, p->headp, sym_entries) { 1952 if (ep->name != NULL && ep->sym != NULL) { 1953 e_v[idx].name = ep->name; 1954 e_v[idx].sym = ep->sym; 1955 ++idx; 1956 } 1957 } 1958 1959 assert((size_t)idx == p->list_num); 1960 1961 if (nm_opts.sort_fn != &cmp_none) { 1962 nm_print_data = p; 1963 assert(nm_print_data != NULL); 1964 qsort(e_v, p->list_num, sizeof(struct sym_entry), 1965 nm_opts.sort_fn); 1966 } 1967 1968 return (e_v); 1969 } 1970 1971 static void 1972 sym_size_oct_print(const GElf_Sym *sym) 1973 { 1974 1975 assert(sym != NULL && "sym is null"); 1976 printf("%016" PRIo64, sym->st_size); 1977 } 1978 1979 static void 1980 sym_size_hex_print(const GElf_Sym *sym) 1981 { 1982 1983 assert(sym != NULL && "sym is null"); 1984 if (nm_elfclass == ELFCLASS32) 1985 printf("%08" PRIx64, sym->st_size); 1986 else 1987 printf("%016" PRIx64, sym->st_size); 1988 } 1989 1990 static void 1991 sym_size_dec_print(const GElf_Sym *sym) 1992 { 1993 1994 assert(sym != NULL && "sym is null"); 1995 printf("%016" PRId64, sym->st_size); 1996 } 1997 1998 static void 1999 sym_value_oct_print(const GElf_Sym *sym) 2000 { 2001 2002 assert(sym != NULL && "sym is null"); 2003 printf("%016" PRIo64, sym->st_value); 2004 } 2005 2006 static void 2007 sym_value_hex_print(const GElf_Sym *sym) 2008 { 2009 2010 assert(sym != NULL && "sym is null"); 2011 if (nm_elfclass == ELFCLASS32) 2012 printf("%08" PRIx64, sym->st_value); 2013 else 2014 printf("%016" PRIx64, sym->st_value); 2015 } 2016 2017 static void 2018 sym_value_dec_print(const GElf_Sym *sym) 2019 { 2020 2021 assert(sym != NULL && "sym is null"); 2022 printf("%016" PRId64, sym->st_value); 2023 } 2024 2025 static void 2026 usage(int exitcode) 2027 { 2028 2029 printf("Usage: %s [options] file ...\ 2030 \n Display symbolic information in file.\n\ 2031 \n Options: \ 2032 \n -A, --print-file-name Write the full pathname or library name of an\ 2033 \n object on each line.\ 2034 \n -a, --debug-syms Display all symbols include debugger-only\ 2035 \n symbols.", nm_info.name); 2036 printf("\ 2037 \n -B Equivalent to specifying \"--format=bsd\".\ 2038 \n -C, --demangle[=style] Decode low-level symbol names.\ 2039 \n --no-demangle Do not demangle low-level symbol names.\ 2040 \n -D, --dynamic Display only dynamic symbols.\ 2041 \n -e Display only global and static symbols."); 2042 printf("\ 2043 \n -f Produce full output (default).\ 2044 \n --format=format Display output in specific format. Allowed\ 2045 \n formats are: \"bsd\", \"posix\" and \"sysv\".\ 2046 \n -g, --extern-only Display only global symbol information.\ 2047 \n -h, --help Show this help message.\ 2048 \n -l, --line-numbers Display filename and linenumber using\ 2049 \n debugging information.\ 2050 \n -n, --numeric-sort Sort symbols numerically by value."); 2051 printf("\ 2052 \n -o Write numeric values in octal. Equivalent to\ 2053 \n specifying \"-t o\".\ 2054 \n -p, --no-sort Do not sort symbols.\ 2055 \n -P Write information in a portable output format.\ 2056 \n Equivalent to specifying \"--format=posix\".\ 2057 \n -r, --reverse-sort Reverse the order of the sort.\ 2058 \n -S, --print-size Print symbol sizes instead values.\ 2059 \n -s, --print-armap Include an index of archive members.\ 2060 \n --size-sort Sort symbols by size."); 2061 printf("\ 2062 \n -t, --radix=format Write each numeric value in the specified\ 2063 \n format:\ 2064 \n d In decimal,\ 2065 \n o In octal,\ 2066 \n x In hexadecimal."); 2067 printf("\ 2068 \n -u, --undefined-only Display only undefined symbols.\ 2069 \n --defined-only Display only defined symbols.\ 2070 \n -V, --version Show the version identifier for %s.\ 2071 \n -v Sort output by value.\ 2072 \n -x Write numeric values in hexadecimal.\ 2073 \n Equivalent to specifying \"-t x\".", 2074 nm_info.name); 2075 printf("\n\ 2076 \n The default options are: output in bsd format, use a hexadecimal radix,\ 2077 \n sort by symbol name, do not demangle names.\n"); 2078 2079 exit(exitcode); 2080 } 2081 2082 /* 2083 * Display symbolic information in file. 2084 * Return 0 at success, >0 at failed. 2085 */ 2086 int 2087 main(int argc, char **argv) 2088 { 2089 int rtn; 2090 2091 global_init(); 2092 get_opt(argc, argv); 2093 rtn = read_files(argc - optind, argv + optind); 2094 global_dest(); 2095 2096 exit(rtn); 2097 } 2098