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="DeveloperPolicy.html">Developer Policy</a> - The LLVM project's
68 policy towards developers and their contributions.</li>
70 <li><a href="CommandGuide/index.html">LLVM Command Guide</a> - A reference
71 manual for the LLVM command line utilities ("man" pages for LLVM tools).<br/>
73 <a href="CommandGuide/html/llvm-ar.html">llvm-ar</a>,
74 <a href="CommandGuide/html/llvm-as.html">llvm-as</a>,
75 <a href="CommandGuide/html/llvm-dis.html">llvm-dis</a>,
76 <a href="CommandGuide/html/llvm-extract.html">llvm-extract</a>,
77 <a href="CommandGuide/html/llvm-ld.html">llvm-ld</a>,
78 <a href="CommandGuide/html/llvm-link.html">llvm-link</a>,
79 <a href="CommandGuide/html/llvm-nm.html">llvm-nm</a>,
80 <a href="CommandGuide/html/llvm-prof.html">llvm-prof</a>,
81 <a href="CommandGuide/html/llvm-ranlib.html">llvm-ranlib</a>,
82 <a href="CommandGuide/html/opt.html">opt</a>,
83 <a href="CommandGuide/html/llc.html">llc</a>,
84 <a href="CommandGuide/html/lli.html">lli</a>,
85 <a href="CommandGuide/html/llvmc.html">llvmc</a>
86 <a href="CommandGuide/html/llvmgcc.html">llvm-gcc</a>,
87 <a href="CommandGuide/html/llvmgxx.html">llvm-g++</a>,
88 <a href="CommandGuide/html/stkrc.html">stkrc</a>,
89 <a href="CommandGuide/html/bugpoint.html">bugpoint</a>,
90 <a href="CommandGuide/html/llvm-bcanalyzer.html">llvm-bcanalyzer</a>,
93 <li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
94 questions and problems and their solutions.</li>
96 <li><a href="ReleaseNotes.html">Release notes for the current release</a>
97 - This describes new features, known bugs, and other limitations.</li>
99 <li><a href="HowToSubmitABug.html">How to Submit A Bug Report</a> -
100 Instructions for properly submitting information about any bugs you run into in
101 the LLVM system.</li>
103 <li><a href="TestingGuide.html">LLVM Test Suite Guide</a> - A reference
104 manual for using the LLVM test suite.</li>
106 <li><a href="CFEBuildInstrs.html">How to build the C/C++ front-end</a> -
107 Instructions for building the front-end from source.</li>
109 <li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
110 and concepts used in LLVM.</li>
112 <li><a name="irc">You can probably find help on the unofficial LLVM IRC
113 channel</a>. We often are on irc.oftc.net in the #llvm channel. If you are
114 using the mozilla browser, and have chatzilla installed, you can <a
115 href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net</a> directly.</li>
120 <!--=======================================================================-->
121 <div class="doc_section"><a name="llvmprog">General LLVM Programming Documentation</a></div>
122 <!--=======================================================================-->
125 <li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
126 intermediate representation and the assembly form of the different nodes.</li>
128 <li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
129 Introduction to the general layout of the LLVM sourcebase, important classes
130 and APIs, and some tips & tricks.</li>
132 <li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
133 templates for new projects that <em>use</em> the LLVM infrastructure. The
134 templates (directory organization, Makefiles, and test tree) allow the project
135 code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
136 header files and libraries.</li>
138 <li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
139 LLVM makefiles work and how to use them.</li>
141 <li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
142 Provides information on using the command line parsing library.</li>
144 <li><a href="CodingStandards.html">LLVM Coding standards</a> -
145 Details the LLVM coding standards and provides useful information on writing
146 efficient C++ code.</li>
148 <li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
149 to add instructions and intrinsics to LLVM.</li>
151 <li><a href="UsingLibraries.html">Using LLVM Libraries</a> - Look here to
152 understand how to use the libraries produced when LLVM is compiled.</li>
154 <li><a href="HowToReleaseLLVM.html">How To Release LLVM To The Public</a> - This
155 is a guide to preparing LLVM releases. Most developers can ignore it.</li>
157 <li><a href="http://llvm.org/doxygen/">Doxygen generated
158 documentation</a> (<a
159 href="http://llvm.org/doxygen/inherits.html">classes</a>)
161 (<a href="http://llvm.org/doxygen/doxygen.tar.gz">tarball</a>)
164 <li><a href="http://llvm.org/cvsweb/cvsweb.cgi/llvm">CVSWeb CVS Tree
169 <!--=======================================================================-->
170 <div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div>
171 <!--=======================================================================-->
175 <li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
176 on how to write LLVM transformations and analyses.</li>
178 <li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
179 on how to write LLVM backends for machine targets.</li>
181 <li><a href="CodeGenerator.html">The LLVM Target-Independent Code
182 Generator</a> - The design and implementation of the LLVM code generator.
183 Useful if you are working on retargetting LLVM to a new architecture, designing
184 a new codegen pass, or enhancing existing components.</li>
186 <li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
187 Describes the TableGen tool, which is used heavily by the LLVM code
190 <li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
191 on how to write a new alias analysis implementation or how to use existing
194 <li><a href="Stacker.html">The Stacker Chronicles</a> - This document
195 describes both the Stacker language and LLVM frontend, but also some details
196 about LLVM useful for those writing front-ends.</li>
198 <li><a href="GarbageCollection.html">Accurate Garbage Collection with
199 LLVM</a> - The interfaces source-language compilers should use for compiling
202 <li><a href="SourceLevelDebugging.html">Source Level Debugging with
203 LLVM</a> - This document describes the design and philosophy behind the LLVM
204 source-level debugger.</li>
206 <li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
207 reducer description and usage information.</li>
209 <li><a href="CompilerDriver.html">Compiler Driver (llvmc)</a> - This document
210 describes the design and configuration of the LLVM compiler driver tool,
213 <li><a href="BytecodeFormat.html">LLVM Bytecode File Format</a></li>
215 <li><a href="SystemLibrary.html">System Library</a> - This document describes
216 the LLVM System Library (<tt>lib/System</tt>) and how to keep LLVM source code
219 <li><a href="LinkTimeOptimization.html">Link Time Optimization</a> - This
220 document describes the interface between LLVM intermodular optimizer and
221 the linker and its design</li>
226 <!--=======================================================================-->
227 <div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div>
228 <!--=======================================================================-->
231 <li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
232 LLVM Announcements List</a>: This is a low volume list that provides important
233 announcements regarding LLVM. It gets email about once a month.</li>
235 <li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
236 List</a>: This list is for people who want to be included in technical
237 discussions of LLVM. People post to this list when they have questions about
238 writing code for or using the LLVM tools. It is relatively low volume.</li>
240 <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &
241 Patches Archive</a>: This list gets emailed every time a bug is opened and
242 closed, and when people submit patches to be included in LLVM. It is higher
243 volume than the LLVMdev list.</li>
245 <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-commits/">CVS Commits
246 Archive</a>: This list contains all commit messages that are made when LLVM
247 developers commit code changes to the CVS archive. It is useful for those who
248 want to stay on the bleeding edge of LLVM development. This list is very high
251 <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-testresults/">
252 Test Results Archive</a>: A message is automatically sent to this list by every
253 active nightly tester when it completes. As such, this list gets email several
254 times each day, making it a high volume list.</li>
258 <!-- *********************************************************************** -->
262 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
263 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
264 <a href="http://validator.w3.org/check/referer"><img
265 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
267 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
268 Last modified: $Date$