blob: 5c50c411cfb14aa8c7b669e1ac13cd36d424981c [file] [log] [blame]
Misha Brukmanb69715e2004-05-12 18:00:48 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
John Criswell0f6d7c02003-10-27 18:18:16 +00003<html>
Misha Brukman1e07e0c2004-04-06 04:22:43 +00004<head>
Chris Lattner52fa42d2004-07-09 05:05:39 +00005 <title>Documentation for the LLVM System</title>
Misha Brukmanb69715e2004-05-12 18:00:48 +00006 <link rel="stylesheet" href="llvm.css" type="text/css">
Misha Brukman1e07e0c2004-04-06 04:22:43 +00007</head>
John Criswell0f6d7c02003-10-27 18:18:16 +00008<body>
9
Chris Lattner52fa42d2004-07-09 05:05:39 +000010<div class="doc_title">Documentation for the LLVM System</div>
John Criswell0f6d7c02003-10-27 18:18:16 +000011
Misha Brukmanb69715e2004-05-12 18:00:48 +000012<div class="doc_text">
Chris Lattner86d9b4c2005-04-23 15:55:18 +000013<table class="layout" width="95%"><tr class="layout"><td class="left">
Misha Brukmanb69715e2004-05-12 18:00:48 +000014<ul>
Chris Lattner20423022004-08-02 21:29:20 +000015 <li><a href="#llvmdesign">LLVM Design</a></li>
Reid Spencer20fdab62006-09-17 23:05:15 +000016 <li><a href="/pubs/">LLVM Publications</a></li>
Chris Lattner20423022004-08-02 21:29:20 +000017 <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>
Chris Lattner354a4422004-08-02 21:32:08 +000020 <li><a href="#maillist">LLVM Mailing Lists</a></li>
Misha Brukmanb69715e2004-05-12 18:00:48 +000021</ul>
Chris Lattner86d9b4c2005-04-23 15:55:18 +000022</td><td class="right">
23 <form action="http://www.google.com/search" method=get>
Misha Brukman430245f2008-12-11 18:14:06 +000024 <p>
Reid Spencer05fe4b02006-03-14 05:39:39 +000025 <input type="hidden" name="sitesearch" value="llvm.org/docs">
Chris Lattner86d9b4c2005-04-23 15:55:18 +000026 <input type=text name=q size=25><br>
27 <input type=submit value="Search the LLVM Docs" name="submit">
Misha Brukman430245f2008-12-11 18:14:06 +000028 </p>
Chris Lattnerf1b200b2005-04-23 17:27:36 +000029 </form>
Chris Lattner86d9b4c2005-04-23 15:55:18 +000030</td></tr></table>
Misha Brukmanb69715e2004-05-12 18:00:48 +000031</div>
John Criswell0f6d7c02003-10-27 18:18:16 +000032
Mikhail Glushenkov68319f82008-12-11 23:24:40 +000033<div class="doc_author">
Reid Spencer05fe4b02006-03-14 05:39:39 +000034 <p>Written by <a href="http://llvm.org">The LLVM Team</a></p>
Chris Lattnerddd21842004-08-02 21:33:45 +000035</div>
36
Chris Lattner20423022004-08-02 21:29:20 +000037<!--=======================================================================-->
Chris Lattner4a463a32006-06-20 20:54:47 +000038<div class="doc_section"><a name="llvmdesign">LLVM Design &amp; Overview</a></div>
Chris Lattner20423022004-08-02 21:29:20 +000039<!--=======================================================================-->
Misha Brukman1e07e0c2004-04-06 04:22:43 +000040
Misha Brukmanb69715e2004-05-12 18:00:48 +000041<ul>
Chris Lattner4a463a32006-06-20 20:54:47 +000042<li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
43intermediate representation.</li>
Chris Lattnerf21f85a2009-07-29 06:19:14 +000044<li><a href="http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html">Introduction to the LLVM Compiler </a> - Presentation describing LLVM.</li>
Chris Lattnerfded8a22006-06-20 20:56:03 +000045<li><a href="http://llvm.org/pubs/2004-09-22-LCPCLLVMTutorial.html">The LLVM Compiler Framework and
46Infrastructure 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
48Lifelong Program Analysis &amp; Transformation</a> - Design overview.</li>
49<li><a href="http://llvm.org/pubs/2002-12-LattnerMSThesis.html">LLVM: An Infrastructure for
Chris Lattnerf21f85a2009-07-29 06:19:14 +000050Multi-Stage Optimization</a> - More details (quite old now).</li>
Reid Spencer7cbe67d2006-11-13 08:03:59 +000051<li><a href="GetElementPtr.html">GetElementPtr FAQ</a> - Answers to some very
52frequent questions about LLVM's most frequently misunderstood instruction.</li>
John Criswella877f142006-06-20 18:21:31 +000053</ul>
54
55<!--=======================================================================-->
Chris Lattner20423022004-08-02 21:29:20 +000056<div class="doc_section"><a name="userguide">LLVM User Guides</a></div>
57<!--=======================================================================-->
Misha Brukmanb69715e2004-05-12 18:00:48 +000058
Misha Brukmanb69715e2004-05-12 18:00:48 +000059<ul>
Chris Lattner20423022004-08-02 21:29:20 +000060<li><a href="GettingStarted.html">The LLVM Getting Started Guide</a> -
61Discusses how to get up and running quickly with the LLVM infrastructure.
62Everything from unpacking and compilation of the distribution to execution of
63some tools.</li>
64
Jeff Cohenb9a47d12005-02-01 15:59:28 +000065<li><a href="GettingStartedVS.html">Getting Started with the LLVM System using
66Microsoft Visual Studio</a> - An addendum to the main Getting Started guide for
67those using Visual Studio on Windows.</li>
68
Chris Lattner1b024ce2007-11-09 19:24:54 +000069<li><a href="tutorial/">LLVM Tutorial</a> - A walk through the process of using
Nick Lewyckycf326da2007-11-09 05:45:51 +000070LLVM for a custom language, and the facilities LLVM offers in tutorial form.</li>
Reid Spencer26cf0662007-02-13 09:08:27 +000071<li><a href="DeveloperPolicy.html">Developer Policy</a> - The LLVM project's
72policy towards developers and their contributions.</li>
73
Reid Spencer944b7f22007-08-05 23:43:44 +000074<li><a href="/docs/CommandGuide/index.html">LLVM Command Guide</a> - A reference
Misha Brukman430245f2008-12-11 18:14:06 +000075manual for the LLVM command line utilities ("man" pages for LLVM tools).<br>
Reid Spencer31f841b2004-11-01 21:57:35 +000076Current tools:
Reid Spencer944b7f22007-08-05 23:43:44 +000077 <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>,
Reid Spencer31f841b2004-11-01 21:57:35 +000095</li>
Chris Lattner20423022004-08-02 21:29:20 +000096
Tanya Lattner20b7bda2008-03-24 18:29:32 +000097<li><a href="Passes.html">LLVM's Analysis and Transform Passes</a> - A list of
98optimizations and analyses implemented in LLVM.</li>
99
Chris Lattner354a4422004-08-02 21:32:08 +0000100<li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
101questions and problems and their solutions.</li>
102
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000103<li><a href="ReleaseNotes.html">Release notes for the current release</a>
Chris Lattner20423022004-08-02 21:29:20 +0000104- 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
Matthijs Kooijman9d3edca2008-07-02 13:54:58 +0000110<li><a href="TestingGuide.html">LLVM Testing Infrastructure Guide</a> - A reference
111manual for using the LLVM testing infrastructure.</li>
Chris Lattner20423022004-08-02 21:29:20 +0000112
Duncan Sands0cfe0522008-12-10 10:50:58 +0000113<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>
Chris Lattner354a4422004-08-02 21:32:08 +0000115
Chris Lattnerd404d7f2004-09-19 23:15:47 +0000116<li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
117and concepts used in LLVM.</li>
118
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000119<li><a name="irc">You can probably find help on the unofficial LLVM IRC
120channel</a>. We often are on irc.oftc.net in the #llvm channel. If you are
121using the mozilla browser, and have chatzilla installed, you can <a
Misha Brukman0b9370f2004-09-06 20:58:44 +0000122href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net</a> directly.</li>
Chris Lattner354a4422004-08-02 21:32:08 +0000123
Misha Brukmanb69715e2004-05-12 18:00:48 +0000124</ul>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000125
Misha Brukmanb69715e2004-05-12 18:00:48 +0000126
Chris Lattner20423022004-08-02 21:29:20 +0000127<!--=======================================================================-->
128<div class="doc_section"><a name="llvmprog">General LLVM Programming Documentation</a></div>
129<!--=======================================================================-->
Misha Brukmanb69715e2004-05-12 18:00:48 +0000130
Chris Lattner20423022004-08-02 21:29:20 +0000131<ul>
Chris Lattner4a463a32006-06-20 20:54:47 +0000132<li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
133intermediate representation and the assembly form of the different nodes.</li>
134
Chris Lattner20423022004-08-02 21:29:20 +0000135<li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
136Introduction to the general layout of the LLVM sourcebase, important classes
137and APIs, and some tips &amp; tricks.</li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000138
Chris Lattner20423022004-08-02 21:29:20 +0000139<li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
140templates for new projects that <em>use</em> the LLVM infrastructure. The
141templates (directory organization, Makefiles, and test tree) allow the project
142code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
143header files and libraries.</li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000144
Chris Lattner4c871b52004-10-25 19:39:46 +0000145<li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
146LLVM makefiles work and how to use them.</li>
147
Chris Lattner20423022004-08-02 21:29:20 +0000148<li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
149Provides information on using the command line parsing library.</li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000150
Chris Lattner4c871b52004-10-25 19:39:46 +0000151<li><a href="CodingStandards.html">LLVM Coding standards</a> -
Chris Lattner20423022004-08-02 21:29:20 +0000152Details the LLVM coding standards and provides useful information on writing
153efficient C++ code.</li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000154
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000155<li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
Chris Lattner20423022004-08-02 21:29:20 +0000156to add instructions and intrinsics to LLVM.</li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000157
Reid Spencer0a727fc2004-10-31 23:02:38 +0000158<li><a href="UsingLibraries.html">Using LLVM Libraries</a> - Look here to
159understand how to use the libraries produced when LLVM is compiled.</li>
160
Reid Spencer7df8e262006-03-23 06:53:38 +0000161<li><a href="HowToReleaseLLVM.html">How To Release LLVM To The Public</a> - This
162is a guide to preparing LLVM releases. Most developers can ignore it.</li>
163
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000164<li><a href="http://llvm.org/doxygen/">Doxygen generated
Misha Brukmane539a2b2004-12-03 23:26:23 +0000165documentation</a> (<a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000166href="http://llvm.org/doxygen/inherits.html">classes</a>)
Chris Lattnere2667312005-11-30 06:35:34 +0000167
Reid Spencer05fe4b02006-03-14 05:39:39 +0000168(<a href="http://llvm.org/doxygen/doxygen.tar.gz">tarball</a>)
Chris Lattnere2667312005-11-30 06:35:34 +0000169</li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000170
Reid Spencer669ed452007-07-09 08:04:31 +0000171<li><a href="http://llvm.org/viewvc/">ViewVC Repository Browser</a></li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000172
Chris Lattner20423022004-08-02 21:29:20 +0000173</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
182on how to write LLVM transformations and analyses.</li>
183
Misha Brukman96bba382004-09-06 23:00:01 +0000184<li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
185on how to write LLVM backends for machine targets.</li>
186
Chris Lattner20423022004-08-02 21:29:20 +0000187<li><a href="CodeGenerator.html">The LLVM Target-Independent Code
188Generator</a> - The design and implementation of the LLVM code generator.
189Useful if you are working on retargetting LLVM to a new architecture, designing
190a new codegen pass, or enhancing existing components.</li>
191
192<li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
193Describes the TableGen tool, which is used heavily by the LLVM code
194generator.</li>
195
196<li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
197on how to write a new alias analysis implementation or how to use existing
198analyses.</li>
199
Chris Lattner20423022004-08-02 21:29:20 +0000200<li><a href="GarbageCollection.html">Accurate Garbage Collection with
201LLVM</a> - The interfaces source-language compilers should use for compiling
202GC'd programs.</li>
203
204<li><a href="SourceLevelDebugging.html">Source Level Debugging with
205LLVM</a> - This document describes the design and philosophy behind the LLVM
206source-level debugger.</li>
207
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000208<li><a href="ExceptionHandling.html">Zero Cost Exception handling in LLVM</a>
Chris Lattner92734182007-05-13 23:38:44 +0000209- This document describes the design and implementation of exception handling
210in LLVM.</li>
211
Misha Brukman9e3bdf12005-01-07 17:00:44 +0000212<li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
Misha Brukman3df00a02004-12-09 20:26:53 +0000213reducer description and usage information.</li>
Chris Lattner20423022004-08-02 21:29:20 +0000214
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000215<li><a href="CompilerDriverTutorial.html">Compiler Driver (llvmc) Tutorial</a>
216- This document is a tutorial introduction to the usage and
217configuration of the LLVM compiler driver tool, <tt>llvmc</tt>.</li>
Reid Spencer2d1e01c2004-08-17 08:01:57 +0000218
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000219<li><a href="CompilerDriver.html">Compiler Driver (llvmc)
220Reference</a> - This document describes the design and configuration
221of <tt>llvmc</tt> in more detail.</li>
222
223<li><a href="BitCodeFormat.html">LLVM Bitcode File Format</a> - This describes
Chris Lattner4f60e4d2008-07-13 21:27:36 +0000224the file format and encoding used for LLVM "bc" files.</li>
Chris Lattner4a463a32006-06-20 20:54:47 +0000225
Reid Spencer8853b132005-01-05 19:01:20 +0000226<li><a href="SystemLibrary.html">System Library</a> - This document describes
227the LLVM System Library (<tt>lib/System</tt>) and how to keep LLVM source code
228portable</li>
229
Devang Patelde4bbd92006-08-14 18:21:53 +0000230<li><a href="LinkTimeOptimization.html">Link Time Optimization</a> - This
231document describes the interface between LLVM intermodular optimizer and
232the linker and its design</li>
233
Chris Lattner932af8f2009-03-01 23:42:51 +0000234<li><a href="GoldPlugin.html">The LLVM gold plugin</a> - How to build your
235programs with link-time optimization on Linux.</li>
Reid Kleckner22884dd2009-09-21 02:34:59 +0000236
237<li><a href="DebuggingJITedCode.html">The GDB JIT interface</a> - How to debug
238JITed code with GDB.</li>
Chris Lattner20423022004-08-02 21:29:20 +0000239</ul>
240
Reid Spencer7df8e262006-03-23 06:53:38 +0000241
Chris Lattner20423022004-08-02 21:29:20 +0000242<!--=======================================================================-->
Chris Lattner354a4422004-08-02 21:32:08 +0000243<div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div>
Chris Lattner20423022004-08-02 21:29:20 +0000244<!--=======================================================================-->
245
246<ul>
Duncan Sands9a365b62008-11-12 10:10:25 +0000247<li>The <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce">
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000248LLVM Announcements List</a>: This is a low volume list that provides important
Chris Lattner20423022004-08-02 21:29:20 +0000249announcements regarding LLVM. It gets email about once a month.</li>
250
Duncan Sands9a365b62008-11-12 10:10:25 +0000251<li>The <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000252List</a>: This list is for people who want to be included in technical
253discussions of LLVM. People post to this list when they have questions about
Chris Lattner20423022004-08-02 21:29:20 +0000254writing code for or using the LLVM tools. It is relatively low volume.</li>
255
Duncan Sands9a365b62008-11-12 10:10:25 +0000256<li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &amp;
Chris Lattner20423022004-08-02 21:29:20 +0000257Patches Archive</a>: This list gets emailed every time a bug is opened and
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000258closed, and when people submit patches to be included in LLVM. It is higher
Chris Lattner20423022004-08-02 21:29:20 +0000259volume than the LLVMdev list.</li>
260
Duncan Sands9a365b62008-11-12 10:10:25 +0000261<li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/">Commits
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000262Archive</a>: This list contains all commit messages that are made when LLVM
263developers commit code changes to the repository. It is useful for those who
Chris Lattner20423022004-08-02 21:29:20 +0000264want to stay on the bleeding edge of LLVM development. This list is very high
265volume.</li>
266
Duncan Sands9a365b62008-11-12 10:10:25 +0000267<li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvm-testresults/">
Chris Lattner77186582006-02-23 16:18:29 +0000268Test Results Archive</a>: A message is automatically sent to this list by every
Chris Lattner1914bf12006-02-23 16:14:22 +0000269active nightly tester when it completes. As such, this list gets email several
270times each day, making it a high volume list.</li>
271
Chris Lattner20423022004-08-02 21:29:20 +0000272</ul>
John Criswell0f6d7c02003-10-27 18:18:16 +0000273
Misha Brukmanb69715e2004-05-12 18:00:48 +0000274<!-- *********************************************************************** -->
John Criswell0f6d7c02003-10-27 18:18:16 +0000275
276<hr>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000277<address>
278 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000279 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000280 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000281 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
John Criswell0f6d7c02003-10-27 18:18:16 +0000282
Reid Spencer05fe4b02006-03-14 05:39:39 +0000283 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000284 Last modified: $Date$
285</address>
Reid Spencer6fdb2362007-07-01 17:02:22 +0000286</body></html>
Chris Lattner1df4f752007-09-21 17:30:40 +0000287