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 show_version
= 0; /* show the version number */
157 /* When to print the names of files. Not mutually exclusive in SYSV format. */
158 static int filename_per_file
= 0; /* Once per file, on its own line. */
159 static int filename_per_symbol
= 0; /* Once per symbol, at start of line. */
161 /* Print formats for printing a symbol value. */
163 static char value_format
[] = "%08x%08x";
165 static char value_format
[] = "%08lx";
167 /* Print formats for printing stab info. */
168 static char other_format
[] = "%02x";
169 static char desc_format
[] = "%04x";
172 extern char *program_name
;
173 extern char *program_version
;
175 extern int print_version
;
177 static struct option long_options
[] =
179 {"debug-syms", no_argument
, &print_debug_syms
, 1},
180 {"demangle", no_argument
, &do_demangle
, 1},
181 {"extern-only", no_argument
, &external_only
, 1},
182 {"format", required_argument
, 0, 'f'},
183 {"help", no_argument
, 0, 'h'},
184 {"no-sort", no_argument
, &no_sort
, 1},
185 {"numeric-sort", no_argument
, &sort_numerically
, 1},
186 {"portability", no_argument
, 0, 'P'},
187 {"print-armap", no_argument
, &print_armap
, 1},
188 {"print-file-name", no_argument
, 0, 'o'},
189 {"radix", required_argument
, 0, 't'},
190 {"reverse-sort", no_argument
, &reverse_sort
, 1},
191 {"target", required_argument
, 0, 200},
192 {"undefined-only", no_argument
, &undefined_only
, 1},
193 {"version", no_argument
, &show_version
, 1},
194 {0, no_argument
, 0, 0}
197 /* Some error-reporting functions */
200 usage (stream
, status
)
205 Usage: %s [-aABCgnopPrsuvV] [-t radix] [--radix=radix] [--target=bfdname]\n\
206 [--debug-syms] [--extern-only] [--print-armap] [--print-file-name]\n\
207 [--numeric-sort] [--no-sort] [--reverse-sort] [--undefined-only]\n\
208 [--portability] [-f {bsd,sysv,posix}] [--format={bsd,sysv,posix}]\n\
209 [--demangle] [--version] [--help] [file...]\n",
214 /* Set the radix for the symbol value and size according to RADIX. */
217 set_print_radix (radix
)
226 value_format
[3] = value_format
[7] = *radix
;
228 value_format
[4] = *radix
;
230 other_format
[3] = desc_format
[3] = *radix
;
233 fprintf (stderr
, "%s: %s: invalid radix\n", program_name
, radix
);
239 set_output_format (f
)
259 fprintf (stderr
, "%s: %s: invalid output format\n", program_name
, f
);
262 format
= &formats
[i
];
273 program_name
= *argv
;
277 while ((c
= getopt_long (argc
, argv
, "aABCf:gnopPrst:uvV", long_options
, (int *) 0)) != EOF
)
282 print_debug_syms
= 1;
286 filename_per_symbol
= 1;
288 case 'B': /* For MIPS compatibility. */
289 set_output_format ("bsd");
295 set_output_format (optarg
);
304 sort_numerically
= 1;
310 set_output_format ("posix");
319 set_print_radix (optarg
);
328 case 200: /* --target */
332 case 0: /* A long option that just sets a flag. */
342 printf ("GNU %s version %s\n", program_name
, program_version
);
346 /* OK, all options now parsed. If no filename specified, do a.out. */
348 return !display_file ("a.out");
352 if (argc
- optind
> 1)
353 filename_per_file
= 1;
355 /* We were given several filenames to do. */
356 while (optind
< argc
)
358 if (!display_file (argv
[optind
++]))
367 display_archive (file
)
373 (*format
->print_archive_filename
) (bfd_get_filename (file
));
376 print_symdef_entry (file
);
380 arfile
= bfd_openr_next_archived_file (file
, arfile
);
384 if (bfd_error
!= no_more_archived_files
)
385 bfd_fatal (bfd_get_filename (file
));
389 if (bfd_check_format_matches (arfile
, bfd_object
, &matching
))
391 (*format
->print_archive_member
) (bfd_get_filename (file
),
392 bfd_get_filename (arfile
));
393 display_rel_file (arfile
, file
);
397 bfd_nonfatal (bfd_get_filename (arfile
));
398 if (bfd_error
== file_ambiguously_recognized
)
400 list_matching_formats (matching
);
408 display_file (filename
)
411 boolean retval
= true;
415 file
= bfd_openr (filename
, target
);
418 bfd_nonfatal (filename
);
422 if (bfd_check_format (file
, bfd_archive
))
424 display_archive (file
);
426 else if (bfd_check_format_matches (file
, bfd_object
, &matching
))
428 (*format
->print_object_filename
) (filename
);
429 display_rel_file (file
, NULL
);
433 bfd_nonfatal (filename
);
434 if (bfd_error
== file_ambiguously_recognized
)
436 list_matching_formats (matching
);
442 if (bfd_close (file
) == false)
443 bfd_fatal (filename
);
448 /* Symbol-sorting predicates */
449 #define valueof(x) ((x)->section->vma + (x)->value)
451 numeric_forward (x
, y
)
455 return (valueof (*(asymbol
**) x
) - valueof (*(asymbol
**) y
));
459 numeric_reverse (x
, y
)
463 return (valueof (*(asymbol
**) y
) - valueof (*(asymbol
**) x
));
467 non_numeric_forward (x
, y
)
471 CONST
char *xn
= (*(asymbol
**) x
)->name
;
472 CONST
char *yn
= (*(asymbol
**) y
)->name
;
474 return ((xn
== NULL
) ? ((yn
== NULL
) ? 0 : -1) :
475 ((yn
== NULL
) ? 1 : strcmp (xn
, yn
)));
479 non_numeric_reverse (x
, y
)
483 return -(non_numeric_forward (x
, y
));
486 static int (*(sorters
[2][2])) PARAMS ((CONST
void *, CONST
void *)) =
488 { non_numeric_forward
, non_numeric_reverse
},
489 { numeric_forward
, numeric_reverse
}
492 /* If ARCHIVE_BFD is non-NULL, it is the archive containing ABFD. */
495 display_rel_file (abfd
, archive_bfd
)
499 unsigned int storage
;
501 unsigned int symcount
= 0;
503 if (!(bfd_get_file_flags (abfd
) & HAS_SYMS
))
505 printf ("No symbols in \"%s\".\n", bfd_get_filename (abfd
));
509 storage
= get_symtab_upper_bound (abfd
);
513 fprintf (stderr
, "%s: Symflags set but there are none?\n",
514 bfd_get_filename (abfd
));
518 syms
= (asymbol
**) xmalloc (storage
);
520 symcount
= bfd_canonicalize_symtab (abfd
, syms
);
527 /* Discard the symbols we don't want to print.
528 It's OK to do this in place; we'll free the storage anyway
531 symcount
= filter_symbols (abfd
, syms
, symcount
);
534 qsort ((char *) syms
, symcount
, sizeof (asymbol
*),
535 sorters
[sort_numerically
][reverse_sort
]);
537 print_symbols (abfd
, syms
, symcount
, archive_bfd
);
541 /* Choose which symbol entries to print;
542 compact them downward to get rid of the rest.
543 Return the number of symbols to be printed. */
546 filter_symbols (abfd
, syms
, symcount
)
547 bfd
*abfd
; /* Unused. */
549 unsigned long symcount
;
551 asymbol
**from
, **to
;
552 unsigned int src_count
;
553 unsigned int dst_count
= 0;
556 for (from
= to
= syms
, src_count
= 0; src_count
< symcount
; src_count
++)
559 flagword flags
= (from
[src_count
])->flags
;
561 sym
= from
[src_count
];
563 keep
= sym
->section
== &bfd_und_section
;
564 else if (external_only
)
565 keep
= ((flags
& BSF_GLOBAL
)
566 || (sym
->section
== &bfd_und_section
)
567 || (bfd_is_com_section (sym
->section
)));
571 if (!print_debug_syms
&& ((flags
& BSF_DEBUGGING
) != 0))
575 to
[dst_count
++] = from
[src_count
];
581 /* Print symbol name NAME, read from ABFD, with printf format FORMAT,
582 demangling it if requested. */
585 print_symname (format
, name
, abfd
)
593 /* In this mode, give a user-level view of the symbol name
594 even if it's not mangled; strip off any leading
596 if (bfd_get_symbol_leading_char (abfd
) == name
[0])
599 res
= cplus_demangle (name
, DMGL_ANSI
| DMGL_PARAMS
);
602 printf (format
, res
);
608 printf (format
, name
);
611 /* If ARCHIVE_BFD is non-NULL, it is the archive containing ABFD. */
614 print_symbols (abfd
, syms
, symcount
, archive_bfd
)
617 unsigned long symcount
;
620 asymbol
**sym
= syms
, **end
= syms
+ symcount
;
623 for (; sym
< end
; ++sym
)
625 (*format
->print_symbol_filename
) (archive_bfd
, abfd
);
629 if ((*sym
)->section
== &bfd_und_section
)
631 print_symname ("%s\n", (*sym
)->name
, abfd
);
639 bfd_get_symbol_info (abfd
, p
, &syminfo
);
640 (*format
->print_symbol_info
) (&syminfo
, abfd
);
647 /* The following 3 groups of functions are called unconditionally,
648 once at the start of processing each file of the appropriate type.
649 They should check `filename_per_file' and `filename_per_symbol',
650 as appropriate for their output format, to determine whether to
653 /* Print the name of an object file given on the command line. */
656 print_object_filename_bsd (filename
)
659 if (filename_per_file
&& !filename_per_symbol
)
660 printf ("\n%s:\n", filename
);
664 print_object_filename_sysv (filename
)
668 printf ("\n\nUndefined symbols from %s:\n\n", filename
);
670 printf ("\n\nSymbols from %s:\n\n", filename
);
672 Name Value Class Type Size Line Section\n\n");
676 print_object_filename_posix (filename
)
679 if (filename_per_file
&& !filename_per_symbol
)
680 printf ("%s:\n", filename
);
683 /* Print the name of an archive file given on the command line. */
686 print_archive_filename_bsd (filename
)
689 if (filename_per_file
)
690 printf ("\n%s:\n", filename
);
694 print_archive_filename_sysv (filename
)
700 print_archive_filename_posix (filename
)
705 /* Print the name of an archive member file. */
708 print_archive_member_bsd (archive
, filename
)
710 CONST
char *filename
;
712 if (!filename_per_symbol
)
713 printf ("\n%s:\n", filename
);
717 print_archive_member_sysv (archive
, filename
)
719 CONST
char *filename
;
722 printf ("\n\nUndefined symbols from %s[%s]:\n\n", archive
, filename
);
724 printf ("\n\nSymbols from %s[%s]:\n\n", archive
, filename
);
726 Name Value Class Type Size Line Section\n\n");
730 print_archive_member_posix (archive
, filename
)
732 CONST
char *filename
;
734 if (!filename_per_symbol
)
735 printf ("%s[%s]:\n", archive
, filename
);
738 /* Print the name of the file (and archive, if there is one)
739 containing a symbol. */
742 print_symbol_filename_bsd (archive_bfd
, abfd
)
743 bfd
*archive_bfd
, *abfd
;
745 if (filename_per_symbol
)
748 printf ("%s:", bfd_get_filename (archive_bfd
));
749 printf ("%s:", bfd_get_filename (abfd
));
754 print_symbol_filename_sysv (archive_bfd
, abfd
)
755 bfd
*archive_bfd
, *abfd
;
757 if (filename_per_symbol
)
760 printf ("%s:", bfd_get_filename (archive_bfd
));
761 printf ("%s:", bfd_get_filename (abfd
));
766 print_symbol_filename_posix (archive_bfd
, abfd
)
767 bfd
*archive_bfd
, *abfd
;
769 if (filename_per_symbol
)
772 printf ("%s[%s]: ", bfd_get_filename (archive_bfd
),
773 bfd_get_filename (abfd
));
775 printf ("%s: ", bfd_get_filename (abfd
));
779 /* Print a line of information about a symbol. */
782 print_symbol_info_bsd (info
, abfd
)
786 if (info
->type
== 'U')
791 printf (value_format
, uint64_typeHIGH (info
->value
),
792 uint64_typeLOW (info
->value
));
794 printf (value_format
, info
->value
);
797 printf (" %c", info
->type
);
798 if (info
->type
== '-')
802 printf (other_format
, info
->stab_other
);
804 printf (desc_format
, info
->stab_desc
);
805 printf (" %5s", info
->stab_name
);
807 print_symname (" %s", info
->name
, abfd
);
811 print_symbol_info_sysv (info
, abfd
)
815 print_symname ("%-20s|", info
->name
, abfd
); /* Name */
816 if (info
->type
== 'U')
817 printf (" "); /* Value */
821 printf (value_format
, uint64_typeHIGH (info
->value
),
822 uint64_typeLOW (info
->value
));
824 printf (value_format
, info
->value
);
827 printf ("| %c |", info
->type
); /* Class */
828 if (info
->type
== '-')
831 printf ("%18s| ", info
->stab_name
); /* (C) Type */
832 printf (desc_format
, info
->stab_desc
); /* Size */
833 printf ("| |"); /* Line, Section */
836 printf (" | | |"); /* Type, Size, Line, Section */
840 print_symbol_info_posix (info
, abfd
)
844 print_symname ("%s ", info
->name
, abfd
);
845 printf ("%c ", info
->type
);
846 if (info
->type
== 'U')
851 printf (value_format
, uint64_typeHIGH (info
->value
),
852 uint64_typeLOW (info
->value
));
854 printf (value_format
, info
->value
);
857 /* POSIX.2 wants the symbol size printed here, when applicable;
858 BFD currently doesn't provide it, so we take the easy way out by
859 considering it to never be applicable. */
863 print_symdef_entry (abfd
)
866 symindex idx
= BFD_NO_MORE_SYMBOLS
;
868 boolean everprinted
= false;
870 for (idx
= bfd_get_next_mapent (abfd
, idx
, &thesym
);
871 idx
!= BFD_NO_MORE_SYMBOLS
;
872 idx
= bfd_get_next_mapent (abfd
, idx
, &thesym
))
877 printf ("\nArchive index:\n");
880 elt
= bfd_get_elt_at_index (abfd
, idx
);
881 if (thesym
->name
!= (char *) NULL
)
883 printf ("%s in %s\n", thesym
->name
, bfd_get_filename (elt
));