Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 4a463a352ffb1b743822c009a3b77a6c0b671447 / . / docs / index.html
blob: 4c76b5f76cbaeea55fdf580e9d71a508dd5bd203 [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>
John Criswella877f142006-06-20 18:21:31 +0000[diff] [blame]16 <li><a href="#llvmpubs">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>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]42
Chris Lattnera2bc7b02006-06-20 20:47:38 +0000[diff] [blame]43<li>"<a href="http://llvm.org/pubs/2006-04-25-GelatoLLVMIntro.html">Introduction to the LLVM Compiler Infrastructure</a>" - Presentation describing LLVM.</li>
44<li>"<a href="http://llvm.org/pubs/2004-09-22-LCPCLLVMTutorial.html">The LLVM Compiler Framework and
45Infrastructure Tutorial</a>" - Tutorial for writing passes, exploring the system.</li>
46<li>"<a href="http://llvm.org/pubs/2004-01-30-CGO-LLVM.html">LLVM: A Compilation Framework for
47Lifelong Program Analysis &amp; Transformation</a>" - Design overview.</li>
48<li>"<a href="http://llvm.org/pubs/2002-12-LattnerMSThesis.html">LLVM: An Infrastructure for
49Multi-Stage Optimization</a>" - More details (somewhat old now).</li>
Chris Lattner4a463a32006-06-20 20:54:47 +0000[diff] [blame^]50
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
John Criswella6536562004-08-16 15:19:02 +0000[diff] [blame]67<li><a href="CommandGuide/index.html">LLVM Command Guide</a> - A reference
Reid Spencer31f841b2004-11-01 21:57:35 +0000[diff] [blame]68manual for the LLVM command line utilities ("man" pages for LLVM tools).<br/>
69Current tools:
Reid Spencer0aa18992004-11-11 09:30:00 +0000[diff] [blame]70 <a href="CommandGuide/html/llvm-ar.html">llvm-ar</a>,
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]71 <a href="CommandGuide/html/llvm-ranlib.html">llvm-ranlib</a>,
Reid Spencer31f841b2004-11-01 21:57:35 +0000[diff] [blame]72 <a href="CommandGuide/html/llvm-as.html">llvm-as</a>,
73 <a href="CommandGuide/html/llvm-dis.html">llvm-dis</a>,
74 <a href="CommandGuide/html/opt.html">opt</a>,
75 <a href="CommandGuide/html/llc.html">llc</a>,
76 <a href="CommandGuide/html/lli.html">lli</a>,
77 <a href="CommandGuide/html/llvm-link.html">llvm-link</a>,
78 <a href="CommandGuide/html/analyze.html">analyze</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/llvmgcc.html">llvmgcc</a>,
82 <a href="CommandGuide/html/llvmgxx.html">llvmgxx</a>,
83 <a href="CommandGuide/html/gccas.html">gccas</a>,
84 <a href="CommandGuide/html/gccld.html">gccld</a>,
85 <a href="CommandGuide/html/stkrc.html">stkrc</a>,
86 <a href="CommandGuide/html/bugpoint.html">bugpoint</a>,
Misha Brukman4e8458d2005-04-24 17:46:58 +0000[diff] [blame]87 <a href="CommandGuide/html/llvm-extract.html">llvm-extract</a>,
Reid Spencer31f841b2004-11-01 21:57:35 +0000[diff] [blame]88 <a href="CommandGuide/html/llvm-bcanalyzer.html">llvm-bcanalyzer</a>,
89 <a href="CommandGuide/html/llvmc.html">llvmc</a>
90</li>
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]91
Chris Lattner354a4422004-08-02 21:32:08 +0000[diff] [blame]92<li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
93questions and problems and their solutions.</li>
94
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]95<li><a href="ReleaseNotes.html">Release notes for the current release</a>
96- This describes new features, known bugs, and other limitations.</li>
97
98<li><a href="HowToSubmitABug.html">How to Submit A Bug Report</a> -
99Instructions for properly submitting information about any bugs you run into in
100the LLVM system.</li>
101
102<li><a href="TestingGuide.html">LLVM Test Suite Guide</a> - A reference
103manual for using the LLVM test suite.</li>
104
105<li><a href="CFEBuildInstrs.html">How to build the C/C++ front-end</a> -
106Instructions for building the front-end from source.</li>
Chris Lattner354a4422004-08-02 21:32:08 +0000[diff] [blame]107
Chris Lattnerd404d7f2004-09-19 23:15:47 +0000[diff] [blame]108<li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
109and concepts used in LLVM.</li>
110
Chris Lattner17d3efc2004-08-02 21:37:11 +0000[diff] [blame]111<li><a name="irc">You can probably find help on the unofficial LLVM IRC
112channel</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]113using the mozilla browser, and have chatzilla installed, you can <a
114href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net</a> directly.</li>
Chris Lattner354a4422004-08-02 21:32:08 +0000[diff] [blame]115
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]116</ul>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]117
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]118
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]119<!--=======================================================================-->
120<div class="doc_section"><a name="llvmprog">General LLVM Programming Documentation</a></div>
121<!--=======================================================================-->
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]122
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]123<ul>
Chris Lattner4a463a32006-06-20 20:54:47 +0000[diff] [blame^]124<li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
125intermediate representation and the assembly form of the different nodes.</li>
126
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]127<li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
128Introduction to the general layout of the LLVM sourcebase, important classes
129and APIs, and some tips &amp; tricks.</li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]130
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]131<li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
132templates for new projects that <em>use</em> the LLVM infrastructure. The
133templates (directory organization, Makefiles, and test tree) allow the project
134code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
135header files and libraries.</li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]136
Chris Lattner4c871b52004-10-25 19:39:46 +0000[diff] [blame]137<li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
138LLVM makefiles work and how to use them.</li>
139
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]140<li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
141Provides information on using the command line parsing library.</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="CodingStandards.html">LLVM Coding standards</a> -
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]144Details the LLVM coding standards and provides useful information on writing
145efficient C++ code.</li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]146
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]147<li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
148to add instructions and intrinsics to LLVM.</li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]149
Reid Spencer0a727fc2004-10-31 23:02:38 +0000[diff] [blame]150<li><a href="UsingLibraries.html">Using LLVM Libraries</a> - Look here to
151understand how to use the libraries produced when LLVM is compiled.</li>
152
Reid Spencer7df8e262006-03-23 06:53:38 +0000[diff] [blame]153<li><a href="HowToReleaseLLVM.html">How To Release LLVM To The Public</a> - This
154is a guide to preparing LLVM releases. Most developers can ignore it.</li>
155
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]156<li><a href="http://llvm.org/doxygen/">Doxygen generated
Misha Brukmane539a2b2004-12-03 23:26:23 +0000[diff] [blame]157documentation</a> (<a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]158href="http://llvm.org/doxygen/inherits.html">classes</a>)
Chris Lattnere2667312005-11-30 06:35:34 +0000[diff] [blame]159
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]160(<a href="http://llvm.org/doxygen/doxygen.tar.gz">tarball</a>)
Chris Lattnere2667312005-11-30 06:35:34 +0000[diff] [blame]161</li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]162
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]163<li><a href="http://llvm.org/cvsweb/cvsweb.cgi/llvm">CVSWeb CVS Tree
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]164Browser</a></li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]165
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]166</ul>
167
168<!--=======================================================================-->
169<div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div>
170<!--=======================================================================-->
171
172<ul>
173
174<li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
175on how to write LLVM transformations and analyses.</li>
176
Misha Brukman96bba382004-09-06 23:00:01 +0000[diff] [blame]177<li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
178on how to write LLVM backends for machine targets.</li>
179
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]180<li><a href="CodeGenerator.html">The LLVM Target-Independent Code
181Generator</a> - The design and implementation of the LLVM code generator.
182Useful if you are working on retargetting LLVM to a new architecture, designing
183a new codegen pass, or enhancing existing components.</li>
184
185<li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
186Describes the TableGen tool, which is used heavily by the LLVM code
187generator.</li>
188
189<li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
190on how to write a new alias analysis implementation or how to use existing
191analyses.</li>
192
John Criswell98d06362004-11-21 14:58:12 +0000[diff] [blame]193<li><a href="Stacker.html">The Stacker Chronicles</a> - This document
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]194describes both the Stacker language and LLVM frontend, but also some details
195about LLVM useful for those writing front-ends.</li>
196
197<li><a href="GarbageCollection.html">Accurate Garbage Collection with
198LLVM</a> - The interfaces source-language compilers should use for compiling
199GC'd programs.</li>
200
201<li><a href="SourceLevelDebugging.html">Source Level Debugging with
202LLVM</a> - This document describes the design and philosophy behind the LLVM
203source-level debugger.</li>
204
Misha Brukman9e3bdf12005-01-07 17:00:44 +0000[diff] [blame]205<li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
Misha Brukman3df00a02004-12-09 20:26:53 +0000[diff] [blame]206reducer description and usage information.</li>
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]207
Reid Spencer2d1e01c2004-08-17 08:01:57 +0000[diff] [blame]208<li><a href="CompilerDriver.html">Compiler Driver (llvmc)</a> - This document
209describes the design and configuration of the LLVM compiler driver tool,
210<tt>llvmc</tt>.</li>
211
Chris Lattner4a463a32006-06-20 20:54:47 +0000[diff] [blame^]212<li><a href="BytecodeFormat.html">LLVM Bytecode File Format</a></li>
213
Reid Spencer8853b132005-01-05 19:01:20 +0000[diff] [blame]214<li><a href="SystemLibrary.html">System Library</a> - This document describes
215the LLVM System Library (<tt>lib/System</tt>) and how to keep LLVM source code
216portable</li>
217
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]218</ul>
219
Reid Spencer7df8e262006-03-23 06:53:38 +0000[diff] [blame]220
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]221<!--=======================================================================-->
Chris Lattner354a4422004-08-02 21:32:08 +0000[diff] [blame]222<div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div>
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]223<!--=======================================================================-->
224
225<ul>
226<li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
227LLVM Announcements List</a>: This is a low volume list that provides important
228announcements regarding LLVM. It gets email about once a month.</li>
229
230<li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
231List</a>: This list is for people who want to be included in technical
232discussions of LLVM. People post to this list when they have questions about
233writing code for or using the LLVM tools. It is relatively low volume.</li>
234
235<li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &amp;
236Patches Archive</a>: This list gets emailed every time a bug is opened and
237closed, and when people submit patches to be included in LLVM. It is higher
238volume than the LLVMdev list.</li>
239
240<li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-commits/">CVS Commits
241Archive</a>: This list contains all commit messages that are made when LLVM
242developers commit code changes to the CVS archive. It is useful for those who
243want to stay on the bleeding edge of LLVM development. This list is very high
244volume.</li>
245
Chris Lattner1914bf12006-02-23 16:14:22 +0000[diff] [blame]246<li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-testresults/">
Chris Lattner77186582006-02-23 16:18:29 +0000[diff] [blame]247Test Results Archive</a>: A message is automatically sent to this list by every
Chris Lattner1914bf12006-02-23 16:14:22 +0000[diff] [blame]248active nightly tester when it completes. As such, this list gets email several
249times each day, making it a high volume list.</li>
250
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]251</ul>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]252
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]253<!-- *********************************************************************** -->
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]254
255<hr>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]256<address>
257 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
258 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
259 <a href="http://validator.w3.org/check/referer"><img
260 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]261
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]262 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]263 Last modified: $Date$
264</address>
Misha Brukman1e07e0c2004-04-06 04:22:43 +0000[diff] [blame]265