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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Hardware Locality (hwloc): hwloc_component Struct 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! -->
<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">2.4.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">hwloc_component Struct Reference<div class="ingroups"><a class="el" href="a00235.html">Components and Plugins: Generic components</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="a00182_source.html">plugins.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a3250bd6fc9713946991d805e48091b2e"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00384.html#a3250bd6fc9713946991d805e48091b2e">abi</a></td></tr>
<tr class="separator:a3250bd6fc9713946991d805e48091b2e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea613546886d9b8221cadba920fe3ebc"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00384.html#aea613546886d9b8221cadba920fe3ebc">init</a> )(unsigned long <a class="el" href="a00384.html#ab8043c5b4cc0e81aabba586ccb194335">flags</a>)</td></tr>
<tr class="separator:aea613546886d9b8221cadba920fe3ebc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4612015451a1c706e8ba19114cb8baae"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00384.html#a4612015451a1c706e8ba19114cb8baae">finalize</a> )(unsigned long <a class="el" href="a00384.html#ab8043c5b4cc0e81aabba586ccb194335">flags</a>)</td></tr>
<tr class="separator:a4612015451a1c706e8ba19114cb8baae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a789208ada7e17492cfd3a5a88a6bb0ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00235.html#ga31a5a455f4e666b936f0a9e8fb9a0f47">hwloc_component_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00384.html#a789208ada7e17492cfd3a5a88a6bb0ee">type</a></td></tr>
<tr class="separator:a789208ada7e17492cfd3a5a88a6bb0ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab8043c5b4cc0e81aabba586ccb194335"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00384.html#ab8043c5b4cc0e81aabba586ccb194335">flags</a></td></tr>
<tr class="separator:ab8043c5b4cc0e81aabba586ccb194335"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b8cffd1d943c29fdc102b841b8598d4"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00384.html#a4b8cffd1d943c29fdc102b841b8598d4">data</a></td></tr>
<tr class="separator:a4b8cffd1d943c29fdc102b841b8598d4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Generic component structure. </p>
<p>Generic components structure, either statically listed by configure in static-components.h or dynamically loaded as a plugin. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a3250bd6fc9713946991d805e48091b2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3250bd6fc9713946991d805e48091b2e">◆ </a></span>abi</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned hwloc_component::abi</td>
</tr>
</table>
</div><div class="memdoc">
<p>Component ABI version, set to <a class="el" href="a00188.html#gaac5bc1f46f55e10ef0141a68ce70e21f" title="Current component and plugin ABI version (see hwloc/plugins.h)">HWLOC_COMPONENT_ABI</a>. </p>
</div>
</div>
<a id="a4b8cffd1d943c29fdc102b841b8598d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b8cffd1d943c29fdc102b841b8598d4">◆ </a></span>data</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* hwloc_component::data</td>
</tr>
</table>
</div><div class="memdoc">
<p>Component data, pointing to a struct <a class="el" href="a00372.html" title="Discovery component structure.">hwloc_disc_component</a> or struct hwloc_xml_component. </p>
</div>
</div>
<a id="a4612015451a1c706e8ba19114cb8baae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4612015451a1c706e8ba19114cb8baae">◆ </a></span>finalize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* hwloc_component::finalize) (unsigned long <a class="el" href="a00384.html#ab8043c5b4cc0e81aabba586ccb194335">flags</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Process-wide component termination callback. </p>
<p>This optional callback is called after unregistering the component from the hwloc core (before unloading the plugin).</p>
<p><code>flags</code> is always 0 for now.</p>
<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="a00384.html#aea613546886d9b8221cadba920fe3ebc" title="Process-wide component initialization callback.">init()</a> and <a class="el" href="a00384.html#a4612015451a1c706e8ba19114cb8baae" title="Process-wide component termination callback.">finalize()</a>, to avoid race conditions with hwloc's use of ltdl. </dd></dl>
</div>
</div>
<a id="ab8043c5b4cc0e81aabba586ccb194335"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8043c5b4cc0e81aabba586ccb194335">◆ </a></span>flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long hwloc_component::flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>Component flags, unused for now. </p>
</div>
</div>
<a id="aea613546886d9b8221cadba920fe3ebc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea613546886d9b8221cadba920fe3ebc">◆ </a></span>init</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* hwloc_component::init) (unsigned long <a class="el" href="a00384.html#ab8043c5b4cc0e81aabba586ccb194335">flags</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Process-wide component initialization callback. </p>
<p>This optional callback is called when the component is registered to the hwloc core (after loading the plugin).</p>
<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>
<p><code>flags</code> is always 0 for now.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, or a negative code on error.</dd></dl>
<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="a00384.html#aea613546886d9b8221cadba920fe3ebc" title="Process-wide component initialization callback.">init()</a> and <a class="el" href="a00384.html#a4612015451a1c706e8ba19114cb8baae" title="Process-wide component termination callback.">finalize()</a>, to avoid race conditions with hwloc's use of ltdl. </dd></dl>
</div>
</div>
<a id="a789208ada7e17492cfd3a5a88a6bb0ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a789208ada7e17492cfd3a5a88a6bb0ee">◆ </a></span>type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00235.html#ga31a5a455f4e666b936f0a9e8fb9a0f47">hwloc_component_type_t</a> hwloc_component::type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Component type. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="a00182_source.html">plugins.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
|
