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
;
274 xmalloc_set_program_name (program_name
);
278 while ((c
= getopt_long (argc
, argv
, "aABCf:gnopPrst:uvV", long_options
, (int *) 0)) != EOF
)
283 print_debug_syms
= 1;
287 filename_per_symbol
= 1;
289 case 'B': /* For MIPS compatibility. */
290 set_output_format ("bsd");
296 set_output_format (optarg
);
305 sort_numerically
= 1;
311 set_output_format ("posix");
320 set_print_radix (optarg
);
329 case 200: /* --target */
333 case 0: /* A long option that just sets a flag. */
343 printf ("GNU %s version %s\n", program_name
, program_version
);
347 /* OK, all options now parsed. If no filename specified, do a.out. */
349 return !display_file ("a.out");
353 if (argc
- optind
> 1)
354 filename_per_file
= 1;
356 /* We were given several filenames to do. */
357 while (optind
< argc
)
359 if (!display_file (argv
[optind
++]))
368 display_archive (file
)
372 bfd
*last_arfile
= NULL
;
375 (*format
->print_archive_filename
) (bfd_get_filename (file
));
378 print_symdef_entry (file
);
382 arfile
= bfd_openr_next_archived_file (file
, arfile
);
386 if (bfd_get_error () != bfd_error_no_more_archived_files
)
387 bfd_fatal (bfd_get_filename (file
));
391 if (bfd_check_format_matches (arfile
, bfd_object
, &matching
))
393 (*format
->print_archive_member
) (bfd_get_filename (file
),
394 bfd_get_filename (arfile
));
395 display_rel_file (arfile
, file
);
399 bfd_nonfatal (bfd_get_filename (arfile
));
400 if (bfd_get_error () == bfd_error_file_ambiguously_recognized
)
402 list_matching_formats (matching
);
407 if (last_arfile
!= NULL
)
408 bfd_close (last_arfile
);
409 last_arfile
= arfile
;
412 if (last_arfile
!= NULL
)
413 bfd_close (last_arfile
);
417 display_file (filename
)
420 boolean retval
= true;
424 file
= bfd_openr (filename
, target
);
427 bfd_nonfatal (filename
);
431 if (bfd_check_format (file
, bfd_archive
))
433 display_archive (file
);
435 else if (bfd_check_format_matches (file
, bfd_object
, &matching
))
437 (*format
->print_object_filename
) (filename
);
438 display_rel_file (file
, NULL
);
442 bfd_nonfatal (filename
);
443 if (bfd_get_error () == bfd_error_file_ambiguously_recognized
)
445 list_matching_formats (matching
);
451 if (bfd_close (file
) == false)
452 bfd_fatal (filename
);
457 /* Symbol-sorting predicates */
458 #define valueof(x) ((x)->section->vma + (x)->value)
460 numeric_forward (x
, y
)
464 return (valueof (*(asymbol
**) x
) - valueof (*(asymbol
**) y
));
468 numeric_reverse (x
, y
)
472 return (valueof (*(asymbol
**) y
) - valueof (*(asymbol
**) x
));
476 non_numeric_forward (x
, y
)
480 CONST
char *xn
= (*(asymbol
**) x
)->name
;
481 CONST
char *yn
= (*(asymbol
**) y
)->name
;
483 return ((xn
== NULL
) ? ((yn
== NULL
) ? 0 : -1) :
484 ((yn
== NULL
) ? 1 : strcmp (xn
, yn
)));
488 non_numeric_reverse (x
, y
)
492 return -(non_numeric_forward (x
, y
));
495 static int (*(sorters
[2][2])) PARAMS ((CONST
void *, CONST
void *)) =
497 { non_numeric_forward
, non_numeric_reverse
},
498 { numeric_forward
, numeric_reverse
}
501 /* If ARCHIVE_BFD is non-NULL, it is the archive containing ABFD. */
504 display_rel_file (abfd
, archive_bfd
)
512 if (!(bfd_get_file_flags (abfd
) & HAS_SYMS
))
514 printf ("No symbols in \"%s\".\n", bfd_get_filename (abfd
));
518 storage
= bfd_get_symtab_upper_bound (abfd
);
520 bfd_fatal (bfd_get_filename (abfd
));
524 fprintf (stderr
, "%s: Symflags set but there are none?\n",
525 bfd_get_filename (abfd
));
529 syms
= (asymbol
**) xmalloc (storage
);
531 symcount
= bfd_canonicalize_symtab (abfd
, syms
);
533 bfd_fatal (bfd_get_filename (abfd
));
540 /* Discard the symbols we don't want to print.
541 It's OK to do this in place; we'll free the storage anyway
544 symcount
= filter_symbols (abfd
, syms
, symcount
);
547 qsort ((char *) syms
, symcount
, sizeof (asymbol
*),
548 sorters
[sort_numerically
][reverse_sort
]);
550 print_symbols (abfd
, syms
, symcount
, archive_bfd
);
554 /* Choose which symbol entries to print;
555 compact them downward to get rid of the rest.
556 Return the number of symbols to be printed. */
559 filter_symbols (abfd
, syms
, symcount
)
560 bfd
*abfd
; /* Unused. */
562 unsigned long symcount
;
564 asymbol
**from
, **to
;
565 unsigned int src_count
;
566 unsigned int dst_count
= 0;
569 for (from
= to
= syms
, src_count
= 0; src_count
< symcount
; src_count
++)
572 flagword flags
= (from
[src_count
])->flags
;
574 sym
= from
[src_count
];
576 keep
= sym
->section
== &bfd_und_section
;
577 else if (external_only
)
578 keep
= ((flags
& BSF_GLOBAL
)
579 || (sym
->section
== &bfd_und_section
)
580 || (bfd_is_com_section (sym
->section
)));
584 if (!print_debug_syms
&& ((flags
& BSF_DEBUGGING
) != 0))
588 to
[dst_count
++] = from
[src_count
];
594 /* Print symbol name NAME, read from ABFD, with printf format FORMAT,
595 demangling it if requested. */
598 print_symname (format
, name
, abfd
)
606 /* In this mode, give a user-level view of the symbol name
607 even if it's not mangled; strip off any leading
609 if (bfd_get_symbol_leading_char (abfd
) == name
[0])
612 res
= cplus_demangle (name
, DMGL_ANSI
| DMGL_PARAMS
);
615 printf (format
, res
);
621 printf (format
, name
);
624 /* If ARCHIVE_BFD is non-NULL, it is the archive containing ABFD. */
627 print_symbols (abfd
, syms
, symcount
, archive_bfd
)
630 unsigned long symcount
;
633 asymbol
**sym
= syms
, **end
= syms
+ symcount
;
636 for (; sym
< end
; ++sym
)
638 (*format
->print_symbol_filename
) (archive_bfd
, abfd
);
642 if ((*sym
)->section
== &bfd_und_section
)
644 print_symname ("%s\n", (*sym
)->name
, abfd
);
652 bfd_get_symbol_info (abfd
, p
, &syminfo
);
653 (*format
->print_symbol_info
) (&syminfo
, abfd
);
660 /* The following 3 groups of functions are called unconditionally,
661 once at the start of processing each file of the appropriate type.
662 They should check `filename_per_file' and `filename_per_symbol',
663 as appropriate for their output format, to determine whether to
666 /* Print the name of an object file given on the command line. */
669 print_object_filename_bsd (filename
)
672 if (filename_per_file
&& !filename_per_symbol
)
673 printf ("\n%s:\n", filename
);
677 print_object_filename_sysv (filename
)
681 printf ("\n\nUndefined symbols from %s:\n\n", filename
);
683 printf ("\n\nSymbols from %s:\n\n", filename
);
685 Name Value Class Type Size Line Section\n\n");
689 print_object_filename_posix (filename
)
692 if (filename_per_file
&& !filename_per_symbol
)
693 printf ("%s:\n", filename
);
696 /* Print the name of an archive file given on the command line. */
699 print_archive_filename_bsd (filename
)
702 if (filename_per_file
)
703 printf ("\n%s:\n", filename
);
707 print_archive_filename_sysv (filename
)
713 print_archive_filename_posix (filename
)
718 /* Print the name of an archive member file. */
721 print_archive_member_bsd (archive
, filename
)
723 CONST
char *filename
;
725 if (!filename_per_symbol
)
726 printf ("\n%s:\n", filename
);
730 print_archive_member_sysv (archive
, filename
)
732 CONST
char *filename
;
735 printf ("\n\nUndefined symbols from %s[%s]:\n\n", archive
, filename
);
737 printf ("\n\nSymbols from %s[%s]:\n\n", archive
, filename
);
739 Name Value Class Type Size Line Section\n\n");
743 print_archive_member_posix (archive
, filename
)
745 CONST
char *filename
;
747 if (!filename_per_symbol
)
748 printf ("%s[%s]:\n", archive
, filename
);
751 /* Print the name of the file (and archive, if there is one)
752 containing a symbol. */
755 print_symbol_filename_bsd (archive_bfd
, abfd
)
756 bfd
*archive_bfd
, *abfd
;
758 if (filename_per_symbol
)
761 printf ("%s:", bfd_get_filename (archive_bfd
));
762 printf ("%s:", bfd_get_filename (abfd
));
767 print_symbol_filename_sysv (archive_bfd
, abfd
)
768 bfd
*archive_bfd
, *abfd
;
770 if (filename_per_symbol
)
773 printf ("%s:", bfd_get_filename (archive_bfd
));
774 printf ("%s:", bfd_get_filename (abfd
));
779 print_symbol_filename_posix (archive_bfd
, abfd
)
780 bfd
*archive_bfd
, *abfd
;
782 if (filename_per_symbol
)
785 printf ("%s[%s]: ", bfd_get_filename (archive_bfd
),
786 bfd_get_filename (abfd
));
788 printf ("%s: ", bfd_get_filename (abfd
));
792 /* Print a line of information about a symbol. */
795 print_symbol_info_bsd (info
, abfd
)
799 if (info
->type
== 'U')
804 printf (value_format
, uint64_typeHIGH (info
->value
),
805 uint64_typeLOW (info
->value
));
807 printf (value_format
, info
->value
);
810 printf (" %c", info
->type
);
811 if (info
->type
== '-')
815 printf (other_format
, info
->stab_other
);
817 printf (desc_format
, info
->stab_desc
);
818 printf (" %5s", info
->stab_name
);
820 print_symname (" %s", info
->name
, abfd
);
824 print_symbol_info_sysv (info
, abfd
)
828 print_symname ("%-20s|", info
->name
, abfd
); /* Name */
829 if (info
->type
== 'U')
830 printf (" "); /* Value */
834 printf (value_format
, uint64_typeHIGH (info
->value
),
835 uint64_typeLOW (info
->value
));
837 printf (value_format
, info
->value
);
840 printf ("| %c |", info
->type
); /* Class */
841 if (info
->type
== '-')
844 printf ("%18s| ", info
->stab_name
); /* (C) Type */
845 printf (desc_format
, info
->stab_desc
); /* Size */
846 printf ("| |"); /* Line, Section */
849 printf (" | | |"); /* Type, Size, Line, Section */
853 print_symbol_info_posix (info
, abfd
)
857 print_symname ("%s ", info
->name
, abfd
);
858 printf ("%c ", info
->type
);
859 if (info
->type
== 'U')
864 printf (value_format
, uint64_typeHIGH (info
->value
),
865 uint64_typeLOW (info
->value
));
867 printf (value_format
, info
->value
);
870 /* POSIX.2 wants the symbol size printed here, when applicable;
871 BFD currently doesn't provide it, so we take the easy way out by
872 considering it to never be applicable. */
876 print_symdef_entry (abfd
)
879 symindex idx
= BFD_NO_MORE_SYMBOLS
;
881 boolean everprinted
= false;
883 for (idx
= bfd_get_next_mapent (abfd
, idx
, &thesym
);
884 idx
!= BFD_NO_MORE_SYMBOLS
;
885 idx
= bfd_get_next_mapent (abfd
, idx
, &thesym
))
890 printf ("\nArchive index:\n");
893 elt
= bfd_get_elt_at_index (abfd
, idx
);
894 if (thesym
->name
!= (char *) NULL
)
896 printf ("%s in %s\n", thesym
->name
, bfd_get_filename (elt
));