summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDan Gohman <gohman@apple.com>2009-07-20 22:41:19 +0000
committerDan Gohman <gohman@apple.com>2009-07-20 22:41:19 +0000
commitcbb38f2f67a3c775b546230ea244e6b003749bde (patch)
tree069d29497378597f5924742b3faf595f83a2f969 /docs
parent746f3b1a9ba22d9b9622240814899417941d2480 (diff)
downloadllvm-cbb38f2f67a3c775b546230ea244e6b003749bde.tar.gz
llvm-cbb38f2f67a3c775b546230ea244e6b003749bde.tar.bz2
llvm-cbb38f2f67a3c775b546230ea244e6b003749bde.tar.xz
Documentation for the new non-overflow and exact keywords.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@76495 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
-rw-r--r--docs/LangRef.html37
1 files changed, 26 insertions, 11 deletions
diff --git a/docs/LangRef.html b/docs/LangRef.html
index dced11c441..334cb68772 100644
--- a/docs/LangRef.html
+++ b/docs/LangRef.html
@@ -2600,7 +2600,9 @@ Instruction</a> </div>
<h5>Syntax:</h5>
<pre>
- &lt;result&gt; = add &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt; <i>; yields {ty}:result</i>
+ &lt;result&gt; = add &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt; <i>; yields {ty}:result</i>
+ &lt;result&gt; = signed add &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt; <i>; yields {ty}:result</i>
+ &lt;result&gt; = unsigned add &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt; <i>; yields {ty}:result</i>
</pre>
<h5>Overview:</h5>
@@ -2620,6 +2622,10 @@ Instruction</a> </div>
<p>Because LLVM integers use a two's complement representation, this instruction
is appropriate for both signed and unsigned integers.</p>
+<p>If the <tt>signed</tt> and/or <tt>unsigned</tt> keywords are present,
+ the behavior of the <tt>add</tt> is undefined if signed and/or unsigned
+ overflow, respectively, occurs.</p>
+
<h5>Example:</h5>
<pre>
&lt;result&gt; = add i32 4, %var <i>; yields {i32}:result = 4 + %var</i>
@@ -2666,7 +2672,9 @@ Instruction</a> </div>
<h5>Syntax:</h5>
<pre>
- &lt;result&gt; = sub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt; <i>; yields {ty}:result</i>
+ &lt;result&gt; = sub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt; <i>; yields {ty}:result</i>
+ &lt;result&gt; = signed sub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt; <i>; yields {ty}:result</i>
+ &lt;result&gt; = unsigned sub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt; <i>; yields {ty}:result</i>
</pre>
<h5>Overview:</h5>
@@ -2692,6 +2700,10 @@ Instruction</a> </div>
<p>Because LLVM integers use a two's complement representation, this instruction
is appropriate for both signed and unsigned integers.</p>
+<p>If the <tt>signed</tt> and/or <tt>unsigned</tt> keywords are present,
+ the behavior of the <tt>sub</tt> is undefined if signed and/or unsigned
+ overflow, respectively, occurs.</p>
+
<h5>Example:</h5>
<pre>
&lt;result&gt; = sub i32 4, %var <i>; yields {i32}:result = 4 - %var</i>
@@ -2745,7 +2757,9 @@ Instruction</a> </div>
<h5>Syntax:</h5>
<pre>
- &lt;result&gt; = mul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt; <i>; yields {ty}:result</i>
+ &lt;result&gt; = mul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt; <i>; yields {ty}:result</i>
+ &lt;result&gt; = signed mul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt; <i>; yields {ty}:result</i>
+ &lt;result&gt; = unsigned mul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt; <i>; yields {ty}:result</i>
</pre>
<h5>Overview:</h5>
@@ -2770,6 +2784,10 @@ Instruction</a> </div>
be sign-extended or zero-extended as appropriate to the width of the full
product.</p>
+<p>If the <tt>signed</tt> and/or <tt>unsigned</tt> keywords are present,
+ the behavior of the <tt>mul</tt> is undefined if signed and/or unsigned
+ overflow, respectively, occurs.</p>
+
<h5>Example:</h5>
<pre>
&lt;result&gt; = mul i32 4, %var <i>; yields {i32}:result = 4 * %var</i>
@@ -2849,7 +2867,8 @@ Instruction</a> </div>
<h5>Syntax:</h5>
<pre>
- &lt;result&gt; = sdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt; <i>; yields {ty}:result</i>
+ &lt;result&gt; = sdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt; <i>; yields {ty}:result</i>
+ &lt;result&gt; = exact sdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt; <i>; yields {ty}:result</i>
</pre>
<h5>Overview:</h5>
@@ -2871,6 +2890,9 @@ Instruction</a> </div>
undefined behavior; this is a rare case, but can occur, for example, by doing
a 32-bit division of -2147483648 by -1.</p>
+<p>If the <tt>exact</tt> keyword is present, the result of the <tt>sdiv</tt>
+ is undefined if the result would be rounded or if overflow occurs.</p>
+
<h5>Example:</h5>
<pre>
&lt;result&gt; = sdiv i32 4, %var <i>; yields {i32}:result = 4 / %var</i>
@@ -3912,13 +3934,6 @@ entry:
}
</pre>
-<p>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 when
- accessed with an instruction that dereferences the pointer (e.g. a load or
- store instruction). 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.</p>
-
<p>The getelementptr instruction is often confusing. For some more insight into
how it works, see <a href="GetElementPtr.html">the getelementptr FAQ</a>.</p>