/usr/share/doc/libhwloc-doc/html/a00173.html is in libhwloc-doc 1.11.5-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 | <!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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Hardware Locality (hwloc): Components and Plugins: Core functions to be used by components</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! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Hardware Locality (hwloc)
 <span id="projectnumber">1.11.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<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">Components and Plugins: Core functions to be used by components</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:ga1ac8191022b0d3b1bf0070e11d1f1155"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00173.html#ga1ac8191022b0d3b1bf0070e11d1f1155">hwloc_report_error_t</a>) (const char *msg, int line)</td></tr>
<tr class="separator:ga1ac8191022b0d3b1bf0070e11d1f1155"><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:gafd853fd67e12c32916201d8303ef39d2"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="a00186.html">hwloc_obj</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00173.html#gafd853fd67e12c32916201d8303ef39d2">hwloc_insert_object_by_cpuset</a> (struct hwloc_topology *topology, <a class="el" href="a00134.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> obj)</td></tr>
<tr class="separator:gafd853fd67e12c32916201d8303ef39d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3ae154590328522a864f4a7fb453b562"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00173.html#ga3ae154590328522a864f4a7fb453b562">hwloc_report_os_error</a> (const char *msg, int line)</td></tr>
<tr class="separator:ga3ae154590328522a864f4a7fb453b562"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab527c1e0f243f057d31a724794ad9f88"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00173.html#gab527c1e0f243f057d31a724794ad9f88">hwloc_hide_errors</a> (void)</td></tr>
<tr class="separator:gab527c1e0f243f057d31a724794ad9f88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga56d4e5fec377bf09f136b4e8e280e30f"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="a00186.html">hwloc_obj</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00173.html#ga56d4e5fec377bf09f136b4e8e280e30f">hwloc__insert_object_by_cpuset</a> (struct hwloc_topology *topology, <a class="el" href="a00134.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> obj, <a class="el" href="a00173.html#ga1ac8191022b0d3b1bf0070e11d1f1155">hwloc_report_error_t</a> report_error)</td></tr>
<tr class="separator:ga56d4e5fec377bf09f136b4e8e280e30f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0ef97debde503b56367689b07bb3e901"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00173.html#ga0ef97debde503b56367689b07bb3e901">hwloc_insert_object_by_parent</a> (struct hwloc_topology *topology, <a class="el" href="a00134.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> parent, <a class="el" href="a00134.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> obj)</td></tr>
<tr class="separator:ga0ef97debde503b56367689b07bb3e901"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga64d210fcfd7e517095319420bf40ed0a"><td class="memItemLeft" align="right" valign="top">static struct <a class="el" href="a00186.html">hwloc_obj</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00173.html#ga64d210fcfd7e517095319420bf40ed0a">hwloc_alloc_setup_object</a> (<a class="el" href="a00133.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type, signed os_index)</td></tr>
<tr class="separator:ga64d210fcfd7e517095319420bf40ed0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabb240e5b856a34963078ccec9a785ac1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00173.html#gabb240e5b856a34963078ccec9a785ac1">hwloc_fill_object_sets</a> (<a class="el" href="a00134.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> obj)</td></tr>
<tr class="separator:gabb240e5b856a34963078ccec9a785ac1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac2eaed287bb215cf0bd33014e9e1d374"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00173.html#gac2eaed287bb215cf0bd33014e9e1d374">hwloc_plugin_check_namespace</a> (const char *pluginname, const char *symbol)</td></tr>
<tr class="separator:gac2eaed287bb215cf0bd33014e9e1d374"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga1ac8191022b0d3b1bf0070e11d1f1155"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1ac8191022b0d3b1bf0070e11d1f1155">§ </a></span>hwloc_report_error_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* hwloc_report_error_t) (const char *msg, int line)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of error callbacks during object insertion. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga56d4e5fec377bf09f136b4e8e280e30f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga56d4e5fec377bf09f136b4e8e280e30f">§ </a></span>hwloc__insert_object_by_cpuset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="a00186.html">hwloc_obj</a>* hwloc__insert_object_by_cpuset </td>
<td>(</td>
<td class="paramtype">struct hwloc_topology * </td>
<td class="paramname"><em>topology</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00134.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00173.html#ga1ac8191022b0d3b1bf0070e11d1f1155">hwloc_report_error_t</a> </td>
<td class="paramname"><em>report_error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add an object to the topology and specify which error callback to use. </p>
<p>Aside from the error callback selection, this function is identical to <a class="el" href="a00173.html#gafd853fd67e12c32916201d8303ef39d2" title="Add an object to the topology. ">hwloc_insert_object_by_cpuset()</a> </p>
</div>
</div>
<a id="ga64d210fcfd7e517095319420bf40ed0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga64d210fcfd7e517095319420bf40ed0a">§ </a></span>hwloc_alloc_setup_object()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static struct <a class="el" href="a00186.html">hwloc_obj</a>* hwloc_alloc_setup_object </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00133.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">signed </td>
<td class="paramname"><em>os_index</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate and initialize an object of the given type and physical index. </p>
</div>
</div>
<a id="gabb240e5b856a34963078ccec9a785ac1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabb240e5b856a34963078ccec9a785ac1">§ </a></span>hwloc_fill_object_sets()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int hwloc_fill_object_sets </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00134.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Setup object cpusets/nodesets by OR'ing its children. </p>
<p>Used when adding an object late in the topology, after propagating sets up and down. The caller should use this after inserting by cpuset (which means the cpusets is already OK). Typical case: PCI backend adding a hostbridge parent. </p>
</div>
</div>
<a id="gab527c1e0f243f057d31a724794ad9f88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab527c1e0f243f057d31a724794ad9f88">§ </a></span>hwloc_hide_errors()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int hwloc_hide_errors </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether insertion errors are hidden. </p>
</div>
</div>
<a id="gafd853fd67e12c32916201d8303ef39d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafd853fd67e12c32916201d8303ef39d2">§ </a></span>hwloc_insert_object_by_cpuset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="a00186.html">hwloc_obj</a>* hwloc_insert_object_by_cpuset </td>
<td>(</td>
<td class="paramtype">struct hwloc_topology * </td>
<td class="paramname"><em>topology</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00134.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> </td>
<td class="paramname"><em>obj</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add an object to the topology. </p>
<p>It is sorted along the tree of other objects according to the inclusion of cpusets, to eventually be added as a child of the smallest object including this object.</p>
<p>If the cpuset is empty, the type of the object (and maybe some attributes) must be enough to find where to insert the object. This is especially true for NUMA nodes with memory and no CPUs.</p>
<p>The given object should not have children.</p>
<p>This shall only be called before levels are built.</p>
<p>In case of error, <a class="el" href="a00173.html#ga3ae154590328522a864f4a7fb453b562" title="Report an insertion error from a backend. ">hwloc_report_os_error()</a> is called.</p>
<p>Returns the object on success. Returns NULL and frees obj on error. Returns another object and frees obj if it was merged with an identical pre-existing object. </p>
</div>
</div>
<a id="ga0ef97debde503b56367689b07bb3e901"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0ef97debde503b56367689b07bb3e901">§ </a></span>hwloc_insert_object_by_parent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hwloc_insert_object_by_parent </td>
<td>(</td>
<td class="paramtype">struct hwloc_topology * </td>
<td class="paramname"><em>topology</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00134.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> </td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00134.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> </td>
<td class="paramname"><em>obj</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Insert an object somewhere in the topology. </p>
<p>It is added as the last child of the given parent. The cpuset is completely ignored, so strange objects such as I/O devices should preferably be inserted with this.</p>
<p>When used for "normal" children with cpusets (when importing from XML when duplicating a topology), the caller should make sure children are inserted in order.</p>
<p>The given object may have children.</p>
<p>Remember to call topology_connect() afterwards to fix handy pointers. </p>
</div>
</div>
<a id="gac2eaed287bb215cf0bd33014e9e1d374"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac2eaed287bb215cf0bd33014e9e1d374">§ </a></span>hwloc_plugin_check_namespace()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int hwloc_plugin_check_namespace </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pluginname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>symbol</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">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Make sure that plugins can lookup core symbols. </p>
<p>This is a sanity check to avoid lazy-lookup failures when libhwloc is loaded within a plugin, and later tries to load its own plugins. This may fail (and abort the program) if libhwloc symbols are in a private namespace.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd>
<dd>
-1 if the plugin cannot be successfully loaded. The caller plugin init() callback should return a negative error code as well.</dd></dl>
<p>Plugins should call this function in their init() callback to avoid later crashes if lazy symbol resolution is used by the upper layer that loaded hwloc (e.g. OpenCL implementations using dlopen with RTLD_LAZY).</p>
<dl class="section note"><dt>Note</dt><dd>The build system must define HWLOC_INSIDE_PLUGIN if and only if building the caller as a plugin.</dd>
<dd>
This function should remain inline so plugins can call it even when they cannot find libhwloc symbols. </dd></dl>
</div>
</div>
<a id="ga3ae154590328522a864f4a7fb453b562"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3ae154590328522a864f4a7fb453b562">§ </a></span>hwloc_report_os_error()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hwloc_report_os_error </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>line</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Report an insertion error from a backend. </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.12
</small></address>
</body>
</html>
|