6502/llvm-6502
1
0
Fork 0
mirror of https://github.com/c64scene-ar/llvm-6502.git synced 2025-01-01 00:33:09 +00:00
Code Issues Projects Releases Wiki Activity

Document function notes.

Browse Source 
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@55808 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Devang Patel 2008-09-04 23:05:13 +00:00
parent 4a03775777
commit f8b94812a1
1 changed files with 37 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/LangRef.html
View File

@ -750,7 +750,8 @@ an optional <a href="#linkage">linkage type</a>, an optional
<a href="#paramattrs">parameter attribute</a> for the return type, a function
name, a (possibly empty) argument list (each with optional
<a href="#paramattrs">parameter attributes</a>), an optional section, an
optional alignment, an optional <a href="#gc">garbage collector name</a>, an
optional alignment, an optional <a href="#gc">garbage collector name</a>,
an optional <a href="#notes">function notes</a>, an
opening curly brace, a list of basic blocks, and a closing curly brace.
LLVM function declarations consist of the "<tt>declare</tt>" keyword, an
@ -910,6 +911,41 @@ collector which will cause the compiler to alter its output in order to support
the named garbage collection algorithm.</p>
</div>
<!-- ======================================================================= -->
<div class="doc_subsection">
<a name="notes">Function Notes</a>
</div>
<div class="doc_text">
<p>Each function may specify function notes.</p>
<div class="doc_code">
<pre>define void @f() notes(inline=Always) { ... }</pre>
<pre>define void @f() notes(inline=Always,opt-size) { ... }</pre>
<pre>define void @f() notes(inline=Never,opt-size) { ... }</pre>
<pre>define void @f() notes(opt-size) { ... }</pre>
</div>
<p>
<li>inline=Always
<p>
This note requests inliner to inline this function irrespective of
inlining size threshold for this function.
</p></li>
<li>inline=Never
<p>
This note requests inliner to never inline this function in any situation.
This note may not be used together with inline=Always note.
</p></li>
<li>opt-size
<p>
This note suggests optimization passes and code generator passes to make
choices that help reduce code size.
</p></li>
<p>
The notes that are not documented here are considered invalid notes.
</div>
<!-- ======================================================================= -->
<div class="doc_subsection">
<a name="moduleasm">Module-Level Inline Assembly</a>