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
209
210
211
212
213
214
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Advice on Packaging LLVM — 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="How To Validate a New Release" href="ReleaseProcess.html" />
<link rel="prev" title="How To Release LLVM To The Public" href="HowToReleaseLLVM.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="ReleaseProcess.html" title="How To Validate a New Release"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="HowToReleaseLLVM.html" title="How To Release LLVM To The Public"
accesskey="P">previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="GettingInvolved.html" accesskey="U">Getting Involved</a> »</li>
<li class="nav-item nav-item-this"><a href="">Advice on Packaging LLVM</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/Packaging.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="advice-on-packaging-llvm">
<h1>Advice on Packaging LLVM<a class="headerlink" href="#advice-on-packaging-llvm" title="Permalink to this headline">¶</a></h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#overview" id="id1">Overview</a></p></li>
<li><p><a class="reference internal" href="#compile-flags" id="id2">Compile Flags</a></p></li>
<li><p><a class="reference internal" href="#c-features" id="id3">C++ Features</a></p></li>
<li><p><a class="reference internal" href="#shared-library" id="id4">Shared Library</a></p></li>
<li><p><a class="reference internal" href="#dependencies" id="id5">Dependencies</a></p></li>
</ul>
</div>
<div class="section" id="overview">
<h2><a class="toc-backref" href="#id1">Overview</a><a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
<p>LLVM sets certain default configure options to make sure our developers don’t
break things for constrained platforms. These settings are not optimal for most
desktop systems, and we hope that packagers (e.g., Redhat, Debian, MacPorts,
etc.) will tweak them. This document lists settings we suggest you tweak.</p>
<p>LLVM’s API changes with each release, so users are likely to want, for example,
both LLVM-2.6 and LLVM-2.7 installed at the same time to support apps developed
against each.</p>
</div>
<div class="section" id="compile-flags">
<h2><a class="toc-backref" href="#id2">Compile Flags</a><a class="headerlink" href="#compile-flags" title="Permalink to this headline">¶</a></h2>
<p>LLVM runs much more quickly when it’s optimized and assertions are removed.
However, such a build is currently incompatible with users who build without
defining <code class="docutils literal notranslate"><span class="pre">NDEBUG</span></code>, and the lack of assertions makes it hard to debug problems
in user code. We recommend allowing users to install both optimized and debug
versions of LLVM in parallel. The following configure flags are relevant:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">--disable-assertions</span></code></dt><dd><p>Builds LLVM with <code class="docutils literal notranslate"><span class="pre">NDEBUG</span></code> defined. Changes the LLVM ABI. Also available
by setting <code class="docutils literal notranslate"><span class="pre">DISABLE_ASSERTIONS=0|1</span></code> in <code class="docutils literal notranslate"><span class="pre">make</span></code>’s environment. This
defaults to enabled regardless of the optimization setting, but it slows
things down.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--enable-debug-symbols</span></code></dt><dd><p>Builds LLVM with <code class="docutils literal notranslate"><span class="pre">-g</span></code>. Also available by setting <code class="docutils literal notranslate"><span class="pre">DEBUG_SYMBOLS=0|1</span></code> in
<code class="docutils literal notranslate"><span class="pre">make</span></code>’s environment. This defaults to disabled when optimizing, so you
should turn it back on to let users debug their programs.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--enable-optimized</span></code></dt><dd><p>(For git checkouts) Builds LLVM with <code class="docutils literal notranslate"><span class="pre">-O2</span></code> and, by default, turns off
debug symbols. Also available by setting <code class="docutils literal notranslate"><span class="pre">ENABLE_OPTIMIZED=0|1</span></code> in
<code class="docutils literal notranslate"><span class="pre">make</span></code>’s environment. This defaults to enabled when not in a
checkout.</p>
</dd>
</dl>
</div>
<div class="section" id="c-features">
<h2><a class="toc-backref" href="#id3">C++ Features</a><a class="headerlink" href="#c-features" title="Permalink to this headline">¶</a></h2>
<dl class="simple">
<dt>RTTI</dt><dd><p>LLVM disables RTTI by default. Add <code class="docutils literal notranslate"><span class="pre">REQUIRES_RTTI=1</span></code> to your environment
while running <code class="docutils literal notranslate"><span class="pre">make</span></code> to re-enable it. This will allow users to build with
RTTI enabled and still inherit from LLVM classes.</p>
</dd>
</dl>
</div>
<div class="section" id="shared-library">
<h2><a class="toc-backref" href="#id4">Shared Library</a><a class="headerlink" href="#shared-library" title="Permalink to this headline">¶</a></h2>
<p>Configure with <code class="docutils literal notranslate"><span class="pre">--enable-shared</span></code> to build
<code class="docutils literal notranslate"><span class="pre">libLLVM-<major>.<minor>.(so|dylib)</span></code> and link the tools against it. This
saves lots of binary size at the cost of some startup time.</p>
</div>
<div class="section" id="dependencies">
<h2><a class="toc-backref" href="#id5">Dependencies</a><a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h2>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">--enable-libffi</span></code></dt><dd><p>Depend on <a class="reference external" href="http://sources.redhat.com/libffi/">libffi</a> to allow the LLVM
interpreter to call external functions.</p>
</dd>
</dl>
<p><code class="docutils literal notranslate"><span class="pre">--with-oprofile</span></code></p>
<blockquote>
<div><p>Depend on <a class="reference external" href="http://oprofile.sourceforge.net/doc/devel/index.html">libopagent</a> (>=version 0.9.4)
to let the LLVM JIT tell oprofile about function addresses and line
numbers.</p>
</div></blockquote>
</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="ReleaseProcess.html" title="How To Validate a New Release"
>next</a> |</li>
<li class="right" >
<a href="HowToReleaseLLVM.html" title="How To Release LLVM To The Public"
>previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="GettingInvolved.html" >Getting Involved</a> »</li>
<li class="nav-item nav-item-this"><a href="">Advice on Packaging LLVM</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© 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>
|
