Skip to content

Commit

Permalink
Add 'llvm.expect' intrinsic description.
Browse files Browse the repository at this point in the history
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@145792 91177308-0d34-0410-b5e6-96231b3b80d8
  • Loading branch information
Jakub Staszak committed Dec 4, 2011
1 parent 309bedd commit b170e2d
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/LangRef.html
Expand Up @@ -306,6 +306,8 @@ <h1>LLVM Language Reference Manual</h1>
'<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>
Expand Down Expand Up @@ -8205,11 +8207,35 @@ <h5>Semantics:</h5>
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>
Expand Down

0 comments on commit b170e2d

Please sign in to comment.