GPROF(1)

📦
version 2.35.1 · 2 versions
, in debian bookworm, ubuntu noble, ubuntu resolute

GPROF 💖 — like, the call graph profile queen 👑

okay bestie, welcome to the GNU manual page for gprof, section 1 (that's user commands, iykyk). buckle up, this one's a chunky little icon and we're doing it in parts 🎀

✨ NAME ✨

gprof — display call graph profile data 💅

🌸 SYNOPSIS 🌸

gprof [ -[abcDhilLrsTvwxyz] ] [ -[ACeEfFJnNOpPqQRStZ][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 🦋

gprof produces an execution profile of C, Pascal, or Fortran77 programs. no cap. the effect of called routines gets folded into the profile of each caller — so like, every function's time includes the chaos its children caused 😭. the profile data comes from the call graph profile file (gmon.out is the default, obviously 💅), which is created by programs compiled with the -pg option of cc, pc, and f77. that -pg option also links in versions of the library routines compiled for profiling, so it's a whole vibe.

gprof reads the object file you give it (default is a.out, the classic) and establishes the relation between its symbol table and the call graph profile from gmon.out. and if you hand it more than one profile file? bestie, it shows the sum of the profile information across all of them. stacking the data, we love to see it ✨

gprof calculates the amount of time spent in each routine. next, those times get propagated along the edges of the call graph. cycles are discovered, and calls into a cycle are made to share the time of the cycle. it's giving... flow of time through the graph 🌀

several forms of output are 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 simply want to know which functions burn most of the cycles, it is stated concisely here. short, sweet, iconic 💅
  • the call graph shows, for each function, which functions called it, which other functions it called, and how many times. there's also 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. detective mode 🔍
  • 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. line-by-line receipts, we're obsessed 📝

💅 OPTIONS 💅

these options specify which of several output formats gprof should produce. pick your fighter 🫶

many of these options take an optional symspec to specify functions to be included or excluded. these options can be specified multiple times, with different symspecs, to include or exclude sets of symbols. go off, stack them 🎀

⚠️ specifying any of these options overrides the default (-p -q), which prints a flat profile and call graph analysis for all functions. so the moment you get specific, the defaults dip 💀
  • -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. only the chosen ones get the spotlight ✨
  • -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. like, we get it, bestie, we know what the columns mean 🙈
  • -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. quick peek then bounce 👋
  • -I dirs, --directory-path=dirs — the -I option specifies a list of search directories in which to find source files. environment variable GPROF_PATH can also be used to convey this information. used mostly for annotated source output. path hunting szn 🌈
  • -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. bye bye, specific symbols 👋💀
  • -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. give me the whole path or give me nothing 🗺️
  • -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. yes, the whole family tree 🌳
  • -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. top ten, but for hot lines 🔥
  • -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). file naming lore, no cap 📁✨
  • -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. sorry bestie, that part's on your system 💀

  • -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. 🫶

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.

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.

  • -T, --traditional — the -T option causes gprof to print its output in "traditional" BSD style. retro 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 it does it 📏
  • -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. every. single. line. 💅
  • --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. let those symbols breathe 🦋

🌈 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, periodt 🤫
  • -c, --static-call-graph — okay so this one is a whole heuristic vibe. It examines the text space of the object file and finds function calls in the binary machine code. Normally, call graph records only show up when functions are entered, but this option finds children that could have been called but never were. It also finds calls to functions that weren't compiled with profiling enabled—but only if there are symbol table entries for them. Calls to dynamic library routines are usually not found by this. Parents or children found this way show up in the call graph with call counts of 0. 💅
  • -D, --ignore-non-functions — makes gprof ignore symbols that aren't known to be functions. This gives more accurate profile data on systems where it's supported (like Solaris and HPUX). ✨
  • -k from/to — this one lets you delete from the call graph any arcs from symbols matching symspec from to those matching symspec to. bye felicia 👋
  • -l, --line — enables line-by-line profiling, so histogram hits get charged to individual source code lines instead of functions. > warning: this only works with programs compiled by older versions of gcc. Newer gcc versions are designed to work with the gcov tool instead, bestie. If the program was compiled with basic-block counting enabled, this option also identifies how many times each line of code was executed. Line-by-line profiling can help isolate where in a large function a program is spending its time, but it also significantly increases the running time of gprof and magnifies statistical inaccuracies. 😭
  • --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 is printed if you use it with the -L option. 🎀
  • -m num, --min-count=num — this only affects execution count output. Symbols executed less than num times are suppressed. periodt.
  • -nsymspec, --time=symspec — causes gprof, in its call graph analysis, to only propagate times for symbols matching symspec. ⏳
  • -Nsymspec, --no-time=symspec — the -n option causes gprof, in its call graph analysis, not to propagate times for symbols matching symspec. (yes it says -n here, we're just the messenger 💀)
  • -Sfilename, --external-symbol-table=filename — causes gprof to read an external symbol table file, such as /proc/kallsyms, rather than read the symbol table from the given object file (the default is a.out). This is useful for profiling kernel modules. 🔥
  • -z, --display-unused-functions — if you give the -z option, gprof will mention all functions in the flat profile, even those that were never called and had no time spent in them. This is useful with the -c option for discovering which routines were never called. 👑

Miscellaneous Options

  • -d[num], --debug[=num] — the -d num option specifies debugging options. If num is not specified, enable all debugging. 🐛
  • -h, --help — prints command line usage. simple as that. 🫶
  • -Oname, --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). ✨
  • -s, --sum — causes gprof to summarize the information in the profile data files it read in, and write out a profile data file called gmon.sum, which contains all the information from the profile data files that gprof read in. The file gmon.sum may be one of the specified input files; the effect of this is to merge the data in the other input files into gmon.sum. Eventually you can run gprof again without -s to analyze the cumulative data in the file gmon.sum. 🌈
  • -v, --version — prints the current version number, and then exits. bye 👋

Deprecated Options

These options have been replaced with newer versions that use symspecs. (so retro, but pls use the new ones bestie 💅)

  • -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; 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; 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; 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; only one function_name may be indicated with each -F option. The -F option overrides the -E option. 👑

💖 FILES 💖

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

🐛 BUGS 🐛

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. So 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. 😭

The profiled program must call exit(2) or return normally for the profiling information to be saved in the gmon.out file. no cap.

👀 SEE ALSO 👀

  • monitor(3), profil(2), 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.

Copyright (c) 1988-2020 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".

okay bestie, that's the whole vibe. this was from binutils-2.35.1, dated 2022-11-21, and it's giving GPROF(1) energy forever 💅✨

📦 where this page comes from