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