Debian Codegraph @

doc/doxygen-doc/html/a00211.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): Interoperability with OpenFabrics</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">Interoperability with OpenFabrics </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:ga5f7559c1d4024c6a4dcbae2cba0555ad" id="r_ga5f7559c1d4024c6a4dcbae2cba0555ad"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5f7559c1d4024c6a4dcbae2cba0555ad">hwloc_ibv_get_device_cpuset</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, struct ibv_device *ibdev, <a class="el" href="a00166.html#ga4bbf39b68b6f568fb92739e7c0ea7801">hwloc_cpuset_t</a> set)</td></tr>
54 <tr class="memitem:ga14a0d0b26f3a9ac79e7d9565eaa6b9b4" id="r_ga14a0d0b26f3a9ac79e7d9565eaa6b9b4"><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="#ga14a0d0b26f3a9ac79e7d9565eaa6b9b4">hwloc_ibv_get_device_osdev_by_name</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, const char *ibname)</td></tr>
55 <tr class="memitem:gaa2694b74b6155121c3a7bab52a5f048e" id="r_gaa2694b74b6155121c3a7bab52a5f048e"><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="#gaa2694b74b6155121c3a7bab52a5f048e">hwloc_ibv_get_device_osdev</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, struct ibv_device *ibdev)</td></tr>
56 </table>
57 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
58 <p>This interface offers ways to retrieve topology information about OpenFabrics devices (InfiniBand, Omni-Path, usNIC, etc). </p>
59 <a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
60 <a id="ga5f7559c1d4024c6a4dcbae2cba0555ad" name="ga5f7559c1d4024c6a4dcbae2cba0555ad"></a>
61 <h2 class="memtitle"><span class="permalink"><a href="#ga5f7559c1d4024c6a4dcbae2cba0555ad">&#9670;&#160;</a></span>hwloc_ibv_get_device_cpuset()</h2>
62
63 <div class="memitem">
64 <div class="memproto">
65 <table class="mlabels">
66 <tr>
67 <td class="mlabels-left">
68 <table class="memname">
69 <tr>
70 <td class="memname">int hwloc_ibv_get_device_cpuset </td>
71 <td>(</td>
72 <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>
73 </tr>
74 <tr>
75 <td class="paramkey"></td>
76 <td></td>
77 <td class="paramtype">struct ibv_device *</td> <td class="paramname"><span class="paramname"><em>ibdev</em></span>, </td>
78 </tr>
79 <tr>
80 <td class="paramkey"></td>
81 <td></td>
82 <td class="paramtype"><a class="el" href="a00166.html#ga4bbf39b68b6f568fb92739e7c0ea7801">hwloc_cpuset_t</a></td> <td class="paramname"><span class="paramname"><em>set</em></span>&#160;)</td>
83 </tr>
84 </table>
85 </td>
86 <td class="mlabels-right">
87 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
88 </tr>
89 </table>
90 </div><div class="memdoc">
91
92 <p>Get the CPU set of processors that are physically close to device <code class="param">ibdev</code>. </p>
93 <p>Store in <code class="param">set</code> the CPU-set describing the locality of the OpenFabrics device <code class="param">ibdev</code> (InfiniBand, etc).</p>
94 <p>Topology <code class="param">topology</code> and device <code class="param">ibdev</code> must match the local machine. I/O devices detection is not needed in the topology.</p>
95 <p>The function only returns the locality of the device. If more information about the device is needed, OS objects should be used instead, see <a class="el" href="#gaa2694b74b6155121c3a7bab52a5f048e" title="Get the hwloc OS device object corresponding to the OpenFabrics device ibdev.">hwloc_ibv_get_device_osdev()</a> and <a class="el" href="#ga14a0d0b26f3a9ac79e7d9565eaa6b9b4" title="Get the hwloc OS device object corresponding to the OpenFabrics device named ibname.">hwloc_ibv_get_device_osdev_by_name()</a>.</p>
96 <p>This function is currently only implemented in a meaningful way for Linux; other systems will simply get the cpuset of the entire topology.</p>
97 <dl class="section return"><dt>Returns</dt><dd>0 on success. </dd>
98 <dd>
99 -1 on error, for instance if device information could not be found. </dd></dl>
100
101 </div>
102 </div>
103 <a id="gaa2694b74b6155121c3a7bab52a5f048e" name="gaa2694b74b6155121c3a7bab52a5f048e"></a>
104 <h2 class="memtitle"><span class="permalink"><a href="#gaa2694b74b6155121c3a7bab52a5f048e">&#9670;&#160;</a></span>hwloc_ibv_get_device_osdev()</h2>
105
106 <div class="memitem">
107 <div class="memproto">
108 <table class="mlabels">
109 <tr>
110 <td class="mlabels-left">
111 <table class="memname">
112 <tr>
113 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_ibv_get_device_osdev </td>
114 <td>(</td>
115 <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>
116 </tr>
117 <tr>
118 <td class="paramkey"></td>
119 <td></td>
120 <td class="paramtype">struct ibv_device *</td> <td class="paramname"><span class="paramname"><em>ibdev</em></span>&#160;)</td>
121 </tr>
122 </table>
123 </td>
124 <td class="mlabels-right">
125 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
126 </tr>
127 </table>
128 </div><div class="memdoc">
129
130 <p>Get the hwloc OS device object corresponding to the OpenFabrics device <code class="param">ibdev</code>. </p>
131 <dl class="section return"><dt>Returns</dt><dd>The hwloc OS device object describing the OpenFabrics device <code class="param">ibdev</code> (InfiniBand, etc). </dd>
132 <dd>
133 <code>NULL</code> if none could be found.</dd></dl>
134 <p>Topology <code class="param">topology</code> and device <code class="param">ibdev</code> must match the local machine. I/O devices detection must be enabled in the topology. If not, the locality of the object may still be found using <a class="el" href="#ga5f7559c1d4024c6a4dcbae2cba0555ad" title="Get the CPU set of processors that are physically close to device ibdev.">hwloc_ibv_get_device_cpuset()</a>.</p>
135 <dl class="section note"><dt>Note</dt><dd>The corresponding PCI device object can be obtained by looking at the OS device parent object. </dd></dl>
136
137 </div>
138 </div>
139 <a id="ga14a0d0b26f3a9ac79e7d9565eaa6b9b4" name="ga14a0d0b26f3a9ac79e7d9565eaa6b9b4"></a>
140 <h2 class="memtitle"><span class="permalink"><a href="#ga14a0d0b26f3a9ac79e7d9565eaa6b9b4">&#9670;&#160;</a></span>hwloc_ibv_get_device_osdev_by_name()</h2>
141
142 <div class="memitem">
143 <div class="memproto">
144 <table class="mlabels">
145 <tr>
146 <td class="mlabels-left">
147 <table class="memname">
148 <tr>
149 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_ibv_get_device_osdev_by_name </td>
150 <td>(</td>
151 <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>
152 </tr>
153 <tr>
154 <td class="paramkey"></td>
155 <td></td>
156 <td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>ibname</em></span>&#160;)</td>
157 </tr>
158 </table>
159 </td>
160 <td class="mlabels-right">
161 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
162 </tr>
163 </table>
164 </div><div class="memdoc">
165
166 <p>Get the hwloc OS device object corresponding to the OpenFabrics device named <code class="param">ibname</code>. </p>
167 <dl class="section return"><dt>Returns</dt><dd>The hwloc OS device object describing the OpenFabrics device (InfiniBand, Omni-Path, usNIC, etc) whose name is <code class="param">ibname</code> (mlx5_0, hfi1_0, usnic_0, qib0, etc). </dd>
168 <dd>
169 <code>NULL</code> if none could be found.</dd></dl>
170 <p>The name <code class="param">ibname</code> is usually obtained from ibv_get_device_name().</p>
171 <p>The topology <code class="param">topology</code> does not necessarily have to match the current machine. For instance the topology may be an XML import of a remote host. I/O devices detection must be enabled in the topology.</p>
172 <dl class="section note"><dt>Note</dt><dd>The corresponding PCI device object can be obtained by looking at the OS device parent object. </dd></dl>
173
174 </div>
175 </div>
176 </div><!-- contents -->
177 <!-- start footer part -->
178 <hr class="footer"/><address class="footer"><small>
179 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
180 </small></address>
181 </div><!-- doc-content -->
182 </body>
183 </html>