Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 9273418777fb0c25da9067d6eec57402a504e94e / . / docs / index.html
blob: 886688d8926234c74d15fa5f1dd41b6f5fc5e258 [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
Reid Spencer26cf0662007-02-13 09:08:27 +0000[diff] [blame]67<li><a href="DeveloperPolicy.html">Developer Policy</a> - The LLVM project's
68policy towards developers and their contributions.</li>
69
John Criswella6536562004-08-16 15:19:02 +0000[diff] [blame]70<li><a href="CommandGuide/index.html">LLVM Command Guide</a> - A reference
Reid Spencer31f841b2004-11-01 21:57:35 +0000[diff] [blame]71manual for the LLVM command line utilities ("man" pages for LLVM tools).<br/>
72Current tools:
Reid Spencer0aa18992004-11-11 09:30:00 +0000[diff] [blame]73 <a href="CommandGuide/html/llvm-ar.html">llvm-ar</a>,
Reid Spencer31f841b2004-11-01 21:57:35 +0000[diff] [blame]74 <a href="CommandGuide/html/llvm-as.html">llvm-as</a>,
75 <a href="CommandGuide/html/llvm-dis.html">llvm-dis</a>,
Reid Spencer434262a2007-02-09 15:59:08 +0000[diff] [blame]76 <a href="CommandGuide/html/llvm-extract.html">llvm-extract</a>,
77 <a href="CommandGuide/html/llvm-ld.html">llvm-ld</a>,
Reid Spencer31f841b2004-11-01 21:57:35 +0000[diff] [blame]78 <a href="CommandGuide/html/llvm-link.html">llvm-link</a>,
Reid Spencer31f841b2004-11-01 21:57:35 +0000[diff] [blame]79 <a href="CommandGuide/html/llvm-nm.html">llvm-nm</a>,
80 <a href="CommandGuide/html/llvm-prof.html">llvm-prof</a>,
Reid Spencer434262a2007-02-09 15:59:08 +0000[diff] [blame]81 <a href="CommandGuide/html/llvm-ranlib.html">llvm-ranlib</a>,
82 <a href="CommandGuide/html/opt.html">opt</a>,
83 <a href="CommandGuide/html/llc.html">llc</a>,
84 <a href="CommandGuide/html/lli.html">lli</a>,
85 <a href="CommandGuide/html/llvmc.html">llvmc</a>
86 <a href="CommandGuide/html/llvmgcc.html">llvm-gcc</a>,
87 <a href="CommandGuide/html/llvmgxx.html">llvm-g++</a>,
Reid Spencer31f841b2004-11-01 21:57:35 +0000[diff] [blame]88 <a href="CommandGuide/html/stkrc.html">stkrc</a>,
89 <a href="CommandGuide/html/bugpoint.html">bugpoint</a>,
Reid Spencer31f841b2004-11-01 21:57:35 +0000[diff] [blame]90 <a href="CommandGuide/html/llvm-bcanalyzer.html">llvm-bcanalyzer</a>,
Reid Spencer31f841b2004-11-01 21:57:35 +0000[diff] [blame]91</li>
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]92
Chris Lattner354a4422004-08-02 21:32:08 +0000[diff] [blame]93<li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
94questions and problems and their solutions.</li>
95
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]96<li><a href="ReleaseNotes.html">Release notes for the current release</a>
97- This describes new features, known bugs, and other limitations.</li>
98
99<li><a href="HowToSubmitABug.html">How to Submit A Bug Report</a> -
100Instructions for properly submitting information about any bugs you run into in
101the LLVM system.</li>
102
103<li><a href="TestingGuide.html">LLVM Test Suite Guide</a> - A reference
104manual for using the LLVM test suite.</li>
105
106<li><a href="CFEBuildInstrs.html">How to build the C/C++ front-end</a> -
107Instructions for building the front-end from source.</li>
Chris Lattner354a4422004-08-02 21:32:08 +0000[diff] [blame]108
Chris Lattnerd404d7f2004-09-19 23:15:47 +0000[diff] [blame]109<li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
110and concepts used in LLVM.</li>
111
Chris Lattner17d3efc2004-08-02 21:37:11 +0000[diff] [blame]112<li><a name="irc">You can probably find help on the unofficial LLVM IRC
113channel</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]114using the mozilla browser, and have chatzilla installed, you can <a
115href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net</a> directly.</li>
Chris Lattner354a4422004-08-02 21:32:08 +0000[diff] [blame]116
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]117</ul>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]118
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]119
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]120<!--=======================================================================-->
121<div class="doc_section"><a name="llvmprog">General LLVM Programming Documentation</a></div>
122<!--=======================================================================-->
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]123
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]124<ul>
Chris Lattner4a463a32006-06-20 20:54:47 +0000[diff] [blame]125<li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
126intermediate representation and the assembly form of the different nodes.</li>
127
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]128<li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
129Introduction to the general layout of the LLVM sourcebase, important classes
130and APIs, and some tips &amp; tricks.</li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]131
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]132<li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
133templates for new projects that <em>use</em> the LLVM infrastructure. The
134templates (directory organization, Makefiles, and test tree) allow the project
135code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
136header files and libraries.</li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]137
Chris Lattner4c871b52004-10-25 19:39:46 +0000[diff] [blame]138<li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
139LLVM makefiles work and how to use them.</li>
140
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]141<li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
142Provides information on using the command line parsing library.</li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]143
Chris Lattner4c871b52004-10-25 19:39:46 +0000[diff] [blame]144<li><a href="CodingStandards.html">LLVM Coding standards</a> -
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]145Details the LLVM coding standards and provides useful information on writing
146efficient C++ code.</li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]147
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]148<li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
149to add instructions and intrinsics to LLVM.</li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]150
Reid Spencer0a727fc2004-10-31 23:02:38 +0000[diff] [blame]151<li><a href="UsingLibraries.html">Using LLVM Libraries</a> - Look here to
152understand how to use the libraries produced when LLVM is compiled.</li>
153
Reid Spencer7df8e262006-03-23 06:53:38 +0000[diff] [blame]154<li><a href="HowToReleaseLLVM.html">How To Release LLVM To The Public</a> - This
155is a guide to preparing LLVM releases. Most developers can ignore it.</li>
156
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]157<li><a href="http://llvm.org/doxygen/">Doxygen generated
Misha Brukmane539a2b2004-12-03 23:26:23 +0000[diff] [blame]158documentation</a> (<a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]159href="http://llvm.org/doxygen/inherits.html">classes</a>)
Chris Lattnere2667312005-11-30 06:35:34 +0000[diff] [blame]160
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]161(<a href="http://llvm.org/doxygen/doxygen.tar.gz">tarball</a>)
Chris Lattnere2667312005-11-30 06:35:34 +0000[diff] [blame]162</li>
Misha Brukmanb69715e2004-05-12 18:00:48 +0000[diff] [blame]163
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]164<li><a href="http://llvm.org/cvsweb/cvsweb.cgi/llvm">CVSWeb CVS Tree
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]165Browser</a></li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]166
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]167</ul>
168
169<!--=======================================================================-->
170<div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div>
171<!--=======================================================================-->
172
173<ul>
174
175<li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
176on how to write LLVM transformations and analyses.</li>
177
Misha Brukman96bba382004-09-06 23:00:01 +0000[diff] [blame]178<li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
179on how to write LLVM backends for machine targets.</li>
180
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]181<li><a href="CodeGenerator.html">The LLVM Target-Independent Code
182Generator</a> - The design and implementation of the LLVM code generator.
183Useful if you are working on retargetting LLVM to a new architecture, designing
184a new codegen pass, or enhancing existing components.</li>
185
186<li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
187Describes the TableGen tool, which is used heavily by the LLVM code
188generator.</li>
189
190<li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
191on how to write a new alias analysis implementation or how to use existing
192analyses.</li>
193
John Criswell98d06362004-11-21 14:58:12 +0000[diff] [blame]194<li><a href="Stacker.html">The Stacker Chronicles</a> - This document
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]195describes both the Stacker language and LLVM frontend, but also some details
196about LLVM useful for those writing front-ends.</li>
197
198<li><a href="GarbageCollection.html">Accurate Garbage Collection with
199LLVM</a> - The interfaces source-language compilers should use for compiling
200GC'd programs.</li>
201
202<li><a href="SourceLevelDebugging.html">Source Level Debugging with
203LLVM</a> - This document describes the design and philosophy behind the LLVM
204source-level debugger.</li>
205
Chris Lattner92734182007-05-13 23:38:44 +0000[diff] [blame^]206<li><a href="ExceptionHandling.html">Zero Cost Exception handling in LLVM</a>
207- This document describes the design and implementation of exception handling
208in LLVM.</li>
209
Misha Brukman9e3bdf12005-01-07 17:00:44 +0000[diff] [blame]210<li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
Misha Brukman3df00a02004-12-09 20:26:53 +0000[diff] [blame]211reducer description and usage information.</li>
Chris Lattner20423022004-08-02 21:29:20 +0000[diff] [blame]212
Reid Spencer2d1e01c2004-08-17 08:01:57 +0000[diff] [blame]213<li><a href="CompilerDriver.html">Compiler Driver (llvmc)</a> - This document
214describes the design and configuration of the LLVM compiler driver tool,
215<tt>llvmc</tt>.</li>
216
Chris Lattnerde36ffd2007-05-06 23:20:06 +0000[diff] [blame]217<li><a href="BitCodeFormat.html">LLVM Bitcode File Format</a></li>
Chris Lattner4a463a32006-06-20 20:54:47 +0000[diff] [blame]218
Reid Spencer8853b132005-01-05 19:01:20 +0000[diff] [blame]219<li><a href="SystemLibrary.html">System Library</a> - This document describes
220the LLVM System Library (<tt>lib/System</tt>) and how to keep LLVM source code
221portable</li>
222
Devang Patelde4bbd92006-08-14 18:21:53 +0000[diff] [blame]223<li><a href="LinkTimeOptimization.html">Link Time Optimization</a> - This
224document describes the interface between LLVM intermodular optimizer and
225the linker and its design</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