gprof/gprof.c

   1 /*
   2  * Copyright (c) 1983, 1993, 1998, 2001, 2002
   3  *      The Regents of the University of California.  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  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #include "libiberty.h"
  31 #include "gprof.h"
  32 #include "search_list.h"
  33 #include "source.h"
  34 #include "symtab.h"
  35 #include "basic_blocks.h"
  36 #include "call_graph.h"
  37 #include "cg_arcs.h"
  38 #include "cg_print.h"
  39 #include "corefile.h"
  40 #include "gmon_io.h"
  41 #include "hertz.h"
  42 #include "hist.h"
  43 #include "sym_ids.h"
  44 #include "demangle.h"
  45 #include "getopt.h"
  46
  47 static void usage (FILE *, int) ATTRIBUTE_NORETURN;
  48 int main (int, char **);
  49
  50 const char *whoami;
  51 const char *function_mapping_file;
  52 const char *a_out_name = A_OUTNAME;
  53 long hz = HZ_WRONG;
  54
  55 /*
  56  * Default options values:
  57  */
  58 int debug_level = 0;
  59 int output_style = 0;
  60 int output_width = 80;
  61 bfd_boolean bsd_style_output = FALSE;
  62 bfd_boolean demangle = TRUE;
  63 bfd_boolean discard_underscores = TRUE;
  64 bfd_boolean ignore_direct_calls = FALSE;
  65 bfd_boolean ignore_static_funcs = FALSE;
  66 bfd_boolean ignore_zeros = TRUE;
  67 bfd_boolean line_granularity = FALSE;
  68 bfd_boolean print_descriptions = TRUE;
  69 bfd_boolean print_path = FALSE;
  70 bfd_boolean ignore_non_functions = FALSE;
  71 File_Format file_format = FF_AUTO;
  72
  73 bfd_boolean first_output = TRUE;
  74
  75 char copyright[] =
  76  "@(#) Copyright (c) 1983 Regents of the University of California.\n\
  77  All rights reserved.\n";
  78
  79 static char *gmon_name = GMONNAME;      /* profile filename */
  80
  81 bfd *abfd;
  82
  83 /*
  84  * Functions that get excluded by default:
  85  */
  86 static char *default_excluded_list[] =
  87 {
  88   "_gprof_mcount", "mcount", "_mcount", "__mcount", "__mcount_internal",
  89   "__mcleanup",
  90   "<locore>", "<hicore>",
  91   0
  92 };
  93
  94 /* Codes used for the long options with no short synonyms.  150 isn't
  95    special; it's just an arbitrary non-ASCII char value.  */
  96
  97 #define OPTION_DEMANGLE         (150)
  98 #define OPTION_NO_DEMANGLE      (OPTION_DEMANGLE + 1)
  99
 100 static struct option long_options[] =
 101 {
 102   {"line", no_argument, 0, 'l'},
 103   {"no-static", no_argument, 0, 'a'},
 104   {"ignore-non-functions", no_argument, 0, 'D'},
 105
 106     /* output styles: */
 107
 108   {"annotated-source", optional_argument, 0, 'A'},
 109   {"no-annotated-source", optional_argument, 0, 'J'},
 110   {"flat-profile", optional_argument, 0, 'p'},
 111   {"no-flat-profile", optional_argument, 0, 'P'},
 112   {"graph", optional_argument, 0, 'q'},
 113   {"no-graph", optional_argument, 0, 'Q'},
 114   {"exec-counts", optional_argument, 0, 'C'},
 115   {"no-exec-counts", optional_argument, 0, 'Z'},
 116   {"function-ordering", no_argument, 0, 'r'},
 117   {"file-ordering", required_argument, 0, 'R'},
 118   {"file-info", no_argument, 0, 'i'},
 119   {"sum", no_argument, 0, 's'},
 120
 121     /* various options to affect output: */
 122
 123   {"all-lines", no_argument, 0, 'x'},
 124   {"demangle", optional_argument, 0, OPTION_DEMANGLE},
 125   {"no-demangle", no_argument, 0, OPTION_NO_DEMANGLE},
 126   {"directory-path", required_argument, 0, 'I'},
 127   {"display-unused-functions", no_argument, 0, 'z'},
 128   {"min-count", required_argument, 0, 'm'},
 129   {"print-path", no_argument, 0, 'L'},
 130   {"separate-files", no_argument, 0, 'y'},
 131   {"static-call-graph", no_argument, 0, 'c'},
 132   {"table-length", required_argument, 0, 't'},
 133   {"time", required_argument, 0, 'n'},
 134   {"no-time", required_argument, 0, 'N'},
 135   {"width", required_argument, 0, 'w'},
 136     /*
 137      * These are for backwards-compatibility only.  Their functionality
 138      * is provided by the output style options already:
 139      */
 140   {"", required_argument, 0, 'e'},
 141   {"", required_argument, 0, 'E'},
 142   {"", required_argument, 0, 'f'},
 143   {"", required_argument, 0, 'F'},
 144   {"", required_argument, 0, 'k'},
 145
 146     /* miscellaneous: */
 147
 148   {"brief", no_argument, 0, 'b'},
 149   {"debug", optional_argument, 0, 'd'},
 150   {"help", no_argument, 0, 'h'},
 151   {"file-format", required_argument, 0, 'O'},
 152   {"traditional", no_argument, 0, 'T'},
 153   {"version", no_argument, 0, 'v'},
 154   {0, no_argument, 0, 0}
 155 };
 156
 157
 158 static void
 159 usage (FILE *stream, int status)
 160 {
 161   fprintf (stream, _("\
 162 Usage: %s [-[abcDhilLsTvwxyz]] [-[ACeEfFJnNOpPqQZ][name]] [-I dirs]\n\
 163         [-d[num]] [-k from/to] [-m min-count] [-t table-length]\n\
 164         [--[no-]annotated-source[=name]] [--[no-]exec-counts[=name]]\n\
 165         [--[no-]flat-profile[=name]] [--[no-]graph[=name]]\n\
 166         [--[no-]time=name] [--all-lines] [--brief] [--debug[=level]]\n\
 167         [--function-ordering] [--file-ordering]\n\
 168         [--directory-path=dirs] [--display-unused-functions]\n\
 169         [--file-format=name] [--file-info] [--help] [--line] [--min-count=n]\n\
 170         [--no-static] [--print-path] [--separate-files]\n\
 171         [--static-call-graph] [--sum] [--table-length=len] [--traditional]\n\
 172         [--version] [--width=n] [--ignore-non-functions]\n\
 173         [--demangle[=STYLE]] [--no-demangle]\n\
 174         [image-file] [profile-file...]\n"),
 175            whoami);
 176   if (status == 0)
 177     fprintf (stream, _("Report bugs to %s\n"), REPORT_BUGS_TO);
 178   done (status);
 179 }
 180
 181
 182 int
 183 main (int argc, char **argv)
 184 {
 185   char **sp, *str;
 186   Sym **cg = 0;
 187   int ch, user_specified = 0;
 188
 189 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
 190   setlocale (LC_MESSAGES, "");
 191 #endif
 192 #if defined (HAVE_SETLOCALE)
 193   setlocale (LC_CTYPE, "");
 194 #endif
 195   bindtextdomain (PACKAGE, LOCALEDIR);
 196   textdomain (PACKAGE);
 197
 198   whoami = argv[0];
 199   xmalloc_set_program_name (whoami);
 200
 201   while ((ch = getopt_long (argc, argv,
 202         "aA::bBcCd::De:E:f:F:hiI:J::k:lLm:n::N::O:p::P::q::Q::st:Tvw:xyzZ::",
 203                             long_options, 0))
 204          != EOF)
 205     {
 206       switch (ch)
 207         {
 208         case 'a':
 209           ignore_static_funcs = TRUE;
 210           break;
 211         case 'A':
 212           if (optarg)
 213             {
 214               sym_id_add (optarg, INCL_ANNO);
 215             }
 216           output_style |= STYLE_ANNOTATED_SOURCE;
 217           user_specified |= STYLE_ANNOTATED_SOURCE;
 218           break;
 219         case 'b':
 220           print_descriptions = FALSE;
 221           break;
 222         case 'B':
 223           output_style |= STYLE_CALL_GRAPH;
 224           user_specified |= STYLE_CALL_GRAPH;
 225           break;
 226         case 'c':
 227           ignore_direct_calls = TRUE;
 228           break;
 229         case 'C':
 230           if (optarg)
 231             {
 232               sym_id_add (optarg, INCL_EXEC);
 233             }
 234           output_style |= STYLE_EXEC_COUNTS;
 235           user_specified |= STYLE_EXEC_COUNTS;
 236           break;
 237         case 'd':
 238           if (optarg)
 239             {
 240               debug_level |= atoi (optarg);
 241               debug_level |= ANYDEBUG;
 242             }
 243           else
 244             {
 245               debug_level = ~0;
 246             }
 247           DBG (ANYDEBUG, printf ("[main] debug-level=0x%x\n", debug_level));
 248 #ifndef DEBUG
 249           printf (_("%s: debugging not supported; -d ignored\n"), whoami);
 250 #endif  /* DEBUG */
 251           break;
 252         case 'D':
 253           ignore_non_functions = TRUE;
 254           break;
 255         case 'E':
 256           sym_id_add (optarg, EXCL_TIME);
 257         case 'e':
 258           sym_id_add (optarg, EXCL_GRAPH);
 259           break;
 260         case 'F':
 261           sym_id_add (optarg, INCL_TIME);
 262         case 'f':
 263           sym_id_add (optarg, INCL_GRAPH);
 264           break;
 265         case 'g':
 266           sym_id_add (optarg, EXCL_FLAT);
 267           break;
 268         case 'G':
 269           sym_id_add (optarg, INCL_FLAT);
 270           break;
 271         case 'h':
 272           usage (stdout, 0);
 273         case 'i':
 274           output_style |= STYLE_GMON_INFO;
 275           user_specified |= STYLE_GMON_INFO;
 276           break;
 277         case 'I':
 278           search_list_append (&src_search_list, optarg);
 279           break;
 280         case 'J':
 281           if (optarg)
 282             {
 283               sym_id_add (optarg, EXCL_ANNO);
 284               output_style |= STYLE_ANNOTATED_SOURCE;
 285             }
 286           else
 287             {
 288               output_style &= ~STYLE_ANNOTATED_SOURCE;
 289             }
 290           user_specified |= STYLE_ANNOTATED_SOURCE;
 291           break;
 292         case 'k':
 293           sym_id_add (optarg, EXCL_ARCS);
 294           break;
 295         case 'l':
 296           line_granularity = TRUE;
 297           break;
 298         case 'L':
 299           print_path = TRUE;
 300           break;
 301         case 'm':
 302           bb_min_calls = (unsigned long) strtoul (optarg, (char **) NULL, 10);
 303           break;
 304         case 'n':
 305           sym_id_add (optarg, INCL_TIME);
 306           break;
 307         case 'N':
 308           sym_id_add (optarg, EXCL_TIME);
 309           break;
 310         case 'O':
 311           switch (optarg[0])
 312             {
 313             case 'a':
 314               file_format = FF_AUTO;
 315               break;
 316             case 'm':
 317               file_format = FF_MAGIC;
 318               break;
 319             case 'b':
 320               file_format = FF_BSD;
 321               break;
 322             case '4':
 323               file_format = FF_BSD44;
 324               break;
 325             case 'p':
 326               file_format = FF_PROF;
 327               break;
 328             default:
 329               fprintf (stderr, _("%s: unknown file format %s\n"),
 330                        optarg, whoami);
 331               done (1);
 332             }
 333           break;
 334         case 'p':
 335           if (optarg)
 336             {
 337               sym_id_add (optarg, INCL_FLAT);
 338             }
 339           output_style |= STYLE_FLAT_PROFILE;
 340           user_specified |= STYLE_FLAT_PROFILE;
 341           break;
 342         case 'P':
 343           if (optarg)
 344             {
 345               sym_id_add (optarg, EXCL_FLAT);
 346               output_style |= STYLE_FLAT_PROFILE;
 347             }
 348           else
 349             {
 350               output_style &= ~STYLE_FLAT_PROFILE;
 351             }
 352           user_specified |= STYLE_FLAT_PROFILE;
 353           break;
 354         case 'q':
 355           if (optarg)
 356             {
 357               if (strchr (optarg, '/'))
 358                 {
 359                   sym_id_add (optarg, INCL_ARCS);
 360                 }
 361               else
 362                 {
 363                   sym_id_add (optarg, INCL_GRAPH);
 364                 }
 365             }
 366           output_style |= STYLE_CALL_GRAPH;
 367           user_specified |= STYLE_CALL_GRAPH;
 368           break;
 369         case 'r':
 370           output_style |= STYLE_FUNCTION_ORDER;
 371           user_specified |= STYLE_FUNCTION_ORDER;
 372           break;
 373         case 'R':
 374           output_style |= STYLE_FILE_ORDER;
 375           user_specified |= STYLE_FILE_ORDER;
 376           function_mapping_file = optarg;
 377           break;
 378         case 'Q':
 379           if (optarg)
 380             {
 381               if (strchr (optarg, '/'))
 382                 {
 383                   sym_id_add (optarg, EXCL_ARCS);
 384                 }
 385               else
 386                 {
 387                   sym_id_add (optarg, EXCL_GRAPH);
 388                 }
 389               output_style |= STYLE_CALL_GRAPH;
 390             }
 391           else
 392             {
 393               output_style &= ~STYLE_CALL_GRAPH;
 394             }
 395           user_specified |= STYLE_CALL_GRAPH;
 396           break;
 397         case 's':
 398           output_style |= STYLE_SUMMARY_FILE;
 399           user_specified |= STYLE_SUMMARY_FILE;
 400           break;
 401         case 't':
 402           bb_table_length = atoi (optarg);
 403           if (bb_table_length < 0)
 404             {
 405               bb_table_length = 0;
 406             }
 407           break;
 408         case 'T':
 409           bsd_style_output = TRUE;
 410           break;
 411         case 'v':
 412           /* This output is intended to follow the GNU standards document.  */
 413           printf (_("GNU gprof %s\n"), VERSION);
 414           printf (_("Based on BSD gprof, copyright 1983 Regents of the University of California.\n"));
 415           printf (_("\
 416 This program is free software.  This program has absolutely no warranty.\n"));
 417           done (0);
 418         case 'w':
 419           output_width = atoi (optarg);
 420           if (output_width < 1)
 421             {
 422               output_width = 1;
 423             }
 424           break;
 425         case 'x':
 426           bb_annotate_all_lines = TRUE;
 427           break;
 428         case 'y':
 429           create_annotation_files = TRUE;
 430           break;
 431         case 'z':
 432           ignore_zeros = FALSE;
 433           break;
 434         case 'Z':
 435           if (optarg)
 436             {
 437               sym_id_add (optarg, EXCL_EXEC);
 438               output_style |= STYLE_EXEC_COUNTS;
 439             }
 440           else
 441             {
 442               output_style &= ~STYLE_EXEC_COUNTS;
 443             }
 444           user_specified |= STYLE_ANNOTATED_SOURCE;
 445           break;
 446         case OPTION_DEMANGLE:
 447           demangle = TRUE;
 448           if (optarg != NULL)
 449             {
 450               enum demangling_styles style;
 451
 452               style = cplus_demangle_name_to_style (optarg);
 453               if (style == unknown_demangling)
 454                 {
 455                   fprintf (stderr,
 456                            _("%s: unknown demangling style `%s'\n"),
 457                            whoami, optarg);
 458                   xexit (1);
 459                 }
 460
 461               cplus_demangle_set_style (style);
 462            }
 463           break;
 464         case OPTION_NO_DEMANGLE:
 465           demangle = FALSE;
 466           break;
 467         default:
 468           usage (stderr, 1);
 469         }
 470     }
 471
 472   /* Don't allow both ordering options, they modify the arc data in-place.  */
 473   if ((user_specified & STYLE_FUNCTION_ORDER)
 474       && (user_specified & STYLE_FILE_ORDER))
 475     {
 476       fprintf (stderr,_("\
 477 %s: Only one of --function-ordering and --file-ordering may be specified.\n"),
 478                whoami);
 479       done (1);
 480     }
 481
 482   /* --sum implies --line, otherwise we'd lose basic block counts in
 483        gmon.sum */
 484   if (output_style & STYLE_SUMMARY_FILE)
 485     {
 486       line_granularity = 1;
 487     }
 488
 489   /* append value of GPROF_PATH to source search list if set: */
 490   str = (char *) getenv ("GPROF_PATH");
 491   if (str)
 492     {
 493       search_list_append (&src_search_list, str);
 494     }
 495
 496   if (optind < argc)
 497     {
 498       a_out_name = argv[optind++];
 499     }
 500   if (optind < argc)
 501     {
 502       gmon_name = argv[optind++];
 503     }
 504
 505   /*
 506    * Turn off default functions:
 507    */
 508   for (sp = &default_excluded_list[0]; *sp; sp++)
 509     {
 510       sym_id_add (*sp, EXCL_TIME);
 511       sym_id_add (*sp, EXCL_GRAPH);
 512       sym_id_add (*sp, EXCL_FLAT);
 513     }
 514
 515   /*
 516    * For line-by-line profiling, also want to keep those
 517    * functions off the flat profile:
 518    */
 519   if (line_granularity)
 520     for (sp = &default_excluded_list[0]; *sp; sp++)
 521       sym_id_add (*sp, EXCL_FLAT);
 522
 523   /* Read symbol table from core file.  */
 524   core_init (a_out_name);
 525
 526   /* If we should ignore direct function calls, we need to load to
 527      core's text-space.  */
 528   if (ignore_direct_calls)
 529     core_get_text_space (core_bfd);
 530
 531   /* Create symbols from core image.  */
 532   if (line_granularity)
 533     core_create_line_syms ();
 534   else
 535     core_create_function_syms ();
 536
 537   /* Translate sym specs into syms.  */
 538   sym_id_parse ();
 539
 540   if (file_format == FF_PROF)
 541     {
 542       fprintf (stderr,
 543                _("%s: sorry, file format `prof' is not yet supported\n"),
 544                whoami);
 545       done (1);
 546     }
 547   else
 548     {
 549       /* Get information about gmon.out file(s).  */
 550       do
 551         {
 552           gmon_out_read (gmon_name);
 553           if (optind < argc)
 554             {
 555               gmon_name = argv[optind];
 556             }
 557         }
 558       while (optind++ < argc);
 559     }
 560
 561   /*
 562    * If user did not specify output style, try to guess something
 563    * reasonable:
 564    */
 565   if (output_style == 0)
 566     {
 567       if (gmon_input & (INPUT_HISTOGRAM | INPUT_CALL_GRAPH))
 568         output_style = STYLE_FLAT_PROFILE | STYLE_CALL_GRAPH;
 569       else
 570         output_style = STYLE_EXEC_COUNTS;
 571
 572       output_style &= ~user_specified;
 573     }
 574
 575   /* Dump a gmon.sum file if requested (before any other
 576      processing!)  */
 577   if (output_style & STYLE_SUMMARY_FILE)
 578     {
 579       gmon_out_write (GMONSUM);
 580     }
 581
 582   if (gmon_input & INPUT_HISTOGRAM)
 583     {
 584       hist_assign_samples ();
 585     }
 586
 587   if (gmon_input & INPUT_CALL_GRAPH)
 588     {
 589       cg = cg_assemble ();
 590     }
 591
 592   /* Do some simple sanity checks.  */
 593   if ((output_style & STYLE_FLAT_PROFILE)
 594       && !(gmon_input & INPUT_HISTOGRAM))
 595     {
 596       fprintf (stderr, _("%s: gmon.out file is missing histogram\n"), whoami);
 597       done (1);
 598     }
 599
 600   if ((output_style & STYLE_CALL_GRAPH) && !(gmon_input & INPUT_CALL_GRAPH))
 601     {
 602       fprintf (stderr,
 603                _("%s: gmon.out file is missing call-graph data\n"), whoami);
 604       done (1);
 605     }
 606
 607   /* output whatever user whishes to see: */
 608
 609   if (cg && (output_style & STYLE_CALL_GRAPH) && bsd_style_output)
 610     {
 611       cg_print (cg);            /* print the dynamic profile */
 612     }
 613
 614   if (output_style & STYLE_FLAT_PROFILE)
 615     {
 616       hist_print ();            /* print the flat profile */
 617     }
 618
 619   if (cg && (output_style & STYLE_CALL_GRAPH))
 620     {
 621       if (!bsd_style_output)
 622         {
 623           cg_print (cg);        /* print the dynamic profile */
 624         }
 625       cg_print_index ();
 626     }
 627
 628   if (output_style & STYLE_EXEC_COUNTS)
 629     {
 630       print_exec_counts ();
 631     }
 632
 633   if (output_style & STYLE_ANNOTATED_SOURCE)
 634     {
 635       print_annotated_source ();
 636     }
 637   if (output_style & STYLE_FUNCTION_ORDER)
 638     {
 639       cg_print_function_ordering ();
 640     }
 641   if (output_style & STYLE_FILE_ORDER)
 642     {
 643       cg_print_file_ordering ();
 644     }
 645   return 0;
 646 }
 647
 648 void
 649 done (int status)
 650 {
 651   exit (status);
 652 }