summaryrefslogtreecommitdiffstats
path: root/llvm/docs/LangRef.html
diff options
context:
space:
mode:
authorTanya Lattner <tonic@nondot.org>2007-09-21 22:59:12 +0000
committerTanya Lattner <tonic@nondot.org>2007-09-21 22:59:12 +0000
commit293c03733630874b110551265da05da140d3187f (patch)
treea105f5c8919a6a1cea4919185583c00687655098 /llvm/docs/LangRef.html
parent4230512f32759410b2fcf8bef1037d6c3b4ecad6 (diff)
downloadbcm5719-llvm-293c03733630874b110551265da05da140d3187f.tar.gz
bcm5719-llvm-293c03733630874b110551265da05da140d3187f.zip
Adding support for __builtin_annotation with an intrinsic called llvm.annotation. This is similar to llvm.var.annotation but is applied to expressions.
llvm-svn: 42211
Diffstat (limited to 'llvm/docs/LangRef.html')
-rw-r--r--llvm/docs/LangRef.html37
1 files changed, 37 insertions, 0 deletions
diff --git a/llvm/docs/LangRef.html b/llvm/docs/LangRef.html
index 1b3f4f4afe9..05f4e66f882 100644
--- a/llvm/docs/LangRef.html
+++ b/llvm/docs/LangRef.html
@@ -210,6 +210,10 @@
<li><a href="#int_var_annotation">
<tt>llvm.var.annotation</tt>' Intrinsic</a></li>
</ol>
+ <ol>
+ <li><a href="#int_annotation">
+ <tt>llvm.annotation</tt>' Intrinsic</a></li>
+ </ol>
</li>
</ol>
</li>
@@ -5263,6 +5267,39 @@ This can be useful for special purpose optimizations that want to look for these
generation and optimization.
</div>
+<!-- _______________________________________________________________________ -->
+<div class="doc_subsubsection">
+ <a name="int_annotation">'<tt>llvm.annotation</tt>' Intrinsic</a>
+</div>
+
+<div class="doc_text">
+
+<h5>Syntax:</h5>
+<pre>
+ declare i32 @llvm.annotation(i32 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32 &lt;int&gt; )
+</pre>
+
+<h5>Overview:</h5>
+<p>This is an overloaded intrinsic. You can use '<tt>llvm.annotation</tt>' on
+any integer bit width. Not all targets support all bit widths however.
+</p>
+
+<h5>Arguments:</h5>
+
+<p>
+The first argument is an integer value (result of some expression),
+the second is a pointer to a global string, the third is a pointer to a global
+string which is the source file name, and the last argument is the line number.
+</p>
+
+<h5>Semantics:</h5>
+
+<p>
+This intrinsic allows annotations to be put on arbitrary expressions
+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.
+</div>
<!-- *********************************************************************** -->
<hr>
OpenPOWER on IntegriCloud