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.8.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 ("Based on BSD gprof, copyright 1983 Regents of the University of California.\n");
 377           printf ("\
 378 This program is free software.  This program has absolutely no warranty.\n");
 379           done (0);
 380         case 'w':
 381           output_width = atoi (optarg);
 382           if (output_width < 1)
 383             {
 384               output_width = 1;
 385             }
 386           break;
 387         case 'x':
 388           bb_annotate_all_lines = TRUE;
 389           break;
 390         case 'y':
 391           create_annotation_files = TRUE;
 392           break;
 393         case 'z':
 394           ignore_zeros = FALSE;
 395           break;
 396         case 'Z':
 397           if (optarg)
 398             {
 399               sym_id_add (optarg, EXCL_EXEC);
 400               output_style |= STYLE_EXEC_COUNTS;
 401             }
 402           else
 403             {
 404               output_style &= ~STYLE_EXEC_COUNTS;
 405             }
 406           user_specified |= STYLE_ANNOTATED_SOURCE;
 407           break;
 408         default:
 409           usage (stderr, 1);
 410         }
 411     }
 412
 413   /* Don't allow both ordering options, they modify the arc data in-place.  */
 414   if ((user_specified & STYLE_FUNCTION_ORDER)
 415       && (user_specified & STYLE_FILE_ORDER))
 416     {
 417       fprintf (stderr,"\
 418 %s: Only one of --function-ordering and --file-ordering may be specified.\n",
 419                whoami);
 420       done (1);
 421     }
 422
 423   /* append value of GPROF_PATH to source search list if set: */
 424   str = (char *) getenv ("GPROF_PATH");
 425   if (str)
 426     {
 427       search_list_append (&src_search_list, str);
 428     }
 429
 430   if (optind < argc)
 431     {
 432       a_out_name = argv[optind++];
 433     }
 434   if (optind < argc)
 435     {
 436       gmon_name = argv[optind++];
 437     }
 438
 439   /*
 440    * Turn off default functions:
 441    */
 442   for (sp = &default_excluded_list[0]; *sp; sp++)
 443     {
 444       sym_id_add (*sp, EXCL_TIME);
 445       sym_id_add (*sp, EXCL_GRAPH);
 446 #ifdef __alpha__
 447       sym_id_add (*sp, EXCL_FLAT);
 448 #endif
 449     }
 450
 451   /*
 452    * For line-by-line profiling, also want to keep those
 453    * functions off the flat profile:
 454    */
 455   if (line_granularity)
 456     {
 457       for (sp = &default_excluded_list[0]; *sp; sp++)
 458         {
 459           sym_id_add (*sp, EXCL_FLAT);
 460         }
 461     }
 462
 463   /*
 464    * Read symbol table from core file:
 465    */
 466   core_init (a_out_name);
 467
 468   /*
 469    * If we should ignore direct function calls, we need to load
 470    * to core's text-space:
 471    */
 472   if (ignore_direct_calls)
 473     {
 474       core_get_text_space (core_bfd);
 475     }
 476
 477   /*
 478    * Create symbols from core image:
 479    */
 480   if (line_granularity)
 481     {
 482       core_create_line_syms (core_bfd);
 483     }
 484   else
 485     {
 486       core_create_function_syms (core_bfd);
 487     }
 488
 489   /*
 490    * Translate sym specs into syms:
 491    */
 492   sym_id_parse ();
 493
 494   if (file_format == FF_PROF)
 495     {
 496 #ifdef PROF_SUPPORT_IMPLEMENTED
 497       /*
 498        * Get information about mon.out file(s):
 499        */
 500       do
 501         {
 502           mon_out_read (gmon_name);
 503           if (optind < argc)
 504             {
 505               gmon_name = argv[optind];
 506             }
 507         }
 508       while (optind++ < argc);
 509 #else
 510       fprintf (stderr,
 511                "%s: sorry, file format `prof' is not yet supported\n",
 512                whoami);
 513       done (1);
 514 #endif
 515     }
 516   else
 517     {
 518       /*
 519        * Get information about gmon.out file(s):
 520        */
 521       do
 522         {
 523           gmon_out_read (gmon_name);
 524           if (optind < argc)
 525             {
 526               gmon_name = argv[optind];
 527             }
 528         }
 529       while (optind++ < argc);
 530     }
 531
 532   /*
 533    * If user did not specify output style, try to guess something
 534    * reasonable:
 535    */
 536   if (output_style == 0)
 537     {
 538       if (gmon_input & (INPUT_HISTOGRAM | INPUT_CALL_GRAPH))
 539         {
 540           output_style = STYLE_FLAT_PROFILE | STYLE_CALL_GRAPH;
 541         }
 542       else
 543         {
 544           output_style = STYLE_EXEC_COUNTS;
 545         }
 546       output_style &= ~user_specified;
 547     }
 548
 549   /*
 550    * Dump a gmon.sum file if requested (before any other processing!):
 551    */
 552   if (output_style & STYLE_SUMMARY_FILE)
 553     {
 554       gmon_out_write (GMONSUM);
 555     }
 556
 557   if (gmon_input & INPUT_HISTOGRAM)
 558     {
 559       hist_assign_samples ();
 560     }
 561
 562   if (gmon_input & INPUT_CALL_GRAPH)
 563     {
 564       cg = cg_assemble ();
 565     }
 566
 567   /* do some simple sanity checks: */
 568
 569   if ((output_style & STYLE_FLAT_PROFILE)
 570       && !(gmon_input & INPUT_HISTOGRAM))
 571     {
 572       fprintf (stderr, "%s: gmon.out file is missing histogram\n", whoami);
 573       done (1);
 574     }
 575
 576   if ((output_style & STYLE_CALL_GRAPH) && !(gmon_input & INPUT_CALL_GRAPH))
 577     {
 578       fprintf (stderr,
 579                "%s: gmon.out file is missing call-graph data\n", whoami);
 580       done (1);
 581     }
 582
 583   /* output whatever user whishes to see: */
 584
 585   if (cg && (output_style & STYLE_CALL_GRAPH) && bsd_style_output)
 586     {
 587       cg_print (cg);            /* print the dynamic profile */
 588     }
 589
 590   if (output_style & STYLE_FLAT_PROFILE)
 591     {
 592       hist_print ();            /* print the flat profile */
 593     }
 594
 595   if (cg && (output_style & STYLE_CALL_GRAPH))
 596     {
 597       if (!bsd_style_output)
 598         {
 599           cg_print (cg);        /* print the dynamic profile */
 600         }
 601       cg_print_index ();
 602     }
 603
 604   if (output_style & STYLE_EXEC_COUNTS)
 605     {
 606       print_exec_counts ();
 607     }
 608
 609   if (output_style & STYLE_ANNOTATED_SOURCE)
 610     {
 611       print_annotated_source ();
 612     }
 613   if (output_style & STYLE_FUNCTION_ORDER)
 614     {
 615       cg_print_function_ordering ();
 616     }
 617   if (output_style & STYLE_FILE_ORDER)
 618     {
 619       cg_print_file_ordering ();
 620     }
 621   return 0;
 622 }
 623
 624 void
 625 done (status)
 626      int status;
 627 {
 628   exit (status);
 629 }