gprof/gprof.c

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