Debian Codegraph @

doc/doxygen-doc/html/a00187.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): Finding I/O objects</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="#func-members">Functions</a> </div>
47 <div class="headertitle"><div class="title">Finding I/O objects </div></div>
48 </div><!--header-->
49 <div class="contents">
50 <table class="memberdecls">
51 <tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
52 Functions</h2></td></tr>
53 <tr class="memitem:ga82a8321fa0f49761cba90201e240c988" id="r_ga82a8321fa0f49761cba90201e240c988"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga82a8321fa0f49761cba90201e240c988">hwloc_get_non_io_ancestor_obj</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> ioobj)</td></tr>
54 <tr class="memitem:ga3725914ece79405c831f11f06ca1fabe" id="r_ga3725914ece79405c831f11f06ca1fabe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3725914ece79405c831f11f06ca1fabe">hwloc_get_next_pcidev</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> prev)</td></tr>
55 <tr class="memitem:ga07532867d72b87ace39aeee2bb407b66" id="r_ga07532867d72b87ace39aeee2bb407b66"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga07532867d72b87ace39aeee2bb407b66">hwloc_get_pcidev_by_busid</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, unsigned domain, unsigned bus, unsigned dev, unsigned func)</td></tr>
56 <tr class="memitem:gaf463491f6dcef8591c19a0b606c97796" id="r_gaf463491f6dcef8591c19a0b606c97796"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf463491f6dcef8591c19a0b606c97796">hwloc_get_pcidev_by_busidstring</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, const char *busid)</td></tr>
57 <tr class="memitem:ga17bba843ffa24978505961f104ee2efb" id="r_ga17bba843ffa24978505961f104ee2efb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga17bba843ffa24978505961f104ee2efb">hwloc_get_next_osdev</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> prev)</td></tr>
58 <tr class="memitem:ga1563399cce826b220190b693818d50cc" id="r_ga1563399cce826b220190b693818d50cc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1563399cce826b220190b693818d50cc">hwloc_get_next_bridge</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> prev)</td></tr>
59 <tr class="memitem:gae7732d287b98657a6b369c32d59d81b6" id="r_gae7732d287b98657a6b369c32d59d81b6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gae7732d287b98657a6b369c32d59d81b6">hwloc_bridge_covers_pcibus</a> (<a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> bridge, unsigned domain, unsigned bus)</td></tr>
60 </table>
61 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
62 <a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
63 <a id="gae7732d287b98657a6b369c32d59d81b6" name="gae7732d287b98657a6b369c32d59d81b6"></a>
64 <h2 class="memtitle"><span class="permalink"><a href="#gae7732d287b98657a6b369c32d59d81b6">&#9670;&#160;</a></span>hwloc_bridge_covers_pcibus()</h2>
65
66 <div class="memitem">
67 <div class="memproto">
68 <table class="mlabels">
69 <tr>
70 <td class="mlabels-left">
71 <table class="memname">
72 <tr>
73 <td class="memname">int hwloc_bridge_covers_pcibus </td>
74 <td>(</td>
75 <td class="paramtype"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a></td> <td class="paramname"><span class="paramname"><em>bridge</em></span>, </td>
76 </tr>
77 <tr>
78 <td class="paramkey"></td>
79 <td></td>
80 <td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>domain</em></span>, </td>
81 </tr>
82 <tr>
83 <td class="paramkey"></td>
84 <td></td>
85 <td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>bus</em></span>&#160;)</td>
86 </tr>
87 </table>
88 </td>
89 <td class="mlabels-right">
90 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
91 </tr>
92 </table>
93 </div><div class="memdoc">
94
95 </div>
96 </div>
97 <a id="ga1563399cce826b220190b693818d50cc" name="ga1563399cce826b220190b693818d50cc"></a>
98 <h2 class="memtitle"><span class="permalink"><a href="#ga1563399cce826b220190b693818d50cc">&#9670;&#160;</a></span>hwloc_get_next_bridge()</h2>
99
100 <div class="memitem">
101 <div class="memproto">
102 <table class="mlabels">
103 <tr>
104 <td class="mlabels-left">
105 <table class="memname">
106 <tr>
107 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_next_bridge </td>
108 <td>(</td>
109 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
110 </tr>
111 <tr>
112 <td class="paramkey"></td>
113 <td></td>
114 <td class="paramtype"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a></td> <td class="paramname"><span class="paramname"><em>prev</em></span>&#160;)</td>
115 </tr>
116 </table>
117 </td>
118 <td class="mlabels-right">
119 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
120 </tr>
121 </table>
122 </div><div class="memdoc">
123
124 <p>Get the next bridge in the system. </p>
125 <dl class="section return"><dt>Returns</dt><dd>the first bridge if <code class="param">prev</code> is <code>NULL</code>. </dd>
126 <dd>
127 the next bridge if <code class="param">prev</code> is not <code>NULL</code>. </dd>
128 <dd>
129 <code>NULL</code> if there is no next bridge. </dd></dl>
130
131 </div>
132 </div>
133 <a id="ga17bba843ffa24978505961f104ee2efb" name="ga17bba843ffa24978505961f104ee2efb"></a>
134 <h2 class="memtitle"><span class="permalink"><a href="#ga17bba843ffa24978505961f104ee2efb">&#9670;&#160;</a></span>hwloc_get_next_osdev()</h2>
135
136 <div class="memitem">
137 <div class="memproto">
138 <table class="mlabels">
139 <tr>
140 <td class="mlabels-left">
141 <table class="memname">
142 <tr>
143 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_next_osdev </td>
144 <td>(</td>
145 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
146 </tr>
147 <tr>
148 <td class="paramkey"></td>
149 <td></td>
150 <td class="paramtype"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a></td> <td class="paramname"><span class="paramname"><em>prev</em></span>&#160;)</td>
151 </tr>
152 </table>
153 </td>
154 <td class="mlabels-right">
155 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
156 </tr>
157 </table>
158 </div><div class="memdoc">
159
160 <p>Get the next OS device in the system. </p>
161 <dl class="section return"><dt>Returns</dt><dd>the first OS device if <code class="param">prev</code> is <code>NULL</code>. </dd>
162 <dd>
163 the next OS device if <code class="param">prev</code> is not <code>NULL</code>. </dd>
164 <dd>
165 <code>NULL</code> if there is no next OS device. </dd></dl>
166
167 </div>
168 </div>
169 <a id="ga3725914ece79405c831f11f06ca1fabe" name="ga3725914ece79405c831f11f06ca1fabe"></a>
170 <h2 class="memtitle"><span class="permalink"><a href="#ga3725914ece79405c831f11f06ca1fabe">&#9670;&#160;</a></span>hwloc_get_next_pcidev()</h2>
171
172 <div class="memitem">
173 <div class="memproto">
174 <table class="mlabels">
175 <tr>
176 <td class="mlabels-left">
177 <table class="memname">
178 <tr>
179 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_next_pcidev </td>
180 <td>(</td>
181 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
182 </tr>
183 <tr>
184 <td class="paramkey"></td>
185 <td></td>
186 <td class="paramtype"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a></td> <td class="paramname"><span class="paramname"><em>prev</em></span>&#160;)</td>
187 </tr>
188 </table>
189 </td>
190 <td class="mlabels-right">
191 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
192 </tr>
193 </table>
194 </div><div class="memdoc">
195
196 <p>Get the next PCI device in the system. </p>
197 <dl class="section return"><dt>Returns</dt><dd>the first PCI device if <code class="param">prev</code> is <code>NULL</code>. </dd>
198 <dd>
199 the next PCI device if <code class="param">prev</code> is not <code>NULL</code>. </dd>
200 <dd>
201 <code>NULL</code> if there is no next PCI device. </dd></dl>
202
203 </div>
204 </div>
205 <a id="ga82a8321fa0f49761cba90201e240c988" name="ga82a8321fa0f49761cba90201e240c988"></a>
206 <h2 class="memtitle"><span class="permalink"><a href="#ga82a8321fa0f49761cba90201e240c988">&#9670;&#160;</a></span>hwloc_get_non_io_ancestor_obj()</h2>
207
208 <div class="memitem">
209 <div class="memproto">
210 <table class="mlabels">
211 <tr>
212 <td class="mlabels-left">
213 <table class="memname">
214 <tr>
215 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_non_io_ancestor_obj </td>
216 <td>(</td>
217 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
218 </tr>
219 <tr>
220 <td class="paramkey"></td>
221 <td></td>
222 <td class="paramtype"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a></td> <td class="paramname"><span class="paramname"><em>ioobj</em></span>&#160;)</td>
223 </tr>
224 </table>
225 </td>
226 <td class="mlabels-right">
227 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
228 </tr>
229 </table>
230 </div><div class="memdoc">
231
232 <p>Get the first non-I/O ancestor object. </p>
233 <p>Given the I/O object <code class="param">ioobj</code>, find the smallest non-I/O ancestor object. This object (normal or memory) may then be used for binding because it has non-NULL CPU and node sets and because its locality is the same as <code class="param">ioobj</code>.</p>
234 <dl class="section return"><dt>Returns</dt><dd>a non-I/O object.</dd></dl>
235 <dl class="section note"><dt>Note</dt><dd>This function cannot return <code>NULL</code>.</dd>
236 <dd>
237 The resulting object is usually a normal object but it could also be a memory object (e.g. NUMA node) in future platforms if I/O objects ever get attached to memory instead of CPUs. </dd></dl>
238
239 </div>
240 </div>
241 <a id="ga07532867d72b87ace39aeee2bb407b66" name="ga07532867d72b87ace39aeee2bb407b66"></a>
242 <h2 class="memtitle"><span class="permalink"><a href="#ga07532867d72b87ace39aeee2bb407b66">&#9670;&#160;</a></span>hwloc_get_pcidev_by_busid()</h2>
243
244 <div class="memitem">
245 <div class="memproto">
246 <table class="mlabels">
247 <tr>
248 <td class="mlabels-left">
249 <table class="memname">
250 <tr>
251 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_pcidev_by_busid </td>
252 <td>(</td>
253 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
254 </tr>
255 <tr>
256 <td class="paramkey"></td>
257 <td></td>
258 <td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>domain</em></span>, </td>
259 </tr>
260 <tr>
261 <td class="paramkey"></td>
262 <td></td>
263 <td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>bus</em></span>, </td>
264 </tr>
265 <tr>
266 <td class="paramkey"></td>
267 <td></td>
268 <td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>dev</em></span>, </td>
269 </tr>
270 <tr>
271 <td class="paramkey"></td>
272 <td></td>
273 <td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>func</em></span>&#160;)</td>
274 </tr>
275 </table>
276 </td>
277 <td class="mlabels-right">
278 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
279 </tr>
280 </table>
281 </div><div class="memdoc">
282
283 <p>Find the PCI device object matching the PCI bus id given domain, bus device and function PCI bus id. </p>
284 <dl class="section return"><dt>Returns</dt><dd>a matching PCI device object if any, <code>NULL</code> otherwise. </dd></dl>
285
286 </div>
287 </div>
288 <a id="gaf463491f6dcef8591c19a0b606c97796" name="gaf463491f6dcef8591c19a0b606c97796"></a>
289 <h2 class="memtitle"><span class="permalink"><a href="#gaf463491f6dcef8591c19a0b606c97796">&#9670;&#160;</a></span>hwloc_get_pcidev_by_busidstring()</h2>
290
291 <div class="memitem">
292 <div class="memproto">
293 <table class="mlabels">
294 <tr>
295 <td class="mlabels-left">
296 <table class="memname">
297 <tr>
298 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_pcidev_by_busidstring </td>
299 <td>(</td>
300 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
301 </tr>
302 <tr>
303 <td class="paramkey"></td>
304 <td></td>
305 <td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>busid</em></span>&#160;)</td>
306 </tr>
307 </table>
308 </td>
309 <td class="mlabels-right">
310 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
311 </tr>
312 </table>
313 </div><div class="memdoc">
314
315 <p>Find the PCI device object matching the PCI bus id given as a string xxxx:yy:zz.t or yy:zz.t. </p>
316 <dl class="section return"><dt>Returns</dt><dd>a matching PCI device object if any, <code>NULL</code> otherwise. </dd></dl>
317
318 </div>
319 </div>
320 </div><!-- contents -->
321 <!-- start footer part -->
322 <hr class="footer"/><address class="footer"><small>
323 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
324 </small></address>
325 </div><!-- doc-content -->
326 </body>
327 </html>