/usr/share/doc/libomp-doc/html/group__PARALLEL.html is in libomp-doc 5.0.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>LLVM OpenMP* Runtime Library: Parallel (fork/join)</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>
<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">LLVM OpenMP* Runtime Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Parallel (fork/join)</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gad6046ca21a94bff569275ed08dd11a97"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PARALLEL.html#gad6046ca21a94bff569275ed08dd11a97">kmpc_micro</a>) (kmp_int32 *global_tid, kmp_int32 *bound_tid,...)</td></tr>
<tr class="separator:gad6046ca21a94bff569275ed08dd11a97"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga345b3a5866deefefc91ae1e8958f49f4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PARALLEL.html#ga345b3a5866deefefc91ae1e8958f49f4">__kmpc_push_num_threads</a> (<a class="el" href="group__BASIC__TYPES.html#ga690fda6b92f039a72db263c6b4394ddb">ident_t</a> *loc, kmp_int32 global_tid, kmp_int32 num_threads)</td></tr>
<tr class="separator:ga345b3a5866deefefc91ae1e8958f49f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac2b7cc2fa78dde5381bcf00cfc48d124"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PARALLEL.html#gac2b7cc2fa78dde5381bcf00cfc48d124">__kmpc_fork_call</a> (<a class="el" href="group__BASIC__TYPES.html#ga690fda6b92f039a72db263c6b4394ddb">ident_t</a> *loc, kmp_int32 argc, <a class="el" href="group__PARALLEL.html#gad6046ca21a94bff569275ed08dd11a97">kmpc_micro</a> microtask,...)</td></tr>
<tr class="separator:gac2b7cc2fa78dde5381bcf00cfc48d124"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaae9462b03457d809faeb3e767a5b2283"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PARALLEL.html#gaae9462b03457d809faeb3e767a5b2283">__kmpc_push_num_teams</a> (<a class="el" href="group__BASIC__TYPES.html#ga690fda6b92f039a72db263c6b4394ddb">ident_t</a> *loc, kmp_int32 global_tid, kmp_int32 num_teams, kmp_int32 num_threads)</td></tr>
<tr class="separator:gaae9462b03457d809faeb3e767a5b2283"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1cab712d076ba1d2758b0c3bf5ffe38a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PARALLEL.html#ga1cab712d076ba1d2758b0c3bf5ffe38a">__kmpc_fork_teams</a> (<a class="el" href="group__BASIC__TYPES.html#ga690fda6b92f039a72db263c6b4394ddb">ident_t</a> *loc, kmp_int32 argc, <a class="el" href="group__PARALLEL.html#gad6046ca21a94bff569275ed08dd11a97">kmpc_micro</a> microtask,...)</td></tr>
<tr class="separator:ga1cab712d076ba1d2758b0c3bf5ffe38a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7b1ba1cc8d9d2fea8654bbb1e59f079e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PARALLEL.html#ga7b1ba1cc8d9d2fea8654bbb1e59f079e">__kmpc_serialized_parallel</a> (<a class="el" href="group__BASIC__TYPES.html#ga690fda6b92f039a72db263c6b4394ddb">ident_t</a> *loc, kmp_int32 global_tid)</td></tr>
<tr class="separator:ga7b1ba1cc8d9d2fea8654bbb1e59f079e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac341818e68b06d910111e4cf08bb54dd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PARALLEL.html#gac341818e68b06d910111e4cf08bb54dd">__kmpc_end_serialized_parallel</a> (<a class="el" href="group__BASIC__TYPES.html#ga690fda6b92f039a72db263c6b4394ddb">ident_t</a> *loc, kmp_int32 global_tid)</td></tr>
<tr class="separator:gac341818e68b06d910111e4cf08bb54dd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>These functions are used for implementing <code>#pragma omp parallel</code>. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="gad6046ca21a94bff569275ed08dd11a97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad6046ca21a94bff569275ed08dd11a97">◆ </a></span>kmpc_micro</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* kmpc_micro) (kmp_int32 *global_tid, kmp_int32 *bound_tid,...)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The type for a microtask which gets passed to <a class="el" href="group__PARALLEL.html#gac2b7cc2fa78dde5381bcf00cfc48d124">__kmpc_fork_call()</a>. The arguments to the outlined function are </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">global_tid</td><td>the global thread identity of the thread executing the function. </td></tr>
<tr><td class="paramname">bound_tid</td><td>the local identitiy of the thread executing the function </td></tr>
<tr><td class="paramname">...</td><td>pointers to shared variables accessed by the function. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="kmp_8h_source.html#l01393">1393</a> of file <a class="el" href="kmp_8h_source.html">kmp.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gac341818e68b06d910111e4cf08bb54dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac341818e68b06d910111e4cf08bb54dd">◆ </a></span>__kmpc_end_serialized_parallel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void __kmpc_end_serialized_parallel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__BASIC__TYPES.html#ga690fda6b92f039a72db263c6b4394ddb">ident_t</a> * </td>
<td class="paramname"><em>loc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kmp_int32 </td>
<td class="paramname"><em>global_tid</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">loc</td><td>source location information </td></tr>
<tr><td class="paramname">global_tid</td><td>global thread number</td></tr>
</table>
</dd>
</dl>
<p>Leave a serialized parallel construct. </p>
<p class="definition">Definition at line <a class="el" href="kmp__csupport_8cpp_source.html#l00451">451</a> of file <a class="el" href="kmp__csupport_8cpp_source.html">kmp_csupport.cpp</a>.</p>
</div>
</div>
<a id="gac2b7cc2fa78dde5381bcf00cfc48d124"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac2b7cc2fa78dde5381bcf00cfc48d124">◆ </a></span>__kmpc_fork_call()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void __kmpc_fork_call </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__BASIC__TYPES.html#ga690fda6b92f039a72db263c6b4394ddb">ident_t</a> * </td>
<td class="paramname"><em>loc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kmp_int32 </td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__PARALLEL.html#gad6046ca21a94bff569275ed08dd11a97">kmpc_micro</a> </td>
<td class="paramname"><em>microtask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">loc</td><td>source location information </td></tr>
<tr><td class="paramname">argc</td><td>total number of arguments in the ellipsis </td></tr>
<tr><td class="paramname">microtask</td><td>pointer to callback routine consisting of outlined parallel construct </td></tr>
<tr><td class="paramname">...</td><td>pointers to shared variables that aren't global</td></tr>
</table>
</dd>
</dl>
<p>Do the actual fork and call the microtask in the relevant number of threads. </p>
<p class="definition">Definition at line <a class="el" href="kmp__csupport_8cpp_source.html#l00264">264</a> of file <a class="el" href="kmp__csupport_8cpp_source.html">kmp_csupport.cpp</a>.</p>
</div>
</div>
<a id="ga1cab712d076ba1d2758b0c3bf5ffe38a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1cab712d076ba1d2758b0c3bf5ffe38a">◆ </a></span>__kmpc_fork_teams()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void __kmpc_fork_teams </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__BASIC__TYPES.html#ga690fda6b92f039a72db263c6b4394ddb">ident_t</a> * </td>
<td class="paramname"><em>loc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kmp_int32 </td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__PARALLEL.html#gad6046ca21a94bff569275ed08dd11a97">kmpc_micro</a> </td>
<td class="paramname"><em>microtask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">loc</td><td>source location information </td></tr>
<tr><td class="paramname">argc</td><td>total number of arguments in the ellipsis </td></tr>
<tr><td class="paramname">microtask</td><td>pointer to callback routine consisting of outlined teams construct </td></tr>
<tr><td class="paramname">...</td><td>pointers to shared variables that aren't global</td></tr>
</table>
</dd>
</dl>
<p>Do the actual fork and call the microtask in the relevant number of threads. </p>
<p class="definition">Definition at line <a class="el" href="kmp__csupport_8cpp_source.html#l00359">359</a> of file <a class="el" href="kmp__csupport_8cpp_source.html">kmp_csupport.cpp</a>.</p>
</div>
</div>
<a id="gaae9462b03457d809faeb3e767a5b2283"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaae9462b03457d809faeb3e767a5b2283">◆ </a></span>__kmpc_push_num_teams()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void __kmpc_push_num_teams </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__BASIC__TYPES.html#ga690fda6b92f039a72db263c6b4394ddb">ident_t</a> * </td>
<td class="paramname"><em>loc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kmp_int32 </td>
<td class="paramname"><em>global_tid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kmp_int32 </td>
<td class="paramname"><em>num_teams</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kmp_int32 </td>
<td class="paramname"><em>num_threads</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">loc</td><td>source location information </td></tr>
<tr><td class="paramname">global_tid</td><td>global thread number </td></tr>
<tr><td class="paramname">num_teams</td><td>number of teams requested for the teams construct </td></tr>
<tr><td class="paramname">num_threads</td><td>number of threads per team requested for the teams construct</td></tr>
</table>
</dd>
</dl>
<p>Set the number of teams to be used by the teams construct. This call is only required if the teams construct has a <code>num_teams</code> clause or a <code>thread_limit</code> clause (or both). </p>
<p class="definition">Definition at line <a class="el" href="kmp__csupport_8cpp_source.html#l00340">340</a> of file <a class="el" href="kmp__csupport_8cpp_source.html">kmp_csupport.cpp</a>.</p>
</div>
</div>
<a id="ga345b3a5866deefefc91ae1e8958f49f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga345b3a5866deefefc91ae1e8958f49f4">◆ </a></span>__kmpc_push_num_threads()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void __kmpc_push_num_threads </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__BASIC__TYPES.html#ga690fda6b92f039a72db263c6b4394ddb">ident_t</a> * </td>
<td class="paramname"><em>loc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kmp_int32 </td>
<td class="paramname"><em>global_tid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kmp_int32 </td>
<td class="paramname"><em>num_threads</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">loc</td><td>source location information </td></tr>
<tr><td class="paramname">global_tid</td><td>global thread number </td></tr>
<tr><td class="paramname">num_threads</td><td>number of threads requested for this parallel construct</td></tr>
</table>
</dd>
</dl>
<p>Set the number of threads to be used by the next fork spawned by this thread. This call is only required if the parallel construct has a <code>num_threads</code> clause. </p>
<p class="definition">Definition at line <a class="el" href="kmp__csupport_8cpp_source.html#l00228">228</a> of file <a class="el" href="kmp__csupport_8cpp_source.html">kmp_csupport.cpp</a>.</p>
</div>
</div>
<a id="ga7b1ba1cc8d9d2fea8654bbb1e59f079e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7b1ba1cc8d9d2fea8654bbb1e59f079e">◆ </a></span>__kmpc_serialized_parallel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void __kmpc_serialized_parallel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__BASIC__TYPES.html#ga690fda6b92f039a72db263c6b4394ddb">ident_t</a> * </td>
<td class="paramname"><em>loc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kmp_int32 </td>
<td class="paramname"><em>global_tid</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">loc</td><td>source location information </td></tr>
<tr><td class="paramname">global_tid</td><td>global thread number</td></tr>
</table>
</dd>
</dl>
<p>Enter a serialized parallel construct. This interface is used to handle a conditional parallel region, like this, </p><div class="fragment"><div class="line"><span class="preprocessor">#pragma omp parallel if (condition)</span></div></div><!-- fragment --><p> when the condition is false. </p>
<p class="definition">Definition at line <a class="el" href="kmp__csupport_8cpp_source.html#l00437">437</a> of file <a class="el" href="kmp__csupport_8cpp_source.html">kmp_csupport.cpp</a>.</p>
</div>
</div>
</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.13
</small></address>
</body>
</html>
|