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