aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJakub Staszak <jstaszak@apple.com>2011-12-04 18:29:26 +0000
committerJakub Staszak <jstaszak@apple.com>2011-12-04 18:29:26 +0000
commitb170e2de8339e239084420293f7657b85c74af74 (patch)
treea4276015551af7dacc4344bb98c766a6658ef415 /docs
parent309bedd7bc37554cdb41c76737284150dc842a4a (diff)
downloadexternal_llvm-b170e2de8339e239084420293f7657b85c74af74.zip
external_llvm-b170e2de8339e239084420293f7657b85c74af74.tar.gz
external_llvm-b170e2de8339e239084420293f7657b85c74af74.tar.bz2
Add 'llvm.expect' intrinsic description.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@145792 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
-rw-r--r--docs/LangRef.html26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/LangRef.html b/docs/LangRef.html
index ed4e4d5..d9e02bd 100644
--- a/docs/LangRef.html
+++ b/docs/LangRef.html
@@ -306,6 +306,8 @@
'<tt>llvm.stackprotector</tt>' Intrinsic</a></li>
<li><a href="#int_objectsize">
'<tt>llvm.objectsize</tt>' Intrinsic</a></li>
+ <li><a href="#int_expect">
+ '<tt>llvm.expect</tt>' Intrinsic</a></li>
</ol>
</li>
</ol>
@@ -8205,11 +8207,35 @@ LLVM</a>.</p>
compile time.</p>
</div>
+<!-- _______________________________________________________________________ -->
+<h4>
+ <a name="int_expect">'<tt>llvm.expect</tt>' Intrinsic</a>
+</h4>
+
+<div>
+<h5>Syntax:</h5>
+<pre>
+ declare i32 @llvm.expect.i32(i32 &lt;val&gt;, i32 &lt;expected_val&gt;)
+ declare i64 @llvm.expect.i64(i64 &lt;val&gt;, i64 &lt;expected_val&gt;)
+</pre>
+
+<h5>Overview:</h5>
+<p>The <tt>llvm.expect</tt> intrinsic provides information about expected (the
+ most probable) value of <tt>val</tt>, which can be used by optimizers.</p>
+
+<h5>Arguments:</h5>
+<p>The <tt>llvm.expect</tt> intrinsic takes two arguments. The first
+ argument is a value. The second argument is an expected value, this needs to
+ be a constant value, variables are not allowed.</p>
+
+<h5>Semantics:</h5>
+<p>This intrinsic is lowered to the <tt>val</tt>.</p>
</div>
</div>
+</div>
<!-- *********************************************************************** -->
<hr>
<address>