1b90d8459525ac68a90de1a2075c281800958b40
[oota-llvm.git] / docs / CommandGuide / gccld.html
1 <html>
2 <title>LLVM: gccld tool</title>
3
4 <body bgcolor=white>
5
6 <center><h1>LLVM: <tt>gccld</tt> tool</h1></center>
7 <HR>
8
9 <h3>NAME</h3>
10 <tt>gccld</tt>
11
12 <h3>SYNOPSIS</h3>
13 <tt>gccld [options] &lt; filename&gt; [ filename ...]</tt>
14
15 <h3>DESCRIPTION</h3>
16
17 The <tt>gccld</tt> utility takes a set of LLVM bytecode files and links them
18 together into a single LLVM bytecode file.  The output bytecode file can be
19 another bytecode library or an executable bytecode program.  Using additional
20 options, <tt>gccld</tt> is able to produce native code executables.
21 <p>
22
23 The <tt>gccld</tt> utility is primarily used by the <a href="llvmgcc.html">C</a>
24 and <a href="llvmgxx.html">C++</a> front-ends, and as such, attempts to mimic
25 the interface provided by the default system linker so that it can act as a
26 "drop-in" replacement.
27 <p>
28
29 The <tt>gccld</tt> tool performs a small set of interprocedural, post-link,
30 optimizations on the program.
31
32
33 <h4>Search Order</h4>
34
35 When looking for objects specified on the command line, <tt>gccld</tt> will
36 search for the object first in the current directory and then in the directory
37 specified by the <tt>LLVM_LIB_SEARCH_PATH</tt> environment variable.  If it
38 cannot find the object, it fails.
39 <p>
40
41 When looking for a library specified with the -l option, <tt>gccld</tt> first
42 attempts to load a file with that name from the current directory.  If that
43 fails, it looks for lib&lt;library&gt;.bc, lib&lt;library&gt;.a, or
44 lib&lt;library&gt;.so, in that order, in each directory added to the library
45 search path with the -L option.  These directories are searched in order they
46 were specified.  If the library cannot be located, then <tt>gccld</tt> looks in
47 the directory specified by the <tt>LLVM_LIB_SEARCH_PATH</tt> environment
48 variable.  If it does not find lib&lt;library&gt;.[bc | a | so] there, it fails.
49
50 The -L option is global.  It does not matter where it is specified in the list
51 of command line arguments; the directory is simply added to the search path and
52 is applied to all libraries, preceding or succeeding, in the command line.
53
54 <h4>Link order</h4>
55
56 All object files are linked first in the order they were specified on the
57 command line.  All library files are linked next.  Some libraries may not be
58 linked into the object program; see below.
59
60 <h4>Library Linkage</h4>
61
62 Object files and static bytecode objects are always linked into the output
63 file.  Library archives (.a files) load only the objects within the archive
64 that define symbols needed by the output file.  Hence, libraries should be
65 listed after the object files and libraries which need them; otherwise, the
66 library may not be linked in, and the dependent library will not have its
67 undefined symbols defined.
68
69 <h4>Native code generation</h4>
70
71 The <tt>gccld</tt> program has limited support for native code generation, when
72 using the -native option.
73
74
75 <h3>OPTIONS</h3>
76
77 <ul>
78         <li> -help
79         <br>
80         Print a summary of command line options.
81         <p>
82
83         <li> -o &lt;filename&gt;
84         <br>
85         Specify the output filename which will hold the linked bytecode.
86         <p>
87
88         <li> -stats
89         <br>
90         Print statistics.
91         <p>
92
93         <li> -time-passes
94         <br>
95         Record the amount of time needed for each pass and print it to standard
96         error.
97         <p>
98
99         <li> -verify
100         <br>
101         Verify each pass result.
102         <p>
103
104         <li> -disable-opt
105         <br>
106     Disable all link-time optimization passes.
107         <p>
108
109         <li> -L=&lt;directory&gt;
110         <br>
111         Add directory to the list of directories to search when looking for
112         libraries.
113         <p>
114
115         <li> -disable-internalize
116         <br>
117         Do not mark all symbols as internal.
118         <p>
119
120         <li> -internalize-public-api-file &lt;filename&gt;
121         <br>
122         Preserve the list of symbol names in the file filename.
123         <p>
124
125         <li> -internalize-public-api-list &lt;list&gt;
126         <br>
127         Preserve the symbol names in list.
128         <p>
129
130         <li> -l=&lt;library&gt;
131         <br>
132         Specify libraries to include when linking the output file.  When
133         linking, <tt>gccld</tt> will first attempt to load a file with the
134         pathname library.  If that fails, it will then attempt to load
135         lib&lt;library&gt;.bc, lib&lt;library&gt;.a, and lib&lt;library&gt;.so,
136         in that order.
137         <p>
138
139         <li> -link-as-library
140         <br>
141         Link the .bc files together as a library, not an executable.
142         <p>
143
144         <li> -native
145         <br>
146         Generate a native, machine code executable.
147   <p>
148   When generating native executables, <tt>gccld</tt> first checks for a bytecode
149   version of the library and links it in, if necessary.  If the library is
150   missing, <tt>gccld</tt> skips it.  Then, <tt>gccld</tt> links in the same
151   libraries as native code.
152   <p>
153   In this way, <tt>gccld</tt> should be able to link in optimized bytecode
154   subsets of common libraries and then link in any part of the library that
155   hasn't been converted to bytecode.
156         <p>
157
158         <li> -s
159         <br>
160         Strip symbol information from the generated executable.
161         <p>
162
163         <li> -v
164         <br>
165         Print information about actions taken.
166 </ul>
167
168 <h3>EXIT STATUS</h3>
169
170 If <tt>gccld</tt> succeeds, it will exit with 0.  Otherwise, if an error occurs,
171 it will exit with a non-zero value.
172
173 <h3>SEE ALSO</h3>
174 <a href="llvm-link.html"><tt>llvm-link</tt></a>
175 <a href="gccas.html"><tt>gccas</tt></a>
176
177 <h3>BUGS</h3>
178 The -L option cannot be used for find native code libraries when using the
179 -native option.
180
181 <HR>
182 Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
183 </body>
184 </html>
185