Debian Codegraph @

doc/doxygen-doc/html/a00214.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): Components and Plugins: Discovery components and backends</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="#nested-classes">Data Structures</a> &#124;
47 <a href="#typedef-members">Typedefs</a> &#124;
48 <a href="#enum-members">Enumerations</a> &#124;
49 <a href="#func-members">Functions</a> </div>
50 <div class="headertitle"><div class="title">Components and Plugins: Discovery components and backends </div></div>
51 </div><!--header-->
52 <div class="contents">
53 <table class="memberdecls">
54 <tr class="heading"><td colspan="2"><h2 id="header-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
55 Data Structures</h2></td></tr>
56 <tr class="memitem:hwloc_5Fdisc_5Fcomponent" id="r_hwloc_5Fdisc_5Fcomponent"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00356.html">hwloc_disc_component</a></td></tr>
57 <tr class="memitem:hwloc_5Fdisc_5Fstatus" id="r_hwloc_5Fdisc_5Fstatus"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00360.html">hwloc_disc_status</a></td></tr>
58 <tr class="memitem:hwloc_5Fbackend" id="r_hwloc_5Fbackend"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00364.html">hwloc_backend</a></td></tr>
59 </table><table class="memberdecls">
60 <tr class="heading"><td colspan="2"><h2 id="header-typedef-members" class="groupheader"><a id="typedef-members" name="typedef-members"></a>
61 Typedefs</h2></td></tr>
62 <tr class="memitem:ga600bba1a62022d5f516800649b1edb61" id="r_ga600bba1a62022d5f516800649b1edb61"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="#ga8c314121c2fc478161bcce758688b9a1">hwloc_disc_phase_e</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga600bba1a62022d5f516800649b1edb61">hwloc_disc_phase_t</a></td></tr>
63 </table><table class="memberdecls">
64 <tr class="heading"><td colspan="2"><h2 id="header-enum-members" class="groupheader"><a id="enum-members" name="enum-members"></a>
65 Enumerations</h2></td></tr>
66 <tr class="memitem:ga8c314121c2fc478161bcce758688b9a1" id="r_ga8c314121c2fc478161bcce758688b9a1"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8c314121c2fc478161bcce758688b9a1">hwloc_disc_phase_e</a> { <br />
67 &#160;&#160;<a class="el" href="#gga8c314121c2fc478161bcce758688b9a1ab41c626c79e9ccb1e7d41e7076972283">HWLOC_DISC_PHASE_GLOBAL</a>
68 , <a class="el" href="#gga8c314121c2fc478161bcce758688b9a1a6360474df197027761a69bd5fc620250">HWLOC_DISC_PHASE_CPU</a>
69 , <a class="el" href="#gga8c314121c2fc478161bcce758688b9a1ac4264a243844c5fbbff495cdb1b4d51d">HWLOC_DISC_PHASE_MEMORY</a>
70 , <a class="el" href="#gga8c314121c2fc478161bcce758688b9a1a677c52064dd987af4988346319b3675a">HWLOC_DISC_PHASE_PCI</a>
71 , <br />
72 &#160;&#160;<a class="el" href="#gga8c314121c2fc478161bcce758688b9a1aa8e10626cba9af72f5605a1acbdc0015">HWLOC_DISC_PHASE_IO</a>
73 , <a class="el" href="#gga8c314121c2fc478161bcce758688b9a1a8a7cde9bff0ab0d085b102a3e934939b">HWLOC_DISC_PHASE_MISC</a>
74 , <a class="el" href="#gga8c314121c2fc478161bcce758688b9a1a68ca5c7ad75a6d9e5355689411621773">HWLOC_DISC_PHASE_ANNOTATE</a>
75 , <a class="el" href="#gga8c314121c2fc478161bcce758688b9a1ada3ed3f00e74909353d6ea4a96cde5ad">HWLOC_DISC_PHASE_TWEAK</a>
76 <br />
77 }</td></tr>
78 <tr class="memitem:gaae1b38cf9b12e489884ce2a07275964b" id="r_gaae1b38cf9b12e489884ce2a07275964b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaae1b38cf9b12e489884ce2a07275964b">hwloc_disc_status_flag_e</a> { <a class="el" href="#ggaae1b38cf9b12e489884ce2a07275964ba205d644d54a0840bd9165fce7d19e6b1">HWLOC_DISC_STATUS_FLAG_GOT_ALLOWED_RESOURCES</a>
79 }</td></tr>
80 </table><table class="memberdecls">
81 <tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
82 Functions</h2></td></tr>
83 <tr class="memitem:ga6118a1009aa390c13255a330ccf253cf" id="r_ga6118a1009aa390c13255a330ccf253cf"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="a00364.html">hwloc_backend</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga6118a1009aa390c13255a330ccf253cf">hwloc_backend_alloc</a> (struct hwloc_topology *topology, struct <a class="el" href="a00356.html">hwloc_disc_component</a> *component)</td></tr>
84 <tr class="memitem:ga4715779d7191833e9b1a7490989a7497" id="r_ga4715779d7191833e9b1a7490989a7497"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4715779d7191833e9b1a7490989a7497">hwloc_backend_enable</a> (struct <a class="el" href="a00364.html">hwloc_backend</a> *backend)</td></tr>
85 </table>
86 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
87 <dl class="section note"><dt>Note</dt><dd>These structures and functions may change when <a class="el" href="a00165.html#gaac5bc1f46f55e10ef0141a68ce70e21f" title="Current component and plugin ABI version (see hwloc/plugins.h).">HWLOC_COMPONENT_ABI</a> is modified. </dd></dl>
88 <a name="doc-typedef-members" id="doc-typedef-members"></a><h2 id="header-doc-typedef-members" class="groupheader">Typedef Documentation</h2>
89 <a id="ga600bba1a62022d5f516800649b1edb61" name="ga600bba1a62022d5f516800649b1edb61"></a>
90 <h2 class="memtitle"><span class="permalink"><a href="#ga600bba1a62022d5f516800649b1edb61">&#9670;&#160;</a></span>hwloc_disc_phase_t</h2>
91
92 <div class="memitem">
93 <div class="memproto">
94 <table class="memname">
95 <tr>
96 <td class="memname">typedef enum <a class="el" href="#ga8c314121c2fc478161bcce758688b9a1">hwloc_disc_phase_e</a> <a class="el" href="#ga600bba1a62022d5f516800649b1edb61">hwloc_disc_phase_t</a></td>
97 </tr>
98 </table>
99 </div><div class="memdoc">
100
101 <p>Discovery phase. </p>
102
103 </div>
104 </div>
105 <a name="doc-enum-members" id="doc-enum-members"></a><h2 id="header-doc-enum-members" class="groupheader">Enumeration Type Documentation</h2>
106 <a id="ga8c314121c2fc478161bcce758688b9a1" name="ga8c314121c2fc478161bcce758688b9a1"></a>
107 <h2 class="memtitle"><span class="permalink"><a href="#ga8c314121c2fc478161bcce758688b9a1">&#9670;&#160;</a></span>hwloc_disc_phase_e</h2>
108
109 <div class="memitem">
110 <div class="memproto">
111 <table class="memname">
112 <tr>
113 <td class="memname">enum <a class="el" href="#ga8c314121c2fc478161bcce758688b9a1">hwloc_disc_phase_e</a></td>
114 </tr>
115 </table>
116 </div><div class="memdoc">
117
118 <p>Discovery phase. </p>
119 <table class="fieldtable">
120 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga8c314121c2fc478161bcce758688b9a1ab41c626c79e9ccb1e7d41e7076972283" name="gga8c314121c2fc478161bcce758688b9a1ab41c626c79e9ccb1e7d41e7076972283"></a>HWLOC_DISC_PHASE_GLOBAL&#160;</td><td class="fielddoc"><p>xml or synthetic, platform-specific components such as bgq. Discovers everything including CPU, memory, I/O and everything else. A component with a Global phase usually excludes all other phases. </p>
121 </td></tr>
122 <tr><td class="fieldname"><a id="gga8c314121c2fc478161bcce758688b9a1a6360474df197027761a69bd5fc620250" name="gga8c314121c2fc478161bcce758688b9a1a6360474df197027761a69bd5fc620250"></a>HWLOC_DISC_PHASE_CPU&#160;</td><td class="fielddoc"><p>CPU discovery. </p>
123 </td></tr>
124 <tr><td class="fieldname"><a id="gga8c314121c2fc478161bcce758688b9a1ac4264a243844c5fbbff495cdb1b4d51d" name="gga8c314121c2fc478161bcce758688b9a1ac4264a243844c5fbbff495cdb1b4d51d"></a>HWLOC_DISC_PHASE_MEMORY&#160;</td><td class="fielddoc"><p>Attach memory to existing CPU objects. </p>
125 </td></tr>
126 <tr><td class="fieldname"><a id="gga8c314121c2fc478161bcce758688b9a1a677c52064dd987af4988346319b3675a" name="gga8c314121c2fc478161bcce758688b9a1a677c52064dd987af4988346319b3675a"></a>HWLOC_DISC_PHASE_PCI&#160;</td><td class="fielddoc"><p>Attach PCI devices and bridges to existing CPU objects. </p>
127 </td></tr>
128 <tr><td class="fieldname"><a id="gga8c314121c2fc478161bcce758688b9a1aa8e10626cba9af72f5605a1acbdc0015" name="gga8c314121c2fc478161bcce758688b9a1aa8e10626cba9af72f5605a1acbdc0015"></a>HWLOC_DISC_PHASE_IO&#160;</td><td class="fielddoc"><p>I/O discovery that requires PCI devices (OS devices such as OpenCL, CUDA, etc.). </p>
129 </td></tr>
130 <tr><td class="fieldname"><a id="gga8c314121c2fc478161bcce758688b9a1a8a7cde9bff0ab0d085b102a3e934939b" name="gga8c314121c2fc478161bcce758688b9a1a8a7cde9bff0ab0d085b102a3e934939b"></a>HWLOC_DISC_PHASE_MISC&#160;</td><td class="fielddoc"><p>Misc objects that gets added below anything else. </p>
131 </td></tr>
132 <tr><td class="fieldname"><a id="gga8c314121c2fc478161bcce758688b9a1a68ca5c7ad75a6d9e5355689411621773" name="gga8c314121c2fc478161bcce758688b9a1a68ca5c7ad75a6d9e5355689411621773"></a>HWLOC_DISC_PHASE_ANNOTATE&#160;</td><td class="fielddoc"><p>Annotating existing objects, adding distances, etc. </p>
133 </td></tr>
134 <tr><td class="fieldname"><a id="gga8c314121c2fc478161bcce758688b9a1ada3ed3f00e74909353d6ea4a96cde5ad" name="gga8c314121c2fc478161bcce758688b9a1ada3ed3f00e74909353d6ea4a96cde5ad"></a>HWLOC_DISC_PHASE_TWEAK&#160;</td><td class="fielddoc"><p>Final tweaks to a ready-to-use topology. This phase runs once the topology is loaded, before it is returned to the topology. Hence it may only use the main hwloc API for modifying the topology, for instance by restricting it, adding info attributes, etc. </p>
135 </td></tr>
136 </table>
137
138 </div>
139 </div>
140 <a id="gaae1b38cf9b12e489884ce2a07275964b" name="gaae1b38cf9b12e489884ce2a07275964b"></a>
141 <h2 class="memtitle"><span class="permalink"><a href="#gaae1b38cf9b12e489884ce2a07275964b">&#9670;&#160;</a></span>hwloc_disc_status_flag_e</h2>
142
143 <div class="memitem">
144 <div class="memproto">
145 <table class="memname">
146 <tr>
147 <td class="memname">enum <a class="el" href="#gaae1b38cf9b12e489884ce2a07275964b">hwloc_disc_status_flag_e</a></td>
148 </tr>
149 </table>
150 </div><div class="memdoc">
151
152 <p>Discovery status flags. </p>
153 <table class="fieldtable">
154 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaae1b38cf9b12e489884ce2a07275964ba205d644d54a0840bd9165fce7d19e6b1" name="ggaae1b38cf9b12e489884ce2a07275964ba205d644d54a0840bd9165fce7d19e6b1"></a>HWLOC_DISC_STATUS_FLAG_GOT_ALLOWED_RESOURCES&#160;</td><td class="fielddoc"><p>The sets of allowed resources were already retrieved. </p>
155 </td></tr>
156 </table>
157
158 </div>
159 </div>
160 <a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
161 <a id="ga6118a1009aa390c13255a330ccf253cf" name="ga6118a1009aa390c13255a330ccf253cf"></a>
162 <h2 class="memtitle"><span class="permalink"><a href="#ga6118a1009aa390c13255a330ccf253cf">&#9670;&#160;</a></span>hwloc_backend_alloc()</h2>
163
164 <div class="memitem">
165 <div class="memproto">
166 <table class="memname">
167 <tr>
168 <td class="memname">struct <a class="el" href="a00364.html">hwloc_backend</a> * hwloc_backend_alloc </td>
169 <td>(</td>
170 <td class="paramtype">struct hwloc_topology *</td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
171 </tr>
172 <tr>
173 <td class="paramkey"></td>
174 <td></td>
175 <td class="paramtype">struct <a class="el" href="a00356.html">hwloc_disc_component</a> *</td> <td class="paramname"><span class="paramname"><em>component</em></span>&#160;)</td>
176 </tr>
177 </table>
178 </div><div class="memdoc">
179
180 <p>Allocate a backend structure, set good default values, initialize backend-&gt;component and topology, etc. The caller will then modify whatever needed, and call <a class="el" href="#ga4715779d7191833e9b1a7490989a7497" title="Enable a previously allocated and setup backend.">hwloc_backend_enable()</a>. </p>
181
182 </div>
183 </div>
184 <a id="ga4715779d7191833e9b1a7490989a7497" name="ga4715779d7191833e9b1a7490989a7497"></a>
185 <h2 class="memtitle"><span class="permalink"><a href="#ga4715779d7191833e9b1a7490989a7497">&#9670;&#160;</a></span>hwloc_backend_enable()</h2>
186
187 <div class="memitem">
188 <div class="memproto">
189 <table class="memname">
190 <tr>
191 <td class="memname">int hwloc_backend_enable </td>
192 <td>(</td>
193 <td class="paramtype">struct <a class="el" href="a00364.html">hwloc_backend</a> *</td> <td class="paramname"><span class="paramname"><em>backend</em></span></td><td>)</td>
194 <td></td>
195 </tr>
196 </table>
197 </div><div class="memdoc">
198
199 <p>Enable a previously allocated and setup backend. </p>
200
201 </div>
202 </div>
203 </div><!-- contents -->
204 <!-- start footer part -->
205 <hr class="footer"/><address class="footer"><small>
206 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
207 </small></address>
208 </div><!-- doc-content -->
209 </body>
210 </html>