Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / llvm / 776d99342b05872d6022ee9ff87bf195e3cd8491 / . / docs / GoldPlugin.html
blob: 92ba4116a071624a381615b810373ad58cf38bc1 [file] [log] [blame]
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
5 <title>LLVM gold plugin</title>
6 <link rel="stylesheet" href="llvm.css" type="text/css">
7</head>
8<body>
9
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]10<h1>LLVM gold plugin</h1>
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]11<ol>
12 <li><a href="#introduction">Introduction</a></li>
13 <li><a href="#build">How to build it</a></li>
Nick Lewyckyf3888ba2009-03-01 21:55:10 +0000[diff] [blame]14 <li><a href="#usage">Usage</a>
15 <ul>
16 <li><a href="#example1">Example of link time optimization</a></li>
Torok Edwin5641f8d2009-06-03 15:06:19 +0000[diff] [blame]17 <li><a href="#lto_autotools">Quickstart for using LTO with autotooled projects</a></li>
Nick Lewyckyf3888ba2009-03-01 21:55:10 +0000[diff] [blame]18 </ul></li>
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]19 <li><a href="#licensing">Licensing</a></li>
20</ol>
21<div class="doc_author">Written by Nick Lewycky</div>
22
23<!--=========================================================================-->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]24<h2><a name="introduction">Introduction</a></h2>
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]25<!--=========================================================================-->
NAKAMURA Takumif5af6ad2011-04-23 00:30:22 +0000[diff] [blame]26<div>
Duncan Sands10f06752009-03-01 15:19:03 +0000[diff] [blame]27 <p>Building with link time optimization requires cooperation from the
Nick Lewyckyfd97aa22009-03-01 09:51:07 +0000[diff] [blame]28system linker. LTO support on Linux systems requires that you use
Duncan Sands10f06752009-03-01 15:19:03 +0000[diff] [blame]29the <a href="http://sourceware.org/binutils">gold linker</a> which supports
Nick Lewycky5c212802010-04-17 07:00:24 +0000[diff] [blame]30LTO via plugins. This is the same mechanism used by the
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]31<a href="http://gcc.gnu.org/wiki/LinkTimeOptimization">GCC LTO</a>
Duncan Sands10f06752009-03-01 15:19:03 +0000[diff] [blame]32project.</p>
33 <p>The LLVM gold plugin implements the
34<a href="http://gcc.gnu.org/wiki/whopr/driver">gold plugin interface</a>
35on top of
NAKAMURA Takumi31c18062011-04-09 02:13:48 +0000[diff] [blame]36<a href="LinkTimeOptimization.html#lto">libLTO</a>.
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]37The same plugin can also be used by other tools such as <tt>ar</tt> and
38<tt>nm</tt>.
39</div>
40<!--=========================================================================-->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]41<h2><a name="build">How to build it</a></h2>
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]42<!--=========================================================================-->
NAKAMURA Takumif5af6ad2011-04-23 00:30:22 +0000[diff] [blame]43<div>
Nick Lewycky5c212802010-04-17 07:00:24 +0000[diff] [blame]44 <p>You need to have gold with plugin support and build the LLVMgold
45plugin. Check whether you have gold running <tt>/usr/bin/ld -v</tt>. It will
46report &#8220;GNU gold&#8221; or else &#8220GNU ld&#8221; if not. If you have
47gold, check for plugin support by running <tt>/usr/bin/ld -plugin</tt>. If it
48complains &#8220missing argument&#8221 then you have plugin support. If not,
49such as an &#8220;unknown option&#8221; error then you will either need to
50build gold or install a version with plugin support.</p>
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]51<ul>
Nick Lewycky5c212802010-04-17 07:00:24 +0000[diff] [blame]52 <li>To build gold with plugin support:
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]53 <pre class="doc_code">
54mkdir binutils
55cd binutils
56cvs -z 9 -d :pserver:anoncvs@sourceware.org:/cvs/src login
57<em>{enter "anoncvs" as the password}</em>
Duncan Sandsed7713d2010-10-06 06:45:11 +0000[diff] [blame]58cvs -z 9 -d :pserver:anoncvs@sourceware.org:/cvs/src co binutils
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]59mkdir build
60cd build
61../src/configure --enable-gold --enable-plugins
62make all-gold
63</pre>
Nick Lewycky5c212802010-04-17 07:00:24 +0000[diff] [blame]64 That should leave you with <tt>binutils/build/gold/ld-new</tt> which supports the <tt>-plugin</tt> option. It also built would have
65<tt>binutils/build/binutils/ar</tt> and <tt>nm-new</tt> which support plugins
66but don't have a visible -plugin option, instead relying on the gold plugin
67being present in <tt>../lib/bfd-plugins</tt> relative to where the binaries are
68placed.
Duncan Sands10f06752009-03-01 15:19:03 +0000[diff] [blame]69 <li>Build the LLVMgold plugin: Configure LLVM with
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]70 <tt>--with-binutils-include=/path/to/binutils/src/include</tt> and run
71 <tt>make</tt>.
72</ul>
73</div>
74<!--=========================================================================-->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]75<h2><a name="usage">Usage</a></h2>
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]76<!--=========================================================================-->
NAKAMURA Takumif5af6ad2011-04-23 00:30:22 +0000[diff] [blame]77<div>
Bill Wendlingea55c832011-09-18 12:37:20 +0000[diff] [blame]78
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]79 <p>The linker takes a <tt>-plugin</tt> option that points to the path of
80 the plugin <tt>.so</tt> file. To find out what link command <tt>gcc</tt>
81 would run in a given situation, run <tt>gcc -v <em>[...]</em></tt> and look
82 for the line where it runs <tt>collect2</tt>. Replace that with
Rafael Espindola53843f82010-08-08 21:14:26 +0000[diff] [blame]83 <tt>ld-new -plugin /path/to/LLVMgold.so</tt> to test it out. Once you're
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]84 ready to switch to using gold, backup your existing <tt>/usr/bin/ld</tt>
85 then replace it with <tt>ld-new</tt>.</p>
Bill Wendlingea55c832011-09-18 12:37:20 +0000[diff] [blame]86
87 <p>You can produce bitcode files from <tt>clang</tt> using
Nick Lewyckyd66ff0f2009-03-01 20:58:07 +0000[diff] [blame]88 <tt>-emit-llvm</tt> or <tt>-flto</tt>, or the <tt>-O4</tt> flag which is
89 synonymous with <tt>-O3 -flto</tt>.</p>
Bill Wendlingea55c832011-09-18 12:37:20 +0000[diff] [blame]90
91 <p><tt>Clang</tt> has a <tt>-use-gold-plugin</tt> option which looks for the
92 gold plugin in the same directories as it looks for <tt>cc1</tt> and passes
93 the <tt>-plugin</tt> option to <tt>ld</tt>. It will not look for an alternate
Nick Lewycky050147c2009-03-01 18:48:53 +0000[diff] [blame]94 linker, which is why you need gold to be the installed system linker in your
95 path.</p>
Bill Wendlingea55c832011-09-18 12:37:20 +0000[diff] [blame]96
Nick Lewycky5c212802010-04-17 07:00:24 +0000[diff] [blame]97 <p>If you want <tt>ar</tt> and <tt>nm</tt> to work seamlessly as well, install
Rafael Espindola53843f82010-08-08 21:14:26 +0000[diff] [blame]98 <tt>LLVMgold.so</tt> to <tt>/usr/lib/bfd-plugins</tt>. If you built your
Nick Lewycky5c212802010-04-17 07:00:24 +0000[diff] [blame]99 own gold, be sure to install the <tt>ar</tt> and <tt>nm-new</tt> you built to
Bill Wendlingea55c832011-09-18 12:37:20 +0000[diff] [blame]100 <tt>/usr/bin</tt>.<p>
Nick Lewyckyf3888ba2009-03-01 21:55:10 +0000[diff] [blame]101
102<!-- ======================================================================= -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]103<h3>
Nick Lewyckyf3888ba2009-03-01 21:55:10 +0000[diff] [blame]104 <a name="example1">Example of link time optimization</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]105</h3>
Nick Lewyckyf3888ba2009-03-01 21:55:10 +0000[diff] [blame]106
NAKAMURA Takumif5af6ad2011-04-23 00:30:22 +0000[diff] [blame]107<div>
Nick Lewyckyf3888ba2009-03-01 21:55:10 +0000[diff] [blame]108 <p>The following example shows a worked example of the gold plugin mixing
109 LLVM bitcode and native code.
110<pre class="doc_code">
111--- a.c ---
112#include &lt;stdio.h&gt;
113
114extern void foo1(void);
115extern void foo4(void);
116
117void foo2(void) {
118 printf("Foo2\n");
119}
120
121void foo3(void) {
122 foo4();
123}
124
125int main(void) {
126 foo1();
127}
128
129--- b.c ---
130#include &lt;stdio.h&gt;
131
132extern void foo2(void);
133
134void foo1(void) {
135 foo2();
136}
137
138void foo4(void) {
139 printf("Foo4");
140}
141
142--- command lines ---
Bill Wendlingea55c832011-09-18 12:37:20 +0000[diff] [blame]143$ clang -flto a.c -c -o a.o # &lt;-- a.o is LLVM bitcode file
Rafael Espindola91f935e2009-07-08 11:13:34 +0000[diff] [blame]144$ ar q a.a a.o # &lt;-- a.a is an archive with LLVM bitcode
Bill Wendlingea55c832011-09-18 12:37:20 +0000[diff] [blame]145$ clang b.c -c -o b.o # &lt;-- b.o is native object file
146$ clang -use-gold-plugin a.a b.o -o main # &lt;-- link with LLVMgold plugin
Nick Lewyckyf3888ba2009-03-01 21:55:10 +0000[diff] [blame]147</pre>
Bill Wendlingea55c832011-09-18 12:37:20 +0000[diff] [blame]148
Nick Lewyckyf3888ba2009-03-01 21:55:10 +0000[diff] [blame]149 <p>Gold informs the plugin that foo3 is never referenced outside the IR,
150 leading LLVM to delete that function. However, unlike in the
NAKAMURA Takumi31c18062011-04-09 02:13:48 +0000[diff] [blame]151 <a href="LinkTimeOptimization.html#example1">libLTO
Nick Lewyckyf3888ba2009-03-01 21:55:10 +0000[diff] [blame]152 example</a> gold does not currently eliminate foo4.</p>
153</div>
154
NAKAMURA Takumif5af6ad2011-04-23 00:30:22 +0000[diff] [blame]155</div>
156
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]157<!--=========================================================================-->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]158<h2>
159 <a name="lto_autotools">
160 Quickstart for using LTO with autotooled projects
161 </a>
162</h2>
Torok Edwin5641f8d2009-06-03 15:06:19 +0000[diff] [blame]163<!--=========================================================================-->
NAKAMURA Takumif5af6ad2011-04-23 00:30:22 +0000[diff] [blame]164<div>
Bill Wendlingea55c832011-09-18 12:37:20 +0000[diff] [blame]165 <p>Once your system <tt>ld</tt>, <tt>ar</tt>, and <tt>nm</tt> all support LLVM
166 bitcode, everything is in place for an easy to use LTO build of autotooled
167 projects:</p>
168
Torok Edwin5641f8d2009-06-03 15:06:19 +0000[diff] [blame]169 <ul>
Rafael Espindola53843f82010-08-08 21:14:26 +0000[diff] [blame]170 <li>Follow the instructions <a href="#build">on how to build LLVMgold.so</a>.</li>
Torok Edwin5641f8d2009-06-03 15:06:19 +0000[diff] [blame]171 <li>Install the newly built binutils to <tt>$PREFIX</tt></li>
Rafael Espindola53843f82010-08-08 21:14:26 +0000[diff] [blame]172 <li>Copy <tt>Release/lib/LLVMgold.so</tt> to
Bill Wendlingea55c832011-09-18 12:37:20 +0000[diff] [blame]173 <tt>$PREFIX/libexec/gcc/x86_64-unknown-linux-gnu/4.2.1/</tt> and
174 <tt>$PREFIX/lib/bfd-plugins/</tt></li>
175 <li>Set environment variables (<tt>$PREFIX</tt> is where you installed clang and
176 binutils):
177<pre class="doc_code">
178export CC="$PREFIX/bin/clang -use-gold-plugin"
179export CXX="$PREFIX/bin/clang++ -use-gold-plugin"
Torok Edwin347c7bb2009-06-04 16:08:10 +0000[diff] [blame]180export AR="$PREFIX/bin/ar"
181export NM="$PREFIX/bin/nm"
Torok Edwin5641f8d2009-06-03 15:06:19 +0000[diff] [blame]182export RANLIB=/bin/true #ranlib is not needed, and doesn't support .bc files in .a
183export CFLAGS="-O4"
Nick Lewycky9d813df2009-06-06 18:14:04 +0000[diff] [blame]184</pre>
Torok Edwin5641f8d2009-06-03 15:06:19 +0000[diff] [blame]185 </li>
Torok Edwin347c7bb2009-06-04 16:08:10 +0000[diff] [blame]186 <li>Or you can just set your path:
Bill Wendlingea55c832011-09-18 12:37:20 +0000[diff] [blame]187<pre class="doc_code">
Torok Edwin347c7bb2009-06-04 16:08:10 +0000[diff] [blame]188export PATH="$PREFIX/bin:$PATH"
Bill Wendlingea55c832011-09-18 12:37:20 +0000[diff] [blame]189export CC="clang -use-gold-plugin"
190export CXX="clang++ -use-gold-plugin"
Torok Edwin347c7bb2009-06-04 16:08:10 +0000[diff] [blame]191export RANLIB=/bin/true
192export CFLAGS="-O4"
Bill Wendlingea55c832011-09-18 12:37:20 +0000[diff] [blame]193</pre></li>
194 <li>Configure &amp; build the project as usual:
195<pre class="doc_code">
196% ./configure &amp;&amp; make &amp;&amp; make check
197</pre></li>
Torok Edwin5641f8d2009-06-03 15:06:19 +0000[diff] [blame]198 </ul>
Bill Wendlingea55c832011-09-18 12:37:20 +0000[diff] [blame]199
200 <p>The environment variable settings may work for non-autotooled projects
201 too, but you may need to set the <tt>LD</tt> environment variable as
202 well.</p>
Torok Edwin5641f8d2009-06-03 15:06:19 +0000[diff] [blame]203</div>
204
205<!--=========================================================================-->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]206<h2><a name="licensing">Licensing</a></h2>
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]207<!--=========================================================================-->
NAKAMURA Takumif5af6ad2011-04-23 00:30:22 +0000[diff] [blame]208<div>
Nick Lewyckyef5facd2009-04-13 02:03:40 +0000[diff] [blame]209 <p>Gold is licensed under the GPLv3. LLVMgold uses the interface file
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]210<tt>plugin-api.h</tt> from gold which means that the resulting LLVMgold.so
211binary is also GPLv3. This can still be used to link non-GPLv3 programs just
Nick Lewyckyef5facd2009-04-13 02:03:40 +0000[diff] [blame]212as much as gold could without the plugin.</p>
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]213</div>
214
215<!-- *********************************************************************** -->
216<hr>
217<address>
218 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
219 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
220 <a href="http://validator.w3.org/check/referer"><img
221 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]222 <a href="mailto:nicholas@metrix.on.ca">Nick Lewycky</a><br>
NAKAMURA Takumib9a33632011-04-09 02:13:37 +0000[diff] [blame]223 <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
Nick Lewycky5c212802010-04-17 07:00:24 +0000[diff] [blame]224 Last modified: $Date: 2010-04-16 23:58:21 -0800 (Fri, 16 Apr 2010) $
Nick Lewyckyebc67652009-03-01 09:38:29 +0000[diff] [blame]225</address>
226</body>
227</html>