File: version_information.htm

package info (click to toggle)
tbb 4.2~20140122-5
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 21,492 kB
  • ctags: 21,278
  • sloc: cpp: 92,813; ansic: 9,775; asm: 1,070; makefile: 1,057; sh: 351; java: 226; objc: 98; pascal: 71; xml: 41
file content (355 lines) | stat: -rwxr-xr-x 10,573 bytes parent folder | download
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
<!DOCTYPE html
  PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- saved from url=(0014)about:internet -->
<html xmlns:MSHelp="http://www.microsoft.com/MSHelp/" lang="en-us" xml:lang="en-us"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="DC.Type" content="topic">
<meta name="DC.Title" content="Version Information">
<meta name="DC.subject" content="Version Information, TBB_INTERFACE_VERSION, TBB_INTERFACE_VERSION_MAJOR, TBB_INTERFACE_VERSION/1000, TBB_COMPATIBLE_INTERFACE_VERSION, TBB_USE_ASSERT, DO_ITT_NOTIFY, ALLOCATOR">
<meta name="keywords" content="Version Information, TBB_INTERFACE_VERSION, TBB_INTERFACE_VERSION_MAJOR, TBB_INTERFACE_VERSION/1000, TBB_COMPATIBLE_INTERFACE_VERSION, TBB_USE_ASSERT, DO_ITT_NOTIFY, ALLOCATOR">
<meta name="DC.Relation" scheme="URI" content="../../reference/environment.htm">
<meta name="DC.Format" content="XHTML">
<meta name="DC.Identifier" content="version_information">
<meta name="DC.Language" content="en-US">
<link rel="stylesheet" type="text/css" href="../../intel_css_styles.css">
<title>Version Information</title>
<xml>
<MSHelp:Attr Name="DocSet" Value="Intel"></MSHelp:Attr>
<MSHelp:Attr Name="Locale" Value="kbEnglish"></MSHelp:Attr>
<MSHelp:Attr Name="TopicType" Value="kbReference"></MSHelp:Attr>
</xml>
</head>
<body id="version_information">
 <!-- ==============(Start:NavScript)================= -->
 <script src="..\..\NavScript.js" language="JavaScript1.2" type="text/javascript"></script>
 <script language="JavaScript1.2" type="text/javascript">WriteNavLink(2);</script>
 <!-- ==============(End:NavScript)================= -->
<a name="version_information"><!-- --></a>

 
  <h1 class="topictitle1">Version Information</h1>
 
   
  <div> 
	 <div class="section"> 
		<p>Intel&reg; Threading Building Blocks (Intel&reg; TBB) has
		  macros, an environment variable, and a function that reveal version and
		  run-time information. 
		</p>
 
	 </div>
 
	 <div class="section"><h2 class="sectiontitle">Version Macros </h2> 
		 
		<p>The header 
		  <samp class="codeph">tbb/tbb_stddef.h</samp> defines macros related to versioning,
		  as described below. You should not redefine these macros. 
		</p>
 
		
<div class="tablenoborder"><a name="tbl4"><!-- --></a><table cellpadding="4" summary="" id="tbl4" width="100%" frame="hsides" border="1" rules="all"><caption><span class="tablecap">Version Macros</span></caption> 
		   
		   
		  <thead align="left"> 
			 <tr> 
				<th class="cellrowborder" valign="top" width="NaN%" id="d61139e81"> 
				  <p><strong>Macro</strong> 
				  </p>
 
				</th>
 
				<th class="row-nocellborder" valign="top" width="NaN%" id="d61139e89"> 
				  <p><strong>Description of Value</strong> 
				  </p>
 
				</th>
 
			 </tr>
 
		  </thead>
 
		  <tbody> 
			 <tr> 
				<td class="cellrowborder" valign="top" width="NaN%" headers="d61139e81 "> 
				  <p><samp class="codeph">TBB_INTERFACE_VERSION</samp> 
				  </p>
 
				</td>
 
				<td class="row-nocellborder" valign="top" width="NaN%" headers="d61139e89 "> 
				  <p>Current interface version. The value is a
					 decimal numeral of the form 
					 <samp class="codeph"><em>xyyy</em></samp> where 
					 <samp class="codeph"><em>x</em></samp> is the major version number and 
					 <samp class="codeph"><em>y</em></samp> is the minor version number. 
				  </p>
 
				</td>
 
			 </tr>
 
			 <tr> 
				<td class="cellrowborder" valign="top" width="NaN%" headers="d61139e81 "> 
				  <p><samp class="codeph">TBB_INTERFACE_VERSION_MAJOR</samp> 
				  </p>
 
				</td>
 
				<td class="row-nocellborder" valign="top" width="NaN%" headers="d61139e89 "> 
				  <p><samp class="codeph">TBB_INTERFACE_VERSION/1000;</samp> that is, the
					 major version number. 
				  </p>
 
				</td>
 
			 </tr>
 
			 <tr> 
				<td class="cellrowborder" valign="top" width="NaN%" headers="d61139e81 "> 
				  <p><samp class="codeph">TBB_COMPATIBLE_INTERFACE_VERSION</samp> 
				  </p>
 
				</td>
 
				<td class="row-nocellborder" valign="top" width="NaN%" headers="d61139e89 "> 
				  <p>Oldest major interface version still
					 supported. 
				  </p>
 
				</td>
 
			 </tr>
 
		  </tbody>
 
		</table>
</div>
 
	 </div>
 
	 <div class="section"><h2 class="sectiontitle"><samp class="codeph">TBB_VERSION</samp> Environment
		  Variable</h2> 
		 
		<p>Set the environment variable 
		  <samp class="codeph">TBB_VERSION</samp> to 
		  <samp class="codeph">1</samp> to cause the library to print information on 
		  <samp class="codeph">stderr</samp>. Each line is of the form 
		  <samp class="codeph">“TBB: 
			 <em>tag value</em>”</samp>, where 
		  <em>tag</em> and 
		  <em>value</em> are described below. 
		</p>
 
		
<div class="tablenoborder"><a name="tbl5"><!-- --></a><table cellpadding="4" summary="" id="tbl5" width="100%" frame="hsides" border="1" rules="all"><caption><span class="tablecap">Output from TBB_VERSION</span></caption> 
		   
		   
		  <thead align="left"> 
			 <tr> 
				<th class="cellrowborder" valign="top" width="NaN%" id="d61139e217"> 
				  <p><strong>Tag</strong> 
				  </p>
 
				</th>
 
				<th class="row-nocellborder" valign="top" width="NaN%" id="d61139e225"> 
				  <p><strong>Description of Value</strong> 
				  </p>
 
				</th>
 
			 </tr>
 
		  </thead>
 
		  <tbody> 
			 <tr> 
				<td class="cellrowborder" valign="top" width="NaN%" headers="d61139e217 "> 
				  <p><samp class="codeph">VERSION</samp> 
				  </p>
 
				</td>
 
				<td class="row-nocellborder" valign="top" width="NaN%" headers="d61139e225 "> 
				  <p>Intel TBB product version number. 
				  </p>
 
				</td>
 
			 </tr>
 
			 <tr> 
				<td class="cellrowborder" valign="top" width="NaN%" headers="d61139e217 "> 
				  <p><samp class="codeph">INTERFACE_VERSION</samp> 
				  </p>
 
				</td>
 
				<td class="row-nocellborder" valign="top" width="NaN%" headers="d61139e225 "> 
				  <p>Value of macro 
					 <samp class="codeph">TBB_INTERFACE_VERSION</samp> when library was
					 compiled. 
				  </p>
 
				</td>
 
			 </tr>
 
			 <tr> 
				<td class="cellrowborder" valign="top" width="NaN%" headers="d61139e217 "> 
				  <p><samp class="codeph">BUILD_</samp>... 
				  </p>
 
				</td>
 
				<td class="row-nocellborder" valign="top" width="NaN%" headers="d61139e225 "> 
				  <p>Various information about the machine
					 configuration on which the library was built. 
				  </p>
 
				</td>
 
			 </tr>
 
			 <tr> 
				<td class="cellrowborder" valign="top" width="NaN%" headers="d61139e217 "> 
				  <p><samp class="codeph">TBB_USE_ASSERT</samp> 
				  </p>
 
				</td>
 
				<td class="row-nocellborder" valign="top" width="NaN%" headers="d61139e225 "> 
				  <p>Setting of macro 
					 <samp class="codeph">TBB_USE_ASSERT</samp> 
				  </p>
 
				</td>
 
			 </tr>
 
			 <tr> 
				<td class="cellrowborder" valign="top" width="NaN%" headers="d61139e217 "> 
				  <p><samp class="codeph">DO_ITT_NOTIFY</samp> 
				  </p>
 
				</td>
 
				<td class="row-nocellborder" valign="top" width="NaN%" headers="d61139e225 "> 
				  <p><samp class="codeph">1</samp> if library can enable
					 instrumentation for Intel&reg; Parallel Studio XE and Intel&reg; Threading Tools; 
					 <samp class="codeph">0</samp> or 
					 <samp class="codeph">undefined</samp> otherwise. 
				  </p>
 
				</td>
 
			 </tr>
 
			 <tr> 
				<td class="cellrowborder" valign="top" width="NaN%" headers="d61139e217 "> 
				  <p><samp class="codeph">ITT</samp> 
				  </p>
 
				</td>
 
				<td class="row-nocellborder" valign="top" width="NaN%" headers="d61139e225 "> 
				  <p><samp class="codeph">yes</samp> if library has enabled
					 instrumentation for Intel&reg; Parallel Studio XE and Intel&reg; Threadng Tools, no
					 otherwise. Typically 
					 <samp class="codeph">yes</samp> only if the program is running under
					 control of Intel&reg; Parallel Studio XE or Intel&reg; Threadng Tools. 
				  </p>
 
				</td>
 
			 </tr>
 
			 <tr> 
				<td class="cellrowborder" valign="top" width="NaN%" headers="d61139e217 "> 
				  <p><samp class="codeph">ALLOCATOR</samp> 
				  </p>
 
				</td>
 
				<td class="row-nocellborder" valign="top" width="NaN%" headers="d61139e225 "> 
				  <p>Underlying allocator for 
					 <samp class="codeph">tbb::tbb_allocator</samp>. It is 
					 <samp class="codeph">scalable_malloc</samp> if the Intel&reg; TBB malloc
					 library was successfully loaded; 
					 <samp class="codeph">malloc</samp> otherwise. 
				  </p>
 
				</td>
 
			 </tr>
 
		  </tbody>
 
		</table>
</div>
 
		<div class="Note"><h3 class="NoteTipHead">
					Caution</h3> 
		  <p>This output is implementation specific and may
			 change at any time. 
		  </p>
 
		</div> 
	 </div>
 
	 <div class="section"><h2 class="sectiontitle"><samp class="codeph">TBB_runtime_interface_version</samp>
		  Function</h2> 
		 
		<p><strong>Summary</strong> 
		</p>
 
		<p>Function that returns the interface version of the
		  Intel&reg; TBB library that was loaded at runtime. 
		</p>
 
	 </div>
 
	 <div class="section"><h2 class="sectiontitle">Syntax</h2> 
		 
		<p> 
		  <pre>extern “C” int TBB_runtime_interface_version();</pre> 
		</p>
 
	 </div>
 
	 <div class="section"><h2 class="sectiontitle">Header</h2> 
		 
		<p> 
		  <pre>#include "tbb/tbb_stddef.h"</pre> 
		</p>
 
	 </div>
 
	 <div class="section"><h2 class="sectiontitle">Description</h2> 
		 
		<p>The value returned by 
		  <samp class="codeph">TBB_runtime_interface_version()</samp> may differ from the
		  value of 
		  <samp class="codeph">TBB_INTERFACE_VERSION</samp> obtained at compile time. This
		  can be used to identify whether an application was compiled against a
		  compatible version of the Intel&reg; TBB headers. 
		</p>
 
		<p>In general, the run-time value 
		  <samp class="codeph">TBB_runtime_interface_version()</samp> must be greater than
		  or equal to the compile-time value of TBB_INTERFACE_VERSION. Otherwise the
		  application may fail to resolve all symbols at run time. 
		</p>
 
	 </div>
 
  </div>
 

<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong>&nbsp;<a href="../../reference/environment.htm">Environment</a></div>
</div>
<div></div>

</body>
</html>