GPROF(1)

📦
version 2.40.50~ti1ubuntu1 · 2 versions
, in ubuntu noble

🎀 GPROF(1) 🎀

okay bestie, this is the GNU manual page for gprof, and it lives in section 1 of the manual. it's a long one so buckle up 💖

✨ NAME ✨

gprof — display call graph profile data 👑

🦋 SYNOPSIS 🦋

gprof [ -[abcDhilLrsTvwxyz] ] [ -[ABCeEfFJnNOpPqQRStZ][name] ]
 [ -I dirs ] [ -d[num] ] [ -k from/to ]
 [ -m min-count ] [ -R map_file ] [ -t table-length ]
 [ --[no-]annotated-source[=name] ]
 [ --[no-]exec-counts[=name] ]
 [ --[no-]flat-profile[=name] ] [ --[no-]graph[=name] ]
 [ --[no-]time=name] [ --all-lines ] [ --brief ]
 [ --debug[=level] ] [ --function-ordering ]
 [ --file-ordering map_file ] [ --directory-path=dirs ]
 [ --display-unused-functions ] [ --file-format=name ]
 [ --file-info ] [ --help ] [ --line ] [ --inline-file-names ]
 [ --min-count=n ] [ --no-static ] [ --print-path ]
 [ --separate-files ] [ --static-call-graph ] [ --sum ]
 [ --table-length=len ] [ --traditional ] [ --version ]
 [ --width=n ] [ --ignore-non-functions ]
 [ --demangle[=STYLE] ] [ --no-demangle ]
 [--external-symbol-table=name]
 [ image-file ] [ profile-file ... ]

🌈 DESCRIPTION 🌈

so gprof produces an execution profile of C, Pascal, or Fortran77 programs. the effect of called routines is incorporated into the profile of each caller — it's giving "everybody gets credit for their children's achievements" 😌💅

the profile data comes from the call graph profile file (gmon.out by default), which is created by programs compiled with the -pg option of cc, pc, and f77. that same -pg option also links in versions of the library routines that were compiled for profiling. two-for-one deal, we love that 🫶

Gprof reads the object file you hand it (default is a.out, classic) and establishes the relationship between its symbol table and the call graph profile from gmon.out. if you specify more than one profile file, the gprof output shows the sum of the profile info across all the given profile files. math is mathing ✨

heads up bestie: if you're using gcc 2.95.x or 3.0 to compile your binaries, you may need to add the -fprofile-arcs to the compile command line so the call graphs get properly stored in gmon.out. it's giving vintage but okay 💀

Gprof calculates how much time was spent in each routine. next, those times get propagated along the edges of the call graph. cycles get discovered, and calls into a cycle are made to share the time of the cycle. circular dependency? she's handled 🔄

there are several forms of output available from the analysis:

  • the flat profile shows how much time your program spent in each function, and how many times that function was called. if you literally just want to know which functions are burning the most cycles, it's stated concisely right here. no fluff, periodt 🔥
  • the call graph shows, for each function, which functions called it, which other functions it called, and how many times. it also gives an estimate of how much time was spent in the subroutines of each function. this can suggest places where you might try to eliminate function calls that use a lot of time. it's basically a family tree but for stack frames 🌳
  • the annotated source listing is a copy of the program's source code, labeled with the number of times each line of the program was executed. every line gets its own little flex 💅

💖 OPTIONS 💖

these options specify which of several output formats gprof should produce. choose your fighter 🎮

many of these options take an optional symspec to specify functions to be included or excluded. you can specify these options multiple times, with different symspecs, to include or exclude sets of symbols. stack 'em up 🧚

specifying any of these options overrides the default (-p -q), which prints a flat profile and call graph analysis for all functions. don't say I didn't warn you 🙈
  • -A[symspec], --annotated-source[=symspec] — the -A option causes gprof to print annotated source code. if symspec is specified, print output only for matching symbols. slay, filtered ✨
  • -b, --brief — if the -b option is given, gprof doesn't print the verbose blurbs that try to explain the meaning of all of the fields in the tables. this is useful if you intend to print out the output, or are tired of seeing the blurbs. we get it, you don't need the tutorial level 😌
  • -B — the -B option causes gprof to print the call graph analysis. graph girlies rise 🦋
  • -C[symspec], --exec-counts[=symspec] — the -C option causes gprof to print a tally of functions and the number of times each was called. if symspec is specified, print tally only for matching symbols.

if the profile data file contains basic-block count records, specifying the -l option, along with -C, will cause basic-block execution counts to be tallied and displayed. combo move 💥

  • -i, --file-info — the -i option causes gprof to display summary information about the profile data file(s) and then exit. the number of histogram, call graph, and basic-block count records is displayed. just the facts, then she's gone 💨
  • -I dirs, --directory-path=dirs — the -I option specifies a list of search directories in which to find source files. the environment variable GPROF_PATH can also be used to convey this information. used mostly for annotated source output. tell her where to look 🔍
  • -J[symspec], --no-annotated-source[=symspec] — the -J option causes gprof not to print annotated source code. if symspec is specified, gprof prints annotated source, but excludes matching symbols. it's giving "yes but not you" 🙅
  • -L, --print-path — normally, source filenames are printed with the path component suppressed. the -L option causes gprof to print the full pathname of source filenames, which is determined from symbolic debugging information in the image file and is relative to the directory in which the compiler was invoked. full receipts, no editing 🫶
  • -p[symspec], --flat-profile[=symspec] — the -p option causes gprof to print a flat profile. if symspec is specified, print flat profile only for matching symbols.
  • -P[symspec], --no-flat-profile[=symspec] — the -P option causes gprof to suppress printing a flat profile. if symspec is specified, gprof prints a flat profile, but excludes matching symbols.
  • -q[symspec], --graph[=symspec] — the -q option causes gprof to print the call graph analysis. if symspec is specified, print call graph only for matching symbols and their children. the whole bloodline, iconic 👑
  • -Q[symspec], --no-graph[=symspec] — the -Q option causes gprof to suppress printing the call graph. if symspec is specified, gprof prints a call graph, but excludes matching symbols.
  • -t, --table-length=num — the -t option causes the num most active source lines in each source file to be listed when source annotation is enabled. the default is 10. the hall of fame, top ten 🏆
  • -y, --separate-files — this option affects annotated source output only. normally, gprof prints annotated source files to standard-output. if this option is specified, annotated source for a file named path/filename is generated in the file filename-ann. if the underlying file system would truncate filename-ann so that it overwrites the original filename, gprof generates annotated source in the file filename.ann instead (if the original file name has an extension, that extension is replaced with .ann). safety first, we are NOT losing the original file bestie 😭
  • -Z[symspec], --no-exec-counts[=symspec] — the -Z option causes gprof not to print a tally of functions and the number of times each was called. if symspec is specified, print tally, but exclude matching symbols.
  • -r, --function-ordering — the --function-ordering option causes gprof to print a suggested function ordering for the program based on profiling data. this option suggests an ordering which may improve paging, tlb and cache behavior for the program on systems which support arbitrary ordering of functions in an executable.

the exact details of how to force the linker to place functions in a particular order is system dependent and out of the scope of this manual. not her job, she just suggests 💅

  • -R map_file, --file-ordering map_file — the --file-ordering option causes gprof to print a suggested .o link line ordering for the program based on profiling data. this option suggests an ordering which may improve paging, tlb and cache behavior for the program on systems which do not support arbitrary ordering of functions in an executable.

use of the -a argument is highly recommended with this option. fr fr, do it.

the map_file argument is a pathname to a file which provides function name to object file mappings. the format of the file is similar to the output of the program nm. look at her:

        c-parse.o:00000000 T yyparse
        c-parse.o:00000004 C yyerrflag
        c-lang.o:00000000 T maybe_objc_method_name
        c-lang.o:00000000 T print_lang_statistics
        c-lang.o:00000000 T recognize_objc_keyword
        c-decl.o:00000000 T print_lang_identifier
        c-decl.o:00000000 T print_lang_type
        ...

to create a map_file with GNU nm, type a command like nm --extern-only --defined-only -v --print-file-name program-name. copy paste energy, no notes ✨

  • -T, --traditional — the -T option causes gprof to print its output in "traditional" BSD style. vintage aesthetic 🎀
  • -w width, --width=width — sets width of output lines to width. currently only used when printing the function index at the bottom of the call graph. one job and she does it well 💅
  • -x, --all-lines — this option affects annotated source output only. by default, only the lines at the beginning of a basic-block are annotated. if this option is specified, every line in a basic-block is annotated by repeating the annotation for the first line. this behavior is similar to tcov's -a. give every line her moment 🌟
  • --demangle[=style], --no-demangle — these options control whether C++ symbol names should be demangled when printing output. the default is to demangle symbols. the --no-demangle option may be used to turn off demangling. different compilers have different mangling styles. the optional demangling style argument can be used to choose an appropriate demangling style for your compiler. _ZN4bestie no more, we're translating 🫶

🌸 Analysis Options 🌸

  • -a, --no-static — the -a option causes gprof to suppress the printing of statically declared (private) functions. (these are functions whose names are not listed as global, and which are not visible outside the file/function/block where they were defined.) time spent in these functions, calls to/from them, etc., will all be attributed to the function that was loaded directly before it in the executable file. this option affects both the flat profile and the call graph. private functions stay private, their stats go to the neighbor 😭
  • -c, --static-call-graph — okay so this one is so smart 💅 it makes the call graph get a lil glow-up via a heuristic that actually reads the text space of the object file and sniffs out function calls hiding in the binary machine code. why does that matter? because normal call graph records only get written when functions are actually entered — so this option catches children that could have been called but never were. it also spots calls to functions that weren't compiled with profiling on, but only if there are symbol table entries for them. calls to dynamic library routines are typically not found by this. any parent or child found by this heuristic shows up in the call graph with call counts of 0. noted 📝
  • -D, --ignore-non-functions — this tells gprof to ignore symbols that aren't known to be functions. it gives you more accurate profile data on systems where it's supported (Solaris and HPUX for example). accuracy slay ✨
  • -k from/to — bestie this one is a scissors moment: it lets you delete from the call graph any arcs from symbols matching symspec from to those matching symspec to. snip snip ✂️
  • -l, --line — turns on line-by-line profiling, which charges histogram hits to individual source code lines instead of whole functions. heads up though: this only works with programs compiled by older versions of the gcc compiler — newer gcc is built to work with the gcov tool instead. and if the program was compiled with basic-block counting enabled, this option will also tell you how many times each line of code was executed. line-by-line profiling can help isolate where in a big function your program is spending its time, but it also significantly increases the running time of gprof, and magnifies statistical inaccuracies. tradeoffs, always tradeoffs 😭
  • --inline-file-names — makes gprof print the source file after each symbol in both the flat profile and the call graph. the full path to the file gets printed if you use it with the -L option. 📁
  • -m num, --min-count=num — this one only affects execution count output: symbols executed fewer than num times get suppressed. bye felicia 👋
  • -n symspec, --time=symspec — in its call graph analysis, gprof will only propagate times for symbols matching symspec. selective propagation era
  • -N symspec, --no-time=symspec — the opposite vibe: in its call graph analysis, gprof will not propagate times for symbols matching symspec.
  • -S filename, --external-symbol-table=filename — makes gprof read an external symbol table file, like /proc/kallsyms, instead of reading the symbol table from the given object file (the default is a.out). super useful for profiling kernel modules 🧚
  • -z, --display-unused-functions — give this one and gprof will mention all the functions in the flat profile, even the ones that were never called and had zero time spent in them. pairs gorgeously with the -c option for discovering which routines were never called. main character energy for the forgotten functions 👑

✨ Miscellaneous Options ✨

  • -d[num], --debug[=num] — specifies debugging options. if num isn't specified, it enables all debugging. 🐛
  • -h, --help — prints command line usage. the classic cry for help 💀
  • -O name, --file-format=name — selects the format of the profile data files. recognized formats are auto (the default), bsd, 4.4bsd, magic, and prof (not yet supported). choose wisely ✨
  • -s, --sum — causes gprof to summarize the info in the profile data files it read in, and write out a profile data file called gmon.sum containing all the information from the profile data files that gprof read in. fun fact: gmon.sum may be one of the specified input files — the effect of that is merging the data in the other input files into gmon.sum. eventually you can run gprof again without -s to analyze the cumulative data in gmon.sum. cumulative data pipeline, obsessed 🫶
  • -v, --version — prints the current version number, then exits. short and sweet, we love a queen who knows when to leave 💅

💀 Deprecated Options 💀

real talk: these options have been replaced with newer versions that use symspecs. they still exist, but they're the old way.
  • -e function_name — tells gprof to not print information about the function function_name (and its children...) in the call graph. the function will still be listed as a child of any functions that call it, but its index number will be shown as [not printed]. more than one -e option may be given, but only one function_name may be indicated with each -e option.
  • -E function_name — works like the -e option, but time spent in the function (and children who were not called from anywhere else) will not be used to compute the percentages-of-time for the call graph. more than one -E option may be given, but only one function_name may be indicated with each -E option.
  • -f function_name — causes gprof to limit the call graph to the function function_name and its children (and their children...). more than one -f option may be given, but only one function_name may be indicated with each -f option.
  • -F function_name — works like the -f option, but only time spent in the function and its children (and their children...) will be used to determine total-time and percentages-of-time for the call graph. more than one -F option may be given, but only one function_name may be indicated with each -F option. also, the -F option overrides the -E option. override drama 😤

📁 FILES 📁

  • a.out — the namelist and text space.
  • gmon.out — dynamic call graph and profile.
  • gmon.sum — summarized dynamic call graph and profile.

🐛 BUGS 🐛

ngl bestie, some of this is just... how it is. 😭

the granularity of the sampling is shown, but it remains statistical at best. we assume that the time for each execution of a function can be expressed by the total time for the function divided by the number of times the function is called. thus the time propagated along the call graph arcs to the function's parents is directly proportional to the number of times that arc is traversed.

parents that are not themselves profiled will have the time of their profiled children propagated to them, but they will appear to be spontaneously invoked in the call graph listing, and will not have their time propagated further. similarly, signal catchers, even though profiled, will appear to be spontaneous (although for more obscure reasons). any profiled children of signal catchers should have their times propagated properly, unless the signal catcher was invoked during the execution of the profiling routine, in which case all is lost. 💀

also, the profiled program must call exit(2) or return normally for the profiling information to be saved in the gmon.out file. don't skip this part 🙈

👀 SEE ALSO 👀

cc(1), prof(1), and the Info entry for gprof.

  • "An Execution Profiler for Modular Programs", by S. Graham, P. Kessler, M. McKusick; Software - Practice and Experience, Vol. 13, pp. 671-685, 1983.
  • "gprof: A Call Graph Execution Profiler", by S. Graham, P. Kessler, M. McKusick; Proceedings of the SIGPLAN '82 Symposium on Compiler Construction, SIGPLAN Notices, Vol. 17, No 6, pp. 120-126, June 1982.

the academic citations ate, honestly 🎀

Copyright (c) 1988-2023 Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

and that's the whole page, bestie! this one's from binutils-2.40.50, dated 2023-07-04, and yes it's the GPROF(1) manual — go profile something iconic 💖✨

📦 where this page comes from