blob: fa9f1fae0fcafd8bfa921dc665987aa49ccf8f68 [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>
Jeffrey Yasskin6351d6b2010-02-03 18:49:55 +00005 <title>Documentation for the LLVM System at SVN head</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
NAKAMURA Takumi05d02652011-04-18 23:59:50 +000010<h1>Documentation for the LLVM System at SVN head</h1>
Jeffrey Yasskin6cfb8a12010-02-03 18:23:23 +000011
Jeffrey Yasskin6351d6b2010-02-03 18:49:55 +000012<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>
John Criswell0f6d7c02003-10-27 18:18:16 +000015
Chris Lattner86d9b4c2005-04-23 15:55:18 +000016<table class="layout" width="95%"><tr class="layout"><td class="left">
Misha Brukmanb69715e2004-05-12 18:00:48 +000017<ul>
Chris Lattner20423022004-08-02 21:29:20 +000018 <li><a href="#llvmdesign">LLVM Design</a></li>
Reid Spencer20fdab62006-09-17 23:05:15 +000019 <li><a href="/pubs/">LLVM Publications</a></li>
Chris Lattner20423022004-08-02 21:29:20 +000020 <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>
Chris Lattner354a4422004-08-02 21:32:08 +000023 <li><a href="#maillist">LLVM Mailing Lists</a></li>
Misha Brukmanb69715e2004-05-12 18:00:48 +000024</ul>
Chris Lattner86d9b4c2005-04-23 15:55:18 +000025</td><td class="right">
26 <form action="http://www.google.com/search" method=get>
Misha Brukman430245f2008-12-11 18:14:06 +000027 <p>
Reid Spencer05fe4b02006-03-14 05:39:39 +000028 <input type="hidden" name="sitesearch" value="llvm.org/docs">
Chris Lattner86d9b4c2005-04-23 15:55:18 +000029 <input type=text name=q size=25><br>
30 <input type=submit value="Search the LLVM Docs" name="submit">
Misha Brukman430245f2008-12-11 18:14:06 +000031 </p>
Chris Lattnerf1b200b2005-04-23 17:27:36 +000032 </form>
Chris Lattner86d9b4c2005-04-23 15:55:18 +000033</td></tr></table>
John Criswell0f6d7c02003-10-27 18:18:16 +000034
Mikhail Glushenkov68319f82008-12-11 23:24:40 +000035<div class="doc_author">
NAKAMURA Takumib9a33632011-04-09 02:13:37 +000036 <p>Written by <a href="http://llvm.org/">The LLVM Team</a></p>
Chris Lattnerddd21842004-08-02 21:33:45 +000037</div>
38
Chris Lattner20423022004-08-02 21:29:20 +000039<!--=======================================================================-->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +000040<h2><a name="llvmdesign">LLVM Design &amp; Overview</a></h2>
Chris Lattner20423022004-08-02 21:29:20 +000041<!--=======================================================================-->
Misha Brukman1e07e0c2004-04-06 04:22:43 +000042
Misha Brukmanb69715e2004-05-12 18:00:48 +000043<ul>
Chris Lattner4a463a32006-06-20 20:54:47 +000044<li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
45intermediate representation.</li>
Chris Lattner78e78b52011-05-30 03:36:58 +000046<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>
Chris Lattnerfded8a22006-06-20 20:56:03 +000048<li><a href="http://llvm.org/pubs/2004-01-30-CGO-LLVM.html">LLVM: A Compilation Framework for
49Lifelong Program Analysis &amp; Transformation</a> - Design overview.</li>
50<li><a href="http://llvm.org/pubs/2002-12-LattnerMSThesis.html">LLVM: An Infrastructure for
Chris Lattnerf21f85a2009-07-29 06:19:14 +000051Multi-Stage Optimization</a> - More details (quite old now).</li>
Reid Spencer7cbe67d2006-11-13 08:03:59 +000052<li><a href="GetElementPtr.html">GetElementPtr FAQ</a> - Answers to some very
53frequent questions about LLVM's most frequently misunderstood instruction.</li>
John Criswella877f142006-06-20 18:21:31 +000054</ul>
55
56<!--=======================================================================-->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +000057<h2><a name="userguide">LLVM User Guides</a></h2>
Chris Lattner20423022004-08-02 21:29:20 +000058<!--=======================================================================-->
Misha Brukmanb69715e2004-05-12 18:00:48 +000059
Misha Brukmanb69715e2004-05-12 18:00:48 +000060<ul>
Chris Lattner20423022004-08-02 21:29:20 +000061<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
Jeff Cohenb9a47d12005-02-01 15:59:28 +000066<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
mike-me2c3a492010-05-07 00:28:04 +000070<li><a href="tutorial/">LLVM Tutorial</a> - A walk through the process of using
Nick Lewyckycf326da2007-11-09 05:45:51 +000071LLVM for a custom language, and the facilities LLVM offers in tutorial form.</li>
Reid Spencer26cf0662007-02-13 09:08:27 +000072<li><a href="DeveloperPolicy.html">Developer Policy</a> - The LLVM project's
73policy towards developers and their contributions.</li>
74
NAKAMURA Takumi31c18062011-04-09 02:13:48 +000075<li><a href="CommandGuide/index.html">LLVM Command Guide</a> - A reference
Misha Brukman430245f2008-12-11 18:14:06 +000076manual for the LLVM command line utilities ("man" pages for LLVM tools).<br>
Reid Spencer31f841b2004-11-01 21:57:35 +000077Current tools:
mike-me2c3a492010-05-07 00:28:04 +000078 <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>,
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
Jeffrey Yasskin0c0f4b62010-02-26 00:54:42 +0000116<li><a href="Packaging.html">Packaging guide</a> - Advice on packaging
117LLVM into a distribution.</li>
118
Chris Lattnerd404d7f2004-09-19 23:15:47 +0000119<li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
120and concepts used in LLVM.</li>
121
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000122<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
Misha Brukman0b9370f2004-09-06 20:58:44 +0000125href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net</a> directly.</li>
Chris Lattner354a4422004-08-02 21:32:08 +0000126
Misha Brukmanb69715e2004-05-12 18:00:48 +0000127</ul>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000128
Misha Brukmanb69715e2004-05-12 18:00:48 +0000129
Chris Lattner20423022004-08-02 21:29:20 +0000130<!--=======================================================================-->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000131<h2><a name="llvmprog">General LLVM Programming Documentation</a></h2>
Chris Lattner20423022004-08-02 21:29:20 +0000132<!--=======================================================================-->
Misha Brukmanb69715e2004-05-12 18:00:48 +0000133
Chris Lattner20423022004-08-02 21:29:20 +0000134<ul>
Chris Lattner4a463a32006-06-20 20:54:47 +0000135<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
Chris Lattner20423022004-08-02 21:29:20 +0000138<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 &amp; tricks.</li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000141
Chris Lattner20423022004-08-02 21:29:20 +0000142<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>
John Criswell0f6d7c02003-10-27 18:18:16 +0000147
Chris Lattner4c871b52004-10-25 19:39:46 +0000148<li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
149LLVM makefiles work and how to use them.</li>
150
Chris Lattner20423022004-08-02 21:29:20 +0000151<li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
152Provides information on using the command line parsing library.</li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000153
Chris Lattner4c871b52004-10-25 19:39:46 +0000154<li><a href="CodingStandards.html">LLVM Coding standards</a> -
Chris Lattner20423022004-08-02 21:29:20 +0000155Details the LLVM coding standards and provides useful information on writing
156efficient C++ code.</li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000157
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000158<li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
Chris Lattner20423022004-08-02 21:29:20 +0000159to add instructions and intrinsics to LLVM.</li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000160
Reid Spencer0a727fc2004-10-31 23:02:38 +0000161<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
Reid Spencer7df8e262006-03-23 06:53:38 +0000164<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
Jakub Staszak29057762011-07-06 18:31:02 +0000167
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000168<li><a href="http://llvm.org/doxygen/">Doxygen generated
Misha Brukmane539a2b2004-12-03 23:26:23 +0000169documentation</a> (<a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000170href="http://llvm.org/doxygen/inherits.html">classes</a>)
Chris Lattnere2667312005-11-30 06:35:34 +0000171
Reid Spencer05fe4b02006-03-14 05:39:39 +0000172(<a href="http://llvm.org/doxygen/doxygen.tar.gz">tarball</a>)
Chris Lattnere2667312005-11-30 06:35:34 +0000173</li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000174
Reid Spencer669ed452007-07-09 08:04:31 +0000175<li><a href="http://llvm.org/viewvc/">ViewVC Repository Browser</a></li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000176
Chris Lattner20423022004-08-02 21:29:20 +0000177</ul>
178
179<!--=======================================================================-->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000180<h2><a name="subsystems">LLVM Subsystem Documentation</a></h2>
Chris Lattner20423022004-08-02 21:29:20 +0000181<!--=======================================================================-->
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
Misha Brukman96bba382004-09-06 23:00:01 +0000188<li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
189on how to write LLVM backends for machine targets.</li>
190
Chris Lattner20423022004-08-02 21:29:20 +0000191<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
Chris Lattner20423022004-08-02 21:29:20 +0000204<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
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000212<li><a href="ExceptionHandling.html">Zero Cost Exception handling in LLVM</a>
Chris Lattner92734182007-05-13 23:38:44 +0000213- This document describes the design and implementation of exception handling
214in LLVM.</li>
215
Misha Brukman9e3bdf12005-01-07 17:00:44 +0000216<li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
Misha Brukman3df00a02004-12-09 20:26:53 +0000217reducer description and usage information.</li>
Chris Lattner20423022004-08-02 21:29:20 +0000218
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000219<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>
Reid Spencer2d1e01c2004-08-17 08:01:57 +0000222
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000223<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
Chris Lattner4f60e4d2008-07-13 21:27:36 +0000228the file format and encoding used for LLVM "bc" files.</li>
Chris Lattner4a463a32006-06-20 20:54:47 +0000229
Reid Spencer8853b132005-01-05 19:01:20 +0000230<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
Devang Patelde4bbd92006-08-14 18:21:53 +0000234<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
Chris Lattner932af8f2009-03-01 23:42:51 +0000238<li><a href="GoldPlugin.html">The LLVM gold plugin</a> - How to build your
239programs with link-time optimization on Linux.</li>
Reid Kleckner22884dd2009-09-21 02:34:59 +0000240
241<li><a href="DebuggingJITedCode.html">The GDB JIT interface</a> - How to debug
242JITed code with GDB.</li>
Jakub Staszak29057762011-07-06 18:31:02 +0000243
244<li><a href="BranchWeightMetadata.html">Branch Weight Metadata</a> - Provides
245information about Branch Prediction Information.</li>
246
Chris Lattner20423022004-08-02 21:29:20 +0000247</ul>
248
Reid Spencer7df8e262006-03-23 06:53:38 +0000249
Chris Lattner20423022004-08-02 21:29:20 +0000250<!--=======================================================================-->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000251<h2><a name="maillist">LLVM Mailing Lists</a></h2>
Chris Lattner20423022004-08-02 21:29:20 +0000252<!--=======================================================================-->
253
254<ul>
Duncan Sands9a365b62008-11-12 10:10:25 +0000255<li>The <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce">
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000256LLVM Announcements List</a>: This is a low volume list that provides important
Chris Lattner20423022004-08-02 21:29:20 +0000257announcements regarding LLVM. It gets email about once a month.</li>
258
Duncan Sands9a365b62008-11-12 10:10:25 +0000259<li>The <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000260List</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
Chris Lattner20423022004-08-02 21:29:20 +0000262writing code for or using the LLVM tools. It is relatively low volume.</li>
263
Duncan Sands9a365b62008-11-12 10:10:25 +0000264<li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &amp;
Chris Lattner20423022004-08-02 21:29:20 +0000265Patches Archive</a>: This list gets emailed every time a bug is opened and
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000266closed, and when people submit patches to be included in LLVM. It is higher
Chris Lattner20423022004-08-02 21:29:20 +0000267volume than the LLVMdev list.</li>
268
Duncan Sands9a365b62008-11-12 10:10:25 +0000269<li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/">Commits
Mikhail Glushenkov68319f82008-12-11 23:24:40 +0000270Archive</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
Chris Lattner20423022004-08-02 21:29:20 +0000272want to stay on the bleeding edge of LLVM development. This list is very high
273volume.</li>
274
Duncan Sands9a365b62008-11-12 10:10:25 +0000275<li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvm-testresults/">
Chris Lattner77186582006-02-23 16:18:29 +0000276Test Results Archive</a>: A message is automatically sent to this list by every
Chris Lattner1914bf12006-02-23 16:14:22 +0000277active nightly tester when it completes. As such, this list gets email several
278times each day, making it a high volume list.</li>
279
Chris Lattner20423022004-08-02 21:29:20 +0000280</ul>
John Criswell0f6d7c02003-10-27 18:18:16 +0000281
Misha Brukmanb69715e2004-05-12 18:00:48 +0000282<!-- *********************************************************************** -->
John Criswell0f6d7c02003-10-27 18:18:16 +0000283
284<hr>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000285<address>
286 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000287 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000288 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000289 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
John Criswell0f6d7c02003-10-27 18:18:16 +0000290
NAKAMURA Takumib9a33632011-04-09 02:13:37 +0000291 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000292 Last modified: $Date$
293</address>
Reid Spencer6fdb2362007-07-01 17:02:22 +0000294</body></html>
Chris Lattner1df4f752007-09-21 17:30:40 +0000295