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
|
<!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.5"/>
<title>tbb::interface6::runtime_loader 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="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<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="modules.html"><span>Modules</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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</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>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00249.html">tbb</a></li><li class="navelem"><b>interface6</b></li><li class="navelem"><a class="el" href="a00139.html">runtime_loader</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="a00409.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">tbb::interface6::runtime_loader Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Load TBB at runtime.
<a href="a00139.html#details">More...</a></p>
<p><code>#include <runtime_loader.h></code></p>
<div class="dynheader">
Inheritance diagram for tbb::interface6::runtime_loader:</div>
<div class="dyncontent">
<div class="center">
<img src="a00139.png" usemap="#tbb::interface6::runtime_loader_map" alt=""/>
<map id="tbb::interface6::runtime_loader_map" name="tbb::interface6::runtime_loader_map">
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ab85c82f9c0ccd91905f2795a79ac1295"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00139.html#ab85c82f9c0ccd91905f2795a79ac1295">error_mode</a> { <a class="el" href="a00139.html#ab85c82f9c0ccd91905f2795a79ac1295af9c9137d6acdb0fd37f1a92b5cdaeb36">em_status</a>,
<a class="el" href="a00139.html#ab85c82f9c0ccd91905f2795a79ac1295a17ec1019cffa635146eaefb042e28a2c">em_throw</a>,
<a class="el" href="a00139.html#ab85c82f9c0ccd91905f2795a79ac1295ac41f8e03c7e8bfc6a420be035d59cc35">em_abort</a>
}</td></tr>
<tr class="memdesc:ab85c82f9c0ccd91905f2795a79ac1295"><td class="mdescLeft"> </td><td class="mdescRight">Error mode constants. <a href="a00139.html#ab85c82f9c0ccd91905f2795a79ac1295">More...</a><br/></td></tr>
<tr class="separator:ab85c82f9c0ccd91905f2795a79ac1295"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a264674772d9f4240d89aa9d939c1eef7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00139.html#a264674772d9f4240d89aa9d939c1eef7">error_code</a> { <br/>
  <a class="el" href="a00139.html#a264674772d9f4240d89aa9d939c1eef7afc7eba28f2fc936312f041cf85276434">ec_ok</a>,
<a class="el" href="a00139.html#a264674772d9f4240d89aa9d939c1eef7a670e4d0a5a3c1bbcdff9e5ee16dc9c01">ec_bad_call</a>,
<a class="el" href="a00139.html#a264674772d9f4240d89aa9d939c1eef7afd928f63eb3da0980e746d58374b07c3">ec_bad_arg</a>,
<a class="el" href="a00139.html#a264674772d9f4240d89aa9d939c1eef7a71f874957c0322f499ba764dd0bb8732">ec_bad_lib</a>,
<br/>
  <a class="el" href="a00139.html#a264674772d9f4240d89aa9d939c1eef7aae7497a49ceae69d06d6ab9fef636064">ec_bad_ver</a>,
<a class="el" href="a00139.html#a264674772d9f4240d89aa9d939c1eef7a5e694560f3ada80d2cc25881b5ae43dd">ec_no_lib</a>
<br/>
}</td></tr>
<tr class="memdesc:a264674772d9f4240d89aa9d939c1eef7"><td class="mdescLeft"> </td><td class="mdescRight">Error codes. <a href="a00139.html#a264674772d9f4240d89aa9d939c1eef7">More...</a><br/></td></tr>
<tr class="separator:a264674772d9f4240d89aa9d939c1eef7"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a2f87eaf99564c705aa140f2eb8848eaa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f87eaf99564c705aa140f2eb8848eaa"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00139.html#a2f87eaf99564c705aa140f2eb8848eaa">runtime_loader</a> (<a class="el" href="a00139.html#ab85c82f9c0ccd91905f2795a79ac1295">error_mode</a> mode=<a class="el" href="a00139.html#ab85c82f9c0ccd91905f2795a79ac1295ac41f8e03c7e8bfc6a420be035d59cc35">em_abort</a>)</td></tr>
<tr class="memdesc:a2f87eaf99564c705aa140f2eb8848eaa"><td class="mdescLeft"> </td><td class="mdescRight">Initialize object but do not load TBB. <br/></td></tr>
<tr class="separator:a2f87eaf99564c705aa140f2eb8848eaa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e0932074d2f3ad04605e7e5da88c561"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00139.html#a3e0932074d2f3ad04605e7e5da88c561">runtime_loader</a> (char const *path[], int min_ver=TBB_INTERFACE_VERSION, int max_ver=INT_MAX, <a class="el" href="a00139.html#ab85c82f9c0ccd91905f2795a79ac1295">error_mode</a> mode=<a class="el" href="a00139.html#ab85c82f9c0ccd91905f2795a79ac1295ac41f8e03c7e8bfc6a420be035d59cc35">em_abort</a>)</td></tr>
<tr class="memdesc:a3e0932074d2f3ad04605e7e5da88c561"><td class="mdescLeft"> </td><td class="mdescRight">Initialize object and load TBB. <a href="#a3e0932074d2f3ad04605e7e5da88c561">More...</a><br/></td></tr>
<tr class="separator:a3e0932074d2f3ad04605e7e5da88c561"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3b96f53e165e3d692c3c36292ba0737"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3b96f53e165e3d692c3c36292ba0737"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00139.html#aa3b96f53e165e3d692c3c36292ba0737">~runtime_loader</a> ()</td></tr>
<tr class="memdesc:aa3b96f53e165e3d692c3c36292ba0737"><td class="mdescLeft"> </td><td class="mdescRight">Destroy object. <br/></td></tr>
<tr class="separator:aa3b96f53e165e3d692c3c36292ba0737"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae2949e9adcac56a2cb9864437be8e22e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00139.html#a264674772d9f4240d89aa9d939c1eef7">error_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00139.html#ae2949e9adcac56a2cb9864437be8e22e">load</a> (char const *path[], int min_ver=TBB_INTERFACE_VERSION, int max_ver=INT_MAX)</td></tr>
<tr class="memdesc:ae2949e9adcac56a2cb9864437be8e22e"><td class="mdescLeft"> </td><td class="mdescRight">Load TBB. <a href="#ae2949e9adcac56a2cb9864437be8e22e">More...</a><br/></td></tr>
<tr class="separator:ae2949e9adcac56a2cb9864437be8e22e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a85bf9ee021a2076a3ac7cfd70aae7345"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00139.html#a264674772d9f4240d89aa9d939c1eef7">error_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00139.html#a85bf9ee021a2076a3ac7cfd70aae7345">status</a> ()</td></tr>
<tr class="memdesc:a85bf9ee021a2076a3ac7cfd70aae7345"><td class="mdescLeft"> </td><td class="mdescRight">Report status. <a href="#a85bf9ee021a2076a3ac7cfd70aae7345">More...</a><br/></td></tr>
<tr class="separator:a85bf9ee021a2076a3ac7cfd70aae7345"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Load TBB at runtime. </p>
<p><b>Usage:</b> </p>
<p>In source code:</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include "tbb/runtime_loader.h"</span></div>
<div class="line"></div>
<div class="line"><span class="keywordtype">char</span> <span class="keyword">const</span> * path[] = { <span class="stringliteral">"<install dir>/lib/ia32"</span>, NULL };</div>
<div class="line">tbb::runtime_loader loader( path );</div>
<div class="line"></div>
<div class="line"><span class="comment">// Now use TBB.</span></div>
</div><!-- fragment --><p>Link with <code>tbbproxy.lib</code> (or <code>libtbbproxy.a</code>) instead of <code>tbb.lib</code> (<code>libtbb.dylib</code>, <code>libtbb.so</code>).</p>
<p>TBB library will be loaded at runtime from <code></code> <install dir>="">/lib/ia32 directory.</p>
<p><b>Attention:</b> </p>
<p>All <code><a class="el" href="a00139.html" title="Load TBB at runtime. ">runtime_loader</a></code> objects (in the same module, i.e. exe or dll) share some global state. The most noticeable piece of global state is loaded TBB library. There are some implications: </p>
<pre class="fragment">- Only one TBB library can be loaded per module.
- If one object has already loaded TBB library, another object will not load TBB.
If the loaded TBB library is suitable for the second object, both will use TBB
cooperatively, otherwise the second object will report an error.
- \c runtime_loader objects will not work (correctly) in parallel due to absence of
synchronization.</pre> </div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a264674772d9f4240d89aa9d939c1eef7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00139.html#a264674772d9f4240d89aa9d939c1eef7">tbb::interface6::runtime_loader::error_code</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Error codes. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a264674772d9f4240d89aa9d939c1eef7afc7eba28f2fc936312f041cf85276434"></a>ec_ok</em> </td><td class="fielddoc">
<p>No errors. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a264674772d9f4240d89aa9d939c1eef7a670e4d0a5a3c1bbcdff9e5ee16dc9c01"></a>ec_bad_call</em> </td><td class="fielddoc">
<p>Invalid function call (e. g. <a class="el" href="a00139.html#ae2949e9adcac56a2cb9864437be8e22e" title="Load TBB. ">load()</a> called when TBB is already loaded). </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a264674772d9f4240d89aa9d939c1eef7afd928f63eb3da0980e746d58374b07c3"></a>ec_bad_arg</em> </td><td class="fielddoc">
<p>Invalid argument passed. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a264674772d9f4240d89aa9d939c1eef7a71f874957c0322f499ba764dd0bb8732"></a>ec_bad_lib</em> </td><td class="fielddoc">
<p>Invalid library found (e. g. <code>TBB_runtime_version</code> symbol not found). </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a264674772d9f4240d89aa9d939c1eef7aae7497a49ceae69d06d6ab9fef636064"></a>ec_bad_ver</em> </td><td class="fielddoc">
<p>TBB found but version is not suitable. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a264674772d9f4240d89aa9d939c1eef7a5e694560f3ada80d2cc25881b5ae43dd"></a>ec_no_lib</em> </td><td class="fielddoc">
<p>No suitable TBB library found. </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="ab85c82f9c0ccd91905f2795a79ac1295"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00139.html#ab85c82f9c0ccd91905f2795a79ac1295">tbb::interface6::runtime_loader::error_mode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Error mode constants. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ab85c82f9c0ccd91905f2795a79ac1295af9c9137d6acdb0fd37f1a92b5cdaeb36"></a>em_status</em> </td><td class="fielddoc">
<p>Save status of operation and continue. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ab85c82f9c0ccd91905f2795a79ac1295a17ec1019cffa635146eaefb042e28a2c"></a>em_throw</em> </td><td class="fielddoc">
<p>Throw an exception of tbb::runtime_loader::error_code type. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ab85c82f9c0ccd91905f2795a79ac1295ac41f8e03c7e8bfc6a420be035d59cc35"></a>em_abort</em> </td><td class="fielddoc">
<p>Print message to <code>stderr</code> and call <code>abort()</code>. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a3e0932074d2f3ad04605e7e5da88c561"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">tbb::interface6::runtime_loader::runtime_loader </td>
<td>(</td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>path</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>min_ver</em> = <code>TBB_INTERFACE_VERSION</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>max_ver</em> = <code>INT_MAX</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00139.html#ab85c82f9c0ccd91905f2795a79ac1295">error_mode</a> </td>
<td class="paramname"><em>mode</em> = <code><a class="el" href="a00139.html#ab85c82f9c0ccd91905f2795a79ac1295ac41f8e03c7e8bfc6a420be035d59cc35">em_abort</a></code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize object and load TBB. </p>
<p>See <a class="el" href="a00139.html#ae2949e9adcac56a2cb9864437be8e22e" title="Load TBB. ">load()</a> for details.</p>
<p>If error mode is <code>em_status</code>, call <a class="el" href="a00139.html#a85bf9ee021a2076a3ac7cfd70aae7345" title="Report status. ">status()</a> to check whether TBB was loaded or not. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>List of directories to search TBB in. </td></tr>
<tr><td class="paramname">min_ver</td><td>Minimal suitable version of TBB. </td></tr>
<tr><td class="paramname">max_ver</td><td>Maximal suitable version of TBB. </td></tr>
<tr><td class="paramname">mode</td><td>Error mode for this object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ae2949e9adcac56a2cb9864437be8e22e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00139.html#a264674772d9f4240d89aa9d939c1eef7">error_code</a> tbb::interface6::runtime_loader::load </td>
<td>(</td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>path</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>min_ver</em> = <code>TBB_INTERFACE_VERSION</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>max_ver</em> = <code>INT_MAX</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load TBB. </p>
<p>The method searches the directories specified in <code>path</code>[] array for the TBB library. When the library is found, it is loaded and its version is checked. If the version is not suitable, the library is unloaded, and the search continues.</p>
<p><b>Note:</b> </p>
<p>For security reasons, avoid using relative directory names. For example, never load TBB from current (<code>"."</code>), parent (<code>".."</code>) or any other relative directory (like <code>"lib"</code> ). Use only absolute directory names (e. g. "/usr/local/lib").</p>
<p>For the same security reasons, avoid using system default directories (<code>""</code>) on Windows. (See <a href="http://www.microsoft.com/technet/security/advisory/2269637.mspx">http://www.microsoft.com/technet/security/advisory/2269637.mspx</a> for details.)</p>
<p>Neglecting these rules may cause your program to execute 3-rd party malicious code.</p>
<p><b>Errors:</b> </p>
<ul>
<li><code>ec_bad_call</code> - TBB already loaded by this object.</li>
<li><code>ec_bad_arg</code> - <code>min_ver</code> and/or <code>max_ver</code> negative or zero, or <code>min_ver</code> > <code>max_ver</code>.</li>
<li><code>ec_bad_ver</code> - TBB of unsuitable version already loaded by another object.</li>
<li><code>ec_no_lib</code> - No suitable library found. </li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>List of directories to search TBB in. </td></tr>
<tr><td class="paramname">min_ver</td><td>Minimal suitable version of TBB. </td></tr>
<tr><td class="paramname">max_ver</td><td>Maximal suitable version of TBB. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a85bf9ee021a2076a3ac7cfd70aae7345"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00139.html#a264674772d9f4240d89aa9d939c1eef7">error_code</a> tbb::interface6::runtime_loader::status </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Report status. </p>
<p>If error mode is <code>em_status</code>, the function returns status of the last operation. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>runtime_loader.h</li>
</ul>
</div><!-- contents -->
<hr>
<p></p>
Copyright © 2005-2018 Intel Corporation. All Rights Reserved.
<p></p>
Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
registered trademarks or trademarks of Intel Corporation or its
subsidiaries in the United States and other countries.
<p></p>
* Other names and brands may be claimed as the property of others.
|
