File: llvm-profgen.html

package info (click to toggle)
llvm-toolchain-13 1%3A13.0.1-6~deb10u4
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 1,418,792 kB
  • sloc: cpp: 5,290,827; ansic: 996,570; asm: 544,593; python: 188,212; objc: 72,027; lisp: 30,291; f90: 25,395; sh: 24,900; javascript: 9,780; pascal: 9,398; perl: 7,484; ml: 5,432; awk: 3,523; makefile: 2,892; xml: 953; cs: 573; fortran: 539
file content (208 lines) | stat: -rw-r--r-- 10,155 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208


<!DOCTYPE html>

<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>llvm-profgen - LLVM SPGO profile generation tool &#8212; LLVM 13 documentation</title>
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="../_static/llvm-theme.css" type="text/css" />
    <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
    <script src="../_static/jquery.js"></script>
    <script src="../_static/underscore.js"></script>
    <script src="../_static/doctools.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Coroutines in LLVM" href="../Coroutines.html" />
    <link rel="prev" title="llvm-pdbutil - PDB File forensics and diagnostics" href="llvm-pdbutil.html" />
<style type="text/css">
  table.right { float: right; margin-left: 20px; }
  table.right td { border: 1px solid #ccc; }
</style>

  </head><body>
<div class="logo">
  <a href="../index.html">
    <img src="../_static/logo.png"
         alt="LLVM Logo" width="250" height="88"/></a>
</div>

    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../Coroutines.html" title="Coroutines in LLVM"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="llvm-pdbutil.html" title="llvm-pdbutil - PDB File forensics and diagnostics"
             accesskey="P">previous</a> |</li>
  <li><a href="https://llvm.org/">LLVM Home</a>&nbsp;|&nbsp;</li>
  <li><a href="../index.html">Documentation</a>&raquo;</li>

          <li class="nav-item nav-item-1"><a href="../Reference.html" >Reference</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="index.html" accesskey="U">LLVM Command Guide</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">llvm-profgen - LLVM SPGO profile generation tool</a></li> 
      </ul>
    </div>

      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">

<h3>Documentation</h3>

<ul class="want-points">
    <li><a href="https://llvm.org/docs/GettingStartedTutorials.html">Getting Started/Tutorials</a></li>
    <li><a href="https://llvm.org/docs/UserGuides.html">User Guides</a></li>
    <li><a href="https://llvm.org/docs/Reference.html">Reference</a></li>
</ul>

<h3>Getting Involved</h3>

<ul class="want-points">
    <li><a href="https://llvm.org/docs/Contributing.html">Contributing to LLVM</a></li>
    <li><a href="https://llvm.org/docs/HowToSubmitABug.html">Submitting Bug Reports</a></li>
    <li><a href="https://llvm.org/docs/GettingInvolved.html#mailing-lists">Mailing Lists</a></li>
    <li><a href="https://llvm.org/docs/GettingInvolved.html#irc">IRC</a></li>
    <li><a href="https://llvm.org/docs/GettingInvolved.html#meetups-and-social-events">Meetups and Social Events</a></li>
</ul>

<h3>Additional Links</h3>

<ul class="want-points">
    <li><a href="https://llvm.org/docs/FAQ.html">FAQ</a></li>
    <li><a href="https://llvm.org/docs/Lexicon.html">Glossary</a></li>
    <li><a href="https://llvm.org/pubs">Publications</a></li>
    <li><a href="https://github.com/llvm/llvm-project//">Github Repository</a></li>
</ul>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/CommandGuide/llvm-profgen.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>
        </div>
      </div>

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="llvm-profgen-llvm-spgo-profile-generation-tool">
<h1>llvm-profgen - LLVM SPGO profile generation tool<a class="headerlink" href="#llvm-profgen-llvm-spgo-profile-generation-tool" title="Permalink to this headline">¶</a></h1>
<div class="section" id="synopsis">
<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
<p><strong class="program">llvm-profgen</strong> [<em>commands</em>] [<em>options</em>]</p>
</div>
<div class="section" id="description">
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>The <strong class="program">llvm-profgen</strong> utility generates a profile data file
from given perf script data files for sample-based profile guided
optimization(SPGO).</p>
</div>
<div class="section" id="commands">
<h2>COMMANDS<a class="headerlink" href="#commands" title="Permalink to this headline">¶</a></h2>
<p>At least one of the following commands are required:</p>
<dl class="std option">
<dt id="cmdoption-llvm-profgen-perfscript">
<code class="sig-name descname"><span class="pre">--perfscript</span></code><code class="sig-prename descclassname"><span class="pre">=&lt;string[,string,...]&gt;</span></code><a class="headerlink" href="#cmdoption-llvm-profgen-perfscript" title="Permalink to this definition">¶</a></dt>
<dd><p>Path of perf-script trace created by Linux perf tool with <cite>script</cite>
command(the raw perf.data should be profiled with -b).</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-llvm-profgen-binary">
<code class="sig-name descname"><span class="pre">--binary</span></code><code class="sig-prename descclassname"><span class="pre">=&lt;string[,string,...]&gt;</span></code><a class="headerlink" href="#cmdoption-llvm-profgen-binary" title="Permalink to this definition">¶</a></dt>
<dd><p>Path of the input profiled binary files.</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-llvm-profgen-output">
<code class="sig-name descname"><span class="pre">--output</span></code><code class="sig-prename descclassname"><span class="pre">=&lt;string&gt;</span></code><a class="headerlink" href="#cmdoption-llvm-profgen-output" title="Permalink to this definition">¶</a></dt>
<dd><p>Path of the output profile file.</p>
</dd></dl>

</div>
<div class="section" id="options">
<h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
<p><strong class="program">llvm-profgen</strong> supports the following options:</p>
<dl class="std option">
<dt id="cmdoption-llvm-profgen-format">
<code class="sig-name descname"><span class="pre">--format</span></code><code class="sig-prename descclassname"><span class="pre">=[text|binary|extbinary|compbinary|gcc]</span></code><a class="headerlink" href="#cmdoption-llvm-profgen-format" title="Permalink to this definition">¶</a></dt>
<dd><p>Specify the format of the generated profile. Supported &lt;format&gt;  are <cite>text</cite>,
<cite>binary</cite>, <cite>extbinary</cite>, <cite>compbinary</cite>, <cite>gcc</cite>, see <cite>llvm-profdata</cite> for more
descriptions of the format.</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-llvm-profgen-show-mmap-events">
<code class="sig-name descname"><span class="pre">--show-mmap-events</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-profgen-show-mmap-events" title="Permalink to this definition">¶</a></dt>
<dd><p>Print mmap events.</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-llvm-profgen-show-disassembly">
<code class="sig-name descname"><span class="pre">--show-disassembly</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-profgen-show-disassembly" title="Permalink to this definition">¶</a></dt>
<dd><p>Print disassembled code.</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-llvm-profgen-x86-asm-syntax">
<code class="sig-name descname"><span class="pre">--x86-asm-syntax</span></code><code class="sig-prename descclassname"><span class="pre">=[att|intel]</span></code><a class="headerlink" href="#cmdoption-llvm-profgen-x86-asm-syntax" title="Permalink to this definition">¶</a></dt>
<dd><p>Specify whether to print assembly code in AT&amp;T syntax (the default) or Intel
syntax.</p>
</dd></dl>

</div>
</div>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../Coroutines.html" title="Coroutines in LLVM"
             >next</a> |</li>
        <li class="right" >
          <a href="llvm-pdbutil.html" title="llvm-pdbutil - PDB File forensics and diagnostics"
             >previous</a> |</li>
  <li><a href="https://llvm.org/">LLVM Home</a>&nbsp;|&nbsp;</li>
  <li><a href="../index.html">Documentation</a>&raquo;</li>

          <li class="nav-item nav-item-1"><a href="../Reference.html" >Reference</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="index.html" >LLVM Command Guide</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">llvm-profgen - LLVM SPGO profile generation tool</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2003-2021, LLVM Project.
      Last updated on 2021-09-18.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.4.
    </div>
  </body>
</html>