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