1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class pooled_fixedsize_stack</title> 5<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../index.html" title="Chapter 1. Coroutine2"> 8<link rel="up" href="../stack.html" title="Stack allocation"> 9<link rel="prev" href="protected_fixedsize.html" title="Class protected_fixedsize"> 10<link rel="next" href="fixedsize.html" title="Class fixedsize_stack"> 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="protected_fixedsize.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="fixedsize.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="coroutine2.stack.pooled_fixedsize"></a><a class="link" href="pooled_fixedsize.html" title="Class pooled_fixedsize_stack">Class <span class="emphasis"><em>pooled_fixedsize_stack</em></span></a> 28</h3></div></div></div> 29<p> 30 <span class="bold"><strong>Boost.Coroutine2</strong></span> provides the class <span class="emphasis"><em>pooled_fixedsize_stack</em></span> 31 which models the <span class="emphasis"><em>stack-allocator concept</em></span>. In contrast 32 to <span class="emphasis"><em>protected_fixedsize_stack</em></span> it does not append a guard 33 page at the end of each stack. The memory is managed internally by <a href="http://www.boost.org/doc/libs/release/libs/pool/doc/html/boost/pool.html" target="_top"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">pool</span><span class="special"><></span></code></a>. 34 </p> 35<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">coroutine2</span><span class="special">/</span><span class="identifier">pooled_fixedsize_stack</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 36 37<span class="keyword">struct</span> <span class="identifier">pooled_fixedsize_stack</span> <span class="special">{</span> 38 <span class="identifier">pooled_fixedsize_stack</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">size</span> <span class="special">=</span> <span class="identifier">traits_type</span><span class="special">::</span><span class="identifier">default_size</span><span class="special">());</span> 39 40 <span class="identifier">stack_context</span> <span class="identifier">allocate</span><span class="special">();</span> 41 42 <span class="keyword">void</span> <span class="identifier">deallocate</span><span class="special">(</span> <span class="identifier">stack_context</span> <span class="special">&);</span> 43<span class="special">}</span> 44</pre> 45<h5> 46<a name="coroutine2.stack.pooled_fixedsize.h0"></a> 47 <span class="phrase"><a name="coroutine2.stack.pooled_fixedsize._code__phrase_role__identifier__pooled_fixedsize_stack__phrase__phrase_role__special_____phrase__phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__stack_size__phrase__phrase_role__special_____phrase___phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__next_size__phrase__phrase_role__special_____phrase___phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__max_size__phrase__phrase_role__special_____phrase___code_"></a></span><a class="link" href="pooled_fixedsize.html#coroutine2.stack.pooled_fixedsize._code__phrase_role__identifier__pooled_fixedsize_stack__phrase__phrase_role__special_____phrase__phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__stack_size__phrase__phrase_role__special_____phrase___phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__next_size__phrase__phrase_role__special_____phrase___phrase_role__identifier__std__phrase__phrase_role__special______phrase__phrase_role__identifier__size_t__phrase___phrase_role__identifier__max_size__phrase__phrase_role__special_____phrase___code_"><code class="computeroutput"><span class="identifier">pooled_fixedsize_stack</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> 48 <span class="identifier">stack_size</span><span class="special">,</span> 49 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">next_size</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">max_size</span><span class="special">)</span></code></a> 50 </h5> 51<div class="variablelist"> 52<p class="title"><b></b></p> 53<dl class="variablelist"> 54<dt><span class="term">Preconditions:</span></dt> 55<dd><p> 56 <code class="computeroutput"><span class="special">!</span> <span class="identifier">traits_type</span><span class="special">::</span><span class="identifier">is_unbounded</span><span class="special">()</span> <span class="special">&&</span> 57 <span class="special">(</span> <span class="identifier">traits_type</span><span class="special">::</span><span class="identifier">maximum</span><span class="special">:</span><span class="identifier">size</span><span class="special">()</span> <span class="special">>=</span> <span class="identifier">stack_size</span><span class="special">)</span></code> 58 and <code class="computeroutput"><span class="number">0</span> <span class="special"><</span> 59 <span class="identifier">nest_size</span></code>. 60 </p></dd> 61<dt><span class="term">Effects:</span></dt> 62<dd><p> 63 Allocates memory of at least <code class="computeroutput"><span class="identifier">stack_size</span></code> 64 Bytes and stores a pointer to the stack and its actual size in <code class="computeroutput"><span class="identifier">sctx</span></code>. Depending on the architecture 65 (the stack grows downwards/upwards) the stored address is the highest/lowest 66 address of the stack. Argument <code class="computeroutput"><span class="identifier">next_size</span></code> 67 determines the number of stacks to request from the system the first 68 time that <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> 69 needs to allocate system memory. The third argument <code class="computeroutput"><span class="identifier">max_size</span></code> 70 controls how many memory might be allocated for stacks - a value of 71 zero means no uper limit. 72 </p></dd> 73</dl> 74</div> 75<h5> 76<a name="coroutine2.stack.pooled_fixedsize.h1"></a> 77 <span class="phrase"><a name="coroutine2.stack.pooled_fixedsize._code__phrase_role__identifier__stack_context__phrase___phrase_role__identifier__allocate__phrase__phrase_role__special______phrase___code_"></a></span><a class="link" href="pooled_fixedsize.html#coroutine2.stack.pooled_fixedsize._code__phrase_role__identifier__stack_context__phrase___phrase_role__identifier__allocate__phrase__phrase_role__special______phrase___code_"><code class="computeroutput"><span class="identifier">stack_context</span> <span class="identifier">allocate</span><span class="special">()</span></code></a> 78 </h5> 79<div class="variablelist"> 80<p class="title"><b></b></p> 81<dl class="variablelist"> 82<dt><span class="term">Preconditions:</span></dt> 83<dd><p> 84 <code class="computeroutput"><span class="special">!</span> <span class="identifier">traits_type</span><span class="special">::</span><span class="identifier">is_unbounded</span><span class="special">()</span> <span class="special">&&</span> 85 <span class="special">(</span> <span class="identifier">traits_type</span><span class="special">::</span><span class="identifier">maximum</span><span class="special">:</span><span class="identifier">size</span><span class="special">()</span> <span class="special">>=</span> <span class="identifier">size</span><span class="special">)</span></code>. 86 </p></dd> 87<dt><span class="term">Effects:</span></dt> 88<dd><p> 89 Allocates memory of at least <code class="computeroutput"><span class="identifier">size</span></code> 90 bytes and stores a pointer to the stack and its actual size in <code class="computeroutput"><span class="identifier">sctx</span></code>. Depending on the architecture 91 (the stack grows downwards/upwards) the stored address is the highest/lowest 92 address of the stack. 93 </p></dd> 94</dl> 95</div> 96<h5> 97<a name="coroutine2.stack.pooled_fixedsize.h2"></a> 98 <span class="phrase"><a name="coroutine2.stack.pooled_fixedsize._code__phrase_role__keyword__void__phrase___phrase_role__identifier__deallocate__phrase__phrase_role__special_____phrase___phrase_role__identifier__stack_context__phrase___phrase_role__special___amp___phrase___phrase_role__identifier__sctx__phrase__phrase_role__special_____phrase___code_"></a></span><a class="link" href="pooled_fixedsize.html#coroutine2.stack.pooled_fixedsize._code__phrase_role__keyword__void__phrase___phrase_role__identifier__deallocate__phrase__phrase_role__special_____phrase___phrase_role__identifier__stack_context__phrase___phrase_role__special___amp___phrase___phrase_role__identifier__sctx__phrase__phrase_role__special_____phrase___code_"><code class="computeroutput"><span class="keyword">void</span> <span class="identifier">deallocate</span><span class="special">(</span> <span class="identifier">stack_context</span> 99 <span class="special">&</span> <span class="identifier">sctx</span><span class="special">)</span></code></a> 100 </h5> 101<div class="variablelist"> 102<p class="title"><b></b></p> 103<dl class="variablelist"> 104<dt><span class="term">Preconditions:</span></dt> 105<dd><p> 106 <code class="computeroutput"><span class="identifier">sctx</span><span class="special">.</span><span class="identifier">sp</span></code> is valid, <code class="computeroutput"><span class="special">!</span> 107 <span class="identifier">traits_type</span><span class="special">::</span><span class="identifier">is_unbounded</span><span class="special">()</span> 108 <span class="special">&&</span> <span class="special">(</span> 109 <span class="identifier">traits_type</span><span class="special">::</span><span class="identifier">maximum</span><span class="special">:</span><span class="identifier">size</span><span class="special">()</span> 110 <span class="special">>=</span> <span class="identifier">sctx</span><span class="special">.</span><span class="identifier">size</span><span class="special">)</span></code>. 111 </p></dd> 112<dt><span class="term">Effects:</span></dt> 113<dd><p> 114 Deallocates the stack space. 115 </p></dd> 116</dl> 117</div> 118</div> 119<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 120<td align="left"></td> 121<td align="right"><div class="copyright-footer">Copyright © 2014 Oliver Kowalke<p> 122 Distributed under the Boost Software License, Version 1.0. (See accompanying 123 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>) 124 </p> 125</div></td> 126</tr></table> 127<hr> 128<div class="spirit-nav"> 129<a accesskey="p" href="protected_fixedsize.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="fixedsize.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 130</div> 131</body> 132</html> 133
