as Heading elements instead of

. X-Git-Url: http://plrg.eecs.uci.edu/git/?a=commitdiff_plain;h=05d0265fef651de152c8127aa701e689555649f3;p=oota-llvm.git docs: Use as Heading elements instead of

. H1 ... doc_title H2 ... doc_section H3 ... doc_subsection H4 ... doc_subsubsection git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@129736 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/docs/AliasAnalysis.html b/docs/AliasAnalysis.html index c1603be1299..bed3aceeb5c 100644 --- a/docs/AliasAnalysis.html +++ b/docs/AliasAnalysis.html @@ -7,9 +7,9 @@ -

LLVM Alias Analysis Infrastructure -

Introduction

Introduction -

@@ -96,9 +96,9 @@ know.

`AliasAnalysis` Class Overview -

@@ -125,9 +125,9 @@ same function.

Representation of Pointers -

@@ -181,9 +181,9 @@ that the accesses alias.

The `alias` method -

The alias method is the primary interface used to determine whether @@ -197,9 +197,9 @@ least one of the values is a constant.

Must, May, and No Alias Responses -

The NoAlias response may be used when there is never an immediate dependence @@ -228,9 +228,9 @@ implies that the pointers compare equal.

The `getModRefInfo` methods -

@@ -250,9 +250,9 @@ memory written to by CS2. Note that this relation is not commutative.

Other useful `AliasAnalysis` methods -

@@ -264,9 +264,9 @@ analysis implementations and can be put to good use by various clients.

The `pointsToConstantMemory` method -

@@ -279,10 +279,10 @@ memory location to be modified.

The `doesNotAccessMemory` and `onlyReadsMemory` methods -

@@ -308,9 +308,9 @@ functions that satisfy the doesNotAccessMemory method also satisfies

Writing a new `AliasAnalysis` Implementation -

@@ -324,9 +324,9 @@ implementations included with LLVM.

Different Pass styles -

@@ -352,9 +352,9 @@ solve:

Required initialization calls -

@@ -393,9 +393,9 @@ bool run(Module &M) {

Interfaces which may be specified -

@@ -412,9 +412,9 @@ implementing, you just override the interfaces you can improve.

`AliasAnalysis` chaining behavior -

@@ -451,9 +451,9 @@ updated.

Updating analysis results for transformations -

@@ -474,7 +474,7 @@ sure to call these interfaces appropriately.

The deleteValue method

The `deleteValue` method

The deleteValue method is called by transformations when they remove an @@ -485,7 +485,7 @@ any entries for the specified value, if they exist.

The copyValue method

The `copyValue` method

The copyValue method is used when a new value is introduced into the @@ -496,7 +496,7 @@ new value has exactly the same properties as the value being copied.

The replaceWithNewValue method

The `replaceWithNewValue` method

This method is a simple helper method that is provided to make clients easier to @@ -506,7 +506,7 @@ analysis implementations.

The addEscapingUse method

The `addEscapingUse` method

The addEscapingUse method is used when the uses of a pointer @@ -528,9 +528,9 @@ uses below:

Efficiency Issues -

@@ -544,9 +544,9 @@ method as possible (within reason).

Limitations -

@@ -617,9 +617,9 @@ from itself.

Using alias analysis results -

@@ -630,9 +630,9 @@ preference, these are...

Using the `MemoryDependenceAnalysis` Pass -

@@ -645,9 +645,9 @@ efficient, and is used by Dead Store Elimination, GVN, and memcpy optimizations.

Using the `AliasSetTracker` class -

@@ -681,9 +681,9 @@ pointer argument is loop-invariant.

The AliasSetTracker implementation -

@@ -707,9 +707,9 @@ are.

Using the `AliasAnalysis` interface directly -

@@ -722,9 +722,9 @@ best precision and efficiency.

Existing alias analysis implementations and clients -

@@ -738,9 +738,9 @@ for monitoring and evaluating different implementations.

Available `AliasAnalysis` implementations -

@@ -752,9 +752,9 @@ href="#chaining">chain to other alias analysis implementations.

The `-no-aa` pass -

@@ -766,9 +766,9 @@ problem.

The `-basicaa` pass -

@@ -794,9 +794,9 @@ many important facts:

The `-globalsmodref-aa` pass -

@@ -818,9 +818,9 @@ non-address taken globals), but is very quick analysis.

The `-steens-aa` pass -

@@ -841,9 +841,9 @@ module, it is not part of the LLVM core.

The `-ds-aa` pass -

@@ -864,9 +864,9 @@ module, it is not part of the LLVM core.

The `-scev-aa` pass -

@@ -878,9 +878,9 @@ and loop induction variables than other alias analyses have.

Alias analysis driven transformations -

LLVM includes several alias-analysis driven transformations which can be used @@ -888,9 +888,9 @@ with any of the implementations above.

The `-adce` pass -

@@ -902,9 +902,9 @@ not have side-effects and are not used.

The `-licm` pass -

@@ -927,9 +927,9 @@ no may aliases to the loaded/stored memory location.

The `-argpromotion` pass -

@@ -942,10 +942,10 @@ pointer.

The `-gvn`, `-memcpyopt`, and `-dse` passes -

@@ -955,10 +955,10 @@ pointer.

Clients for debugging and evaluation of implementations -

@@ -969,9 +969,9 @@ implementations. You can use them with commands like 'opt -ds-aa

- + The -print-alias-sets pass - + @@ -990,9 +990,9 @@ the AliasSetTracker class. To use it, use something like: - + The -count-aa pass - + @@ -1014,9 +1014,9 @@ when debugging a transformation or an alias analysis implementation. - + The -aa-eval pass - + @@ -1029,9 +1029,9 @@ algorithm will have a lower number of may aliases). - + Memory Dependence Analysis - + diff --git a/docs/BitCodeFormat.html b/docs/BitCodeFormat.html index 36d31c9cefb..396904a3d6d 100644 --- a/docs/BitCodeFormat.html +++ b/docs/BitCodeFormat.html @@ -7,7 +7,7 @@ - LLVM Bitcode File Format + LLVM Bitcode File Format Abstract Overview @@ -47,7 +47,7 @@ - Abstract +Abstract @@ -58,7 +58,7 @@ the LLVM IR into it. - Overview +Overview @@ -88,7 +88,7 @@ wrapper format, then describes the record structure used by LLVM IR files. - Bitstream Format +Bitstream Format @@ -117,8 +117,9 @@ understanding the encoding. -Magic Numbers - + + Magic Numbers + @@ -130,8 +131,9 @@ bitcode, while application-specific programs will want to look at all four. -Primitives - + + Primitives + @@ -147,8 +149,9 @@ Integers. - Fixed Width Integers - + + Fixed Width Integers + @@ -161,8 +164,9 @@ Integers. - Variable Width -Integers + + Variable Width Integers + @@ -182,7 +186,7 @@ value of 24 (011 << 3) with no continuation. The sum (3+24) yields the value - 6-bit characters +6-bit characters @@ -206,7 +210,7 @@ characters not in the set. - Word Alignment +Word Alignment @@ -218,8 +222,9 @@ represented as a multiple of 32-bit words. -Abbreviation IDs - + + Abbreviation IDs + @@ -253,8 +258,9 @@ an abbreviated record encoding. -Blocks - + + Blocks + @@ -300,8 +306,7 @@ popped, the saved values are restored. - ENTER_SUBBLOCK -Encoding +ENTER_SUBBLOCK Encoding @@ -322,8 +327,7 @@ reader to skip over the entire block in one jump. - END_BLOCK -Encoding +END_BLOCK Encoding @@ -340,8 +344,9 @@ an even multiple of 32-bits. -Data Records - + + Data Records + @@ -358,8 +363,7 @@ ASCII codes for the characters in the string. - UNABBREV_RECORD -Encoding +UNABBREV_RECORD Encoding @@ -385,8 +389,7 @@ bits. This is not an efficient encoding, but it is fully general. - Abbreviated Record -Encoding +Abbreviated Record Encoding @@ -410,8 +413,9 @@ operand value). -Abbreviations - + + Abbreviations + @@ -434,8 +438,7 @@ operators, the abbreviation does not need to be emitted. -DEFINE_ABBREV - Encoding +DEFINE_ABBREV Encoding @@ -553,8 +556,9 @@ used for any other string value. -Standard Blocks - + + Standard Blocks + @@ -568,8 +572,7 @@ may be added. Block IDs 0-7 are reserved for standard blocks. -#0 - BLOCKINFO -Block +#0 - BLOCKINFO Block @@ -621,7 +624,7 @@ from the corresponding blocks. It is not safe to skip them. - Bitcode Wrapper Format +Bitcode Wrapper Format @@ -652,7 +655,7 @@ value that can be used to encode the CPU of the target. - LLVM IR Encoding +LLVM IR Encoding @@ -669,11 +672,12 @@ reader is not allowed to build in any knowledge of this. -Basics - + + Basics + -LLVM IR Magic Number +LLVM IR Magic Number @@ -695,7 +699,7 @@ When combined with the bitcode magic number and viewed as bytes, this is -Signed VBRs +Signed VBRs @@ -728,7 +732,7 @@ within CONSTANTS_BLOCK blocks. -LLVM IR Blocks +LLVM IR Blocks @@ -759,8 +763,9 @@ LLVM IR is defined with the following blocks: -MODULE_BLOCK Contents - + + MODULE_BLOCK Contents + @@ -785,8 +790,7 @@ following sub-blocks: -MODULE_CODE_VERSION Record - +MODULE_CODE_VERSION Record @@ -798,8 +802,7 @@ time. -MODULE_CODE_TRIPLE Record - +MODULE_CODE_TRIPLE Record [TRIPLE, ...string...] @@ -810,8 +813,7 @@ specification string. -MODULE_CODE_DATALAYOUT Record - +MODULE_CODE_DATALAYOUT Record [DATALAYOUT, ...string...] @@ -822,8 +824,7 @@ specification string. -MODULE_CODE_ASM Record - +MODULE_CODE_ASM Record [ASM, ...string...] @@ -834,8 +835,7 @@ individual assembly blocks separated by newline (ASCII 10) characters. -MODULE_CODE_SECTIONNAME Record - +MODULE_CODE_SECTIONNAME Record [SECTIONNAME, ...string...] @@ -850,8 +850,7 @@ referenced by the 1-based index in the section fields of -MODULE_CODE_DEPLIB Record - +MODULE_CODE_DEPLIB Record [DEPLIB, ...string...] @@ -864,8 +863,7 @@ library name referenced. -MODULE_CODE_GLOBALVAR Record - +MODULE_CODE_GLOBALVAR Record [GLOBALVAR, pointer type, isconst, initid, linkage, alignment, section, visibility, threadlocal] @@ -929,8 +927,7 @@ has unnamed_addr -MODULE_CODE_FUNCTION Record - +MODULE_CODE_FUNCTION Record @@ -986,8 +983,7 @@ has unnamed_addr -MODULE_CODE_ALIAS Record - +MODULE_CODE_ALIAS Record @@ -1011,8 +1007,7 @@ for this alias -MODULE_CODE_PURGEVALS Record - +MODULE_CODE_PURGEVALS Record [PURGEVALS, numvals] @@ -1025,8 +1020,7 @@ new value indices will start from the given numvals value. -MODULE_CODE_GCNAME Record - +MODULE_CODE_GCNAME Record [GCNAME, ...string...] @@ -1040,8 +1034,9 @@ fields of FUNCTION records. -PARAMATTR_BLOCK Contents - + + PARAMATTR_BLOCK Contents + @@ -1061,8 +1056,7 @@ attribute lists). -PARAMATTR_CODE_ENTRY Record - +PARAMATTR_CODE_ENTRY Record @@ -1106,8 +1100,9 @@ the logarithm base 2 of the requested alignment, plus 1 -TYPE_BLOCK Contents - + + TYPE_BLOCK Contents + @@ -1127,8 +1122,7 @@ equivalent types). -TYPE_CODE_NUMENTRY Record - +TYPE_CODE_NUMENTRY Record @@ -1142,8 +1136,7 @@ in the block. -TYPE_CODE_VOID Record - +TYPE_CODE_VOID Record @@ -1155,8 +1148,7 @@ type table. -TYPE_CODE_FLOAT Record - +TYPE_CODE_FLOAT Record @@ -1168,8 +1160,7 @@ floating point) type to the type table. -TYPE_CODE_DOUBLE Record - +TYPE_CODE_DOUBLE Record @@ -1181,8 +1172,7 @@ floating point) type to the type table. -TYPE_CODE_LABEL Record - +TYPE_CODE_LABEL Record @@ -1194,8 +1184,7 @@ the type table. -TYPE_CODE_OPAQUE Record - +TYPE_CODE_OPAQUE Record @@ -1208,8 +1197,7 @@ unified. -TYPE_CODE_INTEGER Record - +TYPE_CODE_INTEGER Record @@ -1222,8 +1210,7 @@ integer type. -TYPE_CODE_POINTER Record - +TYPE_CODE_POINTER Record @@ -1243,8 +1230,7 @@ default address space is zero. -TYPE_CODE_FUNCTION Record - +TYPE_CODE_FUNCTION Record @@ -1268,8 +1254,7 @@ parameter types of the function -TYPE_CODE_STRUCT Record - +TYPE_CODE_STRUCT Record @@ -1287,8 +1272,7 @@ types of the structure -TYPE_CODE_ARRAY Record - +TYPE_CODE_ARRAY Record @@ -1305,8 +1289,7 @@ table. The operand fields are -TYPE_CODE_VECTOR Record - +TYPE_CODE_VECTOR Record @@ -1323,8 +1306,7 @@ table. The operand fields are -TYPE_CODE_X86_FP80 Record - +TYPE_CODE_X86_FP80 Record @@ -1336,8 +1318,7 @@ floating point) type to the type table. -TYPE_CODE_FP128 Record - +TYPE_CODE_FP128 Record @@ -1349,8 +1330,7 @@ floating point) type to the type table. -TYPE_CODE_PPC_FP128 Record - +TYPE_CODE_PPC_FP128 Record @@ -1362,8 +1342,7 @@ floating point) type to the type table. -TYPE_CODE_METADATA Record - +TYPE_CODE_METADATA Record @@ -1375,8 +1354,9 @@ type to the type table. -CONSTANTS_BLOCK Contents - + + CONSTANTS_BLOCK Contents + @@ -1387,8 +1367,9 @@ type to the type table. -FUNCTION_BLOCK Contents - + + FUNCTION_BLOCK Contents + @@ -1409,8 +1390,9 @@ type to the type table. -TYPE_SYMTAB_BLOCK Contents - + + TYPE_SYMTAB_BLOCK Contents + @@ -1422,8 +1404,7 @@ indices. -TST_CODE_ENTRY Record - +TST_CODE_ENTRY Record @@ -1438,8 +1419,9 @@ name. Each entry corresponds to a single named type. -VALUE_SYMTAB_BLOCK Contents - + + VALUE_SYMTAB_BLOCK Contents + @@ -1450,8 +1432,9 @@ name. Each entry corresponds to a single named type. -METADATA_BLOCK Contents - + + METADATA_BLOCK Contents + @@ -1462,8 +1445,9 @@ name. Each entry corresponds to a single named type. -METADATA_ATTACHMENT Contents - + + METADATA_ATTACHMENT Contents + diff --git a/docs/Bugpoint.html b/docs/Bugpoint.html index 6bbc9b70676..5568fc7baf9 100644 --- a/docs/Bugpoint.html +++ b/docs/Bugpoint.html @@ -6,9 +6,9 @@ - + LLVM bugpoint tool: design and usage - + Description @@ -27,9 +27,9 @@ - + Description - + @@ -50,9 +50,9 @@ href="HowToSubmitABug.html">How To Submit a Bug Report document. - + Design Philosophy - + @@ -71,9 +71,9 @@ executing it) takes a long time. - + Automatic Debugger Selection - + @@ -104,9 +104,9 @@ Otherwise, there is no problem bugpoint can debug. - + Crash debugger - + @@ -129,9 +129,9 @@ reproduce the failure with opt or llc. - + Code generator debugger - + @@ -150,9 +150,9 @@ good code. - + Miscompilation debugger - + @@ -167,9 +167,9 @@ assumes that the selected code generator is working properly. - + Advice for using bugpoint - + diff --git a/docs/CMake.html b/docs/CMake.html index 73e6f440e30..8ea4377dd51 100644 --- a/docs/CMake.html +++ b/docs/CMake.html @@ -6,9 +6,9 @@ - + Building LLVM with CMake - + Introduction @@ -36,9 +36,9 @@ - + Introduction - + @@ -59,9 +59,9 @@ - + Quick start - + @@ -112,9 +112,9 @@ - + Basic CMake usage - + @@ -160,9 +160,9 @@ - + Options and variables - + @@ -197,9 +197,9 @@ - + Frequently-used CMake variables - + @@ -240,9 +240,9 @@ - + LLVM-specific variables - + @@ -358,9 +358,9 @@ - + Executing the test suite - + @@ -378,9 +378,9 @@ - + Cross compiling - + @@ -399,9 +399,9 @@ - + Embedding LLVM in your project - + @@ -462,9 +462,9 @@ - + Developing LLVM pass out of source - + @@ -519,9 +519,9 @@ - + Compiler/Platform specific topics - + @@ -530,9 +530,9 @@ - + Microsoft Visual C++ - + diff --git a/docs/CodeGenerator.html b/docs/CodeGenerator.html index 5ca40afc33f..50036f2ed73 100644 --- a/docs/CodeGenerator.html +++ b/docs/CodeGenerator.html @@ -19,9 +19,9 @@ - + The LLVM Target-Independent Code Generator - + Introduction @@ -127,9 +127,9 @@ - + Introduction - + @@ -191,9 +191,9 @@ - + Required components in the code generator - + @@ -223,9 +223,9 @@ - + The high-level design of the code generator - + @@ -297,9 +297,9 @@ - + Using TableGen for target description - + @@ -325,9 +325,9 @@ - + Target description classes - + @@ -349,9 +349,9 @@ - + The TargetMachine class - + @@ -369,9 +369,9 @@ - + The TargetData class - + @@ -385,9 +385,9 @@ - + The TargetLowering class - + @@ -411,9 +411,9 @@ - + The TargetRegisterInfo class - + @@ -445,9 +445,9 @@ - + The TargetInstrInfo class - + @@ -463,9 +463,9 @@ - + The TargetFrameInfo class - + @@ -479,9 +479,9 @@ - + The TargetSubtarget class - + @@ -495,9 +495,9 @@ - + The TargetJITInfo class - + @@ -510,9 +510,9 @@ - + Machine code description classes - + @@ -531,9 +531,9 @@ - + The MachineInstr class - + @@ -579,9 +579,9 @@ - + Using the MachineInstrBuilder.h functions - + @@ -630,9 +630,9 @@ MI.addReg(Reg, RegState::Define); - + Fixed (preassigned) registers - + @@ -702,9 +702,9 @@ ret - + Machine code in SSA form - + @@ -720,9 +720,9 @@ ret - + The MachineBasicBlock class - + @@ -737,9 +737,9 @@ ret - + The MachineFunction class - + @@ -756,9 +756,9 @@ ret - + The "MC" Layer - + @@ -783,9 +783,9 @@ in this manual. - + The MCStreamer API - + @@ -817,9 +817,9 @@ MCObjectStreamer implements a full assembler. - + The MCContext class - + @@ -832,9 +832,9 @@ interact with to create symbols and sections. This class can not be subclassed. - + The MCSymbol class - + @@ -864,9 +864,9 @@ like this to the .s file: - + The MCSection class - + @@ -882,9 +882,9 @@ directive in a .s file). - + The MCInst class - + @@ -906,9 +906,9 @@ printer, and the type generated by the assembly parser and disassembler. - + Target-independent code generation algorithms - + @@ -920,9 +920,9 @@ printer, and the type generated by the assembly parser and disassembler. - + Instruction Selection - + @@ -939,9 +939,9 @@ printer, and the type generated by the assembly parser and disassembler. - + Introduction to SelectionDAGs - + @@ -1001,9 +1001,9 @@ printer, and the type generated by the assembly parser and disassembler. - + SelectionDAG Instruction Selection Process - + @@ -1082,9 +1082,9 @@ printer, and the type generated by the assembly parser and disassembler. - + Initial SelectionDAG Construction - + @@ -1102,9 +1102,9 @@ printer, and the type generated by the assembly parser and disassembler. - + SelectionDAG LegalizeTypes Phase - + @@ -1135,9 +1135,9 @@ printer, and the type generated by the assembly parser and disassembler. - + SelectionDAG Legalize Phase - + @@ -1167,10 +1167,11 @@ printer, and the type generated by the assembly parser and disassembler. - - SelectionDAG Optimization Phase: the DAG - Combiner - + + + SelectionDAG Optimization Phase: the DAG Combiner + + @@ -1202,9 +1203,9 @@ printer, and the type generated by the assembly parser and disassembler. - + SelectionDAG Select Phase - + @@ -1363,9 +1364,9 @@ def : Pat<(i32 imm:$imm), - + SelectionDAG Scheduling and Formation Phase - + @@ -1384,9 +1385,9 @@ def : Pat<(i32 imm:$imm), - + Future directions for the SelectionDAG - + @@ -1399,15 +1400,15 @@ def : Pat<(i32 imm:$imm), - + SSA-based Machine Code Optimizations - + To Be Written - + Live Intervals - + @@ -1420,9 +1421,9 @@ def : Pat<(i32 imm:$imm), - + Live Variable Analysis - + @@ -1466,9 +1467,9 @@ def : Pat<(i32 imm:$imm), - + Live Intervals Analysis - + @@ -1486,9 +1487,9 @@ def : Pat<(i32 imm:$imm), - + Register Allocation - + @@ -1504,9 +1505,9 @@ def : Pat<(i32 imm:$imm), - + How registers are represented in LLVM - + @@ -1617,9 +1618,9 @@ bool RegMapping_Fer::compatible_class(MachineFunction &mf, - + Mapping virtual registers to physical registers - + @@ -1667,9 +1668,9 @@ bool RegMapping_Fer::compatible_class(MachineFunction &mf, - + Handling two address instructions - + @@ -1703,9 +1704,9 @@ bool RegMapping_Fer::compatible_class(MachineFunction &mf, - + The SSA deconstruction phase - + @@ -1727,9 +1728,9 @@ bool RegMapping_Fer::compatible_class(MachineFunction &mf, - + Instruction folding - + @@ -1764,9 +1765,9 @@ bool RegMapping_Fer::compatible_class(MachineFunction &mf, - + Built in register allocators - + @@ -1806,20 +1807,20 @@ $ llc -regalloc=pbqp file.bc -o pbqp.s; - + Prolog/Epilog Code Insertion - + To Be Written - + Late Machine Code Optimizations - + To Be Written - + Code Emission - + @@ -1882,9 +1883,9 @@ to implement an assembler for your target. - + Implementing a Native Assembler - + @@ -1899,15 +1900,15 @@ compiler. -Instruction Parsing +Instruction Parsing To Be Written - + Instruction Alias Processing - + Once the instruction is parsed, it enters the MatchInstructionImpl function. @@ -1925,7 +1926,7 @@ description. -Mnemonic Aliases +Mnemonic Aliases @@ -1965,7 +1966,7 @@ on the current instruction set. -Instruction Aliases +Instruction Aliases @@ -2031,7 +2032,7 @@ subtarget specific. -Instruction Matching +Instruction Matching To Be Written @@ -2039,9 +2040,9 @@ subtarget specific. - + Target-specific Implementation Notes - + @@ -2053,9 +2054,9 @@ subtarget specific. - + Target Feature Matrix - + @@ -2231,7 +2232,7 @@ is the key: -Is Generally Reliable +Is Generally Reliable This box indicates whether the target is considered to be production quality. @@ -2241,7 +2242,7 @@ continuous use. -Assembly Parser +Assembly Parser This box indicates whether the target supports parsing target specific .s @@ -2253,7 +2254,7 @@ support in the native .o file writer. -Disassembler +Disassembler This box indicates whether the target supports the MCDisassembler API for @@ -2262,7 +2263,7 @@ disassembling machine opcode bytes into MCInst's. -Inline Asm +Inline Asm This box indicates whether the target supports most popular inline assembly @@ -2274,7 +2275,7 @@ constraints relating to the X86 floating point stack. -JIT Support +JIT Support This box indicates whether the target supports the JIT compiler through @@ -2286,7 +2287,7 @@ in ARM codegen mode, but lacks NEON and full Thumb support. -.o File Writing +.o File Writing @@ -2302,7 +2303,7 @@ file to a .o file (as is the case for many C compilers). -Tail Calls +Tail Calls @@ -2317,9 +2318,9 @@ more more details. - + Tail call optimization - + @@ -2383,9 +2384,9 @@ define fastcc i32 @tailcaller(i32 %in1, i32 %in2) { - + Sibling call optimization - + @@ -2427,9 +2428,9 @@ entry: - + The X86 backend - + @@ -2440,9 +2441,9 @@ entry: - + X86 Target Triples supported - + @@ -2469,9 +2470,9 @@ entry: - + X86 Calling Conventions supported - + @@ -2489,9 +2490,9 @@ entry: - + Representing X86 addressing modes in MachineInstrs - + @@ -2526,9 +2527,9 @@ OperandTy: VirtReg, | VirtReg, UnsImm, VirtReg, SignExtImm PhysReg - + X86 address spaces supported - + @@ -2571,9 +2572,9 @@ OperandTy: VirtReg, | VirtReg, UnsImm, VirtReg, SignExtImm PhysReg - + Instruction naming - + @@ -2592,9 +2593,9 @@ MOVSX32rm16 -> movsx, 32-bit register, 16-bit memory - + The PowerPC backend - + @@ -2605,9 +2606,9 @@ MOVSX32rm16 -> movsx, 32-bit register, 16-bit memory - + LLVM PowerPC ABI - + @@ -2625,9 +2626,9 @@ MOVSX32rm16 -> movsx, 32-bit register, 16-bit memory - + Frame Layout - + @@ -2772,9 +2773,9 @@ MOVSX32rm16 -> movsx, 32-bit register, 16-bit memory - + Prolog/Epilog - + @@ -2789,9 +2790,9 @@ MOVSX32rm16 -> movsx, 32-bit register, 16-bit memory - + Dynamic Allocation - + diff --git a/docs/CodingStandards.html b/docs/CodingStandards.html index 11655e01bac..ca31cab2ca0 100644 --- a/docs/CodingStandards.html +++ b/docs/CodingStandards.html @@ -7,9 +7,9 @@ - + LLVM Coding Standards - + Introduction @@ -83,9 +83,9 @@ - + Introduction - + @@ -117,20 +117,20 @@ href="mailto:sabre@nondot.org">Chris. - + Mechanical Source Issues - + - + Source Code Formatting - + - + Commenting - + @@ -208,9 +208,9 @@ happens: does the method return null? Abort? Format your hard disk? - + Comment Formatting - + @@ -233,9 +233,9 @@ These nest properly and are better behaved in general than C style comments. - + #include Style - + @@ -273,9 +273,9 @@ implements are defined. - + Source Code Width - + @@ -298,9 +298,9 @@ for debate. - + Use Spaces Instead of Tabs - + @@ -319,9 +319,9 @@ makes for incredible diffs that are absolutely worthless. - + Indent Code Consistently - + @@ -333,15 +333,15 @@ Just do it. - + Compiler Issues - + - + Treat Compiler Warnings Like Errors - + @@ -393,9 +393,9 @@ be fixed by massaging the code appropriately. - + Write Portable Code - + @@ -412,9 +412,9 @@ libSystem. - + Do not use RTTI or Exceptions - + In an effort to reduce code and executable size, LLVM does not use RTTI @@ -433,9 +433,9 @@ than dynamic_cast<>. - + Use of class and struct Keywords - + In C++, the class and struct keywords can be used almost @@ -455,23 +455,23 @@ which case struct is allowed. - + Style Issues - + - + The High-Level Issues - + - + A Public Header File is a Module - + @@ -499,9 +499,9 @@ translation unit. - + #include as Little as Possible - + @@ -528,9 +528,9 @@ dependencies that you'll find out about later. - + Keep "Internal" Headers Private - + @@ -549,9 +549,9 @@ class itself. Just make them private (or protected) and all is well. - + Use Early Exits and continue to Simplify Code - + @@ -658,9 +658,9 @@ can be a big understandability win. - + Don't use else after a return - + @@ -741,9 +741,9 @@ track of when reading the code. - + Turn Predicate Loops into Predicate Functions - + @@ -804,16 +804,18 @@ locality. - + The Low-Level Issues - + - - Name Types, Functions, Variables, and Enumerators Properly - + + + Name Types, Functions, Variables, and Enumerators Properly + + @@ -894,9 +896,9 @@ Vehicle MakeVehicle(VehicleType Type) { - + Assert Liberally - + @@ -997,9 +999,9 @@ assert(NewToSet && "The value shouldn't be in the set yet"); - + Do Not Use 'using namespace std' - + @@ -1035,10 +1037,11 @@ use any others. - - Provide a Virtual Method Anchor for Classes - in Headers - + + + Provide a Virtual Method Anchor for Classes in Headers + + @@ -1052,9 +1055,9 @@ increasing link times. - + Don't evaluate end() every time through a loop - + @@ -1114,9 +1117,9 @@ prefer it. - + #include <iostream> is Forbidden - + @@ -1149,9 +1152,9 @@ the llvm::MemoryBuffer API for reading files. - + Use raw_ostream - + @@ -1169,9 +1172,9 @@ declarations and constant references to raw_ostream instances. - + Avoid std::endl - + @@ -1193,18 +1196,18 @@ it's better to use a literal '\n'. - + Microscopic Details - + This section describes preferred low-level formatting guidelines along with reasoning on why we prefer them. - + Spaces Before Parentheses - + @@ -1260,9 +1263,9 @@ this misinterpretation. - + Prefer Preincrement - + @@ -1280,9 +1283,9 @@ get in the habit of always using preincrement, and you won't have a problem. - + Namespace Indentation - + @@ -1368,9 +1371,9 @@ the contents of the namespace. - + Anonymous Namespaces - + @@ -1455,9 +1458,9 @@ namespace just because it was declared there. - + See Also - + diff --git a/docs/CommandGuide/index.html b/docs/CommandGuide/index.html index 4ab1b511653..98e97ee000f 100644 --- a/docs/CommandGuide/index.html +++ b/docs/CommandGuide/index.html @@ -7,9 +7,9 @@ - + LLVM Command Guide - + @@ -23,9 +23,9 @@ options) arguments to the tool you are interested in. - + Basic Commands - + @@ -80,9 +80,9 @@ options) arguments to the tool you are interested in. - + C and C++ Front-end Commands - + @@ -99,9 +99,9 @@ options) arguments to the tool you are interested in. - + Debugging Tools - + @@ -123,9 +123,9 @@ options) arguments to the tool you are interested in. - + Internal Tools - + diff --git a/docs/CommandLine.html b/docs/CommandLine.html index 83b2ebbe511..0bcd38267cc 100644 --- a/docs/CommandLine.html +++ b/docs/CommandLine.html @@ -8,9 +8,9 @@ - + CommandLine 2.0 Library Manual - + Introduction @@ -100,9 +100,9 @@ - + Introduction - + @@ -184,9 +184,9 @@ href="mailto:sabre@nondot.org">Chris Lattner. - + Quick Start Guide - + @@ -324,9 +324,9 @@ OPTIONS: - + Boolean Arguments - + @@ -406,9 +406,9 @@ and lists of options. - + Argument Aliases - + @@ -456,10 +456,10 @@ uses. - + Selecting an alternative from a set of possibilities - + @@ -567,9 +567,9 @@ which is when you would use it. - + Named Alternatives - + @@ -629,9 +629,9 @@ that you can choose the form most appropriate for your application. - + Parsing a list of options - + @@ -699,9 +699,9 @@ checking we have to do. - + Collecting options as a set of flags - + @@ -758,9 +758,9 @@ href="#list"> cl::list option. - + Adding freeform text to help output - + @@ -802,9 +802,9 @@ OPTIONS: - + Reference Guide - + @@ -817,9 +817,9 @@ processing capabilities. - + Positional Arguments - + @@ -858,9 +858,9 @@ define all of your positional arguments in one .cpp file. - + Specifying positional options with hyphens - + @@ -895,9 +895,9 @@ can use it like this: - + Determining absolute position with getPosition() - + Sometimes an option can affect or modify the meaning of another option. For example, consider gcc's -x LANG option. This tells @@ -954,9 +954,9 @@ can use it like this: - + The cl::ConsumeAfter modifier - + @@ -1007,9 +1007,9 @@ href="#cl::list">cl::list option. - + Internal vs External Storage - + @@ -1076,9 +1076,9 @@ that DebugFlag is automatically set. - + Option Attributes - + @@ -1166,9 +1166,9 @@ obviously). - + Option Modifiers - + @@ -1199,9 +1199,9 @@ usually shouldn't have to worry about these. - + Hiding an option from -help output - + @@ -1230,10 +1230,10 @@ indicates that the option should not appear in any help output. - + Controlling the number of occurrences required and allowed - + @@ -1279,9 +1279,9 @@ retained. - + Controlling whether or not a value must be specified - + @@ -1328,9 +1328,9 @@ when extending the library. - + Controlling other formatting options - + @@ -1409,9 +1409,9 @@ strategy basically looks like this: - + Miscellaneous option modifiers - + @@ -1453,9 +1453,9 @@ only makes sense with a cl::list option. - + Response files - + @@ -1476,9 +1476,9 @@ and - + Top-Level Classes and Functions - + @@ -1493,10 +1493,10 @@ classes in detail. - + The cl::ParseCommandLineOptions function - + @@ -1514,10 +1514,10 @@ which holds additional extra text to emit when the - + The cl::ParseEnvironmentOptions function - + @@ -1551,10 +1551,10 @@ input. - + The cl::SetVersionPrinter function - + @@ -1572,9 +1572,9 @@ called when the --version option is given by the user. - + The cl::opt class - + @@ -1607,9 +1607,9 @@ href="#customparser">custom parser. - + The cl::list class - + @@ -1634,9 +1634,9 @@ be used. - + The cl::bits class - + @@ -1659,9 +1659,9 @@ must be of type unsigned if external storage is used. - + The cl::alias class - + @@ -1682,9 +1682,9 @@ the conversion from string to data. - + The cl::extrahelp class - + @@ -1710,9 +1710,9 @@ single cl::extrahelp instance. - + Builtin parsers - + @@ -1774,9 +1774,9 @@ exponential notation (ex: 1.7e15) and properly supports locales. - + Extension Guide - + @@ -1789,9 +1789,9 @@ the covers and illustrates how to do some simple, common, extensions. - + Writing a custom parser - + @@ -1932,9 +1932,9 @@ tutorial. - + Exploiting external storage - + Several of the LLVM libraries define static cl::opt instances that @@ -1951,9 +1951,9 @@ tutorial. - + Dynamically adding command line options - + diff --git a/docs/CompilerWriterInfo.html b/docs/CompilerWriterInfo.html index daee9316727..6be1b63e652 100644 --- a/docs/CompilerWriterInfo.html +++ b/docs/CompilerWriterInfo.html @@ -9,9 +9,9 @@ - + Architecture/platform information for compiler writers - + Note: This document is a work-in-progress. Additions and clarifications @@ -43,11 +43,11 @@ -Hardware +Hardware -Alpha +Alpha @@ -58,7 +58,7 @@ href="http://ftp.digital.com/pub/Digital/info/semiconductor/literature/dsc-libra -ARM +ARM @@ -70,7 +70,7 @@ Cores) -Itanium (ia64) +Itanium (ia64) @@ -81,7 +81,7 @@ href="http://developer.intel.com/design/itanium2/documentation.htm">Itanium docu -MIPS +MIPS @@ -92,10 +92,10 @@ Processor Architecture -PowerPC +PowerPC -IBM - Official manuals and docs +IBM - Official manuals and docs @@ -129,7 +129,7 @@ PowerPC architecture -Other documents, collections, notes +Other documents, collections, notes @@ -144,7 +144,7 @@ branch stubs for powerpc64-linux (from binutils) -SPARC +SPARC @@ -156,10 +156,10 @@ branch stubs for powerpc64-linux (from binutils) -X86 +X86 -AMD - Official manuals and docs +AMD - Official manuals and docs @@ -170,7 +170,7 @@ href="http://www.amd.com/us-en/Processors/TechnicalResources/0,,30_182_739,00.ht -Intel - Official manuals and docs +Intel - Official manuals and docs @@ -184,7 +184,7 @@ Itanium documentation -Other x86-specific information +Other x86-specific information @@ -194,7 +194,7 @@ conventions for different C++ compilers and operating systems -Other relevant lists +Other relevant lists @@ -205,11 +205,11 @@ conventions for different C++ compilers and operating systems -ABI +ABI -Linux +Linux @@ -219,7 +219,7 @@ Supplement -OS X +OS X @@ -233,7 +233,7 @@ ABI -Miscellaneous resources +Miscellaneous resources diff --git a/docs/DebuggingJITedCode.html b/docs/DebuggingJITedCode.html index 5b174d76565..f23fdf6f391 100644 --- a/docs/DebuggingJITedCode.html +++ b/docs/DebuggingJITedCode.html @@ -7,7 +7,7 @@ -Debugging JITed Code With GDB +Debugging JITed Code With GDB Example usage Background @@ -15,7 +15,7 @@ Written by Reid Kleckner -Example usage +Example usage @@ -96,7 +96,7 @@ function names. -Background +Background diff --git a/docs/DeveloperPolicy.html b/docs/DeveloperPolicy.html index 633de1aa03f..5d6c2d85590 100644 --- a/docs/DeveloperPolicy.html +++ b/docs/DeveloperPolicy.html @@ -8,7 +8,7 @@ -LLVM Developer Policy +LLVM Developer Policy Introduction Developer Policies @@ -34,7 +34,7 @@ Written by the LLVM Oversight Team -Introduction +Introduction This document contains the LLVM Developer Policy which defines the project's @@ -63,7 +63,7 @@ -Developer Policies +Developer Policies This section contains policies that pertain to frequent LLVM developers. We @@ -75,7 +75,7 @@ - Stay Informed +Stay Informed Developers should stay informed by reading at least the "dev" mailing list for the projects you are interested in, such as @@ -102,7 +102,7 @@ - Making a Patch +Making a Patch When making a patch for review, the goal is to make it as easy for the @@ -142,7 +142,7 @@ - Code Reviews +Code Reviews LLVM has a code review policy. Code review is one way to increase the quality of software. We generally follow these policies: @@ -174,7 +174,7 @@ - Code Owners +Code Owners The LLVM Project relies on two features of its process to maintain rapid @@ -225,7 +225,7 @@ - Test Cases +Test Cases Developers are required to create test cases for any bugs fixed and any new features added. Some tips for getting your testcase approved: @@ -258,7 +258,7 @@ - Quality +Quality The minimum quality standards that any change must satisfy before being committed to the main development branch are: @@ -318,8 +318,7 @@ - - Obtaining Commit Access +Obtaining Commit Access We grant commit access to contributors with a track record of submitting high @@ -381,7 +380,7 @@ - Making a Major Change +Making a Major Change When a developer begins a major new project with the aim of contributing it back to LLVM, s/he should inform the community with an email to @@ -410,8 +409,7 @@ - Incremental Development - +Incremental Development In the LLVM project, we do all significant changes as a series of incremental patches. We have a strong dislike for huge changes or long-term development @@ -472,8 +470,7 @@ -Attribution of -Changes +Attribution of Changes We believe in correct attribution of contributions to their contributors. However, we do not want the source code to be littered with random @@ -487,9 +484,9 @@ Changes - + Copyright, License, and Patents - + @@ -507,7 +504,7 @@ Changes -Copyright +Copyright The LLVM project does not require copyright assignments, which means that the @@ -530,7 +527,7 @@ Changes -License +License We intend to keep LLVM perpetually open source and to use a liberal open source license. All of the code in LLVM is available under the @@ -585,7 +582,7 @@ Changes -Patents +Patents To the best of our knowledge, LLVM does not infringe on any patents (we have actually removed code from LLVM in the past that was found to infringe). diff --git a/docs/ExceptionHandling.html b/docs/ExceptionHandling.html index 1738bdf5cc1..09e09461429 100644 --- a/docs/ExceptionHandling.html +++ b/docs/ExceptionHandling.html @@ -11,7 +11,7 @@ - Exception Handling in LLVM +Exception Handling in LLVM @@ -58,7 +58,7 @@ -Introduction +Introduction @@ -73,9 +73,9 @@ - + Itanium ABI Zero-cost Exception Handling - + @@ -106,9 +106,9 @@ - + Setjmp/Longjmp Exception Handling - + @@ -138,9 +138,9 @@ - + Overview - + @@ -186,9 +186,9 @@ - + LLVM Code Generation - + @@ -203,9 +203,9 @@ - + Throw - + @@ -225,9 +225,9 @@ - + Try/Catch - + @@ -313,9 +313,9 @@ - + Cleanups - + @@ -332,9 +332,9 @@ - + Throw Filters - + @@ -359,9 +359,9 @@ - + Restrictions - + @@ -385,9 +385,9 @@ - + Exception Handling Intrinsics - + @@ -398,9 +398,9 @@ - + llvm.eh.exception - + @@ -413,9 +413,9 @@ - + llvm.eh.selector - + @@ -445,9 +445,9 @@ - + llvm.eh.typeid.for - + @@ -463,9 +463,9 @@ - + llvm.eh.sjlj.setjmp - + @@ -492,9 +492,9 @@ - + llvm.eh.sjlj.longjmp - + @@ -512,9 +512,9 @@ - + llvm.eh.sjlj.lsda - + @@ -531,9 +531,9 @@ - + llvm.eh.sjlj.callsite - + @@ -549,9 +549,9 @@ - + llvm.eh.sjlj.dispatchsetup - + @@ -566,9 +566,9 @@ - + Asm Table Formats - + @@ -578,9 +578,9 @@ - + Exception Handling Frame - + @@ -596,9 +596,9 @@ - + Exception Tables - + @@ -612,9 +612,9 @@ - + ToDo - + diff --git a/docs/ExtendingLLVM.html b/docs/ExtendingLLVM.html index df706eac557..7f77bb77921 100644 --- a/docs/ExtendingLLVM.html +++ b/docs/ExtendingLLVM.html @@ -8,9 +8,9 @@ - + Extending LLVM: Adding instructions, intrinsics, types, etc. - + Introduction and Warning @@ -31,9 +31,9 @@ - + Introduction and Warning - + @@ -68,9 +68,9 @@ effort by doing so. - + Adding a new intrinsic function - + @@ -130,9 +130,9 @@ support for it. Generally you must do the following steps: - + Adding a new SelectionDAG node - + @@ -220,9 +220,9 @@ complicated behavior in a single node (rotate). - + Adding a new instruction - + @@ -277,9 +277,9 @@ to understand this new instruction. - + Adding a new type - + @@ -291,9 +291,9 @@ installations. Only add new types if it is absolutely necessary. - + Adding a fundamental type - + @@ -317,9 +317,9 @@ installations. Only add new types if it is absolutely necessary. - + Adding a derived type - + diff --git a/docs/FAQ.html b/docs/FAQ.html index ae3a0da6f81..620cf2500a4 100644 --- a/docs/FAQ.html +++ b/docs/FAQ.html @@ -12,9 +12,9 @@ - + LLVM: Frequently Asked Questions - + License @@ -138,9 +138,9 @@ - + License - + @@ -189,9 +189,9 @@ - + Source Code - + @@ -227,9 +227,9 @@ LLVM have been ported to a plethora of platforms. - + Build Problems - + @@ -449,7 +449,9 @@ Stop. -Source Languages + + Source Languages + What source languages are supported? @@ -555,9 +557,9 @@ Stop. - + Using the GCC Front End - + When I compile software that uses a configure script, the configure script @@ -712,9 +714,9 @@ Stop. - + Questions about code generated by the GCC front-end - + What is this llvm.global_ctors and diff --git a/docs/GCCFEBuildInstrs.html b/docs/GCCFEBuildInstrs.html index 6714a4988ae..f3c94594977 100644 --- a/docs/GCCFEBuildInstrs.html +++ b/docs/GCCFEBuildInstrs.html @@ -8,9 +8,9 @@ - + Building the LLVM GCC Front-End - + Building llvm-gcc from Source diff --git a/docs/GarbageCollection.html b/docs/GarbageCollection.html index bd114b562fc..aa83a2d6d83 100644 --- a/docs/GarbageCollection.html +++ b/docs/GarbageCollection.html @@ -13,9 +13,9 @@ - + Accurate Garbage Collection with LLVM - + Introduction @@ -79,9 +79,9 @@ - + Introduction - + @@ -127,9 +127,9 @@ support accurate garbage collection. - + Goals and non-goals - + @@ -199,9 +199,9 @@ compiler matures. - + Getting started - + @@ -249,9 +249,9 @@ into llc and works even with the interpreter and C backends. - + In your compiler - + @@ -276,9 +276,9 @@ switching to a more advanced GC. - + In your runtime - + @@ -343,9 +343,9 @@ void visitGCRoots(void (*Visitor)(void **Root, const void *Meta)) { } - + About the shadow stack - + @@ -373,9 +373,9 @@ in order to improve performance. - + IR features - + @@ -393,9 +393,9 @@ program. - + Specifying GC code generation: gc "..." - + define ty @name(...) gc "name" { ... @@ -418,9 +418,9 @@ programs that use different garbage collection algorithms (or none at all). - + Identifying GC roots on the stack: llvm.gcroot - + void @llvm.gcroot(i8** %ptrloc, i8* %metadata) @@ -494,9 +494,9 @@ CodeBlock: - + Reading and writing references in the heap - + @@ -537,9 +537,9 @@ are used. - + Write barrier: llvm.gcwrite - + void @llvm.gcwrite(i8* %value, i8* %object, i8** %derived) @@ -559,9 +559,9 @@ implement reference counting. - + Read barrier: llvm.gcread - + i8* @llvm.gcread(i8* %object, i8** %derived) @@ -581,9 +581,9 @@ writes. - + Implementing a collector plugin - + @@ -669,9 +669,9 @@ as a language-specific compiler front-end. - + Overview of available features - + @@ -958,9 +958,9 @@ interest. - + Computing stack maps - + @@ -1014,9 +1014,9 @@ for collector plugins which implement reference counting or a shadow stack. - + Initializing roots to null: InitRoots - + @@ -1039,10 +1039,10 @@ this feature should be used by all GC plugins. It is enabled by default. - + Custom lowering of intrinsics: CustomRoots, CustomReadBarriers, and CustomWriteBarriers - + @@ -1129,9 +1129,9 @@ bool MyGC::performCustomLowering(Function &F) { - + Generating safe points: NeededSafePoints - + @@ -1193,9 +1193,9 @@ safe point (because only the topmost function has been patched). - + Emitting assembly code: GCMetadataPrinter - + @@ -1343,9 +1343,9 @@ void MyGCPrinter::finishAssembly(std::ostream &OS, AsmPrinter &AP, - + References - + diff --git a/docs/GetElementPtr.html b/docs/GetElementPtr.html index 9e3f8bb2bca..d1c5b6c5367 100644 --- a/docs/GetElementPtr.html +++ b/docs/GetElementPtr.html @@ -11,9 +11,9 @@ - + The Often Misunderstood GEP Instruction - + Introduction @@ -58,7 +58,7 @@ -Introduction +Introduction @@ -72,7 +72,7 @@ -Address Computation +Address Computation When people are first confronted with the GEP instruction, they tend to @@ -83,9 +83,9 @@ - - What is the first index of the GEP instruction? - + + What is the first index of the GEP instruction? + Quick answer: The index stepping through the first operand. The confusion with the first index usually arises from thinking about @@ -205,9 +205,9 @@ idx3 = (char*) &MyVar + 8 - - Why is the extra 0 index required? - + + Why is the extra 0 index required? + Quick answer: there are no superfluous indices. @@ -247,9 +247,9 @@ idx3 = (char*) &MyVar + 8 - - What is dereferenced by GEP? - + + What is dereferenced by GEP? + Quick answer: nothing. The GetElementPtr instruction dereferences nothing. That is, it doesn't @@ -302,9 +302,9 @@ idx3 = (char*) &MyVar + 8 - - Why don't GEP x,0,0,1 and GEP x,1 alias? - + + Why don't GEP x,0,0,1 and GEP x,1 alias? + Quick Answer: They compute different address locations. If you look at the first indices in these GEP @@ -331,9 +331,9 @@ idx3 = (char*) &MyVar + 8 - - Why do GEP x,1,0,0 and GEP x,1 alias? - + + Why do GEP x,1,0,0 and GEP x,1 alias? + Quick Answer: They compute the same address location. These two GEP instructions will compute the same address because indexing @@ -355,9 +355,9 @@ idx3 = (char*) &MyVar + 8 - - Can GEP index into vector elements? - + + Can GEP index into vector elements? + This hasn't always been forcefully disallowed, though it's not recommended. It leads to awkward special cases in the optimizers, and fundamental @@ -368,9 +368,9 @@ idx3 = (char*) &MyVar + 8 - - What effect do address spaces have on GEPs? - + + What effect do address spaces have on GEPs? + None, except that the address space qualifier on the first operand pointer type always matches the address space qualifier on the result type. @@ -379,10 +379,11 @@ idx3 = (char*) &MyVar + 8 - - How is GEP different from ptrtoint, arithmetic, - and inttoptr? - + + + How is GEP different from ptrtoint, arithmetic, and inttoptr? + + It's very similar; there are only subtle differences. @@ -409,10 +410,12 @@ idx3 = (char*) &MyVar + 8 - - I'm writing a backend for a target which needs custom - lowering for GEP. How do I do this? - + + + I'm writing a backend for a target which needs custom lowering for GEP. + How do I do this? + + You don't. The integer computation implied by a GEP is target-independent. Typically what you'll need to do is make your backend pattern-match @@ -431,9 +434,9 @@ idx3 = (char*) &MyVar + 8 - - How does VLA addressing work with GEPs? - + + How does VLA addressing work with GEPs? + GEPs don't natively support VLAs. LLVM's type system is entirely static, and GEP address computations are guided by an LLVM type. @@ -451,14 +454,14 @@ idx3 = (char*) &MyVar + 8 -Rules +Rules - - What happens if an array index is out of bounds? - + + What happens if an array index is out of bounds? + There are two senses in which an array index can be out of bounds. @@ -498,9 +501,9 @@ idx3 = (char*) &MyVar + 8 - - Can array indices be negative? - + + Can array indices be negative? + Yes. This is basically a special case of array indices being out of bounds. @@ -508,9 +511,9 @@ idx3 = (char*) &MyVar + 8 - - Can I compare two values computed with GEPs? - + + Can I compare two values computed with GEPs? + Yes. If both addresses are within the same allocated object, or one-past-the-end, you'll get the comparison result you expect. If either @@ -520,10 +523,12 @@ idx3 = (char*) &MyVar + 8 - - Can I do GEP with a different pointer type than the type of - the underlying object? - + + + Can I do GEP with a different pointer type than the type of + the underlying object? + + Yes. There are no restrictions on bitcasting a pointer value to an arbitrary pointer type. The types in a GEP serve only to define the parameters for the @@ -538,10 +543,11 @@ idx3 = (char*) &MyVar + 8 - - Can I cast an object's address to integer and add it - to null? - + + + Can I cast an object's address to integer and add it to null? + + You can compute an address that way, but if you use GEP to do the add, you can't use that pointer to actually access the object, unless the @@ -562,10 +568,12 @@ idx3 = (char*) &MyVar + 8 - - Can I compute the distance between two objects, and add - that value to one address to compute the other address? - + + + Can I compute the distance between two objects, and add + that value to one address to compute the other address? + + As with arithmetic on null, You can use GEP to compute an address that way, but you can't use that pointer to actually access the object if you @@ -577,9 +585,9 @@ idx3 = (char*) &MyVar + 8 - - Can I do type-based alias analysis on LLVM IR? - + + Can I do type-based alias analysis on LLVM IR? + You can't do type-based alias analysis using LLVM's built-in type system, because LLVM has no restrictions on mixing types in addressing, loads or @@ -594,9 +602,9 @@ idx3 = (char*) &MyVar + 8 - - What happens if a GEP computation overflows? - + + What happens if a GEP computation overflows? + If the GEP lacks the inbounds keyword, the value is the result from evaluating the implied two's complement integer computation. However, @@ -624,10 +632,11 @@ idx3 = (char*) &MyVar + 8 - - How can I tell if my front-end is following the - rules? - + + + How can I tell if my front-end is following the rules? + + There is currently no checker for the getelementptr rules. Currently, the only way to do this is to manually check each place in your front-end @@ -642,14 +651,14 @@ idx3 = (char*) &MyVar + 8 -Rationale +Rationale - - Why is GEP designed this way? - + + Why is GEP designed this way? + The design of GEP has the following goals, in rough unofficial order of priority: @@ -669,9 +678,9 @@ idx3 = (char*) &MyVar + 8 - - Why do struct member indices always use i32? - + + Why do struct member indices always use i32? + The specific type i32 is probably just a historical artifact, however it's wide enough for all practical purposes, so there's been no need to change it. @@ -684,9 +693,9 @@ idx3 = (char*) &MyVar + 8 - - What's an uglygep? - + + What's an uglygep? + Some LLVM optimizers operate on GEPs by internally lowering them into more primitive integer expressions, which allows them to be combined @@ -705,7 +714,7 @@ idx3 = (char*) &MyVar + 8 -Summary +Summary diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html index d6706119708..2bca7ae643a 100644 --- a/docs/GettingStarted.html +++ b/docs/GettingStarted.html @@ -8,9 +8,9 @@ - + Getting Started with the LLVM System - + Overview @@ -70,9 +70,9 @@ - - Overview - + + Overview + @@ -102,9 +102,9 @@ and performance. - - Getting Started Quickly (A Summary) - + + Getting Started Quickly (A Summary) + @@ -191,9 +191,9 @@ Layout to learn about the layout of the source code tree. - - Requirements - + + Requirements + @@ -205,9 +205,9 @@ software you will need. - - Hardware - + + Hardware + @@ -370,7 +370,9 @@ href="GCCFEBuildInstrs.html">try to compile it on your platform. -Software + + Software + Compiling LLVM requires that you have several software packages installed. The table below lists those required packages. The Package column @@ -508,9 +510,9 @@ href="GCCFEBuildInstrs.html">try to compile it on your platform. - + Broken versions of GCC and other tools - + @@ -608,9 +610,9 @@ upgrading to a newer version of Gold. - - Getting Started with LLVM - + + Getting Started with LLVM + @@ -626,9 +628,9 @@ help via e-mail. - + Terminology and Notation - + @@ -663,9 +665,9 @@ All these paths are absolute: - + Setting Up Your Environment - + @@ -686,9 +688,9 @@ variables. - + Unpacking the LLVM Archives - + @@ -720,9 +722,9 @@ compressed with the gzip program. - + Checkout LLVM from Subversion - + @@ -791,9 +793,9 @@ instructions to successfully get and build the LLVM GCC front-end. - + GIT mirror - + @@ -810,9 +812,9 @@ instructions to successfully get and build the LLVM GCC front-end. - + Install the GCC Front End - + @@ -880,9 +882,9 @@ please let us know how you would like to see things improved by dropping us a no - + Local LLVM Configuration - + @@ -1002,9 +1004,9 @@ script to configure the build system: - + Compiling the LLVM Suite Source Code - + @@ -1136,9 +1138,9 @@ that directory that is out of date. - + Cross-Compiling LLVM - + It is possible to cross-compile LLVM itself. That is, you can create LLVM @@ -1154,9 +1156,9 @@ that directory that is out of date. - + The Location of LLVM Object Files - + @@ -1214,9 +1216,9 @@ named after the build type: - + Optional Configuration Items - + @@ -1250,9 +1252,9 @@ $ sudo update-binfmts --install llvm /path/to/lli --magic 'BC' - - Program Layout - + + Program Layout + @@ -1265,14 +1267,20 @@ The following is a brief introduction to code layout: -llvm/examples + + llvm/examples + + This directory contains some simple examples of how to use the LLVM IR and JIT. -llvm/include + + llvm/include + + This directory contains public header files exported from the LLVM @@ -1300,7 +1308,10 @@ library. The three main subdirectories of this directory are: -llvm/lib + + llvm/lib + + This directory contains most of the source files of the LLVM system. In LLVM, @@ -1366,7 +1377,10 @@ different tools. -llvm/projects + + llvm/projects + + This directory contains projects that are not strictly part of LLVM but are shipped with LLVM. This is also the directory where you should create your own @@ -1375,7 +1389,10 @@ different tools. -llvm/runtime + + llvm/runtime + + This directory contains libraries which are compiled into LLVM bitcode and @@ -1389,7 +1406,10 @@ end to compile. -llvm/test + + llvm/test + + This directory contains feature and regression tests and other basic sanity checks on the LLVM infrastructure. These are intended to run quickly and cover @@ -1397,7 +1417,10 @@ end to compile. -test-suite + + test-suite + + This is not a directory in the normal llvm module; it is a separate Subversion @@ -1413,7 +1436,10 @@ end to compile. -llvm/tools + + llvm/tools + + The tools directory contains the executables built out of the @@ -1498,7 +1524,10 @@ information is in the Command Guide. -llvm/utils + + llvm/utils + + This directory contains utilities for working with LLVM source code, and some @@ -1561,9 +1590,9 @@ are code generators for parts of LLVM infrastructure. - + An Example Using the LLVM Tool Chain - + @@ -1580,7 +1609,9 @@ output. -Example with llvm-gcc4 + + Example with llvm-gcc4 + @@ -1665,9 +1696,9 @@ int main() { - + Common Problems - + @@ -1679,9 +1710,9 @@ Asked Questions page. - + Links - + diff --git a/docs/GettingStartedVS.html b/docs/GettingStartedVS.html index 113ba493994..469b5376afb 100644 --- a/docs/GettingStartedVS.html +++ b/docs/GettingStartedVS.html @@ -8,9 +8,9 @@ - + Getting Started with the LLVM System using Microsoft Visual Studio - + Overview @@ -31,9 +31,9 @@ - + Overview - + @@ -70,9 +70,9 @@ - + Requirements - + @@ -84,9 +84,9 @@ - + Hardware - + @@ -97,7 +97,7 @@ -Software +Software You will need Visual Studio .NET 2005 SP1 or higher. The VS2005 SP1 @@ -119,9 +119,9 @@ - + Getting Started - + @@ -229,9 +229,9 @@ - + An Example Using the LLVM Tool Chain - + @@ -319,9 +319,9 @@ int main() { - + Common Problems - + @@ -333,9 +333,9 @@ Asked Questions page. - + Links - + diff --git a/docs/GoldPlugin.html b/docs/GoldPlugin.html index 051d8a49433..7ba11866278 100644 --- a/docs/GoldPlugin.html +++ b/docs/GoldPlugin.html @@ -7,7 +7,7 @@ -LLVM gold plugin +LLVM gold plugin Introduction How to build it @@ -21,7 +21,7 @@ Written by Nick Lewycky -Introduction +Introduction Building with link time optimization requires cooperation from the @@ -38,7 +38,7 @@ The same plugin can also be used by other tools such as ar and nm. -How to build it +How to build it You need to have gold with plugin support and build the LLVMgold @@ -72,7 +72,7 @@ placed. -Usage +Usage The linker takes a -plugin option that points to the path of @@ -98,9 +98,9 @@ placed. - + Example of link time optimization - + The following example shows a worked example of the gold plugin mixing @@ -150,7 +150,11 @@ $ llvm-gcc -use-gold-plugin a.a b.o -o main # <-- link with LLVMgold plugin -Quickstart for using LTO with autotooled projects + + + Quickstart for using LTO with autotooled projects + + Once your system ld, ar and nm all support LLVM @@ -189,7 +193,7 @@ export CFLAGS="-O4" -Licensing +Licensing Gold is licensed under the GPLv3. LLVMgold uses the interface file diff --git a/docs/HowToReleaseLLVM.html b/docs/HowToReleaseLLVM.html index 85398d4fca6..59e78646300 100644 --- a/docs/HowToReleaseLLVM.html +++ b/docs/HowToReleaseLLVM.html @@ -7,7 +7,7 @@ - How To Release LLVM To The Public +How To Release LLVM To The Public Introduction Qualification Criteria @@ -23,7 +23,7 @@ -Introduction +Introduction @@ -36,7 +36,7 @@ -Release Timeline +Release Timeline @@ -76,7 +76,7 @@ -Release Process +Release Process @@ -122,7 +122,7 @@ -Release Administrative Tasks +Release Administrative Tasks @@ -138,7 +138,7 @@ -Create Release Branch +Create Release Branch @@ -198,7 +198,7 @@ $ svn co https://llvm.org/svn/llvm-project/cfe/branches/release_XY clang- -Update LLVM Version +Update LLVM Version @@ -214,7 +214,7 @@ $ svn co https://llvm.org/svn/llvm-project/cfe/branches/release_XY clang- -Build the LLVM Release Candidates +Build the LLVM Release Candidates @@ -269,7 +269,7 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g -Building the Release +Building the Release @@ -290,7 +290,7 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g -Build LLVM +Build LLVM @@ -302,7 +302,7 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g -Build the LLVM GCC Binary Distribution +Build the LLVM GCC Binary Distribution @@ -329,7 +329,7 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g -Build Clang Binary Distribution +Build Clang Binary Distribution @@ -350,7 +350,7 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g -Target Specific Build Details +Target Specific Build Details @@ -372,8 +372,7 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g - -Building the Release +Building the Release @@ -394,7 +393,7 @@ Building the Release -Qualify LLVM +Qualify LLVM @@ -405,7 +404,7 @@ Building the Release -Qualify LLVM-GCC +Qualify LLVM-GCC @@ -418,7 +417,7 @@ Building the Release -Qualify Clang +Qualify Clang @@ -429,8 +428,7 @@ Building the Release -Specific Target -Qualification Details +Specific Target Qualification Details @@ -447,7 +445,7 @@ Qualification Details -Community Testing +Community Testing Once all testing has been completed and appropriate bugs filed, the release @@ -484,7 +482,7 @@ Qualification Details -Release Patch Rules +Release Patch Rules @@ -508,8 +506,7 @@ Qualification Details -Release Final Tasks - +Release Final Tasks @@ -521,7 +518,7 @@ Qualification Details -Update Documentation +Update Documentation @@ -535,7 +532,7 @@ Qualification Details -Tag the LLVM Final Release +Tag the LLVM Final Release @@ -560,7 +557,7 @@ $ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_XY \ -Update the LLVM Demo Page +Update the LLVM Demo Page @@ -570,7 +567,7 @@ $ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_XY \ -Update the LLVM Website +Update the LLVM Website @@ -606,7 +603,7 @@ $ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_XY \ -Announce the Release +Announce the Release diff --git a/docs/HowToSubmitABug.html b/docs/HowToSubmitABug.html index b9d8362e32a..ca34384621b 100644 --- a/docs/HowToSubmitABug.html +++ b/docs/HowToSubmitABug.html @@ -7,9 +7,9 @@ - + How to submit an LLVM bug report - + @@ -37,9 +37,9 @@ - + Introduction - Got bugs? - + @@ -76,9 +76,9 @@ information: - + Crashing Bugs - + @@ -112,9 +112,9 @@ with the following extra command line options: - + Front-end bugs - + @@ -137,9 +137,9 @@ has instructions on the best way to use delta. - + Compile-time optimization bugs - + @@ -171,9 +171,9 @@ that bugpoint emits. If something goes wrong with bugpoint, please submit the - + Code generator bugs - + @@ -208,9 +208,9 @@ that bugpoint emits. If something goes wrong with bugpoint, please submit the - + Miscompilations - + @@ -241,9 +241,9 @@ error. - + Incorrect code generation - + diff --git a/docs/LangRef.html b/docs/LangRef.html index 8c5ba804c74..69e0a75951f 100644 --- a/docs/LangRef.html +++ b/docs/LangRef.html @@ -12,7 +12,7 @@ - LLVM Language Reference Manual +LLVM Language Reference Manual Abstract Introduction @@ -321,7 +321,7 @@ - Abstract +Abstract @@ -335,7 +335,7 @@ - Introduction +Introduction @@ -362,7 +362,9 @@ - Well-Formedness + + Well-Formedness + @@ -387,7 +389,7 @@ - Identifiers +Identifiers @@ -475,12 +477,13 @@ - High Level Structure +High Level Structure - Module Structure - + + Module Structure + @@ -528,9 +531,9 @@ define i32 @main() { ; i32()* - + Linkage Types - + @@ -677,9 +680,9 @@ define i32 @main() { ; i32()* - + Calling Conventions - + @@ -750,9 +753,9 @@ define i32 @main() { ; i32()* - + Visibility Styles - + @@ -784,9 +787,9 @@ define i32 @main() { ; i32()* - + Named Types - + @@ -815,9 +818,9 @@ define i32 @main() { ; i32()* - + Global Variables - + @@ -883,9 +886,9 @@ define i32 @main() { ; i32()* - + Functions - + @@ -946,9 +949,9 @@ define [linkage] [visibility] - + Aliases - + @@ -965,9 +968,9 @@ define [linkage] [visibility] - + Named Metadata - + @@ -988,7 +991,9 @@ define [linkage] [visibility] -Parameter Attributes + + Parameter Attributes + @@ -1097,9 +1102,9 @@ declare signext i8 @returns_signed_char() - + Garbage Collector Names - + @@ -1117,9 +1122,9 @@ define void @f() gc "name" { ... } - + Function Attributes - + @@ -1240,9 +1245,9 @@ define void @f() optsize { ... } - + Module-Level Inline Assembly - + @@ -1266,9 +1271,9 @@ module asm "more can go here" - + Data Layout - + @@ -1378,9 +1383,9 @@ target datalayout = "layout specification" - + Pointer Aliasing Rules - + @@ -1442,9 +1447,9 @@ to implement type-based alias analysis. - + Volatile Memory Accesses - + @@ -1460,7 +1465,7 @@ synchronization behavior. - Type System +Type System @@ -1476,8 +1481,9 @@ synchronization behavior. - Type -Classifications + + Type Classifications + @@ -1536,7 +1542,9 @@ Classifications - Primitive Types + + Primitive Types + @@ -1546,7 +1554,9 @@ Classifications - Integer Type + + Integer Type + @@ -1582,7 +1592,9 @@ Classifications - Floating Point Types + + Floating Point Types + @@ -1600,7 +1612,9 @@ Classifications - X86mmx Type + + X86mmx Type + @@ -1615,7 +1629,9 @@ Classifications - Void Type + + Void Type + @@ -1630,7 +1646,9 @@ Classifications - Label Type + + Label Type + @@ -1645,7 +1663,9 @@ Classifications - Metadata Type + + Metadata Type + @@ -1663,7 +1683,9 @@ Classifications - Derived Types + + Derived Types + @@ -1678,7 +1700,9 @@ Classifications - Aggregate Types + + Aggregate Types + @@ -1690,7 +1714,9 @@ Classifications - Array Type + + Array Type + @@ -1748,7 +1774,9 @@ Classifications - Function Type + + Function Type + @@ -1801,7 +1829,9 @@ Classifications - Structure Type + + Structure Type + @@ -1839,8 +1869,9 @@ Classifications - Packed Structure Type - + + Packed Structure Type + @@ -1877,7 +1908,9 @@ Classifications - Pointer Type + + Pointer Type + @@ -1921,7 +1954,9 @@ Classifications - Vector Type + + Vector Type + @@ -1960,7 +1995,10 @@ Classifications - Opaque Type + + Opaque Type + + Overview: @@ -1985,9 +2023,9 @@ Classifications - + Type Up-references - + @@ -2033,7 +2071,7 @@ Classifications - Constants +Constants @@ -2044,7 +2082,9 @@ Classifications -Simple Constants + + Simple Constants + @@ -2099,10 +2139,10 @@ Classifications - + Complex Constants - + @@ -2154,9 +2194,9 @@ Classifications - + Global Variable and Function Addresses - + @@ -2176,7 +2216,10 @@ Classifications -Undefined Values + + Undefined Values + + The string 'undef' can be used anywhere a constant is expected, and @@ -2316,7 +2359,10 @@ b: unreachable -Trap Values + + Trap Values + + Trap values are similar to undef values, however @@ -2441,8 +2487,10 @@ second_end: -Addresses of Basic - Blocks + + Addresses of Basic Blocks + + blockaddress(@function, %block) @@ -2468,8 +2516,9 @@ second_end: -Constant Expressions - + + Constant Expressions + @@ -2598,13 +2647,13 @@ second_end: - Other Values +Other Values - + Inline Assembler Expressions - + @@ -2657,9 +2706,9 @@ call void asm alignstack "eieio", ""() another document that covers inline asm from a holistic perspective. - + Inline Asm Metadata - + @@ -2683,9 +2732,9 @@ call void asm sideeffect "something bad", ""(), !srcloc !42 -Metadata Nodes and Metadata - Strings - + + Metadata Nodes and Metadata Strings + @@ -2731,9 +2780,9 @@ call void @llvm.dbg.value(metadata !24, i64 0, metadata !25) - + Intrinsic Global Variables - + LLVM has a number of "magic" global variables that contain data that affect @@ -2743,9 +2792,9 @@ section and all globals that start with "llvm." are reserved for use by LLVM. - + The 'llvm.used' Global Variable - + @@ -2778,9 +2827,11 @@ object file to prevent the assembler and linker from molesting the symbol. - -The 'llvm.compiler.used' Global Variable - + + + The 'llvm.compiler.used' Global Variable + + @@ -2796,9 +2847,9 @@ should not be exposed to source languages. - + The 'llvm.global_ctors' Global Variable - + @@ -2811,9 +2862,9 @@ should not be exposed to source languages. - + The 'llvm.global_dtors' Global Variable - + @@ -2828,7 +2879,7 @@ should not be exposed to source languages. - Instruction Reference +Instruction Reference @@ -2843,8 +2894,9 @@ should not be exposed to source languages. - Terminator -Instructions + + Terminator Instructions + @@ -2867,8 +2919,9 @@ Instructions - 'ret' -Instruction + + 'ret' Instruction + @@ -2916,7 +2969,9 @@ Instruction - 'br' Instruction + + 'br' Instruction + @@ -2957,9 +3012,9 @@ IfUnequal: - + 'switch' Instruction - + @@ -3012,9 +3067,9 @@ IfUnequal: - + 'indirectbr' Instruction - + @@ -3060,9 +3115,9 @@ IfUnequal: - + 'invoke' Instruction - + @@ -3150,8 +3205,9 @@ that the invoke/unwind semantics are likely to change in future versions. - 'unwind' -Instruction + + 'unwind' Instruction + @@ -3181,8 +3237,9 @@ that the invoke/unwind semantics are likely to change in future versions. - 'unreachable' -Instruction + + 'unreachable' Instruction + @@ -3203,7 +3260,9 @@ Instruction - Binary Operations + + Binary Operations + @@ -3218,9 +3277,9 @@ Instruction - + 'add' Instruction - + @@ -3263,9 +3322,9 @@ Instruction - + 'fadd' Instruction - + @@ -3293,9 +3352,9 @@ Instruction - + 'sub' Instruction - + @@ -3345,9 +3404,9 @@ Instruction - + 'fsub' Instruction - + @@ -3381,9 +3440,9 @@ Instruction - + 'mul' Instruction - + @@ -3431,9 +3490,9 @@ Instruction - + 'fmul' Instruction - + @@ -3461,8 +3520,9 @@ Instruction - 'udiv' Instruction - + + 'udiv' Instruction + @@ -3501,8 +3561,9 @@ Instruction - 'sdiv' Instruction - + + 'sdiv' Instruction + @@ -3543,8 +3604,9 @@ Instruction - 'fdiv' -Instruction + + 'fdiv' Instruction + @@ -3572,8 +3634,9 @@ Instruction - 'urem' Instruction - + + 'urem' Instruction + @@ -3609,9 +3672,9 @@ Instruction - + 'srem' Instruction - + @@ -3660,8 +3723,9 @@ Instruction - - 'frem' Instruction + + 'frem' Instruction + @@ -3691,8 +3755,9 @@ Instruction - Bitwise Binary -Operations + + Bitwise Binary Operations + @@ -3705,8 +3770,9 @@ Operations - 'shl' -Instruction + + 'shl' Instruction + @@ -3755,8 +3821,9 @@ Instruction - 'lshr' -Instruction + + 'lshr' Instruction + @@ -3801,8 +3868,10 @@ Instruction - 'ashr' -Instruction + + 'ashr' Instruction + + Syntax: @@ -3846,8 +3915,9 @@ Instruction - 'and' -Instruction + + 'and' Instruction + @@ -3906,7 +3976,9 @@ Instruction - 'or' Instruction + + 'or' Instruction + @@ -3967,8 +4039,9 @@ Instruction

- 'xor' -Instruction + + 'xor' Instruction + @@ -4031,9 +4104,9 @@ Instruction

- + Vector Operations - + @@ -4047,9 +4120,9 @@ Instruction

- + 'extractelement' Instruction - + @@ -4083,9 +4156,9 @@ Instruction

- + 'insertelement' Instruction - + @@ -4119,9 +4192,9 @@ Instruction

- + 'shufflevector' Instruction - + @@ -4167,9 +4240,9 @@ Instruction - + Aggregate Operations - + @@ -4179,9 +4252,9 @@ Instruction - + 'extractvalue' Instruction - + @@ -4221,9 +4294,9 @@ Instruction - + 'insertvalue' Instruction - + @@ -4261,9 +4334,9 @@ Instruction - + Memory Access and Addressing Operations - + @@ -4275,9 +4348,9 @@ Instruction - + 'alloca' Instruction - + @@ -4326,8 +4399,9 @@ Instruction - 'load' -Instruction + + 'load' Instruction + @@ -4384,8 +4458,9 @@ Instruction - 'store' -Instruction + + 'store' Instruction + @@ -4445,9 +4520,9 @@ Instruction - + 'getelementptr' Instruction - + @@ -4576,8 +4651,9 @@ entry: - Conversion Operations - + + Conversion Operations + @@ -4588,9 +4664,10 @@ entry: - + 'trunc .. to' Instruction - + + Syntax: @@ -4627,9 +4704,10 @@ entry: - + 'zext .. to' Instruction - + + Syntax: @@ -4666,9 +4744,10 @@ entry: - + 'sext .. to' Instruction - + + Syntax: @@ -4704,9 +4783,9 @@ entry: - + 'fptrunc .. to' Instruction - + @@ -4742,9 +4821,10 @@ entry: - + 'fpext .. to' Instruction - + + Syntax: @@ -4778,9 +4858,10 @@ entry: - + 'fptoui .. to' Instruction - + + Syntax: @@ -4815,9 +4896,10 @@ entry: - + 'fptosi .. to' Instruction - + + Syntax: @@ -4853,9 +4935,10 @@ entry: - + 'uitofp .. to' Instruction - + + Syntax: @@ -4889,9 +4972,10 @@ entry: - + 'sitofp .. to' Instruction - + + Syntax: @@ -4924,9 +5008,10 @@ entry: - + 'ptrtoint .. to' Instruction - + + Syntax: @@ -4961,9 +5046,10 @@ entry: - + 'inttoptr .. to' Instruction - + + Syntax: @@ -4998,9 +5084,10 @@ entry: - + 'bitcast .. to' Instruction - + + Syntax: @@ -5041,7 +5128,9 @@ entry: - Other Operations + + Other Operations + @@ -5051,8 +5140,9 @@ entry: -'icmp' Instruction - + + 'icmp' Instruction + @@ -5153,8 +5243,9 @@ entry: -'fcmp' Instruction - + + 'fcmp' Instruction + @@ -5273,9 +5364,9 @@ entry: - + 'phi' Instruction - + @@ -5321,9 +5412,9 @@ Loop: ; Infinite loop that counts from 0 on up... - + 'select' Instruction - + @@ -5364,9 +5455,9 @@ Loop: ; Infinite loop that counts from 0 on up... - + 'call' Instruction - + @@ -5473,9 +5564,9 @@ freestanding environments and non-C-based languages. - + 'va_arg' Instruction - + @@ -5519,7 +5610,7 @@ freestanding environments and non-C-based languages. - Intrinsic Functions +Intrinsic Functions @@ -5568,9 +5659,9 @@ freestanding environments and non-C-based languages. - + Variable Argument Handling Intrinsics - + @@ -5617,9 +5708,9 @@ declare void @llvm.va_end(i8*) - + 'llvm.va_start' Intrinsic - + @@ -5648,9 +5739,9 @@ declare void @llvm.va_end(i8*) - + 'llvm.va_end' Intrinsic - + @@ -5679,9 +5770,9 @@ declare void @llvm.va_end(i8*) - + 'llvm.va_copy' Intrinsic - + @@ -5710,9 +5801,9 @@ declare void @llvm.va_end(i8*) - + Accurate Garbage Collection Intrinsics - + @@ -5732,9 +5823,9 @@ LLVM. - + 'llvm.gcroot' Intrinsic - + @@ -5763,9 +5854,9 @@ LLVM. - + 'llvm.gcread' Intrinsic - + @@ -5795,9 +5886,9 @@ LLVM. - + 'llvm.gcwrite' Intrinsic - + @@ -5827,9 +5918,9 @@ LLVM. - + Code Generator Intrinsics - + @@ -5839,9 +5930,9 @@ LLVM. - + 'llvm.returnaddress' Intrinsic - + @@ -5874,9 +5965,9 @@ LLVM. - + 'llvm.frameaddress' Intrinsic - + @@ -5908,9 +5999,9 @@ LLVM. - + 'llvm.stacksave' Intrinsic - + @@ -5938,9 +6029,9 @@ LLVM. - + 'llvm.stackrestore' Intrinsic - + @@ -5963,9 +6054,9 @@ LLVM. - + 'llvm.prefetch' Intrinsic - + @@ -5996,9 +6087,9 @@ LLVM. - + 'llvm.pcmarker' Intrinsic - + @@ -6027,9 +6118,9 @@ LLVM. - + 'llvm.readcyclecounter' Intrinsic - + @@ -6054,9 +6145,9 @@ LLVM. - + Standard C Library Intrinsics - + @@ -6068,9 +6159,9 @@ LLVM. - + 'llvm.memcpy' Intrinsic - + @@ -6122,9 +6213,9 @@ LLVM. - + 'llvm.memmove' Intrinsic - + @@ -6178,9 +6269,9 @@ LLVM. - + 'llvm.memset.*' Intrinsics - + @@ -6228,9 +6319,9 @@ LLVM. - + 'llvm.sqrt.*' Intrinsic - + @@ -6266,9 +6357,9 @@ LLVM. - + 'llvm.powi.*' Intrinsic - + @@ -6302,9 +6393,9 @@ LLVM. - + 'llvm.sin.*' Intrinsic - + @@ -6336,9 +6427,9 @@ LLVM. - + 'llvm.cos.*' Intrinsic - + @@ -6370,9 +6461,9 @@ LLVM. - + 'llvm.pow.*' Intrinsic - + @@ -6405,9 +6496,9 @@ LLVM. - + Bit Manipulation Intrinsics - + @@ -6417,9 +6508,9 @@ LLVM. - + 'llvm.bswap.*' Intrinsics - + @@ -6452,9 +6543,9 @@ LLVM. - + 'llvm.ctpop.*' Intrinsic - + @@ -6484,9 +6575,9 @@ LLVM. - + 'llvm.ctlz.*' Intrinsic - + @@ -6518,9 +6609,9 @@ LLVM. - + 'llvm.cttz.*' Intrinsic - + @@ -6552,9 +6643,9 @@ LLVM. - + Arithmetic with Overflow Intrinsics - + @@ -6563,9 +6654,11 @@ LLVM. - - 'llvm.sadd.with.overflow.*' Intrinsics - + + + 'llvm.sadd.with.overflow.*' Intrinsics + + @@ -6609,9 +6702,11 @@ LLVM. - - 'llvm.uadd.with.overflow.*' Intrinsics - + + + 'llvm.uadd.with.overflow.*' Intrinsics + + @@ -6654,9 +6749,11 @@ LLVM. - - 'llvm.ssub.with.overflow.*' Intrinsics - + + + 'llvm.ssub.with.overflow.*' Intrinsics + + @@ -6700,9 +6797,11 @@ LLVM. - - 'llvm.usub.with.overflow.*' Intrinsics - + + + 'llvm.usub.with.overflow.*' Intrinsics + + @@ -6746,9 +6845,11 @@ LLVM. - - 'llvm.smul.with.overflow.*' Intrinsics - + + + 'llvm.smul.with.overflow.*' Intrinsics + + @@ -6793,9 +6894,11 @@ LLVM. - - 'llvm.umul.with.overflow.*' Intrinsics - + + + 'llvm.umul.with.overflow.*' Intrinsics + + @@ -6839,9 +6942,9 @@ LLVM. - + Half Precision Floating Point Intrinsics - + @@ -6860,9 +6963,11 @@ LLVM. - - 'llvm.convert.to.fp16' Intrinsic - + + + 'llvm.convert.to.fp16' Intrinsic + + @@ -6895,9 +7000,11 @@ LLVM. - - 'llvm.convert.from.fp16' Intrinsic - + + + 'llvm.convert.from.fp16' Intrinsic + + @@ -6930,9 +7037,9 @@ LLVM. - + Debugger Intrinsics - + @@ -6944,9 +7051,9 @@ LLVM. - + Exception Handling Intrinsics - + @@ -6958,9 +7065,9 @@ LLVM. - + Trampoline Intrinsic - + @@ -6991,9 +7098,11 @@ LLVM. - - 'llvm.init.trampoline' Intrinsic - + + + 'llvm.init.trampoline' Intrinsic + + @@ -7033,9 +7142,9 @@ LLVM. - + Atomic Operations and Synchronization Intrinsics - + @@ -7060,9 +7169,10 @@ LLVM. - + 'llvm.memory.barrier' Intrinsic - + + Syntax: @@ -7131,9 +7241,9 @@ LLVM. - + 'llvm.atomic.cmp.swap.*' Intrinsic - + @@ -7191,9 +7301,10 @@ LLVM. - + 'llvm.atomic.swap.*' Intrinsic - + + Syntax: @@ -7247,10 +7358,9 @@ LLVM. - + 'llvm.atomic.load.add.*' Intrinsic - - + @@ -7297,10 +7407,9 @@ LLVM. - + 'llvm.atomic.load.sub.*' Intrinsic - - + @@ -7349,12 +7458,23 @@ LLVM. - - 'llvm.atomic.load.and.*' Intrinsic - 'llvm.atomic.load.nand.*' Intrinsic - 'llvm.atomic.load.or.*' Intrinsic - 'llvm.atomic.load.xor.*' Intrinsic - + + + 'llvm.atomic.load.and.*' Intrinsic + + + + 'llvm.atomic.load.nand.*' Intrinsic + + + + 'llvm.atomic.load.or.*' Intrinsic + + + + 'llvm.atomic.load.xor.*' Intrinsic + + @@ -7429,12 +7549,23 @@ LLVM. - - 'llvm.atomic.load.max.*' Intrinsic - 'llvm.atomic.load.min.*' Intrinsic - 'llvm.atomic.load.umax.*' Intrinsic - 'llvm.atomic.load.umin.*' Intrinsic - + + + 'llvm.atomic.load.max.*' Intrinsic + + + + 'llvm.atomic.load.min.*' Intrinsic + + + + 'llvm.atomic.load.umax.*' Intrinsic + + + + 'llvm.atomic.load.umin.*' Intrinsic + + @@ -7509,9 +7640,9 @@ LLVM. - + Memory Use Markers - + @@ -7521,9 +7652,9 @@ LLVM. - + 'llvm.lifetime.start' Intrinsic - + @@ -7551,9 +7682,9 @@ LLVM. - + 'llvm.lifetime.end' Intrinsic - + @@ -7580,9 +7711,9 @@ LLVM. - + 'llvm.invariant.start' Intrinsic - + @@ -7608,9 +7739,9 @@ LLVM. - + 'llvm.invariant.end' Intrinsic - + @@ -7635,9 +7766,9 @@ LLVM. - + General Intrinsics - + @@ -7647,9 +7778,9 @@ LLVM. - + 'llvm.var.annotation' Intrinsic - + @@ -7675,9 +7806,9 @@ LLVM. - + 'llvm.annotation.*' Intrinsic - + @@ -7711,9 +7842,9 @@ LLVM. - + 'llvm.trap' Intrinsic - + @@ -7736,9 +7867,9 @@ LLVM. - + 'llvm.stackprotector' Intrinsic - + @@ -7770,9 +7901,9 @@ LLVM. - + 'llvm.objectsize' Intrinsic - + diff --git a/docs/Lexicon.html b/docs/Lexicon.html index 682bd080628..458da8013ed 100644 --- a/docs/Lexicon.html +++ b/docs/Lexicon.html @@ -9,10 +9,10 @@ content="A glossary of terms used with the LLVM project."> -The LLVM Lexicon +The LLVM Lexicon NOTE: This document is a work in progress! -Table Of Contents +Table Of Contents @@ -83,10 +83,10 @@ -Definitions +Definitions -- A - +- A - ADCE @@ -94,7 +94,7 @@ -- B - +- B - BURS @@ -104,7 +104,7 @@ href="http://www.program-transformation.org/Transform/BURG">BURG tool. -- C - +- C - CSE @@ -116,7 +116,7 @@ href="http://www.program-transformation.org/Transform/BURG">BURG tool. -- D - +- D - DAG @@ -136,7 +136,7 @@ href="http://www.program-transformation.org/Transform/BURG">BURG tool. -- G - +- G - GC @@ -145,7 +145,7 @@ href="http://www.program-transformation.org/Transform/BURG">BURG tool. -- H - +- H - Heap @@ -154,7 +154,7 @@ href="http://www.program-transformation.org/Transform/BURG">BURG tool. -- I - +- I - IPA @@ -169,7 +169,7 @@ href="http://www.program-transformation.org/Transform/BURG">BURG tool. -- L - +- L - LCSSA @@ -183,7 +183,7 @@ href="http://www.program-transformation.org/Transform/BURG">BURG tool. -- M - +- M - MC @@ -191,7 +191,7 @@ href="http://www.program-transformation.org/Transform/BURG">BURG tool. -- O - +- O - Object Pointer @@ -202,7 +202,7 @@ href="http://www.program-transformation.org/Transform/BURG">BURG tool. -- P - +- P - PRE @@ -211,7 +211,7 @@ href="http://www.program-transformation.org/Transform/BURG">BURG tool. -- R - +- R - RAUW An abbreviation for Replace @@ -234,7 +234,7 @@ href="http://www.program-transformation.org/Transform/BURG">BURG tool. -- S - +- S - Safe Point diff --git a/docs/LinkTimeOptimization.html b/docs/LinkTimeOptimization.html index 05011e63d24..720a5e460ab 100644 --- a/docs/LinkTimeOptimization.html +++ b/docs/LinkTimeOptimization.html @@ -6,9 +6,9 @@ - + LLVM Link Time Optimization: Design and Implementation - + Description @@ -36,9 +36,9 @@ - + Description - + @@ -50,9 +50,9 @@ and design between the LTO optimizer and the linker. - + Design Philosophy - + @@ -72,9 +72,9 @@ conservative escape analysis. - + Example of link time optimization - + The following example illustrates the advantages of LTO's integrated @@ -145,9 +145,9 @@ $ llvm-gcc a.o main.o -o main # <-- standard link command without any modific - + Alternative Approaches - + @@ -176,9 +176,9 @@ $ llvm-gcc a.o main.o -o main # <-- standard link command without any modific - + Multi-phase communication between libLTO and linker - + The linker collects information about symbol defininitions and uses in @@ -195,9 +195,9 @@ $ llvm-gcc a.o main.o -o main # <-- standard link command without any modific - + Phase 1 : Read LLVM Bitcode Files - + The linker first reads all object files in natural order and collects @@ -219,9 +219,9 @@ $ llvm-gcc a.o main.o -o main # <-- standard link command without any modific - + Phase 2 : Symbol Resolution - + In this stage, the linker resolves symbols using global symbol table. @@ -233,9 +233,9 @@ $ llvm-gcc a.o main.o -o main # <-- standard link command without any modific - + Phase 3 : Optimize Bitcode Files - + After symbol resolution, the linker tells the LTO shared object which symbols are needed by native object files. In the example above, the linker @@ -248,9 +248,9 @@ $ llvm-gcc a.o main.o -o main # <-- standard link command without any modific - + Phase 4 : Symbol Resolution after optimization - + In this phase, the linker reads optimized a native object file and @@ -265,9 +265,9 @@ $ llvm-gcc a.o main.o -o main # <-- standard link command without any modific - + libLTO - + libLTO is a shared object that is part of the LLVM tools, and @@ -281,9 +281,9 @@ $ llvm-gcc a.o main.o -o main # <-- standard link command without any modific - + lto_module_t - + @@ -325,9 +325,9 @@ lto_module_get_symbol_attribute(lto_module_t, unsigned int) - + lto_code_gen_t - + diff --git a/docs/MakefileGuide.html b/docs/MakefileGuide.html index f50e335b151..a85314ab282 100644 --- a/docs/MakefileGuide.html +++ b/docs/MakefileGuide.html @@ -7,7 +7,7 @@ -LLVM Makefile Guide +LLVM Makefile Guide Introduction @@ -77,7 +77,7 @@ -Introduction +Introduction @@ -99,7 +99,7 @@ -General Concepts +General Concepts @@ -111,7 +111,7 @@ -Projects +Projects The LLVM Makefile System is quite generous. It not only builds its own software, but it can build yours too. Built into the system is knowledge of @@ -129,7 +129,7 @@ -Variable Values +Variable Values To use the makefile system, you simply create a file named Makefile in your directory and declare values for certain variables. @@ -139,7 +139,7 @@ -Including Makefiles +Including Makefiles Setting variables alone is not enough. You must include into your Makefile additional files that provide the rules of the LLVM Makefile system. The @@ -147,7 +147,7 @@ -Makefile +Makefile Each directory to participate in the build needs to have a file named Makefile. This is the file first read by make. It has three @@ -163,8 +163,7 @@ -Makefile.common - +Makefile.common Every project must have a Makefile.common file at its top source directory. This file serves three purposes: @@ -182,8 +181,7 @@ -Makefile.config - +Makefile.config Every project must have a Makefile.config at the top of its build directory. This file is generated by the @@ -196,7 +194,7 @@ -Makefile.rules +Makefile.rules This file, located at $(LLVM_SRC_ROOT)/Makefile.rules is the heart of the LLVM Makefile System. It provides all the logic, dependencies, and @@ -206,7 +204,7 @@ -Comments +Comments User Makefiles need not have comments in them unless the construction is unusual or it does not strictly follow the rules and patterns of the LLVM @@ -216,7 +214,7 @@ -Tutorial +Tutorial This section provides some examples of the different kinds of modules you @@ -226,7 +224,7 @@ -Libraries +Libraries Only a few variable definitions are needed to build a regular library. Normally, the makefile system will build all the software into a single @@ -259,7 +257,7 @@ -Bitcode Modules +Bitcode Modules In some situations, it is desirable to build a single bitcode module from a variety of sources, instead of an archive, shared library, or bitcode @@ -280,9 +278,9 @@ - + Loadable Modules - + In some situations, you need to create a loadable module. Loadable modules can be loaded into programs like opt or llc to specify @@ -312,7 +310,7 @@ -Tools +Tools For building executable programs (tools), you must provide the name of the tool and the names of the libraries you wish to link with the tool. For @@ -347,7 +345,7 @@ -JIT Tools +JIT Tools Many tools will want to use the JIT features of LLVM. To do this, you simply specify that you want an execution 'engine', and the makefiles will @@ -368,7 +366,7 @@ -Targets Supported +Targets Supported @@ -429,7 +427,7 @@ -all (default) +all (default) When you invoke make with no arguments, you are implicitly instructing it to seek the "all" target (goal). This target is used for @@ -440,14 +438,14 @@ -all-local +all-local This target is the same as all but it operates only on the current directory instead of recursively. -check +check This target can be invoked from anywhere within a project's directories but always invokes the check-local target @@ -464,7 +462,7 @@ -check-local +check-local This target should be implemented by the Makefile in the project's test directory. It is invoked by the check target elsewhere. @@ -475,7 +473,7 @@ -clean +clean This target cleans the build directory, recursively removing all things that the Makefile builds. The cleaning rules have been made guarded so they @@ -484,14 +482,14 @@ -clean-local +clean-local This target does the same thing as clean but only for the current (local) directory. -dist +dist This target builds a distribution tarball. It first builds the entire project using the all target and then tars up the necessary files and @@ -500,7 +498,7 @@ -dist-check +dist-check This target does the same thing as the dist target but also checks the distribution tarball. The check is made by unpacking the tarball to a new @@ -512,7 +510,7 @@ -dist-clean +dist-clean This is a special form of the clean clean target. It performs a normal clean but also removes things pertaining to building the @@ -520,7 +518,7 @@ -install +install This target finalizes shared objects and executables and copies all libraries, headers, executables and documentation to the directory given @@ -538,7 +536,7 @@ -preconditions +preconditions This utility target checks to see if the Makefile in the object directory is older than the Makefile in the source directory and @@ -549,14 +547,14 @@ -printvars +printvars This utility target just causes the LLVM makefiles to print out some of the makefile variables so that you can double check how things are set. -reconfigure +reconfigure This utility target will force a reconfigure of LLVM or your project. It simply runs $(PROJ_OBJ_ROOT)/config.status --recheck to rerun the @@ -566,7 +564,7 @@ -spotless +spotless This utility target, only available when $(PROJ_OBJ_ROOT) is not the same as $(PROJ_SRC_ROOT), will completely clean the @@ -578,7 +576,7 @@ -tags +tags This target will generate a TAGS file in the top-level source directory. It is meant for use with emacs, XEmacs, or ViM. The TAGS file @@ -587,7 +585,7 @@ -uninstall +uninstall This target is the opposite of the install target. It removes the header, library and executable files from the installation directories. Note @@ -596,7 +594,7 @@ -Variables +Variables Variables are used to tell the LLVM Makefile System what to do and to @@ -609,7 +607,7 @@ -Control Variables +Control Variables Variables listed in the table below should be set before the inclusion of $(LEVEL)/Makefile.common. @@ -762,7 +760,7 @@ -Override Variables +Override Variables Override variables can be used to override the default values provided by the LLVM makefile system. These variables can be set in @@ -868,7 +866,7 @@ -Readable Variables +Readable Variables Variables listed in the table below can be used by the user's Makefile but should not be changed. Changing the value will generally cause the build to go @@ -939,7 +937,7 @@ -Internal Variables +Internal Variables Variables listed below are used by the LLVM Makefile System and considered internal. You should not use these variables under any diff --git a/docs/Packaging.html b/docs/Packaging.html index 3376bbcdb4a..86d6ca1ef03 100644 --- a/docs/Packaging.html +++ b/docs/Packaging.html @@ -7,7 +7,7 @@ - Advice on Packaging LLVM +Advice on Packaging LLVM Overview Compile Flags @@ -17,7 +17,7 @@ -Overview +Overview @@ -34,7 +34,7 @@ developed against each. -Compile Flags +Compile Flags @@ -65,7 +65,7 @@ versions of LLVM in parallel. The following configure flags are relevant: -C++ Features +C++ Features @@ -78,7 +78,7 @@ versions of LLVM in parallel. The following configure flags are relevant: -Shared Library +Shared Library @@ -89,7 +89,7 @@ against it. This saves lots of binary size at the cost of some startup time. -Dependencies +Dependencies diff --git a/docs/Passes.html b/docs/Passes.html index 9a5ad91bfef..8b993379756 100644 --- a/docs/Passes.html +++ b/docs/Passes.html @@ -1,4 +1,4 @@ - @@ -40,7 +40,7 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! --> - LLVM's Analysis and Transform Passes +LLVM's Analysis and Transform Passes Introduction @@ -55,7 +55,7 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - Introduction +Introduction This document serves as a high level summary of the optimization features that LLVM provides. Optimizations are implemented as Passes that traverse some @@ -204,15 +204,15 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - Analysis Passes +Analysis Passes This section describes the LLVM Analysis Passes. - + -aa-eval: Exhaustive Alias Analysis Precision Evaluator - + This is a simple N^2 alias analysis accuracy evaluator. Basically, for each function in the program, it simply queries to see how the @@ -224,9 +224,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -basicaa: Basic Alias Analysis (stateless AA impl) - + This is the default implementation of the Alias Analysis interface @@ -236,17 +236,17 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -basiccg: Basic CallGraph Construction - + Yet to be written. - + -count-aa: Count Alias Analysis Query Responses - + A pass which can be used to count how many alias queries @@ -255,9 +255,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -debug-aa: AA use debugger - + This simple pass checks alias analysis users to ensure that if they @@ -272,9 +272,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -domfrontier: Dominance Frontier Construction - + This pass is a simple dominator construction algorithm for finding forward @@ -283,9 +283,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -domtree: Dominator Tree Construction - + This pass is a simple dominator construction algorithm for finding forward @@ -294,9 +294,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -dot-callgraph: Print Call Graph to 'dot' file - + This pass, only available in opt, prints the call graph into a @@ -306,9 +306,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -dot-cfg: Print CFG of function to 'dot' file - + This pass, only available in opt, prints the control flow graph @@ -318,9 +318,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -dot-cfg-only: Print CFG of function to 'dot' file (with no function bodies) - + This pass, only available in opt, prints the control flow graph @@ -331,9 +331,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -dot-dom: Print dominance tree of function to 'dot' file - + This pass, only available in opt, prints the dominator tree @@ -343,9 +343,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -dot-dom-only: Print dominance tree of function to 'dot' file (with no function bodies) - + This pass, only available in opt, prints the dominator tree @@ -356,9 +356,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -dot-postdom: Print postdominance tree of function to 'dot' file - + This pass, only available in opt, prints the post dominator tree @@ -368,9 +368,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -dot-postdom-only: Print postdominance tree of function to 'dot' file (with no function bodies) - + This pass, only available in opt, prints the post dominator tree @@ -381,9 +381,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -globalsmodref-aa: Simple mod/ref analysis for globals - + This simple pass provides alias and mod/ref information for global values @@ -394,9 +394,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -instcount: Counts the various types of Instructions - + This pass collects the count of all instructions and reports them @@ -404,9 +404,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -intervals: Interval Partition Construction - + This analysis calculates and represents the interval partition of a function, @@ -420,43 +420,43 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -iv-users: Induction Variable Users - + Bookkeeping for "interesting" users of expressions computed from induction variables. - + -lazy-value-info: Lazy Value Information Analysis - + Interface for lazy computation of value constraint information. - + -lda: Loop Dependence Analysis - + Loop dependence analysis framework, which is used to detect dependences in memory accesses in loops. - + -libcall-aa: LibCall Alias Analysis - + LibCall Alias Analysis. - + -lint: Statically lint-checks LLVM IR - + This pass statically checks for common and easily-identified constructs which produce undefined or likely unintended behavior in LLVM IR. @@ -485,9 +485,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -loops: Natural Loop Information - + This analysis is used to identify natural loops and determine the loop depth @@ -498,9 +498,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -memdep: Memory Dependence Analysis - + An analysis that determines, for a given memory operation, what preceding @@ -511,9 +511,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -module-debuginfo: Decodes module-level debug info - + This pass decodes the debug info metadata in a module and prints in a (sufficiently-prepared-) human-readable form. @@ -524,9 +524,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -no-aa: No Alias Analysis (always returns 'may' alias) - + Always returns "I don't know" for alias queries. NoAA is unlike other alias @@ -536,9 +536,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -no-profile: No Profile Information - + The default "no profile" implementation of the abstract @@ -547,9 +547,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -postdomfrontier: Post-Dominance Frontier Construction - + This pass is a simple post-dominator construction algorithm for finding @@ -558,9 +558,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -postdomtree: Post-Dominator Tree Construction - + This pass is a simple post-dominator construction algorithm for finding @@ -569,17 +569,17 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -print-alias-sets: Alias Set Printer - + Yet to be written. - + -print-callgraph: Print a call graph - + This pass, only available in opt, prints the call graph to @@ -588,9 +588,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -print-callgraph-sccs: Print SCCs of the Call Graph - + This pass, only available in opt, prints the SCCs of the call @@ -599,9 +599,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -print-cfg-sccs: Print SCCs of each function CFG - + This pass, only available in opt, prints the SCCs of each @@ -610,9 +610,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -print-dbginfo: Print debug info in human readable form - + Pass that prints instructions, and associated debug info: @@ -624,17 +624,17 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -print-dom-info: Dominator Info Printer - + Dominator Info Printer. - + -print-externalfnconstants: Print external fn callsites passed constants - + This pass, only available in opt, prints out call sites to @@ -645,9 +645,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -print-function: Print function to stderr - + The PrintFunctionPass class is designed to be pipelined with @@ -657,9 +657,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -print-module: Print module to stderr - + This pass simply prints out the entire module when it is executed. @@ -667,9 +667,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -print-used-types: Find Used Types - + This pass is used to seek out all of the types in use by the program. Note @@ -678,9 +678,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -profile-estimator: Estimate profiling information - + Profiling information that estimates the profiling information in a very crude and unimaginative way. @@ -688,9 +688,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -profile-loader: Load profile information from llvmprof.out - + A concrete implementation of profiling information that loads the information @@ -699,15 +699,15 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -profile-verifier: Verify profiling information - + Pass that checks profiling information for plausibility. - + -regions: Detect single entry single exit regions - + The RegionInfo pass detects single entry single exit regions in a @@ -718,9 +718,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -scalar-evolution: Scalar Evolution Analysis - + The ScalarEvolution analysis can be used to analyze and @@ -737,9 +737,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -scev-aa: ScalarEvolution-based Alias Analysis - + Simple alias analysis implemented in terms of ScalarEvolution queries. @@ -753,24 +753,24 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -targetdata: Target Data Layout - + Provides other passes access to information on how the size and alignment required by the the target ABI for various data types. - Transform Passes +Transform Passes This section describes the LLVM Transform Passes. - + -adce: Aggressive Dead Code Elimination - + ADCE aggressively tries to eliminate code. This pass is similar to DCE but it assumes that values are dead until proven @@ -779,18 +779,18 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -always-inline: Inliner for always_inline functions - + A custom inliner that handles only functions that are marked as "always inline". - + -argpromotion: Promote 'by reference' arguments to scalars - + This pass promotes "by reference" arguments to be "by value" arguments. In @@ -819,9 +819,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -block-placement: Profile Guided Basic Block Placement - + This pass is a very simple profile guided basic block placement algorithm. The idea is to put frequently executed blocks together at the start of the @@ -831,9 +831,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -break-crit-edges: Break critical edges in CFG - + Break all of the critical edges in the CFG by inserting a dummy basic block. @@ -844,9 +844,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -codegenprepare: Optimize for code generation - + This pass munges the code in the input function to better prepare it for SelectionDAG-based code generation. This works around limitations in it's @@ -854,9 +854,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -constmerge: Merge Duplicate Global Constants - + Merges duplicate global constants together into a single constant that is @@ -867,9 +867,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -constprop: Simple constant propagation - + This file implements constant propagation and merging. It looks for instructions involving only constant operands and replaces them with a @@ -883,9 +883,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -dce: Dead Code Elimination - + Dead code elimination is similar to dead instruction @@ -895,9 +895,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -deadargelim: Dead Argument Elimination - + This pass deletes dead arguments from internal functions. Dead argument @@ -913,9 +913,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -deadtypeelim: Dead Type Elimination - + This pass is used to cleanup the output of GCC. It eliminate names for types @@ -925,9 +925,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -die: Dead Instruction Elimination - + Dead instruction elimination performs a single pass over the function, @@ -936,9 +936,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -dse: Dead Store Elimination - + A trivial dead store elimination that only considers basic-block local @@ -947,9 +947,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -functionattrs: Deduce function attributes - + A simple interprocedural pass which walks the call-graph, looking for functions which do not access or only read non-local memory, and marking them @@ -962,9 +962,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -globaldce: Dead Global Elimination - + This transform is designed to eliminate unreachable internal globals from the @@ -976,9 +976,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -globalopt: Global Variable Optimizer - + This pass transforms simple global variables that never have their address @@ -988,9 +988,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -gvn: Global Value Numbering - + This pass performs global value numbering to eliminate fully and partially @@ -999,9 +999,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -indvars: Canonicalize Induction Variables - + This transformation analyzes and transforms the induction variables (and @@ -1050,9 +1050,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -inline: Function Integration/Inlining - + Bottom-up inlining of functions into callees. @@ -1060,9 +1060,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -insert-edge-profiling: Insert instrumentation for edge profiling - + This pass instruments the specified program with counters for edge profiling. @@ -1078,9 +1078,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -insert-optimal-edge-profiling: Insert optimal instrumentation for edge profiling - + This pass instruments the specified program with counters for edge profiling. Edge profiling can give a reasonable approximation of the hot paths through a @@ -1089,9 +1089,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -instcombine: Combine redundant instructions - + Combine instructions to form fewer, simple @@ -1143,9 +1143,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -internalize: Internalize Global Symbols - + This pass loops over all of the functions in the input module, looking for a @@ -1155,9 +1155,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -ipconstprop: Interprocedural constant propagation - + This pass implements an extremely simple interprocedural constant @@ -1169,9 +1169,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -ipsccp: Interprocedural Sparse Conditional Constant Propagation - + An interprocedural variant of Sparse Conditional Constant @@ -1180,9 +1180,9 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " \n" if ! - + -jump-threading: Jump Threading - + Jump threading tries to find distinct threads of control flow running through @@ -1209,9 +1209,9 @@ if (X < 3) { - + -lcssa: Loop-Closed SSA Form Pass - + This pass transforms loops by placing phi nodes at the end of the loops for @@ -1238,9 +1238,9 @@ if (X < 3) { - + -licm: Loop Invariant Code Motion - + This pass performs loop invariant code motion, attempting to remove as much @@ -1275,9 +1275,9 @@ if (X < 3) { - + -loop-deletion: Delete dead loops - + This file implements the Dead Loop Deletion Pass. This pass is responsible @@ -1288,9 +1288,9 @@ if (X < 3) { - + -loop-extract: Extract loops into new functions - + A pass wrapper around the ExtractLoop() scalar transformation to @@ -1301,9 +1301,9 @@ if (X < 3) { - + -loop-extract-single: Extract at most one loop into a new function - + Similar to Extract loops into new functions, @@ -1313,9 +1313,9 @@ if (X < 3) { - + -loop-reduce: Loop Strength Reduction - + This pass performs a strength reduction on array references inside loops that @@ -1327,17 +1327,17 @@ if (X < 3) { - + -loop-rotate: Rotate Loops - + A simple loop rotation transformation. - + -loop-simplify: Canonicalize natural loops - + This pass performs several transformations to transform natural loops into a @@ -1376,9 +1376,9 @@ if (X < 3) { - + -loop-unroll: Unroll loops - + This pass implements a simple loop unroller. It works best when loops have @@ -1388,9 +1388,9 @@ if (X < 3) { - + -loop-unswitch: Unswitch loops - + This pass transforms loops that contain branches on loop-invariant conditions @@ -1418,9 +1418,9 @@ if (X < 3) { - + -loweratomic: Lower atomic intrinsics to non-atomic form - + This pass lowers atomic intrinsics to non-atomic form for use in a known @@ -1436,9 +1436,9 @@ if (X < 3) { - + -lowerinvoke: Lower invoke and unwind, for unwindless code generators - + This transformation is designed for use by code generators which do not yet @@ -1477,9 +1477,9 @@ if (X < 3) { - + -lowersetjmp: Lower Set Jump - + Lowers setjmp and longjmp to use the LLVM invoke and unwind @@ -1506,9 +1506,9 @@ if (X < 3) { - + -lowerswitch: Lower SwitchInst's to branches - + Rewrites switch instructions with a sequence of branches, which @@ -1518,9 +1518,9 @@ if (X < 3) { - + -mem2reg: Promote Memory to Register - + This file promotes memory references to be register references. It promotes @@ -1534,9 +1534,9 @@ if (X < 3) { - + -memcpyopt: MemCpy Optimization - + This pass performs various transformations related to eliminating memcpy @@ -1545,9 +1545,9 @@ if (X < 3) { - + -mergefunc: Merge Functions - + This pass looks for equivalent functions that are mergable and folds them. @@ -1566,9 +1566,9 @@ if (X < 3) { - + -mergereturn: Unify function exit nodes - + Ensure that functions have at most one ret instruction in them. @@ -1577,9 +1577,9 @@ if (X < 3) { - + -partial-inliner: Partial Inliner - + This pass performs partial inlining, typically by inlining an if statement that surrounds the body of the function. @@ -1587,9 +1587,9 @@ if (X < 3) { - + -prune-eh: Remove unused exception handling info - + This file implements a simple interprocedural pass which walks the call-graph, @@ -1600,9 +1600,9 @@ if (X < 3) { - + -reassociate: Reassociate expressions - + This pass reassociates commutative expressions in an order that is designed @@ -1623,9 +1623,9 @@ if (X < 3) { - + -reg2mem: Demote all values to stack slots - + This file demotes all registers to memory references. It is intented to be @@ -1640,9 +1640,9 @@ if (X < 3) { - + -scalarrepl: Scalar Replacement of Aggregates (DT) - + The well-known scalar replacement of aggregates transformation. This @@ -1662,9 +1662,9 @@ if (X < 3) { - + -sccp: Sparse Conditional Constant Propagation - + Sparse conditional constant propagation and merging, which can be summarized @@ -1685,9 +1685,9 @@ if (X < 3) { - + -simplify-libcalls: Simplify well-known library calls - + Applies a variety of small optimizations for calls to specific well-known @@ -1698,9 +1698,9 @@ if (X < 3) { - + -simplifycfg: Simplify the CFG - + Performs dead code elimination and basic block merging. Specifically: @@ -1717,9 +1717,9 @@ if (X < 3) { - + -sink: Code sinking - + This pass moves instructions into successor blocks, when possible, so that they aren't executed on paths where their results aren't needed. @@ -1727,9 +1727,9 @@ if (X < 3) { - + -sretpromotion: Promote sret arguments to multiple ret values - + This pass finds functions that return a struct (using a pointer to the struct @@ -1750,9 +1750,9 @@ if (X < 3) { - + -strip: Strip all symbols from a module - + performs code stripping. this transformation can delete: @@ -1772,9 +1772,9 @@ if (X < 3) { - + -strip-dead-debug-info: Strip debug info for unused symbols - + performs code stripping. this transformation can delete: @@ -1794,9 +1794,9 @@ if (X < 3) { - + -strip-dead-prototypes: Strip Unused Function Prototypes - + This pass loops over all of the functions in the input module, looking for @@ -1807,9 +1807,9 @@ if (X < 3) { - + -strip-debug-declare: Strip all llvm.dbg.declare intrinsics - + This pass implements code stripping. Specifically, it can delete: @@ -1825,9 +1825,9 @@ if (X < 3) { - + -strip-nondebug: Strip all symbols, except dbg symbols, from a module - + This pass implements code stripping. Specifically, it can delete: @@ -1843,9 +1843,9 @@ if (X < 3) { - + -tailcallelim: Tail Call Elimination - + This file transforms calls of the current function (self recursion) followed @@ -1875,9 +1875,9 @@ if (X < 3) { - + -tailduplicate: Tail Duplication - + This pass performs a limited form of tail duplication, intended to simplify @@ -1889,15 +1889,15 @@ if (X < 3) { - Utility Passes +Utility Passes This section describes the LLVM Utility Passes. - + -deadarghaX0r: Dead Argument Hacking (BUGPOINT USE ONLY; DO NOT USE) - + Same as dead argument elimination, but deletes arguments to functions which @@ -1906,9 +1906,9 @@ if (X < 3) { - + -extract-blocks: Extract Basic Blocks From Module (for bugpoint use) - + This pass is used by bugpoint to extract all blocks from the module into their @@ -1916,9 +1916,9 @@ if (X < 3) { - + -instnamer: Assign names to anonymous instructions - + This is a little utility pass that gives instructions names, this is mostly useful when diffing the effect of an optimization because deleting an @@ -1928,9 +1928,9 @@ if (X < 3) { - + -preverify: Preliminary module verification - + Ensures that the module is in the form required by the - + -verify: Module Verifier - + Verifies an LLVM IR code. This is useful to run after an optimization which is @@ -1995,9 +1995,9 @@ if (X < 3) { - + -view-cfg: View CFG of function - + Displays the control flow graph using the GraphViz tool. @@ -2005,9 +2005,9 @@ if (X < 3) { - + -view-cfg-only: View CFG of function (with no function bodies) - + Displays the control flow graph using the GraphViz tool, but omitting function @@ -2016,9 +2016,9 @@ if (X < 3) { - + -view-dom: View dominance tree of function - + Displays the dominator tree using the GraphViz tool. @@ -2026,9 +2026,9 @@ if (X < 3) { - + -view-dom-only: View dominance tree of function (with no function bodies) - + Displays the dominator tree using the GraphViz tool, but omitting function @@ -2037,9 +2037,9 @@ if (X < 3) { - + -view-postdom: View postdominance tree of function - + Displays the post dominator tree using the GraphViz tool. @@ -2047,9 +2047,9 @@ if (X < 3) { - + -view-postdom-only: View postdominance tree of function (with no function bodies) - + Displays the post dominator tree using the GraphViz tool, but omitting diff --git a/docs/ProgrammersManual.html b/docs/ProgrammersManual.html index e3f2a7a9095..b29c5826124 100644 --- a/docs/ProgrammersManual.html +++ b/docs/ProgrammersManual.html @@ -8,9 +8,9 @@ - + LLVM Programmer's Manual - + Introduction @@ -210,9 +210,9 @@ with another Value - + Introduction - + @@ -242,9 +242,9 @@ href="/doxygen/InstVisitor_8h-source.html">InstVisitor template. - + General Information - + @@ -255,9 +255,9 @@ in the LLVM source-base, but that isn't specific to any particular API. - + The C++ Standard Template Library - + @@ -305,9 +305,9 @@ to write maintainable code more than where to put your curly braces. - + Other useful references - + @@ -319,9 +319,9 @@ static and shared libraries across platforms - + Important and useful LLVM APIs - + @@ -332,10 +332,10 @@ know about when writing transformations. - + The isa<>, cast<> and dyn_cast<> templates - + @@ -442,10 +442,10 @@ are lots of examples in the LLVM source base. - + Passing strings (the StringRef and Twine classes) - + @@ -464,9 +464,9 @@ passing strings efficiently. - + The StringRef class - + @@ -504,9 +504,9 @@ small and pervasive enough in LLVM that it should always be passed by value. - + The Twine class - + @@ -541,9 +541,9 @@ accept concatenated strings. - + The DEBUG() macro and -debug option - + @@ -594,10 +594,10 @@ program hasn't been started yet, you can always just run it with - + Fine grained debug info with DEBUG_TYPE and the -debug-only option - + @@ -668,10 +668,10 @@ DEBUG_WITH_TYPE("", errs() << "No debug type (2)\n"); - + The Statistic class & -stats option - + @@ -768,9 +768,9 @@ maintainable and useful. - + Viewing graphs while debugging code - + @@ -817,9 +817,9 @@ attributes, then you can call DAG.clearGraphAttrs(). - + Picking the Right Data Structure for a Task - + @@ -881,9 +881,9 @@ cost of adding the elements to the container. - + Sequential Containers (std::vector, std::list, etc) - + There are a variety of sequential containers available for you, based on your @@ -891,9 +891,9 @@ needs. Pick the first in this section that will do what you want. - + llvm/ADT/ArrayRef.h - + The llvm::ArrayRef class is the preferred class to use in an interface that @@ -906,9 +906,9 @@ needs. Pick the first in this section that will do what you want. - + Fixed Size Arrays - + Fixed size arrays are very simple and very fast. They are good if you know @@ -917,9 +917,9 @@ you have. - + Heap Allocated Arrays - + Heap allocated arrays (new[] + delete[]) are also simple. They are good if @@ -933,9 +933,9 @@ construct those elements actually used). - + "llvm/ADT/SmallVector.h" - + SmallVector<Type, N> is a simple class that looks and smells @@ -962,9 +962,9 @@ SmallVectors are most useful when on the stack. - + <vector> - + @@ -1004,9 +1004,9 @@ the loop. - + <deque> - + std::deque is, in some senses, a generalized version of std::vector. Like @@ -1020,9 +1020,9 @@ something cheaper. - + <list> - + std::list is an extremely inefficient class that is rarely useful. @@ -1038,9 +1038,9 @@ not invalidate iterator or pointers to other elements in the list. - + llvm/ADT/ilist.h - + ilist<T> implements an 'intrusive' doubly-linked list. It is @@ -1068,9 +1068,9 @@ Related classes of interest are explained in the following subsections: - + ilist_traits - + ilist_traits<T> is ilist<T>'s customization @@ -1079,9 +1079,9 @@ publicly derive from this traits class. - + iplist - + iplist<T> is ilist<T>'s base and as such @@ -1093,9 +1093,9 @@ used for a wide variety of customizations. - + llvm/ADT/ilist_node.h - + ilist_node<T> implements a the forward and backward links @@ -1108,9 +1108,9 @@ in the default manner. - + Sentinels - + ilists have another specialty that must be considered. To be a good @@ -1146,9 +1146,9 @@ field in the ghostly sentinel which can be legally accessed. - + Other Sequential Container options - + Other STL containers are available, such as std::string. @@ -1161,9 +1161,9 @@ underlying container but don't affect the cost of the container itself. - + Set-Like Containers (std::set, SmallSet, SetVector, etc) - + @@ -1175,9 +1175,9 @@ this, providing various trade-offs. - + A sorted 'vector' - + @@ -1197,9 +1197,9 @@ efficiently queried with a standard binary or radix search. - + "llvm/ADT/SmallSet.h" - + @@ -1220,9 +1220,9 @@ and erasing, but does not support iteration. - + "llvm/ADT/SmallPtrSet.h" - + @@ -1240,9 +1240,9 @@ visited in sorted order. - + "llvm/ADT/DenseSet.h" - + @@ -1259,9 +1259,9 @@ href="#dss_densemap">DenseMap has. - + "llvm/ADT/FoldingSet.h" - + @@ -1296,9 +1296,9 @@ elements. - + <set> - + @@ -1321,9 +1321,9 @@ std::set is almost never a good choice. - + "llvm/ADT/SetVector.h" - + LLVM's SetVector<Type> is an adapter class that combines your choice of @@ -1361,9 +1361,9 @@ heap traffic. - + "llvm/ADT/UniqueVector.h" - + @@ -1381,9 +1381,9 @@ factors, and produces a lot of malloc traffic. It should be avoided. - + Other Set-Like Container Options - + @@ -1402,9 +1402,9 @@ better. - + Map-Like Containers (std::map, DenseMap, etc) - + Map-like containers are useful when you want to associate data to a key. As @@ -1412,9 +1412,9 @@ usual, there are a lot of different ways to do this. :) - + A sorted 'vector' - + @@ -1429,9 +1429,9 @@ vectors for sets. - + "llvm/ADT/StringMap.h" - + @@ -1463,9 +1463,9 @@ copies a string if a value is inserted into the table. - + "llvm/ADT/IndexedMap.h" - + @@ -1483,9 +1483,9 @@ virtual register ID). - + "llvm/ADT/DenseMap.h" - + @@ -1509,9 +1509,9 @@ inserted into the map) that it needs internally. - + "llvm/ADT/ValueMap.h" - + @@ -1526,9 +1526,9 @@ a Config parameter to the ValueMap template. - + "llvm/ADT/IntervalMap.h" - + @@ -1543,9 +1543,9 @@ as STL iterators. The heavyweight iterators allow a smaller data structure. - + <map> - + @@ -1563,9 +1563,9 @@ another element takes place). - + "llvm/ADT/IntEqClasses.h" - + @@ -1583,9 +1583,9 @@ it can be edited again. - + Other Map-Like Container Options - + @@ -1602,9 +1602,9 @@ always better. - + String-like containers - + @@ -1616,9 +1616,9 @@ xref to #string_apis. - + Bit storage containers (BitVector, SparseBitVector) - + Unlike the other containers, there are only two bit storage containers, and @@ -1633,9 +1633,9 @@ please don't use it. - + BitVector - + The BitVector container provides a dynamic size set of bits for manipulation. @@ -1648,9 +1648,9 @@ the number of set bits to be high (IE a dense set). - + SmallBitVector - + The SmallBitVector container provides the same interface as BitVector, but @@ -1667,9 +1667,9 @@ and its operator[] does not provide an assignable lvalue. - + SparseBitVector - + The SparseBitVector container is much like BitVector, with one major @@ -1682,9 +1682,9 @@ universe). The downside to the SparseBitVector is that setting and testing of r - + Helpful Hints for Common Operations - + @@ -1700,9 +1700,9 @@ and descriptions of the main classes that you should know about. - + Basic Inspection and Traversal Routines - + @@ -1724,11 +1724,11 @@ structures are traversed in very similar ways. - + Iterating over the BasicBlocks in a Function - + @@ -1759,11 +1759,11 @@ exactly equivalent to (*i).size() just like you'd expect. - + Iterating over the Instructions in a BasicBlock - + @@ -1790,11 +1790,11 @@ basic block itself: errs() << *blk << "\n";. - + Iterating over the Instructions in a Function - + @@ -1836,10 +1836,10 @@ for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I) - + Turning an iterator into a class pointer (and vice-versa) - + @@ -1913,10 +1913,10 @@ and operator* changed to return a pointer instead of a reference. - + Finding call sites: a slightly more complex example - + @@ -1975,9 +1975,9 @@ class OurFunctionPass : public FunctionPass { - + Treating calls and invokes the same way - + @@ -2002,9 +2002,9 @@ If you look at its definition, it has only a single pointer member. - + Iterating over def-use & use-def chains - + @@ -2063,10 +2063,10 @@ calling use/op_begin() on const Value*s or - + Iterating over predecessors & successors of blocks - + @@ -2093,9 +2093,9 @@ succ_iterator/succ_begin/succ_end. - + Making simple changes - + @@ -2108,10 +2108,10 @@ and gives example code. - + Creating and inserting new Instructions - + @@ -2249,9 +2249,9 @@ Instruction* newInst = new Instruction(..., pi); - + Deleting Instructions - + @@ -2273,10 +2273,10 @@ block but not delete it, you can use the removeFromParent() method. - + Replacing an Instruction with another Value - + @@ -2339,9 +2339,9 @@ ReplaceInstWithValue, ReplaceInstWithInst --> - + Deleting GlobalVariables - + @@ -2361,9 +2361,9 @@ GV->eraseFromParent(); - + How to Create Types - + @@ -2401,9 +2401,9 @@ comment for more details. - + Threads and LLVM - + @@ -2432,9 +2432,9 @@ support. - + Entering and Exiting Multithreaded Mode - + @@ -2469,9 +2469,9 @@ result in concurrent LLVM API calls. - + Ending Execution with llvm_shutdown() - + @@ -2489,9 +2489,9 @@ destructor. - + Lazy Initialization with ManagedStatic - + @@ -2518,9 +2518,9 @@ and only if you know what you're doing! - + Achieving Isolation with LLVMContext - + @@ -2562,9 +2562,9 @@ isolation is not a concern. - + Threads and the JIT - + @@ -2590,9 +2590,9 @@ access, but we suggest using only the eager JIT in threaded programs. - + Advanced Topics - + @@ -2604,9 +2604,9 @@ LLVM system, and only need to be accessed in unusual circumstances. - + LLVM Type Resolution - + @@ -2640,9 +2640,9 @@ float }"). - + Basic Recursive Type Construction - + @@ -2696,9 +2696,9 @@ href="#PATypeHolder">PATypeHolder class. - + The refineAbstractTypeTo method - + @@ -2726,9 +2726,9 @@ complex datastructures. - + The PATypeHolder Class - + @@ -2748,9 +2748,9 @@ Type is maintained by PATypeHolder objects. - + The AbstractTypeUser Class - + @@ -2768,10 +2768,10 @@ objects) can never be refined. - + The ValueSymbolTable and TypeSymbolTable classes - + The @@ -2804,9 +2804,9 @@ insert entries into the symbol table. - + The User and owned Use classes' memory layout - + The @@ -2817,9 +2817,11 @@ Use helper class is employed to do the bookkeeping and to facilitate - - Interaction and relationship between User and Use objects - + + + Interaction and relationship between User and Use objects + + @@ -2878,9 +2880,9 @@ enforce the following memory layouts: is stored in each Use object in the member Use::Prev) - + The waymarking algorithm - + @@ -2919,9 +2921,9 @@ stops, so that the worst case is 20 memory accesses when there are 1000 Use objects associated with a User. - + Reference implementation - + @@ -3009,9 +3011,9 @@ OK, passed 500 tests. - + Tagging considerations - + To maintain the invariant that the 2 LSBits of each Use** in Use @@ -3028,9 +3030,9 @@ the LSBit set. (Portability is relying on the fact that all known compilers plac - + The Core LLVM Class Hierarchy Reference - + @@ -3045,9 +3047,9 @@ the lib/VMCore directory. - + The Type class and Derived Types - + @@ -3067,9 +3069,9 @@ the lib/VMCore directory. - + Important Public Methods - + @@ -3089,9 +3091,9 @@ the lib/VMCore directory. - + Important Derived Types - + IntegerType @@ -3157,9 +3159,9 @@ the lib/VMCore directory. - + The Module class - + @@ -3179,9 +3181,9 @@ helpful member functions that try to make common operations easy. - + Important Public Members of the Module class - + @@ -3284,9 +3286,9 @@ provide a name for it (probably based on the name of the translation unit). - + The Value class - + @@ -3342,9 +3344,9 @@ simplifies the representation and makes it easier to manipulate. - + Important Public Members of the Value class - + @@ -3394,9 +3396,9 @@ Inst->replaceAllUsesWith(ConstVal); - + The User class - + @@ -3420,9 +3422,9 @@ information in LLVM. - + Important Public Members of the User class - + @@ -3448,9 +3450,9 @@ the operands of a User. - + The Instruction class - + @@ -3486,10 +3488,11 @@ this file confuses doxygen, so these enum values don't show up correctly in the - - Important Subclasses of the Instruction - class - + + + Important Subclasses of the Instruction class + + BinaryOperator @@ -3509,10 +3512,11 @@ this file confuses doxygen, so these enum values don't show up correctly in the - - Important Public Members of the Instruction - class - + + + Important Public Members of the Instruction class + + @@ -3535,9 +3539,9 @@ and it has no name - + The Constant class and subclasses - + @@ -3550,7 +3554,7 @@ a subclass, which represents the address of a global variable or function. -Important Subclasses of Constant +Important Subclasses of Constant ConstantInt : This subclass of Constant represents an integer constant of @@ -3601,9 +3605,9 @@ a subclass, which represents the address of a global variable or function. - + The GlobalValue class - + @@ -3648,10 +3652,11 @@ Language Reference Manual. - - Important Public Members of the GlobalValue - class - + + + Important Public Members of the GlobalValue class + + @@ -3670,9 +3675,9 @@ GlobalValue is currently embedded into. - + The Function class - + @@ -3724,10 +3729,11 @@ is its address (after linking) which is guaranteed to be constant. - - Important Public Members of the Function - class - + + + Important Public Members of the Function class + + @@ -3808,9 +3814,9 @@ iterator - + The GlobalVariable class - + @@ -3837,10 +3843,11 @@ never change at runtime). - - Important Public Members of the - GlobalVariable class - + + + Important Public Members of the GlobalVariable class + + @@ -3882,9 +3889,9 @@ never change at runtime). - + The BasicBlock class - + @@ -3914,10 +3921,11 @@ like branches and can go in the switch tables. BasicBlocks have type - - Important Public Members of the BasicBlock - class - + + + Important Public Members of the BasicBlock class + + @@ -3973,9 +3981,9 @@ returned. - + The Argument class - + diff --git a/docs/Projects.html b/docs/Projects.html index d7f4c8985cd..8ba87837649 100644 --- a/docs/Projects.html +++ b/docs/Projects.html @@ -7,7 +7,7 @@ -Creating an LLVM Project +Creating an LLVM Project Overview @@ -30,7 +30,7 @@ -Overview +Overview @@ -73,9 +73,9 @@ provide enough information on how to write your own Makefiles. - + Create a Project from the Sample Project - + @@ -145,9 +145,9 @@ project should build. - + Source Tree Layout - + @@ -230,9 +230,9 @@ your tools directory. - + Writing LLVM Style Makefiles - + @@ -245,9 +245,9 @@ do: - + Required Variables - + @@ -263,9 +263,9 @@ do: - + Variables for Building Subdirectories - + @@ -294,9 +294,9 @@ do: - + Variables for Building Libraries - + @@ -325,9 +325,9 @@ do: - + Variables for Building Programs - + @@ -368,9 +368,9 @@ do: - + Miscellaneous Variables - + @@ -399,9 +399,9 @@ do: - + Placement of Object Code - + @@ -427,9 +427,9 @@ whether you do a Debug, Release, or Profile build. - + Further Help - + diff --git a/docs/SourceLevelDebugging.html b/docs/SourceLevelDebugging.html index 544b9142e26..9e6b579e8e6 100644 --- a/docs/SourceLevelDebugging.html +++ b/docs/SourceLevelDebugging.html @@ -8,7 +8,7 @@ -Source Level Debugging with LLVM +Source Level Debugging with LLVM @@ -68,7 +68,7 @@ height="369"> -Introduction +Introduction @@ -83,9 +83,9 @@ height="369"> - + Philosophy behind LLVM debugging information - + @@ -133,9 +133,9 @@ height="369"> - + Debug information consumers - + @@ -157,9 +157,9 @@ height="369"> - + Debugging optimized code - + @@ -227,9 +227,9 @@ height="369"> - + Debugging information format - + @@ -268,9 +268,9 @@ height="369"> - + Debug information descriptors - + @@ -315,9 +315,9 @@ height="369"> - + Compile unit descriptors - + @@ -351,9 +351,9 @@ height="369"> - + File descriptors - + @@ -380,9 +380,9 @@ height="369"> - + Global variable descriptors - + @@ -413,9 +413,9 @@ global variables are collected by named metadata !llvm.dbg.gv. - + Subprogram descriptors - + @@ -456,9 +456,9 @@ global variables are collected by named metadata !llvm.dbg.gv. - + Block descriptors - + @@ -482,9 +482,9 @@ global variables are collected by named metadata !llvm.dbg.gv. - + Basic type descriptors - + @@ -534,9 +534,9 @@ DW_ATE_unsigned_char = 8 - + Derived type descriptors - + @@ -606,9 +606,9 @@ DW_TAG_restrict_type = 55 - + Composite type descriptors - + @@ -693,9 +693,9 @@ DW_TAG_inheritance = 28 - + Subrange descriptors - + @@ -719,9 +719,9 @@ DW_TAG_inheritance = 28 - + Enumerator descriptors - + @@ -743,9 +743,9 @@ DW_TAG_inheritance = 28 - + Local variables - + @@ -787,9 +787,9 @@ DW_TAG_return_variable = 258 - + Debugger intrinsic functions - + @@ -799,9 +799,9 @@ DW_TAG_return_variable = 258 - + llvm.dbg.declare - + @@ -814,9 +814,9 @@ DW_TAG_return_variable = 258 - + llvm.dbg.value - + @@ -831,9 +831,9 @@ DW_TAG_return_variable = 258 - + Object lifetimes and scoping - + In many languages, the local variables in functions can have their lifetimes @@ -994,9 +994,9 @@ call void @llvm.dbg.declare(metadata, metadata !12), !dbg !14 - + C/C++ front-end specific debug information - + @@ -1023,9 +1023,9 @@ call void @llvm.dbg.declare(metadata, metadata !12), !dbg !14 - + C/C++ source file information - + @@ -1101,9 +1101,9 @@ using Instruction::getMetadata() and - + C/C++ global variable information - + @@ -1171,9 +1171,9 @@ int MyGlobal = 100; - + C/C++ function information - + @@ -1228,9 +1228,9 @@ define i32 @main(i32 %argc, i8** %argv) { - + C/C++ basic types - + @@ -1239,9 +1239,9 @@ define i32 @main(i32 %argc, i8** %argv) { - + bool - + @@ -1265,9 +1265,9 @@ define i32 @main(i32 %argc, i8** %argv) { - + char - + @@ -1291,9 +1291,9 @@ define i32 @main(i32 %argc, i8** %argv) { - + unsigned char - + @@ -1317,9 +1317,9 @@ define i32 @main(i32 %argc, i8** %argv) { - + short - + @@ -1343,9 +1343,9 @@ define i32 @main(i32 %argc, i8** %argv) { - + unsigned short - + @@ -1369,9 +1369,9 @@ define i32 @main(i32 %argc, i8** %argv) { - + int - + @@ -1394,9 +1394,9 @@ define i32 @main(i32 %argc, i8** %argv) { - + unsigned int - + @@ -1420,9 +1420,9 @@ define i32 @main(i32 %argc, i8** %argv) { - + long long - + @@ -1446,9 +1446,9 @@ define i32 @main(i32 %argc, i8** %argv) { - + unsigned long long - + @@ -1472,9 +1472,9 @@ define i32 @main(i32 %argc, i8** %argv) { - + float - + @@ -1498,9 +1498,9 @@ define i32 @main(i32 %argc, i8** %argv) { - + double - + @@ -1524,9 +1524,9 @@ define i32 @main(i32 %argc, i8** %argv) { - + C/C++ derived types - + @@ -1609,9 +1609,9 @@ typedef const int *IntPtr; - + C/C++ struct/union types - + @@ -1722,9 +1722,9 @@ struct Color { - + C/C++ enumeration types - + diff --git a/docs/SystemLibrary.html b/docs/SystemLibrary.html index 35a94b7e7a9..db60a471381 100644 --- a/docs/SystemLibrary.html +++ b/docs/SystemLibrary.html @@ -7,7 +7,7 @@ -System Library +System Library Abstract Keeping LLVM Portable @@ -36,7 +36,7 @@ -Abstract +Abstract This document provides some details on LLVM's System Library, located in the source at lib/System and include/llvm/System. The @@ -63,9 +63,9 @@ - + Keeping LLVM Portable - + In order to keep LLVM portable, LLVM developers should adhere to a set of portability rules associated with the System Library. Adherence to these rules @@ -75,8 +75,7 @@ -Don't Include System Headers - +Don't Include System Headers Except in lib/System, no LLVM source code should directly #include a system header. Care has been taken to remove all such @@ -91,8 +90,7 @@ -Don't Expose System Headers - +Don't Expose System Headers The System Library must shield LLVM from all system headers. To obtain system level functionality, LLVM source must @@ -103,7 +101,7 @@ -Use Standard C Headers +Use Standard C Headers The standard C headers (the ones beginning with "c") are allowed to be exposed through the lib/System interface. These headers and @@ -113,8 +111,7 @@ -Use Standard C++ Headers - +Use Standard C++ Headers The standard C++ headers from the standard C++ library and standard template library may be exposed through the lib/System @@ -124,7 +121,7 @@ -High Level Interface +High Level Interface The entry points specified in the interface of lib/System must be aimed at completing some reasonably high level task needed by LLVM. We do not want to @@ -143,7 +140,7 @@ -No Unused Functionality +No Unused Functionality There must be no functionality specified in the interface of lib/System that isn't actually used by LLVM. We're not writing a general purpose @@ -153,8 +150,7 @@ -No Duplicate Implementations - +No Duplicate Implementations The implementation of a function for a given platform must be written exactly once. This implies that it must be possible to apply a function's @@ -165,7 +161,7 @@ -No Virtual Methods +No Virtual Methods The System Library interfaces can be called quite frequently by LLVM. In order to make those calls as efficient as possible, we discourage the use of @@ -175,7 +171,7 @@ -No Exposed Functions +No Exposed Functions Any functions defined by system libraries (i.e. not defined by lib/System) must not be exposed through the lib/System interface, even if the header file @@ -191,7 +187,7 @@ -No Exposed Data +No Exposed Data Any data defined by system libraries (i.e. not defined by lib/System) must not be exposed through the lib/System interface, even if the header file for @@ -200,7 +196,7 @@ -Minimize Soft Errors +Minimize Soft Errors Operating system interfaces will generally provide error results for every little thing that could go wrong. In almost all cases, you can divide these @@ -239,8 +235,7 @@ -No throw Specifications - +No throw Specifications None of the lib/System interface functions may be declared with C++ throw() specifications on them. This requirement makes sure that the @@ -252,7 +247,7 @@ -Code Organization +Code Organization Implementations of the System Library interface are separated by their general class of operating system. Currently only Unix and Win32 classes are @@ -281,7 +276,7 @@ -Consistent Semantics +Consistent Semantics The implementation of a lib/System interface can vary drastically between platforms. That's okay as long as the end result of the interface function @@ -296,7 +291,7 @@ -Bug 351 +Bug 351 See bug 351 for further details on the progress of this work diff --git a/docs/TableGenFundamentals.html b/docs/TableGenFundamentals.html index 90ac804db76..7efdfbb7cec 100644 --- a/docs/TableGenFundamentals.html +++ b/docs/TableGenFundamentals.html @@ -7,7 +7,7 @@ -TableGen Fundamentals +TableGen Fundamentals @@ -50,7 +50,7 @@ -Introduction +Introduction @@ -75,7 +75,7 @@ distribution, respectively. -Basic concepts +Basic concepts @@ -112,7 +112,7 @@ multiclass, as if they were declared in the current multiclass. -An example record +An example record @@ -212,7 +212,7 @@ abstractions they prefer to use when describing their information. -Running TableGen +Running TableGen @@ -258,7 +258,7 @@ what you need and formats it in the appropriate way. -TableGen syntax +TableGen syntax @@ -271,10 +271,10 @@ This section describes the syntax and the constructs allowed in a TableGen file. -TableGen primitives +TableGen primitives -TableGen comments +TableGen comments @@ -284,9 +284,9 @@ the line, and it also supports nestable "/* */" comments. - + The TableGen type system - + @@ -344,9 +344,9 @@ needed. - + TableGen values and expressions - + @@ -434,9 +434,9 @@ to a "bits<4>" value, for example. - + Classes and definitions - + @@ -476,9 +476,9 @@ subclasses to override them as they wish. - + Value definitions - + @@ -492,9 +492,9 @@ equal sign. Value definitions require terminating semicolons. - + 'let' expressions - + @@ -519,9 +519,9 @@ because the D class overrode its value. - + Class template arguments - + @@ -610,9 +610,9 @@ X86 backend. - + Multiclass definitions and instances - + @@ -773,14 +773,14 @@ before them. - + File scope entities - + - + File inclusion - + TableGen supports the 'include' token, which textually substitutes @@ -797,9 +797,9 @@ keyword. Example: - + 'let' expressions - + @@ -865,7 +865,7 @@ several levels of multiclass instanciations. This also avoids the need of using -Code Generator backend info +Code Generator backend info @@ -882,7 +882,7 @@ patterns: -TableGen backends +TableGen backends diff --git a/docs/TestingGuide.html b/docs/TestingGuide.html index 5886c85242c..3d6aa92ffb1 100644 --- a/docs/TestingGuide.html +++ b/docs/TestingGuide.html @@ -7,9 +7,9 @@ - + LLVM Testing Infrastructure Guide - + Overview @@ -52,7 +52,7 @@ -Overview +Overview @@ -64,7 +64,7 @@ use it, and how to add and run tests. -Requirements +Requirements @@ -76,7 +76,7 @@ as Python 2.4 or later. -LLVM testing infrastructure organization +LLVM testing infrastructure organization @@ -92,7 +92,7 @@ in subversion. -Regression tests +Regression tests @@ -119,7 +119,7 @@ application or benchmark. -Test suite +Test suite @@ -144,8 +144,7 @@ generates code. -Debugging Information -tests +Debugging Information tests @@ -161,7 +160,7 @@ test suite for more information . This test suite is located in the -Quick start +Quick start @@ -179,7 +178,7 @@ the test-suite directory will be automatically configured. Alternatively, you can configure the test-suite module manually. -Regression tests +Regression tests To run all of the LLVM regression tests, use master Makefile in the llvm/test directory: @@ -240,7 +239,7 @@ script which is built as part of LLVM. For example, to run the 'lit' man page. -Test suite +Test suite To run the comprehensive test suite (tests that compile and execute whole @@ -292,8 +291,7 @@ that subdirectory. -Debugging Information -tests +Debugging Information tests @@ -312,7 +310,7 @@ clang/test directory. -Regression test structure +Regression test structure The LLVM regression tests are driven by 'lit' and are located in @@ -339,7 +337,7 @@ clang/test directory. -Writing new regression tests +Writing new regression tests The regression test structure is very simple, but does require some @@ -493,7 +491,7 @@ negatives). -The FileCheck utility +The FileCheck utility @@ -565,8 +563,9 @@ file. -The FileCheck -check-prefix option + + The FileCheck -check-prefix option + @@ -599,8 +598,9 @@ both 32-bit and 64-bit code generation. -The "CHECK-NEXT:" directive + + The "CHECK-NEXT:" directive + @@ -639,8 +639,9 @@ directive in a file. -The "CHECK-NOT:" directive + + The "CHECK-NOT:" directive + @@ -669,8 +670,9 @@ define i8 @coerce_offset0(i32 %V, i32* %P) { -FileCheck Pattern Matching Syntax + + FileCheck Pattern Matching Syntax + @@ -701,8 +703,9 @@ braces explicitly from the input, you can use something ugly like -FileCheck Variables + + FileCheck Variables + @@ -740,8 +743,7 @@ define two separate CHECK lines that match on the same line. -Variables and -substitutions +Variables and substitutions With a RUN line there are a number of substitutions that are permitted. In @@ -836,7 +838,7 @@ substitutions -Other Features +Other Features To make RUN line writing easier, there are several shell scripts located @@ -894,8 +896,7 @@ substitutions -Test suite -Structure +Test suite Structure @@ -963,7 +964,7 @@ will help you separate benign warnings from actual test failures. -Running the test suite +Running the test suite @@ -1024,8 +1025,9 @@ the test code or configure script changes). - -Configuring External Tests + + Configuring External Tests + @@ -1056,8 +1058,9 @@ the test code or configure script changes). - -Running different tests + + Running different tests + In addition to the regular "whole program" tests, the test-suite @@ -1079,8 +1082,9 @@ LLVM. - -Generating test output + + Generating test output + There are a number of ways to run the tests and generate output. The most @@ -1110,8 +1114,9 @@ LLVM. - -Writing custom tests for the test suite + + Writing custom tests for the test suite + diff --git a/docs/UsingLibraries.html b/docs/UsingLibraries.html index 28c1e08b729..e8067ed0f8d 100644 --- a/docs/UsingLibraries.html +++ b/docs/UsingLibraries.html @@ -5,7 +5,7 @@ -Using The LLVM Libraries +Using The LLVM Libraries Abstract Introduction @@ -30,7 +30,7 @@ guide. -Abstract +Abstract Amongst other things, LLVM is a toolkit for building compilers, linkers, runtime executives, virtual machines, and other program execution related @@ -45,7 +45,7 @@ - Introduction +Introduction If you're writing a compiler, virtual machine, or any other utility based on LLVM, you'll need to figure out which of the many libraries files you will @@ -74,7 +74,7 @@ correct for your tool can sometimes be challenging. -Library Descriptions +Library Descriptions The table below categorizes each library @@ -152,7 +152,7 @@ -Using llvm-config +Using llvm-config The llvm-config tool is a perl script that produces on its output various kinds of information. For example, the source or object directories @@ -401,14 +401,15 @@ -Linkage Rules Of Thumb +Linkage Rules Of Thumb This section contains various "rules of thumb" about what files you should link into your programs. -Always Link LLVMCore, LLVMSupport, - and LLVMSystem + + Always Link LLVMCore, LLVMSupport, and LLVMSystem + No matter what you do with LLVM, the last three entries in the value of your LLVMLIBS make variable should always be: @@ -416,8 +417,9 @@ programs that don't depend on these three. -Never link both archive and - re-linked library + + Never link both archive and re-linked library + There is never any point to linking both the re-linked (.o) and the archive (.a) versions of a library. Since the re-linked version diff --git a/docs/WritingAnLLVMBackend.html b/docs/WritingAnLLVMBackend.html index 4798cdfc350..c8dcb8a7d8d 100644 --- a/docs/WritingAnLLVMBackend.html +++ b/docs/WritingAnLLVMBackend.html @@ -9,9 +9,9 @@ - + Writing an LLVM Compiler Backend - + Introduction @@ -61,9 +61,9 @@ - + Introduction - + @@ -93,9 +93,9 @@ conventions. - + Audience - + @@ -106,9 +106,9 @@ generate code for a specific hardware or software target. - + Prerequisite Reading - + @@ -155,9 +155,9 @@ machine dependent features. - + Basic Steps - + @@ -220,9 +220,9 @@ that the class will need and which components will need to be subclassed. - + Preliminaries - + @@ -282,9 +282,9 @@ regenerate configure by running ./autoconf/AutoRegen.sh. - + Target Machine - + @@ -424,9 +424,9 @@ SparcTargetMachine::SparcTargetMachine(const Module &M, const std::string &a - + Target Registration - + @@ -480,9 +480,9 @@ For more information, see - + Register Set and Register Classes - + @@ -517,9 +517,9 @@ implementation of XXXRegisterInfo requires hand-coding. - + Defining a Register - + @@ -700,9 +700,9 @@ fields of a register's TargetRegisterDesc. - + Defining a Register Class - + @@ -894,10 +894,10 @@ namespace SP { // Register class instances - + Implement a subclass of TargetRegisterInfo - + @@ -934,9 +934,9 @@ implementation in SparcRegisterInfo.cpp: - + Instruction Set - + @@ -1191,9 +1191,9 @@ correspond to the values in SparcInstrInfo.td. I.e., - + Instruction Operand Mapping - + @@ -1283,10 +1283,10 @@ the rd, rs1, and rs2 fields respectively. - + Implement a subclass of TargetInstrInfo - + @@ -1327,9 +1327,9 @@ implementation in SparcInstrInfo.cpp: - + Branch Folding and If Conversion - + @@ -1486,9 +1486,9 @@ branch. - + Instruction Selector - + @@ -1645,9 +1645,9 @@ SDNode *Select_ISD_STORE(const SDValue &N) { - + The SelectionDAG Legalize Phase - + @@ -1719,9 +1719,9 @@ contains examples of all four LegalAction values. - + Promote - + @@ -1742,9 +1742,9 @@ setLoadExtAction(ISD::SEXTLOAD, MVT::i1, Promote); - + Expand - + @@ -1767,9 +1767,9 @@ setOperationAction(ISD::FCOS, MVT::f32, Expand); - + Custom - + @@ -1833,9 +1833,9 @@ static SDValue LowerFP_TO_SINT(SDValue Op, SelectionDAG &DAG) { - + Legal - + @@ -1866,9 +1866,9 @@ if (TM.getSubtarget<SparcSubtarget>().isV9()) - + Calling Conventions - + @@ -2016,9 +2016,9 @@ def RetCC_X86_32 : CallingConv<[ - + Assembly Printer - + @@ -2171,9 +2171,9 @@ output. - + Subtarget Support - + @@ -2289,9 +2289,9 @@ XXXSubtarget::XXXSubtarget(const Module &M, const std::string &FS) { - + JIT Support - + @@ -2336,9 +2336,9 @@ that write data (in bytes, words, strings, etc.) to the output stream. - + Machine Code Emitter - + @@ -2478,9 +2478,9 @@ enum RelocationType { - + Target JIT Info - + diff --git a/docs/WritingAnLLVMPass.html b/docs/WritingAnLLVMPass.html index 7e152452740..33161793775 100644 --- a/docs/WritingAnLLVMPass.html +++ b/docs/WritingAnLLVMPass.html @@ -8,9 +8,9 @@ - + Writing an LLVM Pass - + Introduction - What is a pass? @@ -121,9 +121,9 @@ - + Introduction - What is a pass? - + @@ -156,9 +156,9 @@ more advanced features are discussed. - + Quick Start - Writing hello world - + @@ -172,9 +172,9 @@ source tree in the lib/Transforms/Hello directory. - + Setting up the build environment - + @@ -220,9 +220,9 @@ the pass itself. - + Basic code required - + @@ -356,9 +356,9 @@ them) to be useful. - + Running a pass with opt - + @@ -447,9 +447,9 @@ about some more details of how they work and how to use them. - + Pass classes and requirements - + @@ -470,9 +470,9 @@ slow. - + The ImmutablePass class - + @@ -493,9 +493,9 @@ invalidated, and are never "run". - + The ModulePass class - + @@ -522,9 +522,9 @@ following signature: - + The runOnModule method - + @@ -539,9 +539,9 @@ false otherwise. - + The CallGraphSCCPass class - + @@ -587,10 +587,11 @@ false if they didn't. - - The doInitialization(CallGraph &) - method - + + + The doInitialization(CallGraph &) method + + @@ -609,9 +610,9 @@ fast). - + The runOnSCC method - + @@ -626,10 +627,11 @@ otherwise. - - The doFinalization(CallGraph - &) method - + + + The doFinalization(CallGraph &) method + + @@ -645,9 +647,9 @@ program being compiled. - + The FunctionPass class - + @@ -677,10 +679,11 @@ should return true if they modified the program, or false if they didn't. - - The doInitialization(Module &) - method - + + + The doInitialization(Module &) method + + @@ -706,9 +709,9 @@ free functions that it needs, adding prototypes to the module if necessary. - + The runOnFunction method - + @@ -723,10 +726,11 @@ be returned if the function is modified. - - The doFinalization(Module - &) method - + + + The doFinalization(Module &) method + + @@ -742,9 +746,9 @@ program being compiled. - + The LoopPass class - + @@ -760,11 +764,11 @@ program, or false if they didn't. - - The doInitialization(Loop *, - LPPassManager &) - method - + + + The doInitialization(Loop *,LPPassManager &) method + + @@ -783,9 +787,9 @@ information. - + The runOnLoop method - + @@ -801,9 +805,9 @@ should be used to update loop nest. - + The doFinalization() method - + @@ -819,9 +823,9 @@ program being compiled. - + The RegionPass class - + @@ -838,11 +842,11 @@ methods should return true if they modified the program, or false if they didn n - - The doInitialization(Region *, - RGPassManager &) - method - + + + The doInitialization(Region *, RGPassManager &) method + + @@ -861,9 +865,9 @@ information. - + The runOnRegion method - + @@ -879,9 +883,9 @@ should be used to update region tree. - + The doFinalization() method - + @@ -899,9 +903,9 @@ program being compiled. - + The BasicBlockPass class - + @@ -928,10 +932,11 @@ href="#FunctionPass">FunctionPass's have, but also have the followi - - The doInitialization(Function - &) method - + + + The doInitialization(Function &) method + + @@ -950,9 +955,9 @@ fast). - + The runOnBasicBlock method - + @@ -968,10 +973,11 @@ if the basic block is modified. - - The doFinalization(Function &) - method - + + + The doFinalization(Function &) method + + @@ -988,9 +994,9 @@ finalization. - + The MachineFunctionPass class - + @@ -1020,10 +1026,11 @@ data) - - The runOnMachineFunction(MachineFunction - &MF) method - + + + The runOnMachineFunction(MachineFunction &MF) method + + @@ -1047,9 +1054,9 @@ remember, you may not modify the LLVM Function or its contents from a - + Pass registration - + @@ -1072,9 +1079,9 @@ implement the virtual print method: - + The print method - + @@ -1097,9 +1104,9 @@ depended on. - + Specifying interactions between passes - + @@ -1122,9 +1129,9 @@ having any prerequisite passes, and invalidating all other passes. - + The getAnalysisUsage method - + @@ -1142,9 +1149,12 @@ object: - - The AnalysisUsage::addRequired<> and AnalysisUsage::addRequiredTransitive<> methods - + + + The AnalysisUsage::addRequired<> + and AnalysisUsage::addRequiredTransitive<> methods + + @@ -1168,9 +1178,11 @@ pass is. - - The AnalysisUsage::addPreserved<> method - + + + The AnalysisUsage::addPreserved<> method + + @@ -1203,9 +1215,11 @@ the fact that it hacks on the CFG. - - Example implementations of getAnalysisUsage - + + + Example implementations of getAnalysisUsage + + @@ -1220,10 +1234,12 @@ the fact that it hacks on the CFG. - - The getAnalysis<> and -getAnalysisIfAvailable<> methods - + + + The getAnalysis<> and + getAnalysisIfAvailable<> methods + + @@ -1278,9 +1294,9 @@ if it is active. For example: - + Implementing Analysis Groups - + @@ -1305,9 +1321,9 @@ Analysis Groups. - + Analysis Group Concepts - + @@ -1356,9 +1372,9 @@ hypothetical example) instead. - + Using RegisterAnalysisGroup - + @@ -1418,9 +1434,9 @@ pass is the default implementation for the interface. - + Pass Statistics - + @@ -1435,9 +1451,9 @@ line. See the St - + What PassManager does - + @@ -1610,9 +1626,9 @@ anymore, and therefore do not have to compute it twice. - + The releaseMemory method - + @@ -1636,9 +1652,9 @@ class, before the next call of run* in your pass. - + Registering dynamically loaded passes - + @@ -1671,9 +1687,9 @@ register on load and unregister at unload. - + Using existing registries - + @@ -1736,9 +1752,9 @@ call line to llvm/Codegen/LinkAllCodegenComponents.h. - + Creating new registries - + @@ -1769,9 +1785,9 @@ creator. - + Using GDB with dynamically loaded passes - + @@ -1789,9 +1805,9 @@ on that. - + Setting a breakpoint in your pass - + @@ -1834,9 +1850,9 @@ or do other standard debugging stuff. - + Miscellaneous Problems - + @@ -1867,9 +1883,9 @@ href="mailto:sabre@nondot.org">Chris. - + Future extensions planned - + @@ -1881,9 +1897,9 @@ where we are going: - + Multithreaded LLVM - + diff --git a/docs/index.html b/docs/index.html index f0bd103b343..e40877c5fbb 100644 --- a/docs/index.html +++ b/docs/index.html @@ -7,7 +7,7 @@ -Documentation for the LLVM System at SVN head +Documentation for the LLVM System at SVN head If you are using a released version of LLVM, see the download page to find @@ -39,7 +39,7 @@ your documentation. -LLVM Design & Overview +LLVM Design & Overview @@ -57,7 +57,7 @@ frequent questions about LLVM's most frequently misunderstood instruction. -LLVM User Guides +LLVM User Guides @@ -131,7 +131,7 @@ href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net directly. -General LLVM Programming Documentation +General LLVM Programming Documentation @@ -179,7 +179,7 @@ href="http://llvm.org/doxygen/inherits.html">classes) -LLVM Subsystem Documentation +LLVM Subsystem Documentation @@ -246,7 +246,7 @@ JITed code with GDB. -LLVM Mailing Lists +LLVM Mailing Lists diff --git a/docs/tutorial/LangImpl1.html b/docs/tutorial/LangImpl1.html index c96cb9fd44f..cc2fa9735f3 100644 --- a/docs/tutorial/LangImpl1.html +++ b/docs/tutorial/LangImpl1.html @@ -11,7 +11,7 @@ -Kaleidoscope: Tutorial Introduction and the Lexer +Kaleidoscope: Tutorial Introduction and the Lexer Up to Tutorial Index @@ -30,7 +30,7 @@ -Tutorial Introduction +Tutorial Introduction @@ -123,7 +123,7 @@ languages! -The Basic Language +The Basic Language @@ -181,7 +181,7 @@ a Mandelbrot Set at various levels of magnification. -The Lexer +The Lexer diff --git a/docs/tutorial/LangImpl2.html b/docs/tutorial/LangImpl2.html index ac4f1ee6df7..bfe8d3fca09 100644 --- a/docs/tutorial/LangImpl2.html +++ b/docs/tutorial/LangImpl2.html @@ -11,7 +11,7 @@ -Kaleidoscope: Implementing a Parser and AST +Kaleidoscope: Implementing a Parser and AST Up to Tutorial Index @@ -36,7 +36,7 @@ -Chapter 2 Introduction +Chapter 2 Introduction @@ -61,7 +61,7 @@ Tree. -The Abstract Syntax Tree (AST) +The Abstract Syntax Tree (AST) @@ -178,7 +178,7 @@ bodies in Kaleidoscope. -Parser Basics +Parser Basics @@ -239,8 +239,7 @@ piece of our grammar: numeric literals. -Basic Expression - Parsing +Basic Expression Parsing @@ -394,8 +393,7 @@ They are a bit more complex. -Binary Expression - Parsing +Binary Expression Parsing @@ -617,7 +615,7 @@ handle function definitions, etc. -Parsing the Rest +Parsing the Rest @@ -714,7 +712,7 @@ actually execute this code we've built! -The Driver +The Driver @@ -753,7 +751,7 @@ type "4+5;", and the parser will know you are done. -Conclusions +Conclusions @@ -790,7 +788,7 @@ Representation (IR) from the AST. -Full Code Listing +Full Code Listing diff --git a/docs/tutorial/LangImpl3.html b/docs/tutorial/LangImpl3.html index 42e51696d91..468a1bfe5ff 100644 --- a/docs/tutorial/LangImpl3.html +++ b/docs/tutorial/LangImpl3.html @@ -11,7 +11,7 @@ -Kaleidoscope: Code generation to LLVM IR +Kaleidoscope: Code generation to LLVM IR Up to Tutorial Index @@ -34,7 +34,7 @@ Support -Chapter 3 Introduction +Chapter 3 Introduction @@ -57,7 +57,7 @@ releases page. -Code Generation Setup +Code Generation Setup @@ -147,7 +147,7 @@ has already been done, and we'll just use it to emit code. -Expression Code Generation +Expression Code Generation @@ -293,7 +293,7 @@ basic framework. -Function Code Generation +Function Code Generation @@ -515,8 +515,7 @@ def bar() foo(1, 2); # error, unknown function "foo" -Driver Changes and -Closing Thoughts +Driver Changes and Closing Thoughts @@ -657,7 +656,7 @@ support to this so we can actually start running code! -Full Code Listing +Full Code Listing diff --git a/docs/tutorial/LangImpl4.html b/docs/tutorial/LangImpl4.html index 2d876229c41..d73f8a351d8 100644 --- a/docs/tutorial/LangImpl4.html +++ b/docs/tutorial/LangImpl4.html @@ -11,7 +11,7 @@ -Kaleidoscope: Adding JIT and Optimizer Support +Kaleidoscope: Adding JIT and Optimizer Support Up to Tutorial Index @@ -33,7 +33,7 @@ Flow -Chapter 4 Introduction +Chapter 4 Introduction @@ -48,8 +48,7 @@ for the Kaleidoscope language. -Trivial Constant -Folding +Trivial Constant Folding @@ -134,8 +133,7 @@ range of optimizations that you can use, in the form of "passes". -LLVM Optimization - Passes +LLVM Optimization Passes @@ -266,7 +264,7 @@ executing it! -Adding a JIT Compiler +Adding a JIT Compiler @@ -474,7 +472,7 @@ tackling some interesting LLVM IR issues along the way. -Full Code Listing +Full Code Listing diff --git a/docs/tutorial/LangImpl5.html b/docs/tutorial/LangImpl5.html index 2c1a07f6144..4fbf7beca42 100644 --- a/docs/tutorial/LangImpl5.html +++ b/docs/tutorial/LangImpl5.html @@ -11,7 +11,7 @@ -Kaleidoscope: Extending the Language: Control Flow +Kaleidoscope: Extending the Language: Control Flow Up to Tutorial Index @@ -48,7 +48,7 @@ User-defined Operators -Chapter 5 Introduction +Chapter 5 Introduction @@ -65,7 +65,7 @@ have an if/then/else expression plus a simple 'for' loop. -If/Then/Else +If/Then/Else @@ -111,8 +111,7 @@ pieces. -Lexer Extensions for -If/Then/Else +Lexer Extensions for If/Then/Else @@ -146,8 +145,7 @@ stuff: -AST Extensions for - If/Then/Else +AST Extensions for If/Then/Else @@ -172,8 +170,7 @@ public: -Parser Extensions for -If/Then/Else +Parser Extensions for If/Then/Else @@ -231,7 +228,7 @@ static ExprAST *ParsePrimary() { -LLVM IR for If/Then/Else +LLVM IR for If/Then/Else @@ -347,8 +344,7 @@ directly. -Code Generation for -If/Then/Else +Code Generation for If/Then/Else @@ -501,7 +497,7 @@ another useful expression that is familiar from non-functional languages... -'for' Loop Expression +'for' Loop Expression @@ -536,8 +532,7 @@ support this. -Lexer Extensions for -the 'for' Loop +Lexer Extensions for the 'for' Loop @@ -566,8 +561,7 @@ the 'for' Loop -AST Extensions for -the 'for' Loop +AST Extensions for the 'for' Loop @@ -593,8 +587,7 @@ public: -Parser Extensions for -the 'for' Loop +Parser Extensions for the 'for' Loop @@ -653,8 +646,7 @@ static ExprAST *ParseForExpr() { -LLVM IR for -the 'for' Loop +LLVM IR for the 'for' Loop @@ -699,8 +691,7 @@ expressions, and some basic blocks. Lets see how this fits together. -Code Generation for -the 'for' Loop +Code Generation for the 'for' Loop @@ -877,7 +868,7 @@ language. -Full Code Listing +Full Code Listing diff --git a/docs/tutorial/LangImpl6.html b/docs/tutorial/LangImpl6.html index 72fa9c3b080..510d9dde09a 100644 --- a/docs/tutorial/LangImpl6.html +++ b/docs/tutorial/LangImpl6.html @@ -11,7 +11,7 @@ -Kaleidoscope: Extending the Language: User-defined Operators +Kaleidoscope: Extending the Language: User-defined Operators Up to Tutorial Index @@ -34,7 +34,7 @@ Variables / SSA Construction -Chapter 6 Introduction +Chapter 6 Introduction @@ -60,7 +60,7 @@ an example of what you can build with Kaleidoscope and its feature set. -User-defined Operators: the Idea +User-defined Operators: the Idea @@ -125,7 +125,7 @@ operators. -User-defined Binary Operators +User-defined Binary Operators @@ -342,7 +342,7 @@ see what it takes. -User-defined Unary Operators +User-defined Unary Operators @@ -491,7 +491,7 @@ is simpler primarily because it doesn't need to handle any predefined operators. -Kicking the Tires +Kicking the Tires @@ -796,7 +796,7 @@ add variable mutation without building SSA in your front-end. -Full Code Listing +Full Code Listing diff --git a/docs/tutorial/LangImpl7.html b/docs/tutorial/LangImpl7.html index 732d9086921..fc49d070476 100644 --- a/docs/tutorial/LangImpl7.html +++ b/docs/tutorial/LangImpl7.html @@ -12,7 +12,7 @@ -Kaleidoscope: Extending the Language: Mutable Variables +Kaleidoscope: Extending the Language: Mutable Variables Up to Tutorial Index @@ -38,7 +38,7 @@ -Chapter 7 Introduction +Chapter 7 Introduction @@ -66,7 +66,7 @@ support for this, though the way it works is a bit unexpected for some. -Why is this a hard problem? +Why is this a hard problem? @@ -140,7 +140,7 @@ logic. -Memory in LLVM +Memory in LLVM @@ -321,8 +321,7 @@ variables now! -Mutable Variables in -Kaleidoscope +Mutable Variables in Kaleidoscope @@ -378,8 +377,7 @@ Kaleidoscope to support new variable definitions. -Adjusting Existing Variables for -Mutation +Adjusting Existing Variables for Mutation @@ -648,7 +646,7 @@ we'll add the assignment operator. -New Assignment Operator +New Assignment Operator @@ -745,8 +743,7 @@ add this next! -User-defined Local -Variables +User-defined Local Variables @@ -979,7 +976,7 @@ anywhere in sight. -Full Code Listing +Full Code Listing diff --git a/docs/tutorial/LangImpl8.html b/docs/tutorial/LangImpl8.html index 5f993ecf9fa..449ac706620 100644 --- a/docs/tutorial/LangImpl8.html +++ b/docs/tutorial/LangImpl8.html @@ -11,8 +11,7 @@ -Kaleidoscope: Conclusion and other useful LLVM - tidbits +Kaleidoscope: Conclusion and other useful LLVM tidbits Up to Tutorial Index @@ -43,7 +42,7 @@ -Tutorial Conclusion +Tutorial Conclusion @@ -154,8 +153,7 @@ are very useful if you want to take advantage of LLVM's capabilities. -Properties of the LLVM -IR +Properties of the LLVM IR @@ -166,8 +164,7 @@ get these out of the way right now, shall we? -Target -Independence +Target Independence @@ -221,7 +218,7 @@ in-kernel language. -Safety Guarantees +Safety Guarantees @@ -243,8 +240,7 @@ list if you are interested in more details. -Language-Specific -Optimizations +Language-Specific Optimizations @@ -298,7 +294,7 @@ language-specific AST. -Tips and Tricks +Tips and Tricks @@ -310,8 +306,7 @@ everyone rediscover them, this section talks about some of these issues. -Implementing portable -offsetof/sizeof +Implementing portable offsetof/sizeof @@ -331,8 +326,7 @@ in a portable way. -Garbage Collected -Stack Frames +Garbage Collected Stack Frames diff --git a/docs/tutorial/OCamlLangImpl1.html b/docs/tutorial/OCamlLangImpl1.html index 3ec7c1ef772..5446b7a729b 100644 --- a/docs/tutorial/OCamlLangImpl1.html +++ b/docs/tutorial/OCamlLangImpl1.html @@ -12,7 +12,7 @@ -Kaleidoscope: Tutorial Introduction and the Lexer +Kaleidoscope: Tutorial Introduction and the Lexer Up to Tutorial Index @@ -35,7 +35,7 @@ AST -Tutorial Introduction +Tutorial Introduction @@ -130,7 +130,7 @@ languages! -The Basic Language +The Basic Language @@ -188,7 +188,7 @@ a Mandelbrot Set at various levels of magnification. -The Lexer +The Lexer diff --git a/docs/tutorial/OCamlLangImpl2.html b/docs/tutorial/OCamlLangImpl2.html index 9b002324cf6..deb592ee411 100644 --- a/docs/tutorial/OCamlLangImpl2.html +++ b/docs/tutorial/OCamlLangImpl2.html @@ -12,7 +12,7 @@ -Kaleidoscope: Implementing a Parser and AST +Kaleidoscope: Implementing a Parser and AST Up to Tutorial Index @@ -40,7 +40,7 @@ -Chapter 2 Introduction +Chapter 2 Introduction @@ -65,7 +65,7 @@ Tree. -The Abstract Syntax Tree (AST) +The Abstract Syntax Tree (AST) @@ -146,7 +146,7 @@ bodies in Kaleidoscope. -Parser Basics +Parser Basics @@ -181,8 +181,7 @@ piece of our grammar: numeric literals. -Basic Expression - Parsing +Basic Expression Parsing @@ -303,8 +302,7 @@ They are a bit more complex. -Binary Expression - Parsing +Binary Expression Parsing @@ -517,7 +515,7 @@ handle function definitions, etc. -Parsing the Rest +Parsing the Rest @@ -596,7 +594,7 @@ actually execute this code we've built! -The Driver +The Driver @@ -652,7 +650,7 @@ type "4+5;", and the parser will know you are done. -Conclusions +Conclusions @@ -689,7 +687,7 @@ Representation (IR) from the AST. -Full Code Listing +Full Code Listing diff --git a/docs/tutorial/OCamlLangImpl3.html b/docs/tutorial/OCamlLangImpl3.html index e7c419e2662..cf5afe9b718 100644 --- a/docs/tutorial/OCamlLangImpl3.html +++ b/docs/tutorial/OCamlLangImpl3.html @@ -12,7 +12,7 @@ -Kaleidoscope: Code generation to LLVM IR +Kaleidoscope: Code generation to LLVM IR Up to Tutorial Index @@ -38,7 +38,7 @@ Support -Chapter 3 Introduction +Chapter 3 Introduction @@ -57,7 +57,7 @@ LLVM SVN to work. LLVM 2.2 and before will not work with it. -Code Generation Setup +Code Generation Setup @@ -128,7 +128,7 @@ that this has already been done, and we'll just use it to emit code. -Expression Code Generation +Expression Code Generation @@ -263,7 +263,7 @@ basic framework. -Function Code Generation +Function Code Generation @@ -466,8 +466,7 @@ def bar() foo(1, 2); # error, unknown function "foo" -Driver Changes and -Closing Thoughts +Driver Changes and Closing Thoughts @@ -607,7 +606,7 @@ support to this so we can actually start running code! -Full Code Listing +Full Code Listing diff --git a/docs/tutorial/OCamlLangImpl4.html b/docs/tutorial/OCamlLangImpl4.html index 2219f3ae9eb..e42404561cc 100644 --- a/docs/tutorial/OCamlLangImpl4.html +++ b/docs/tutorial/OCamlLangImpl4.html @@ -12,7 +12,7 @@ -Kaleidoscope: Adding JIT and Optimizer Support +Kaleidoscope: Adding JIT and Optimizer Support Up to Tutorial Index @@ -37,7 +37,7 @@ Flow -Chapter 4 Introduction +Chapter 4 Introduction @@ -52,8 +52,7 @@ for the Kaleidoscope language. -Trivial Constant -Folding +Trivial Constant Folding @@ -148,8 +147,7 @@ range of optimizations that you can use, in the form of "passes". -LLVM Optimization - Passes +LLVM Optimization Passes @@ -283,7 +281,7 @@ executing it! -Adding a JIT Compiler +Adding a JIT Compiler @@ -486,7 +484,7 @@ constructs, tackling some interesting LLVM IR issues along the way. -Full Code Listing +Full Code Listing diff --git a/docs/tutorial/OCamlLangImpl5.html b/docs/tutorial/OCamlLangImpl5.html index 74f28e7f030..59c17492a37 100644 --- a/docs/tutorial/OCamlLangImpl5.html +++ b/docs/tutorial/OCamlLangImpl5.html @@ -12,7 +12,7 @@ -Kaleidoscope: Extending the Language: Control Flow +Kaleidoscope: Extending the Language: Control Flow Up to Tutorial Index @@ -52,7 +52,7 @@ User-defined Operators -Chapter 5 Introduction +Chapter 5 Introduction @@ -69,7 +69,7 @@ have an if/then/else expression plus a simple 'for' loop. -If/Then/Else +If/Then/Else @@ -115,8 +115,7 @@ pieces. -Lexer Extensions for -If/Then/Else +Lexer Extensions for If/Then/Else @@ -153,8 +152,7 @@ stuff: -AST Extensions for - If/Then/Else +AST Extensions for If/Then/Else @@ -175,8 +173,7 @@ type expr = -Parser Extensions for -If/Then/Else +Parser Extensions for If/Then/Else @@ -214,7 +211,7 @@ let rec parse_primary = parser -LLVM IR for If/Then/Else +LLVM IR for If/Then/Else @@ -331,8 +328,7 @@ directly. -Code Generation for -If/Then/Else +Code Generation for If/Then/Else @@ -493,7 +489,7 @@ another useful expression that is familiar from non-functional languages... -'for' Loop Expression +'for' Loop Expression @@ -528,8 +524,7 @@ support this. -Lexer Extensions for -the 'for' Loop +Lexer Extensions for the 'for' Loop @@ -559,8 +554,7 @@ the 'for' Loop -AST Extensions for -the 'for' Loop +AST Extensions for the 'for' Loop @@ -580,8 +574,7 @@ type expr = -Parser Extensions for -the 'for' Loop +Parser Extensions for the 'for' Loop @@ -628,8 +621,7 @@ let rec parse_primary = parser -LLVM IR for -the 'for' Loop +LLVM IR for the 'for' Loop @@ -674,8 +666,7 @@ expressions, and some basic blocks. Lets see how this fits together. -Code Generation for -the 'for' Loop +Code Generation for the 'for' Loop @@ -852,7 +843,7 @@ to our poor innocent language. -Full Code Listing +Full Code Listing diff --git a/docs/tutorial/OCamlLangImpl6.html b/docs/tutorial/OCamlLangImpl6.html index c5772a2d946..693aafc0b38 100644 --- a/docs/tutorial/OCamlLangImpl6.html +++ b/docs/tutorial/OCamlLangImpl6.html @@ -12,7 +12,7 @@ -Kaleidoscope: Extending the Language: User-defined Operators +Kaleidoscope: Extending the Language: User-defined Operators Up to Tutorial Index @@ -38,7 +38,7 @@ Variables / SSA Construction -Chapter 6 Introduction +Chapter 6 Introduction @@ -64,7 +64,7 @@ an example of what you can build with Kaleidoscope and its feature set. -User-defined Operators: the Idea +User-defined Operators: the Idea @@ -129,7 +129,7 @@ operators. -User-defined Binary Operators +User-defined Binary Operators @@ -320,7 +320,7 @@ see what it takes. -User-defined Unary Operators +User-defined Unary Operators @@ -472,7 +472,7 @@ is simpler primarily because it doesn't need to handle any predefined operators. -Kicking the Tires +Kicking the Tires @@ -778,7 +778,7 @@ add variable mutation without building SSA in your front-end. -Full Code Listing +Full Code Listing diff --git a/docs/tutorial/OCamlLangImpl7.html b/docs/tutorial/OCamlLangImpl7.html index 42d8141a819..aebc81c08e7 100644 --- a/docs/tutorial/OCamlLangImpl7.html +++ b/docs/tutorial/OCamlLangImpl7.html @@ -13,7 +13,7 @@ -Kaleidoscope: Extending the Language: Mutable Variables +Kaleidoscope: Extending the Language: Mutable Variables Up to Tutorial Index @@ -42,7 +42,7 @@ -Chapter 7 Introduction +Chapter 7 Introduction @@ -70,7 +70,7 @@ support for this, though the way it works is a bit unexpected for some. -Why is this a hard problem? +Why is this a hard problem? @@ -144,7 +144,7 @@ logic. -Memory in LLVM +Memory in LLVM @@ -325,8 +325,7 @@ variables now! -Mutable Variables in -Kaleidoscope +Mutable Variables in Kaleidoscope @@ -382,8 +381,7 @@ Kaleidoscope to support new variable definitions. -Adjusting Existing Variables for -Mutation +Adjusting Existing Variables for Mutation @@ -672,7 +670,7 @@ we'll add the assignment operator. -New Assignment Operator +New Assignment Operator @@ -773,8 +771,7 @@ add this next! -User-defined Local -Variables +User-defined Local Variables @@ -956,7 +953,7 @@ anywhere in sight. -Full Code Listing +Full Code Listing diff --git a/docs/tutorial/OCamlLangImpl8.html b/docs/tutorial/OCamlLangImpl8.html index 5f993ecf9fa..449ac706620 100644 --- a/docs/tutorial/OCamlLangImpl8.html +++ b/docs/tutorial/OCamlLangImpl8.html @@ -11,8 +11,7 @@ -Kaleidoscope: Conclusion and other useful LLVM - tidbits +Kaleidoscope: Conclusion and other useful LLVM tidbits Up to Tutorial Index @@ -43,7 +42,7 @@ -Tutorial Conclusion +Tutorial Conclusion @@ -154,8 +153,7 @@ are very useful if you want to take advantage of LLVM's capabilities. -Properties of the LLVM -IR +Properties of the LLVM IR @@ -166,8 +164,7 @@ get these out of the way right now, shall we? -Target -Independence +Target Independence @@ -221,7 +218,7 @@ in-kernel language. -Safety Guarantees +Safety Guarantees @@ -243,8 +240,7 @@ list if you are interested in more details. -Language-Specific -Optimizations +Language-Specific Optimizations @@ -298,7 +294,7 @@ language-specific AST. -Tips and Tricks +Tips and Tricks @@ -310,8 +306,7 @@ everyone rediscover them, this section talks about some of these issues. -Implementing portable -offsetof/sizeof +Implementing portable offsetof/sizeof @@ -331,8 +326,7 @@ in a portable way. -Garbage Collected -Stack Frames +Garbage Collected Stack Frames diff --git a/docs/tutorial/index.html b/docs/tutorial/index.html index 11dd5e2d732..0a8cae2c2c9 100644 --- a/docs/tutorial/index.html +++ b/docs/tutorial/index.html @@ -12,7 +12,7 @@ - LLVM Tutorial: Table of Contents +LLVM Tutorial: Table of Contents Kaleidoscope: Implementing a Language with LLVM

LLVM Alias Analysis Infrastructure -

Introduction -

AliasAnalysis Class Overview -

Representation of Pointers -

The alias method -

Must, May, and No Alias Responses -

The getModRefInfo methods -

Other useful AliasAnalysis methods -

The pointsToConstantMemory method -

The doesNotAccessMemory and onlyReadsMemory methods -

Writing a new AliasAnalysis Implementation -

Different Pass styles -

Required initialization calls -

Interfaces which may be specified -

AliasAnalysis chaining behavior -

Updating analysis results for transformations -

The deleteValue method

The copyValue method

The replaceWithNewValue method

The addEscapingUse method

Efficiency Issues -

Limitations -

Using alias analysis results -

Using the MemoryDependenceAnalysis Pass -

Using the AliasSetTracker class -

The AliasSetTracker implementation -

Using the AliasAnalysis interface directly -

Existing alias analysis implementations and clients -

Available AliasAnalysis implementations -

The -no-aa pass -

The -basicaa pass -

The -globalsmodref-aa pass -

The -steens-aa pass -

The -ds-aa pass -

The -scev-aa pass -

Alias analysis driven transformations -

The -adce pass -

The -licm pass -

The -argpromotion pass -

The -gvn, -memcpyopt, and -dse passes -

Clients for debugging and evaluation of implementations -

The -print-alias-sets pass -

The -count-aa pass -

The -aa-eval pass -

Memory Dependence Analysis -

LLVM Bitcode File Format

+ Magic Numbers +

+ Primitives +

+ Fixed Width Integers +

+ Variable Width Integers +

+ Abbreviation IDs +

+ Blocks +

+ Data Records +

+ Abbreviations +

+ Standard Blocks +

+ Basics +

+ MODULE_BLOCK Contents +

+ PARAMATTR_BLOCK Contents +

+ TYPE_BLOCK Contents +

+ CONSTANTS_BLOCK Contents +

+ FUNCTION_BLOCK Contents +

+ TYPE_SYMTAB_BLOCK Contents +

+ VALUE_SYMTAB_BLOCK Contents +

+ METADATA_BLOCK Contents +

+ METADATA_ATTACHMENT Contents +

LLVM bugpoint tool: design and usage -

Description -

Design Philosophy -

Automatic Debugger Selection -

Crash debugger -

Code generator debugger -

Miscompilation debugger -

Advice for using bugpoint -

Building LLVM with CMake -

Introduction -

Quick start -

Basic CMake usage -

Options and variables -

Frequently-used CMake variables -

LLVM-specific variables -

`AliasAnalysis` Class Overview -

The `alias` method -

The `getModRefInfo` methods -

Other useful `AliasAnalysis` methods -

The `pointsToConstantMemory` method -

The `doesNotAccessMemory` and `onlyReadsMemory` methods -

Writing a new `AliasAnalysis` Implementation -

`AliasAnalysis` chaining behavior -

The `deleteValue` method

The `copyValue` method

The `replaceWithNewValue` method

The `addEscapingUse` method

Using the `MemoryDependenceAnalysis` Pass -

Using the `AliasSetTracker` class -

Using the `AliasAnalysis` interface directly -

Available `AliasAnalysis` implementations -

The `-no-aa` pass -

The `-basicaa` pass -

The `-globalsmodref-aa` pass -

The `-steens-aa` pass -

The `-ds-aa` pass -

The `-scev-aa` pass -

The `-adce` pass -

The `-licm` pass -

The `-argpromotion` pass -

The `-gvn`, `-memcpyopt`, and `-dse` passes -

The `-print-alias-sets` pass -

The `-count-aa` pass -

The `-aa-eval` pass -

The `TargetMachine` class -

The `TargetData` class -

The `TargetLowering` class -

The `TargetRegisterInfo` class -

The `TargetInstrInfo` class -

The `TargetFrameInfo` class -

The `TargetSubtarget` class -

The `TargetJITInfo` class -

The `MachineInstr` class -

Using the `MachineInstrBuilder.h` functions -