/usr/share/doc/llvm-3.5-doc/html/index.html is in llvm-3.5-doc 1:3.5-10.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Overview — LLVM 3.5 documentation</title>
<link rel="stylesheet" href="_static/llvm-theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '3.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="LLVM 3.5 documentation" href="#" />
<link rel="next" title="LLVM Language Reference Manual" href="LangRef.html" />
<style type="text/css">
table.right { float: right; margin-left: 20px; }
table.right td { border: 1px solid #ccc; }
</style>
</head>
<body>
<div class="logo">
<a href="#">
<img src="_static/logo.png"
alt="LLVM Logo" width="250" height="88"/></a>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="LangRef.html" title="LLVM Language Reference Manual"
accesskey="N">next</a> |</li>
<li><a href="http://llvm.org/">LLVM Home</a> | </li>
<li><a href="#">Documentation</a>»</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="body">
<div class="section" id="overview">
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h1>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">If you are using a released version of LLVM, see <a class="reference external" href="http://llvm.org/releases/">the download page</a> to find your documentation.</p>
</div>
<p>The LLVM compiler infrastructure supports a wide range of projects, from
industrial strength compilers to specialized JIT applications to small
research projects.</p>
<p>Similarly, documentation is broken down into several high-level groupings
targeted at different audiences:</p>
</div>
<div class="section" id="llvm-design-overview">
<h1>LLVM Design & Overview<a class="headerlink" href="#llvm-design-overview" title="Permalink to this headline">¶</a></h1>
<p>Several introductory papers and presentations.</p>
<div class="toctree-wrapper compound">
</div>
<dl class="docutils">
<dt><a class="reference internal" href="LangRef.html"><em>LLVM Language Reference Manual</em></a></dt>
<dd>Defines the LLVM intermediate representation.</dd>
<dt><a class="reference external" href="http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html">Introduction to the LLVM Compiler</a></dt>
<dd>Presentation providing a users introduction to LLVM.</dd>
<dt><a class="reference external" href="http://www.aosabook.org/en/llvm.html">Intro to LLVM</a></dt>
<dd>Book chapter providing a compiler hacker’s introduction to LLVM.</dd>
<dt><a class="reference external" href="http://llvm.org/pubs/2004-01-30-CGO-LLVM.html">LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation</a></dt>
<dd>Design overview.</dd>
<dt><a class="reference external" href="http://llvm.org/pubs/2002-12-LattnerMSThesis.html">LLVM: An Infrastructure for Multi-Stage Optimization</a></dt>
<dd>More details (quite old now).</dd>
<dt><a class="reference external" href="http://llvm.org/pubs">Publications mentioning LLVM</a></dt>
<dd></dd>
</dl>
</div>
<div class="section" id="user-guides">
<h1>User Guides<a class="headerlink" href="#user-guides" title="Permalink to this headline">¶</a></h1>
<p>For those new to the LLVM system.</p>
<p>NOTE: If you are a user who is only interested in using LLVM-based
compilers, you should look into <a class="reference external" href="http://clang.llvm.org">Clang</a> or
<a class="reference external" href="http://dragonegg.llvm.org">DragonEgg</a> instead. The documentation here is
intended for users who have a need to work with the intermediate LLVM
representation.</p>
<div class="toctree-wrapper compound">
</div>
<dl class="docutils">
<dt><a class="reference internal" href="GettingStarted.html"><em>Getting Started with the LLVM System</em></a></dt>
<dd>Discusses how to get up and running quickly with the LLVM infrastructure.
Everything from unpacking and compilation of the distribution to execution
of some tools.</dd>
<dt><a class="reference internal" href="CMake.html"><em>Building LLVM with CMake</em></a></dt>
<dd>An addendum to the main Getting Started guide for those using the <a class="reference external" href="http://www.cmake.org">CMake
build system</a>.</dd>
<dt><a class="reference internal" href="HowToBuildOnARM.html"><em>How To Build On ARM</em></a></dt>
<dd>Notes on building and testing LLVM/Clang on ARM.</dd>
<dt><a class="reference internal" href="HowToCrossCompileLLVM.html"><em>How To Cross-Compile Clang/LLVM using Clang/LLVM</em></a></dt>
<dd>Notes on cross-building and testing LLVM/Clang.</dd>
<dt><a class="reference internal" href="GettingStartedVS.html"><em>Getting Started with the LLVM System using Microsoft Visual Studio</em></a></dt>
<dd>An addendum to the main Getting Started guide for those using Visual Studio
on Windows.</dd>
<dt><a class="reference internal" href="tutorial/index.html"><em>LLVM Tutorial: Table of Contents</em></a></dt>
<dd>Tutorials about using LLVM. Includes a tutorial about making a custom
language with LLVM.</dd>
<dt><a class="reference internal" href="CommandGuide/index.html"><em>LLVM Command Guide</em></a></dt>
<dd>A reference manual for the LLVM command line utilities (“man” pages for LLVM
tools).</dd>
<dt><a class="reference internal" href="Passes.html"><em>LLVM’s Analysis and Transform Passes</em></a></dt>
<dd>A list of optimizations and analyses implemented in LLVM.</dd>
<dt><a class="reference internal" href="FAQ.html"><em>Frequently Asked Questions (FAQ)</em></a></dt>
<dd>A list of common questions and problems and their solutions.</dd>
<dt><a class="reference internal" href="ReleaseNotes.html"><em>Release notes for the current release</em></a></dt>
<dd>This describes new features, known bugs, and other limitations.</dd>
<dt><a class="reference internal" href="HowToSubmitABug.html"><em>How to submit an LLVM bug report</em></a></dt>
<dd>Instructions for properly submitting information about any bugs you run into
in the LLVM system.</dd>
<dt><a class="reference internal" href="SphinxQuickstartTemplate.html"><em>Sphinx Quickstart Template</em></a></dt>
<dd>A template + tutorial for writing new Sphinx documentation. It is meant
to be read in source form.</dd>
<dt><a class="reference internal" href="TestingGuide.html"><em>LLVM Testing Infrastructure Guide</em></a></dt>
<dd>A reference manual for using the LLVM testing infrastructure.</dd>
<dt><a class="reference external" href="http://clang.llvm.org/get_started.html">How to build the C, C++, ObjC, and ObjC++ front end</a></dt>
<dd>Instructions for building the clang front-end from source.</dd>
<dt><a class="reference internal" href="Lexicon.html"><em>The LLVM Lexicon</em></a></dt>
<dd>Definition of acronyms, terms and concepts used in LLVM.</dd>
<dt><a class="reference internal" href="HowToAddABuilder.html"><em>How To Add Your Build Configuration To LLVM Buildbot Infrastructure</em></a></dt>
<dd>Instructions for adding new builder to LLVM buildbot master.</dd>
<dt><a class="reference internal" href="YamlIO.html"><em>YAML I/O</em></a></dt>
<dd>A reference guide for using LLVM’s YAML I/O library.</dd>
<dt><a class="reference internal" href="GetElementPtr.html"><em>The Often Misunderstood GEP Instruction</em></a></dt>
<dd>Answers to some very frequent questions about LLVM’s most frequently
misunderstood instruction.</dd>
</dl>
</div>
<div class="section" id="programming-documentation">
<h1>Programming Documentation<a class="headerlink" href="#programming-documentation" title="Permalink to this headline">¶</a></h1>
<p>For developers of applications which use LLVM as a library.</p>
<div class="toctree-wrapper compound">
</div>
<dl class="docutils">
<dt><a class="reference internal" href="LangRef.html"><em>LLVM Language Reference Manual</em></a></dt>
<dd>Defines the LLVM intermediate representation and the assembly form of the
different nodes.</dd>
<dt><a class="reference internal" href="Atomics.html"><em>LLVM Atomic Instructions and Concurrency Guide</em></a></dt>
<dd>Information about LLVM’s concurrency model.</dd>
<dt><a class="reference internal" href="ProgrammersManual.html"><em>LLVM Programmer’s Manual</em></a></dt>
<dd>Introduction to the general layout of the LLVM sourcebase, important classes
and APIs, and some tips & tricks.</dd>
<dt><a class="reference internal" href="Extensions.html"><em>LLVM Extensions</em></a></dt>
<dd>LLVM-specific extensions to tools and formats LLVM seeks compatibility with.</dd>
<dt><a class="reference internal" href="CommandLine.html"><em>CommandLine 2.0 Library Manual</em></a></dt>
<dd>Provides information on using the command line parsing library.</dd>
<dt><a class="reference internal" href="CodingStandards.html"><em>LLVM Coding Standards</em></a></dt>
<dd>Details the LLVM coding standards and provides useful information on writing
efficient C++ code.</dd>
<dt><a class="reference internal" href="HowToSetUpLLVMStyleRTTI.html"><em>How to set up LLVM-style RTTI for your class hierarchy</em></a></dt>
<dd>How to make <tt class="docutils literal"><span class="pre">isa<></span></tt>, <tt class="docutils literal"><span class="pre">dyn_cast<></span></tt>, etc. available for clients of your
class hierarchy.</dd>
<dt><a class="reference internal" href="ExtendingLLVM.html"><em>Extending LLVM: Adding instructions, intrinsics, types, etc.</em></a></dt>
<dd>Look here to see how to add instructions and intrinsics to LLVM.</dd>
<dt><a class="reference external" href="http://llvm.org/doxygen/">Doxygen generated documentation</a></dt>
<dd>(<a class="reference external" href="http://llvm.org/doxygen/inherits.html">classes</a>)
(<a class="reference external" href="http://llvm.org/doxygen/doxygen.tar.gz">tarball</a>)</dd>
<dt><a class="reference external" href="http://llvm.org/viewvc/">ViewVC Repository Browser</a></dt>
<dd></dd>
<dt><a class="reference internal" href="CompilerWriterInfo.html"><em>Architecture & Platform Information for Compiler Writers</em></a></dt>
<dd>A list of helpful links for compiler writers.</dd>
</dl>
</div>
<div class="section" id="subsystem-documentation">
<h1>Subsystem Documentation<a class="headerlink" href="#subsystem-documentation" title="Permalink to this headline">¶</a></h1>
<p>For API clients and LLVM developers.</p>
<div class="toctree-wrapper compound">
</div>
<dl class="docutils">
<dt><a class="reference internal" href="WritingAnLLVMPass.html"><em>Writing an LLVM Pass</em></a></dt>
<dd>Information on how to write LLVM transformations and analyses.</dd>
<dt><a class="reference internal" href="WritingAnLLVMBackend.html"><em>Writing an LLVM Backend</em></a></dt>
<dd>Information on how to write LLVM backends for machine targets.</dd>
<dt><a class="reference internal" href="CodeGenerator.html"><em>The LLVM Target-Independent Code Generator</em></a></dt>
<dd>The design and implementation of the LLVM code generator. Useful if you are
working on retargetting LLVM to a new architecture, designing a new codegen
pass, or enhancing existing components.</dd>
<dt><a class="reference internal" href="TableGen/index.html"><em>TableGen</em></a></dt>
<dd>Describes the TableGen tool, which is used heavily by the LLVM code
generator.</dd>
<dt><a class="reference internal" href="AliasAnalysis.html"><em>LLVM Alias Analysis Infrastructure</em></a></dt>
<dd>Information on how to write a new alias analysis implementation or how to
use existing analyses.</dd>
<dt><a class="reference internal" href="GarbageCollection.html"><em>Accurate Garbage Collection with LLVM</em></a></dt>
<dd>The interfaces source-language compilers should use for compiling GC’d
programs.</dd>
<dt><a class="reference internal" href="SourceLevelDebugging.html"><em>Source Level Debugging with LLVM</em></a></dt>
<dd>This document describes the design and philosophy behind the LLVM
source-level debugger.</dd>
<dt><a class="reference internal" href="Vectorizers.html"><em>Auto-Vectorization in LLVM</em></a></dt>
<dd>This document describes the current status of vectorization in LLVM.</dd>
<dt><a class="reference internal" href="ExceptionHandling.html"><em>Exception Handling in LLVM</em></a></dt>
<dd>This document describes the design and implementation of exception handling
in LLVM.</dd>
<dt><a class="reference internal" href="Bugpoint.html"><em>LLVM bugpoint tool: design and usage</em></a></dt>
<dd>Automatic bug finder and test-case reducer description and usage
information.</dd>
<dt><a class="reference internal" href="BitCodeFormat.html"><em>LLVM Bitcode File Format</em></a></dt>
<dd>This describes the file format and encoding used for LLVM “bc” files.</dd>
<dt><a class="reference internal" href="SystemLibrary.html"><em>System Library</em></a></dt>
<dd>This document describes the LLVM System Library (<tt class="docutils literal"><span class="pre">lib/System</span></tt>) and
how to keep LLVM source code portable</dd>
<dt><a class="reference internal" href="LinkTimeOptimization.html"><em>LLVM Link Time Optimization: Design and Implementation</em></a></dt>
<dd>This document describes the interface between LLVM intermodular optimizer
and the linker and its design</dd>
<dt><a class="reference internal" href="GoldPlugin.html"><em>The LLVM gold plugin</em></a></dt>
<dd>How to build your programs with link-time optimization on Linux.</dd>
<dt><a class="reference internal" href="DebuggingJITedCode.html"><em>Debugging JIT-ed Code With GDB</em></a></dt>
<dd>How to debug JITed code with GDB.</dd>
<dt><a class="reference internal" href="MCJITDesignAndImplementation.html"><em>MCJIT Design and Implementation</em></a></dt>
<dd>Describes the inner workings of MCJIT execution engine.</dd>
<dt><a class="reference internal" href="BranchWeightMetadata.html"><em>LLVM Branch Weight Metadata</em></a></dt>
<dd>Provides information about Branch Prediction Information.</dd>
<dt><a class="reference internal" href="BlockFrequencyTerminology.html"><em>LLVM Block Frequency Terminology</em></a></dt>
<dd>Provides information about terminology used in the <tt class="docutils literal"><span class="pre">BlockFrequencyInfo</span></tt>
analysis pass.</dd>
<dt><a class="reference internal" href="SegmentedStacks.html"><em>Segmented Stacks in LLVM</em></a></dt>
<dd>This document describes segmented stacks and how they are used in LLVM.</dd>
<dt><a class="reference internal" href="MarkedUpDisassembly.html"><em>LLVM’s Optional Rich Disassembly Output</em></a></dt>
<dd>This document describes the optional rich disassembly output syntax.</dd>
<dt><a class="reference internal" href="HowToUseAttributes.html"><em>How To Use Attributes</em></a></dt>
<dd>Answers some questions about the new Attributes infrastructure.</dd>
<dt><a class="reference internal" href="NVPTXUsage.html"><em>User Guide for NVPTX Back-end</em></a></dt>
<dd>This document describes using the NVPTX back-end to compile GPU kernels.</dd>
<dt><a class="reference internal" href="StackMaps.html"><em>Stack maps and patch points in LLVM</em></a></dt>
<dd>LLVM support for mapping instruction addresses to the location of
values and allowing code to be patched.</dd>
<dt><a class="reference internal" href="BigEndianNEON.html"><em>Using ARM NEON instructions in big endian mode</em></a></dt>
<dd>LLVM’s support for generating NEON instructions on big endian ARM targets is
somewhat nonintuitive. This document explains the implementation and rationale.</dd>
</dl>
</div>
<div class="section" id="development-process-documentation">
<h1>Development Process Documentation<a class="headerlink" href="#development-process-documentation" title="Permalink to this headline">¶</a></h1>
<p>Information about LLVM’s development process.</p>
<div class="toctree-wrapper compound">
</div>
<dl class="docutils">
<dt><a class="reference internal" href="DeveloperPolicy.html"><em>LLVM Developer Policy</em></a></dt>
<dd>The LLVM project’s policy towards developers and their contributions.</dd>
<dt><a class="reference internal" href="Projects.html"><em>Creating an LLVM Project</em></a></dt>
<dd>How-to guide and templates for new projects that <em>use</em> the LLVM
infrastructure. The templates (directory organization, Makefiles, and test
tree) allow the project code to be located outside (or inside) the <tt class="docutils literal"><span class="pre">llvm/</span></tt>
tree, while using LLVM header files and libraries.</dd>
<dt><a class="reference internal" href="LLVMBuild.html"><em>LLVMBuild Guide</em></a></dt>
<dd>Describes the LLVMBuild organization and files used by LLVM to specify
component descriptions.</dd>
<dt><a class="reference internal" href="MakefileGuide.html"><em>LLVM Makefile Guide</em></a></dt>
<dd>Describes how the LLVM makefiles work and how to use them.</dd>
<dt><a class="reference internal" href="HowToReleaseLLVM.html"><em>How To Release LLVM To The Public</em></a></dt>
<dd>This is a guide to preparing LLVM releases. Most developers can ignore it.</dd>
<dt><a class="reference internal" href="ReleaseProcess.html"><em>How To Validate a New Release</em></a></dt>
<dd>This is a validate a new release, during the release process. Most developers can ignore it.</dd>
<dt><a class="reference internal" href="Packaging.html"><em>Advice on Packaging LLVM</em></a></dt>
<dd>Advice on packaging LLVM into a distribution.</dd>
</dl>
</div>
<div class="section" id="community">
<h1>Community<a class="headerlink" href="#community" title="Permalink to this headline">¶</a></h1>
<p>LLVM has a thriving community of friendly and helpful developers.
The two primary communication mechanisms in the LLVM community are mailing
lists and IRC.</p>
<div class="section" id="mailing-lists">
<h2>Mailing Lists<a class="headerlink" href="#mailing-lists" title="Permalink to this headline">¶</a></h2>
<p>If you can’t find what you need in these docs, try consulting the mailing
lists.</p>
<dl class="docutils">
<dt><a class="reference external" href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer’s List (llvmdev)</a></dt>
<dd>This list is for people who want to be included in technical discussions of
LLVM. People post to this list when they have questions about writing code
for or using the LLVM tools. It is relatively low volume.</dd>
<dt><a class="reference external" href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/">Commits Archive (llvm-commits)</a></dt>
<dd>This list contains all commit messages that are made when LLVM developers
commit code changes to the repository. It also serves as a forum for
patch review (i.e. send patches here). It is useful for those who want to
stay on the bleeding edge of LLVM development. This list is very high
volume.</dd>
<dt><a class="reference external" href="http://lists.cs.uiuc.edu/pipermail/llvmbugs/">Bugs & Patches Archive (llvmbugs)</a></dt>
<dd>This list gets emailed every time a bug is opened and closed. It is
higher volume than the LLVMdev list.</dd>
<dt><a class="reference external" href="http://lists.cs.uiuc.edu/pipermail/llvm-testresults/">Test Results Archive (llvm-testresults)</a></dt>
<dd>A message is automatically sent to this list by every active nightly tester
when it completes. As such, this list gets email several times each day,
making it a high volume list.</dd>
<dt><a class="reference external" href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce">LLVM Announcements List (llvm-announce)</a></dt>
<dd>This is a low volume list that provides important announcements regarding
LLVM. It gets email about once a month.</dd>
</dl>
</div>
<div class="section" id="irc">
<h2>IRC<a class="headerlink" href="#irc" title="Permalink to this headline">¶</a></h2>
<p>Users and developers of the LLVM project (including subprojects such as Clang)
can be found in #llvm on <a class="reference external" href="irc://irc.oftc.net/llvm">irc.oftc.net</a>.</p>
<p>This channel has several bots.</p>
<ul class="simple">
<li>Buildbot reporters<ul>
<li>llvmbb - Bot for the main LLVM buildbot master.
<a class="reference external" href="http://lab.llvm.org:8011/console">http://lab.llvm.org:8011/console</a></li>
<li>bb-chapuni - An individually run buildbot master. <a class="reference external" href="http://bb.pgr.jp/console">http://bb.pgr.jp/console</a></li>
<li>smooshlab - Apple’s internal buildbot master.</li>
</ul>
</li>
<li>robot - Bugzilla linker. %bug <number></li>
<li>clang-bot - A <a class="reference external" href="http://www.eelis.net/geordi/">geordi</a> instance running
near-trunk clang instead of gcc.</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="LangRef.html" title="LLVM Language Reference Manual"
>next</a> |</li>
<li><a href="http://llvm.org/">LLVM Home</a> | </li>
<li><a href="#">Documentation</a>»</li>
</ul>
</div>
<div class="footer">
© Copyright 2003-2014, LLVM Project.
Last updated on 2015-02-27.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>
|