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 first class types are perhaps the most important. Values of these types are the only ones which can be produced by instructions, passed as arguments, or used as operands to -instructions. This means that all structures and arrays must be -manipulated either by pointer or by component.
+instructions. @@ -1215,22 +1242,29 @@ type "{ i32, [0 x float]}", for example.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 -(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. -
+consists of a return type and a list of formal parameter types. The +return type of a function type is a scalar type, 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, and the struct must have at least one element. +<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 } + |
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 value) from a function back to the caller.
There are two forms of the 'ret' instruction: one that -returns a value and then causes control flow, and one that just causes +returns value(s) 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 zero, 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 "call" instruction, execution continues at @@ -1804,10 +1859,16 @@ the instruction after the call. If the caller was an "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 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@@ -1904,7 +1965,7 @@ branches or with a lookup table.Syntax:
- <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>@@ -1917,7 +1978,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.Arguments:
@@ -1965,9 +2028,9 @@ exception. Additionally, this is important for implementation ofExample:
- %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@@ -1994,7 +2057,7 @@ primarily used to implement exception handling.Semantics:
-The 'unwind' intrinsic causes execution of the current function to +
The 'unwind' instruction causes execution of the current function to immediately halt. The dynamic call stack is then searched for the first invoke instruction on the call stack. Once found, execution continues at the "exceptional" destination block specified by the @@ -2032,90 +2095,128 @@ 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:
+- + +Syntax:
-<result> = add <ty> <var1>, <var2> ; yields {ty}:result + ++ <result> = add <ty> <var1>, <var2> ; yields {ty}:result+Overview:
+The 'add' instruction returns the sum of its two operands.
+Arguments:
-The two arguments to the 'add' instruction must be either integer or floating point values. - This instruction can also take vector versions of the values. -Both arguments must have identical types.
+ +The two arguments to the 'add' instruction must be integer, floating point, or + vector values. Both arguments must have identical + types.
+Semantics:
+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.
+Example:
-<result> = add i32 4, %var ; yields {i32}:result = 4 + %var + ++ <result> = add i32 4, %var ; yields {i32}:result = 4 + %var++ - + +Syntax:
-<result> = sub <ty> <var1>, <var2> ; yields {ty}:result + ++ <result> = sub <ty> <var1>, <var2> ; yields {ty}:result+Overview:
+The 'sub' instruction returns the difference of its two operands.
-Note that the 'sub' instruction is used to represent the 'neg' -instruction present in most other intermediate representations.
+ +Note that the 'sub' instruction is used to represent the +'neg' instruction present in most other intermediate +representations.
+Arguments:
-The two arguments to the 'sub' instruction must be either integer or floating point -values. -This instruction can also take vector versions of the values. -Both arguments must have identical types.
+ +The two arguments to the 'sub' instruction must be integer, floating point, + or vector values. Both arguments must have identical + types.
+Semantics:
+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.
+Example:
<result> = sub i32 4, %var ; yields {i32}:result = 4 - %var <result> = sub i32 0, %val ; yields {i32}:result = -%var++ @@ -2139,12 +2241,15 @@ width of the full product.Syntax:
<result> = mul <ty> <var1>, <var2> ; yields {ty}:resultOverview:
The 'mul' instruction returns the product of its two operands.
+Arguments:
-The two arguments to the 'mul' instruction must be either integer or floating point -values. -This instruction can also take vector versions of the values. -Both arguments must have identical types.
+ +The two arguments to the 'mul' instruction must be integer, floating point, +or vector values. Both arguments must have identical +types.
+Semantics:
+The value produced is the integer or floating point product of the two operands.
+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.
@@ -2129,6 +2230,7 @@ width of the full product.<result> = mul i32 4, %var ; yields {i32}:result = 4 * %varOverview:
The 'udiv' instruction returns the quotient of its two operands.
+Arguments:
+The two arguments to the 'udiv' instruction must be -integer values. Both arguments must have identical -types. This instruction can also take vector versions -of the values in which case the elements must be integers.
+integer or vector of integer +values. Both arguments must have identical types. +Semantics:
+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'.
@@ -2158,18 +2263,23 @@ operations; for signed integer division, use 'sdiv'.Syntax:
-<result> = sdiv <ty> <var1>, <var2> ; yields {ty}:result ++ <result> = sdiv <ty> <var1>, <var2> ; yields {ty}:result+Overview:
+The 'sdiv' instruction returns the quotient of its two operands.
+Arguments:
-The two arguments to the 'sdiv' instruction must be -integer values. Both arguments must have identical -types. This instruction can also take vector versions -of the values in which case the elements must be integers.
+ +The two arguments to the 'sdiv' instruction must be +integer or vector of integer +values. Both arguments must have identical types.
+Semantics:
-The value produced is the signed integer quotient of the two operands.
+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 @@ -2184,22 +2294,31 @@ by doing a 32-bit division of -2147483648 by -1.
Instruction+ @@ -2211,14 +2330,12 @@ versions of floating point values.Syntax:
-<result> = fdiv <ty> <var1>, <var2> ; yields {ty}:result ++ <result> = fdiv <ty> <var1>, <var2> ; yields {ty}:resultOverview:
+The 'fdiv' instruction returns the quotient of its two operands.
+Arguments:
+The two arguments to the 'fdiv' instruction must be -floating point values. Both arguments must have -identical types. This instruction can also take vector -versions of floating point values.
+floating point or vector +of floating point values. Both arguments must have identical types. +Semantics:
+The value produced is the floating point quotient of the two operands.
+Example:
-<result> = fdiv float 4.0, %var ; yields {float}:result = 4.0 / %var + ++ <result> = fdiv float 4.0, %var ; yields {float}:result = 4.0 / %varThe 'urem' instruction returns the remainder from the unsigned division of its two arguments.
Arguments:
-The two arguments to the 'urem' instruction must be -integer values. Both arguments must have identical -types. This instruction can also take vector versions -of the values in which case the elements must be integers.
+The two arguments to the 'urem' instruction must be +integer or vector of integer +values. Both arguments must have identical types.
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.
@@ -2228,23 +2345,33 @@ distinct operations; for signed integer remainder, use 'srem'. - + ++- + +Syntax:
-<result> = srem <ty> <var1>, <var2> ; yields {ty}:result + ++ <result> = srem <ty> <var1>, <var2> ; yields {ty}:result+Overview:
+The 'srem' instruction returns the remainder from the 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 -types.
+integer or vector of integer +values. Both arguments must have identical types. +Semantics:
+This instruction returns the remainder of a division (where the result has the same sign as the dividend, var1), not the modulo operator (where the result has the same sign as the divisor, var2) of @@ -2267,9 +2394,11 @@ and the remainder.)
+division of its two operands.Syntax:
<result> = frem <ty> <var1>, <var2> ; yields {ty}:result@@ -2278,13 +2407,18 @@ InstructionArguments:
The two arguments to the 'frem' instruction must be -floating point values. Both arguments must have -identical types. This instruction can also take vector -versions of floating point values.
+floating point or vector +of floating point values. Both arguments must have identical types. +Semantics:
-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.
+Example:
-<result> = frem float 4.0, %var ; yields {float}:result = 4.0 % %var + ++ + ++ <result> = frem float 4.0, %var ; yields {float}:result = 4.0 % %var@@ -2295,9 +2429,8 @@ OperationsBitwise 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. @@ -2316,13 +2449,15 @@ the left a specified number of bits.Arguments:
Both arguments to the 'shl' instruction must be the same integer type.
+ href="#t_integer">integer type. 'var2' is treated as an +unsigned value. This instruction does not support +vector operands.Semantics:
-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.
+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.
Example:
<result> = shl i32 4, %var ; yields {i32}: 4 << %var @@ -2345,7 +2480,9 @@ operand shifted to the right a specified number of bits with zero fill.Arguments:
Both arguments to the 'lshr' instruction must be the same -integer type.
+integer type. 'var2' is treated as an +unsigned value. This instruction does not support +vector operands.Semantics:
@@ -2379,7 +2516,9 @@ operand shifted to the right a specified number of bits with sign extension.Arguments:
Both arguments to the 'ashr' instruction must be the same -integer type.
+integer type. 'var2' is treated as an +unsigned value. This instruction does not support +vector operands.Semantics:
This instruction always performs an arithmetic shift right operation, @@ -2401,17 +2540,26 @@ larger than the number of bits in var1, the result is undefined.
++Syntax:
-<result> = and <ty> <var1>, <var2> ; yields {ty}:result + ++ <result> = and <ty> <var1>, <var2> ; yields {ty}:result+Overview:
+The 'and' instruction returns the bitwise logical and of its two operands.
+Arguments:
-The two arguments to the 'and' instruction must be integer values. Both arguments must have -identical types.
+ +The two arguments to the 'and' instruction must be +integer or vector of integer +values. Both arguments must have identical types.
+Semantics:
The truth table used for the 'and' instruction is:
@@ -2447,7 +2595,8 @@ identical types.
Example:
-<result> = and i32 4, %var ; yields {i32}:result = 4 & %var ++ <result> = and i32 4, %var ; yields {i32}:result = 4 & %var <result> = and i32 15, 40 ; yields {i32}:result = 8 <result> = and i32 4, 8 ; yields {i32}:result = 0@@ -2462,9 +2611,10 @@ identical types.The 'or' instruction returns the bitwise logical inclusive or of its two operands.
Arguments:
-The two arguments to the 'or' instruction must be integer values. Both arguments must have -identical types.
+ +The two arguments to the 'or' instruction must be +integer or vector of integer +values. Both arguments must have identical types.
Semantics:
The truth table used for the 'or' instruction is:
@@ -2517,10 +2667,12 @@ Instruction or of its two operands. The xor is used to implement the "one's complement" operation, which is the "~" operator in C.
Arguments:
-The two arguments to the 'xor' instruction must be integer values. Both arguments must have -identical types.
+The two arguments to the 'xor' instruction must be +integer or vector of integer +values. Both arguments must have identical types.
+Semantics:
+The truth table used for the 'xor' instruction is:
@@ -2635,7 +2787,7 @@ results are undefined.+ + + +Syntax:
- <result> = insertelement <n x <ty>> <val>, <ty> <elt>, i32 <idx> ; yields <n x <ty>> + <result> = insertelement <n x <ty>> <val>, <ty> <elt>, i32 <idx> ; yields <n x <ty>>Overview:
@@ -2726,6 +2878,114 @@ operand may be undef if performing a shuffle from only one vector.+ ++ + + + +LLVM supports several instructions for working with aggregate values. +
+ ++ ++ + + + + +Syntax:
+ ++ <result> = extractvalue <aggregate type> <val>, <idx>{, <idx>}* ++ +Overview:
+ ++The 'extractvalue' instruction extracts the value of a struct field +or array element from an aggregate value. +
+ + +Arguments:
+ ++The first operand of an 'extractvalue' instruction is a +value of struct or array +type. The operands are constant indices to specify which value to extract +in a similar manner as indices in a +'getelementptr' instruction. +
+ +Semantics:
+ ++The result is the value at the position in the aggregate specified by +the index operands. +
+ +Example:
+ ++ %result = extractvalue {i32, float} %agg, 0 ; yields i32 +++ ++ +Syntax:
+ ++ <result> = insertvalue <aggregate type> <val>, <ty> <val>, <idx> ; yields <n x <ty>> ++ +Overview:
+ ++The 'insertvalue' instruction inserts a value +into a struct field or array element in an aggregate. +
+ + +Arguments:
+ ++The first operand of an 'insertvalue' instruction is a +value of struct or array type. +The second operand is a first-class value to insert. +The following operands are constant indices +indicating the position at which to insert the value in a similar manner as +indices in a +'getelementptr' instruction. +The value to insert must have the same type as the value identified +by the indices. + +
Semantics:
+ ++The result is an aggregate of the same type as val. Its +value is that of val except that the value at the position +specified by the indices is that of elt. +
+ +Example:
+ ++ %result = insertvalue {i32, float} %agg, i32 1, 0 ; yields {i32, float} ++Memory Access and Addressing Operations @@ -2766,7 +3026,7 @@ address space (address space zero). bytes of memory from the operating system and returns a pointer of the appropriate type to the program. If "NumElements" is specified, it is the number of elements allocated, otherwise "NumElements" is defaulted to be one. -If an alignment is specified, the value result of the allocation is guaranteed to +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. @@ -2775,7 +3035,8 @@ choose to align the allocation on any convenient boundary.Semantics:
Memory is allocated using the system "malloc" function, and -a pointer is returned.
+a pointer is returned. The result of a zero byte allocattion is undefined. The +result is null if there is insufficient memory available.Example:
@@ -2817,7 +3078,8 @@ instruction.Semantics:
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 operation +is a noop.Example:
@@ -2853,7 +3115,7 @@ space (address space zero). 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, otherwise "NumElements" is defaulted to be one. -If an alignment is specified, the value result of the allocation is guaranteed +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. @@ -2861,12 +3123,14 @@ can choose to align the allocation on any convenient boundary.Semantics:
-Memory is allocated; a pointer is returned. 'alloca'd +
Memory is allocated; a pointer is returned. The operation is undefiend if +there is insufficient stack space for the allocation. 'alloca'd memory is automatically released when the function returns. The 'alloca' instruction is commonly used to represent automatic variables that must have an address available. When the function returns (either with the ret or unwind -instructions), the memory is reclaimed.
+instructions), the memory is reclaimed. Allocating zero bytes +is legal, but the result is undefined.Example:
@@ -2895,7 +3159,7 @@ the number or order of execution of this load with other volatile load and store instructions.-The optional "align" argument specifies the alignment of the operation +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 @@ -2926,13 +3190,14 @@ Instruction
Arguments:
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 "align" argument specifies the alignment of the operation +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 @@ -2976,8 +3241,8 @@ provided depend on the type of the first pointer argument. The 'getelementptr' instruction is used to index down through the type levels of a structure or to a specific index in an array. When indexing into a structure, only i32 integer constants are allowed. When indexing -into an array or pointer, only integers of 32 or 64 bits are allowed, and will -be sign extended to 64-bit values.
+into an array or pointer, only integers of 32 or 64 bits are allowed; 32-bit +values will be sign extended to 64-bits if required.For example, let's consider a C code fragment and how it gets compiled to LLVM:
@@ -3022,8 +3287,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 @@ -3052,7 +3317,7 @@ the LLVM code for the given testcase is equivalent to:
Note that it is undefined to access an array out of bounds: array and pointer indexes must always be within the defined bounds of the array type. -The one exception for this rules is zero length arrays. These arrays are +The one exception for this rule is zero length arrays. These arrays are defined to be accessible as variable length arrays, which requires access beyond the zero'th element.
@@ -3488,15 +3753,19 @@ nothing is done (no-op cast).Overview:
+The 'bitcast' instruction converts value to type ty2 without changing any bits.
Arguments:
+The 'bitcast' instruction takes a value to cast, which must be a first class value, and a type to cast it to, which must also be a first class type. The bit sizes of value and the destination type, ty2, must be identical. If the source -type is a pointer, the destination type must also be a pointer.
+type is a pointer, the destination type must also be a pointer. This +instruction supports bitwise conversion of vectors to integers and to vectors +of other types (as long as they have the same size).Semantics:
The 'bitcast' instruction converts value to type @@ -3531,7 +3800,7 @@ instructions, which defy better classification.
Overview:
The 'icmp' instruction returns a boolean value based on comparison -of its two integer operands.
+of its two integer or pointer operands.Arguments:
The 'icmp' instruction takes three operands. The first operand is the condition code indicating the kind of comparison to perform. It is not @@ -3628,9 +3897,9 @@ a value, just a keyword. The possible condition code are: floating point typed. They must have identical types.
Semantics:
-The 'fcmp' compares var1 and var2 according to -the condition code given as cond. The comparison performed always -yields a i1 result, as follows: +
The 'fcmp' instruction compares var1 and var2 +according to the condition code given as cond. The comparison performed +always yields a i1 result, as follows:
- false: always yields false, regardless of operands.
- oeq: yields true if both operands are not a QNAN and @@ -3671,30 +3940,144 @@ yields a i1 result, as follows: - + +
++ + +Syntax:
+<result> = vicmp <cond> <ty> <var1>, <var2> ; yields {ty}:result ++Overview:
+The 'vicmp' instruction returns an integer vector value based on +element-wise comparison of its two integer vector operands.
+Arguments:
+The 'vicmp' instruction takes three operands. The first operand is +the condition code indicating the kind of comparison to perform. It is not +a value, just a keyword. The possible condition code are: +
+
+- eq: equal
+- ne: not equal
+- ugt: unsigned greater than
+- uge: unsigned greater or equal
+- ult: unsigned less than
+- ule: unsigned less or equal
+- sgt: signed greater than
+- sge: signed greater or equal
+- slt: signed less than
+- sle: signed less or equal
+The remaining two arguments must be vector of +integer typed. They must also be identical types.
+Semantics:
+The 'vicmp' instruction compares var1 and var2 +according to the condition code given as cond. The comparison yields a +vector of integer result, of +identical type as the values being compared. The most significant bit in each +element is 1 if the element-wise comparison evaluates to true, and is 0 +otherwise. All other bits of the result are undefined. The condition codes +are evaluated identically to the 'icmp' +instruction. + +
Example:
++ <result> = vicmp eq <2 x i32> < i32 4, i32 0>, < i32 5, i32 0> ; yields: result=<2 x i32> < i32 0, i32 -1 > + <result> = vicmp ult <2 x i8 > < i8 1, i8 2>, < i8 2, i8 2 > ; yields: result=<2 x i8> < i8 -1, i8 0 > +++ + + + +Syntax:
+<result> = vfcmp <cond> <ty> <var1>, <var2>+Overview:
+The 'vfcmp' instruction returns an integer vector value based on +element-wise comparison of its two floating point vector operands. The output +elements have the same width as the input elements.
+Arguments:
+The 'vfcmp' instruction takes three operands. The first operand is +the condition code indicating the kind of comparison to perform. It is not +a value, just a keyword. The possible condition code are: +
+
+- false: no comparison, always returns false
+- oeq: ordered and equal
+- ogt: ordered and greater than
+- oge: ordered and greater than or equal
+- olt: ordered and less than
+- ole: ordered and less than or equal
+- one: ordered and not equal
+- ord: ordered (no nans)
+- ueq: unordered or equal
+- ugt: unordered or greater than
+- uge: unordered or greater than or equal
+- ult: unordered or less than
+- ule: unordered or less than or equal
+- une: unordered or not equal
+- uno: unordered (either nans)
+- true: no comparison, always returns true
+The remaining two arguments must be vector of +floating point typed. They must also be identical +types.
+Semantics:
+The 'vfcmp' instruction compares var1 and var2 +according to the condition code given as cond. The comparison yields a +vector of integer result, with +an identical number of elements as the values being compared, and each element +having identical with to the width of the floating point elements. The most +significant bit in each element is 1 if the element-wise comparison evaluates to +true, and is 0 otherwise. All other bits of the result are undefined. The +condition codes are evaluated identically to the +'fcmp' instruction. + +
Example:
++ <result> = vfcmp oeq <2 x float> < float 4, float 0 >, < float 5, float 0 > ; yields: result=<2 x i32> < i32 0, i32 -1 > + <result> = vfcmp ult <2 x double> < double 1, double 2 >, < double 2, double 2> ; yields: result=<2 x i64> < i64 -1, i64 0 > +++ +@@ -3721,13 +4104,16 @@ condition, without branching.Syntax:
+<result> = phi <ty> [ <val0>, <label0>], ...Overview:
The 'phi' instruction is used to implement the φ node in the SSA graph representing the function.
Arguments:
+The type of the incoming values is specified with the first type field. After this, the 'phi' instruction takes a list of pairs as arguments, with one pair for each predecessor basic block of the current block. Only values of first class type may be used as the value arguments to the PHI node. Only labels may be used as the label arguments.
+There must be no non-phi instructions between the start of a basic block and the PHI instructions: i.e. PHI instructions must be first in a basic block.
+Semantics:
+At runtime, the 'phi' instruction logically takes on the value specified by the pair corresponding to the predecessor basic block that executed just prior to the current block.
+Example:
-Loop: ; Infinite loop that counts from 0 on up...+
%indvar = phi i32 [ 0, %LoopHeader ], [ %nextindvar, %Loop ]
%nextindvar = add i32 %indvar, 1
br label %Loop+Loop: ; Infinite loop that counts from 0 on up... + %indvar = phi i32 [ 0, %LoopHeader ], [ %nextindvar, %Loop ] + %nextindvar = add i32 %indvar, 1 + br label %Loop +Arguments:
-The 'select' instruction requires a boolean value indicating the condition, and two values of the same first class type. +The 'select' instruction requires an 'i1' value indicating the +condition, and two values of the same first class +type. If the val1/val2 are vectors, the entire vectors are selected, not +individual elements.
Semantics:
-If the boolean condition evaluates to true, the instruction returns the first +If the i1 condition evaluates is 1, the instruction returns the first value argument; otherwise, it returns the second value argument.
@@ -3805,17 +4191,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.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() - %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@@ -3868,6 +4260,52 @@ argument. + + + ++ ++ @@ -4111,7 +4549,7 @@ value address) contains the meta-data to be associated with the root.Syntax:
++ <resultval> = getresult <type> <retval>, <index> ++ +Overview:
+ +The 'getresult' instruction is used to extract individual values +from a 'call' +or 'invoke' instruction that returns multiple +results.
+ +Arguments:
+ +The 'getresult' instruction takes a call or invoke value as its +first argument, or an undef value. 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.
+ +Semantics:
+ +The 'getresult' instruction extracts the element identified by +'index' from the aggregate value.
+ +Example:
+ ++ %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 ++ +Semantics:
-At runtime, a call to this intrinsics stores a null pointer into the "ptrloc" +
At runtime, a call to this intrinsic 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 'llvm.gcroot' intrinsic may only be used in a function which specifies a GC @@ -5337,6 +5775,176 @@ i1 <device> )
++ + + +Syntax:
++ 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( 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> ) + ++Overview:
++ This loads a value in memory and compares it to a given value. If they are + equal, it stores a new value into the memory. +
+Arguments:
++ The llvm.atomic.lcs intrinsic takes three arguments. The result as + well as both cmp and val must be integer values with the + 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. + +
+Semantics:
++ This entire intrinsic must be executed atomically. It first loads the value + in memory pointed to by ptr and compares it with the value + cmp. If they are equal, val is stored into the memory. The + loaded value is yielded in all cases. This provides the equivalent of an + atomic compare-and-swap operation within the SSA framework. +
+Examples:
+ ++%ptr = malloc i32 + store i32 4, %ptr + +%val1 = add i32 4, 4 +%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( 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 ++++ + + +Syntax:
+ ++ 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.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> ) + ++Overview:
++ This intrinsic loads the value stored in memory at ptr and yields + the value from memory. It then stores the value in val in the memory + at ptr. +
+Arguments:
+ ++ The llvm.atomic.ls intrinsic takes two arguments. Both the + val argument and the result must be integers of the same bit width. + The first argument, ptr, must be a pointer to a value of this + integer type. The targets may only lower integer representations they + support. +
+Semantics:
++ 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. + +
+Examples:
++%ptr = malloc i32 + store i32 4, %ptr + +%val1 = add i32 4, 4 +%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.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 ++++Syntax:
++ This is an overloaded intrinsic. You can use llvm.atomic.las on any + integer bit width. Not all targets support all bit widths however.
++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> ) + ++Overview:
++ This intrinsic adds delta to the value stored in memory at + ptr. It yields the original value at ptr. +
+Arguments:
++ + 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. +
+Semantics:
++ This intrinsic does a series of operations atomically. It first loads the + value stored at ptr. It then adds delta, stores the result + to ptr. It yields the original value stored at ptr. +
+ +Examples:
++%ptr = malloc i32 + store i32 4, %ptr +%result1 = call i32 @llvm.atomic.las.i32( i32* %ptr, i32 4 ) + ; yields {i32}:result1 = 4 +%result2 = call i32 @llvm.atomic.las.i32( i32* %ptr, i32 2 ) + ; yields {i32}:result2 = 8 +%result3 = call i32 @llvm.atomic.las.i32( i32* %ptr, i32 5 ) + ; yields {i32}:result3 = 10 +%memval = load i32* %ptr ; yields {i32}:memval1 = 15 ++