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
|
<!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): hwloc_backend 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">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="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">hwloc_backend Struct Reference<div class="ingroups"><a class="el" href="a00201.html">Components and Plugins: Discovery backends</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="a00158_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:aaa8eafe495aadd81c2e3c4ec527c10ba"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00316.html#aaa8eafe495aadd81c2e3c4ec527c10ba">flags</a></td></tr>
<tr class="separator:aaa8eafe495aadd81c2e3c4ec527c10ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5209e6508c110dcd4c3c296466f07cb3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00316.html#a5209e6508c110dcd4c3c296466f07cb3">is_custom</a></td></tr>
<tr class="separator:a5209e6508c110dcd4c3c296466f07cb3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab8806f6db077f1bb2e9d63ec99223f7a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00316.html#ab8806f6db077f1bb2e9d63ec99223f7a">is_thissystem</a></td></tr>
<tr class="separator:ab8806f6db077f1bb2e9d63ec99223f7a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ea5bd36b7f06efdb65b98b32af16c68"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00316.html#a2ea5bd36b7f06efdb65b98b32af16c68">private_data</a></td></tr>
<tr class="separator:a2ea5bd36b7f06efdb65b98b32af16c68"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a36c4fa86350525b46340c67b802c69c7"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00316.html#a36c4fa86350525b46340c67b802c69c7">disable</a> )(struct <a class="el" href="a00316.html">hwloc_backend</a> *backend)</td></tr>
<tr class="separator:a36c4fa86350525b46340c67b802c69c7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb9e1dcf68853a65355082b359a3a2d7"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00316.html#aeb9e1dcf68853a65355082b359a3a2d7">discover</a> )(struct <a class="el" href="a00316.html">hwloc_backend</a> *backend)</td></tr>
<tr class="separator:aeb9e1dcf68853a65355082b359a3a2d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab3d1836eeda1970a4c51342df186581e"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00316.html#ab3d1836eeda1970a4c51342df186581e">get_obj_cpuset</a> )(struct <a class="el" href="a00316.html">hwloc_backend</a> *backend, struct <a class="el" href="a00316.html">hwloc_backend</a> *caller, struct <a class="el" href="a00216.html">hwloc_obj</a> *obj, <a class="el" href="a00186.html#gaa3c2bf4c776d603dcebbb61b0c923d84">hwloc_bitmap_t</a> cpuset)</td></tr>
<tr class="separator:ab3d1836eeda1970a4c51342df186581e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a4803e23309be318d7cdb641a5f1037"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00316.html#a5a4803e23309be318d7cdb641a5f1037">notify_new_object</a> )(struct <a class="el" href="a00316.html">hwloc_backend</a> *backend, struct <a class="el" href="a00316.html">hwloc_backend</a> *caller, struct <a class="el" href="a00216.html">hwloc_obj</a> *obj)</td></tr>
<tr class="separator:a5a4803e23309be318d7cdb641a5f1037"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Discovery backend structure. </p>
<p>A backend is the instantiation of a discovery component. When a component gets enabled for a topology, its instantiate() callback creates a backend.</p>
<p><a class="el" href="a00201.html#ga330a0b581de4817d0cf1e7401db22436" title="Allocate a backend structure, set good default values, initialize backend->component and topology...">hwloc_backend_alloc()</a> initializes all fields to default values that the component may change (except "component" and "next") before enabling the backend with <a class="el" href="a00201.html#gaa4edf46c5d88eef53b3b8f572d88b9c5" title="Enable a previously allocated and setup backend. ">hwloc_backend_enable()</a>. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a36c4fa86350525b46340c67b802c69c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36c4fa86350525b46340c67b802c69c7">§ </a></span>disable</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* hwloc_backend::disable) (struct <a class="el" href="a00316.html">hwloc_backend</a> *backend)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback for freeing the private_data. May be NULL. </p>
</div>
</div>
<a id="aeb9e1dcf68853a65355082b359a3a2d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb9e1dcf68853a65355082b359a3a2d7">§ </a></span>discover</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* hwloc_backend::discover) (struct <a class="el" href="a00316.html">hwloc_backend</a> *backend)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Main discovery callback. returns > 0 if it modified the topology tree, -1 on error, 0 otherwise. May be NULL if type is <a class="el" href="a00200.html#gga0dceb95fada01e5e4558429912053ca7aaf4d61f8e2c7c28e88cd81bb565695b7" title="OpenCL, Cuda, etc. ">HWLOC_DISC_COMPONENT_TYPE_MISC</a>. </p>
</div>
</div>
<a id="aaa8eafe495aadd81c2e3c4ec527c10ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa8eafe495aadd81c2e3c4ec527c10ba">§ </a></span>flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long hwloc_backend::flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>Backend flags, as an OR'ed set of <a class="el" href="a00201.html#ga21513209613570877b6bfa9898106f2a" title="Backend flags. ">hwloc_backend_flag_e</a>. </p>
</div>
</div>
<a id="ab3d1836eeda1970a4c51342df186581e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3d1836eeda1970a4c51342df186581e">§ </a></span>get_obj_cpuset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* hwloc_backend::get_obj_cpuset) (struct <a class="el" href="a00316.html">hwloc_backend</a> *backend, struct <a class="el" href="a00316.html">hwloc_backend</a> *caller, struct <a class="el" href="a00216.html">hwloc_obj</a> *obj, <a class="el" href="a00186.html#gaa3c2bf4c776d603dcebbb61b0c923d84">hwloc_bitmap_t</a> cpuset)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback used by the PCI backend to retrieve the locality of a PCI object from the OS/cpu backend. May be NULL. </p>
</div>
</div>
<a id="a5209e6508c110dcd4c3c296466f07cb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5209e6508c110dcd4c3c296466f07cb3">§ </a></span>is_custom</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int hwloc_backend::is_custom</td>
</tr>
</table>
</div><div class="memdoc">
<p>Backend-specific 'is_custom' property. Shortcut on !strcmp(..->component->name, "custom"). Only the custom component should touch this. </p>
</div>
</div>
<a id="ab8806f6db077f1bb2e9d63ec99223f7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8806f6db077f1bb2e9d63ec99223f7a">§ </a></span>is_thissystem</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int hwloc_backend::is_thissystem</td>
</tr>
</table>
</div><div class="memdoc">
<p>Backend-specific 'is_thissystem' property. Set to 0 or 1 if the backend should enforce the thissystem flag when it gets enabled. Set to -1 if the backend doesn't care (default). </p>
</div>
</div>
<a id="a5a4803e23309be318d7cdb641a5f1037"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a4803e23309be318d7cdb641a5f1037">§ </a></span>notify_new_object</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* hwloc_backend::notify_new_object) (struct <a class="el" href="a00316.html">hwloc_backend</a> *backend, struct <a class="el" href="a00316.html">hwloc_backend</a> *caller, struct <a class="el" href="a00216.html">hwloc_obj</a> *obj)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback called by backends to notify this backend that a new object was added. returns > 0 if it modified the topology tree, 0 otherwise. May be NULL. </p>
</div>
</div>
<a id="a2ea5bd36b7f06efdb65b98b32af16c68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ea5bd36b7f06efdb65b98b32af16c68">§ </a></span>private_data</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* hwloc_backend::private_data</td>
</tr>
</table>
</div><div class="memdoc">
<p>Backend private data, or NULL if none. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="a00158_source.html">plugins.h</a></li>
</ul>
</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>
|
