1 /* nm.c -- Describe symbol table of a rel file.
2 Copyright 1991, 92, 93, 94 Free Software Foundation, Inc.
4 This file is part of GNU Binutils.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
24 #include "aout/stab_gnu.h"
25 #include "aout/ranlib.h"
29 display_file PARAMS ((char *filename));
32 display_rel_file PARAMS ((bfd * file, bfd * archive));
35 filter_symbols PARAMS ((bfd * file, asymbol ** syms, unsigned long symcount));
38 print_symbols PARAMS ((bfd * file, asymbol ** syms, unsigned long symcount,
42 print_symdef_entry PARAMS ((bfd * abfd));
45 /* The output formatting functions. */
48 print_object_filename_bsd PARAMS ((char *filename));
51 print_object_filename_sysv PARAMS ((char *filename));
54 print_object_filename_posix PARAMS ((char *filename));
58 print_archive_filename_bsd PARAMS ((char *filename));
61 print_archive_filename_sysv PARAMS ((char *filename));
64 print_archive_filename_posix PARAMS ((char *filename));
68 print_archive_member_bsd PARAMS ((char *archive, CONST char *filename));
71 print_archive_member_sysv PARAMS ((char *archive, CONST char *filename));
74 print_archive_member_posix PARAMS ((char *archive, CONST char *filename));
78 print_symbol_filename_bsd PARAMS ((bfd * archive_bfd, bfd * abfd));
81 print_symbol_filename_sysv PARAMS ((bfd * archive_bfd, bfd * abfd));
84 print_symbol_filename_posix PARAMS ((bfd * archive_bfd, bfd * abfd));
88 print_symbol_info_bsd PARAMS ((symbol_info * info, bfd * abfd));
91 print_symbol_info_sysv PARAMS ((symbol_info * info, bfd * abfd));
94 print_symbol_info_posix PARAMS ((symbol_info * info, bfd * abfd));
97 /* Support for different output formats. */
100 /* Print the name of an object file given on the command line. */
101 void (*print_object_filename) PARAMS ((char *filename));
103 /* Print the name of an archive file given on the command line. */
104 void (*print_archive_filename) PARAMS ((char *filename));
106 /* Print the name of an archive member file. */
107 void (*print_archive_member) PARAMS ((char *archive, CONST char *filename));
109 /* Print the name of the file (and archive, if there is one)
110 containing a symbol. */
111 void (*print_symbol_filename) PARAMS ((bfd * archive_bfd, bfd * abfd));
113 /* Print a line of information about a symbol. */
114 void (*print_symbol_info) PARAMS ((symbol_info * info, bfd * abfd));
116 static struct output_fns formats[] =
118 {print_object_filename_bsd,
119 print_archive_filename_bsd,
120 print_archive_member_bsd,
121 print_symbol_filename_bsd,
122 print_symbol_info_bsd},
123 {print_object_filename_sysv,
124 print_archive_filename_sysv,
125 print_archive_member_sysv,
126 print_symbol_filename_sysv,
127 print_symbol_info_sysv},
128 {print_object_filename_posix,
129 print_archive_filename_posix,
130 print_archive_member_posix,
131 print_symbol_filename_posix,
132 print_symbol_info_posix}
135 /* Indices in `formats'. */
137 #define FORMAT_SYSV 1
138 #define FORMAT_POSIX 2
139 #define FORMAT_DEFAULT FORMAT_BSD
141 /* The output format to use. */
142 static struct output_fns *format = &formats[FORMAT_DEFAULT];
145 /* Command options. */
147 static int do_demangle = 0; /* Pretty print C++ symbol names. */
148 static int external_only = 0; /* print external symbols only */
149 static int no_sort = 0; /* don't sort; print syms in order found */
150 static int print_debug_syms = 0; /* print debugger-only symbols too */
151 static int print_armap = 0; /* describe __.SYMDEF data in archive files. */
152 static int reverse_sort = 0; /* sort in downward(alpha or numeric) order */
153 static int sort_numerically = 0; /* sort in numeric rather than alpha order */
154 static int undefined_only = 0; /* print undefined symbols only */
155 static int dynamic = 0; /* print dynamic symbols. */
156 static int show_version = 0; /* show the version number */
158 /* When to print the names of files. Not mutually exclusive in SYSV format. */
159 static int filename_per_file = 0; /* Once per file, on its own line. */
160 static int filename_per_symbol = 0; /* Once per symbol, at start of line. */
162 /* Print formats for printing a symbol value. */
163 #ifdef BFD_HOST_64_BIT
164 static char value_format[] = "%08x%08x";
166 static char value_format[] = "%08lx";
168 /* Print formats for printing stab info. */
169 static char other_format[] = "%02x";
170 static char desc_format[] = "%04x";
173 extern char *program_name;
174 extern char *program_version;
176 extern int print_version;
178 static struct option long_options[] =
180 {"debug-syms", no_argument, &print_debug_syms, 1},
181 {"demangle", no_argument, &do_demangle, 1},
182 {"dynamic", no_argument, &dynamic, 1},
183 {"extern-only", no_argument, &external_only, 1},
184 {"format", required_argument, 0, 'f'},
185 {"help", no_argument, 0, 'h'},
186 {"no-sort", no_argument, &no_sort, 1},
187 {"numeric-sort", no_argument, &sort_numerically, 1},
188 {"portability", no_argument, 0, 'P'},
189 {"print-armap", no_argument, &print_armap, 1},
190 {"print-file-name", no_argument, 0, 'o'},
191 {"radix", required_argument, 0, 't'},
192 {"reverse-sort", no_argument, &reverse_sort, 1},
193 {"target", required_argument, 0, 200},
194 {"undefined-only", no_argument, &undefined_only, 1},
195 {"version", no_argument, &show_version, 1},
196 {0, no_argument, 0, 0}
199 /* Some error-reporting functions */
202 usage (stream, status)
207 Usage: %s [-aABCDgnopPrsuvV] [-t radix] [--radix=radix] [--target=bfdname]\n\
208 [--debug-syms] [--extern-only] [--print-armap] [--print-file-name]\n\
209 [--numeric-sort] [--no-sort] [--reverse-sort] [--undefined-only]\n\
210 [--portability] [-f {bsd,sysv,posix}] [--format={bsd,sysv,posix}]\n\
211 [--demangle] [--dynamic] [--version] [--help] [file...]\n",
216 /* Set the radix for the symbol value and size according to RADIX. */
219 set_print_radix (radix)
227 #ifdef BFD_HOST_64_BIT
228 value_format[3] = value_format[7] = *radix;
230 value_format[4] = *radix;
232 other_format[3] = desc_format[3] = *radix;
235 fprintf (stderr, "%s: %s: invalid radix\n", program_name, radix);
241 set_output_format (f)
261 fprintf (stderr, "%s: %s: invalid output format\n", program_name, f);
264 format = &formats[i];
275 program_name = *argv;
276 xmalloc_set_program_name (program_name);
280 while ((c = getopt_long (argc, argv, "aABCDf:gnopPrst:uvV", long_options, (int *) 0)) != EOF)
285 print_debug_syms = 1;
289 filename_per_symbol = 1;
291 case 'B': /* For MIPS compatibility. */
292 set_output_format ("bsd");
301 set_output_format (optarg);
310 sort_numerically = 1;
316 set_output_format ("posix");
325 set_print_radix (optarg);
334 case 200: /* --target */
338 case 0: /* A long option that just sets a flag. */
348 printf ("GNU %s version %s\n", program_name, program_version);
352 /* OK, all options now parsed. If no filename specified, do a.out. */
354 return !display_file ("a.out");
358 if (argc - optind > 1)
359 filename_per_file = 1;
361 /* We were given several filenames to do. */
362 while (optind < argc)
364 if (!display_file (argv[optind++]))
373 display_archive (file)
377 bfd *last_arfile = NULL;
380 (*format->print_archive_filename) (bfd_get_filename (file));
383 print_symdef_entry (file);
387 arfile = bfd_openr_next_archived_file (file, arfile);
391 if (bfd_get_error () != bfd_error_no_more_archived_files)
392 bfd_fatal (bfd_get_filename (file));
396 if (bfd_check_format_matches (arfile, bfd_object, &matching))
398 (*format->print_archive_member) (bfd_get_filename (file),
399 bfd_get_filename (arfile));
400 display_rel_file (arfile, file);
404 bfd_nonfatal (bfd_get_filename (arfile));
405 if (bfd_get_error () == bfd_error_file_ambiguously_recognized)
407 list_matching_formats (matching);
412 if (last_arfile != NULL)
413 bfd_close (last_arfile);
414 last_arfile = arfile;
417 if (last_arfile != NULL)
418 bfd_close (last_arfile);
422 display_file (filename)
425 boolean retval = true;
429 file = bfd_openr (filename, target);
432 bfd_nonfatal (filename);
436 if (bfd_check_format (file, bfd_archive))
438 display_archive (file);
440 else if (bfd_check_format_matches (file, bfd_object, &matching))
442 (*format->print_object_filename) (filename);
443 display_rel_file (file, NULL);
447 bfd_nonfatal (filename);
448 if (bfd_get_error () == bfd_error_file_ambiguously_recognized)
450 list_matching_formats (matching);
456 if (bfd_close (file) == false)
457 bfd_fatal (filename);
462 /* Symbol-sorting predicates */
463 #define valueof(x) ((x)->section->vma + (x)->value)
465 numeric_forward (x, y)
469 return (valueof (*(asymbol **) x) - valueof (*(asymbol **) y));
473 numeric_reverse (x, y)
477 return (valueof (*(asymbol **) y) - valueof (*(asymbol **) x));
481 non_numeric_forward (x, y)
485 CONST char *xn = (*(asymbol **) x)->name;
486 CONST char *yn = (*(asymbol **) y)->name;
488 return ((xn == NULL) ? ((yn == NULL) ? 0 : -1) :
489 ((yn == NULL) ? 1 : strcmp (xn, yn)));
493 non_numeric_reverse (x, y)
497 return -(non_numeric_forward (x, y));
500 static int (*(sorters[2][2])) PARAMS ((CONST void *, CONST void *)) =
502 { non_numeric_forward, non_numeric_reverse },
503 { numeric_forward, numeric_reverse }
506 /* If ARCHIVE_BFD is non-NULL, it is the archive containing ABFD. */
509 display_rel_file (abfd, archive_bfd)
519 if (!(bfd_get_file_flags (abfd) & DYNAMIC))
521 printf ("\"%s\" is not a dynamic object.\n",
522 bfd_get_filename (abfd));
528 if (!(bfd_get_file_flags (abfd) & HAS_SYMS))
530 printf ("No symbols in \"%s\".\n", bfd_get_filename (abfd));
536 storage = bfd_get_dynamic_symtab_upper_bound (abfd);
538 storage = bfd_get_symtab_upper_bound (abfd);
540 bfd_fatal (bfd_get_filename (abfd));
545 fprintf (stderr, "%s: no symbols\n", bfd_get_filename (abfd));
547 fprintf (stderr, "%s: Symflags set but there are none?\n",
548 bfd_get_filename (abfd));
552 syms = (asymbol **) xmalloc (storage);
555 symcount = bfd_canonicalize_dynamic_symtab (abfd, syms);
557 symcount = bfd_canonicalize_symtab (abfd, syms);
559 bfd_fatal (bfd_get_filename (abfd));
566 /* Discard the symbols we don't want to print.
567 It's OK to do this in place; we'll free the storage anyway
570 symcount = filter_symbols (abfd, syms, symcount);
573 qsort ((char *) syms, symcount, sizeof (asymbol *),
574 sorters[sort_numerically][reverse_sort]);
576 print_symbols (abfd, syms, symcount, archive_bfd);
580 /* Choose which symbol entries to print;
581 compact them downward to get rid of the rest.
582 Return the number of symbols to be printed. */
585 filter_symbols (abfd, syms, symcount)
586 bfd *abfd; /* Unused. */
588 unsigned long symcount;
590 asymbol **from, **to;
591 unsigned int src_count;
592 unsigned int dst_count = 0;
595 for (from = to = syms, src_count = 0; src_count < symcount; src_count++)
598 flagword flags = (from[src_count])->flags;
600 sym = from[src_count];
602 keep = sym->section == &bfd_und_section;
603 else if (external_only)
604 keep = ((flags & BSF_GLOBAL)
605 || (sym->section == &bfd_und_section)
606 || (bfd_is_com_section (sym->section)));
610 if (!print_debug_syms && ((flags & BSF_DEBUGGING) != 0))
614 to[dst_count++] = from[src_count];
620 /* Print symbol name NAME, read from ABFD, with printf format FORMAT,
621 demangling it if requested. */
624 print_symname (format, name, abfd)
632 /* In this mode, give a user-level view of the symbol name
633 even if it's not mangled; strip off any leading
635 if (bfd_get_symbol_leading_char (abfd) == name[0])
638 res = cplus_demangle (name, DMGL_ANSI | DMGL_PARAMS);
641 printf (format, res);
647 printf (format, name);
650 /* If ARCHIVE_BFD is non-NULL, it is the archive containing ABFD. */
653 print_symbols (abfd, syms, symcount, archive_bfd)
656 unsigned long symcount;
659 asymbol **sym = syms, **end = syms + symcount;
662 for (; sym < end; ++sym)
664 (*format->print_symbol_filename) (archive_bfd, abfd);
668 if ((*sym)->section == &bfd_und_section)
670 print_symname ("%s\n", (*sym)->name, abfd);
678 bfd_get_symbol_info (abfd, p, &syminfo);
679 (*format->print_symbol_info) (&syminfo, abfd);
686 /* The following 3 groups of functions are called unconditionally,
687 once at the start of processing each file of the appropriate type.
688 They should check `filename_per_file' and `filename_per_symbol',
689 as appropriate for their output format, to determine whether to
692 /* Print the name of an object file given on the command line. */
695 print_object_filename_bsd (filename)
698 if (filename_per_file && !filename_per_symbol)
699 printf ("\n%s:\n", filename);
703 print_object_filename_sysv (filename)
707 printf ("\n\nUndefined symbols from %s:\n\n", filename);
709 printf ("\n\nSymbols from %s:\n\n", filename);
711 Name Value Class Type Size Line Section\n\n");
715 print_object_filename_posix (filename)
718 if (filename_per_file && !filename_per_symbol)
719 printf ("%s:\n", filename);
722 /* Print the name of an archive file given on the command line. */
725 print_archive_filename_bsd (filename)
728 if (filename_per_file)
729 printf ("\n%s:\n", filename);
733 print_archive_filename_sysv (filename)
739 print_archive_filename_posix (filename)
744 /* Print the name of an archive member file. */
747 print_archive_member_bsd (archive, filename)
749 CONST char *filename;
751 if (!filename_per_symbol)
752 printf ("\n%s:\n", filename);
756 print_archive_member_sysv (archive, filename)
758 CONST char *filename;
761 printf ("\n\nUndefined symbols from %s[%s]:\n\n", archive, filename);
763 printf ("\n\nSymbols from %s[%s]:\n\n", archive, filename);
765 Name Value Class Type Size Line Section\n\n");
769 print_archive_member_posix (archive, filename)
771 CONST char *filename;
773 if (!filename_per_symbol)
774 printf ("%s[%s]:\n", archive, filename);
777 /* Print the name of the file (and archive, if there is one)
778 containing a symbol. */
781 print_symbol_filename_bsd (archive_bfd, abfd)
782 bfd *archive_bfd, *abfd;
784 if (filename_per_symbol)
787 printf ("%s:", bfd_get_filename (archive_bfd));
788 printf ("%s:", bfd_get_filename (abfd));
793 print_symbol_filename_sysv (archive_bfd, abfd)
794 bfd *archive_bfd, *abfd;
796 if (filename_per_symbol)
799 printf ("%s:", bfd_get_filename (archive_bfd));
800 printf ("%s:", bfd_get_filename (abfd));
805 print_symbol_filename_posix (archive_bfd, abfd)
806 bfd *archive_bfd, *abfd;
808 if (filename_per_symbol)
811 printf ("%s[%s]: ", bfd_get_filename (archive_bfd),
812 bfd_get_filename (abfd));
814 printf ("%s: ", bfd_get_filename (abfd));
818 /* Print a line of information about a symbol. */
821 print_symbol_info_bsd (info, abfd)
825 if (info->type == 'U')
829 #ifdef BFD_HOST_64_BIT
830 printf (value_format, uint64_typeHIGH (info->value),
831 uint64_typeLOW (info->value));
833 printf (value_format, info->value);
836 printf (" %c", info->type);
837 if (info->type == '-')
841 printf (other_format, info->stab_other);
843 printf (desc_format, info->stab_desc);
844 printf (" %5s", info->stab_name);
846 print_symname (" %s", info->name, abfd);
850 print_symbol_info_sysv (info, abfd)
854 print_symname ("%-20s|", info->name, abfd); /* Name */
855 if (info->type == 'U')
856 printf (" "); /* Value */
859 #ifdef BFD_HOST_64_BIT
860 printf (value_format, uint64_typeHIGH (info->value),
861 uint64_typeLOW (info->value));
863 printf (value_format, info->value);
866 printf ("| %c |", info->type); /* Class */
867 if (info->type == '-')
870 printf ("%18s| ", info->stab_name); /* (C) Type */
871 printf (desc_format, info->stab_desc); /* Size */
872 printf ("| |"); /* Line, Section */
875 printf (" | | |"); /* Type, Size, Line, Section */
879 print_symbol_info_posix (info, abfd)
883 print_symname ("%s ", info->name, abfd);
884 printf ("%c ", info->type);
885 if (info->type == 'U')
889 #ifdef BFD_HOST_64_BIT
890 printf (value_format, uint64_typeHIGH (info->value),
891 uint64_typeLOW (info->value));
893 printf (value_format, info->value);
896 /* POSIX.2 wants the symbol size printed here, when applicable;
897 BFD currently doesn't provide it, so we take the easy way out by
898 considering it to never be applicable. */
902 print_symdef_entry (abfd)
905 symindex idx = BFD_NO_MORE_SYMBOLS;
907 boolean everprinted = false;
909 for (idx = bfd_get_next_mapent (abfd, idx, &thesym);
910 idx != BFD_NO_MORE_SYMBOLS;
911 idx = bfd_get_next_mapent (abfd, idx, &thesym))
916 printf ("\nArchive index:\n");
919 elt = bfd_get_elt_at_index (abfd, idx);
920 if (thesym->name != (char *) NULL)
922 printf ("%s in %s\n", thesym->name, bfd_get_filename (elt));