libs/context/doc/html/context/stack/stack_helper.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Helper functions</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="../../index.html" title="Context">
   8 <link rel="up" href="../stack.html" title="Stack allocation">
   9 <link rel="prev" href="stack_allocator.html" title="Class stack_allocator">
  10 <link rel="next" href="../performance.html" title="Performance">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="stack_allocator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../stack.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../performance.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="context.stack.stack_helper"></a><a class="link" href="stack_helper.html" title="Helper functions">Helper functions</a>
  28 </h3></div></div></div>
  29 <p>
  30         <span class="bold"><strong>Boost.Context</strong></span> provides easy access to the
  31         stack related limits defined by the environment.
  32       </p>
  33 <pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">default_stacksize</span><span class="special">();</span>
  34
  35 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">minimum_stacksize</span><span class="special">();</span>
  36
  37 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">maximum_stacksize</span><span class="special">();</span>
  38
  39 <span class="keyword">bool</span> <span class="identifier">is_stack_unbound</span><span class="special">();</span>
  40
  41 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">pagesize</span><span class="special">();</span>
  42
  43 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">page_count</span><span class="special">(</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">stacksize</span><span class="special">);</span>
  44 </pre>
  45 <h5>
  46 <a name="context.stack.stack_helper.h0"></a>
  47         <span><a name="context.stack.stack_helper._code__phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__default_stacksize__phrase__phrase_role__special______phrase___code_"></a></span><a class="link" href="stack_helper.html#context.stack.stack_helper._code__phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__default_stacksize__phrase__phrase_role__special______phrase___code_"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span>
  48         <span class="identifier">default_stacksize</span><span class="special">()</span></code></a>
  49       </h5>
  50 <div class="variablelist">
  51 <p class="title"><b></b></p>
  52 <dl>
  53 <dt><span class="term">Returns:</span></dt>
  54 <dd><p>
  55               Returns a default stack size, which may be platform specific. The present
  56               implementation returns a value of 256 kB.
  57             </p></dd>
  58 </dl>
  59 </div>
  60 <h5>
  61 <a name="context.stack.stack_helper.h1"></a>
  62         <span><a name="context.stack.stack_helper._code__phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__minimum_stacksize__phrase__phrase_role__special______phrase___code_"></a></span><a class="link" href="stack_helper.html#context.stack.stack_helper._code__phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__minimum_stacksize__phrase__phrase_role__special______phrase___code_"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span>
  63         <span class="identifier">minimum_stacksize</span><span class="special">()</span></code></a>
  64       </h5>
  65 <div class="variablelist">
  66 <p class="title"><b></b></p>
  67 <dl>
  68 <dt><span class="term">Returns:</span></dt>
  69 <dd><p>
  70               Returns the minimum size in bytes of stack defined by the environment.
  71             </p></dd>
  72 <dt><span class="term">Throws:</span></dt>
  73 <dd><p>
  74               Nothing.
  75             </p></dd>
  76 </dl>
  77 </div>
  78 <h5>
  79 <a name="context.stack.stack_helper.h2"></a>
  80         <span><a name="context.stack.stack_helper._code__phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__maximum_stacksize__phrase__phrase_role__special______phrase___code_"></a></span><a class="link" href="stack_helper.html#context.stack.stack_helper._code__phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__maximum_stacksize__phrase__phrase_role__special______phrase___code_"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span>
  81         <span class="identifier">maximum_stacksize</span><span class="special">()</span></code></a>
  82       </h5>
  83 <div class="variablelist">
  84 <p class="title"><b></b></p>
  85 <dl>
  86 <dt><span class="term">Preconditions:</span></dt>
  87 <dd><p>
  88               <code class="computeroutput"><span class="identifier">is_stack_unbound</span><span class="special">()</span></code>
  89               returns <code class="computeroutput"><span class="keyword">false</span></code>.
  90             </p></dd>
  91 <dt><span class="term">Returns:</span></dt>
  92 <dd><p>
  93               Returns the maximum size in bytes of stack defined by the environment.
  94             </p></dd>
  95 <dt><span class="term">Throws:</span></dt>
  96 <dd><p>
  97               Nothing.
  98             </p></dd>
  99 </dl>
 100 </div>
 101 <h5>
 102 <a name="context.stack.stack_helper.h3"></a>
 103         <span><a name="context.stack.stack_helper._code__phrase_role__keyword__bool__phrase___phrase_role__identifier__is_stack_unbound__phrase__phrase_role__special______phrase___code_"></a></span><a class="link" href="stack_helper.html#context.stack.stack_helper._code__phrase_role__keyword__bool__phrase___phrase_role__identifier__is_stack_unbound__phrase__phrase_role__special______phrase___code_"><code class="computeroutput"><span class="keyword">bool</span> <span class="identifier">is_stack_unbound</span><span class="special">()</span></code></a>
 104       </h5>
 105 <div class="variablelist">
 106 <p class="title"><b></b></p>
 107 <dl>
 108 <dt><span class="term">Returns:</span></dt>
 109 <dd><p>
 110               Returns <code class="computeroutput"><span class="keyword">true</span></code> if the environment
 111               defines no limit for the size of a stack.
 112             </p></dd>
 113 <dt><span class="term">Throws:</span></dt>
 114 <dd><p>
 115               Nothing.
 116             </p></dd>
 117 </dl>
 118 </div>
 119 <h5>
 120 <a name="context.stack.stack_helper.h4"></a>
 121         <span><a name="context.stack.stack_helper._code__phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__pagesize__phrase__phrase_role__special______phrase___code_"></a></span><a class="link" href="stack_helper.html#context.stack.stack_helper._code__phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__pagesize__phrase__phrase_role__special______phrase___code_"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span>
 122         <span class="identifier">pagesize</span><span class="special">()</span></code></a>
 123       </h5>
 124 <div class="variablelist">
 125 <p class="title"><b></b></p>
 126 <dl>
 127 <dt><span class="term">Returns:</span></dt>
 128 <dd><p>
 129               Returns how many bytes the operating system allocates for one page.
 130             </p></dd>
 131 <dt><span class="term">Throws:</span></dt>
 132 <dd><p>
 133               Nothing.
 134             </p></dd>
 135 </dl>
 136 </div>
 137 <h5>
 138 <a name="context.stack.stack_helper.h5"></a>
 139         <span><a name="context.stack.stack_helper._code__phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__page_count__phrase__phrase_role__special_____phrase___phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__stacksize__phrase__phrase_role__special_____phrase___code_"></a></span><a class="link" href="stack_helper.html#context.stack.stack_helper._code__phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__page_count__phrase__phrase_role__special_____phrase___phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__stacksize__phrase__phrase_role__special_____phrase___code_"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span>
 140         <span class="identifier">page_count</span><span class="special">(</span>
 141         <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">stacksize</span><span class="special">)</span></code></a>
 142       </h5>
 143 <div class="variablelist">
 144 <p class="title"><b></b></p>
 145 <dl>
 146 <dt><span class="term">Returns:</span></dt>
 147 <dd><p>
 148               Returns how many pages have to be allocated for a stack of <code class="computeroutput"><span class="identifier">stacksize</span></code> bytes.
 149             </p></dd>
 150 <dt><span class="term">Throws:</span></dt>
 151 <dd><p>
 152               Nothing.
 153             </p></dd>
 154 </dl>
 155 </div>
 156 </div>
 157 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 158 <td align="left"></td>
 159 <td align="right"><div class="copyright-footer">Copyright &#169; 2009 Oliver Kowalke<p>
 160         Distributed under the Boost Software License, Version 1.0. (See accompanying
 161         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 162       </p>
 163 </div></td>
 164 </tr></table>
 165 <hr>
 166 <div class="spirit-nav">
 167 <a accesskey="p" href="stack_allocator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../stack.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../performance.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 168 </div>
 169 </body>
 170 </html>