1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
5 <title>Documentation for the LLVM System</title>
6 <link rel="stylesheet" href="llvm.css" type="text/css">
10 <div class="doc_title">Documentation for the LLVM System</div>
12 <div class="doc_text">
13 <table class="layout" width="95%"><tr class="layout"><td class="left">
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>
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">
31 <div class="doc_author">
32 <p>Written by <a href="http://llvm.org">The LLVM Team</a></p>
35 <!--=======================================================================-->
36 <div class="doc_section"><a name="llvmdesign">LLVM Design & Overview</a></div>
37 <!--=======================================================================-->
40 <li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
41 intermediate representation.</li>
42 <li><a href="http://llvm.org/pubs/2006-04-25-GelatoLLVMIntro.html">Introduction to the LLVM Compiler Infrastructure</a> - Presentation describing LLVM.</li>
43 <li><a href="http://llvm.org/pubs/2004-09-22-LCPCLLVMTutorial.html">The LLVM Compiler Framework and
44 Infrastructure Tutorial</a> - Tutorial for writing passes, exploring the system.</li>
45 <li><a href="http://llvm.org/pubs/2004-01-30-CGO-LLVM.html">LLVM: A Compilation Framework for
46 Lifelong Program Analysis & Transformation</a> - Design overview.</li>
47 <li><a href="http://llvm.org/pubs/2002-12-LattnerMSThesis.html">LLVM: An Infrastructure for
48 Multi-Stage Optimization</a> - More details (somewhat old now).</li>
49 <li><a href="GetElementPtr.html">GetElementPtr FAQ</a> - Answers to some very
50 frequent questions about LLVM's most frequently misunderstood instruction.</li>
53 <!--=======================================================================-->
54 <div class="doc_section"><a name="userguide">LLVM User Guides</a></div>
55 <!--=======================================================================-->
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
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>
67 <li><a href="tutorial/">LLVM Tutorial</a> - A walk through the process of using
68 LLVM for a custom language, and the facilities LLVM offers in tutorial form.</li>
69 <li><a href="DeveloperPolicy.html">Developer Policy</a> - The LLVM project's
70 policy towards developers and their contributions.</li>
72 <li><a href="/docs/CommandGuide/index.html">LLVM Command Guide</a> - A reference
73 manual for the LLVM command line utilities ("man" pages for LLVM tools).<br/>
75 <a href="/cmds/llvm-ar.html">llvm-ar</a>,
76 <a href="/cmds/llvm-as.html">llvm-as</a>,
77 <a href="/cmds/llvm-dis.html">llvm-dis</a>,
78 <a href="/cmds/llvm-extract.html">llvm-extract</a>,
79 <a href="/cmds/llvm-ld.html">llvm-ld</a>,
80 <a href="/cmds/llvm-link.html">llvm-link</a>,
81 <a href="/cmds/llvm-nm.html">llvm-nm</a>,
82 <a href="/cmds/llvm-prof.html">llvm-prof</a>,
83 <a href="/cmds/llvm-ranlib.html">llvm-ranlib</a>,
84 <a href="/cmds/opt.html">opt</a>,
85 <a href="/cmds/llc.html">llc</a>,
86 <a href="/cmds/lli.html">lli</a>,
87 <a href="/cmds/llvmc.html">llvmc</a>
88 <a href="/cmds/llvmgcc.html">llvm-gcc</a>,
89 <a href="/cmds/llvmgxx.html">llvm-g++</a>,
90 <a href="/cmds/stkrc.html">stkrc</a>,
91 <a href="/cmds/bugpoint.html">bugpoint</a>,
92 <a href="/cmds/llvm-bcanalyzer.html">llvm-bcanalyzer</a>,
95 <li><a href="Passes.html">LLVM's Analysis and Transform Passes</a> - A list of
96 optimizations and analyses implemented in LLVM.</li>
98 <li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
99 questions and problems and their solutions.</li>
101 <li><a href="ReleaseNotes.html">Release notes for the current release</a>
102 - This describes new features, known bugs, and other limitations.</li>
104 <li><a href="HowToSubmitABug.html">How to Submit A Bug Report</a> -
105 Instructions for properly submitting information about any bugs you run into in
106 the LLVM system.</li>
108 <li><a href="TestingGuide.html">LLVM Test Suite Guide</a> - A reference
109 manual for using the LLVM test suite.</li>
111 <li><a href="GCCFEBuildInstrs.html">How to build the C/C++ front-end</a> -
112 Instructions for building the front-end from source.</li>
114 <li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
115 and concepts used in LLVM.</li>
117 <li><a name="irc">You can probably find help on the unofficial LLVM IRC
118 channel</a>. We often are on irc.oftc.net in the #llvm channel. If you are
119 using the mozilla browser, and have chatzilla installed, you can <a
120 href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net</a> directly.</li>
125 <!--=======================================================================-->
126 <div class="doc_section"><a name="llvmprog">General LLVM Programming Documentation</a></div>
127 <!--=======================================================================-->
130 <li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
131 intermediate representation and the assembly form of the different nodes.</li>
133 <li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
134 Introduction to the general layout of the LLVM sourcebase, important classes
135 and APIs, and some tips & tricks.</li>
137 <li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
138 templates for new projects that <em>use</em> the LLVM infrastructure. The
139 templates (directory organization, Makefiles, and test tree) allow the project
140 code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
141 header files and libraries.</li>
143 <li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
144 LLVM makefiles work and how to use them.</li>
146 <li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
147 Provides information on using the command line parsing library.</li>
149 <li><a href="CodingStandards.html">LLVM Coding standards</a> -
150 Details the LLVM coding standards and provides useful information on writing
151 efficient C++ code.</li>
153 <li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
154 to add instructions and intrinsics to LLVM.</li>
156 <li><a href="UsingLibraries.html">Using LLVM Libraries</a> - Look here to
157 understand how to use the libraries produced when LLVM is compiled.</li>
159 <li><a href="HowToReleaseLLVM.html">How To Release LLVM To The Public</a> - This
160 is a guide to preparing LLVM releases. Most developers can ignore it.</li>
162 <li><a href="http://llvm.org/doxygen/">Doxygen generated
163 documentation</a> (<a
164 href="http://llvm.org/doxygen/inherits.html">classes</a>)
166 (<a href="http://llvm.org/doxygen/doxygen.tar.gz">tarball</a>)
169 <li><a href="http://llvm.org/viewvc/">ViewVC Repository Browser</a></li>
173 <!--=======================================================================-->
174 <div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div>
175 <!--=======================================================================-->
179 <li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
180 on how to write LLVM transformations and analyses.</li>
182 <li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
183 on how to write LLVM backends for machine targets.</li>
185 <li><a href="CodeGenerator.html">The LLVM Target-Independent Code
186 Generator</a> - The design and implementation of the LLVM code generator.
187 Useful if you are working on retargetting LLVM to a new architecture, designing
188 a new codegen pass, or enhancing existing components.</li>
190 <li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
191 Describes the TableGen tool, which is used heavily by the LLVM code
194 <li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
195 on how to write a new alias analysis implementation or how to use existing
198 <li><a href="Stacker.html">The Stacker Chronicles</a> - This document
199 describes both the Stacker language and LLVM frontend, but also some details
200 about LLVM useful for those writing front-ends.</li>
202 <li><a href="GarbageCollection.html">Accurate Garbage Collection with
203 LLVM</a> - The interfaces source-language compilers should use for compiling
206 <li><a href="SourceLevelDebugging.html">Source Level Debugging with
207 LLVM</a> - This document describes the design and philosophy behind the LLVM
208 source-level debugger.</li>
210 <li><a href="ExceptionHandling.html">Zero Cost Exception handling in LLVM</a>
211 - This document describes the design and implementation of exception handling
214 <li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
215 reducer description and usage information.</li>
217 <li><a href="CompilerDriver.html">Compiler Driver (llvmc)</a> - This document
218 describes the design and configuration of the LLVM compiler driver tool,
221 <li><a href="BitCodeFormat.html">LLVM Bitcode File Format</a></li>
223 <li><a href="SystemLibrary.html">System Library</a> - This document describes
224 the LLVM System Library (<tt>lib/System</tt>) and how to keep LLVM source code
227 <li><a href="LinkTimeOptimization.html">Link Time Optimization</a> - This
228 document describes the interface between LLVM intermodular optimizer and
229 the linker and its design</li>
234 <!--=======================================================================-->
235 <div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div>
236 <!--=======================================================================-->
239 <li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
240 LLVM Announcements List</a>: This is a low volume list that provides important
241 announcements regarding LLVM. It gets email about once a month.</li>
243 <li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
244 List</a>: This list is for people who want to be included in technical
245 discussions of LLVM. People post to this list when they have questions about
246 writing code for or using the LLVM tools. It is relatively low volume.</li>
248 <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &
249 Patches Archive</a>: This list gets emailed every time a bug is opened and
250 closed, and when people submit patches to be included in LLVM. It is higher
251 volume than the LLVMdev list.</li>
253 <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-commits/">Commits
254 Archive</a>: This list contains all commit messages that are made when LLVM
255 developers commit code changes to the repository. It is useful for those who
256 want to stay on the bleeding edge of LLVM development. This list is very high
259 <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-testresults/">
260 Test Results Archive</a>: A message is automatically sent to this list by every
261 active nightly tester when it completes. As such, this list gets email several
262 times each day, making it a high volume list.</li>
266 <!-- *********************************************************************** -->
270 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
271 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
272 <a href="http://validator.w3.org/check/referer"><img
273 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
275 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
276 Last modified: $Date$