aboutsummaryrefslogblamecommitdiffhomepage
path: root/trace_profile/callgrind.html
blob: 8e27485f0d43234d0640e911e72b5d107dec28c1 (plain) (tree)
1
2
3
4
5
6
7
8
9
               
                                                        






                                            
 





















                                                                            
 




                                                                                                             




                                          




















                                                                                                 
                                                  

                                          
                                     





                                                                         








                                                                                      

                                                     


                                                                         




                                                                                           




                                                                          


                                                    
                                                           























































                                                                                                                                                                                                                       


                                                                                          


                                                                                  


                                                                                                




                                                                                                                                                                        
                                                        











                                                                  




                                                                                                                               













                                                                                             

                                                                                 
             



















                                                                                                                    





























                                                                                                                                                                                                     
                                                                                                                                                                                                   












                                                                                                                                                                                      
                                                                                                                                                                                    



























                                                         
<!DOCTYPE HTML>
<html lang="en" class="light sidebar-visible" dir="ltr">
    <head>
        <!-- Book generated using mdBook -->
        <meta charset="UTF-8">
        <title>callgrind - Notes</title>


        <!-- Custom HTML head -->

        <meta name="description" content="">
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <meta name="theme-color" content="#ffffff">

        <link rel="icon" href="../favicon.svg">
        <link rel="shortcut icon" href="../favicon.png">
        <link rel="stylesheet" href="../css/variables.css">
        <link rel="stylesheet" href="../css/general.css">
        <link rel="stylesheet" href="../css/chrome.css">
        <link rel="stylesheet" href="../css/print.css" media="print">

        <!-- Fonts -->
        <link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
        <link rel="stylesheet" href="../fonts/fonts.css">

        <!-- Highlight.js Stylesheets -->
        <link rel="stylesheet" href="../highlight.css">
        <link rel="stylesheet" href="../tomorrow-night.css">
        <link rel="stylesheet" href="../ayu-highlight.css">

        <!-- Custom theme stylesheets -->


        <!-- Provide site root to javascript -->
        <script>
            var path_to_root = "../";
            var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
        </script>
        <!-- Start loading toc.js asap -->
        <script src="../toc.js"></script>
    </head>
    <body>
    <div id="body-container">
        <!-- Work around some values being stored in localStorage wrapped in quotes -->
        <script>
            try {
                var theme = localStorage.getItem('mdbook-theme');
                var sidebar = localStorage.getItem('mdbook-sidebar');

                if (theme.startsWith('"') && theme.endsWith('"')) {
                    localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
                }

                if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
                    localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
                }
            } catch (e) { }
        </script>

        <!-- Set the theme before any content is loaded, prevents flash -->
        <script>
            var theme;
            try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
            if (theme === null || theme === undefined) { theme = default_theme; }
            const html = document.documentElement;
            html.classList.remove('light')
            html.classList.add(theme);
            html.classList.add("js");
        </script>

        <input type="checkbox" id="sidebar-toggle-anchor" class="hidden">

        <!-- Hide / unhide sidebar before it is displayed -->
        <script>
            var sidebar = null;
            var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
            if (document.body.clientWidth >= 1080) {
                try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
                sidebar = sidebar || 'visible';
            } else {
                sidebar = 'hidden';
            }
            sidebar_toggle.checked = sidebar === 'visible';
            html.classList.remove('sidebar-visible');
            html.classList.add("sidebar-" + sidebar);
        </script>

        <nav id="sidebar" class="sidebar" aria-label="Table of contents">
            <!-- populated by js -->
            <mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
            <noscript>
                <iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
            </noscript>
            <div id="sidebar-resize-handle" class="sidebar-resize-handle">
                <div class="sidebar-resize-indicator"></div>
            </div>
        </nav>

        <div id="page-wrapper" class="page-wrapper">

            <div class="page">
                <div id="menu-bar-hover-placeholder"></div>
                <div id="menu-bar" class="menu-bar sticky">
                    <div class="left-buttons">
                        <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
                            <i class="fa fa-bars"></i>
                        </label>
                        <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
                            <i class="fa fa-paint-brush"></i>
                        </button>
                        <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
                            <li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
                            <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
                            <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
                            <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
                            <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
                        </ul>
                        <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
                            <i class="fa fa-search"></i>
                        </button>
                    </div>

                    <h1 class="menu-title">Notes</h1>

                    <div class="right-buttons">
                        <a href="../print.html" title="Print this book" aria-label="Print this book">
                            <i id="print-button" class="fa fa-print"></i>
                        </a>
                        <a href="https://github.com/johannst/notes" title="Git repository" aria-label="Git repository">
                            <i id="git-repository-button" class="fa fa-github"></i>
                        </a>

                    </div>
                </div>

                <div id="search-wrapper" class="hidden">
                    <form id="searchbar-outer" class="searchbar-outer">
                        <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
                    </form>
                    <div id="searchresults-outer" class="searchresults-outer hidden">
                        <div id="searchresults-header" class="searchresults-header"></div>
                        <ul id="searchresults">
                        </ul>
                    </div>
                </div>

                <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
                <script>
                    document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
                    document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
                    Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
                        link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
                    });
                </script>

                <div id="content" class="content">
                    <main>
                        <h1 id="callgrind"><a class="header" href="#callgrind">callgrind</a></h1>
<p>Callgrind is a tracing profiler which records the function call history of a
target program and collects the number of executed instructions. It is part of
the <a href="https://valgrind.org/docs/manual/cl-manual.html">valgrind</a> tool suite.</p>
<p>Profiling data is collected by instrumentation rather than sampling of the
target program.</p>
<p>Callgrind does not capture the actual time spent in a function but computes the
<em>inclusive</em> &amp; <em>exclusive</em> cost of a function based on the instructions fetched
(<code>Ir = Instruction read</code>). This provides reproducibility and high-precision and
is a major difference to sampling profilers like <code>perf</code> or <code>vtune</code>.
Therefore effects like slow IO are not reflected, which should be kept in mind
when analyzing callgrind results.</p>
<p>By default the profiler data is dumped when the target process is terminating,
but <a href="https://valgrind.org/docs/manual/cl-manual.html#cl-manual.callgrind_control-options">callgrind_control</a> allows for interactive control of callgrind.</p>
<pre><code class="language-bash"># Run a program under callgrind.
valgrind --tool=callgrind -- &lt;prog&gt; [&lt;args&gt;]

# Interactive control of callgrind.
callgrind_control [opts]
  opts:
    -b ............. show current backtrace
    -e ............. show current event counters
    -s ............. show current stats
    --dump[=file] .. dump current collection
    -i=on|off ...... turn instrumentation on|off
</code></pre>
<p>Results can be analyzed by using one of the following tools</p>
<ul>
<li><a href="https://valgrind.org/docs/manual/cl-manual.html#cl-manual.callgrind_annotate-options">callgrind_annotate</a> (cli)
<pre><code class="language-sh"># Show only specific trace events (default is all).
callgrind_annotate --show=Ir,Dr,Dw [callgrind_out_file]
</code></pre>
</li>
<li><a href="https://kcachegrind.github.io/html/Home.html">kcachegrind</a> (ui)</li>
</ul>
<p>The following is a collection of frequently used callgrind options.</p>
<pre><code class="language-bash">valgrind --tool=callgrind [opts] -- &lt;prog&gt;
  opts:
    --callgrind-out-file=&lt;file&gt; .... output file, rather than callgrind.out.&lt;pid&gt;
    --dump-instr=&lt;yes|no&gt; .......... annotation on instrucion level,
                                     allows for asm annotations

    --instr-atstart=&lt;yes|no&gt; ....... control if instrumentation is enabled from 
                                     beginning of the program

    --separate-threads=&lt;yes|no&gt; .... create separate output files per thread,
                                     appends -&lt;thread_id&gt; to the output file

    --cache-sim=&lt;yes|no&gt; ........... control if cache simulation is enabled
</code></pre>
<h2 id="trace-events"><a class="header" href="#trace-events">Trace events</a></h2>
<p>By default callgrind collects following events:</p>
<ul>
<li><code>Ir</code>: Instruction read</li>
</ul>
<p>Callgrind also provides a functional cache simulation with their own model,
which is enabled by passing <code>--cache-sim=yes</code>.
This simulates a 2-level cache hierarchy with separate L1 <em>instruction</em> and
<em>data</em> caches (<code>L1i</code>/ <code>L1d</code>) and a <em>unified</em> last level (<code>LL</code>) cache.
When enabled, this collects the following additional events:</p>
<ul>
<li><code>I1mr</code>: L1 cache miss on instruction read</li>
<li><code>ILmr</code>: LL cache miss on instruction read</li>
<li><code>Dr</code>: Data reads access</li>
<li><code>D1mr</code>: L1 cache miss on data read</li>
<li><code>DLmr</code>: LL cache miss on data read</li>
<li><code>Dw</code>: Data write access</li>
<li><code>D1mw</code>: L1 cache miss on data write</li>
<li><code>DLmw</code>: LL cache miss on data write</li>
</ul>
<h2 id="profile-specific-part-of-the-target"><a class="header" href="#profile-specific-part-of-the-target">Profile specific part of the target</a></h2>
<p>Programmatically enable/disable instrumentation using the macros defined in
the callgrind header.</p>
<pre><code class="language-c">#include &lt;valgrind/callgrind.h&gt;

int main() {
    // init ..

    CALLGRIND_START_INSTRUMENTATION;
    compute();
    CALLGRIND_STOP_INSTRUMENTATION;

    // shutdown ..
}
</code></pre>
<blockquote>
<p>In this case, callgrind should be launched with <code>--instr-atstart=no</code>.</p>
</blockquote>
<p>Alternatively instrumentation can be controlled with <code>callgrind_control -i on/off</code>.</p>
<p>The files <a href="callgrind/cg_example.cc">cg_example.cc</a> and
<a href="callgrind/Makefile">Makefile</a> provide a full example.</p>

                    </main>

                    <nav class="nav-wrapper" aria-label="Page navigation">
                        <!-- Mobile navigation buttons -->
                            <a rel="prev" href="../trace_profile/oprofile.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                                <i class="fa fa-angle-left"></i>
                            </a>

                            <a rel="next prefetch" href="../trace_profile/valgrind.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                                <i class="fa fa-angle-right"></i>
                            </a>

                        <div style="clear: both"></div>
                    </nav>
                </div>
            </div>

            <nav class="nav-wide-wrapper" aria-label="Page navigation">
                    <a rel="prev" href="../trace_profile/oprofile.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                        <i class="fa fa-angle-left"></i>
                    </a>

                    <a rel="next prefetch" href="../trace_profile/valgrind.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                        <i class="fa fa-angle-right"></i>
                    </a>
            </nav>

        </div>




        <script>
            window.playground_copyable = true;
        </script>


        <script src="../elasticlunr.min.js"></script>
        <script src="../mark.min.js"></script>
        <script src="../searcher.js"></script>

        <script src="../clipboard.min.js"></script>
        <script src="../highlight.js"></script>
        <script src="../book.js"></script>

        <!-- Custom JS scripts -->


    </div>
    </body>
</html>