docs/index.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>Documentation for the LLVM System</title>
   6   <link rel="stylesheet" href="llvm.css" type="text/css">
   7 </head>
   8 <body>
   9
  10 <div class="doc_title">Documentation for the LLVM System</div>
  11
  12 <div class="doc_text">
  13 <table class="layout" width="95%"><tr class="layout"><td class="left">
  14 <ul>
  15   <li><a href="#llvmdesign">LLVM Design</a></li>
  16   <li><a href="#llvmpubs">LLVM Publications</a></li>
  17   <li><a href="#userguide">LLVM User Guides</a></li>
  18   <li><a href="#llvmprog">General LLVM Programming Documentation</a></li>
  19   <li><a href="#subsystems">LLVM Subsystem Documentation</a></li>
  20   <li><a href="#maillist">LLVM Mailing Lists</a></li>
  21 </ul>
  22 </td><td class="right">
  23   <form action="http://www.google.com/search" method=get>
  24       <input type="hidden" name="sitesearch" value="llvm.org/docs">
  25       <input type=text name=q size=25><br>
  26       <input type=submit value="Search the LLVM Docs" name="submit">
  27   </form>
  28 </td></tr></table>
  29 </div>
  30
  31 <div class="doc_author">
  32   <p>Written by <a href="http://llvm.org">The LLVM Team</a></p>
  33 </div>
  34
  35 <!--=======================================================================-->
  36 <div class="doc_section"><a name="llvmdesign">LLVM Design</a></div>
  37 <!--=======================================================================-->
  38
  39 <ul>
  40 <li><a href="http://llvm.org/pubs/2004-01-30-CGO-LLVM.html">LLVM: A
  41 Compilation Framework for Lifelong Program Analysis &amp; Transformation</a>: -
  42 Describes the LLVM instruction set and compilation strategy.  This should be the
  43 first document you read to get an overview of LLVM.</li>
  44
  45 <li><a href="LangRef.html">LLVM Reference Manual</a> - Defines the LLVM
  46 intermediate representation, the assembly form of the different nodes, and
  47 provides reference information about the different tools in LLVM.</li>
  48
  49 <li><a href="BytecodeFormat.html">LLVM Bytecode File Format</a></li>
  50
  51 </ul>
  52
  53 <!--=======================================================================-->
  54 <div class="doc_section"><a name="llvmpubs">LLVM Publications</a></div>
  55 <!--=======================================================================-->
  56
  57 <ul>
  58 <li>"<a href="2006-04-25-GelatoLLVMIntro.html">Introduction to the LLVM Compiler Infrastructure</a>"<br>Chris Lattner<br>
  59   <i>2006 Itanium Conference and Expo</i>, San Jose, California, April 2006.</li>
  60
  61
  62 <li>"<a href="2004-09-22-LCPCLLVMTutorial.html">The LLVM Compiler Framework and
  63 Infrastructure Tutorial</a>"<br> Chris Lattner and Vikram Adve<br>
  64 <i>LCPC'04 Mini Workshop on Compiler Research Infrastructures</i>, West Lafayette, Indiana, Sep. 2004.</li>
  65
  66 <li>"<a href="2004-01-30-CGO-LLVM.html">LLVM: A Compilation Framework for
  67 Lifelong Program Analysis &amp; Transformation</a>"<br> Chris Lattner and Vikram
  68 Adve<br>  <i>Proc. of the 2004 International Symposium
  69 on Code Generation and Optimization (CGO'04)</i>, Palo Alto, California, Mar.
  70 2004.</li>
  71
  72 <li>"<a href="2003-10-01-LLVA.html">LLVA: A Low-level Virtual Instruction Set
  73 Architecture</a>"<br> Vikram Adve, Chris Lattner, Michael Brukman, Anand Shukla,
  74 and Brian Gaeke<br>  <i>Proc. of the
  75 36th annual ACM/IEEE international symposium on Microarchitecture
  76 (MICRO-36)</i>, San Diego, CA, December 2003.</li>
  77
  78 <li>"<a href="2003-05-01-GCCSummit2003.html">Architecture For a Next-Generation
  79 GCC</a>"<br> Chris Lattner &amp; Vikram Adve<br> <i>First Annual GCC Developers'
  80 Summit</i>, Ottawa, Canada, May 2003.<br> </li>
  81
  82 <li>"<a href="2002-12-LattnerMSThesis.html">LLVM: An Infrastructure for
  83 Multi-Stage Optimization</a>"<br> Chris Lattner<br> <i>Masters Thesis</i>,
  84 Computer Science Dept., University of Illinois at Urbana-Champaign,
  85 Dec. 2002</li>
  86 </ul>
  87
  88 <!--=======================================================================-->
  89 <div class="doc_section"><a name="userguide">LLVM User Guides</a></div>
  90 <!--=======================================================================-->
  91
  92 <ul>
  93 <li><a href="GettingStarted.html">The LLVM Getting Started Guide</a> -
  94 Discusses how to get up and running quickly with the LLVM infrastructure.
  95 Everything from unpacking and compilation of the distribution to execution of
  96 some tools.</li>
  97
  98 <li><a href="GettingStartedVS.html">Getting Started with the LLVM System using
  99 Microsoft Visual Studio</a> - An addendum to the main Getting Started guide for
 100 those using Visual Studio on Windows.</li>
 101
 102 <li><a href="CommandGuide/index.html">LLVM Command Guide</a> - A reference
 103 manual for the LLVM command line utilities ("man" pages for LLVM tools).<br/>
 104 Current tools:
 105  <a href="CommandGuide/html/llvm-ar.html">llvm-ar</a>,
 106  <a href="CommandGuide/html/llvm-ranlib.html">llvm-ranlib</a>,
 107  <a href="CommandGuide/html/llvm-as.html">llvm-as</a>,
 108  <a href="CommandGuide/html/llvm-dis.html">llvm-dis</a>,
 109  <a href="CommandGuide/html/opt.html">opt</a>,
 110  <a href="CommandGuide/html/llc.html">llc</a>,
 111  <a href="CommandGuide/html/lli.html">lli</a>,
 112  <a href="CommandGuide/html/llvm-link.html">llvm-link</a>,
 113  <a href="CommandGuide/html/analyze.html">analyze</a>,
 114  <a href="CommandGuide/html/llvm-nm.html">llvm-nm</a>,
 115  <a href="CommandGuide/html/llvm-prof.html">llvm-prof</a>,
 116  <a href="CommandGuide/html/llvmgcc.html">llvmgcc</a>,
 117  <a href="CommandGuide/html/llvmgxx.html">llvmgxx</a>,
 118  <a href="CommandGuide/html/gccas.html">gccas</a>,
 119  <a href="CommandGuide/html/gccld.html">gccld</a>,
 120  <a href="CommandGuide/html/stkrc.html">stkrc</a>,
 121  <a href="CommandGuide/html/bugpoint.html">bugpoint</a>,
 122  <a href="CommandGuide/html/llvm-extract.html">llvm-extract</a>,
 123  <a href="CommandGuide/html/llvm-bcanalyzer.html">llvm-bcanalyzer</a>,
 124  <a href="CommandGuide/html/llvmc.html">llvmc</a>
 125 </li>
 126
 127 <li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
 128 questions and problems and their solutions.</li>
 129
 130 <li><a href="ReleaseNotes.html">Release notes for the current release</a>
 131 - This describes new features, known bugs, and other limitations.</li>
 132
 133 <li><a href="HowToSubmitABug.html">How to Submit A Bug Report</a> -
 134 Instructions for properly submitting information about any bugs you run into in
 135 the LLVM system.</li>
 136
 137 <li><a href="TestingGuide.html">LLVM Test Suite Guide</a> - A reference
 138 manual for using the LLVM test suite.</li>
 139
 140 <li><a href="CFEBuildInstrs.html">How to build the C/C++ front-end</a> -
 141 Instructions for building the front-end from source.</li>
 142
 143 <li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
 144 and concepts used in LLVM.</li>
 145
 146 <li><a name="irc">You can probably find help on the unofficial LLVM IRC
 147 channel</a>.  We often are on irc.oftc.net in the #llvm channel.  If you are
 148 using the mozilla browser, and have chatzilla installed, you can <a
 149 href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net</a> directly.</li>
 150
 151 </ul>
 152
 153
 154 <!--=======================================================================-->
 155 <div class="doc_section"><a name="llvmprog">General LLVM Programming Documentation</a></div>
 156 <!--=======================================================================-->
 157
 158 <ul>
 159 <li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
 160 Introduction to the general layout of the LLVM sourcebase, important classes
 161 and APIs, and some tips &amp; tricks.</li>
 162
 163 <li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
 164 templates for new projects that <em>use</em> the LLVM infrastructure.  The
 165 templates (directory organization, Makefiles, and test tree) allow the project
 166 code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
 167 header files and libraries.</li>
 168
 169 <li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
 170 LLVM makefiles work and how to use them.</li>
 171
 172 <li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
 173 Provides information on using the command line parsing library.</li>
 174
 175 <li><a href="CodingStandards.html">LLVM Coding standards</a> -
 176 Details the LLVM coding standards and provides useful information on writing
 177 efficient C++ code.</li>
 178
 179 <li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
 180 to add instructions and intrinsics to LLVM.</li>
 181
 182 <li><a href="UsingLibraries.html">Using LLVM Libraries</a> - Look here to
 183 understand how to use the libraries produced when LLVM is compiled.</li>
 184
 185 <li><a href="HowToReleaseLLVM.html">How To Release LLVM To The Public</a> - This
 186 is a guide to preparing LLVM releases. Most developers can ignore it.</li>
 187
 188 <li><a href="http://llvm.org/doxygen/">Doxygen generated
 189 documentation</a> (<a
 190 href="http://llvm.org/doxygen/inherits.html">classes</a>)
 191
 192 (<a href="http://llvm.org/doxygen/doxygen.tar.gz">tarball</a>)
 193 </li>
 194
 195 <li><a href="http://llvm.org/cvsweb/cvsweb.cgi/llvm">CVSWeb CVS Tree
 196 Browser</a></li>
 197
 198 </ul>
 199
 200 <!--=======================================================================-->
 201 <div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div>
 202 <!--=======================================================================-->
 203
 204 <ul>
 205
 206 <li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
 207 on how to write LLVM transformations and analyses.</li>
 208
 209 <li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
 210 on how to write LLVM backends for machine targets.</li>
 211
 212 <li><a href="CodeGenerator.html">The LLVM Target-Independent Code
 213 Generator</a> - The design and implementation of the LLVM code generator.
 214 Useful if you are working on retargetting LLVM to a new architecture, designing
 215 a new codegen pass, or enhancing existing components.</li>
 216
 217 <li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
 218 Describes the TableGen tool, which is used heavily by the LLVM code
 219 generator.</li>
 220
 221 <li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
 222 on how to write a new alias analysis implementation or how to use existing
 223 analyses.</li>
 224
 225 <li><a href="Stacker.html">The Stacker Chronicles</a> - This document
 226 describes both the Stacker language and LLVM frontend, but also some details
 227 about LLVM useful for those writing front-ends.</li>
 228
 229 <li><a href="GarbageCollection.html">Accurate Garbage Collection with
 230 LLVM</a> - The interfaces source-language compilers should use for compiling
 231 GC'd programs.</li>
 232
 233 <li><a href="SourceLevelDebugging.html">Source Level Debugging with
 234 LLVM</a> - This document describes the design and philosophy behind the LLVM
 235 source-level debugger.</li>
 236
 237 <li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
 238 reducer description and usage information.</li>
 239
 240 <li><a href="CompilerDriver.html">Compiler Driver (llvmc)</a> - This document
 241 describes the design and configuration of the LLVM compiler driver tool,
 242 <tt>llvmc</tt>.</li>
 243
 244 <li><a href="SystemLibrary.html">System Library</a> - This document describes
 245 the LLVM System Library (<tt>lib/System</tt>) and how to keep LLVM source code
 246 portable</li>
 247
 248 </ul>
 249
 250
 251 <!--=======================================================================-->
 252 <div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div>
 253 <!--=======================================================================-->
 254
 255 <ul>
 256 <li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
 257 LLVM Announcements List</a>: This is a low volume list that provides important
 258 announcements regarding LLVM.  It gets email about once a month.</li>
 259
 260 <li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
 261 List</a>: This list is for people who want to be included in technical
 262 discussions of LLVM. People post to this list when they have questions about
 263 writing code for or using the LLVM tools. It is relatively low volume.</li>
 264
 265 <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &amp;
 266 Patches Archive</a>: This list gets emailed every time a bug is opened and
 267 closed, and when people submit patches to be included in LLVM.  It is higher
 268 volume than the LLVMdev list.</li>
 269
 270 <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-commits/">CVS Commits
 271 Archive</a>: This list contains all commit messages that are made when LLVM
 272 developers commit code changes to the CVS archive. It is useful for those who
 273 want to stay on the bleeding edge of LLVM development. This list is very high
 274 volume.</li>
 275
 276 <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-testresults/">
 277 Test Results Archive</a>: A message is automatically sent to this list by every
 278 active nightly tester when it completes.  As such, this list gets email several
 279 times each day, making it a high volume list.</li>
 280
 281 </ul>
 282
 283 <!-- *********************************************************************** -->
 284
 285 <hr>
 286 <address>
 287   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 288   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 289   <a href="http://validator.w3.org/check/referer"><img
 290   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 291
 292   <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
 293   Last modified: $Date$
 294 </address>
 295