docs/index.rst

   1 Overview
   2 ========
   3
   4 .. warning::
   5
   6    If you are using a released version of LLVM, see `the download page
   7    <http://llvm.org/releases/>`_ to find your documentation.
   8
   9 The LLVM compiler infrastructure supports a wide range of projects, from
  10 industrial strength compilers to specialized JIT applications to small
  11 research projects.
  12
  13 Similarly, documentation is broken down into several high-level groupings
  14 targeted at different audiences:
  15
  16 LLVM Design & Overview
  17 ======================
  18
  19 Several introductory papers and presentations.
  20
  21 .. toctree::
  22    :hidden:
  23
  24    LangRef
  25
  26 :doc:`LangRef`
  27   Defines the LLVM intermediate representation.
  28
  29 `Introduction to the LLVM Compiler`__
  30   Presentation providing a users introduction to LLVM.
  31
  32   .. __: http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html
  33
  34 `Intro to LLVM`__
  35   Book chapter providing a compiler hacker's introduction to LLVM.
  36
  37   .. __: http://www.aosabook.org/en/llvm.html
  38
  39
  40 `LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__
  41   Design overview.
  42
  43   .. __: http://llvm.org/pubs/2004-01-30-CGO-LLVM.html
  44
  45 `LLVM: An Infrastructure for Multi-Stage Optimization`__
  46   More details (quite old now).
  47
  48   .. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html
  49
  50 `Publications mentioning LLVM <http://llvm.org/pubs>`_
  51    ..
  52
  53 User Guides
  54 ===========
  55
  56 For those new to the LLVM system.
  57
  58 NOTE: If you are a user who is only interested in using LLVM-based
  59 compilers, you should look into `Clang <http://clang.llvm.org>`_ or
  60 `DragonEgg <http://dragonegg.llvm.org>`_ instead. The documentation here is
  61 intended for users who have a need to work with the intermediate LLVM
  62 representation.
  63
  64 .. toctree::
  65    :hidden:
  66
  67    CMake
  68    HowToBuildOnARM
  69    HowToCrossCompileLLVM
  70    CommandGuide/index
  71    GettingStarted
  72    GettingStartedVS
  73    BuildingLLVMWithAutotools
  74    FAQ
  75    Lexicon
  76    HowToAddABuilder
  77    yaml2obj
  78    HowToSubmitABug
  79    SphinxQuickstartTemplate
  80    Phabricator
  81    TestingGuide
  82    tutorial/index
  83    ReleaseNotes
  84    Passes
  85    YamlIO
  86    GetElementPtr
  87    Frontend/PerformanceTips
  88    MCJITDesignAndImplementation
  89
  90 :doc:`GettingStarted`
  91    Discusses how to get up and running quickly with the LLVM infrastructure.
  92    Everything from unpacking and compilation of the distribution to execution
  93    of some tools.
  94
  95 :doc:`CMake`
  96    An addendum to the main Getting Started guide for those using the `CMake
  97    build system <http://www.cmake.org>`_.
  98
  99 :doc:`HowToBuildOnARM`
 100    Notes on building and testing LLVM/Clang on ARM.
 101
 102 :doc:`HowToCrossCompileLLVM`
 103    Notes on cross-building and testing LLVM/Clang.
 104
 105 :doc:`GettingStartedVS`
 106    An addendum to the main Getting Started guide for those using Visual Studio
 107    on Windows.
 108
 109 :doc:`BuildingLLVMWithAutotools`
 110    An addendum to the Getting Started guide with instructions for building LLVM
 111    with the Autotools build system.
 112
 113 :doc:`tutorial/index`
 114    Tutorials about using LLVM. Includes a tutorial about making a custom
 115    language with LLVM.
 116
 117 :doc:`LLVM Command Guide <CommandGuide/index>`
 118    A reference manual for the LLVM command line utilities ("man" pages for LLVM
 119    tools).
 120
 121 :doc:`Passes`
 122    A list of optimizations and analyses implemented in LLVM.
 123
 124 :doc:`FAQ`
 125    A list of common questions and problems and their solutions.
 126
 127 :doc:`Release notes for the current release <ReleaseNotes>`
 128    This describes new features, known bugs, and other limitations.
 129
 130 :doc:`HowToSubmitABug`
 131    Instructions for properly submitting information about any bugs you run into
 132    in the LLVM system.
 133
 134 :doc:`SphinxQuickstartTemplate`
 135   A template + tutorial for writing new Sphinx documentation. It is meant
 136   to be read in source form.
 137
 138 :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
 139    A reference manual for using the LLVM testing infrastructure.
 140
 141 `How to build the C, C++, ObjC, and ObjC++ front end`__
 142    Instructions for building the clang front-end from source.
 143
 144    .. __: http://clang.llvm.org/get_started.html
 145
 146 :doc:`Lexicon`
 147    Definition of acronyms, terms and concepts used in LLVM.
 148
 149 :doc:`HowToAddABuilder`
 150    Instructions for adding new builder to LLVM buildbot master.
 151
 152 :doc:`YamlIO`
 153    A reference guide for using LLVM's YAML I/O library.
 154
 155 :doc:`GetElementPtr`
 156   Answers to some very frequent questions about LLVM's most frequently
 157   misunderstood instruction.
 158
 159 :doc:`Frontend/PerformanceTips`
 160    A collection of tips for frontend authors on how to generate IR
 161    which LLVM is able to effectively optimize.
 162
 163
 164 Programming Documentation
 165 =========================
 166
 167 For developers of applications which use LLVM as a library.
 168
 169 .. toctree::
 170    :hidden:
 171
 172    Atomics
 173    CodingStandards
 174    CommandLine
 175    CompilerWriterInfo
 176    ExtendingLLVM
 177    HowToSetUpLLVMStyleRTTI
 178    ProgrammersManual
 179    Extensions
 180    LibFuzzer
 181
 182 :doc:`LLVM Language Reference Manual <LangRef>`
 183   Defines the LLVM intermediate representation and the assembly form of the
 184   different nodes.
 185
 186 :doc:`Atomics`
 187   Information about LLVM's concurrency model.
 188
 189 :doc:`ProgrammersManual`
 190   Introduction to the general layout of the LLVM sourcebase, important classes
 191   and APIs, and some tips & tricks.
 192
 193 :doc:`Extensions`
 194   LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
 195
 196 :doc:`CommandLine`
 197   Provides information on using the command line parsing library.
 198
 199 :doc:`CodingStandards`
 200   Details the LLVM coding standards and provides useful information on writing
 201   efficient C++ code.
 202
 203 :doc:`HowToSetUpLLVMStyleRTTI`
 204   How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
 205   class hierarchy.
 206
 207 :doc:`ExtendingLLVM`
 208   Look here to see how to add instructions and intrinsics to LLVM.
 209
 210 `Doxygen generated documentation <http://llvm.org/doxygen/>`_
 211   (`classes <http://llvm.org/doxygen/inherits.html>`_)
 212   (`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
 213
 214 `Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
 215
 216 `ViewVC Repository Browser <http://llvm.org/viewvc/>`_
 217    ..
 218
 219 :doc:`CompilerWriterInfo`
 220   A list of helpful links for compiler writers.
 221
 222 :doc:`LibFuzzer`
 223   A library for writing in-process guided fuzzers.
 224
 225 Subsystem Documentation
 226 =======================
 227
 228 For API clients and LLVM developers.
 229
 230 .. toctree::
 231    :hidden:
 232
 233    AliasAnalysis
 234    BitCodeFormat
 235    BlockFrequencyTerminology
 236    BranchWeightMetadata
 237    Bugpoint
 238    CodeGenerator
 239    ExceptionHandling
 240    LinkTimeOptimization
 241    SegmentedStacks
 242    TableGenFundamentals
 243    TableGen/index
 244    DebuggingJITedCode
 245    GoldPlugin
 246    MarkedUpDisassembly
 247    SystemLibrary
 248    SourceLevelDebugging
 249    Vectorizers
 250    WritingAnLLVMBackend
 251    GarbageCollection
 252    WritingAnLLVMPass
 253    HowToUseAttributes
 254    NVPTXUsage
 255    AMDGPUUsage
 256    StackMaps
 257    InAlloca
 258    BigEndianNEON
 259    CoverageMappingFormat
 260    Statepoints
 261    MergeFunctions
 262    BitSets
 263    FaultMaps
 264    MIRLangRef
 265
 266 :doc:`WritingAnLLVMPass`
 267    Information on how to write LLVM transformations and analyses.
 268
 269 :doc:`WritingAnLLVMBackend`
 270    Information on how to write LLVM backends for machine targets.
 271
 272 :doc:`CodeGenerator`
 273    The design and implementation of the LLVM code generator.  Useful if you are
 274    working on retargetting LLVM to a new architecture, designing a new codegen
 275    pass, or enhancing existing components.
 276
 277 :doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
 278    A reference manual for the MIR serialization format, which is used to test
 279    LLVM's code generation passes.
 280
 281 :doc:`TableGen <TableGen/index>`
 282    Describes the TableGen tool, which is used heavily by the LLVM code
 283    generator.
 284
 285 :doc:`AliasAnalysis`
 286    Information on how to write a new alias analysis implementation or how to
 287    use existing analyses.
 288
 289 :doc:`GarbageCollection`
 290    The interfaces source-language compilers should use for compiling GC'd
 291    programs.
 292
 293 :doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
 294    This document describes the design and philosophy behind the LLVM
 295    source-level debugger.
 296
 297 :doc:`Vectorizers`
 298    This document describes the current status of vectorization in LLVM.
 299
 300 :doc:`ExceptionHandling`
 301    This document describes the design and implementation of exception handling
 302    in LLVM.
 303
 304 :doc:`Bugpoint`
 305    Automatic bug finder and test-case reducer description and usage
 306    information.
 307
 308 :doc:`BitCodeFormat`
 309    This describes the file format and encoding used for LLVM "bc" files.
 310
 311 :doc:`System Library <SystemLibrary>`
 312    This document describes the LLVM System Library (``lib/System``) and
 313    how to keep LLVM source code portable
 314
 315 :doc:`LinkTimeOptimization`
 316    This document describes the interface between LLVM intermodular optimizer
 317    and the linker and its design
 318
 319 :doc:`GoldPlugin`
 320    How to build your programs with link-time optimization on Linux.
 321
 322 :doc:`DebuggingJITedCode`
 323    How to debug JITed code with GDB.
 324
 325 :doc:`MCJITDesignAndImplementation`
 326    Describes the inner workings of MCJIT execution engine.
 327
 328 :doc:`BranchWeightMetadata`
 329    Provides information about Branch Prediction Information.
 330
 331 :doc:`BlockFrequencyTerminology`
 332    Provides information about terminology used in the ``BlockFrequencyInfo``
 333    analysis pass.
 334
 335 :doc:`SegmentedStacks`
 336    This document describes segmented stacks and how they are used in LLVM.
 337
 338 :doc:`MarkedUpDisassembly`
 339    This document describes the optional rich disassembly output syntax.
 340
 341 :doc:`HowToUseAttributes`
 342   Answers some questions about the new Attributes infrastructure.
 343
 344 :doc:`NVPTXUsage`
 345    This document describes using the NVPTX back-end to compile GPU kernels.
 346
 347 :doc:`AMDGPUUsage`
 348    This document describes how to use the AMDGPU back-end.
 349
 350 :doc:`StackMaps`
 351   LLVM support for mapping instruction addresses to the location of
 352   values and allowing code to be patched.
 353
 354 :doc:`BigEndianNEON`
 355   LLVM's support for generating NEON instructions on big endian ARM targets is
 356   somewhat nonintuitive. This document explains the implementation and rationale.
 357
 358 :doc:`CoverageMappingFormat`
 359   This describes the format and encoding used for LLVM’s code coverage mapping.
 360
 361 :doc:`Statepoints`
 362   This describes a set of experimental extensions for garbage
 363   collection support.
 364
 365 :doc:`MergeFunctions`
 366   Describes functions merging optimization.
 367
 368 :doc:`InAlloca`
 369   Description of the ``inalloca`` argument attribute.
 370
 371 :doc:`FaultMaps`
 372   LLVM support for folding control flow into faulting machine instructions.
 373
 374 Development Process Documentation
 375 =================================
 376
 377 Information about LLVM's development process.
 378
 379 .. toctree::
 380    :hidden:
 381
 382    DeveloperPolicy
 383    MakefileGuide
 384    Projects
 385    LLVMBuild
 386    HowToReleaseLLVM
 387    Packaging
 388    ReleaseProcess
 389    Phabricator
 390
 391 :doc:`DeveloperPolicy`
 392    The LLVM project's policy towards developers and their contributions.
 393
 394 :doc:`Projects`
 395   How-to guide and templates for new projects that *use* the LLVM
 396   infrastructure.  The templates (directory organization, Makefiles, and test
 397   tree) allow the project code to be located outside (or inside) the ``llvm/``
 398   tree, while using LLVM header files and libraries.
 399
 400 :doc:`LLVMBuild`
 401   Describes the LLVMBuild organization and files used by LLVM to specify
 402   component descriptions.
 403
 404 :doc:`MakefileGuide`
 405   Describes how the LLVM makefiles work and how to use them.
 406
 407 :doc:`HowToReleaseLLVM`
 408   This is a guide to preparing LLVM releases. Most developers can ignore it.
 409
 410 :doc:`ReleaseProcess`
 411   This is a guide to validate a new release, during the release process. Most developers can ignore it.
 412
 413 :doc:`Packaging`
 414    Advice on packaging LLVM into a distribution.
 415
 416 :doc:`Phabricator`
 417    Describes how to use the Phabricator code review tool hosted on
 418    http://reviews.llvm.org/ and its command line interface, Arcanist.
 419
 420 Community
 421 =========
 422
 423 LLVM has a thriving community of friendly and helpful developers.
 424 The two primary communication mechanisms in the LLVM community are mailing
 425 lists and IRC.
 426
 427 Mailing Lists
 428 -------------
 429
 430 If you can't find what you need in these docs, try consulting the mailing
 431 lists.
 432
 433 `Developer's List (llvm-dev)`__
 434   This list is for people who want to be included in technical discussions of
 435   LLVM. People post to this list when they have questions about writing code
 436   for or using the LLVM tools. It is relatively low volume.
 437
 438   .. __: http://lists.llvm.org/mailman/listinfo/llvm-dev
 439
 440 `Commits Archive (llvm-commits)`__
 441   This list contains all commit messages that are made when LLVM developers
 442   commit code changes to the repository. It also serves as a forum for
 443   patch review (i.e. send patches here). It is useful for those who want to
 444   stay on the bleeding edge of LLVM development. This list is very high
 445   volume.
 446
 447   .. __: http://lists.llvm.org/pipermail/llvm-commits/
 448
 449 `Bugs & Patches Archive (llvm-bugs)`__
 450   This list gets emailed every time a bug is opened and closed. It is
 451   higher volume than the LLVM-dev list.
 452
 453   .. __: http://lists.llvm.org/pipermail/llvm-bugs/
 454
 455 `Test Results Archive (llvm-testresults)`__
 456   A message is automatically sent to this list by every active nightly tester
 457   when it completes.  As such, this list gets email several times each day,
 458   making it a high volume list.
 459
 460   .. __: http://lists.llvm.org/pipermail/llvm-testresults/
 461
 462 `LLVM Announcements List (llvm-announce)`__
 463   This is a low volume list that provides important announcements regarding
 464   LLVM.  It gets email about once a month.
 465
 466   .. __: http://lists.llvm.org/mailman/listinfo/llvm-announce
 467
 468 IRC
 469 ---
 470
 471 Users and developers of the LLVM project (including subprojects such as Clang)
 472 can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
 473
 474 This channel has several bots.
 475
 476 * Buildbot reporters
 477
 478   * llvmbb - Bot for the main LLVM buildbot master.
 479     http://lab.llvm.org:8011/console
 480   * bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console
 481   * smooshlab - Apple's internal buildbot master.
 482
 483 * robot - Bugzilla linker. %bug <number>
 484
 485 * clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
 486   near-trunk clang instead of gcc.
 487
 488
 489 Indices and tables
 490 ==================
 491
 492 * :ref:`genindex`
 493 * :ref:`search`