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