blob: 0a50c3c367d9e40d73d91b6c7961dc21ab048123 [file] [log] [blame]
Misha Brukman8e33fed2004-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 Criswellf531f312003-10-27 18:18:16 +00003<html>
Misha Brukmanad3e28c2004-04-06 04:22:43 +00004<head>
Chris Lattner0fc190f2004-07-09 05:05:39 +00005 <title>Documentation for the LLVM System</title>
Misha Brukman8e33fed2004-05-12 18:00:48 +00006 <link rel="stylesheet" href="llvm.css" type="text/css">
Misha Brukmanad3e28c2004-04-06 04:22:43 +00007</head>
John Criswellf531f312003-10-27 18:18:16 +00008<body>
9
Chris Lattner0fc190f2004-07-09 05:05:39 +000010<div class="doc_title">Documentation for the LLVM System</div>
John Criswellf531f312003-10-27 18:18:16 +000011
Misha Brukman8e33fed2004-05-12 18:00:48 +000012<div class="doc_text">
Chris Lattnerc5ad1ca2005-04-23 15:55:18 +000013<table class="layout" width="95%"><tr class="layout"><td class="left">
Misha Brukman8e33fed2004-05-12 18:00:48 +000014<ul>
Chris Lattnerfcc76882004-08-02 21:29:20 +000015 <li><a href="#llvmdesign">LLVM Design</a></li>
Reid Spencer99dedf42006-09-17 23:05:15 +000016 <li><a href="/pubs/">LLVM Publications</a></li>
Chris Lattnerfcc76882004-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 Lattner07414cb2004-08-02 21:32:08 +000020 <li><a href="#maillist">LLVM Mailing Lists</a></li>
Misha Brukman8e33fed2004-05-12 18:00:48 +000021</ul>
Chris Lattnerc5ad1ca2005-04-23 15:55:18 +000022</td><td class="right">
23 <form action="http://www.google.com/search" method=get>
Misha Brukman0091c262008-12-11 18:14:06 +000024 <p>
Reid Spencerca058542006-03-14 05:39:39 +000025 <input type="hidden" name="sitesearch" value="llvm.org/docs">
Chris Lattnerc5ad1ca2005-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 Brukman0091c262008-12-11 18:14:06 +000028 </p>
Chris Lattnerfdfb25a2005-04-23 17:27:36 +000029 </form>
Chris Lattnerc5ad1ca2005-04-23 15:55:18 +000030</td></tr></table>
Misha Brukman8e33fed2004-05-12 18:00:48 +000031</div>
John Criswellf531f312003-10-27 18:18:16 +000032
Chris Lattnere1972b12004-08-02 21:33:45 +000033<div class="doc_author">
Reid Spencerca058542006-03-14 05:39:39 +000034 <p>Written by <a href="http://llvm.org">The LLVM Team</a></p>
Chris Lattnere1972b12004-08-02 21:33:45 +000035</div>
36
Chris Lattnerfcc76882004-08-02 21:29:20 +000037<!--=======================================================================-->
Chris Lattner4c65c0e2006-06-20 20:54:47 +000038<div class="doc_section"><a name="llvmdesign">LLVM Design &amp; Overview</a></div>
Chris Lattnerfcc76882004-08-02 21:29:20 +000039<!--=======================================================================-->
Misha Brukmanad3e28c2004-04-06 04:22:43 +000040
Misha Brukman8e33fed2004-05-12 18:00:48 +000041<ul>
Chris Lattner4c65c0e2006-06-20 20:54:47 +000042<li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
43intermediate representation.</li>
Chris Lattner9fa620e2006-06-20 20:56:03 +000044<li><a href="http://llvm.org/pubs/2006-04-25-GelatoLLVMIntro.html">Introduction to the LLVM Compiler Infrastructure</a> - Presentation describing LLVM.</li>
45<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
50Multi-Stage Optimization</a> - More details (somewhat old now).</li>
Reid Spencere473e412006-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 Criswellac8b8c52006-06-20 18:21:31 +000053</ul>
54
55<!--=======================================================================-->
Chris Lattnerfcc76882004-08-02 21:29:20 +000056<div class="doc_section"><a name="userguide">LLVM User Guides</a></div>
57<!--=======================================================================-->
Misha Brukman8e33fed2004-05-12 18:00:48 +000058
Misha Brukman8e33fed2004-05-12 18:00:48 +000059<ul>
Chris Lattnerfcc76882004-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 Cohenc04c0db2005-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 Lattnerda043b62007-11-09 19:24:54 +000069<li><a href="tutorial/">LLVM Tutorial</a> - A walk through the process of using
Nick Lewycky70248c92007-11-09 05:45:51 +000070LLVM for a custom language, and the facilities LLVM offers in tutorial form.</li>
Reid Spencerd35e3642007-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 Spencerade052e52007-08-05 23:43:44 +000074<li><a href="/docs/CommandGuide/index.html">LLVM Command Guide</a> - A reference
Misha Brukman0091c262008-12-11 18:14:06 +000075manual for the LLVM command line utilities ("man" pages for LLVM tools).<br>
Reid Spencer9df63b42004-11-01 21:57:35 +000076Current tools:
Reid Spencerade052e52007-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 Spencer9df63b42004-11-01 21:57:35 +000095</li>
Chris Lattnerfcc76882004-08-02 21:29:20 +000096
Tanya Lattnera863cca2008-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 Lattner07414cb2004-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
Chris Lattnerfcc76882004-08-02 21:29:20 +0000103<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
Matthijs Kooijmana5d95542008-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 Lattnerfcc76882004-08-02 21:29:20 +0000112
Duncan Sands8aace1f2008-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 Lattner07414cb2004-08-02 21:32:08 +0000115
Chris Lattner85927a62004-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
Chris Lattnerbaf2b6e2004-08-02 21:37:11 +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
Misha Brukmana196c682004-09-06 20:58:44 +0000121using the mozilla browser, and have chatzilla installed, you can <a
122href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net</a> directly.</li>
Chris Lattner07414cb2004-08-02 21:32:08 +0000123
Misha Brukman8e33fed2004-05-12 18:00:48 +0000124</ul>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000125
Misha Brukman8e33fed2004-05-12 18:00:48 +0000126
Chris Lattnerfcc76882004-08-02 21:29:20 +0000127<!--=======================================================================-->
128<div class="doc_section"><a name="llvmprog">General LLVM Programming Documentation</a></div>
129<!--=======================================================================-->
Misha Brukman8e33fed2004-05-12 18:00:48 +0000130
Chris Lattnerfcc76882004-08-02 21:29:20 +0000131<ul>
Chris Lattner4c65c0e2006-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 Lattnerfcc76882004-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 Criswellf531f312003-10-27 18:18:16 +0000138
Chris Lattnerfcc76882004-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 Criswellf531f312003-10-27 18:18:16 +0000144
Chris Lattner024627b2004-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 Lattnerfcc76882004-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 Criswellf531f312003-10-27 18:18:16 +0000150
Chris Lattner024627b2004-10-25 19:39:46 +0000151<li><a href="CodingStandards.html">LLVM Coding standards</a> -
Chris Lattnerfcc76882004-08-02 21:29:20 +0000152Details the LLVM coding standards and provides useful information on writing
153efficient C++ code.</li>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000154
Chris Lattnerfcc76882004-08-02 21:29:20 +0000155<li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
156to add instructions and intrinsics to LLVM.</li>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000157
Reid Spencer0b40fdb2004-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 Spencer7c5df342006-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
Reid Spencerca058542006-03-14 05:39:39 +0000164<li><a href="http://llvm.org/doxygen/">Doxygen generated
Misha Brukman9976d342004-12-03 23:26:23 +0000165documentation</a> (<a
Reid Spencerca058542006-03-14 05:39:39 +0000166href="http://llvm.org/doxygen/inherits.html">classes</a>)
Chris Lattnerb2d8f042005-11-30 06:35:34 +0000167
Reid Spencerca058542006-03-14 05:39:39 +0000168(<a href="http://llvm.org/doxygen/doxygen.tar.gz">tarball</a>)
Chris Lattnerb2d8f042005-11-30 06:35:34 +0000169</li>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000170
Reid Spencerc7f87f22007-07-09 08:04:31 +0000171<li><a href="http://llvm.org/viewvc/">ViewVC Repository Browser</a></li>
John Criswellf531f312003-10-27 18:18:16 +0000172
Chris Lattnerfcc76882004-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 Brukmana0194212004-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 Lattnerfcc76882004-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 Lattnerfcc76882004-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
Chris Lattner79c2c382007-05-13 23:38:44 +0000208<li><a href="ExceptionHandling.html">Zero Cost Exception handling in LLVM</a>
209- This document describes the design and implementation of exception handling
210in LLVM.</li>
211
Misha Brukmana9ade832005-01-07 17:00:44 +0000212<li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
Misha Brukmanf4315372004-12-09 20:26:53 +0000213reducer description and usage information.</li>
Chris Lattnerfcc76882004-08-02 21:29:20 +0000214
Reid Spencercde8a13a2004-08-17 08:01:57 +0000215<li><a href="CompilerDriver.html">Compiler Driver (llvmc)</a> - This document
216describes the design and configuration of the LLVM compiler driver tool,
217<tt>llvmc</tt>.</li>
218
Chris Lattner8afd2f32008-07-13 21:27:36 +0000219<li><a href="BitCodeFormat.html">LLVM Bitcode File Format</a> - This describes
220the file format and encoding used for LLVM "bc" files.</li>
Chris Lattner4c65c0e2006-06-20 20:54:47 +0000221
Reid Spencer1d183c42005-01-05 19:01:20 +0000222<li><a href="SystemLibrary.html">System Library</a> - This document describes
223the LLVM System Library (<tt>lib/System</tt>) and how to keep LLVM source code
224portable</li>
225
Devang Patelb1ebbee2006-08-14 18:21:53 +0000226<li><a href="LinkTimeOptimization.html">Link Time Optimization</a> - This
227document describes the interface between LLVM intermodular optimizer and
228the linker and its design</li>
229
Chris Lattnerfcc76882004-08-02 21:29:20 +0000230</ul>
231
Reid Spencer7c5df342006-03-23 06:53:38 +0000232
Chris Lattnerfcc76882004-08-02 21:29:20 +0000233<!--=======================================================================-->
Chris Lattner07414cb2004-08-02 21:32:08 +0000234<div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div>
Chris Lattnerfcc76882004-08-02 21:29:20 +0000235<!--=======================================================================-->
236
237<ul>
Duncan Sandsd85a1662008-11-12 10:10:25 +0000238<li>The <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce">
Chris Lattnerfcc76882004-08-02 21:29:20 +0000239LLVM Announcements List</a>: This is a low volume list that provides important
240announcements regarding LLVM. It gets email about once a month.</li>
241
Duncan Sandsd85a1662008-11-12 10:10:25 +0000242<li>The <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
Chris Lattnerfcc76882004-08-02 21:29:20 +0000243List</a>: This list is for people who want to be included in technical
244discussions of LLVM. People post to this list when they have questions about
245writing code for or using the LLVM tools. It is relatively low volume.</li>
246
Duncan Sandsd85a1662008-11-12 10:10:25 +0000247<li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &amp;
Chris Lattnerfcc76882004-08-02 21:29:20 +0000248Patches Archive</a>: This list gets emailed every time a bug is opened and
249closed, and when people submit patches to be included in LLVM. It is higher
250volume than the LLVMdev list.</li>
251
Duncan Sandsd85a1662008-11-12 10:10:25 +0000252<li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/">Commits
Chris Lattnerfcc76882004-08-02 21:29:20 +0000253Archive</a>: This list contains all commit messages that are made when LLVM
Reid Spencerc7f87f22007-07-09 08:04:31 +0000254developers commit code changes to the repository. It is useful for those who
Chris Lattnerfcc76882004-08-02 21:29:20 +0000255want to stay on the bleeding edge of LLVM development. This list is very high
256volume.</li>
257
Duncan Sandsd85a1662008-11-12 10:10:25 +0000258<li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvm-testresults/">
Chris Lattner47b8bb02006-02-23 16:18:29 +0000259Test Results Archive</a>: A message is automatically sent to this list by every
Chris Lattner411f0df2006-02-23 16:14:22 +0000260active nightly tester when it completes. As such, this list gets email several
261times each day, making it a high volume list.</li>
262
Chris Lattnerfcc76882004-08-02 21:29:20 +0000263</ul>
John Criswellf531f312003-10-27 18:18:16 +0000264
Misha Brukman8e33fed2004-05-12 18:00:48 +0000265<!-- *********************************************************************** -->
John Criswellf531f312003-10-27 18:18:16 +0000266
267<hr>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000268<address>
269 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman86242e12008-12-11 17:34:48 +0000270 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000271 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman86242e12008-12-11 17:34:48 +0000272 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
John Criswellf531f312003-10-27 18:18:16 +0000273
Reid Spencerca058542006-03-14 05:39:39 +0000274 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000275 Last modified: $Date$
276</address>
Reid Spencer0b67f662007-07-01 17:02:22 +0000277</body></html>
Chris Lattner12477732007-09-21 17:30:40 +0000278