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