Debian Codegraph @

doc/doxygen-doc/html/a00364.html

raw
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_backend 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">&#160;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_backend Struct Reference<div class="ingroups"><a class="el" href="a00214.html">Components and Plugins: Discovery components and backends</a></div></div></div>
48 </div><!--header-->
49 <div class="contents">
50
51 <p><code>#include &lt;<a class="el" href="a00161_source.html">plugins.h</a>&gt;</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:aeca769840a6ff03e96462a9533adbccd" id="r_aeca769840a6ff03e96462a9533adbccd"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aeca769840a6ff03e96462a9533adbccd">phases</a></td></tr>
56 <tr class="memitem:aaa8eafe495aadd81c2e3c4ec527c10ba" id="r_aaa8eafe495aadd81c2e3c4ec527c10ba"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaa8eafe495aadd81c2e3c4ec527c10ba">flags</a></td></tr>
57 <tr class="memitem:ab8806f6db077f1bb2e9d63ec99223f7a" id="r_ab8806f6db077f1bb2e9d63ec99223f7a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab8806f6db077f1bb2e9d63ec99223f7a">is_thissystem</a></td></tr>
58 <tr class="memitem:a2ea5bd36b7f06efdb65b98b32af16c68" id="r_a2ea5bd36b7f06efdb65b98b32af16c68"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2ea5bd36b7f06efdb65b98b32af16c68">private_data</a></td></tr>
59 <tr class="memitem:a36c4fa86350525b46340c67b802c69c7" id="r_a36c4fa86350525b46340c67b802c69c7"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a36c4fa86350525b46340c67b802c69c7">disable</a> )(struct <a class="el" href="a00364.html">hwloc_backend</a> *backend)</td></tr>
60 <tr class="memitem:accff2cd8404be43c3b44cec05e6f609b" id="r_accff2cd8404be43c3b44cec05e6f609b"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#accff2cd8404be43c3b44cec05e6f609b">discover</a> )(struct <a class="el" href="a00364.html">hwloc_backend</a> *backend, struct <a class="el" href="a00360.html">hwloc_disc_status</a> *status)</td></tr>
61 <tr class="memitem:aaac253491264c20930f44817270bc502" id="r_aaac253491264c20930f44817270bc502"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaac253491264c20930f44817270bc502">get_pci_busid_cpuset</a> )(struct <a class="el" href="a00364.html">hwloc_backend</a> *backend, struct hwloc_pcidev_attr_s *busid, <a class="el" href="a00188.html#gaa3c2bf4c776d603dcebbb61b0c923d84">hwloc_bitmap_t</a> cpuset)</td></tr>
62 </table>
63 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
64 <div class="textblock"><p>Discovery backend structure. </p>
65 <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>
66 <p><a class="el" href="a00214.html#ga6118a1009aa390c13255a330ccf253cf" title="Allocate a backend structure, set good default values, initialize backend-&gt;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="a00214.html#ga4715779d7191833e9b1a7490989a7497" title="Enable a previously allocated and setup backend.">hwloc_backend_enable()</a>.</p>
67 <p>Most backends assume that the topology is_thissystem flag is set because they talk to the underlying operating system. However they may still be used in topologies without the is_thissystem flag for debugging reasons. In practice, they are usually auto-disabled in such cases (excluded by xml or synthetic backends, or by environment variables when changing the Linux fsroot or the x86 cpuid path). </p>
68 </div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
69 <a id="a36c4fa86350525b46340c67b802c69c7" name="a36c4fa86350525b46340c67b802c69c7"></a>
70 <h2 class="memtitle"><span class="permalink"><a href="#a36c4fa86350525b46340c67b802c69c7">&#9670;&#160;</a></span>disable</h2>
71
72 <div class="memitem">
73 <div class="memproto">
74 <table class="memname">
75 <tr>
76 <td class="memname">void(* hwloc_backend::disable) (struct <a class="el" href="a00364.html">hwloc_backend</a> *backend)</td>
77 </tr>
78 </table>
79 </div><div class="memdoc">
80
81 <p>Callback for freeing the private_data. May be NULL. </p>
82
83 </div>
84 </div>
85 <a id="accff2cd8404be43c3b44cec05e6f609b" name="accff2cd8404be43c3b44cec05e6f609b"></a>
86 <h2 class="memtitle"><span class="permalink"><a href="#accff2cd8404be43c3b44cec05e6f609b">&#9670;&#160;</a></span>discover</h2>
87
88 <div class="memitem">
89 <div class="memproto">
90 <table class="memname">
91 <tr>
92 <td class="memname">int(* hwloc_backend::discover) (struct <a class="el" href="a00364.html">hwloc_backend</a> *backend, struct <a class="el" href="a00360.html">hwloc_disc_status</a> *status)</td>
93 </tr>
94 </table>
95 </div><div class="memdoc">
96
97 <p>Main discovery callback. returns -1 on error, either because it couldn't add its objects ot the existing topology, or because of an actual discovery/gathering failure. May be NULL. </p>
98
99 </div>
100 </div>
101 <a id="aaa8eafe495aadd81c2e3c4ec527c10ba" name="aaa8eafe495aadd81c2e3c4ec527c10ba"></a>
102 <h2 class="memtitle"><span class="permalink"><a href="#aaa8eafe495aadd81c2e3c4ec527c10ba">&#9670;&#160;</a></span>flags</h2>
103
104 <div class="memitem">
105 <div class="memproto">
106 <table class="memname">
107 <tr>
108 <td class="memname">unsigned long hwloc_backend::flags</td>
109 </tr>
110 </table>
111 </div><div class="memdoc">
112
113 <p>Backend flags, currently always 0. </p>
114
115 </div>
116 </div>
117 <a id="aaac253491264c20930f44817270bc502" name="aaac253491264c20930f44817270bc502"></a>
118 <h2 class="memtitle"><span class="permalink"><a href="#aaac253491264c20930f44817270bc502">&#9670;&#160;</a></span>get_pci_busid_cpuset</h2>
119
120 <div class="memitem">
121 <div class="memproto">
122 <table class="memname">
123 <tr>
124 <td class="memname">int(* hwloc_backend::get_pci_busid_cpuset) (struct <a class="el" href="a00364.html">hwloc_backend</a> *backend, struct hwloc_pcidev_attr_s *busid, <a class="el" href="a00188.html#gaa3c2bf4c776d603dcebbb61b0c923d84">hwloc_bitmap_t</a> cpuset)</td>
125 </tr>
126 </table>
127 </div><div class="memdoc">
128
129 <p>Callback to retrieve the locality of a PCI object. Called by the PCI core when attaching PCI hierarchy to CPU objects. May be NULL. </p>
130
131 </div>
132 </div>
133 <a id="ab8806f6db077f1bb2e9d63ec99223f7a" name="ab8806f6db077f1bb2e9d63ec99223f7a"></a>
134 <h2 class="memtitle"><span class="permalink"><a href="#ab8806f6db077f1bb2e9d63ec99223f7a">&#9670;&#160;</a></span>is_thissystem</h2>
135
136 <div class="memitem">
137 <div class="memproto">
138 <table class="memname">
139 <tr>
140 <td class="memname">int hwloc_backend::is_thissystem</td>
141 </tr>
142 </table>
143 </div><div class="memdoc">
144
145 <p>Backend-specific 'is_thissystem' property. Set to 0 if the backend disables the thissystem flag for this topology (e.g. loading from xml or synthetic string, or using a different fsroot on Linux, or a x86 CPUID dump). Set to -1 if the backend doesn't care (default). </p>
146
147 </div>
148 </div>
149 <a id="aeca769840a6ff03e96462a9533adbccd" name="aeca769840a6ff03e96462a9533adbccd"></a>
150 <h2 class="memtitle"><span class="permalink"><a href="#aeca769840a6ff03e96462a9533adbccd">&#9670;&#160;</a></span>phases</h2>
151
152 <div class="memitem">
153 <div class="memproto">
154 <table class="memname">
155 <tr>
156 <td class="memname">unsigned hwloc_backend::phases</td>
157 </tr>
158 </table>
159 </div><div class="memdoc">
160
161 <p>Discovery phases performed by this component, possibly without some of them if excluded by other components. OR'ed set of <a class="el" href="a00214.html#ga600bba1a62022d5f516800649b1edb61" title="Discovery phase.">hwloc_disc_phase_t</a>. </p>
162
163 </div>
164 </div>
165 <a id="a2ea5bd36b7f06efdb65b98b32af16c68" name="a2ea5bd36b7f06efdb65b98b32af16c68"></a>
166 <h2 class="memtitle"><span class="permalink"><a href="#a2ea5bd36b7f06efdb65b98b32af16c68">&#9670;&#160;</a></span>private_data</h2>
167
168 <div class="memitem">
169 <div class="memproto">
170 <table class="memname">
171 <tr>
172 <td class="memname">void* hwloc_backend::private_data</td>
173 </tr>
174 </table>
175 </div><div class="memdoc">
176
177 <p>Backend private data, or NULL if none. </p>
178
179 </div>
180 </div>
181 <hr/>The documentation for this struct was generated from the following file:<ul>
182 <li><a class="el" href="a00161_source.html">plugins.h</a></li>
183 </ul>
184 </div><!-- contents -->
185 <!-- start footer part -->
186 <hr class="footer"/><address class="footer"><small>
187 Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0
188 </small></address>
189 </div><!-- doc-content -->
190 </body>
191 </html>