forked from RaftLib/RaftLib
-
Notifications
You must be signed in to change notification settings - Fork 1
/
class_allocate.html
409 lines (397 loc) · 19 KB
/
class_allocate.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>My Project: Allocate Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> |
<a href="class_allocate-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Allocate Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for Allocate:</div>
<div class="dyncontent">
<div class="center">
<img src="class_allocate.png" usemap="#Allocate_map" alt=""/>
<map id="Allocate_map" name="Allocate_map">
<area href="classdynalloc.html" alt="dynalloc" shape="rect" coords="0,56,60,80"/>
<area href="classstdalloc.html" alt="stdalloc" shape="rect" coords="70,56,130,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a61d8b01e404c23ead20068035e3ba540"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_allocate.html#a61d8b01e404c23ead20068035e3ba540">Allocate</a> (<a class="el" href="class_map.html">Map</a> &map, volatile bool &<a class="el" href="class_allocate.html#a4d10076b88ab1297c89b8a05e117b510">exit_alloc</a>)</td></tr>
<tr class="separator:a61d8b01e404c23ead20068035e3ba540"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a68cd61da26f3b82da094b6d3e5d556f5"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_allocate.html#a68cd61da26f3b82da094b6d3e5d556f5">~Allocate</a> ()</td></tr>
<tr class="separator:a68cd61da26f3b82da094b6d3e5d556f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44f9b51c382fec159233609e21b9d272"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_allocate.html#a44f9b51c382fec159233609e21b9d272">run</a> ()=0</td></tr>
<tr class="separator:a44f9b51c382fec159233609e21b9d272"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3123c2c1d9584974ce19b47fe6ceea17"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_allocate.html#a3123c2c1d9584974ce19b47fe6ceea17">waitTillReady</a> ()</td></tr>
<tr class="separator:a3123c2c1d9584974ce19b47fe6ceea17"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a1d5c71b5cd6fc9671ed82d9c1d04965c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_allocate.html#a1d5c71b5cd6fc9671ed82d9c1d04965c">initialize</a> (<a class="el" href="struct_port_info.html">PortInfo</a> *const src, <a class="el" href="struct_port_info.html">PortInfo</a> *const dst, FIFO *const fifo)</td></tr>
<tr class="separator:a1d5c71b5cd6fc9671ed82d9c1d04965c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a901eb0fdb6cffd56019c9ab9f2b25f92"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a901eb0fdb6cffd56019c9ab9f2b25f92"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>allocate</b> (<a class="el" href="struct_port_info.html">PortInfo</a> &a, <a class="el" href="struct_port_info.html">PortInfo</a> &b, void *data)</td></tr>
<tr class="separator:a901eb0fdb6cffd56019c9ab9f2b25f92"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4cf36bb704e43f5736a0e736d9e1a81b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_allocate.html#a4cf36bb704e43f5736a0e736d9e1a81b">setReady</a> ()</td></tr>
<tr class="separator:a4cf36bb704e43f5736a0e736d9e1a81b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a93e612d7ea7eb686fc88b5dee7a1407b"><td class="memItemLeft" align="right" valign="top">kernelkeeper & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_allocate.html#a93e612d7ea7eb686fc88b5dee7a1407b">source_kernels</a></td></tr>
<tr class="separator:a93e612d7ea7eb686fc88b5dee7a1407b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a91e8c7d69ab7b309ea45439aea54fb4f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a91e8c7d69ab7b309ea45439aea54fb4f"></a>
kernelkeeper & </td><td class="memItemRight" valign="bottom"><b>all_kernels</b></td></tr>
<tr class="separator:a91e8c7d69ab7b309ea45439aea54fb4f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a037410210c0d10578f87de1ec68f47ba"><td class="memItemLeft" align="right" valign="top">std::set< FIFO * > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_allocate.html#a037410210c0d10578f87de1ec68f47ba">allocated_fifo</a></td></tr>
<tr class="separator:a037410210c0d10578f87de1ec68f47ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d10076b88ab1297c89b8a05e117b510"><td class="memItemLeft" align="right" valign="top">volatile bool & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_allocate.html#a4d10076b88ab1297c89b8a05e117b510">exit_alloc</a></td></tr>
<tr class="separator:a4d10076b88ab1297c89b8a05e117b510"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a901ac6fe1c35f3c114cf9e83f75dde0c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a901ac6fe1c35f3c114cf9e83f75dde0c"></a>
class </td><td class="memItemRight" valign="bottom"><b>basic_parallel</b></td></tr>
<tr class="separator:a901ac6fe1c35f3c114cf9e83f75dde0c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a61d8b01e404c23ead20068035e3ba540"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Allocate::Allocate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_map.html">Map</a> & </td>
<td class="paramname"><em>map</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">volatile bool & </td>
<td class="paramname"><em>exit_alloc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="class_allocate.html">Allocate</a> - base constructor, really doesn't do too much save for setting the global variables all_kernels and source_kernels from the <a class="el" href="class_map.html">Map</a> object. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">map</td><td>- <a class="el" href="class_map.html">Map</a>& </td></tr>
<tr><td class="paramname">exit_alloc</td><td>- bool used to terminate loop, for monitoring allocations, controlled by map object.</td></tr>
</table>
</dd>
</dl>
<p>allocate.cpp - </p><dl class="section author"><dt>Author</dt><dd>: Jonathan Beard </dd></dl>
<dl class="section version"><dt>Version</dt><dd>: Tue Sep 16 20:20:06 2014</dd></dl>
<p>Copyright 2014 Jonathan Beard</p>
<p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:</p>
<p><a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></p>
<p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. </p>
</div>
</div>
<a class="anchor" id="a68cd61da26f3b82da094b6d3e5d556f5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Allocate::~Allocate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>destructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1d5c71b5cd6fc9671ed82d9c1d04965c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Allocate::initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_port_info.html">PortInfo</a> *const </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_port_info.html">PortInfo</a> *const </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FIFO *const </td>
<td class="paramname"><em>fifo</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>initialize - internal method to be used within the run method takes care of the initialization using the already allocated FIFO object passed as a param. This function will throw an exception if either port (src or dst) have already been allocated. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>- PortInfo*, nullptr if not to be set </td></tr>
<tr><td class="paramname">dst</td><td>- PortInfo*, nullptr if not to be set </td></tr>
<tr><td class="paramname">fifo</td><td>- FIFO* </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="class_port_double_initialize_exception.html">PortDoubleInitializeException</a></td><td>- if either port is already initialized. </td></tr>
</table>
</dd>
</dl>
<p>NOTE: this list simply speeds up the monitoring if we want it </p>
</div>
</div>
<a class="anchor" id="a44f9b51c382fec159233609e21b9d272"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Allocate::run </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>run - implement this function to create a new allocator, will be run inside a thread so exits when done but if run-time monitoring is desired then this is the place to do it. </p>
<p>Implemented in <a class="el" href="classstdalloc.html#a60438b15948ce354b52b03ba6d975de0">stdalloc</a>, and <a class="el" href="classdynalloc.html#a2a52b86ec09bd6dd52e49062137b2e37">dynalloc</a>.</p>
</div>
</div>
<a class="anchor" id="a4cf36bb704e43f5736a0e736d9e1a81b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Allocate::setReady </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>setReady - call within the implemented run function to signal that the initial allocations have been completed. </p>
</div>
</div>
<a class="anchor" id="a3123c2c1d9584974ce19b47fe6ceea17"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Allocate::waitTillReady </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>waitTillReady - call after initializing the allocate thread, returns when the initial allocation is complete. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a037410210c0d10578f87de1ec68f47ba"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::set< FIFO* > Allocate::allocated_fifo</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>keeps a list of all currently allocated FIFO objects, set from within the initialize function. </p>
</div>
</div>
<a class="anchor" id="a4d10076b88ab1297c89b8a05e117b510"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">volatile bool& Allocate::exit_alloc</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>exit_alloc - bool whose value is set by the map object, controls when the loop within the alloc thread is exited. </p>
</div>
</div>
<a class="anchor" id="a93e612d7ea7eb686fc88b5dee7a1407b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">kernelkeeper& Allocate::source_kernels</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>both convenience structs, hold exactly what the names say </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="allocate_8hpp_source.html">allocate.hpp</a></li>
<li>allocate.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>