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="/pubs/">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     <p>
  25       <input type="hidden" name="sitesearch" value="llvm.org/docs">
  26       <input type=text name=q size=25><br>
  27       <input type=submit value="Search the LLVM Docs" name="submit">
  28     </p>
  29   </form>
  30 </td></tr></table>
  31 </div>
  32
  33 <div class="doc_author">
  34   <p>Written by <a href="http://llvm.org">The LLVM Team</a></p>
  35 </div>
  36
  37 <!--=======================================================================-->
  38 <div class="doc_section"><a name="llvmdesign">LLVM Design &amp; Overview</a></div>
  39 <!--=======================================================================-->
  40
  41 <ul>
  42 <li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
  43 intermediate representation.</li>
  44 <li><a href="http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html">Introduction to the LLVM Compiler </a> - Presentation describing LLVM.</li>
  45 <li><a href="http://llvm.org/pubs/2004-09-22-LCPCLLVMTutorial.html">The LLVM Compiler Framework and
  46 Infrastructure Tutorial</a> - Tutorial for writing passes, exploring the system.</li>
  47 <li><a href="http://llvm.org/pubs/2004-01-30-CGO-LLVM.html">LLVM: A Compilation Framework for
  48 Lifelong Program Analysis &amp; Transformation</a> - Design overview.</li>
  49 <li><a href="http://llvm.org/pubs/2002-12-LattnerMSThesis.html">LLVM: An Infrastructure for
  50 Multi-Stage Optimization</a> - More details (quite old now).</li>
  51 <li><a href="GetElementPtr.html">GetElementPtr FAQ</a> - Answers to some very
  52 frequent questions about LLVM's most frequently misunderstood instruction.</li>
  53 </ul>
  54
  55 <!--=======================================================================-->
  56 <div class="doc_section"><a name="userguide">LLVM User Guides</a></div>
  57 <!--=======================================================================-->
  58
  59 <ul>
  60 <li><a href="GettingStarted.html">The LLVM Getting Started Guide</a> -
  61 Discusses how to get up and running quickly with the LLVM infrastructure.
  62 Everything from unpacking and compilation of the distribution to execution of
  63 some tools.</li>
  64
  65 <li><a href="GettingStartedVS.html">Getting Started with the LLVM System using
  66 Microsoft Visual Studio</a> - An addendum to the main Getting Started guide for
  67 those using Visual Studio on Windows.</li>
  68
  69 <li><a href="tutorial/">LLVM Tutorial</a> - A walk through the process of using
  70 LLVM for a custom language, and the facilities LLVM offers in tutorial form.</li>
  71 <li><a href="DeveloperPolicy.html">Developer Policy</a> - The LLVM project's
  72 policy towards developers and their contributions.</li>
  73
  74 <li><a href="/docs/CommandGuide/index.html">LLVM Command Guide</a> - A reference
  75 manual for the LLVM command line utilities ("man" pages for LLVM tools).<br>
  76 Current tools:
  77  <a href="/cmds/llvm-ar.html">llvm-ar</a>,
  78  <a href="/cmds/llvm-as.html">llvm-as</a>,
  79  <a href="/cmds/llvm-dis.html">llvm-dis</a>,
  80  <a href="/cmds/llvm-extract.html">llvm-extract</a>,
  81  <a href="/cmds/llvm-ld.html">llvm-ld</a>,
  82  <a href="/cmds/llvm-link.html">llvm-link</a>,
  83  <a href="/cmds/llvm-nm.html">llvm-nm</a>,
  84  <a href="/cmds/llvm-prof.html">llvm-prof</a>,
  85  <a href="/cmds/llvm-ranlib.html">llvm-ranlib</a>,
  86  <a href="/cmds/opt.html">opt</a>,
  87  <a href="/cmds/llc.html">llc</a>,
  88  <a href="/cmds/lli.html">lli</a>,
  89  <a href="/cmds/llvmc.html">llvmc</a>
  90  <a href="/cmds/llvmgcc.html">llvm-gcc</a>,
  91  <a href="/cmds/llvmgxx.html">llvm-g++</a>,
  92  <a href="/cmds/stkrc.html">stkrc</a>,
  93  <a href="/cmds/bugpoint.html">bugpoint</a>,
  94  <a href="/cmds/llvm-bcanalyzer.html">llvm-bcanalyzer</a>,
  95 </li>
  96
  97 <li><a href="Passes.html">LLVM's Analysis and Transform Passes</a> - A list of
  98 optimizations and analyses implemented in LLVM.</li>
  99
 100 <li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
 101 questions and problems and their solutions.</li>
 102
 103 <li><a href="ReleaseNotes.html">Release notes for the current release</a>
 104 - This describes new features, known bugs, and other limitations.</li>
 105
 106 <li><a href="HowToSubmitABug.html">How to Submit A Bug Report</a> -
 107 Instructions for properly submitting information about any bugs you run into in
 108 the LLVM system.</li>
 109
 110 <li><a href="TestingGuide.html">LLVM Testing Infrastructure Guide</a> - A reference
 111 manual for using the LLVM testing infrastructure.</li>
 112
 113 <li><a href="GCCFEBuildInstrs.html">How to build the Ada/C/C++/Fortran front-ends</a> -
 114 Instructions for building gcc front-ends from source.</li>
 115
 116 <li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
 117 and concepts used in LLVM.</li>
 118
 119 <li><a name="irc">You can probably find help on the unofficial LLVM IRC
 120 channel</a>.  We often are on irc.oftc.net in the #llvm channel.  If you are
 121 using the mozilla browser, and have chatzilla installed, you can <a
 122 href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net</a> directly.</li>
 123
 124 </ul>
 125
 126
 127 <!--=======================================================================-->
 128 <div class="doc_section"><a name="llvmprog">General LLVM Programming Documentation</a></div>
 129 <!--=======================================================================-->
 130
 131 <ul>
 132 <li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
 133 intermediate representation and the assembly form of the different nodes.</li>
 134
 135 <li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
 136 Introduction to the general layout of the LLVM sourcebase, important classes
 137 and APIs, and some tips &amp; tricks.</li>
 138
 139 <li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
 140 templates for new projects that <em>use</em> the LLVM infrastructure.  The
 141 templates (directory organization, Makefiles, and test tree) allow the project
 142 code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
 143 header files and libraries.</li>
 144
 145 <li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
 146 LLVM makefiles work and how to use them.</li>
 147
 148 <li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
 149 Provides information on using the command line parsing library.</li>
 150
 151 <li><a href="CodingStandards.html">LLVM Coding standards</a> -
 152 Details the LLVM coding standards and provides useful information on writing
 153 efficient C++ code.</li>
 154
 155 <li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
 156 to add instructions and intrinsics to LLVM.</li>
 157
 158 <li><a href="UsingLibraries.html">Using LLVM Libraries</a> - Look here to
 159 understand how to use the libraries produced when LLVM is compiled.</li>
 160
 161 <li><a href="HowToReleaseLLVM.html">How To Release LLVM To The Public</a> - This
 162 is a guide to preparing LLVM releases. Most developers can ignore it.</li>
 163
 164 <li><a href="http://llvm.org/doxygen/">Doxygen generated
 165 documentation</a> (<a
 166 href="http://llvm.org/doxygen/inherits.html">classes</a>)
 167
 168 (<a href="http://llvm.org/doxygen/doxygen.tar.gz">tarball</a>)
 169 </li>
 170
 171 <li><a href="http://llvm.org/viewvc/">ViewVC Repository Browser</a></li>
 172
 173 </ul>
 174
 175 <!--=======================================================================-->
 176 <div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div>
 177 <!--=======================================================================-->
 178
 179 <ul>
 180
 181 <li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
 182 on how to write LLVM transformations and analyses.</li>
 183
 184 <li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
 185 on how to write LLVM backends for machine targets.</li>
 186
 187 <li><a href="CodeGenerator.html">The LLVM Target-Independent Code
 188 Generator</a> - The design and implementation of the LLVM code generator.
 189 Useful if you are working on retargetting LLVM to a new architecture, designing
 190 a new codegen pass, or enhancing existing components.</li>
 191
 192 <li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
 193 Describes the TableGen tool, which is used heavily by the LLVM code
 194 generator.</li>
 195
 196 <li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
 197 on how to write a new alias analysis implementation or how to use existing
 198 analyses.</li>
 199
 200 <li><a href="GarbageCollection.html">Accurate Garbage Collection with
 201 LLVM</a> - The interfaces source-language compilers should use for compiling
 202 GC'd programs.</li>
 203
 204 <li><a href="SourceLevelDebugging.html">Source Level Debugging with
 205 LLVM</a> - This document describes the design and philosophy behind the LLVM
 206 source-level debugger.</li>
 207
 208 <li><a href="ExceptionHandling.html">Zero Cost Exception handling in LLVM</a>
 209 - This document describes the design and implementation of exception handling
 210 in LLVM.</li>
 211
 212 <li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
 213 reducer description and usage information.</li>
 214
 215 <li><a href="CompilerDriverTutorial.html">Compiler Driver (llvmc) Tutorial</a>
 216 - This document is a tutorial introduction to the usage and
 217 configuration of the LLVM compiler driver tool, <tt>llvmc</tt>.</li>
 218
 219 <li><a href="CompilerDriver.html">Compiler Driver (llvmc)
 220 Reference</a> - This document describes the design and configuration
 221 of <tt>llvmc</tt> in more detail.</li>
 222
 223 <li><a href="BitCodeFormat.html">LLVM Bitcode File Format</a> - This describes
 224 the file format and encoding used for LLVM "bc" files.</li>
 225
 226 <li><a href="SystemLibrary.html">System Library</a> - This document describes
 227 the LLVM System Library (<tt>lib/System</tt>) and how to keep LLVM source code
 228 portable</li>
 229
 230 <li><a href="LinkTimeOptimization.html">Link Time Optimization</a> - This
 231 document describes the interface between LLVM intermodular optimizer and
 232 the linker and its design</li>
 233
 234 <li><a href="GoldPlugin.html">The LLVM gold plugin</a> - How to build your
 235 programs with link-time optimization on Linux.</li>
 236
 237 <li><a href="DebuggingJITedCode.html">The GDB JIT interface</a> - How to debug
 238 JITed code with GDB.</li>
 239 </ul>
 240
 241
 242 <!--=======================================================================-->
 243 <div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div>
 244 <!--=======================================================================-->
 245
 246 <ul>
 247 <li>The <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce">
 248 LLVM Announcements List</a>: This is a low volume list that provides important
 249 announcements regarding LLVM.  It gets email about once a month.</li>
 250
 251 <li>The <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
 252 List</a>: This list is for people who want to be included in technical
 253 discussions of LLVM. People post to this list when they have questions about
 254 writing code for or using the LLVM tools. It is relatively low volume.</li>
 255
 256 <li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &amp;
 257 Patches Archive</a>: This list gets emailed every time a bug is opened and
 258 closed, and when people submit patches to be included in LLVM.  It is higher
 259 volume than the LLVMdev list.</li>
 260
 261 <li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/">Commits
 262 Archive</a>: This list contains all commit messages that are made when LLVM
 263 developers commit code changes to the repository. It is useful for those who
 264 want to stay on the bleeding edge of LLVM development. This list is very high
 265 volume.</li>
 266
 267 <li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvm-testresults/">
 268 Test Results Archive</a>: A message is automatically sent to this list by every
 269 active nightly tester when it completes.  As such, this list gets email several
 270 times each day, making it a high volume list.</li>
 271
 272 </ul>
 273
 274 <!-- *********************************************************************** -->
 275
 276 <hr>
 277 <address>
 278   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 279   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
 280   <a href="http://validator.w3.org/check/referer"><img
 281   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
 282
 283   <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
 284   Last modified: $Date$
 285 </address>
 286 </body></html>
 287