| 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 inside a 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"> 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 inside a 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:ga8edc4c8f976062c42cb0551a44317d4c" id="r_ga8edc4c8f976062c42cb0551a44317d4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8edc4c8f976062c42cb0551a44317d4c">hwloc_get_first_largest_obj_inside_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> |
| 54 |
<tr class="memitem:ga34ca563fa3a6a4e05268f36a87668511" id="r_ga34ca563fa3a6a4e05268f36a87668511"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga34ca563fa3a6a4e05268f36a87668511">hwloc_get_largest_objs_inside_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> *restrict objs, int max)</td></tr> |
| 55 |
<tr class="memitem:gad444a20167320c79c7f3c233899badd5" id="r_gad444a20167320c79c7f3c233899badd5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gad444a20167320c79c7f3c233899badd5">hwloc_get_next_obj_inside_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:gabf0e69621bd014605f24436b415b4247" id="r_gabf0e69621bd014605f24436b415b4247"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gabf0e69621bd014605f24436b415b4247">hwloc_get_next_obj_inside_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 |
<tr class="memitem:ga4eded74ffab87e5ad154c817c2f9fd4c" id="r_ga4eded74ffab87e5ad154c817c2f9fd4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4eded74ffab87e5ad154c817c2f9fd4c">hwloc_get_obj_inside_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, unsigned idx)</td></tr> |
| 58 |
<tr class="memitem:gaf32c12c931955e111db73bb42921ca76" id="r_gaf32c12c931955e111db73bb42921ca76"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf32c12c931955e111db73bb42921ca76">hwloc_get_obj_inside_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, unsigned idx)</td></tr> |
| 59 |
<tr class="memitem:gaa81ef7cb29d610b8acb0421c6f772d52" id="r_gaa81ef7cb29d610b8acb0421c6f772d52"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa81ef7cb29d610b8acb0421c6f772d52">hwloc_get_nbobjs_inside_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)</td></tr> |
| 60 |
<tr class="memitem:ga7a860bc70bcd789e7e872c221f7e3595" id="r_ga7a860bc70bcd789e7e872c221f7e3595"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga7a860bc70bcd789e7e872c221f7e3595">hwloc_get_nbobjs_inside_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)</td></tr> |
| 61 |
<tr class="memitem:ga7613539c0d840617a16a25ffcf25a643" id="r_ga7613539c0d840617a16a25ffcf25a643"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga7613539c0d840617a16a25ffcf25a643">hwloc_get_obj_index_inside_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> obj)</td></tr> |
| 62 |
</table> |
| 63 |
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2> |
| 64 |
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2> |
| 65 |
<a id="ga8edc4c8f976062c42cb0551a44317d4c" name="ga8edc4c8f976062c42cb0551a44317d4c"></a> |
| 66 |
<h2 class="memtitle"><span class="permalink"><a href="#ga8edc4c8f976062c42cb0551a44317d4c">◆ </a></span>hwloc_get_first_largest_obj_inside_cpuset()</h2> |
| 67 |
|
| 68 |
<div class="memitem"> |
| 69 |
<div class="memproto"> |
| 70 |
<table class="mlabels"> |
| 71 |
<tr> |
| 72 |
<td class="mlabels-left"> |
| 73 |
<table class="memname"> |
| 74 |
<tr> |
| 75 |
<td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_first_largest_obj_inside_cpuset </td> |
| 76 |
<td>(</td> |
| 77 |
<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> |
| 78 |
</tr> |
| 79 |
<tr> |
| 80 |
<td class="paramkey"></td> |
| 81 |
<td></td> |
| 82 |
<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> |
| 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 first largest object included in the given cpuset <code class="param">set</code>. </p> |
| 93 |
<dl class="section return"><dt>Returns</dt><dd>the first object that is included in <code class="param">set</code> and whose parent is not. </dd> |
| 94 |
<dd> |
| 95 |
<code>NULL</code> if no such object exists.</dd></dl> |
| 96 |
<p>This is convenient for iterating over all largest objects within a CPU set by doing a loop getting the first largest object and clearing its CPU set from the remaining CPU set. </p> |
| 97 |
|
| 98 |
</div> |
| 99 |
</div> |
| 100 |
<a id="ga34ca563fa3a6a4e05268f36a87668511" name="ga34ca563fa3a6a4e05268f36a87668511"></a> |
| 101 |
<h2 class="memtitle"><span class="permalink"><a href="#ga34ca563fa3a6a4e05268f36a87668511">◆ </a></span>hwloc_get_largest_objs_inside_cpuset()</h2> |
| 102 |
|
| 103 |
<div class="memitem"> |
| 104 |
<div class="memproto"> |
| 105 |
<table class="memname"> |
| 106 |
<tr> |
| 107 |
<td class="memname">int hwloc_get_largest_objs_inside_cpuset </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="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a></td> <td class="paramname"><span class="paramname"><em>set</em></span>, </td> |
| 115 |
</tr> |
| 116 |
<tr> |
| 117 |
<td class="paramkey"></td> |
| 118 |
<td></td> |
| 119 |
<td class="paramtype"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> *restrict</td> <td class="paramname"><span class="paramname"><em>objs</em></span>, </td> |
| 120 |
</tr> |
| 121 |
<tr> |
| 122 |
<td class="paramkey"></td> |
| 123 |
<td></td> |
| 124 |
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>max</em></span> )</td> |
| 125 |
</tr> |
| 126 |
</table> |
| 127 |
</div><div class="memdoc"> |
| 128 |
|
| 129 |
<p>Get the set of largest objects covering exactly a given cpuset <code class="param">set</code>. </p> |
| 130 |
<dl class="section return"><dt>Returns</dt><dd>the number of objects returned in <code class="param">objs</code>. </dd> |
| 131 |
<dd> |
| 132 |
-1 if no set of objects may cover that cpuset. </dd></dl> |
| 133 |
|
| 134 |
</div> |
| 135 |
</div> |
| 136 |
<a id="gaa81ef7cb29d610b8acb0421c6f772d52" name="gaa81ef7cb29d610b8acb0421c6f772d52"></a> |
| 137 |
<h2 class="memtitle"><span class="permalink"><a href="#gaa81ef7cb29d610b8acb0421c6f772d52">◆ </a></span>hwloc_get_nbobjs_inside_cpuset_by_depth()</h2> |
| 138 |
|
| 139 |
<div class="memitem"> |
| 140 |
<div class="memproto"> |
| 141 |
<table class="mlabels"> |
| 142 |
<tr> |
| 143 |
<td class="mlabels-left"> |
| 144 |
<table class="memname"> |
| 145 |
<tr> |
| 146 |
<td class="memname">unsigned hwloc_get_nbobjs_inside_cpuset_by_depth </td> |
| 147 |
<td>(</td> |
| 148 |
<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> |
| 149 |
</tr> |
| 150 |
<tr> |
| 151 |
<td class="paramkey"></td> |
| 152 |
<td></td> |
| 153 |
<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> |
| 154 |
</tr> |
| 155 |
<tr> |
| 156 |
<td class="paramkey"></td> |
| 157 |
<td></td> |
| 158 |
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>depth</em></span> )</td> |
| 159 |
</tr> |
| 160 |
</table> |
| 161 |
</td> |
| 162 |
<td class="mlabels-right"> |
| 163 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 164 |
</tr> |
| 165 |
</table> |
| 166 |
</div><div class="memdoc"> |
| 167 |
|
| 168 |
<p>Return the number of objects at depth <code class="param">depth</code> included in CPU set <code class="param">set</code>. </p> |
| 169 |
<dl class="section return"><dt>Returns</dt><dd>the number of objects. </dd> |
| 170 |
<dd> |
| 171 |
0 if the depth is invalid.</dd></dl> |
| 172 |
<dl class="section note"><dt>Note</dt><dd>Objects with empty CPU sets are ignored (otherwise they would be considered included in any given set).</dd> |
| 173 |
<dd> |
| 174 |
This function cannot work if objects at the given depth do not have CPU sets (I/O or Misc objects). </dd></dl> |
| 175 |
|
| 176 |
</div> |
| 177 |
</div> |
| 178 |
<a id="ga7a860bc70bcd789e7e872c221f7e3595" name="ga7a860bc70bcd789e7e872c221f7e3595"></a> |
| 179 |
<h2 class="memtitle"><span class="permalink"><a href="#ga7a860bc70bcd789e7e872c221f7e3595">◆ </a></span>hwloc_get_nbobjs_inside_cpuset_by_type()</h2> |
| 180 |
|
| 181 |
<div class="memitem"> |
| 182 |
<div class="memproto"> |
| 183 |
<table class="mlabels"> |
| 184 |
<tr> |
| 185 |
<td class="mlabels-left"> |
| 186 |
<table class="memname"> |
| 187 |
<tr> |
| 188 |
<td class="memname">int hwloc_get_nbobjs_inside_cpuset_by_type </td> |
| 189 |
<td>(</td> |
| 190 |
<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> |
| 191 |
</tr> |
| 192 |
<tr> |
| 193 |
<td class="paramkey"></td> |
| 194 |
<td></td> |
| 195 |
<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> |
| 196 |
</tr> |
| 197 |
<tr> |
| 198 |
<td class="paramkey"></td> |
| 199 |
<td></td> |
| 200 |
<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> |
| 201 |
</tr> |
| 202 |
</table> |
| 203 |
</td> |
| 204 |
<td class="mlabels-right"> |
| 205 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 206 |
</tr> |
| 207 |
</table> |
| 208 |
</div><div class="memdoc"> |
| 209 |
|
| 210 |
<p>Return the number of objects of type <code class="param">type</code> included in CPU set <code class="param">set</code>. </p> |
| 211 |
<dl class="section return"><dt>Returns</dt><dd>the number of objects. </dd> |
| 212 |
<dd> |
| 213 |
0 if there are no objects of that type in the topology. </dd> |
| 214 |
<dd> |
| 215 |
-1 if there are multiple levels of objects of that type, the caller should fallback to <a class="el" href="#gaa81ef7cb29d610b8acb0421c6f772d52" title="Return the number of objects at depth depth included in CPU set set.">hwloc_get_nbobjs_inside_cpuset_by_depth()</a>.</dd></dl> |
| 216 |
<dl class="section note"><dt>Note</dt><dd>Objects with empty CPU sets are ignored (otherwise they would be considered included in any given set).</dd> |
| 217 |
<dd> |
| 218 |
This function cannot work if objects of the given type do not have CPU sets (I/O objects). </dd></dl> |
| 219 |
|
| 220 |
</div> |
| 221 |
</div> |
| 222 |
<a id="gad444a20167320c79c7f3c233899badd5" name="gad444a20167320c79c7f3c233899badd5"></a> |
| 223 |
<h2 class="memtitle"><span class="permalink"><a href="#gad444a20167320c79c7f3c233899badd5">◆ </a></span>hwloc_get_next_obj_inside_cpuset_by_depth()</h2> |
| 224 |
|
| 225 |
<div class="memitem"> |
| 226 |
<div class="memproto"> |
| 227 |
<table class="mlabels"> |
| 228 |
<tr> |
| 229 |
<td class="mlabels-left"> |
| 230 |
<table class="memname"> |
| 231 |
<tr> |
| 232 |
<td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_next_obj_inside_cpuset_by_depth </td> |
| 233 |
<td>(</td> |
| 234 |
<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> |
| 235 |
</tr> |
| 236 |
<tr> |
| 237 |
<td class="paramkey"></td> |
| 238 |
<td></td> |
| 239 |
<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> |
| 240 |
</tr> |
| 241 |
<tr> |
| 242 |
<td class="paramkey"></td> |
| 243 |
<td></td> |
| 244 |
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>depth</em></span>, </td> |
| 245 |
</tr> |
| 246 |
<tr> |
| 247 |
<td class="paramkey"></td> |
| 248 |
<td></td> |
| 249 |
<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> )</td> |
| 250 |
</tr> |
| 251 |
</table> |
| 252 |
</td> |
| 253 |
<td class="mlabels-right"> |
| 254 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 255 |
</tr> |
| 256 |
</table> |
| 257 |
</div><div class="memdoc"> |
| 258 |
|
| 259 |
<p>Return the next object at depth <code class="param">depth</code> included in CPU set <code class="param">set</code>. </p> |
| 260 |
<p>The next invokation should pass the previous return value in <code class="param">prev</code> so as to obtain the next object in <code class="param">set</code>.</p> |
| 261 |
<dl class="section return"><dt>Returns</dt><dd>the first object at depth <code class="param">depth</code> included in <code class="param">set</code> if <code class="param">prev</code> is <code>NULL</code>. </dd> |
| 262 |
<dd> |
| 263 |
the next object at depth <code class="param">depth</code> included in <code class="param">set</code> if <code class="param">prev</code> is not <code>NULL</code>. </dd> |
| 264 |
<dd> |
| 265 |
<code>NULL</code> if there is no next object.</dd></dl> |
| 266 |
<dl class="section note"><dt>Note</dt><dd>Objects with empty CPU sets are ignored (otherwise they would be considered included in any given set).</dd> |
| 267 |
<dd> |
| 268 |
This function cannot work if objects at the given depth do not have CPU sets (I/O or Misc objects). </dd></dl> |
| 269 |
|
| 270 |
</div> |
| 271 |
</div> |
| 272 |
<a id="gabf0e69621bd014605f24436b415b4247" name="gabf0e69621bd014605f24436b415b4247"></a> |
| 273 |
<h2 class="memtitle"><span class="permalink"><a href="#gabf0e69621bd014605f24436b415b4247">◆ </a></span>hwloc_get_next_obj_inside_cpuset_by_type()</h2> |
| 274 |
|
| 275 |
<div class="memitem"> |
| 276 |
<div class="memproto"> |
| 277 |
<table class="mlabels"> |
| 278 |
<tr> |
| 279 |
<td class="mlabels-left"> |
| 280 |
<table class="memname"> |
| 281 |
<tr> |
| 282 |
<td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_next_obj_inside_cpuset_by_type </td> |
| 283 |
<td>(</td> |
| 284 |
<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> |
| 285 |
</tr> |
| 286 |
<tr> |
| 287 |
<td class="paramkey"></td> |
| 288 |
<td></td> |
| 289 |
<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> |
| 290 |
</tr> |
| 291 |
<tr> |
| 292 |
<td class="paramkey"></td> |
| 293 |
<td></td> |
| 294 |
<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> |
| 295 |
</tr> |
| 296 |
<tr> |
| 297 |
<td class="paramkey"></td> |
| 298 |
<td></td> |
| 299 |
<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> )</td> |
| 300 |
</tr> |
| 301 |
</table> |
| 302 |
</td> |
| 303 |
<td class="mlabels-right"> |
| 304 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 305 |
</tr> |
| 306 |
</table> |
| 307 |
</div><div class="memdoc"> |
| 308 |
|
| 309 |
<p>Return the next object of type <code class="param">type</code> included in CPU set <code class="param">set</code>. </p> |
| 310 |
<p>The next invokation should pass the previous return value in <code class="param">prev</code> so as to obtain the next object in <code class="param">set</code>.</p> |
| 311 |
<dl class="section return"><dt>Returns</dt><dd>the first object of type <code class="param">type</code> included in <code class="param">set</code> if <code class="param">prev</code> is <code>NULL</code>. </dd> |
| 312 |
<dd> |
| 313 |
the next object of type <code class="param">type</code> included in <code class="param">set</code> if <code class="param">prev</code> is not <code>NULL</code>. </dd> |
| 314 |
<dd> |
| 315 |
<code>NULL</code> if there is no next object. </dd> |
| 316 |
<dd> |
| 317 |
<code>NULL</code> if there is no depth for the given type. </dd> |
| 318 |
<dd> |
| 319 |
<code>NULL</code> if there are multiple depths for the given type, the caller should fallback to <a class="el" href="#gad444a20167320c79c7f3c233899badd5" title="Return the next object at depth depth included in CPU set set.">hwloc_get_next_obj_inside_cpuset_by_depth()</a>.</dd></dl> |
| 320 |
<dl class="section note"><dt>Note</dt><dd>Objects with empty CPU sets are ignored (otherwise they would be considered included in any given set).</dd> |
| 321 |
<dd> |
| 322 |
This function cannot work if objects of the given type do not have CPU sets (I/O or Misc objects). </dd></dl> |
| 323 |
|
| 324 |
</div> |
| 325 |
</div> |
| 326 |
<a id="ga7613539c0d840617a16a25ffcf25a643" name="ga7613539c0d840617a16a25ffcf25a643"></a> |
| 327 |
<h2 class="memtitle"><span class="permalink"><a href="#ga7613539c0d840617a16a25ffcf25a643">◆ </a></span>hwloc_get_obj_index_inside_cpuset()</h2> |
| 328 |
|
| 329 |
<div class="memitem"> |
| 330 |
<div class="memproto"> |
| 331 |
<table class="mlabels"> |
| 332 |
<tr> |
| 333 |
<td class="mlabels-left"> |
| 334 |
<table class="memname"> |
| 335 |
<tr> |
| 336 |
<td class="memname">int hwloc_get_obj_index_inside_cpuset </td> |
| 337 |
<td>(</td> |
| 338 |
<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> |
| 339 |
</tr> |
| 340 |
<tr> |
| 341 |
<td class="paramkey"></td> |
| 342 |
<td></td> |
| 343 |
<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> |
| 344 |
</tr> |
| 345 |
<tr> |
| 346 |
<td class="paramkey"></td> |
| 347 |
<td></td> |
| 348 |
<td class="paramtype"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a></td> <td class="paramname"><span class="paramname"><em>obj</em></span> )</td> |
| 349 |
</tr> |
| 350 |
</table> |
| 351 |
</td> |
| 352 |
<td class="mlabels-right"> |
| 353 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 354 |
</tr> |
| 355 |
</table> |
| 356 |
</div><div class="memdoc"> |
| 357 |
|
| 358 |
<p>Return the logical index among the objects included in CPU set <code class="param">set</code>. </p> |
| 359 |
<p>Consult all objects in the same level as <code class="param">obj</code> and inside CPU set <code class="param">set</code> in the logical order, and return the index of <code class="param">obj</code> within them. If <code class="param">set</code> covers the entire topology, this is the logical index of <code class="param">obj</code>. Otherwise, this is similar to a logical index within the part of the topology defined by CPU set <code class="param">set</code>.</p> |
| 360 |
<dl class="section return"><dt>Returns</dt><dd>the logical index among the objects included in the set if any. </dd> |
| 361 |
<dd> |
| 362 |
-1 if the object is not included in the set.</dd></dl> |
| 363 |
<dl class="section note"><dt>Note</dt><dd>Objects with empty CPU sets are ignored (otherwise they would be considered included in any given set).</dd> |
| 364 |
<dd> |
| 365 |
This function cannot work if obj does not have CPU sets (I/O objects). </dd></dl> |
| 366 |
|
| 367 |
</div> |
| 368 |
</div> |
| 369 |
<a id="ga4eded74ffab87e5ad154c817c2f9fd4c" name="ga4eded74ffab87e5ad154c817c2f9fd4c"></a> |
| 370 |
<h2 class="memtitle"><span class="permalink"><a href="#ga4eded74ffab87e5ad154c817c2f9fd4c">◆ </a></span>hwloc_get_obj_inside_cpuset_by_depth()</h2> |
| 371 |
|
| 372 |
<div class="memitem"> |
| 373 |
<div class="memproto"> |
| 374 |
<table class="mlabels"> |
| 375 |
<tr> |
| 376 |
<td class="mlabels-left"> |
| 377 |
<table class="memname"> |
| 378 |
<tr> |
| 379 |
<td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_obj_inside_cpuset_by_depth </td> |
| 380 |
<td>(</td> |
| 381 |
<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> |
| 382 |
</tr> |
| 383 |
<tr> |
| 384 |
<td class="paramkey"></td> |
| 385 |
<td></td> |
| 386 |
<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> |
| 387 |
</tr> |
| 388 |
<tr> |
| 389 |
<td class="paramkey"></td> |
| 390 |
<td></td> |
| 391 |
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>depth</em></span>, </td> |
| 392 |
</tr> |
| 393 |
<tr> |
| 394 |
<td class="paramkey"></td> |
| 395 |
<td></td> |
| 396 |
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>idx</em></span> )</td> |
| 397 |
</tr> |
| 398 |
</table> |
| 399 |
</td> |
| 400 |
<td class="mlabels-right"> |
| 401 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 402 |
</tr> |
| 403 |
</table> |
| 404 |
</div><div class="memdoc"> |
| 405 |
|
| 406 |
<p>Return the (logically) <code class="param">idx</code> -th object at depth <code class="param">depth</code> included in CPU set <code class="param">set</code>. </p> |
| 407 |
<dl class="section return"><dt>Returns</dt><dd>the object if any, <code>NULL</code> otherwise.</dd></dl> |
| 408 |
<dl class="section note"><dt>Note</dt><dd>Objects with empty CPU sets are ignored (otherwise they would be considered included in any given set).</dd> |
| 409 |
<dd> |
| 410 |
This function cannot work if objects at the given depth do not have CPU sets (I/O or Misc objects). </dd></dl> |
| 411 |
|
| 412 |
</div> |
| 413 |
</div> |
| 414 |
<a id="gaf32c12c931955e111db73bb42921ca76" name="gaf32c12c931955e111db73bb42921ca76"></a> |
| 415 |
<h2 class="memtitle"><span class="permalink"><a href="#gaf32c12c931955e111db73bb42921ca76">◆ </a></span>hwloc_get_obj_inside_cpuset_by_type()</h2> |
| 416 |
|
| 417 |
<div class="memitem"> |
| 418 |
<div class="memproto"> |
| 419 |
<table class="mlabels"> |
| 420 |
<tr> |
| 421 |
<td class="mlabels-left"> |
| 422 |
<table class="memname"> |
| 423 |
<tr> |
| 424 |
<td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_obj_inside_cpuset_by_type </td> |
| 425 |
<td>(</td> |
| 426 |
<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> |
| 427 |
</tr> |
| 428 |
<tr> |
| 429 |
<td class="paramkey"></td> |
| 430 |
<td></td> |
| 431 |
<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> |
| 432 |
</tr> |
| 433 |
<tr> |
| 434 |
<td class="paramkey"></td> |
| 435 |
<td></td> |
| 436 |
<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> |
| 437 |
</tr> |
| 438 |
<tr> |
| 439 |
<td class="paramkey"></td> |
| 440 |
<td></td> |
| 441 |
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>idx</em></span> )</td> |
| 442 |
</tr> |
| 443 |
</table> |
| 444 |
</td> |
| 445 |
<td class="mlabels-right"> |
| 446 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 447 |
</tr> |
| 448 |
</table> |
| 449 |
</div><div class="memdoc"> |
| 450 |
|
| 451 |
<p>Return the <code class="param">idx</code> -th object of type <code class="param">type</code> included in CPU set <code class="param">set</code>. </p> |
| 452 |
<dl class="section return"><dt>Returns</dt><dd>the object if any. </dd> |
| 453 |
<dd> |
| 454 |
<code>NULL</code> if there is no such object. </dd> |
| 455 |
<dd> |
| 456 |
<code>NULL</code> if there is no depth for given type. </dd> |
| 457 |
<dd> |
| 458 |
<code>NULL</code> if there are multiple depths for given type, the caller should fallback to <a class="el" href="#ga4eded74ffab87e5ad154c817c2f9fd4c" title="Return the (logically) idx -th object at depth depth included in CPU set set.">hwloc_get_obj_inside_cpuset_by_depth()</a>.</dd></dl> |
| 459 |
<dl class="section note"><dt>Note</dt><dd>Objects with empty CPU sets are ignored (otherwise they would be considered included in any given set).</dd> |
| 460 |
<dd> |
| 461 |
This function cannot work if objects of the given type do not have CPU sets (I/O or Misc objects). </dd></dl> |
| 462 |
|
| 463 |
</div> |
| 464 |
</div> |
| 465 |
</div><!-- contents --> |
| 466 |
<!-- start footer part --> |
| 467 |
<hr class="footer"/><address class="footer"><small> |
| 468 |
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 |
| 469 |
</small></address> |
| 470 |
</div><!-- doc-content --> |
| 471 |
</body> |
| 472 |
</html> |