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