| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 5 |
<meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| 6 |
<meta name="generator" content="Doxygen 1.15.0"/> |
| 7 |
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 8 |
<title>Hardware Locality (hwloc): hwloc_component Struct Reference</title> |
| 9 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 10 |
<script type="text/javascript" src="jquery.js"></script> |
| 11 |
<script type="text/javascript" src="dynsections.js"></script> |
| 12 |
<script type="text/javascript" src="clipboard.js"></script> |
| 13 |
<link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 14 |
</head> |
| 15 |
<body> |
| 16 |
<div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 17 |
<div id="titlearea"> |
| 18 |
<table cellspacing="0" cellpadding="0"> |
| 19 |
<tbody> |
| 20 |
<tr id="projectrow"> |
| 21 |
<td id="projectalign"> |
| 22 |
<div id="projectname">Hardware Locality (hwloc)<span id="projectnumber"> 2.14.0</span> |
| 23 |
</div> |
| 24 |
</td> |
| 25 |
</tr> |
| 26 |
</tbody> |
| 27 |
</table> |
| 28 |
</div> |
| 29 |
<!-- end header part --> |
| 30 |
<!-- Generated by Doxygen 1.15.0 --> |
| 31 |
<script type="text/javascript"> |
| 32 |
$(function() { codefold.init(); }); |
| 33 |
</script> |
| 34 |
<script type="text/javascript" src="menudata.js"></script> |
| 35 |
<script type="text/javascript" src="menu.js"></script> |
| 36 |
<script type="text/javascript"> |
| 37 |
$(function() { |
| 38 |
initMenu('',false,false,'search.php','Search',false); |
| 39 |
}); |
| 40 |
</script> |
| 41 |
<div id="main-nav"></div> |
| 42 |
</div><!-- top --> |
| 43 |
<div id="doc-content"> |
| 44 |
<div class="header"> |
| 45 |
<div class="summary"> |
| 46 |
<a href="#pub-attribs">Data Fields</a> </div> |
| 47 |
<div class="headertitle"><div class="title">hwloc_component Struct Reference<div class="ingroups"><a class="el" href="a00215.html">Components and Plugins: Generic components</a></div></div></div> |
| 48 |
</div><!--header--> |
| 49 |
<div class="contents"> |
| 50 |
|
| 51 |
<p><code>#include <<a class="el" href="a00161_source.html">plugins.h</a>></code></p> |
| 52 |
<table class="memberdecls"> |
| 53 |
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a> |
| 54 |
Data Fields</h2></td></tr> |
| 55 |
<tr class="memitem:a3250bd6fc9713946991d805e48091b2e" id="r_a3250bd6fc9713946991d805e48091b2e"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3250bd6fc9713946991d805e48091b2e">abi</a></td></tr> |
| 56 |
<tr class="memitem:aea613546886d9b8221cadba920fe3ebc" id="r_aea613546886d9b8221cadba920fe3ebc"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="#aea613546886d9b8221cadba920fe3ebc">init</a> )(unsigned long <a class="el" href="#ab8043c5b4cc0e81aabba586ccb194335">flags</a>)</td></tr> |
| 57 |
<tr class="memitem:a4612015451a1c706e8ba19114cb8baae" id="r_a4612015451a1c706e8ba19114cb8baae"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4612015451a1c706e8ba19114cb8baae">finalize</a> )(unsigned long <a class="el" href="#ab8043c5b4cc0e81aabba586ccb194335">flags</a>)</td></tr> |
| 58 |
<tr class="memitem:a789208ada7e17492cfd3a5a88a6bb0ee" id="r_a789208ada7e17492cfd3a5a88a6bb0ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00215.html#ga31a5a455f4e666b936f0a9e8fb9a0f47">hwloc_component_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a789208ada7e17492cfd3a5a88a6bb0ee">type</a></td></tr> |
| 59 |
<tr class="memitem:ab8043c5b4cc0e81aabba586ccb194335" id="r_ab8043c5b4cc0e81aabba586ccb194335"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab8043c5b4cc0e81aabba586ccb194335">flags</a></td></tr> |
| 60 |
<tr class="memitem:a4b8cffd1d943c29fdc102b841b8598d4" id="r_a4b8cffd1d943c29fdc102b841b8598d4"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4b8cffd1d943c29fdc102b841b8598d4">data</a></td></tr> |
| 61 |
</table> |
| 62 |
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2> |
| 63 |
<div class="textblock"><p>Generic component structure. </p> |
| 64 |
<p>Generic components structure, either statically listed by configure in static-components.h or dynamically loaded as a plugin. </p> |
| 65 |
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2> |
| 66 |
<a id="a3250bd6fc9713946991d805e48091b2e" name="a3250bd6fc9713946991d805e48091b2e"></a> |
| 67 |
<h2 class="memtitle"><span class="permalink"><a href="#a3250bd6fc9713946991d805e48091b2e">◆ </a></span>abi</h2> |
| 68 |
|
| 69 |
<div class="memitem"> |
| 70 |
<div class="memproto"> |
| 71 |
<table class="memname"> |
| 72 |
<tr> |
| 73 |
<td class="memname">unsigned hwloc_component::abi</td> |
| 74 |
</tr> |
| 75 |
</table> |
| 76 |
</div><div class="memdoc"> |
| 77 |
|
| 78 |
<p>Component ABI version, set to <a class="el" href="a00165.html#gaac5bc1f46f55e10ef0141a68ce70e21f" title="Current component and plugin ABI version (see hwloc/plugins.h).">HWLOC_COMPONENT_ABI</a>. </p> |
| 79 |
|
| 80 |
</div> |
| 81 |
</div> |
| 82 |
<a id="a4b8cffd1d943c29fdc102b841b8598d4" name="a4b8cffd1d943c29fdc102b841b8598d4"></a> |
| 83 |
<h2 class="memtitle"><span class="permalink"><a href="#a4b8cffd1d943c29fdc102b841b8598d4">◆ </a></span>data</h2> |
| 84 |
|
| 85 |
<div class="memitem"> |
| 86 |
<div class="memproto"> |
| 87 |
<table class="memname"> |
| 88 |
<tr> |
| 89 |
<td class="memname">void* hwloc_component::data</td> |
| 90 |
</tr> |
| 91 |
</table> |
| 92 |
</div><div class="memdoc"> |
| 93 |
|
| 94 |
<p>Component data, pointing to a struct <a class="el" href="a00356.html" title="Discovery component structure.">hwloc_disc_component</a> or struct hwloc_xml_component. </p> |
| 95 |
|
| 96 |
</div> |
| 97 |
</div> |
| 98 |
<a id="a4612015451a1c706e8ba19114cb8baae" name="a4612015451a1c706e8ba19114cb8baae"></a> |
| 99 |
<h2 class="memtitle"><span class="permalink"><a href="#a4612015451a1c706e8ba19114cb8baae">◆ </a></span>finalize</h2> |
| 100 |
|
| 101 |
<div class="memitem"> |
| 102 |
<div class="memproto"> |
| 103 |
<table class="memname"> |
| 104 |
<tr> |
| 105 |
<td class="memname">void(* hwloc_component::finalize) (unsigned long <a class="el" href="#ab8043c5b4cc0e81aabba586ccb194335">flags</a>)</td> |
| 106 |
</tr> |
| 107 |
</table> |
| 108 |
</div><div class="memdoc"> |
| 109 |
|
| 110 |
<p>Process-wide component termination callback. </p> |
| 111 |
<p>This optional callback is called after unregistering the component from the hwloc core (before unloading the plugin).</p> |
| 112 |
<p><code class="param">flags</code> is always 0 for now.</p> |
| 113 |
<dl class="section note"><dt>Note</dt><dd>If the component uses ltdl for loading its own plugins, it should load/unload them only in <a class="el" href="#aea613546886d9b8221cadba920fe3ebc" title="Process-wide component initialization callback.">init()</a> and <a class="el" href="#a4612015451a1c706e8ba19114cb8baae" title="Process-wide component termination callback.">finalize()</a>, to avoid race conditions with hwloc's use of ltdl. </dd></dl> |
| 114 |
|
| 115 |
</div> |
| 116 |
</div> |
| 117 |
<a id="ab8043c5b4cc0e81aabba586ccb194335" name="ab8043c5b4cc0e81aabba586ccb194335"></a> |
| 118 |
<h2 class="memtitle"><span class="permalink"><a href="#ab8043c5b4cc0e81aabba586ccb194335">◆ </a></span>flags</h2> |
| 119 |
|
| 120 |
<div class="memitem"> |
| 121 |
<div class="memproto"> |
| 122 |
<table class="memname"> |
| 123 |
<tr> |
| 124 |
<td class="memname">unsigned long hwloc_component::flags</td> |
| 125 |
</tr> |
| 126 |
</table> |
| 127 |
</div><div class="memdoc"> |
| 128 |
|
| 129 |
<p>Component flags, unused for now. </p> |
| 130 |
|
| 131 |
</div> |
| 132 |
</div> |
| 133 |
<a id="aea613546886d9b8221cadba920fe3ebc" name="aea613546886d9b8221cadba920fe3ebc"></a> |
| 134 |
<h2 class="memtitle"><span class="permalink"><a href="#aea613546886d9b8221cadba920fe3ebc">◆ </a></span>init</h2> |
| 135 |
|
| 136 |
<div class="memitem"> |
| 137 |
<div class="memproto"> |
| 138 |
<table class="memname"> |
| 139 |
<tr> |
| 140 |
<td class="memname">int(* hwloc_component::init) (unsigned long <a class="el" href="#ab8043c5b4cc0e81aabba586ccb194335">flags</a>)</td> |
| 141 |
</tr> |
| 142 |
</table> |
| 143 |
</div><div class="memdoc"> |
| 144 |
|
| 145 |
<p>Process-wide component initialization callback. </p> |
| 146 |
<p>This optional callback is called when the component is registered to the hwloc core (after loading the plugin).</p> |
| 147 |
<p>When the component is built as a plugin, this callback should call hwloc_check_plugin_namespace() and return an negative error code on error.</p> |
| 148 |
<p><code class="param">flags</code> is always 0 for now.</p> |
| 149 |
<dl class="section return"><dt>Returns</dt><dd>0 on success, or a negative code on error.</dd></dl> |
| 150 |
<dl class="section note"><dt>Note</dt><dd>If the component uses ltdl for loading its own plugins, it should load/unload them only in <a class="el" href="#aea613546886d9b8221cadba920fe3ebc" title="Process-wide component initialization callback.">init()</a> and <a class="el" href="#a4612015451a1c706e8ba19114cb8baae" title="Process-wide component termination callback.">finalize()</a>, to avoid race conditions with hwloc's use of ltdl. </dd></dl> |
| 151 |
|
| 152 |
</div> |
| 153 |
</div> |
| 154 |
<a id="a789208ada7e17492cfd3a5a88a6bb0ee" name="a789208ada7e17492cfd3a5a88a6bb0ee"></a> |
| 155 |
<h2 class="memtitle"><span class="permalink"><a href="#a789208ada7e17492cfd3a5a88a6bb0ee">◆ </a></span>type</h2> |
| 156 |
|
| 157 |
<div class="memitem"> |
| 158 |
<div class="memproto"> |
| 159 |
<table class="memname"> |
| 160 |
<tr> |
| 161 |
<td class="memname"><a class="el" href="a00215.html#ga31a5a455f4e666b936f0a9e8fb9a0f47">hwloc_component_type_t</a> hwloc_component::type</td> |
| 162 |
</tr> |
| 163 |
</table> |
| 164 |
</div><div class="memdoc"> |
| 165 |
|
| 166 |
<p>Component type. </p> |
| 167 |
|
| 168 |
</div> |
| 169 |
</div> |
| 170 |
<hr/>The documentation for this struct was generated from the following file:<ul> |
| 171 |
<li><a class="el" href="a00161_source.html">plugins.h</a></li> |
| 172 |
</ul> |
| 173 |
</div><!-- contents --> |
| 174 |
<!-- start footer part --> |
| 175 |
<hr class="footer"/><address class="footer"><small> |
| 176 |
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 |
| 177 |
</small></address> |
| 178 |
</div><!-- doc-content --> |
| 179 |
</body> |
| 180 |
</html> |