binutils/size.c

   1 /* size.c -- report size of various sections of an executable file.
   2    Copyright (C) 1991-2019 Free Software Foundation, Inc.
   3
   4    This file is part of GNU Binutils.
   5
   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 3 of the License, or
   9    (at your option) any later version.
  10
  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.
  15
  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., 51 Franklin Street - Fifth Floor, Boston,
  19    MA 02110-1301, USA.  */
  20 \f
  21 /* Extensions/incompatibilities:
  22    o - BSD output has filenames at the end.
  23    o - BSD output can appear in different radicies.
  24    o - SysV output has less redundant whitespace.  Filename comes at end.
  25    o - SysV output doesn't show VMA which is always the same as the PMA.
  26    o - We also handle core files.
  27    o - We also handle archives.
  28    If you write shell scripts which manipulate this info then you may be
  29    out of luck; there's no --compatibility or --pedantic option.  */
  30
  31 #include "sysdep.h"
  32 #include "bfd.h"
  33 #include "libiberty.h"
  34 #include "getopt.h"
  35 #include "bucomm.h"
  36
  37 #ifndef BSD_DEFAULT
  38 #define BSD_DEFAULT 1
  39 #endif
  40
  41 /* Program options.  */
  42
  43 static enum
  44   {
  45     decimal, octal, hex
  46   }
  47 radix = decimal;
  48
  49 /* 0 means use AT&T-style output.  */
  50 static int berkeley_format = BSD_DEFAULT;
  51
  52 static int show_version = 0;
  53 static int show_help = 0;
  54 static int show_totals = 0;
  55 static int show_common = 0;
  56
  57 static bfd_size_type common_size;
  58 static bfd_size_type total_bsssize;
  59 static bfd_size_type total_datasize;
  60 static bfd_size_type total_textsize;
  61
  62 /* Program exit status.  */
  63 static int return_code = 0;
  64
  65 static char *target = NULL;
  66
  67 /* Forward declarations.  */
  68
  69 static void display_file (char *);
  70 static void rprint_number (int, bfd_size_type);
  71 static void print_sizes (bfd * file);
  72 \f
  73 static void
  74 usage (FILE *stream, int status)
  75 {
  76   fprintf (stream, _("Usage: %s [option(s)] [file(s)]\n"), program_name);
  77   fprintf (stream, _(" Displays the sizes of sections inside binary files\n"));
  78   fprintf (stream, _(" If no input file(s) are specified, a.out is assumed\n"));
  79   fprintf (stream, _(" The options are:\n\
  80   -A|-B     --format={sysv|berkeley}  Select output style (default is %s)\n\
  81   -o|-d|-x  --radix={8|10|16}         Display numbers in octal, decimal or hex\n\
  82   -t        --totals                  Display the total sizes (Berkeley only)\n\
  83             --common                  Display total size for *COM* syms\n\
  84             --target=<bfdname>        Set the binary file format\n\
  85             @<file>                   Read options from <file>\n\
  86   -h        --help                    Display this information\n\
  87   -v        --version                 Display the program's version\n\
  88 \n"),
  89 #if BSD_DEFAULT
  90   "berkeley"
  91 #else
  92   "sysv"
  93 #endif
  94 );
  95   list_supported_targets (program_name, stream);
  96   if (REPORT_BUGS_TO[0] && status == 0)
  97     fprintf (stream, _("Report bugs to %s\n"), REPORT_BUGS_TO);
  98   exit (status);
  99 }
 100
 101 #define OPTION_FORMAT (200)
 102 #define OPTION_RADIX (OPTION_FORMAT + 1)
 103 #define OPTION_TARGET (OPTION_RADIX + 1)
 104
 105 static struct option long_options[] =
 106 {
 107   {"common", no_argument, &show_common, 1},
 108   {"format", required_argument, 0, OPTION_FORMAT},
 109   {"radix", required_argument, 0, OPTION_RADIX},
 110   {"target", required_argument, 0, OPTION_TARGET},
 111   {"totals", no_argument, &show_totals, 1},
 112   {"version", no_argument, &show_version, 1},
 113   {"help", no_argument, &show_help, 1},
 114   {0, no_argument, 0, 0}
 115 };
 116
 117 int main (int, char **);
 118
 119 int
 120 main (int argc, char **argv)
 121 {
 122   int temp;
 123   int c;
 124
 125 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
 126   setlocale (LC_MESSAGES, "");
 127 #endif
 128 #if defined (HAVE_SETLOCALE)
 129   setlocale (LC_CTYPE, "");
 130 #endif
 131   bindtextdomain (PACKAGE, LOCALEDIR);
 132   textdomain (PACKAGE);
 133
 134   program_name = *argv;
 135   xmalloc_set_program_name (program_name);
 136   bfd_set_error_program_name (program_name);
 137
 138   expandargv (&argc, &argv);
 139
 140   if (bfd_init () != BFD_INIT_MAGIC)
 141     fatal (_("fatal error: libbfd ABI mismatch"));
 142   set_default_bfd_target ();
 143
 144   while ((c = getopt_long (argc, argv, "ABHhVvdfotx", long_options,
 145                            (int *) 0)) != EOF)
 146     switch (c)
 147       {
 148       case OPTION_FORMAT:
 149         switch (*optarg)
 150           {
 151           case 'B':
 152           case 'b':
 153             berkeley_format = 1;
 154             break;
 155           case 'S':
 156           case 's':
 157             berkeley_format = 0;
 158             break;
 159           default:
 160             non_fatal (_("invalid argument to --format: %s"), optarg);
 161             usage (stderr, 1);
 162           }
 163         break;
 164
 165       case OPTION_TARGET:
 166         target = optarg;
 167         break;
 168
 169       case OPTION_RADIX:
 170 #ifdef ANSI_LIBRARIES
 171         temp = strtol (optarg, NULL, 10);
 172 #else
 173         temp = atol (optarg);
 174 #endif
 175         switch (temp)
 176           {
 177           case 10:
 178             radix = decimal;
 179             break;
 180           case 8:
 181             radix = octal;
 182             break;
 183           case 16:
 184             radix = hex;
 185             break;
 186           default:
 187             non_fatal (_("Invalid radix: %s\n"), optarg);
 188             usage (stderr, 1);
 189           }
 190         break;
 191
 192       case 'A':
 193         berkeley_format = 0;
 194         break;
 195       case 'B':
 196         berkeley_format = 1;
 197         break;
 198       case 'v':
 199       case 'V':
 200         show_version = 1;
 201         break;
 202       case 'd':
 203         radix = decimal;
 204         break;
 205       case 'x':
 206         radix = hex;
 207         break;
 208       case 'o':
 209         radix = octal;
 210         break;
 211       case 't':
 212         show_totals = 1;
 213         break;
 214       case 'f': /* FIXME : For sysv68, `-f' means `full format', i.e.
 215                    `[fname:] M(.text) + N(.data) + O(.bss) + P(.comment) = Q'
 216                    where `fname: ' appears only if there are >= 2 input files,
 217                    and M, N, O, P, Q are expressed in decimal by default,
 218                    hexa or octal if requested by `-x' or `-o'.
 219                    Just to make things interesting, Solaris also accepts -f,
 220                    which prints out the size of each allocatable section, the
 221                    name of the section, and the total of the section sizes.  */
 222                 /* For the moment, accept `-f' silently, and ignore it.  */
 223         break;
 224       case 0:
 225         break;
 226       case 'h':
 227       case 'H':
 228       case '?':
 229         usage (stderr, 1);
 230       }
 231
 232   if (show_version)
 233     print_version ("size");
 234   if (show_help)
 235     usage (stdout, 0);
 236
 237   if (optind == argc)
 238     display_file ("a.out");
 239   else
 240     for (; optind < argc;)
 241       display_file (argv[optind++]);
 242
 243   if (show_totals && berkeley_format)
 244     {
 245       bfd_size_type total = total_textsize + total_datasize + total_bsssize;
 246
 247       rprint_number (7, total_textsize);
 248       putchar('\t');
 249       rprint_number (7, total_datasize);
 250       putchar('\t');
 251       rprint_number (7, total_bsssize);
 252       printf (((radix == octal) ? "\t%7lo\t%7lx\t" : "\t%7lu\t%7lx\t"),
 253               (unsigned long) total, (unsigned long) total);
 254       fputs ("(TOTALS)\n", stdout);
 255     }
 256
 257   return return_code;
 258 }
 259 \f
 260 /* Total size required for common symbols in ABFD.  */
 261
 262 static void
 263 calculate_common_size (bfd *abfd)
 264 {
 265   asymbol **syms = NULL;
 266   long storage, symcount;
 267
 268   common_size = 0;
 269   if ((bfd_get_file_flags (abfd) & (EXEC_P | DYNAMIC | HAS_SYMS)) != HAS_SYMS)
 270     return;
 271
 272   storage = bfd_get_symtab_upper_bound (abfd);
 273   if (storage < 0)
 274     bfd_fatal (bfd_get_filename (abfd));
 275   if (storage)
 276     syms = (asymbol **) xmalloc (storage);
 277
 278   symcount = bfd_canonicalize_symtab (abfd, syms);
 279   if (symcount < 0)
 280     bfd_fatal (bfd_get_filename (abfd));
 281
 282   while (--symcount >= 0)
 283     {
 284       asymbol *sym = syms[symcount];
 285
 286       if (bfd_is_com_section (sym->section)
 287           && (sym->flags & BSF_SECTION_SYM) == 0)
 288         common_size += sym->value;
 289     }
 290   free (syms);
 291 }
 292
 293 /* Display stats on file or archive member ABFD.  */
 294
 295 static void
 296 display_bfd (bfd *abfd)
 297 {
 298   char **matching;
 299
 300   if (bfd_check_format (abfd, bfd_archive))
 301     /* An archive within an archive.  */
 302     return;
 303
 304   if (bfd_check_format_matches (abfd, bfd_object, &matching))
 305     {
 306       print_sizes (abfd);
 307       printf ("\n");
 308       return;
 309     }
 310
 311   if (bfd_get_error () == bfd_error_file_ambiguously_recognized)
 312     {
 313       bfd_nonfatal (bfd_get_filename (abfd));
 314       list_matching_formats (matching);
 315       free (matching);
 316       return_code = 3;
 317       return;
 318     }
 319
 320   if (bfd_check_format_matches (abfd, bfd_core, &matching))
 321     {
 322       const char *core_cmd;
 323
 324       print_sizes (abfd);
 325       fputs (" (core file", stdout);
 326
 327       core_cmd = bfd_core_file_failing_command (abfd);
 328       if (core_cmd)
 329         printf (" invoked as %s", core_cmd);
 330
 331       puts (")\n");
 332       return;
 333     }
 334
 335   bfd_nonfatal (bfd_get_filename (abfd));
 336
 337   if (bfd_get_error () == bfd_error_file_ambiguously_recognized)
 338     {
 339       list_matching_formats (matching);
 340       free (matching);
 341     }
 342
 343   return_code = 3;
 344 }
 345
 346 static void
 347 display_archive (bfd *file)
 348 {
 349   bfd *arfile = (bfd *) NULL;
 350   bfd *last_arfile = (bfd *) NULL;
 351
 352   for (;;)
 353     {
 354       bfd_set_error (bfd_error_no_error);
 355
 356       arfile = bfd_openr_next_archived_file (file, arfile);
 357       if (arfile == NULL)
 358         {
 359           if (bfd_get_error () != bfd_error_no_more_archived_files)
 360             {
 361               bfd_nonfatal (bfd_get_filename (file));
 362               return_code = 2;
 363             }
 364           break;
 365         }
 366
 367       display_bfd (arfile);
 368
 369       if (last_arfile != NULL)
 370         {
 371           bfd_close (last_arfile);
 372
 373           /* PR 17512: file: a244edbc.  */
 374           if (last_arfile == arfile)
 375             return;
 376         }
 377
 378       last_arfile = arfile;
 379     }
 380
 381   if (last_arfile != NULL)
 382     bfd_close (last_arfile);
 383 }
 384
 385 static void
 386 display_file (char *filename)
 387 {
 388   bfd *file;
 389
 390   if (get_file_size (filename) < 1)
 391     {
 392       return_code = 1;
 393       return;
 394     }
 395
 396   file = bfd_openr (filename, target);
 397   if (file == NULL)
 398     {
 399       bfd_nonfatal (filename);
 400       return_code = 1;
 401       return;
 402     }
 403
 404   if (bfd_check_format (file, bfd_archive))
 405     display_archive (file);
 406   else
 407     display_bfd (file);
 408
 409   if (!bfd_close (file))
 410     {
 411       bfd_nonfatal (filename);
 412       return_code = 1;
 413       return;
 414     }
 415 }
 416 \f
 417 static int
 418 size_number (bfd_size_type num)
 419 {
 420   char buffer[40];
 421
 422   sprintf (buffer,
 423            (radix == decimal ? "%" BFD_VMA_FMT "u" :
 424            ((radix == octal) ? "0%" BFD_VMA_FMT "o" : "0x%" BFD_VMA_FMT "x")),
 425            num);
 426
 427   return strlen (buffer);
 428 }
 429
 430 static void
 431 rprint_number (int width, bfd_size_type num)
 432 {
 433   char buffer[40];
 434
 435   sprintf (buffer,
 436            (radix == decimal ? "%" BFD_VMA_FMT "u" :
 437            ((radix == octal) ? "0%" BFD_VMA_FMT "o" : "0x%" BFD_VMA_FMT "x")),
 438            num);
 439
 440   printf ("%*s", width, buffer);
 441 }
 442
 443 static bfd_size_type bsssize;
 444 static bfd_size_type datasize;
 445 static bfd_size_type textsize;
 446
 447 static void
 448 berkeley_sum (bfd *abfd ATTRIBUTE_UNUSED, sec_ptr sec,
 449               void *ignore ATTRIBUTE_UNUSED)
 450 {
 451   flagword flags;
 452   bfd_size_type size;
 453
 454   flags = bfd_get_section_flags (abfd, sec);
 455   if ((flags & SEC_ALLOC) == 0)
 456     return;
 457
 458   size = bfd_get_section_size (sec);
 459   if ((flags & SEC_CODE) != 0 || (flags & SEC_READONLY) != 0)
 460     textsize += size;
 461   else if ((flags & SEC_HAS_CONTENTS) != 0)
 462     datasize += size;
 463   else
 464     bsssize += size;
 465 }
 466
 467 static void
 468 print_berkeley_format (bfd *abfd)
 469 {
 470   static int files_seen = 0;
 471   bfd_size_type total;
 472
 473   bsssize = 0;
 474   datasize = 0;
 475   textsize = 0;
 476
 477   bfd_map_over_sections (abfd, berkeley_sum, NULL);
 478
 479   bsssize += common_size;
 480   if (files_seen++ == 0)
 481     puts ((radix == octal) ? "   text\t   data\t    bss\t    oct\t    hex\tfilename" :
 482           "   text\t   data\t    bss\t    dec\t    hex\tfilename");
 483
 484   total = textsize + datasize + bsssize;
 485
 486   if (show_totals)
 487     {
 488       total_textsize += textsize;
 489       total_datasize += datasize;
 490       total_bsssize  += bsssize;
 491     }
 492
 493   rprint_number (7, textsize);
 494   putchar ('\t');
 495   rprint_number (7, datasize);
 496   putchar ('\t');
 497   rprint_number (7, bsssize);
 498   printf (((radix == octal) ? "\t%7lo\t%7lx\t" : "\t%7lu\t%7lx\t"),
 499           (unsigned long) total, (unsigned long) total);
 500
 501   fputs (bfd_get_filename (abfd), stdout);
 502
 503   if (abfd->my_archive)
 504     printf (" (ex %s)", bfd_get_filename (abfd->my_archive));
 505 }
 506
 507 /* I REALLY miss lexical functions! */
 508 bfd_size_type svi_total = 0;
 509 bfd_vma svi_maxvma = 0;
 510 int svi_namelen = 0;
 511 int svi_vmalen = 0;
 512 int svi_sizelen = 0;
 513
 514 static void
 515 sysv_internal_sizer (bfd *file ATTRIBUTE_UNUSED, sec_ptr sec,
 516                      void *ignore ATTRIBUTE_UNUSED)
 517 {
 518   bfd_size_type size = bfd_section_size (file, sec);
 519
 520   if (   ! bfd_is_abs_section (sec)
 521       && ! bfd_is_com_section (sec)
 522       && ! bfd_is_und_section (sec))
 523     {
 524       int namelen = strlen (bfd_section_name (file, sec));
 525
 526       if (namelen > svi_namelen)
 527         svi_namelen = namelen;
 528
 529       svi_total += size;
 530
 531       if (bfd_section_vma (file, sec) > svi_maxvma)
 532         svi_maxvma = bfd_section_vma (file, sec);
 533     }
 534 }
 535
 536 static void
 537 sysv_one_line (const char *name, bfd_size_type size, bfd_vma vma)
 538 {
 539   printf ("%-*s   ", svi_namelen, name);
 540   rprint_number (svi_sizelen, size);
 541   printf ("   ");
 542   rprint_number (svi_vmalen, vma);
 543   printf ("\n");
 544 }
 545
 546 static void
 547 sysv_internal_printer (bfd *file ATTRIBUTE_UNUSED, sec_ptr sec,
 548                        void *ignore ATTRIBUTE_UNUSED)
 549 {
 550   bfd_size_type size = bfd_section_size (file, sec);
 551
 552   if (   ! bfd_is_abs_section (sec)
 553       && ! bfd_is_com_section (sec)
 554       && ! bfd_is_und_section (sec))
 555     {
 556       svi_total += size;
 557
 558       sysv_one_line (bfd_section_name (file, sec),
 559                      size,
 560                      bfd_section_vma (file, sec));
 561     }
 562 }
 563
 564 static void
 565 print_sysv_format (bfd *file)
 566 {
 567   /* Size all of the columns.  */
 568   svi_total = 0;
 569   svi_maxvma = 0;
 570   svi_namelen = 0;
 571   bfd_map_over_sections (file, sysv_internal_sizer, NULL);
 572   if (show_common)
 573     {
 574       if (svi_namelen < (int) sizeof ("*COM*") - 1)
 575         svi_namelen = sizeof ("*COM*") - 1;
 576       svi_total += common_size;
 577     }
 578
 579   svi_vmalen = size_number ((bfd_size_type)svi_maxvma);
 580
 581   if ((size_t) svi_vmalen < sizeof ("addr") - 1)
 582     svi_vmalen = sizeof ("addr")-1;
 583
 584   svi_sizelen = size_number (svi_total);
 585   if ((size_t) svi_sizelen < sizeof ("size") - 1)
 586     svi_sizelen = sizeof ("size")-1;
 587
 588   svi_total = 0;
 589   printf ("%s  ", bfd_get_filename (file));
 590
 591   if (file->my_archive)
 592     printf (" (ex %s)", bfd_get_filename (file->my_archive));
 593
 594   printf (":\n%-*s   %*s   %*s\n", svi_namelen, "section",
 595           svi_sizelen, "size", svi_vmalen, "addr");
 596
 597   bfd_map_over_sections (file, sysv_internal_printer, NULL);
 598   if (show_common)
 599     {
 600       svi_total += common_size;
 601       sysv_one_line ("*COM*", common_size, 0);
 602     }
 603
 604   printf ("%-*s   ", svi_namelen, "Total");
 605   rprint_number (svi_sizelen, svi_total);
 606   printf ("\n\n");
 607 }
 608
 609 static void
 610 print_sizes (bfd *file)
 611 {
 612   if (show_common)
 613     calculate_common_size (file);
 614   if (berkeley_format)
 615     print_berkeley_format (file);
 616   else
 617     print_sysv_format (file);
 618 }