X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;ds=sidebyside;f=docs%2FLangRef.html;h=c877651225cf7a87ad41c0d9c4919590312a7951;hb=e86ce7d94abaf7883a5d84dcb9a79c118b63672b;hp=3c67f031785b8c8f7dcbddd1d04f3a5fa973b853;hpb=a89e5f1fd537e90b0582f7f8025086062cfbb210;p=oota-llvm.git diff --git a/docs/LangRef.html b/docs/LangRef.html index 3c67f031785..c877651225c 100644 --- a/docs/LangRef.html +++ b/docs/LangRef.html @@ -26,6 +26,7 @@
  • Functions
  • Aliases
  • Parameter Attributes
  • +
  • Garbage Collector Names
  • Module-Level Inline Assembly
  • Data Layout
  • @@ -39,6 +40,7 @@
  • Derived Types
      +
    1. Integer Type
    2. Array Type
    3. Function Type
    4. Pointer Type
    5. @@ -177,6 +179,9 @@
    6. 'llvm.memset.*' Intrinsic
    7. 'llvm.sqrt.*' Intrinsic
    8. 'llvm.powi.*' Intrinsic
    9. +
    10. 'llvm.sin.*' Intrinsic
    11. +
    12. 'llvm.cos.*' Intrinsic
    13. +
    14. 'llvm.pow.*' Intrinsic
  • Bit Manipulation Intrinsics @@ -191,6 +196,21 @@
  • Debugger intrinsics
  • Exception Handling intrinsics
  • +
  • Trampoline Intrinsic +
      +
    1. 'llvm.init.trampoline' Intrinsic
    2. +
    +
  • +
  • General intrinsics +
      +
    1. + llvm.var.annotation' Intrinsic
    2. +
    +
      +
    1. + llvm.annotation.*' Intrinsic
    2. +
    +
  • @@ -220,7 +240,7 @@ strategy.

    The LLVM code representation is designed to be used in three -different forms: as an in-memory compiler IR, as an on-disk bytecode +different forms: as an in-memory compiler IR, as an on-disk bitcode representation (suitable for fast loading by a Just-In-Time compiler), and as a human readable assembly language representation. This allows LLVM to provide a powerful intermediate representation for efficient @@ -262,12 +282,12 @@ following instruction is syntactically okay, but not well formed:

    its uses. The LLVM infrastructure provides a verification pass that may be used to verify that an LLVM module is well formed. This pass is automatically run by the parser after parsing input assembly and by -the optimizer before it outputs bytecode. The violations pointed out +the optimizer before it outputs bitcode. The violations pointed out by the verifier pass indicate bugs in transformation passes or input to the parser.

    - +
    Identifiers
    @@ -275,25 +295,27 @@ the parser.

    -

    LLVM uses three different forms of identifiers, for different -purposes:

    +

    LLVM identifiers come in two basic types: global and local. Global + identifiers (functions, global variables) begin with the @ character. Local + identifiers (register names, types) begin with the % character. Additionally, + there are three different formats for identifiers, for different purposes:

      -
    1. Named values are represented as a string of characters with a '%' prefix. - For example, %foo, %DivisionByZero, %a.really.long.identifier. The actual - regular expression used is '%[a-zA-Z$._][a-zA-Z$._0-9]*'. +
    2. Named values are represented as a string of characters with their prefix. + For example, %foo, @DivisionByZero, %a.really.long.identifier. The actual + regular expression used is '[%@][a-zA-Z$._][a-zA-Z$._0-9]*'. Identifiers which require other characters in their names can be surrounded - with quotes. In this way, anything except a " character can be used - in a name.
    3. + with quotes. In this way, anything except a " character can + be used in a named value. -
    4. Unnamed values are represented as an unsigned numeric value with a '%' - prefix. For example, %12, %2, %44.
    5. +
    6. Unnamed values are represented as an unsigned numeric value with their + prefix. For example, %12, @2, %44.
    7. Constants, which are described in a section about constants, below.
    -

    LLVM requires that values start with a '%' sign for two reasons: Compilers +

    LLVM requires that values start with a prefix for two reasons: Compilers don't need to worry about name clashes with reserved words, and the set of reserved words may be expanded in the future without penalty. Additionally, unnamed identifiers allow a compiler to quickly come up with a temporary @@ -306,7 +328,7 @@ languages. There are keywords for different opcodes 'ret', etc...), for primitive type names ('void', 'i32', etc...), and others. These reserved words cannot conflict with variable names, because -none of them start with a '%' character.

    +none of them start with a prefix character ('%' or '@').

    Here is an example of LLVM code to multiply the integer variable '%X' by 8:

    @@ -388,7 +410,7 @@ symbol table entries. Here is an example of the "hello world" module:

    define i32 @main() { ; i32()* ; Convert [13x i8 ]* to i8 *... %cast210 = getelementptr [13 x i8 ]* %.LC0, i64 0, i64 0 ; i8 * + href="#i_getelementptr">getelementptr [13 x i8 ]* @.LC0, i64 0, i64 0 ; i8 * ; Call puts function to write out the string to stdout... +

    A global variable may be declared to reside in a target-specifc numbered +address space. For targets that support them, address spaces may affect how +optimizations are performed and/or what target instructions are used to access +the variable. The default address space is zero. The address space qualifier +must precede any other attributes.

    +

    LLVM allows an explicit section to be specified for globals. If the target supports it, it will emit globals to the section specified.

    @@ -656,12 +684,12 @@ to whatever it feels convenient. If an explicit alignment is specified, the global is forced to have at least that much alignment. All alignments must be a power of 2.

    -

    For example, the following defines a global with an initializer, section, - and alignment:

    +

    For example, the following defines a global in a numbered address space with +an initializer, section, and alignment:

    -%G = constant float 1.0, section "foo", align 4
    +@G = constant float 1.0 addrspace(5), section "foo", align 4
     
    @@ -682,15 +710,16 @@ an optional
    linkage type, an optional parameter attribute for the return type, a function name, a (possibly empty) argument list (each with optional parameter attributes), an optional section, an -optional alignment, an opening curly brace, a list of basic blocks, and a -closing curly brace. +optional alignment, an optional garbage collector name, an +opening curly brace, a list of basic blocks, and a closing curly brace. LLVM function declarations consist of the "declare" keyword, an optional linkage type, an optional visibility style, an optional calling convention, a return type, an optional parameter attribute for the return type, a function -name, a possibly empty list of arguments, and an optional alignment.

    +name, a possibly empty list of arguments, an optional alignment, and an optional +garbage collector name.

    A function definition contains a list of basic blocks, forming the CFG for the function. Each basic block may optionally start with a label (giving the @@ -704,11 +733,6 @@ basic blocks (i.e. there can not be any branches to the entry block of a function). Because the block can have no predecessors, it also cannot have any PHI nodes.

    -

    LLVM functions are identified by their name and type signature. Hence, two -functions with the same name but different parameter lists or return values are -considered different functions, and LLVM will resolve references to each -appropriately.

    -

    LLVM allows an explicit section to be specified for functions. If the target supports it, it will emit functions to the section specified.

    @@ -749,9 +773,9 @@ a power of 2.

    The return type and each parameter of a function type may have a set of parameter attributes associated with them. Parameter attributes are used to communicate additional information about the result or parameters of - a function. Parameter attributes are considered to be part of the function - type so two functions types that differ only by the parameter attributes - are different function types.

    + a function. Parameter attributes are considered to be part of the function, + not of the function type, so functions with different parameter attributes + can have the same function type.

    Parameter attributes are simple keywords that follow the type specified. If multiple parameter attributes are needed, they are space separated. For @@ -759,22 +783,20 @@ a power of 2.

    -%someFunc = i16 (i8 sext %someParam) zext
    -%someFunc = i16 (i8 zext %someParam) zext
    +declare i32 @printf(i8* noalias , ...) nounwind
    +declare i32 @atoi(i8*) nounwind readonly
     
    -

    Note that the two function types above are unique because the parameter has - a different attribute (sext in the first one, zext in the second). Also note - that the attribute for the function result (zext) comes immediately after the - argument list.

    +

    Note that any attributes for the function result (nounwind, + readonly) come immediately after the argument list.

    Currently, only the following parameter attributes are defined:

    -
    zext
    +
    zeroext
    This indicates that the parameter should be zero extended just before a call to this function.
    -
    sext
    +
    signext
    This indicates that the parameter should be sign extended just before a call to this function.
    inreg
    @@ -795,10 +817,39 @@ a power of 2.

    This function attribute indicates that the function type does not use the unwind instruction and does not allow stack unwinding to propagate through it.
    +
    nest
    +
    This indicates that the parameter can be excised using the + trampoline intrinsics.
    +
    readonly
    +
    This function attribute indicates that the function has no side-effects + except for producing a return value or throwing an exception. The value + returned must only depend on the function arguments and/or global variables. + It may use values obtained by dereferencing pointers.
    +
    readnone
    +
    A readnone function has the same restrictions as a readonly + function, but in addition it is not allowed to dereference any pointer arguments + or global variables.
    + +
    + Garbage Collector Names +
    + +
    +

    Each function may specify a garbage collector name, which is simply a +string.

    + +
    define void @f() gc "name" { ...
    + +

    The compiler declares the supported values of name. Specifying a +collector which will cause the compiler to alter its output in order to support +the named garbage collection algorithm.

    +
    +
    Module-Level Inline Assembly @@ -1019,28 +1070,18 @@ value.

    Examples:
    - - - + + + + + + + + + + +
    - i1
    - i4
    - i8
    - i16
    - i32
    - i42
    - i64
    - i1942652
    -
    - A boolean integer of 1 bit
    - A nibble sized integer of 4 bits.
    - A byte sized integer of 8 bits.
    - A half word sized integer of 16 bits.
    - A word sized integer of 32 bits.
    - An integer whose bit width is the answer.
    - A double word sized integer of 64 bits.
    - A really big integer of over 1 million bits.
    -
    i1a single-bit integer.
    i32a 32-bit integer.
    i1942652a really big integer of over 1 million bits.
    @@ -1067,31 +1108,31 @@ be any type with a size.

    Examples:
    - - + + + + + + + + + +
    - [40 x i32 ]
    - [41 x i32 ]
    - [40 x i8]
    -
    - Array of 40 32-bit integer values.
    - Array of 41 32-bit integer values.
    - Array of 40 8-bit integer values.
    -
    [40 x i32]Array of 40 32-bit integer values.
    [41 x i32]Array of 41 32-bit integer values.
    [4 x i8]Array of 4 8-bit integer values.

    Here are some examples of multidimensional arrays:

    - - + + + + + + + + + +
    - [3 x [4 x i32]]
    - [12 x [10 x float]]
    - [2 x [3 x [4 x i16]]]
    -
    - 3x4 array of 32-bit integer values.
    - 12x10 array of single precision floating point values.
    - 2x3x4 array of 16-bit integer values.
    -
    [3 x [4 x i32]]3x4 array of 32-bit integer values.
    [12 x [10 x float]]12x10 array of single precision floating point values.
    [2 x [3 x [4 x i16]]]2x3x4 array of 16-bit integer values.
    @@ -1130,7 +1171,7 @@ Variable argument functions can access their arguments with the function taking an i32, returning an i32 - float (i16 sext, i32 *) * + float (i16 signext, i32 *) * Pointer to a function that takes an i16 that should be sign extended and a @@ -1198,7 +1239,7 @@ instruction.

    < { i32, i32, i32 } > A triple of three i32 values - < { float, i32 (i32) * } > + < { float, i32 (i32)* } > A pair, where the first element is a float and the second element is a pointer to a function that takes an i32, returning @@ -1212,23 +1253,29 @@ instruction.

    Overview:

    As in many languages, the pointer type represents a pointer or -reference to another object, which must live in memory.

    +reference to another object, which must live in memory. Pointer types may have +an optional address space attribute defining the target-specific numbered +address space where the pointed-to object resides. The default address space is +zero.

    Syntax:
      <type> *
    Examples:
    - - + + + + + + i32. + + + +
    - [4x i32]*
    - i32 (i32 *) *
    -
    - A pointer to array of - four i32 values
    - A pointer to a [4x i32]*
    A pointer to array of four i32 values.
    i32 (i32 *) * A pointer to a function that takes an i32*, returning an - i32.
    -
    i32 addrspace(5)*A pointer to an i32 value + that resides in address space #5.
    @@ -1260,16 +1307,16 @@ be any integer or floating point type.

    - - + + + + + + + + + +
    - <4 x i32>
    - <8 x float>
    - <2 x i64>
    -
    - Vector of 4 32-bit integer values.
    - Vector of 8 floating-point values.
    - Vector of 2 64-bit integer values.
    -
    <4 x i32>Vector of 4 32-bit integer values.
    <8 x float>Vector of 8 32-bit floating-point values.
    <2 x i64>Vector of 2 64-bit integer values.
    @@ -1281,7 +1328,7 @@ be any integer or floating point type.

    Overview:

    Opaque types are used to represent unknown types in the system. This -corresponds (for example) to the C notion of a foward declared structure type. +corresponds (for example) to the C notion of a forward declared structure type. In LLVM, opaque types can eventually be resolved to any type (not just a structure type).

    @@ -1295,12 +1342,8 @@ structure type).

    - - + +
    - opaque - - An opaque type.
    -
    opaqueAn opaque type.
    @@ -1375,8 +1418,8 @@ and smaller aggregate constants.

    Structure constants are represented with notation similar to structure type definitions (a comma separated list of elements, surrounded by braces - ({})). For example: "{ i32 4, float 17.0, i32* %G }", - where "%G" is declared as "%G = external global i32". Structure constants + ({})). For example: "{ i32 4, float 17.0, i32* @G }", + where "@G" is declared as "@G = external global i32". Structure constants must have structure type, and the number and types of elements must match those specified by the type.
    @@ -1482,25 +1525,33 @@ following is the syntax for constant expressions:

    Floating point extend a constant to another type. The size of CST must be smaller or equal to the size of TYPE. Both types must be floating point.
    -
    fp2uint ( CST to TYPE )
    +
    fptoui ( CST to TYPE )
    Convert a floating point constant to the corresponding unsigned integer - constant. TYPE must be an integer type. CST must be floating point. If the - value won't fit in the integer type, the results are undefined.
    + constant. TYPE must be a scalar or vector integer type. CST must be of scalar + or vector floating point type. Both CST and TYPE must be scalars, or vectors + of the same number of elements. If the value won't fit in the integer type, + the results are undefined.
    fptosi ( CST to TYPE )
    Convert a floating point constant to the corresponding signed integer - constant. TYPE must be an integer type. CST must be floating point. If the - value won't fit in the integer type, the results are undefined.
    + constant. TYPE must be a scalar or vector integer type. CST must be of scalar + or vector floating point type. Both CST and TYPE must be scalars, or vectors + of the same number of elements. If the value won't fit in the integer type, + the results are undefined.
    uitofp ( CST to TYPE )
    Convert an unsigned integer constant to the corresponding floating point - constant. TYPE must be floating point. CST must be of integer type. If the - value won't fit in the floating point type, the results are undefined.
    + constant. TYPE must be a scalar or vector floating point type. CST must be of + scalar or vector integer type. Both CST and TYPE must be scalars, or vectors + of the same number of elements. If the value won't fit in the floating point + type, the results are undefined.
    sitofp ( CST to TYPE )
    Convert a signed integer constant to the corresponding floating point - constant. TYPE must be floating point. CST must be of integer type. If the - value won't fit in the floating point type, the results are undefined.
    + constant. TYPE must be a scalar or vector floating point type. CST must be of + scalar or vector integer type. Both CST and TYPE must be scalars, or vectors + of the same number of elements. If the value won't fit in the floating point + type, the results are undefined.
    ptrtoint ( CST to TYPE )
    Convert a pointer typed constant to the corresponding integer constant @@ -2075,7 +2126,8 @@ unsigned division of its two arguments.

    Arguments:

    The two arguments to the 'urem' instruction must be integer values. Both arguments must have identical -types.

    +types. This instruction can also take vector versions +of the values in which case the elements must be integers.

    Semantics:

    This instruction returns the unsigned integer remainder of a division. This instruction always performs an unsigned division to get the remainder, @@ -2094,7 +2146,10 @@ Instruction

    Overview:

    The 'srem' instruction returns the remainder from the -signed division of its two operands.

    +signed division of its two operands. This instruction can also take +vector versions of the values in which case +the elements must be integers.

    +

    Arguments:

    The two arguments to the 'srem' instruction must be integer values. Both arguments must have identical @@ -2126,7 +2181,8 @@ division of its two operands.

    Arguments:

    The two arguments to the 'frem' instruction must be floating point values. Both arguments must have -identical types.

    +identical types. This instruction can also take vector +versions of floating point values.

    Semantics:

    This instruction returns the remainder of a division.

    Example:
    @@ -2153,18 +2209,28 @@ Instruction
    Syntax:
      <result> = shl <ty> <var1>, <var2>   ; yields {ty}:result
     
    +
    Overview:
    +

    The 'shl' instruction returns the first operand shifted to the left a specified number of bits.

    +
    Arguments:
    +

    Both arguments to the 'shl' instruction must be the same integer type.

    +
    Semantics:
    -

    The value produced is var1 * 2var2.

    + +

    The value produced is var1 * 2var2. If +var2 is (statically or dynamically) equal to or larger than the number +of bits in var1, the result is undefined.

    +
    Example:
       <result> = shl i32 4, %var   ; yields {i32}: 4 << %var
       <result> = shl i32 4, 2      ; yields {i32}: 16
       <result> = shl i32 1, 10     ; yields {i32}: 1024
    +  <result> = shl i32 1, 32     ; undefined
     
    @@ -2184,9 +2250,11 @@ operand shifted to the right a specified number of bits with zero fill.

    integer type.

    Semantics:
    +

    This instruction always performs a logical shift right operation. The most significant bits of the result will be filled with zero bits after the -shift.

    +shift. If var2 is (statically or dynamically) equal to or larger than +the number of bits in var1, the result is undefined.

    Example:
    @@ -2194,6 +2262,7 @@ shift.

    <result> = lshr i32 4, 2 ; yields {i32}:result = 1 <result> = lshr i8 4, 3 ; yields {i8}:result = 0 <result> = lshr i8 -2, 1 ; yields {i8}:result = 0x7FFFFFFF + <result> = lshr i32 1, 32 ; undefined
    @@ -2217,7 +2286,9 @@ operand shifted to the right a specified number of bits with sign extension.

    Semantics:

    This instruction always performs an arithmetic shift right operation, The most significant bits of the result will be filled with the sign bit -of var1.

    +of var1. If var2 is (statically or dynamically) equal to or +larger than the number of bits in var1, the result is undefined. +

    Example:
    @@ -2225,6 +2296,7 @@ of var1.

    <result> = ashr i32 4, 2 ; yields {i32}:result = 1 <result> = ashr i8 4, 3 ; yields {i8}:result = 0 <result> = ashr i8 -2, 1 ; yields {i8}:result = -1 + <result> = ashr i32 1, 32 ; undefined
    @@ -2586,7 +2658,8 @@ allocate, and free memory in LLVM.

    Overview:

    The 'malloc' instruction allocates memory from the system -heap and returns a pointer to it.

    +heap and returns a pointer to it. The object is always allocated in the generic +address space (address space zero).

    Arguments:
    @@ -2673,7 +2746,8 @@ after this instruction executes.

    The 'alloca' instruction allocates memory on the stack frame of the currently executing function, to be automatically released when this function -returns to its caller.

    +returns to its caller. The object is always allocated in the generic address +space (address space zero).

    Arguments:
    @@ -2754,9 +2828,8 @@ this store with other volatile load and <pointer>' operand.

    Example:
      %ptr = alloca i32                               ; yields {i32*}:ptr
    -  store i32 3, i32* %ptr                          ; yields {void}
    -  %val = load i32* %ptr                           ; yields {i32}:val = i32 3
    +  store i32 3, i32* %ptr                          ; yields {void}
    +  %val = load i32* %ptr                           ; yields {i32}:val = i32 3
     
    @@ -3079,34 +3152,32 @@ used to make a no-op cast because it always changes bits. Use
    Syntax:
    -  <result> = fp2uint <ty> <value> to <ty2>             ; yields ty2
    +  <result> = fptoui <ty> <value> to <ty2>             ; yields ty2
     
    Overview:
    -

    The 'fp2uint' converts a floating point value to its +

    The 'fptoui' converts a floating point value to its unsigned integer equivalent of type ty2.

    Arguments:
    -

    The 'fp2uint' instruction takes a value to cast, which must be a -floating point value, and a type to cast it to, which -must be an integer type.

    +

    The 'fptoui' instruction takes a value to cast, which must be a +scalar or vector floating point value, and a type +to cast it to ty2, which must be an integer +type. If ty is a vector floating point type, ty2 must be a +vector integer type with the same number of elements as ty

    Semantics:
    -

    The 'fp2uint' instruction converts its +

    The 'fptoui' instruction converts its floating point operand into the nearest (rounding towards zero) unsigned integer value. If the value cannot fit in ty2, the results are undefined.

    -

    When converting to i1, the conversion is done as a comparison against -zero. If the value was zero, the i1 result will be false. -If the value was non-zero, the i1 result will be true.

    -
    Example:
    -  %X = fp2uint double 123.0 to i32      ; yields i32:123
    -  %Y = fp2uint float 1.0E+300 to i1     ; yields i1:true
    -  %X = fp2uint float 1.04E+17 to i8     ; yields undefined:1
    +  %X = fptoui double 123.0 to i32      ; yields i32:123
    +  %Y = fptoui float 1.0E+300 to i1     ; yields undefined:1
    +  %X = fptoui float 1.04E+17 to i8     ; yields undefined:1
     
    @@ -3126,11 +3197,12 @@ If the value was non-zero, the i1 result will be true.

    floating point value to type ty2.

    -
    Arguments:

    The 'fptosi' instruction takes a value to cast, which must be a -floating point value, and a type to cast it to, which -must also be an integer type.

    +scalar or vector floating point value, and a type +to cast it to ty2, which must be an integer +type. If ty is a vector floating point type, ty2 must be a +vector integer type with the same number of elements as ty

    Semantics:

    The 'fptosi' instruction converts its @@ -3138,14 +3210,10 @@ must also be an integer type.

    towards zero) signed integer value. If the value cannot fit in ty2, the results are undefined.

    -

    When converting to i1, the conversion is done as a comparison against -zero. If the value was zero, the i1 result will be false. -If the value was non-zero, the i1 result will be true.

    -
    Example:
       %X = fptosi double -123.0 to i32      ; yields i32:-123
    -  %Y = fptosi float 1.0E-247 to i1      ; yields i1:true
    +  %Y = fptosi float 1.0E-247 to i1      ; yields undefined:1
       %X = fptosi float 1.04E+17 to i8      ; yields undefined:1
     
    @@ -3165,18 +3233,18 @@ If the value was non-zero, the i1 result will be true.

    The 'uitofp' instruction regards value as an unsigned integer and converts that value to the ty2 type.

    -
    Arguments:
    -

    The 'uitofp' instruction takes a value to cast, which must be an -integer value, and a type to cast it to, which must -be a floating point type.

    +

    The 'uitofp' instruction takes a value to cast, which must be a +scalar or vector integer value, and a type to cast it +to ty2, which must be an floating point +type. If ty is a vector integer type, ty2 must be a vector +floating point type with the same number of elements as ty

    Semantics:

    The 'uitofp' instruction interprets its operand as an unsigned integer quantity and converts it to the corresponding floating point value. If the value cannot fit in the floating point value, the results are undefined.

    -
    Example:
       %X = uitofp i32 257 to float         ; yields float:257.0
    @@ -3200,9 +3268,11 @@ the value cannot fit in the floating point value, the results are undefined.

    integer and converts that value to the ty2 type.

    Arguments:
    -

    The 'sitofp' instruction takes a value to cast, which must be an -integer value, and a type to cast it to, which must be -a floating point type.

    +

    The 'sitofp' instruction takes a value to cast, which must be a +scalar or vector integer value, and a type to cast it +to ty2, which must be an floating point +type. If ty is a vector integer type, ty2 must be a vector +floating point type with the same number of elements as ty

    Semantics:

    The 'sitofp' instruction interprets its operand as a signed @@ -3560,7 +3630,7 @@ value argument; otherwise, it returns the second value argument.

    Syntax:
    -  <result> = [tail] call [cconv] <ty>* <fnptrval>(<param list>)
    +  <result> = [tail] call [cconv] <ty> [<fnty>*] <fnptrval>(<param list>)
     
    Overview:
    @@ -3585,10 +3655,15 @@ value argument; otherwise, it returns the second value argument. to using C calling conventions.
  • -

    'ty': shall be the signature of the pointer to function value - being invoked. The argument types must match the types implied by this - signature. This type can be omitted if the function is not varargs and - if the function type does not return a pointer to a function.

    +

    'ty': the type of the call instruction itself which is also + the type of the return value. Functions that return no value are marked + void.

    +
  • +
  • +

    'fnty': shall be the signature of the pointer to function + value being invoked. The argument types must match the types implied by + this signature. This type can be omitted if the function is not varargs + and if the function type does not return a pointer to a function.

  • 'fnptrval': An LLVM value containing a pointer to a function to @@ -3618,10 +3693,11 @@ the invoke instruction.

    Example:
    -  %retval = call i32 %test(i32 %argc)
    -  call i32(i8 *, ...) *%printf(i8 * %msg, i32 12, i8 42);
    -  %X = tail call i32 %foo()
    -  %Y = tail call fastcc i32 %foo()
    +  %retval = call i32 @test(i32 %argc)
    +  call i32 (i8 *, ...)* @printf(i8 * %msg, i32 12, i8 42);
    +  %X = tail call i32 @foo()
    +  %Y = tail call fastcc i32 @foo()
    +  %Z = call void %foo(i8 97 signext)
     
    @@ -3684,7 +3760,7 @@ argument.

    well known names and semantics and are required to follow certain restrictions. Overall, these intrinsics represent an extension mechanism for the LLVM language that does not require changing all of the transformations in LLVM when -adding to the language (or the bytecode reader/writer, the parser, etc...).

    +adding to the language (or the bitcode reader/writer, the parser, etc...).

    Intrinsic function names must all start with an "llvm." prefix. This prefix is reserved in LLVM for intrinsic names; thus, function names may not @@ -3695,17 +3771,27 @@ of an intrinsic function. Additionally, because intrinsic functions are part of the LLVM language, it is required if any are added that they be documented here.

    -

    Some intrinsic functions can be overloaded, i.e., the intrinsic represents -a family of functions that perform the same operation but on different data -types. This is most frequent with the integer types. Since LLVM can represent -over 8 million different integer types, there is a way to declare an intrinsic -that can be overloaded based on its arguments. Such an intrinsic will have the -names of its argument types encoded into its function name, each -preceded by a period. For example, the llvm.ctpop function can take an -integer of any width. This leads to a family of functions such as -i32 @llvm.ctpop.i8(i8 %val) and i32 @llvm.ctpop.i29(i29 %val). -

    - +

    Some intrinsic functions can be overloaded, i.e., the intrinsic represents +a family of functions that perform the same operation but on different data +types. Because LLVM can represent over 8 million different integer types, +overloading is used commonly to allow an intrinsic function to operate on any +integer type. One or more of the argument types or the result type can be +overloaded to accept any integer type. Argument types may also be defined as +exactly matching a previous argument's type or the result type. This allows an +intrinsic function which accepts multiple arguments, but needs all of them to +be of the same type, to only be overloaded with respect to a single argument or +the result.

    + +

    Overloaded intrinsics will have the names of its overloaded argument types +encoded into its function name, each preceded by a period. Only those types +which are overloaded result in a name suffix. Arguments whose type is matched +against another type do not. For example, the llvm.ctpop function can +take an integer of any width and returns an integer of exactly the same integer +width. This leads to a family of functions such as +i8 @llvm.ctpop.i8(i8 %val) and i29 @llvm.ctpop.i29(i29 %val). +Only one type, the return type, is overloaded, and only one type suffix is +required. Because the argument's type is matched against the return type, it +does not require its own name suffix.

    To learn how to add an intrinsic function, please see the Extending LLVM Guide. @@ -3875,6 +3961,10 @@ Front-ends for type-safe garbage collected languages should generate these intrinsics to make use of the LLVM garbage collectors. For more details, see Accurate Garbage Collection with LLVM.

    + +

    The garbage collection intrinsics only operate on objects in the generic + address space (address space zero).

    + @@ -3887,7 +3977,7 @@ href="GarbageCollection.html">Accurate Garbage Collection with LLVM.
    Syntax:
    -  declare void @llvm.gcroot(<ty>** %ptrloc, <ty2>* %metadata)
    +  declare void @llvm.gcroot(i8** %ptrloc, i8* %metadata)
     
    Overview:
    @@ -3905,8 +3995,9 @@ value address) contains the meta-data to be associated with the root.

    At runtime, a call to this intrinsics stores a null pointer into the "ptrloc" location. At compile-time, the code generator generates information to allow -the runtime to find the pointer at GC safe points. -

    +the runtime to find the pointer at GC safe points. The 'llvm.gcroot' +intrinsic may only be used in a function which specifies a GC +algorithm.

    @@ -3921,7 +4012,7 @@ the runtime to find the pointer at GC safe points.
    Syntax:
    -  declare i8 * @llvm.gcread(i8 * %ObjPtr, i8 ** %Ptr)
    +  declare i8* @llvm.gcread(i8* %ObjPtr, i8** %Ptr)
     
    Overview:
    @@ -3941,7 +4032,9 @@ null).

    The 'llvm.gcread' intrinsic has the same semantics as a load instruction, but may be replaced with substantially more complex code by the -garbage collector runtime, as needed.

    +garbage collector runtime, as needed. The 'llvm.gcread' intrinsic +may only be used in a function which specifies a GC +algorithm.

    @@ -3956,7 +4049,7 @@ garbage collector runtime, as needed.

    Syntax:
    -  declare void @llvm.gcwrite(i8 * %P1, i8 * %Obj, i8 ** %P2)
    +  declare void @llvm.gcwrite(i8* %P1, i8* %Obj, i8** %P2)
     
    Overview:
    @@ -3976,7 +4069,9 @@ null.

    The 'llvm.gcwrite' intrinsic has the same semantics as a store instruction, but may be replaced with substantially more complex code by the -garbage collector runtime, as needed.

    +garbage collector runtime, as needed. The 'llvm.gcwrite' intrinsic +may only be used in a function which specifies a GC +algorithm.

    @@ -4049,7 +4144,7 @@ source-language caller.
    Syntax:
    -  declare i8  *@llvm.frameaddress(i32 <level>)
    +  declare i8 *@llvm.frameaddress(i32 <level>)
     
    Overview:
    @@ -4092,7 +4187,7 @@ source-language caller.
    Syntax:
    -  declare i8  *@llvm.stacksave()
    +  declare i8 *@llvm.stacksave()
     
    Overview:
    @@ -4158,8 +4253,7 @@ See the description for llvm.stacksave.
    Syntax:
    -  declare void @llvm.prefetch(i8  * <address>,
    -                                i32 <rw>, i32 <locality>)
    +  declare void @llvm.prefetch(i8* <address>, i32 <rw>, i32 <locality>)
     
    Overview:
    @@ -4203,7 +4297,7 @@ performance.
    Syntax:
    -  declare void @llvm.pcmarker( i32 <id> )
    +  declare void @llvm.pcmarker(i32 <id>)
     
    Overview:
    @@ -4453,16 +4547,22 @@ this can be specified as the fourth argument, otherwise it should be set to 0 or
    Syntax:
    +

    This is an overloaded intrinsic. You can use llvm.sqrt on any +floating point or vector of floating point type. Not all targets support all +types however.

    -  declare float @llvm.sqrt.f32(float %Val)
    -  declare double @llvm.sqrt.f64(double %Val)
    +  declare float     @llvm.sqrt.f32(float %Val)
    +  declare double    @llvm.sqrt.f64(double %Val)
    +  declare x86_fp80  @llvm.sqrt.f80(x86_fp80 %Val)
    +  declare fp128     @llvm.sqrt.f128(fp128 %Val)
    +  declare ppc_fp128 @llvm.sqrt.ppcf128(ppc_fp128 %Val)
     
    Overview:

    The 'llvm.sqrt' intrinsics return the sqrt of the specified operand, -returning the same value as the libm 'sqrt' function would. Unlike +returning the same value as the libm 'sqrt' functions would. Unlike sqrt in libm, however, llvm.sqrt has undefined behavior for negative numbers (which allows for better optimization).

    @@ -4476,7 +4576,7 @@ The argument and return value are floating point numbers of the same type.
    Semantics:

    -This function returns the sqrt of the specified operand if it is a positive +This function returns the sqrt of the specified operand if it is a nonnegative floating point number.

    @@ -4489,9 +4589,15 @@ floating point number.
    Syntax:
    +

    This is an overloaded intrinsic. You can use llvm.powi on any +floating point or vector of floating point type. Not all targets support all +types however.

    -  declare float  @llvm.powi.f32(float  %Val, i32 %power)
    -  declare double @llvm.powi.f64(double %Val, i32 %power)
    +  declare float     @llvm.powi.f32(float  %Val, i32 %power)
    +  declare double    @llvm.powi.f64(double %Val, i32 %power)
    +  declare x86_fp80  @llvm.powi.f80(x86_fp80  %Val, i32 %power)
    +  declare fp128     @llvm.powi.f128(fp128 %Val, i32 %power)
    +  declare ppc_fp128 @llvm.powi.ppcf128(ppc_fp128  %Val, i32 %power)
     
    Overview:
    @@ -4499,7 +4605,8 @@ floating point number.

    The 'llvm.powi.*' intrinsics return the first operand raised to the specified (positive or negative) power. The order of evaluation of -multiplications is not defined. +multiplications is not defined. When a vector of floating point type is +used, the second argument remains a scalar integer value.

    Arguments:
    @@ -4516,6 +4623,126 @@ This function returns the first value raised to the second power with an unspecified sequence of rounding operations.

    + + + +
    + +
    Syntax:
    +

    This is an overloaded intrinsic. You can use llvm.sin on any +floating point or vector of floating point type. Not all targets support all +types however. +

    +  declare float     @llvm.sin.f32(float  %Val)
    +  declare double    @llvm.sin.f64(double %Val)
    +  declare x86_fp80  @llvm.sin.f80(x86_fp80  %Val)
    +  declare fp128     @llvm.sin.f128(fp128 %Val)
    +  declare ppc_fp128 @llvm.sin.ppcf128(ppc_fp128  %Val)
    +
    + +
    Overview:
    + +

    +The 'llvm.sin.*' intrinsics return the sine of the operand. +

    + +
    Arguments:
    + +

    +The argument and return value are floating point numbers of the same type. +

    + +
    Semantics:
    + +

    +This function returns the sine of the specified operand, returning the +same values as the libm sin functions would, and handles error +conditions in the same way.

    +
    + + + + +
    + +
    Syntax:
    +

    This is an overloaded intrinsic. You can use llvm.cos on any +floating point or vector of floating point type. Not all targets support all +types however. +

    +  declare float     @llvm.cos.f32(float  %Val)
    +  declare double    @llvm.cos.f64(double %Val)
    +  declare x86_fp80  @llvm.cos.f80(x86_fp80  %Val)
    +  declare fp128     @llvm.cos.f128(fp128 %Val)
    +  declare ppc_fp128 @llvm.cos.ppcf128(ppc_fp128  %Val)
    +
    + +
    Overview:
    + +

    +The 'llvm.cos.*' intrinsics return the cosine of the operand. +

    + +
    Arguments:
    + +

    +The argument and return value are floating point numbers of the same type. +

    + +
    Semantics:
    + +

    +This function returns the cosine of the specified operand, returning the +same values as the libm cos functions would, and handles error +conditions in the same way.

    +
    + + + + +
    + +
    Syntax:
    +

    This is an overloaded intrinsic. You can use llvm.pow on any +floating point or vector of floating point type. Not all targets support all +types however. +

    +  declare float     @llvm.pow.f32(float  %Val, float %Power)
    +  declare double    @llvm.pow.f64(double %Val, double %Power)
    +  declare x86_fp80  @llvm.pow.f80(x86_fp80  %Val, x86_fp80 %Power)
    +  declare fp128     @llvm.pow.f128(fp128 %Val, fp128 %Power)
    +  declare ppc_fp128 @llvm.pow.ppcf128(ppc_fp128  %Val, ppc_fp128 Power)
    +
    + +
    Overview:
    + +

    +The 'llvm.pow.*' intrinsics return the first operand raised to the +specified (positive or negative) power. +

    + +
    Arguments:
    + +

    +The second argument is a floating point power, and the first is a value to +raise to that power. +

    + +
    Semantics:
    + +

    +This function returns the first value raised to the second power, +returning the +same values as the libm pow functions would, and handles error +conditions in the same way.

    +
    +
    @@ -4539,12 +4766,11 @@ These allow efficient code generation for some algorithms.
    Syntax:

    This is an overloaded intrinsic function. You can use bswap on any integer -type that is an even number of bytes (i.e. BitWidth % 16 == 0). Note the suffix -that includes the type for the result and the operand. +type that is an even number of bytes (i.e. BitWidth % 16 == 0).

    -  declare i16 @llvm.bswap.i16.i16(i16 <id>)
    -  declare i32 @llvm.bswap.i32.i32(i32 <id>)
    -  declare i64 @llvm.bswap.i64.i64(i64 <id>)
    +  declare i16 @llvm.bswap.i16(i16 <id>)
    +  declare i32 @llvm.bswap.i32(i32 <id>)
    +  declare i64 @llvm.bswap.i64(i64 <id>)
     
    Overview:
    @@ -4559,12 +4785,12 @@ byte order.
    Semantics:

    -The llvm.bswap.16.i16 intrinsic returns an i16 value that has the high +The llvm.bswap.i16 intrinsic returns an i16 value that has the high and low byte of the input i16 swapped. Similarly, the llvm.bswap.i32 intrinsic returns an i32 value that has the four bytes of the input i32 swapped, so that if the input bytes are numbered 0, 1, 2, 3 then the returned -i32 will have its bytes in 3, 2, 1, 0 order. The llvm.bswap.i48.i48, -llvm.bswap.i64.i64 and other intrinsics extend this concept to +i32 will have its bytes in 3, 2, 1, 0 order. The llvm.bswap.i48, +llvm.bswap.i64 and other intrinsics extend this concept to additional even-byte lengths (6 bytes, 8 bytes and more, respectively).

    @@ -4581,11 +4807,11 @@ additional even-byte lengths (6 bytes, 8 bytes and more, respectively).

    This is an overloaded intrinsic. You can use llvm.ctpop on any integer bit width. Not all targets support all bit widths however.

    -  declare i32 @llvm.ctpop.i8 (i8  <src>)
    -  declare i32 @llvm.ctpop.i16(i16 <src>)
    +  declare i8 @llvm.ctpop.i8 (i8  <src>)
    +  declare i16 @llvm.ctpop.i16(i16 <src>)
       declare i32 @llvm.ctpop.i32(i32 <src>)
    -  declare i32 @llvm.ctpop.i64(i64 <src>)
    -  declare i32 @llvm.ctpop.i256(i256 <src>)
    +  declare i64 @llvm.ctpop.i64(i64 <src>)
    +  declare i256 @llvm.ctpop.i256(i256 <src>)
     
    Overview:
    @@ -4620,11 +4846,11 @@ The 'llvm.ctpop' intrinsic counts the 1's in a variable.

    This is an overloaded intrinsic. You can use llvm.ctlz on any integer bit width. Not all targets support all bit widths however.

    -  declare i32 @llvm.ctlz.i8 (i8  <src>)
    -  declare i32 @llvm.ctlz.i16(i16 <src>)
    +  declare i8 @llvm.ctlz.i8 (i8  <src>)
    +  declare i16 @llvm.ctlz.i16(i16 <src>)
       declare i32 @llvm.ctlz.i32(i32 <src>)
    -  declare i32 @llvm.ctlz.i64(i64 <src>)
    -  declare i32 @llvm.ctlz.i256(i256 <src>)
    +  declare i64 @llvm.ctlz.i64(i64 <src>)
    +  declare i256 @llvm.ctlz.i256(i256 <src>)
     
    Overview:
    @@ -4663,11 +4889,11 @@ of src. For example, llvm.ctlz(i32 2) = 30.

    This is an overloaded intrinsic. You can use llvm.cttz on any integer bit width. Not all targets support all bit widths however.

    -  declare i32 @llvm.cttz.i8 (i8  <src>)
    -  declare i32 @llvm.cttz.i16(i16 <src>)
    +  declare i8 @llvm.cttz.i8 (i8  <src>)
    +  declare i16 @llvm.cttz.i16(i16 <src>)
       declare i32 @llvm.cttz.i32(i32 <src>)
    -  declare i32 @llvm.cttz.i64(i64 <src>)
    -  declare i32 @llvm.cttz.i256(i256 <src>)
    +  declare i64 @llvm.cttz.i64(i64 <src>)
    +  declare i256 @llvm.cttz.i256(i256 <src>)
     
    Overview:
    @@ -4704,8 +4930,8 @@ of src. For example, llvm.cttz(2) = 1.

    This is an overloaded intrinsic. You can use llvm.part.select on any integer bit width.

    -  declare i17 @llvm.part.select.i17.i17 (i17 %val, i32 %loBit, i32 %hiBit)
    -  declare i29 @llvm.part.select.i29.i29 (i29 %val, i32 %loBit, i32 %hiBit)
    +  declare i17 @llvm.part.select.i17 (i17 %val, i32 %loBit, i32 %hiBit)
    +  declare i29 @llvm.part.select.i29 (i29 %val, i32 %loBit, i32 %hiBit)
     
    Overview:
    @@ -4751,8 +4977,8 @@ returned in the reverse order. So, for example, if X has the value

    This is an overloaded intrinsic. You can use llvm.part.set on any integer bit width.

    -  declare i17 @llvm.part.set.i17.i17.i9 (i17 %val, i9 %repl, i32 %lo, i32 %hi)
    -  declare i29 @llvm.part.set.i29.i29.i9 (i29 %val, i9 %repl, i32 %lo, i32 %hi)
    +  declare i17 @llvm.part.set.i17.i9 (i17 %val, i9 %repl, i32 %lo, i32 %hi)
    +  declare i29 @llvm.part.set.i29.i9 (i29 %val, i9 %repl, i32 %lo, i32 %hi)
     
    Overview:
    @@ -4819,6 +5045,165 @@ href="ExceptionHandling.html#format_common_intrinsics">LLVM Exception Handling document.

    + + + +
    +

    + This intrinsic makes it possible to excise one parameter, marked with + the nest attribute, from a function. The result is a callable + function pointer lacking the nest parameter - the caller does not need + to provide a value for it. Instead, the value to use is stored in + advance in a "trampoline", a block of memory usually allocated + on the stack, which also contains code to splice the nest value into the + argument list. This is used to implement the GCC nested function address + extension. +

    +

    + For example, if the function is + i32 f(i8* nest %c, i32 %x, i32 %y) then the resulting function + pointer has signature i32 (i32, i32)*. It can be created as follows:

    +
    +  %tramp = alloca [10 x i8], align 4 ; size and alignment only correct for X86
    +  %tramp1 = getelementptr [10 x i8]* %tramp, i32 0, i32 0
    +  %p = call i8* @llvm.init.trampoline( i8* %tramp1, i8* bitcast (i32 (i8* nest , i32, i32)* @f to i8*), i8* %nval )
    +  %fp = bitcast i8* %p to i32 (i32, i32)*
    +
    +

    The call %val = call i32 %fp( i32 %x, i32 %y ) is then equivalent + to %val = call i32 %f( i8* %nval, i32 %x, i32 %y ).

    +
    + + + +
    +
    Syntax:
    +
    +declare i8* @llvm.init.trampoline(i8* <tramp>, i8* <func>, i8* <nval>)
    +
    +
    Overview:
    +

    + This fills the memory pointed to by tramp with code + and returns a function pointer suitable for executing it. +

    +
    Arguments:
    +

    + The llvm.init.trampoline intrinsic takes three arguments, all + pointers. The tramp argument must point to a sufficiently large + and sufficiently aligned block of memory; this memory is written to by the + intrinsic. Note that the size and the alignment are target-specific - LLVM + currently provides no portable way of determining them, so a front-end that + generates this intrinsic needs to have some target-specific knowledge. + The func argument must hold a function bitcast to an i8*. +

    +
    Semantics:
    +

    + The block of memory pointed to by tramp is filled with target + dependent code, turning it into a function. A pointer to this function is + returned, but needs to be bitcast to an + appropriate function pointer type + before being called. The new function's signature is the same as that of + func with any arguments marked with the nest attribute + removed. At most one such nest argument is allowed, and it must be + of pointer type. Calling the new function is equivalent to calling + func with the same argument list, but with nval used for the + missing nest argument. If, after calling + llvm.init.trampoline, the memory pointed to by tramp is + modified, then the effect of any later call to the returned function pointer is + undefined. +

    +
    + + + + +
    +

    This class of intrinsics is designed to be generic and has +no specific purpose.

    +
    + + + + +
    + +
    Syntax:
    +
    +  declare void @llvm.var.annotation(i8* <val>, i8* <str>, i8* <str>, i32  <int> )
    +
    + +
    Overview:
    + +

    +The 'llvm.var.annotation' intrinsic +

    + +
    Arguments:
    + +

    +The first argument is a pointer to a value, the second is a pointer to a +global string, the third is a pointer to a global string which is the source +file name, and the last argument is the line number. +

    + +
    Semantics:
    + +

    +This intrinsic allows annotation of local variables with arbitrary strings. +This can be useful for special purpose optimizations that want to look for these + annotations. These have no other defined use, they are ignored by code + generation and optimization. +

    + + + + +
    + +
    Syntax:
    +

    This is an overloaded intrinsic. You can use 'llvm.annotation' on +any integer bit width. +

    +
    +  declare i8 @llvm.annotation.i8(i8 <val>, i8* <str>, i8* <str>, i32  <int> )
    +  declare i16 @llvm.annotation.i16(i16 <val>, i8* <str>, i8* <str>, i32  <int> )
    +  declare i32 @llvm.annotation.i32(i32 <val>, i8* <str>, i8* <str>, i32  <int> )
    +  declare i64 @llvm.annotation.i64(i64 <val>, i8* <str>, i8* <str>, i32  <int> )
    +  declare i256 @llvm.annotation.i256(i256 <val>, i8* <str>, i8* <str>, i32  <int> )
    +
    + +
    Overview:
    + +

    +The 'llvm.annotation' intrinsic. +

    + +
    Arguments:
    + +

    +The first argument is an integer value (result of some expression), +the second is a pointer to a global string, the third is a pointer to a global +string which is the source file name, and the last argument is the line number. +It returns the value of the first argument. +

    + +
    Semantics:
    + +

    +This intrinsic allows annotations to be put on arbitrary expressions +with arbitrary strings. This can be useful for special purpose optimizations +that want to look for these annotations. These have no other defined use, they +are ignored by code generation and optimization. +