Mercurial Mercurial > oss > FCL > sftools > dev > ide > carbidecpp / annotate
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core/com.nokia.carbide.cpp.compiler.doc.user/html/c_compiler/c_inlining.htm
author timkelly
Thu, 10 Dec 2009 13:45:47 -0600
branchRCL_2_4
changeset 671 80524b72f957
parent 0 fb279309251b
child 1641 2b3996fc09a1
permissions -rw-r--r--
Add S60 5.2 support.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
     1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN"><html>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
     2
 
<head>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
     3
 
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
     4
 
<meta http-equiv="Content-Style-Type" content="text/css" />
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
     5
 
<meta name="LASTUPDATED" content="06/17/05 11:09:43" />
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
     6
 
<title>Inlining</title>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
     7
 
<link rel="StyleSheet" href="../../book.css" type="text/css"/>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
     8
 
</head>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
     9
 
<body bgcolor="#FFFFFF">
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    10
 
<h3>Inlining</h3>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    11
 
<p>Carbide supports inlining C/C++ functions that you define with the <span class="code">inline</span>, <span class="code">__inline__</span>, or <span class="code">__inline</span> specifier keywords.</p>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    12
 
<p>The following functions are never inlined:</p>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    13
 
<ul>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    14
 
  <li>Functions that return class objects that need destruction.</li>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    15
 
  <li>Functions with class arguments that need destruction.</li>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    16
 
  <li>Functions with variable argument lists.</li>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    17
 
</ul>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    18
 
<p>The compiler determines whether to inline a function based on the <a href="../pragmas/p_ANSI_strict.htm">ANSI Strict</a>, <a href="../pragmas/p_inline_depth.htm">Inline Depth</a>, <a href="../pragmas/p_auto_inline.htm">Auto-inline</a>, and <a href="../pragmas/p_defer_codegen.htm">Deferred Inlining</a> settings.</p>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    19
 
<p class="note"><strong>TIP</strong> When you call an inlined function, the compiler inserts the actual instructions of that function rather than a call to that function. Inlining functions makes your programs faster because you execute the function code immediately without the overhead of a function call and return. However, it can also make your program larger because the compiler may have to repeat the function code multiple times throughout your program.</p>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    20
 
<p>If you disable the ANSI Keywords Only setting, you can declare C functions to be inline.</p>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    21
 
<h5>Table 1: Settings for the Inline Depth</h5>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    22
 
<table width="76%"  border="0" cellpadding="2" cellspacing="0">
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    23
 
  <tr>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    24
 
    <th width="25%" scope="col">This setting</th>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    25
 
    <th width="75%" scope="col">Does this&hellip;</th>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    26
 
  </tr>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    27
 
  <tr>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    28
 
    <td>Don&rsquo;t Inline</td>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    29
 
    <td>Inlines no functions, not even C or C++ functions declared inline.</td>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    30
 
  </tr>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    31
 
  <tr>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    32
 
    <td>Smart</td>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    33
 
    <td>Inlines small functions to a depth of 2 to 4 inline functions deep.</td>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    34
 
  </tr>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    35
 
  <tr>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    36
 
    <td>1 to 8</td>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    37
 
    <td>Inlines to the depth specified by the numerical selection.</td>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    38
 
  </tr>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    39
 
</table>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    40
 
<p>The Smart and 1 to 8 items in the Inline Depth dropdown menu correspond to the pragma <a href="../pragmas/p_inline_depth.htm">inline_depth</a> (inline_depth). To check this setting, use <span class="code">__option(inline_depth)</span>, described at <a href="../symbols/sym_settings.htm">Checking Settings</a>.</p>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    41
 
<p>The Don&rsquo;t Inline item  corresponds to the pragma <a href="../pragmas/p_dont_inline.htm">dont_inline</a>. To check this setting, use <span class="code">__option (dont_inline)</span>. By default, this setting is disabled. </p>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    42
 
<p>The Auto-Inline setting lets the compiler choose which functions to inline. Also inlines C++ functions declared inline and member functions defined within a class declaration. This setting corresponds to the pragma <a href="../pragmas/p_auto_inline.htm">auto_inline</a>. To check this setting, use <span class="code">__option (auto_inline)</span>. By default, this setting is disabled.</p>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    43
 
<p>The Deferred Inlining setting tells the compiler to inline functions that are not yet defined. This setting corresponds to the pragma <a href="../pragmas/p_defer_codegen.htm">defer_codegen</a>. To check this setting, use<span class="code"> <span class="code">__option (defer_codegen)</span></span>. </p>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    44
 
<p>The Bottom-up Inlining settings tells the compiler to inline functions starting at the last function to the first function in a chain of function calls. This setting corresponds to the pragma <a href="../pragmas/p_inline_bottom_up.htm">inline_bottom_up</a>. To check this setting, use <span class="code">__option (inline_bottom_up)</span>.</p>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    45
 
<p>You can also disable automatic inlining of specific functions within a source file using the <span class="code">__attribute__((never_inline))</span>. </p>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    46
 
<div class="listing">
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    47
 
  <h5>Example __attribute__(never_inline)</h5>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    48
 
  <p>inline int f() __attribute__((never_inline))<br />
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    49
 
    {<br />
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    50
 
    return 10;<br />
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    51
 
    }</p>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    52
 
  <p>int main()<br />
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    53
 
    {<br />
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    54
 
    return f(); // f() is never inlined<br />
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    55
 
  }</p>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    56
 
</div>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    57
 
<p class="note"><strong>NOTE</strong> For Intel x86 targets, the <span class="code">__decspec(noinline)</span> is a compatible synonym. </p>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    58
 
<div id="footer">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. <br>License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a></div>
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset 
    59
 












fb279309251b
DP tools release version Revision: 200912



Deepak Modgil <Deepak.Modgil@Nokia.com>


parents: 

diff
changeset




    60














fb279309251b
DP tools release version Revision: 200912



Deepak Modgil <Deepak.Modgil@Nokia.com>


parents: 

diff
changeset




    61


</body>













fb279309251b
DP tools release version Revision: 200912



Deepak Modgil <Deepak.Modgil@Nokia.com>


parents: 

diff
changeset




    62


</html>















FCL/sftools/dev/ide/carbidecpp