Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 86d9b4c36fb31f6d45e4484bcfdd876366ac9ebb / . / docs / index.html
blob: 956d0ca68491a04340860e925843c1eac6bf9560 [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>
16 <li><a href="#userguide">LLVM User Guides</a></li>
17 <li><a href="#llvmprog">General LLVM Programming Documentation</a></li>
18 <li><a href="#subsystems">LLVM Subsystem Documentation</a></li>
Chris Lattner354a4422004-08-02 21:32:08 +0000[diff] [blame]19 <li><a href="#maillist">LLVM Mailing Lists</a></li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]20</ul>
Chris Lattner86d9b4c2005-04-23 15:55:18 +0000[diff] [blame^]21</td><td class="right">
22 <form action="http://www.google.com/search" method=get>
23 <input type="hidden" name="output" value="googleabout">
24 <input type="hidden" name="sitesearch" value="llvm.cs.uiuc.edu/docs">
25 <input type=text name=q size=25><br>
26 <input type=submit value="Search the LLVM Docs" name="submit">
27 </form>
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">
32 <p>Written by <a href="http://llvm.cs.uiuc.edu">The LLVM Team</a></p>
33</div>
34
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]35<!--=======================================================================-->
36<div class="doc_section"><a name="llvmdesign">LLVM Design</a></div>
37<!--=======================================================================-->
Misha Brukman1e07e0c2004-04-06 04:22:43 +0000[diff] [blame]38
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]39<ul>
Misha Brukmand54fe672004-09-09 16:18:40 +0000[diff] [blame]40<li><a href="http://llvm.cs.uiuc.edu/pubs/2004-01-30-CGO-LLVM.html">LLVM: A
41Compilation Framework for Lifelong Program Analysis &amp; Transformation</a>: -
42Describes the LLVM instruction set and compilation strategy. This should be the
43first document you read to get an overview of LLVM.</li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]44
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]45<li><a href="LangRef.html">LLVM Reference Manual</a> - Defines the LLVM
46intermediate representation, the assembly form of the different nodes, and
47provides reference information about the different tools in LLVM.</li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]48
Reid Spencer50026612004-05-22 02:28:36 +0000[diff] [blame]49<li><a href="BytecodeFormat.html">LLVM Bytecode File Format</a></li>
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]50
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]51</ul>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]52
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]53<!--=======================================================================-->
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>,
87 <a href="CommandGuide/html/extract.html">extract</a>,
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>
124<li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
125Introduction to the general layout of the LLVM sourcebase, important classes
126and APIs, and some tips &amp; tricks.</li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]127
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]128<li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
129templates for new projects that <em>use</em> the LLVM infrastructure. The
130templates (directory organization, Makefiles, and test tree) allow the project
131code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
132header files and libraries.</li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]133
Chris Lattner4c871b52004-10-25 19:39:46 +0000[diff] [blame]134<li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
135LLVM makefiles work and how to use them.</li>
136
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]137<li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
138Provides information on using the command line parsing library.</li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]139
Chris Lattner4c871b52004-10-25 19:39:46 +0000[diff] [blame]140<li><a href="CodingStandards.html">LLVM Coding standards</a> -
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]141Details the LLVM coding standards and provides useful information on writing
142efficient C++ code.</li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]143
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]144<li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
145to add instructions and intrinsics to LLVM.</li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]146
Reid Spencer0a727fc2004-10-31 23:02:38 +0000[diff] [blame]147<li><a href="UsingLibraries.html">Using LLVM Libraries</a> - Look here to
148understand how to use the libraries produced when LLVM is compiled.</li>
149
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]150<li><a href="http://llvm.cs.uiuc.edu/doxygen/">Doxygen generated
Misha Brukmane539a2b2004-12-03 23:26:23 +0000[diff] [blame]151documentation</a> (<a
152href="http://llvm.cs.uiuc.edu/doxygen/inherits.html">classes</a>)</li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]153
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]154<li><a href="http://llvm.cs.uiuc.edu/cvsweb/cvsweb.cgi/llvm">CVSWeb CVS Tree
155Browser</a></li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]156
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]157</ul>
158
159<!--=======================================================================-->
160<div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div>
161<!--=======================================================================-->
162
163<ul>
164
165<li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
166on how to write LLVM transformations and analyses.</li>
167
Misha Brukman96bba382004-09-06 23:00:01 +0000[diff] [blame]168<li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
169on how to write LLVM backends for machine targets.</li>
170
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]171<li><a href="CodeGenerator.html">The LLVM Target-Independent Code
172Generator</a> - The design and implementation of the LLVM code generator.
173Useful if you are working on retargetting LLVM to a new architecture, designing
174a new codegen pass, or enhancing existing components.</li>
175
176<li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
177Describes the TableGen tool, which is used heavily by the LLVM code
178generator.</li>
179
180<li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
181on how to write a new alias analysis implementation or how to use existing
182analyses.</li>
183
John Criswell98d06362004-11-21 14:58:12 +0000[diff] [blame]184<li><a href="Stacker.html">The Stacker Chronicles</a> - This document
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]185describes both the Stacker language and LLVM frontend, but also some details
186about LLVM useful for those writing front-ends.</li>
187
188<li><a href="GarbageCollection.html">Accurate Garbage Collection with
189LLVM</a> - The interfaces source-language compilers should use for compiling
190GC'd programs.</li>
191
192<li><a href="SourceLevelDebugging.html">Source Level Debugging with
193LLVM</a> - This document describes the design and philosophy behind the LLVM
194source-level debugger.</li>
195
Misha Brukman9e3bdf12005-01-07 17:00:44 +0000[diff] [blame]196<li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
Misha Brukman3df00a02004-12-09 20:26:53 +0000[diff] [blame]197reducer description and usage information.</li>
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]198
Reid Spencer2d1e01c2004-08-17 08:01:57 +0000[diff] [blame]199<li><a href="CompilerDriver.html">Compiler Driver (llvmc)</a> - This document
200describes the design and configuration of the LLVM compiler driver tool,
201<tt>llvmc</tt>.</li>
202
Reid Spencer8853b132005-01-05 19:01:20 +0000[diff] [blame]203<li><a href="SystemLibrary.html">System Library</a> - This document describes
204the LLVM System Library (<tt>lib/System</tt>) and how to keep LLVM source code
205portable</li>
206
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]207</ul>
208
209<!--=======================================================================-->
Chris Lattner354a4422004-08-02 21:32:08 +0000[diff] [blame]210<div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div>
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]211<!--=======================================================================-->
212
213<ul>
214<li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
215LLVM Announcements List</a>: This is a low volume list that provides important
216announcements regarding LLVM. It gets email about once a month.</li>
217
218<li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
219List</a>: This list is for people who want to be included in technical
220discussions of LLVM. People post to this list when they have questions about
221writing code for or using the LLVM tools. It is relatively low volume.</li>
222
223<li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &amp;
224Patches Archive</a>: This list gets emailed every time a bug is opened and
225closed, and when people submit patches to be included in LLVM. It is higher
226volume than the LLVMdev list.</li>
227
228<li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-commits/">CVS Commits
229Archive</a>: This list contains all commit messages that are made when LLVM
230developers commit code changes to the CVS archive. It is useful for those who
231want to stay on the bleeding edge of LLVM development. This list is very high
232volume.</li>
233
234</ul>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]235
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]236<!-- *********************************************************************** -->
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]237
238<hr>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]239<address>
240 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
241 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
242 <a href="http://validator.w3.org/check/referer"><img
243 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]244
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]245 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
246 Last modified: $Date$
247</address>
Misha Brukman1e07e0c2004-04-06 04:22:43 +0000[diff] [blame]248