Packed types, brought to you by Brad Jones
[oota-llvm.git] / docs / FAQ.html
index f4afc266cbcbb34aa113c7267561a199d60a23bf..3c460de89d96e4ff6db951b59585d5881fdae73e 100644 (file)
@@ -3,7 +3,7 @@
 <html>
 <head>
   <title>LLVM: Frequently Asked Questions</title>
-  <style>
+  <style type="text/css">
     @import url("llvm.css");
     .question { font-weight: bold }
     .answer   { margin-left: 2em  }
@@ -49,6 +49,8 @@
   <li>I've built LLVM and am testing it, but the tests freeze.</li>
   <li>Why do test results differ when I perform different types of builds?</li>
   <li>Compiling LLVM with GCC 3.3.2 fails, what should I do?</li>
+  <li>When I use the test suite, all of the C Backend tests fail.  What is
+      wrong?</li>
   </ol></li>
 
   <li><a href="#cfe">Using the GCC Front End</a>
@@ -61,7 +63,7 @@
 
     <li>
     When I compile code using the LLVM GCC front end, it complains that it
-    cannot find crtend.o.
+    cannot find libcrtend.a.
     </li>
   </ol>
   </li>
      <li>What is this <tt>__main()</tt> call that gets inserted into
          <tt>main()</tt>?</li>
      <li>Where did all of my code go??</li>
+     <li>What is this <tt>llvm.global_ctors</tt> and
+          <tt>_GLOBAL__I__tmp_webcompile...</tt> stuff that happens when I
+          #include &lt;iostream&gt;?</li>
   </ol>
   </li>
 </ol>
 
+<div class="doc_author">
+  <p>Written by <a href="http://llvm.cs.uiuc.edu">The LLVM Team</a></p>
+</div>
+
+
 <!-- *********************************************************************** -->
 <div class="doc_section">
   <a name="license">License</a>
@@ -111,7 +121,7 @@ Source Initiative (OSI).</p>
 <div class="answer">
 <p>Yes.  The modified source distribution must retain the copyright notice and
 follow the three bulletted conditions listed in the <a
-href="http://llvm.cs.uiuc.edu/releases/1.0/LICENSE.TXT">LLVM license</a>.</p>
+href="http://llvm.cs.uiuc.edu/releases/1.2/LICENSE.TXT">LLVM license</a>.</p>
 </div>
 
 <div class="question">
@@ -226,7 +236,7 @@ it:</p>
   <li><p>Run <tt>configure</tt> with an alternative <tt>PATH</tt> that is
   correct. In a Borne compatible shell, the syntax would be:</p>
                
-      <p><tt>PATH=<the path without the bad program> ./configure ...</tt></p>
+      <p><tt>PATH=[the path without the bad program] ./configure ...</tt></p>
 
       <p>This is still somewhat inconvenient, but it allows <tt>configure</tt>
       to do its work without having to adjust your <tt>PATH</tt>
@@ -338,6 +348,31 @@ build.</p>
    affects projects other than LLVM.  Try upgrading or downgrading your GCC.</p>
 </div>
 
+<div class="question">
+<p>
+When I use the test suite, all of the C Backend tests fail.  What is
+wrong?
+</p>
+</div>
+
+<div class="answer">
+<p>
+If you build LLVM and the C Backend tests fail in <tt>llvm/test/Programs</tt>,
+then chances are good that the directory pointed to by the LLVM_LIB_SEARCH_PATH
+environment variable does not contain the libcrtend.a library.
+</p>
+
+<p>
+To fix it, verify that LLVM_LIB_SEARCH_PATH points to the correct directory
+and that libcrtend.a is inside.  For pre-built LLVM GCC front ends, this
+should be the absolute path to
+<tt>cfrontend/&lt;<i>platform</i>&gt;/llvm-gcc/bytecode-libs</tt>.  If you've
+built your own LLVM GCC front end, then ensure that you've built and installed
+the libraries in <tt>llvm/runtime</tt> and have LLVM_LIB_SEARCH_PATH pointing
+to the <tt>LLVMGCCDIR/bytecode-libs</tt> subdirectory.
+</p>
+</div>
+
 <!-- *********************************************************************** -->
 <div class="doc_section">
   <a name="cfe">Using the GCC Front End</a>
@@ -388,13 +423,13 @@ not linking on your system because the feature isn't available on your system.
 <div class="question">
 <p>
 When I compile code using the LLVM GCC front end, it complains that it cannot
-find crtend.o.
+find libcrtend.a.
 </p>
 </div>
 
 <div class="answer">
 <p>
-In order to find crtend.o, you must have the directory in which it lives in
+In order to find libcrtend.a, you must have the directory in which it lives in
 your LLVM_LIB_SEARCH_PATH environment variable.  For the binary distribution of
 the LLVM GCC front end, this will be the full path of the bytecode-libs
 directory inside of the LLVM GCC distribution.
@@ -437,7 +472,7 @@ Where did all of my code go??
 <p>
 If you are using the LLVM demo page, you may often wonder what happened to all
 of the code that you typed in.  Remember that the demo script is running the
-code through the LLVM optimizers, so if you code doesn't actually do anything
+code through the LLVM optimizers, so if your code doesn't actually do anything
 useful, it might all be deleted.
 </p>
 
@@ -449,15 +484,50 @@ you can read from and assign to <tt>volatile</tt> global variables.
 </p>
 </div>
 
-<!-- *********************************************************************** -->
+<!--=========================================================================-->
+
+<div class="question"><p>
+What is this <tt>llvm.global_ctors</tt> and <tt>_GLOBAL__I__tmp_webcompile...</tt> stuff that happens when I #include &lt;iostream&gt;?
+</p></div>
+
+<div class="answer">
+<p>
+If you #include the &lt;iostream&gt; header into a C++ translation unit, the
+file will probably use the <tt>std::cin</tt>/<tt>std::cout</tt>/... global
+objects.  However, C++ does not guarantee an order of initialization between
+static objects in different translation units, so if a static ctor/dtor in your
+.cpp file used <tt>std::cout</tt>, for example, the object would not necessarily
+be automatically initialized before your use.
+</p>
+
+<p>
+To make <tt>std::cout</tt> and friends work correctly in these scenarios, the
+STL that we use declares a static object that gets created in every translation
+unit that includes &lt;iostream&gt;.  This object has a static constructor and
+destructor that initializes and destroys the global iostream objects before they
+could possibly be used in the file.  The code that you see in the .ll file
+corresponds to the constructor and destructor registration code.
+</p>
+
+<p>
+If you would like to make it easier to <b>understand</b> the LLVM code generated
+by the compiler in the demo page, consider using printf instead of iostreams to
+print values.
+</p>
+</div>
+
 <!-- *********************************************************************** -->
 
 <hr>
-<div class="doc_footer">
-  <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
-  <br>
+<address>
+  <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
+  src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
+  <a href="http://validator.w3.org/check/referer"><img
+  src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
+
+  <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
   Last modified: $Date$
-</div>
+</address>
 
 </body>
 </html>