docs/FAQ.html

   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: Frequently Asked Questions</title>
   6   <style type="text/css">
   7     @import url("llvm.css");
   8     .question { font-weight: bold }
   9     .answer   { margin-left: 2em  }
  10   </style>
  11 </head>
  12 <body>
  13
  14 <div class="doc_title">
  15   LLVM: Frequently Asked Questions
  16 </div>
  17
  18 <ol>
  19   <li><a href="#license">License</a>
  20   <ol>
  21   <li>Why are the LLVM source code and the front-end distributed under different
  22   licenses?</li>
  23   <li>Does the University of Illinois Open Source License really qualify as an
  24   "open source" license?</li>
  25   <li>Can I modify LLVM source code and redistribute the modified source?</li>
  26   <li>Can I modify LLVM source code and redistribute binaries or other tools
  27   based on it, without redistributing the source?</li>
  28   </ol></li>
  29
  30   <li><a href="#source">Source code</a>
  31   <ol>
  32   <li>In what language is LLVM written?</li>
  33   <li>How portable is the LLVM source code?</li>
  34   </ol></li>
  35
  36   <li><a href="#build">Build Problems</a>
  37   <ol>
  38   <li>When I run configure, it finds the wrong C compiler.</li>
  39   <li>I compile the code, and I get some error about <tt>/localhome</tt>.</li>
  40   <li>The <tt>configure</tt> script finds the right C compiler, but it uses the
  41   LLVM linker from a previous build.  What do I do?</li>
  42   <li>When creating a dynamic library, I get a strange GLIBC error.</li>
  43   <li>I've updated my source tree from CVS, and now my build is trying to use a
  44   file/directory that doesn't exist.</li>
  45   <li>I've modified a Makefile in my source tree, but my build tree keeps using
  46   the old version.  What do I do?</li>
  47   <li>I've upgraded to a new version of LLVM, and I get strange build
  48   errors.</li>
  49   <li>I've built LLVM and am testing it, but the tests freeze.</li>
  50   <li>Why do test results differ when I perform different types of builds?</li>
  51   <li>Compiling LLVM with GCC 3.3.2 fails, what should I do?</li>
  52   <li>When I use the test suite, all of the C Backend tests fail.  What is
  53       wrong?</li>
  54   <li>After CVS update, rebuilding gives the error "No rule to make
  55   target".</li>
  56   </ol></li>
  57
  58   <li><a href="#cfe">Using the GCC Front End</a>
  59   <ol>
  60     <li>
  61     When I compile software that uses a configure script, the configure script
  62     thinks my system has all of the header files and libraries it is testing
  63     for.  How do I get configure to work correctly?
  64     </li>
  65
  66     <li>
  67     When I compile code using the LLVM GCC front end, it complains that it
  68     cannot find libcrtend.a.
  69     </li>
  70   </ol>
  71   </li>
  72
  73   <li><a href="#cfe_code">Questions about code generated by the GCC front-end</a>
  74   <ol>
  75      <li>What is this <tt>__main()</tt> call that gets inserted into
  76          <tt>main()</tt>?</li>
  77      <li>Where did all of my code go??</li>
  78      <li>What is this <tt>llvm.global_ctors</tt> and
  79           <tt>_GLOBAL__I__tmp_webcompile...</tt> stuff that happens when I
  80           #include &lt;iostream&gt;?</li>
  81   </ol>
  82   </li>
  83 </ol>
  84
  85 <div class="doc_author">
  86   <p>Written by <a href="http://llvm.cs.uiuc.edu">The LLVM Team</a></p>
  87 </div>
  88
  89
  90 <!-- *********************************************************************** -->
  91 <div class="doc_section">
  92   <a name="license">License</a>
  93 </div>
  94 <!-- *********************************************************************** -->
  95
  96 <div class="question">
  97 <p>Why are the LLVM source code and the front-end distributed under different
  98 licenses?</p>
  99 </div>
 100
 101 <div class="answer">
 102 <p>The C/C++ front-ends are based on GCC and must be distributed under the GPL.
 103 Our aim is to distribute LLVM source code under a <em>much less restrictive</em>
 104 license, in particular one that does not compel users who distribute tools based
 105 on modifying the source to redistribute the modified source code as well.</p>
 106 </div>
 107
 108 <div class="question">
 109 <p>Does the University of Illinois Open Source License really qualify as an
 110 "open source" license?</p>
 111 </div>
 112
 113 <div class="answer">
 114 <p>Yes, the license is <a
 115 href="http://www.opensource.org/licenses/UoI-NCSA.php">certified</a> by the Open
 116 Source Initiative (OSI).</p>
 117 </div>
 118
 119 <div class="question">
 120 <p>Can I modify LLVM source code and redistribute the modified source?</p>
 121 </div>
 122
 123 <div class="answer">
 124 <p>Yes.  The modified source distribution must retain the copyright notice and
 125 follow the three bulletted conditions listed in the <a
 126 href="http://llvm.cs.uiuc.edu/releases/1.3/LICENSE.TXT">LLVM license</a>.</p>
 127 </div>
 128
 129 <div class="question">
 130 <p>Can I modify LLVM source code and redistribute binaries or other tools based
 131 on it, without redistributing the source?</p>
 132 </div>
 133
 134 <div class="answer">
 135 <p>Yes, this is why we distribute LLVM under a less restrictive license than
 136 GPL, as explained in the first question above.</p>
 137 </div>
 138
 139 <!-- *********************************************************************** -->
 140 <div class="doc_section">
 141   <a name="source">Source Code</a>
 142 </div>
 143 <!-- *********************************************************************** -->
 144
 145 <div class="question">
 146 <p>In what language is LLVM written?</p>
 147 </div>
 148
 149 <div class="answer">
 150 <p>All of the LLVM tools and libraries are written in C++ with extensive use of
 151 the STL.</p>
 152 </div>
 153
 154 <div class="question">
 155 <p>How portable is the LLVM source code?</p>
 156 </div>
 157
 158 <div class="answer">
 159 <p>The LLVM source code should be portable to most modern UNIX-like operating
 160 systems.  Most of the code is written in standard C++ with operating system
 161 services abstracted to a support library.  The tools required to build and test
 162 LLVM have been ported to a plethora of platforms.</p>
 163
 164 <p>Some porting problems may exist in the following areas:</p>
 165
 166 <ul>
 167
 168   <li>The GCC front end code is not as portable as the LLVM suite, so it may not
 169   compile as well on unsupported platforms.</li>
 170
 171   <li>The LLVM build system relies heavily on UNIX shell tools, like the Bourne
 172   Shell and sed.  Porting to systems without these tools (MacOS 9, Plan 9) will
 173   require more effort.</li>
 174
 175 </ul>
 176
 177 </div>
 178
 179 <!-- *********************************************************************** -->
 180 <div class="doc_section">
 181   <a name="build">Build Problems</a>
 182 </div>
 183 <!-- *********************************************************************** -->
 184
 185 <div class="question">
 186 <p>When I run configure, it finds the wrong C compiler.</p>
 187 </div>
 188
 189 <div class="answer">
 190
 191 <p>The <tt>configure</tt> script attempts to locate first <tt>gcc</tt> and then
 192 <tt>cc</tt>, unless it finds compiler paths set in <tt>CC</tt> and <tt>CXX</tt>
 193 for the C and C++ compiler, respectively.</p>
 194
 195 <p>If <tt>configure</tt> finds the wrong compiler, either adjust your
 196 <tt>PATH</tt> environment variable or set <tt>CC</tt> and <tt>CXX</tt>
 197 explicitly.</p>
 198
 199 </div>
 200
 201 <div class="question">
 202 <p>I compile the code, and I get some error about <tt>/localhome</tt>.</p>
 203 </div>
 204
 205 <div class="answer">
 206
 207 <p>There are several possible causes for this.  The first is that you didn't set
 208 a pathname properly when using <tt>configure</tt>, and it defaulted to a
 209 pathname that we use on our research machines.</p>
 210
 211 <p>Another possibility is that we hardcoded a path in our Makefiles.  If you see
 212 this, please email the LLVM bug mailing list with the name of the offending
 213 Makefile and a description of what is wrong with it.</p>
 214
 215 </div>
 216
 217 <div class="question">
 218 <p>The <tt>configure</tt> script finds the right C compiler, but it uses the
 219 LLVM linker from a previous build.  What do I do?</p>
 220 </div>
 221
 222 <div class="answer">
 223 <p>The <tt>configure</tt> script uses the <tt>PATH</tt> to find executables, so
 224 if it's grabbing the wrong linker/assembler/etc, there are two ways to fix
 225 it:</p>
 226
 227 <ol>
 228
 229   <li><p>Adjust your <tt>PATH</tt> environment variable so that the correct
 230   program appears first in the <tt>PATH</tt>.  This may work, but may not be
 231   convenient when you want them <i>first</i> in your path for other
 232   work.</p></li>
 233
 234   <li><p>Run <tt>configure</tt> with an alternative <tt>PATH</tt> that is
 235   correct. In a Borne compatible shell, the syntax would be:</p>
 236
 237       <p><tt>PATH=[the path without the bad program] ./configure ...</tt></p>
 238
 239       <p>This is still somewhat inconvenient, but it allows <tt>configure</tt>
 240       to do its work without having to adjust your <tt>PATH</tt>
 241       permanently.</p></li>
 242
 243 </ol>
 244
 245 </div>
 246
 247 <div class="question">
 248 <p>When creating a dynamic library, I get a strange GLIBC error.</p>
 249 </div>
 250
 251 <div class="answer">
 252 <p>Under some operating systems (i.e. Linux), libtool does not work correctly if
 253 GCC was compiled with the --disable-shared option.  To work around this, install
 254 your own version of GCC that has shared libraries enabled by default.</p>
 255 </div>
 256
 257 <div class="question">
 258 <p>I've updated my source tree from CVS, and now my build is trying to use a
 259 file/directory that doesn't exist.</p>
 260 </div>
 261
 262 <div class="answer">
 263 <p>You need to re-run configure in your object directory.  When new Makefiles
 264 are added to the source tree, they have to be copied over to the object tree in
 265 order to be used by the build.</p>
 266 </div>
 267
 268 <div class="question">
 269 <p>I've modified a Makefile in my source tree, but my build tree keeps using the
 270 old version.  What do I do?</p>
 271 </div>
 272
 273 <div class="answer">
 274
 275 <p>If the Makefile already exists in your object tree, you
 276 can just run the following command in the top level directory of your object
 277 tree:</p>
 278
 279 <p><tt>./config.status &lt;relative path to Makefile&gt;</tt><p>
 280
 281 <p>If the Makefile is new, you will have to modify the configure script to copy
 282 it over.</p>
 283
 284 </div>
 285
 286 <div class="question">
 287 <p>I've upgraded to a new version of LLVM, and I get strange build errors.</p>
 288 </div>
 289
 290 <div class="answer">
 291
 292 <p>Sometimes, changes to the LLVM source code alters how the build system works.
 293 Changes in libtool, autoconf, or header file dependencies are especially prone
 294 to this sort of problem.</p>
 295
 296 <p>The best thing to try is to remove the old files and re-build.  In most
 297 cases, this takes care of the problem.  To do this, just type <tt>make
 298 clean</tt> and then <tt>make</tt> in the directory that fails to build.</p>
 299
 300 </div>
 301
 302 <div class="question">
 303 <p>I've built LLVM and am testing it, but the tests freeze.</p>
 304 </div>
 305
 306 <div class="answer">
 307
 308 <p>This is most likely occurring because you built a profile or release
 309 (optimized) build of LLVM and have not specified the same information on the
 310 <tt>gmake</tt> command line.</p>
 311
 312 <p>For example, if you built LLVM with the command:</p>
 313
 314 <p><tt>gmake ENABLE_PROFILING=1</tt>
 315
 316 <p>...then you must run the tests with the following commands:</p>
 317
 318 <p><tt>cd llvm/test<br>gmake  ENABLE_PROFILING=1</tt></p>
 319
 320 </div>
 321
 322 <div class="question">
 323 <p>Why do test results differ when I perform different types of builds?</p>
 324 </div>
 325
 326 <div class="answer">
 327
 328 <p>The LLVM test suite is dependent upon several features of the LLVM tools and
 329 libraries.</p>
 330
 331 <p>First, the debugging assertions in code are not enabled in optimized or
 332 profiling builds.  Hence, tests that used to fail may pass.</p>
 333
 334 <p>Second, some tests may rely upon debugging options or behavior that is only
 335 available in the debug build.  These tests will fail in an optimized or profile
 336 build.</p>
 337
 338 </div>
 339
 340 <div class="question">
 341 <p>Compiling LLVM with GCC 3.3.2 fails, what should I do?</p>
 342 </div>
 343
 344 <div class="answer">
 345 <p>This is <a href="http://gcc.gnu.org/PR?13392">a bug in GCC</a>, and
 346    affects projects other than LLVM.  Try upgrading or downgrading your GCC.</p>
 347 </div>
 348
 349 <div class="question">
 350 <p>After CVS update, rebuilding gives the error "No rule to make target".</p>
 351 </div>
 352
 353 <div class="answer">
 354 <p>If the error is of the form:</p>
 355
 356 <div class="doc_code">
 357 <tt>
 358 gmake[2]: *** No rule to make target `/path/to/somefile', needed by
 359 `/path/to/another/file.d'.<br>
 360 Stop.
 361 </tt>
 362 </div>
 363
 364 <p>This may occur anytime files are moved within the CVS repository or removed
 365 entirely.  In this case, the best solution is to erase all <tt>.d</tt> files,
 366 which list dependencies for source files, and rebuild:</p>
 367
 368 <div class="doc_code">
 369 <pre>
 370 % cd $LLVM_OBJ_DIR
 371 % rm -f `find . -name \*\.d`
 372 % gmake
 373 </pre>
 374 </div>
 375
 376 <p>In other cases, it may be necessary to run <tt>make clean</tt> before
 377 rebuilding.</p>
 378 </div>
 379
 380 <!-- *********************************************************************** -->
 381 <div class="doc_section">
 382   <a name="cfe">Using the GCC Front End</a>
 383 </div>
 384
 385 <div class="question">
 386 <p>
 387 When I compile software that uses a configure script, the configure script
 388 thinks my system has all of the header files and libraries it is testing for.
 389 How do I get configure to work correctly?
 390 </p>
 391 </div>
 392
 393 <div class="answer">
 394 <p>
 395 The configure script is getting things wrong because the LLVM linker allows
 396 symbols to be undefined at link time (so that they can be resolved during JIT
 397 or translation to the C back end).  That is why configure thinks your system
 398 "has everything."
 399 </p>
 400 <p>
 401 To work around this, perform the following steps:
 402 </p>
 403
 404 <ol>
 405   <li>
 406   Make sure the CC and CXX environment variables contains the full path to the
 407   LLVM GCC front end.
 408   </li>
 409
 410   <li>
 411   Make sure that the regular C compiler is first in your PATH.
 412   </li>
 413
 414   <li>
 415   Add the string "-Wl,-native" to your CFLAGS environment variable.
 416   </li>
 417 </ol>
 418
 419 <p>
 420 This will allow the gccld linker to create a native code executable instead of
 421 a shell script that runs the JIT.  Creating native code requires standard
 422 linkage, which in turn will allow the configure script to find out if code is
 423 not linking on your system because the feature isn't available on your system.
 424 </p>
 425 </div>
 426
 427 <div class="question">
 428 <p>
 429 When I compile code using the LLVM GCC front end, it complains that it cannot
 430 find libcrtend.a.
 431 </p>
 432 </div>
 433
 434 <div class="answer">
 435 <p>
 436 The only way this can happen is if you haven't installed the runtime library. To
 437 correct this, do:</p>
 438 <pre>
 439   % cd llvm/runtime
 440   % make clean ; make install-bytecode
 441 </pre>
 442 </div>
 443
 444
 445 <!-- *********************************************************************** -->
 446 <div class="doc_section">
 447   <a name="cfe_code">Questions about code generated by the GCC front-end</a>
 448 </div>
 449
 450 <div class="question"><p>
 451 What is this <tt>__main()</tt> call that gets inserted into <tt>main()</tt>?
 452 </p></div>
 453
 454 <div class="answer">
 455 <p>
 456 The <tt>__main</tt> call is inserted by the C/C++ compiler in order to guarantee
 457 that static constructors and destructors are called when the program starts up
 458 and shuts down.  In C, you can create static constructors and destructors by
 459 using GCC extensions, and in C++ you can do so by creating a global variable
 460 whose class has a ctor or dtor.
 461 </p>
 462
 463 <p>
 464 The actual implementation of <tt>__main</tt> lives in the
 465 <tt>llvm/runtime/GCCLibraries/crtend/</tt> directory in the source-base, and is
 466 linked in automatically when you link the program.
 467 </p>
 468 </div>
 469
 470 <!--=========================================================================-->
 471
 472 <div class="question"><p>
 473 Where did all of my code go??
 474 </p></div>
 475
 476 <div class="answer">
 477 <p>
 478 If you are using the LLVM demo page, you may often wonder what happened to all
 479 of the code that you typed in.  Remember that the demo script is running the
 480 code through the LLVM optimizers, so if your code doesn't actually do anything
 481 useful, it might all be deleted.
 482 </p>
 483
 484 <p>
 485 To prevent this, make sure that the code is actually needed.  For example, if
 486 you are computing some expression, return the value from the function instead of
 487 leaving it in a local variable.  If you really want to constrain the optimizer,
 488 you can read from and assign to <tt>volatile</tt> global variables.
 489 </p>
 490 </div>
 491
 492 <!--=========================================================================-->
 493
 494 <div class="question">
 495 <p> What is this <tt>llvm.global_ctors</tt> and
 496 <tt>_GLOBAL__I__tmp_webcompile...</tt> stuff that happens when I #include
 497 &lt;iostream&gt;?</p>
 498 </div>
 499
 500 <div class="answer">
 501
 502 <p>If you #include the &lt;iostream&gt; header into a C++ translation unit, the
 503 file will probably use the <tt>std::cin</tt>/<tt>std::cout</tt>/... global
 504 objects.  However, C++ does not guarantee an order of initialization between
 505 static objects in different translation units, so if a static ctor/dtor in your
 506 .cpp file used <tt>std::cout</tt>, for example, the object would not necessarily
 507 be automatically initialized before your use.</p>
 508
 509 <p>To make <tt>std::cout</tt> and friends work correctly in these scenarios, the
 510 STL that we use declares a static object that gets created in every translation
 511 unit that includes <tt>&lt;iostream&gt;</tt>.  This object has a static
 512 constructor and destructor that initializes and destroys the global iostream
 513 objects before they could possibly be used in the file.  The code that you see
 514 in the .ll file corresponds to the constructor and destructor registration code.
 515 </p>
 516
 517 <p>If you would like to make it easier to <b>understand</b> the LLVM code
 518 generated by the compiler in the demo page, consider using <tt>printf()</tt>
 519 instead of <tt>iostream</tt>s to print values.</p>
 520
 521 </div>
 522
 523 <!-- *********************************************************************** -->
 524
 525 <hr>
 526 <address>
 527   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 528   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 529   <a href="http://validator.w3.org/check/referer"><img
 530   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 531
 532   <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
 533   Last modified: $Date$
 534 </address>
 535
 536 </body>
 537 </html>