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 <p>
  36 When looking for objects specified on the command line, <tt>gccld</tt> will
  37 search for the object first in the current directory and then in the directory
  38 specified by the <tt>LLVM_LIB_SEARCH_PATH</tt> environment variable.  If it
  39 cannot find the object, it fails.
  40 </p>
  41
  42 <p>
  43 When looking for a library specified with the -l option, <tt>gccld</tt> first
  44 attempts to load a file with that name from the current directory.  If that
  45 fails, it looks for lib&lt;library&gt;.bc, lib&lt;library&gt;.a, or
  46 lib&lt;library&gt;.&lt;shared library extension&gt;, in that order, in each
  47 directory added to the library search path with the -L option.  These
  48 directories are searched in the order they
  49 were specified.  If the library cannot be located, then <tt>gccld</tt> looks in
  50 the directory specified by the <tt>LLVM_LIB_SEARCH_PATH</tt> environment
  51 variable.  If it does not find a library there, it fails.
  52 </p>
  53
  54 <p>
  55 The shared library extension is usually <tt>.so</tt>, but it may differ
  56 depending upon the system.
  57 </p>
  58
  59 <p>
  60 The -L option is global.  It does not matter where it is specified in the list
  61 of command line arguments; the directory is simply added to the search path and
  62 is applied to all libraries, preceding or succeeding, in the command line.
  63 </p>
  64
  65 <h4>Link order</h4>
  66
  67 All object files are linked first in the order they were specified on the
  68 command line.  All library files are linked next.  Some libraries may not be
  69 linked into the object program; see below.
  70
  71 <h4>Library Linkage</h4>
  72
  73 Object files and static bytecode objects are always linked into the output
  74 file.  Library archives (.a files) load only the objects within the archive
  75 that define symbols needed by the output file.  Hence, libraries should be
  76 listed after the object files and libraries which need them; otherwise, the
  77 library may not be linked in, and the dependent library will not have its
  78 undefined symbols defined.
  79
  80 <h4>Native code generation</h4>
  81
  82 The <tt>gccld</tt> program has limited support for native code generation, when
  83 using the -native option.
  84
  85
  86 <h3>OPTIONS</h3>
  87
  88 <ul>
  89         <li> -help
  90         <br>
  91         Print a summary of command line options.
  92         <p>
  93
  94         <li> -o &lt;filename&gt;
  95         <br>
  96         Specify the output filename which will hold the linked bytecode.
  97         <p>
  98
  99         <li> -stats
 100         <br>
 101         Print statistics.
 102         <p>
 103
 104         <li> -time-passes
 105         <br>
 106         Record the amount of time needed for each pass and print it to standard
 107         error.
 108         <p>
 109
 110         <li> -verify
 111         <br>
 112         Verify each pass result.
 113         <p>
 114
 115         <li> -disable-opt
 116         <br>
 117     Disable all link-time optimization passes.
 118         <p>
 119
 120         <li> -L=&lt;directory&gt;
 121         <br>
 122         Add directory to the list of directories to search when looking for
 123         libraries.
 124         <p>
 125
 126         <li> -disable-internalize
 127         <br>
 128         Do not mark all symbols as internal.
 129         <p>
 130
 131         <li> -internalize-public-api-file &lt;filename&gt;
 132         <br>
 133         Preserve the list of symbol names in the file filename.
 134         <p>
 135
 136         <li> -internalize-public-api-list &lt;list&gt;
 137         <br>
 138         Preserve the symbol names in list.
 139         <p>
 140
 141         <li> -l=&lt;library&gt;
 142         <br>
 143         Specify libraries to include when linking the output file.  When
 144         linking, <tt>gccld</tt> will first attempt to load a file with the
 145         pathname <tt>library</tt>.  If that fails, it will then attempt to load
 146         lib&lt;library&gt;.bc, lib&lt;library&gt;.a, and
 147   lib&lt;library&gt;.&lt;shared library extension&gt;, in that order.
 148         <p>
 149
 150         <li> -link-as-library
 151         <br>
 152         Link the .bc files together as a library, not an executable.
 153         <p>
 154
 155         <li> -native
 156         <br>
 157         Generate a native, machine code executable.
 158   <p>
 159   When generating native executables, <tt>gccld</tt> first checks for a bytecode
 160   version of the library and links it in, if necessary.  If the library is
 161   missing, <tt>gccld</tt> skips it.  Then, <tt>gccld</tt> links in the same
 162   libraries as native code.
 163   <p>
 164   In this way, <tt>gccld</tt> should be able to link in optimized bytecode
 165   subsets of common libraries and then link in any part of the library that
 166   hasn't been converted to bytecode.
 167         <p>
 168
 169         <li> -s
 170         <br>
 171         Strip symbol information from the generated executable.
 172         <p>
 173
 174         <li> -v
 175         <br>
 176         Print information about actions taken.
 177 </ul>
 178
 179 <h3>EXIT STATUS</h3>
 180
 181 If <tt>gccld</tt> succeeds, it will exit with 0.  Otherwise, if an error occurs,
 182 it will exit with a non-zero value.
 183
 184 <h3>SEE ALSO</h3>
 185 <a href="llvm-link.html"><tt>llvm-link</tt></a>
 186 <a href="gccas.html"><tt>gccas</tt></a>
 187
 188 <h3>BUGS</h3>
 189 The -L option cannot be used for find native code libraries when using the
 190 -native option.
 191
 192 <HR>
 193 Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
 194 </body>
 195 </html>
 196