X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FLangRef.html;h=09903f1016be76acc2decca4a81db68375ee86be;hb=f2317782697e05787dbae01c013bfdf642ed6299;hp=e7c3b1fade8772ce78771498f1cbdc0cfe861910;hpb=885190418fdf8736dd1948d5533f333d7e0f4060;p=oota-llvm.git diff --git a/docs/LangRef.html b/docs/LangRef.html index e7c3b1fade8..09903f1016b 100644 --- a/docs/LangRef.html +++ b/docs/LangRef.html @@ -26,19 +26,24 @@
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.
@@ -682,12 +696,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
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 @@ -748,8 +763,8 @@ a power of 2.
Aliases act as "second name" for the aliasee value (which can be either - function or global variable or bitcast of global value). Aliases may have an - optional linkage type, and an + function, global variable, another alias or bitcast of global value). Aliases + may have an optional linkage type, and an optional visibility style.
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 @@ -780,49 +795,92 @@ a power of 2.
-%someFunc = i16 (i8 signext %someParam) zeroext -%someFunc = i16 (i8 zeroext %someParam) zeroext +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 (signext in the first one, zeroext in - the second). Also note that the attribute for the function result - (zeroext) 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:
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.
+The primitive types are the fundamental building blocks of the LLVM -system. The current set of primitive types is as follows:
- -
-
|
-
-
|
-
These different primitive types fall into a few useful +
The types fall into a few useful classifications:
Classification | Types | ||
---|---|---|---|
integer | +integer | i1, i2, i3, ... i8, ... i16, ... i32, ... i64, ... | |
floating point | -float, double | +floating point | +float, double, x86_fp80, fp128, ppc_fp128 |
first class | -i1, ..., float, double, - pointer,vector + | integer, + floating point, + pointer, + vector | |
primitive | +label, + void, + integer, + floating point. | +||
derived | +integer, + array, + function, + pointer, + structure, + packed structure, + vector, + opaque. + |
The primitive types are the fundamental building blocks of the LLVM +system.
+ +Type | Description |
---|---|
float | 32-bit floating point value |
double | 64-bit floating point value |
fp128 | 128-bit floating point value (112-bit mantissa) |
x86_fp80 | 80-bit floating point value (X87) |
ppc_fp128 | 128-bit floating point value (two 64-bits) |
The void type does not represent any value and has no size.
+ ++ void ++
The label type represents code labels.
+ ++ label ++
- 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. - |
+
i1 | +a single-bit integer. | +
i32 | +a 32-bit integer. | +
i1942652 | +a really big integer of over 1 million bits. |
- [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. |
The function type can be thought of as a function signature. It -consists of a return type and a list of formal parameter types. -Function types are usually used to build virtual function tables +consists of a return type and a list of formal parameter types. The +return type of a function type is a scalar type or a void type or a struct type. +If the return type is a struct type then all struct elements must be of first +class types. Function types are usually used to build virtual function tables (which are structures of pointers to functions), for indirect function calls, and when defining a function.
--The return type of a function type cannot be an aggregate type. -
+<returntype> (<parameter list>)+
<returntype list> (<parameter list>)
...where '<parameter list>' is a comma-separated list of type specifiers. Optionally, the parameter list may include a type ..., which indicates that the function takes a variable number of arguments. Variable argument functions can access their arguments with the variable argument handling intrinsic functions.
+ href="#int_varargs">variable argument handling intrinsic functions. +'<returntype list>' is a comma-separated list of +first class type specifiers.{i32, i32} (i32) | +A function taking an i32>, returning two + i32 values as an aggregate of type { i32, i32 } + |
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.<type> *
- [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.
+ |
i32 addrspace(5)* | +A pointer to an i32 value + that resides in address space #5. |
- <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. |
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).
@@ -1319,12 +1424,8 @@ structure type).- opaque - | -
- An opaque type. - |
+ opaque | +An opaque type. |
ret <type> <value> ; Return a value from a non-void function ret void ; Return from void function + ret <type> <value>, <type> <value> ; Return two values from a non-void function
The 'ret' instruction is used to return control flow (and a @@ -1697,11 +1809,11 @@ value) from a function back to the caller.
returns a value and then causes control flow, and one that just causes control flow to occur.The 'ret' instruction may return any 'first class' type. Notice that a function is -not well formed if there exists a 'ret' -instruction inside of the function that returns a value that does not -match the return type of the function.
+The 'ret' instruction may return one or multiple values. The +type of each return value must be a 'first class' + type. Note that a function is not well formed +if there exists a 'ret' instruction inside of the function that +returns values that do not match the return type of the function.
When the 'ret' instruction is executed, control flow returns back to the calling function's context. If the caller is a "invoke" instruction, execution continues at the beginning of the "normal" destination block. If the instruction returns a value, that value shall set the call or invoke instruction's -return value.
+return value. If the instruction returns multiple values then these +values can only be accessed through a 'getresult +' instruction.ret i32 5 ; Return an integer value of 5 ret void ; Return from a void function + ret i32 4, i8 2 ; Return two values 4 and 2@@ -1810,7 +1925,7 @@ branches or with a lookup table.
- <result> = invoke [cconv] <ptr to function ty> %<function ptr val>(<function args>) + <result> = invoke [cconv] <ptr to function ty> <function ptr val>(<function args>) to label <normal label> unwind label <exception label>@@ -1823,7 +1938,9 @@ function, with the possibility of control flow transfer to either the "ret" instruction, control flow will return to the "normal" label. If the callee (or any indirect callees) returns with the "unwind" instruction, control is interrupted and -continued at the dynamically nearest "exception" label. +continued at the dynamically nearest "exception" label. If the callee function +returns multiple values then individual return values are only accessible through +a 'getresult' instruction.
- %retval = invoke i32 %Test(i32 15) to label %Continue + %retval = invoke i32 @Test(i32 15) to label %Continue unwind label %TestCleanup ; {i32}:retval set - %retval = invoke coldcc i32 %Test(i32 15) to label %Continue + %retval = invoke coldcc i32 %Testfnptr(i32 15) to label %Continue unwind label %TestCleanup ; {i32}:retval set@@ -1938,11 +2055,10 @@ no-return function cannot be reached, and other facts.
Binary operators are used to do most of the computation in a -program. They require two operands, execute an operation on them, and +program. They require two operands of the same type, execute an operation on them, and produce a single value. The operands might represent multiple data, as is the case with the vector data type. -The result value of a binary operator is not -necessarily the same type as its operands.
+The result value has the same type as its operands.There are several different binary operators:
The value produced is the integer or floating point sum of the two operands.
+If an integer sum has unsigned overflow, the result returned is the +mathematical result modulo 2n, where n is the bit width of +the result.
+Because LLVM integers use a two's complement representation, this +instruction is appropriate for both signed and unsigned integers.
<result> = add i32 4, %var ; yields {i32}:result = 4 + %var@@ -1987,6 +2108,11 @@ Both arguments must have identical types.
The value produced is the integer or floating point difference of the two operands.
+If an integer difference has unsigned overflow, the result returned is the +mathematical result modulo 2n, where n is the bit width of +the result.
+Because LLVM integers use a two's complement representation, this +instruction is appropriate for both signed and unsigned integers.
<result> = sub i32 4, %var ; yields {i32}:result = 4 - %var @@ -2012,9 +2138,15 @@ Both arguments must have identical types.Semantics:
The value produced is the integer or floating point product of the two operands.
-Because the operands are the same width, the result of an integer -multiplication is the same whether the operands should be deemed unsigned or -signed.
+If the result of an integer multiplication has unsigned overflow, +the result returned is the mathematical result modulo +2n, where n is the bit width of the result.
+Because LLVM integers use a two's complement representation, and the +result is the same width as the operands, this instruction returns the +correct result for both signed and unsigned integers. If a full product +(e.g. i32xi32->i64) is needed, the operands +should be sign-extended or zero-extended as appropriate to the +width of the full product.
Example:
<result> = mul i32 4, %var ; yields {i32}:result = 4 * %var@@ -2035,9 +2167,10 @@ operands. types. This instruction can also take vector versions of the values in which case the elements must be integers.Semantics:
-The value produced is the unsigned integer quotient of the two operands. This -instruction always performs an unsigned division operation, regardless of -whether the arguments are unsigned or not.
+The value produced is the unsigned integer quotient of the two operands.
+Note that unsigned integer division and signed integer division are distinct +operations; for signed integer division, use 'sdiv'.
+Division by zero leads to undefined behavior.
Example:
<result> = udiv i32 4, %var ; yields {i32}:result = 4 / %var@@ -2058,9 +2191,12 @@ operands. types. This instruction can also take vector versions of the values in which case the elements must be integers.Semantics:
-The value produced is the signed integer quotient of the two operands. This -instruction always performs a signed division operation, regardless of whether -the arguments are signed or not.
+The value produced is the signed integer quotient of the two operands rounded towards zero.
+Note that signed integer division and unsigned integer division are distinct +operations; for unsigned integer division, use 'udiv'.
+Division by zero leads to undefined behavior. Overflow also leads to +undefined behavior; this is a rare case, but can occur, for example, +by doing a 32-bit division of -2147483648 by -1.
Example:
<result> = sdiv i32 4, %var ; yields {i32}:result = 4 / %var@@ -2099,11 +2235,14 @@ 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, -regardless of whether the arguments are unsigned or not.
+This instruction always performs an unsigned division to get the remainder. +Note that unsigned integer remainder and signed integer remainder are +distinct operations; for signed integer remainder, use 'srem'.
+Taking the remainder of a division by zero leads to undefined behavior.
Example:
<result> = urem i32 4, %var ; yields {i32}:result = 4 % %var@@ -2118,7 +2257,10 @@ Instruction
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. +The two arguments to the 'srem' instruction must be integer values. Both arguments must have identical @@ -2132,6 +2274,14 @@ a value. For more information about the difference, see . For a table of how this is implemented in various languages, please see Wikipedia: modulo operation.
+Note that signed integer remainder and unsigned integer remainder are +distinct operations; for unsigned integer remainder, use 'urem'.
+Taking the remainder of a division by zero leads to undefined behavior. +Overflow also leads to undefined behavior; this is a rare case, but can occur, +for example, by taking the remainder of a 32-bit division of -2147483648 by -1. +(The remainder doesn't actually overflow, but this rule lets srem be +implemented using instructions that return both the result of the division +and the remainder.)
<result> = srem i32 4, %var ; yields {i32}:result = 4 % %var@@ -2150,9 +2300,11 @@ division of its two operands.
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.This instruction returns the remainder of a division.
+This instruction returns the remainder of a division. +The remainder has the same sign as the dividend.
<result> = frem float 4.0, %var ; yields {float}:result = 4.0 % %var@@ -2165,9 +2317,8 @@ Operations
Bitwise binary operators are used to do various forms of bit-twiddling in a program. They are generally very efficient instructions and can commonly be strength reduced from other -instructions. They require two operands, execute an operation on them, -and produce a single value. The resulting value of the bitwise binary -operators is always the same type as its first operand.
+instructions. They require two operands of the same type, execute an operation on them, +and produce a single value. The resulting value is the same type as its operands. @@ -2177,18 +2328,28 @@ Instruction<result> = shl <ty> <var1>, <var2> ; yields {ty}:result+
The 'shl' instruction returns the first operand shifted to the left a specified number of bits.
+Both arguments to the 'shl' instruction must be the same integer type.
+The value produced is var1 * 2var2.
+ +The value produced is var1 * 2var2 mod 2n, +where n is the width of the result. If var2 is (statically or dynamically) negative or +equal to or larger than the number of bits in var1, the result is undefined.
+<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@@ -2208,9 +2369,11 @@ operand shifted to the right a specified number of bits with zero fill. integer type.
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.@@ -2218,6 +2381,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@@ -2241,7 +2405,9 @@ operand shifted to the right a specified number of bits with sign extension.
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. +@@ -2249,6 +2415,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@@ -2610,7 +2777,8 @@ allocate, and free memory in LLVM.
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).'type' must be a sized type.
Memory is allocated using the system "malloc" function, and -a pointer is returned.
+a pointer is returned. Allocating zero bytes is undefined. The result is null +if there is insufficient memory available.Access to the memory pointed to by the pointer is no longer defined -after this instruction executes.
+after this instruction executes. If the pointer is null, the result is +undefined.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).The 'alloca' instruction allocates sizeof(<type>)*NumElements bytes of memory on the runtime stack, returning a pointer of the -appropriate type to the program. If "NumElements" is specified, it is the -number of elements allocated. If an alignment is specified, the value result -of the allocation is guaranteed to be aligned to at least that boundary. If -not specified, or if zero, the target can choose to align the allocation on any -convenient boundary.
+appropriate type to the program. If "NumElements" is specified, it is the +number of elements allocated, otherwise "NumElements" is defaulted to be one. +If a constant alignment is specified, the value result of the allocation is guaranteed +to be aligned to at least that boundary. If not specified, or if zero, the target +can choose to align the allocation on any convenient boundary.'type' may be any sized type.
@@ -2718,7 +2889,8 @@ memory is automatically released when the function returns. The 'allocaret or unwind -instructions), the memory is reclaimed. +instructions), the memory is reclaimed. Allocating zero bytes +is legal, but the result is undefined.+The optional constant "align" argument specifies the alignment of the operation +(that is, the alignment of the memory address). A value of 0 or an +omitted "align" argument means that the operation has the preferential +alignment for the target. It is the responsibility of the code emitter +to ensure that the alignment information is correct. Overestimating +the alignment results in an undefined behavior. Underestimating the +alignment may produce less efficient code. An alignment of 1 is always +safe. +
The location of memory pointed to is loaded.
There are two arguments to the 'store' instruction: a value to store and an address at which to store it. The type of the '<pointer>' -operand must be a pointer to the type of the '<value>' +operand must be a pointer to the first class type +of the '<value>' operand. If the store is marked as volatile, then the optimizer is not allowed to modify the number or order of execution of this store with other volatile load and store instructions.
++The optional constant "align" argument specifies the alignment of the operation +(that is, the alignment of the memory address). A value of 0 or an +omitted "align" argument means that the operation has the preferential +alignment for the target. It is the responsibility of the code emitter +to ensure that the alignment information is correct. Overestimating +the alignment results in an undefined behavior. Underestimating the +alignment may produce less efficient code. An alignment of 1 is always +safe. +
The contents of memory are updated to contain '<value>' at the location specified by the '<pointer>' operand.
%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@@ -2855,8 +3047,8 @@ entry: on the pointer type that is being indexed into. Pointer and array types can use a 32-bit or 64-bit integer type but the value will always be sign extended -to 64-bits. Structure types require i32 -constants. +to 64-bits. Structure and packed +structure types require i32 constants.
In the example above, the first index is indexing into the '%ST*'
type, which is a pointer, yielding a '%ST' = '{ i32, double, %RT
@@ -3113,8 +3305,10 @@ unsigned integer equivalent of type ty2.
Arguments:
The 'fptoui' 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.
+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 tyThe 'fptoui' instruction converts its @@ -3146,11 +3340,12 @@ the results are undefined.
floating point value to type ty2. -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 tyThe 'fptosi' instruction converts its @@ -3181,18 +3376,18 @@ the results are undefined.
The 'uitofp' instruction regards value as an unsigned integer and converts that value to the ty2 type.
-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
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.
-%X = uitofp i32 257 to float ; yields float:257.0 @@ -3216,9 +3411,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 @@ -3359,7 +3556,7 @@ instructions, which defy better classification.
The 'icmp' instruction returns a boolean value based on comparison -of its two integer operands.
+of its two integer or pointer operands.The 'icmp' instruction takes three operands. The first operand is the condition code indicating the kind of comparison to perform. It is not @@ -3633,17 +3830,23 @@ transfer to a specified function, with its incoming arguments bound to the specified values. Upon a 'ret' instruction in the called function, control flow continues with the instruction after the function call, and the return value of the -function is bound to the result argument. This is a simpler case of -the invoke instruction.
+function is bound to the result argument. If the callee returns multiple +values then the return values of the function are only accessible through +the 'getresult' instruction.%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) + call i32 (i8 *, ...)* @printf(i8 * %msg, i32 12, i8 42) ; yields i32 + %X = tail call i32 @foo() ; yields i32 + %Y = tail call fastcc i32 @foo() ; yields i32 + call void %foo(i8 97 signext) + + %struct.A = type { i32, i8 } + %r = call %struct.A @foo() ; yields { 32, i8 } + %gr = getresult %struct.A %r, 0 ; yields i32 + %gr1 = getresult %struct.A %r, 1 ; yields i8@@ -3696,6 +3899,51 @@ argument. + + + +
+ <resultval> = getresult <type> <retval>, <index> ++ +
The 'getresult' instruction is used to extract individual values +from a 'call' +or 'invoke' instruction that returns multiple +results.
+ +The 'getresult' instruction takes a call or invoke value as its +first argument. The value must have structure type. +The second argument is a constant unsigned index value which must be in range for +the number of values returned by the call.
+ +The 'getresult' instruction extracts the element identified by +'index' from the aggregate value.
+ ++ %struct.A = type { i32, i8 } + + %r = call %struct.A @foo() + %gr = getresult %struct.A %r, 0 ; yields i32:%gr + %gr1 = getresult %struct.A %r, 1 ; yields i8:%gr1 + add i32 %gr, 42 + add i8 %gr1, 41 ++ +
The garbage collection intrinsics only operate on objects in the generic + address space (address space zero).
+ @@ -3937,8 +4189,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. @@ -3973,7 +4226,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. @@ -4008,7 +4263,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. @@ -4388,7 +4645,7 @@ be set to 0 or 1.The 'llvm.memmove.*' intrinsics move a block of memory from the source location to the destination location. It is similar to the -'llvm.memcmp' intrinsic but allows the two memory locations to overlap. +'llvm.memcpy' intrinsic but allows the two memory locations to overlap.
@@ -4484,18 +4741,26 @@ this can be specified as the fourth argument, otherwise it should be set to 0 or
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)
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). +negative numbers other than -0.0 (which allows for better optimization, because +there is no need to worry about errno being set). llvm.sqrt(-0.0) is +defined to return -0.0 like IEEE sqrt.
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)
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.
-LLVM provides intrinsics for a few important bit manipulation operations. -These allow efficient code generation for some algorithms. -
- -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). +
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 i16 @llvm.bswap.i16(i16 <id>) - declare i32 @llvm.bswap.i32(i32 <id>) - declare i64 @llvm.bswap.i64(i64 <id>) + 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)
-The 'llvm.bswap' family of intrinsics is used to byte swap integer -values with an even number of bytes (positive multiple of 16 bits). These are -useful for performing operations on data that is not in the target's native -byte order. +The 'llvm.sin.*' intrinsics return the sine of the operand.
--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, -llvm.bswap.i64 and other intrinsics extend this concept to -additional even-byte lengths (6 bytes, 8 bytes and more, respectively). +The argument and return value are floating point numbers of the same type.
++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.
This is an overloaded intrinsic. You can use llvm.ctpop on any integer bit -width. Not all targets support all bit widths however. +
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 i8 @llvm.ctpop.i8 (i8 <src>) - declare i16 @llvm.ctpop.i16(i16 <src>) - declare i32 @llvm.ctpop.i32(i32 <src>) - declare i64 @llvm.ctpop.i64(i64 <src>) - declare i256 @llvm.ctpop.i256(i256 <src>) + 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)
-The 'llvm.ctpop' family of intrinsics counts the number of bits set in a -value. +The 'llvm.cos.*' intrinsics return the cosine of the operand.
-The only argument is the value to be counted. The argument may be of any -integer type. The return type must match the argument type. +The argument and return value are floating point numbers of the same type.
-The 'llvm.ctpop' intrinsic counts the 1's in a variable. -
+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.This is an overloaded intrinsic. You can use llvm.ctlz on any -integer bit width. Not all targets support all bit widths however. +
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 i8 @llvm.ctlz.i8 (i8 <src>) - declare i16 @llvm.ctlz.i16(i16 <src>) - declare i32 @llvm.ctlz.i32(i32 <src>) - declare i64 @llvm.ctlz.i64(i64 <src>) - declare i256 @llvm.ctlz.i256(i256 <src>) + 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)
-The 'llvm.ctlz' family of intrinsic functions counts the number of -leading zeros in a variable. +The 'llvm.pow.*' intrinsics return the first operand raised to the +specified (positive or negative) power.
-The only argument is the value to be counted. The argument may be of any -integer type. The return type must match the argument type. +The second argument is a floating point power, and the first is a value to +raise to that power.
-The 'llvm.ctlz' intrinsic counts the leading (most significant) zeros -in a variable. If the src == 0 then the result is the size in bits of the type -of src. For example, llvm.ctlz(i32 2) = 30. -
+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.+LLVM provides intrinsics for a few important bit manipulation operations. +These allow efficient code generation for some algorithms. +
+ +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). +
+ declare i16 @llvm.bswap.i16(i16 <id>) + declare i32 @llvm.bswap.i32(i32 <id>) + declare i64 @llvm.bswap.i64(i64 <id>) ++ +
+The 'llvm.bswap' family of intrinsics is used to byte swap integer +values with an even number of bytes (positive multiple of 16 bits). These are +useful for performing operations on data that is not in the target's native +byte order. +
+ ++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, +llvm.bswap.i64 and other intrinsics extend this concept to +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 i8 @llvm.ctpop.i8 (i8 <src>) + declare i16 @llvm.ctpop.i16(i16 <src>) + declare i32 @llvm.ctpop.i32(i32 <src>) + declare i64 @llvm.ctpop.i64(i64 <src>) + declare i256 @llvm.ctpop.i256(i256 <src>) ++ +
+The 'llvm.ctpop' family of intrinsics counts the number of bits set in a +value. +
+ ++The only argument is the value to be counted. The argument may be of any +integer type. The return type must match the argument type. +
+ ++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 i8 @llvm.ctlz.i8 (i8 <src>) + declare i16 @llvm.ctlz.i16(i16 <src>) + declare i32 @llvm.ctlz.i32(i32 <src>) + declare i64 @llvm.ctlz.i64(i64 <src>) + declare i256 @llvm.ctlz.i256(i256 <src>) ++ +
+The 'llvm.ctlz' family of intrinsic functions counts the number of +leading zeros in a variable. +
+ ++The only argument is the value to be counted. The argument may be of any +integer type. The return type must match the argument type. +
+ ++The 'llvm.ctlz' intrinsic counts the leading (most significant) zeros +in a variable. If the src == 0 then the result is the size in bits of the type +of src. For example, llvm.ctlz(i32 2) = 30. +
++ 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 ).
++declare i8* @llvm.init.trampoline(i8* <tramp>, i8* <func>, i8* <nval>) ++
+ This fills the memory pointed to by tramp with code + and returns a function pointer suitable for executing it. +
++ 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*. +
++ 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. +
++declare void @llvm.memory.barrier( i1 <ll>, i1 <ls>, i1 <sl>, i1 <ss>, +i1 <device> ) + ++
+ The llvm.memory.barrier intrinsic guarantees ordering between + specific pairs of memory access types. +
++ The llvm.memory.barrier intrinsic requires five boolean arguments. + The first four arguments enables a specific barrier as listed below. The fith + argument specifies that the barrier applies to io or device or uncached memory. + +
++ This intrinsic causes the system to enforce some ordering constraints upon + the loads and stores of the program. This barrier does not indicate + when any events will occur, it only enforces an order in + which they occur. For any of the specified pairs of load and store operations + (f.ex. load-load, or store-load), all of the first operations preceding the + barrier will complete before any of the second operations succeeding the + barrier begin. Specifically the semantics for each pairing is as follows: +
++ These semantics are applied with a logical "and" behavior when more than one + is enabled in a single memory barrier intrinsic. +
++ Backends may implement stronger barriers than those requested when they do not + support as fine grained a barrier as requested. Some architectures do not + need all types of barriers and on such architectures, these become noops.
++%ptr = malloc i32 + store i32 4, %ptr + +%result1 = load i32* %ptr ; yields {i32}:result1 = 4 + call void @llvm.memory.barrier( i1 false, i1 true, i1 false, i1 false ) + ; guarantee the above finishes + store i32 8, %ptr ; before this begins +
This is an overloaded intrinsic. You can use llvm.atomic.lcs on any integer bit width. Not all targets support all bit widths however.
+-declare i8 @llvm.atomic.lcs.i8.i8p.i8.i8( i8* <ptr>, i8 <cmp>, i8 <val> ) -declare i16 @llvm.atomic.lcs.i16.i16p.i16.i16( i16* <ptr>, i16 <cmp>, i16 <val> ) -declare i32 @llvm.atomic.lcs.i32.i32p.i32.i32( i32* <ptr>, i32 <cmp>, i32 <val> ) -declare i64 @llvm.atomic.lcs.i64.i64p.i64.i64( i64* <ptr>, i64 <cmp>, i64 <val> ) +declare i8 @llvm.atomic.lcs.i8( i8* <ptr>, i8 <cmp>, i8 <val> ) +declare i16 @llvm.atomic.lcs.i16( i16* <ptr>, i16 <cmp>, i16 <val> ) +declare i32 @llvm.atomic.lcs.i32( i32* <ptr>, i32 <cmp>, i32 <val> ) +declare i64 @llvm.atomic.lcs.i64( i64* <ptr>, i64 <cmp>, i64 <val> ) +
@@ -4903,6 +5442,7 @@ declare i64 @llvm.atomic.lcs.i64.i64p.i64.i64( i64* <ptr>, i64 <cmp> same bit width. The ptr argument must be a pointer to a value of this integer type. While any bit width integer may be used, targets may only lower representations they support in hardware. +
@@ -4913,38 +5453,42 @@ declare i64 @llvm.atomic.lcs.i64.i64p.i64.i64( i64* <ptr>, i64 <cmp> atomic compare-and-swap operation within the SSA framework.
%ptr = malloc i32 store i32 4, %ptr %val1 = add i32 4, 4 -%result1 = call i32 @llvm.atomic.lcs( i32* %ptr, i32 4, %val1 ) +%result1 = call i32 @llvm.atomic.lcs.i32( i32* %ptr, i32 4, %val1 ) ; yields {i32}:result1 = 4 %stored1 = icmp eq i32 %result1, 4 ; yields {i1}:stored1 = true %memval1 = load i32* %ptr ; yields {i32}:memval1 = 8 %val2 = add i32 1, 1 -%result2 = call i32 @llvm.atomic.lcs( i32* %ptr, i32 5, %val2 ) +%result2 = call i32 @llvm.atomic.lcs.i32( i32* %ptr, i32 5, %val2 ) ; yields {i32}:result2 = 8 %stored2 = icmp eq i32 %result2, 5 ; yields {i1}:stored2 = false + %memval2 = load i32* %ptr ; yields {i32}:memval2 = 8
- This is an overloaded intrinsic. You can use llvm.atomic.ls on any + This is an overloaded intrinsic. You can use llvm.atomic.swap on any integer bit width. Not all targets support all bit widths however.
-declare i8 @llvm.atomic.ls.i8.i8p.i8( i8* <ptr>, i8 <val> ) -declare i16 @llvm.atomic.ls.i16.i16p.i16( i16* <ptr>, i16 <val> ) -declare i32 @llvm.atomic.ls.i32.i32p.i32( i32* <ptr>, i32 <val> ) -declare i64 @llvm.atomic.ls.i64.i64p.i64( i64* <ptr>, i64 <val> ) +declare i8 @llvm.atomic.swap.i8( i8* <ptr>, i8 <val> ) +declare i16 @llvm.atomic.swap.i16( i16* <ptr>, i16 <val> ) +declare i32 @llvm.atomic.swap.i32( i32* <ptr>, i32 <val> ) +declare i64 @llvm.atomic.swap.i64( i64* <ptr>, i64 <val> ) +
@@ -4953,6 +5497,7 @@ declare i64 @llvm.atomic.ls.i64.i64p.i64( i64* <ptr>, i64 <val> ) at ptr.
The llvm.atomic.ls intrinsic takes two arguments. Both the val argument and the result must be integers of the same bit width. @@ -4965,6 +5510,7 @@ declare i64 @llvm.atomic.ls.i64.i64p.i64( i64* <ptr>, i64 <val> ) This intrinsic loads the value pointed to by ptr, yields it, and stores val back into ptr atomically. This provides the equivalent of an atomic swap operation within the SSA framework. +
@@ -4972,22 +5518,24 @@ declare i64 @llvm.atomic.ls.i64.i64p.i64( i64* <ptr>, i64 <val> ) store i32 4, %ptr %val1 = add i32 4, 4 -%result1 = call i32 @llvm.atomic.ls( i32* %ptr, i32 %val1 ) +%result1 = call i32 @llvm.atomic.swap.i32( i32* %ptr, i32 %val1 ) ; yields {i32}:result1 = 4 %stored1 = icmp eq i32 %result1, 4 ; yields {i1}:stored1 = true %memval1 = load i32* %ptr ; yields {i32}:memval1 = 8 %val2 = add i32 1, 1 -%result2 = call i32 @llvm.atomic.ls( i32* %ptr, i32 %val2 ) +%result2 = call i32 @llvm.atomic.swap.i32( i32* %ptr, i32 %val2 ) ; yields {i32}:result2 = 8 + %stored2 = icmp eq i32 %result2, 8 ; yields {i1}:stored2 = true %memval2 = load i32* %ptr ; yields {i32}:memval2 = 2-
-declare i8 @llvm.atomic.las.i8.i8p.i8( i8* <ptr>, i8 <delta> ) -declare i16 @llvm.atomic.las.i16.i16p.i16( i16* <ptr>, i16 <delta> ) -declare i32 @llvm.atomic.las.i32.i32p.i32( i32* <ptr>, i32 <delta> ) -declare i64 @llvm.atomic.las.i64.i64p.i64( i64* <ptr>, i64 <delta> ) +declare i8 @llvm.atomic.las.i8.( i8* <ptr>, i8 <delta> ) +declare i16 @llvm.atomic.las.i16.( i16* <ptr>, i16 <delta> ) +declare i32 @llvm.atomic.las.i32.( i32* <ptr>, i32 <delta> ) +declare i64 @llvm.atomic.las.i64.( i64* <ptr>, i64 <delta> ) +
@@ -5007,6 +5556,7 @@ declare i64 @llvm.atomic.las.i64.i64p.i64( i64* <ptr>, i64 <delta> )
+ The intrinsic takes two arguments, the first a pointer to an integer value and the second an integer value. The result is also an integer value. These integer types can have any bit width, but they must all have the same bit @@ -5018,201 +5568,21 @@ declare i64 @llvm.atomic.las.i64.i64p.i64( i64* <ptr>, i64 <delta> ) value stored at ptr. It then adds delta, stores the result to ptr. It yields the original value stored at ptr.
+%ptr = malloc i32 store i32 4, %ptr -%result1 = call i32 @llvm.atomic.las( i32* %ptr, i32 4 ) +%result1 = call i32 @llvm.atomic.las.i32( i32* %ptr, i32 4 ) ; yields {i32}:result1 = 4 -%result2 = call i32 @llvm.atomic.las( i32* %ptr, i32 2 ) +%result2 = call i32 @llvm.atomic.las.i32( i32* %ptr, i32 2 ) ; yields {i32}:result2 = 8 -%result3 = call i32 @llvm.atomic.las( i32* %ptr, i32 5 ) +%result3 = call i32 @llvm.atomic.las.i32( i32* %ptr, i32 5 ) ; yields {i32}:result3 = 10 %memval = load i32* %ptr ; yields {i32}:memval1 = 15
- This is an overloaded intrinsic. You can use llvm.atomic.lss on any - integer bit width. Not all targets support all bit widths however.
--declare i8 @llvm.atomic.lss.i8.i8.i8( i8* <ptr>, i8 <delta> ) -declare i16 @llvm.atomic.lss.i16.i16.i16( i16* <ptr>, i16 <delta> ) -declare i32 @llvm.atomic.lss.i32.i32.i32( i32* <ptr>, i32 <delta> ) -declare i64 @llvm.atomic.lss.i64.i64.i64( i64* <ptr>, i64 <delta> ) --
- This intrinsic subtracts delta from the value stored in memory at - ptr. It yields the original value at ptr. -
-- The intrinsic takes two arguments, the first a pointer to an integer value - and the second an integer value. The result is also an integer value. These - integer types can have any bit width, but they must all have the same bit - width. The targets may only lower integer representations they support. -
-- This intrinsic does a series of operations atomically. It first loads the - value stored at ptr. It then subtracts delta, - stores the result to ptr. It yields the original value stored - at ptr. -
--%ptr = malloc i32 - store i32 32, %ptr -%result1 = call i32 @llvm.atomic.lss( i32* %ptr, i32 4 ) - ; yields {i32}:result1 = 32 -%result2 = call i32 @llvm.atomic.lss( i32* %ptr, i32 2 ) - ; yields {i32}:result2 = 28 -%result3 = call i32 @llvm.atomic.lss( i32* %ptr, i32 5 ) - ; yields {i32}:result3 = 26 -%memval = load i32* %ptr ; yields {i32}:memval1 = 21 --
-declare void @llvm.memory.barrier( i1 <ll>, i1 <ls>, i1 <sl>, i1 <ss> ) --
- The llvm.memory.barrier intrinsic guarantees ordering between - specific pairs of memory access types. -
-- The llvm.memory.barrier intrinsic requires four boolean arguments. - Each argument enables a specific barrier as listed below. -
-- This intrinsic causes the system to enforce some ordering constraints upon - the loads and stores of the program. This barrier does not indicate - when any events will occur, it only enforces an order in - which they occur. For any of the specified pairs of load and store operations - (f.ex. load-load, or store-load), all of the first operations preceding the - barrier will complete before any of the second operations succeeding the - barrier begin. Specifically the semantics for each pairing is as follows: -
-- These semantics are applied with a logical "and" behavior when more than one - is enabled in a single memory barrier intrinsic. -
--%ptr = malloc i32 - store i32 4, %ptr - -%result1 = load i32* %ptr ; yields {i32}:result1 = 4 - call void @llvm.memory.barrier( i1 false, i1 true, i1 false, i1 false ) - ; guarantee the above finishes - store i32 8, %ptr ; before this begins --
- 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 ). - -
-declare i8* @llvm.init.trampoline(i8* <tramp>, i8* <func>, i8* <nval>) --
- This fills the memory pointed to by tramp with code - and returns a function pointer suitable for executing it. -
-- 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*. -
-- 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 intrinsic allows annotation of local variables with arbitrary strings. +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. +annotations. These have no other defined use, they are ignored by code +generation and optimization. +
+ declare void @llvm.trap() ++ +
+The 'llvm.trap' intrinsic +
+ ++None +
+ ++This intrinsics is lowered to the target dependent trap instruction. If the +target does not have a trap instruction, this intrinsic will be lowered to the +call of the abort() function. +
+