Debian Codegraph @

doc/doxygen-doc/html/a00180.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 Objects covering at least CPU set</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 Objects covering at least CPU set </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:ga33b785797d3ec5c37b75380c819eaae7" id="r_ga33b785797d3ec5c37b75380c819eaae7"><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="#ga33b785797d3ec5c37b75380c819eaae7">hwloc_get_child_covering_cpuset</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a> set, <a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> parent)</td></tr>
54 <tr class="memitem:ga5535e32d7a0bd047cabedd04b53270cf" id="r_ga5535e32d7a0bd047cabedd04b53270cf"><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="#ga5535e32d7a0bd047cabedd04b53270cf">hwloc_get_obj_covering_cpuset</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a> set)</td></tr>
55 <tr class="memitem:ga98c864a575327bfbfdb92b701e5069dd" id="r_ga98c864a575327bfbfdb92b701e5069dd"><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="#ga98c864a575327bfbfdb92b701e5069dd">hwloc_get_next_obj_covering_cpuset_by_depth</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a> set, int depth, <a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> prev)</td></tr>
56 <tr class="memitem:gae37eabe1f91b6524576e2c0dad3b3639" id="r_gae37eabe1f91b6524576e2c0dad3b3639"><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="#gae37eabe1f91b6524576e2c0dad3b3639">hwloc_get_next_obj_covering_cpuset_by_type</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a> set, <a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type, <a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> prev)</td></tr>
57 </table>
58 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
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="ga33b785797d3ec5c37b75380c819eaae7" name="ga33b785797d3ec5c37b75380c819eaae7"></a>
61 <h2 class="memtitle"><span class="permalink"><a href="#ga33b785797d3ec5c37b75380c819eaae7">&#9670;&#160;</a></span>hwloc_get_child_covering_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"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_child_covering_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"><a class="el" href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a></td> <td class="paramname"><span class="paramname"><em>set</em></span>, </td>
78 </tr>
79 <tr>
80 <td class="paramkey"></td>
81 <td></td>
82 <td class="paramtype"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a></td> <td class="paramname"><span class="paramname"><em>parent</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 child covering at least CPU set <code class="param">set</code>. </p>
93 <dl class="section return"><dt>Returns</dt><dd>the child that covers the set entirely. </dd>
94 <dd>
95 <code>NULL</code> if no child matches or if <code class="param">set</code> is empty.</dd></dl>
96 <dl class="section note"><dt>Note</dt><dd>This function cannot work if parent does not have a CPU set (I/O or Misc objects). </dd></dl>
97
98 </div>
99 </div>
100 <a id="ga98c864a575327bfbfdb92b701e5069dd" name="ga98c864a575327bfbfdb92b701e5069dd"></a>
101 <h2 class="memtitle"><span class="permalink"><a href="#ga98c864a575327bfbfdb92b701e5069dd">&#9670;&#160;</a></span>hwloc_get_next_obj_covering_cpuset_by_depth()</h2>
102
103 <div class="memitem">
104 <div class="memproto">
105 <table class="mlabels">
106 <tr>
107 <td class="mlabels-left">
108 <table class="memname">
109 <tr>
110 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_next_obj_covering_cpuset_by_depth </td>
111 <td>(</td>
112 <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>
113 </tr>
114 <tr>
115 <td class="paramkey"></td>
116 <td></td>
117 <td class="paramtype"><a class="el" href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a></td> <td class="paramname"><span class="paramname"><em>set</em></span>, </td>
118 </tr>
119 <tr>
120 <td class="paramkey"></td>
121 <td></td>
122 <td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>depth</em></span>, </td>
123 </tr>
124 <tr>
125 <td class="paramkey"></td>
126 <td></td>
127 <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>
128 </tr>
129 </table>
130 </td>
131 <td class="mlabels-right">
132 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
133 </tr>
134 </table>
135 </div><div class="memdoc">
136
137 <p>Iterate through same-depth objects covering at least CPU set <code class="param">set</code>. </p>
138 <p>The next invokation should pass the previous return value in <code class="param">prev</code> so as to obtain the next object covering at least another part of <code class="param">set</code>.</p>
139 <dl class="section return"><dt>Returns</dt><dd>the first object at depth <code class="param">depth</code> covering at least part of CPU set <code class="param">set</code> if object <code class="param">prev</code> is <code>NULL</code>. </dd>
140 <dd>
141 the next one if <code class="param">prev</code> is not <code>NULL</code>. </dd>
142 <dd>
143 <code>NULL</code> if there is no next object.</dd></dl>
144 <dl class="section note"><dt>Note</dt><dd>This function cannot work if objects at the given depth do not have CPU sets (I/O or Misc objects). </dd></dl>
145
146 </div>
147 </div>
148 <a id="gae37eabe1f91b6524576e2c0dad3b3639" name="gae37eabe1f91b6524576e2c0dad3b3639"></a>
149 <h2 class="memtitle"><span class="permalink"><a href="#gae37eabe1f91b6524576e2c0dad3b3639">&#9670;&#160;</a></span>hwloc_get_next_obj_covering_cpuset_by_type()</h2>
150
151 <div class="memitem">
152 <div class="memproto">
153 <table class="mlabels">
154 <tr>
155 <td class="mlabels-left">
156 <table class="memname">
157 <tr>
158 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_next_obj_covering_cpuset_by_type </td>
159 <td>(</td>
160 <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>
161 </tr>
162 <tr>
163 <td class="paramkey"></td>
164 <td></td>
165 <td class="paramtype"><a class="el" href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a></td> <td class="paramname"><span class="paramname"><em>set</em></span>, </td>
166 </tr>
167 <tr>
168 <td class="paramkey"></td>
169 <td></td>
170 <td class="paramtype"><a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
171 </tr>
172 <tr>
173 <td class="paramkey"></td>
174 <td></td>
175 <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>
176 </tr>
177 </table>
178 </td>
179 <td class="mlabels-right">
180 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
181 </tr>
182 </table>
183 </div><div class="memdoc">
184
185 <p>Iterate through same-type objects covering at least CPU set <code class="param">set</code>. </p>
186 <p>The next invokation should pass the previous return value in <code class="param">prev</code> so as to obtain the next object of type <code class="param">type</code> covering at least another part of <code class="param">set</code>.</p>
187 <dl class="section return"><dt>Returns</dt><dd>the first object of type <code class="param">type</code> covering at least part of CPU set <code class="param">set</code> if object <code class="param">prev</code> is <code>NULL</code>. </dd>
188 <dd>
189 the next one if <code class="param">prev</code> is not <code>NULL</code>. </dd>
190 <dd>
191 <code>NULL</code> if there is no next object. </dd>
192 <dd>
193 <code>NULL</code> if there is no depth for the given type. </dd>
194 <dd>
195 <code>NULL</code> if there are multiple depths for the given type, the caller should fallback to <a class="el" href="#ga98c864a575327bfbfdb92b701e5069dd" title="Iterate through same-depth objects covering at least CPU set set.">hwloc_get_next_obj_covering_cpuset_by_depth()</a>.</dd></dl>
196 <dl class="section note"><dt>Note</dt><dd>This function cannot work if objects of the given type do not have CPU sets (I/O or Misc objects). </dd></dl>
197
198 </div>
199 </div>
200 <a id="ga5535e32d7a0bd047cabedd04b53270cf" name="ga5535e32d7a0bd047cabedd04b53270cf"></a>
201 <h2 class="memtitle"><span class="permalink"><a href="#ga5535e32d7a0bd047cabedd04b53270cf">&#9670;&#160;</a></span>hwloc_get_obj_covering_cpuset()</h2>
202
203 <div class="memitem">
204 <div class="memproto">
205 <table class="mlabels">
206 <tr>
207 <td class="mlabels-left">
208 <table class="memname">
209 <tr>
210 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_obj_covering_cpuset </td>
211 <td>(</td>
212 <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>
213 </tr>
214 <tr>
215 <td class="paramkey"></td>
216 <td></td>
217 <td class="paramtype"><a class="el" href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a></td> <td class="paramname"><span class="paramname"><em>set</em></span>&#160;)</td>
218 </tr>
219 </table>
220 </td>
221 <td class="mlabels-right">
222 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
223 </tr>
224 </table>
225 </div><div class="memdoc">
226
227 <p>Get the lowest object covering at least CPU set <code class="param">set</code>. </p>
228 <dl class="section return"><dt>Returns</dt><dd>the lowest object covering the set entirely. </dd>
229 <dd>
230 <code>NULL</code> if no object matches or if <code class="param">set</code> is empty. </dd></dl>
231
232 </div>
233 </div>
234 </div><!-- contents -->
235 <!-- start footer part -->
236 <hr class="footer"/><address class="footer"><small>
237 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
238 </small></address>
239 </div><!-- doc-content -->
240 </body>
241 </html>