Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 4f60e4de90ed926fc012aa2e59118adb17062c7b / . / docs / index.html
blob: f3dcb18500ea4f7220bab083695efe645fe760fb [file] [log] [blame]
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]1<!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 +0000[diff] [blame]3<html>
Misha Brukman1e07e0c2004-04-06 04:22:43 +0000[diff] [blame]4<head>
Chris Lattner52fa42d2004-07-09 05:05:39 +0000[diff] [blame]5 <title>Documentation for the LLVM System</title>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]6 <link rel="stylesheet" href="llvm.css" type="text/css">
Misha Brukman1e07e0c2004-04-06 04:22:43 +0000[diff] [blame]7</head>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]8<body>
9
Chris Lattner52fa42d2004-07-09 05:05:39 +0000[diff] [blame]10<div class="doc_title">Documentation for the LLVM System</div>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]11
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]12<div class="doc_text">
Chris Lattner86d9b4c2005-04-23 15:55:18 +0000[diff] [blame]13<table class="layout" width="95%"><tr class="layout"><td class="left">
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]14<ul>
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]15 <li><a href="#llvmdesign">LLVM Design</a></li>
Reid Spencer20fdab62006-09-17 23:05:15 +0000[diff] [blame]16 <li><a href="/pubs/">LLVM Publications</a></li>
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]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>
Chris Lattner354a4422004-08-02 21:32:08 +0000[diff] [blame]20 <li><a href="#maillist">LLVM Mailing Lists</a></li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]21</ul>
Chris Lattner86d9b4c2005-04-23 15:55:18 +0000[diff] [blame]22</td><td class="right">
23 <form action="http://www.google.com/search" method=get>
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]24 <input type="hidden" name="sitesearch" value="llvm.org/docs">
Chris Lattner86d9b4c2005-04-23 15:55:18 +0000[diff] [blame]25 <input type=text name=q size=25><br>
26 <input type=submit value="Search the LLVM Docs" name="submit">
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]27 </form>
Chris Lattner86d9b4c2005-04-23 15:55:18 +0000[diff] [blame]28</td></tr></table>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]29</div>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]30
Chris Lattnerddd21842004-08-02 21:33:45 +0000[diff] [blame]31<div class="doc_author">
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]32 <p>Written by <a href="http://llvm.org">The LLVM Team</a></p>
Chris Lattnerddd21842004-08-02 21:33:45 +0000[diff] [blame]33</div>
34
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]35<!--=======================================================================-->
Chris Lattner4a463a32006-06-20 20:54:47 +0000[diff] [blame]36<div class="doc_section"><a name="llvmdesign">LLVM Design &amp; Overview</a></div>
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]37<!--=======================================================================-->
Misha Brukman1e07e0c2004-04-06 04:22:43 +0000[diff] [blame]38
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]39<ul>
Chris Lattner4a463a32006-06-20 20:54:47 +0000[diff] [blame]40<li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
41intermediate representation.</li>
Chris Lattnerfded8a22006-06-20 20:56:03 +0000[diff] [blame]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
44Infrastructure 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
46Lifelong Program Analysis &amp; Transformation</a> - Design overview.</li>
47<li><a href="http://llvm.org/pubs/2002-12-LattnerMSThesis.html">LLVM: An Infrastructure for
48Multi-Stage Optimization</a> - More details (somewhat old now).</li>
Reid Spencer7cbe67d2006-11-13 08:03:59 +0000[diff] [blame]49<li><a href="GetElementPtr.html">GetElementPtr FAQ</a> - Answers to some very
50frequent questions about LLVM's most frequently misunderstood instruction.</li>
John Criswella877f142006-06-20 18:21:31 +0000[diff] [blame]51</ul>
52
53<!--=======================================================================-->
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]54<div class="doc_section"><a name="userguide">LLVM User Guides</a></div>
55<!--=======================================================================-->
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]56
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]57<ul>
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]58<li><a href="GettingStarted.html">The LLVM Getting Started Guide</a> -
59Discusses how to get up and running quickly with the LLVM infrastructure.
60Everything from unpacking and compilation of the distribution to execution of
61some tools.</li>
62
Jeff Cohenb9a47d12005-02-01 15:59:28 +0000[diff] [blame]63<li><a href="GettingStartedVS.html">Getting Started with the LLVM System using
64Microsoft Visual Studio</a> - An addendum to the main Getting Started guide for
65those using Visual Studio on Windows.</li>
66
Chris Lattner1b024ce2007-11-09 19:24:54 +0000[diff] [blame]67<li><a href="tutorial/">LLVM Tutorial</a> - A walk through the process of using
Nick Lewyckycf326da2007-11-09 05:45:51 +0000[diff] [blame]68LLVM for a custom language, and the facilities LLVM offers in tutorial form.</li>
Reid Spencer26cf0662007-02-13 09:08:27 +0000[diff] [blame]69<li><a href="DeveloperPolicy.html">Developer Policy</a> - The LLVM project's
70policy towards developers and their contributions.</li>
71
Reid Spencer944b7f22007-08-05 23:43:44 +0000[diff] [blame]72<li><a href="/docs/CommandGuide/index.html">LLVM Command Guide</a> - A reference
Reid Spencer31f841b2004-11-01 21:57:35 +0000[diff] [blame]73manual for the LLVM command line utilities ("man" pages for LLVM tools).<br/>
74Current tools:
Reid Spencer944b7f22007-08-05 23:43:44 +0000[diff] [blame]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>,
Reid Spencer31f841b2004-11-01 21:57:35 +0000[diff] [blame]93</li>
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]94
Tanya Lattner20b7bda2008-03-24 18:29:32 +0000[diff] [blame]95<li><a href="Passes.html">LLVM's Analysis and Transform Passes</a> - A list of
96optimizations and analyses implemented in LLVM.</li>
97
Chris Lattner354a4422004-08-02 21:32:08 +0000[diff] [blame]98<li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
99questions and problems and their solutions.</li>
100
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]101<li><a href="ReleaseNotes.html">Release notes for the current release</a>
102- This describes new features, known bugs, and other limitations.</li>
103
104<li><a href="HowToSubmitABug.html">How to Submit A Bug Report</a> -
105Instructions for properly submitting information about any bugs you run into in
106the LLVM system.</li>
107
Matthijs Kooijman9d3edca2008-07-02 13:54:58 +0000[diff] [blame]108<li><a href="TestingGuide.html">LLVM Testing Infrastructure Guide</a> - A reference
109manual for using the LLVM testing infrastructure.</li>
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]110
Duncan Sands8655b152008-02-14 17:53:22 +0000[diff] [blame]111<li><a href="GCCFEBuildInstrs.html">How to build the C/C++ front-end</a> -
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]112Instructions for building the front-end from source.</li>
Chris Lattner354a4422004-08-02 21:32:08 +0000[diff] [blame]113
Chris Lattnerd404d7f2004-09-19 23:15:47 +0000[diff] [blame]114<li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
115and concepts used in LLVM.</li>
116
Chris Lattner17d3efc2004-08-02 21:37:11 +0000[diff] [blame]117<li><a name="irc">You can probably find help on the unofficial LLVM IRC
118channel</a>. We often are on irc.oftc.net in the #llvm channel. If you are
Misha Brukman0b9370f2004-09-06 20:58:44 +0000[diff] [blame]119using the mozilla browser, and have chatzilla installed, you can <a
120href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net</a> directly.</li>
Chris Lattner354a4422004-08-02 21:32:08 +0000[diff] [blame]121
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]122</ul>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]123
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]124
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]125<!--=======================================================================-->
126<div class="doc_section"><a name="llvmprog">General LLVM Programming Documentation</a></div>
127<!--=======================================================================-->
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]128
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]129<ul>
Chris Lattner4a463a32006-06-20 20:54:47 +0000[diff] [blame]130<li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
131intermediate representation and the assembly form of the different nodes.</li>
132
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]133<li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
134Introduction to the general layout of the LLVM sourcebase, important classes
135and APIs, and some tips &amp; tricks.</li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]136
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]137<li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
138templates for new projects that <em>use</em> the LLVM infrastructure. The
139templates (directory organization, Makefiles, and test tree) allow the project
140code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
141header files and libraries.</li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]142
Chris Lattner4c871b52004-10-25 19:39:46 +0000[diff] [blame]143<li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
144LLVM makefiles work and how to use them.</li>
145
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]146<li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
147Provides information on using the command line parsing library.</li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]148
Chris Lattner4c871b52004-10-25 19:39:46 +0000[diff] [blame]149<li><a href="CodingStandards.html">LLVM Coding standards</a> -
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]150Details the LLVM coding standards and provides useful information on writing
151efficient C++ code.</li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]152
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]153<li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
154to add instructions and intrinsics to LLVM.</li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]155
Reid Spencer0a727fc2004-10-31 23:02:38 +0000[diff] [blame]156<li><a href="UsingLibraries.html">Using LLVM Libraries</a> - Look here to
157understand how to use the libraries produced when LLVM is compiled.</li>
158
Reid Spencer7df8e262006-03-23 06:53:38 +0000[diff] [blame]159<li><a href="HowToReleaseLLVM.html">How To Release LLVM To The Public</a> - This
160is a guide to preparing LLVM releases. Most developers can ignore it.</li>
161
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]162<li><a href="http://llvm.org/doxygen/">Doxygen generated
Misha Brukmane539a2b2004-12-03 23:26:23 +0000[diff] [blame]163documentation</a> (<a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]164href="http://llvm.org/doxygen/inherits.html">classes</a>)
Chris Lattnere2667312005-11-30 06:35:34 +0000[diff] [blame]165
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]166(<a href="http://llvm.org/doxygen/doxygen.tar.gz">tarball</a>)
Chris Lattnere2667312005-11-30 06:35:34 +0000[diff] [blame]167</li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]168
Reid Spencer669ed452007-07-09 08:04:31 +0000[diff] [blame]169<li><a href="http://llvm.org/viewvc/">ViewVC Repository Browser</a></li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]170
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]171</ul>
172
173<!--=======================================================================-->
174<div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div>
175<!--=======================================================================-->
176
177<ul>
178
179<li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
180on how to write LLVM transformations and analyses.</li>
181
Misha Brukman96bba382004-09-06 23:00:01 +0000[diff] [blame]182<li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
183on how to write LLVM backends for machine targets.</li>
184
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]185<li><a href="CodeGenerator.html">The LLVM Target-Independent Code
186Generator</a> - The design and implementation of the LLVM code generator.
187Useful if you are working on retargetting LLVM to a new architecture, designing
188a new codegen pass, or enhancing existing components.</li>
189
190<li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
191Describes the TableGen tool, which is used heavily by the LLVM code
192generator.</li>
193
194<li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
195on how to write a new alias analysis implementation or how to use existing
196analyses.</li>
197
John Criswell98d06362004-11-21 14:58:12 +0000[diff] [blame]198<li><a href="Stacker.html">The Stacker Chronicles</a> - This document
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]199describes both the Stacker language and LLVM frontend, but also some details
200about LLVM useful for those writing front-ends.</li>
201
202<li><a href="GarbageCollection.html">Accurate Garbage Collection with
203LLVM</a> - The interfaces source-language compilers should use for compiling
204GC'd programs.</li>
205
206<li><a href="SourceLevelDebugging.html">Source Level Debugging with
207LLVM</a> - This document describes the design and philosophy behind the LLVM
208source-level debugger.</li>
209
Chris Lattner92734182007-05-13 23:38:44 +0000[diff] [blame]210<li><a href="ExceptionHandling.html">Zero Cost Exception handling in LLVM</a>
211- This document describes the design and implementation of exception handling
212in LLVM.</li>
213
Misha Brukman9e3bdf12005-01-07 17:00:44 +0000[diff] [blame]214<li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
Misha Brukman3df00a02004-12-09 20:26:53 +0000[diff] [blame]215reducer description and usage information.</li>
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]216
Reid Spencer2d1e01c2004-08-17 08:01:57 +0000[diff] [blame]217<li><a href="CompilerDriver.html">Compiler Driver (llvmc)</a> - This document
218describes the design and configuration of the LLVM compiler driver tool,
219<tt>llvmc</tt>.</li>
220
Chris Lattner4f60e4d2008-07-13 21:27:36 +0000[diff] [blame^]221<li><a href="BitCodeFormat.html">LLVM Bitcode File Format</a> - This describes
222the file format and encoding used for LLVM "bc" files.</li>
Chris Lattner4a463a32006-06-20 20:54:47 +0000[diff] [blame]223
Reid Spencer8853b132005-01-05 19:01:20 +0000[diff] [blame]224<li><a href="SystemLibrary.html">System Library</a> - This document describes
225the LLVM System Library (<tt>lib/System</tt>) and how to keep LLVM source code
226portable</li>
227
Devang Patelde4bbd92006-08-14 18:21:53 +0000[diff] [blame]228<li><a href="LinkTimeOptimization.html">Link Time Optimization</a> - This
229document describes the interface between LLVM intermodular optimizer and
230the linker and its design</li>
231
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]232</ul>
233
Reid Spencer7df8e262006-03-23 06:53:38 +0000[diff] [blame]234
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]235<!--=======================================================================-->
Chris Lattner354a4422004-08-02 21:32:08 +0000[diff] [blame]236<div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div>
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]237<!--=======================================================================-->
238
239<ul>
240<li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
241LLVM Announcements List</a>: This is a low volume list that provides important
242announcements regarding LLVM. It gets email about once a month.</li>
243
244<li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
245List</a>: This list is for people who want to be included in technical
246discussions of LLVM. People post to this list when they have questions about
247writing code for or using the LLVM tools. It is relatively low volume.</li>
248
249<li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &amp;
250Patches Archive</a>: This list gets emailed every time a bug is opened and
251closed, and when people submit patches to be included in LLVM. It is higher
252volume than the LLVMdev list.</li>
253
Reid Spencer669ed452007-07-09 08:04:31 +0000[diff] [blame]254<li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-commits/">Commits
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]255Archive</a>: This list contains all commit messages that are made when LLVM
Reid Spencer669ed452007-07-09 08:04:31 +0000[diff] [blame]256developers commit code changes to the repository. It is useful for those who
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]257want to stay on the bleeding edge of LLVM development. This list is very high
258volume.</li>
259
Chris Lattner1914bf12006-02-23 16:14:22 +0000[diff] [blame]260<li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-testresults/">
Chris Lattner77186582006-02-23 16:18:29 +0000[diff] [blame]261Test Results Archive</a>: A message is automatically sent to this list by every
Chris Lattner1914bf12006-02-23 16:14:22 +0000[diff] [blame]262active nightly tester when it completes. As such, this list gets email several
263times each day, making it a high volume list.</li>
264
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]265</ul>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]266
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]267<!-- *********************************************************************** -->
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]268
269<hr>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]270<address>
271 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
272 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
273 <a href="http://validator.w3.org/check/referer"><img
274 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]275
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]276 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]277 Last modified: $Date$
278</address>
Reid Spencer6fdb2362007-07-01 17:02:22 +0000[diff] [blame]279</body></html>
Chris Lattner1df4f752007-09-21 17:30:40 +0000[diff] [blame]280