| 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): CPU and node sets of entire topologies</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">CPU and node sets of entire topologies </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:gaee30e03391c1ed7dfd617fb5c7bbb033" id="r_gaee30e03391c1ed7dfd617fb5c7bbb033"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaee30e03391c1ed7dfd617fb5c7bbb033">hwloc_topology_get_complete_cpuset</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology)</td></tr> |
| 54 |
<tr class="memitem:ga79212faa07b70dd26588941b17d9fa82" id="r_ga79212faa07b70dd26588941b17d9fa82"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga79212faa07b70dd26588941b17d9fa82">hwloc_topology_get_topology_cpuset</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology)</td></tr> |
| 55 |
<tr class="memitem:ga517d5d68ec9f24583d8933aab713be8e" id="r_ga517d5d68ec9f24583d8933aab713be8e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga517d5d68ec9f24583d8933aab713be8e">hwloc_topology_get_allowed_cpuset</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology)</td></tr> |
| 56 |
<tr class="memitem:ga773fd98949461ef4c1e3170bb0c0418f" id="r_ga773fd98949461ef4c1e3170bb0c0418f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00166.html#ga2f5276235841ad66a79bedad16a5a10c">hwloc_const_nodeset_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga773fd98949461ef4c1e3170bb0c0418f">hwloc_topology_get_complete_nodeset</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology)</td></tr> |
| 57 |
<tr class="memitem:ga3fd37303e99ace8b0d0ea03f95f8c514" id="r_ga3fd37303e99ace8b0d0ea03f95f8c514"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00166.html#ga2f5276235841ad66a79bedad16a5a10c">hwloc_const_nodeset_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3fd37303e99ace8b0d0ea03f95f8c514">hwloc_topology_get_topology_nodeset</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology)</td></tr> |
| 58 |
<tr class="memitem:ga21a4d7237a11e76b912ed4524ab78cbd" id="r_ga21a4d7237a11e76b912ed4524ab78cbd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00166.html#ga2f5276235841ad66a79bedad16a5a10c">hwloc_const_nodeset_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga21a4d7237a11e76b912ed4524ab78cbd">hwloc_topology_get_allowed_nodeset</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology)</td></tr> |
| 59 |
</table> |
| 60 |
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2> |
| 61 |
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2> |
| 62 |
<a id="ga517d5d68ec9f24583d8933aab713be8e" name="ga517d5d68ec9f24583d8933aab713be8e"></a> |
| 63 |
<h2 class="memtitle"><span class="permalink"><a href="#ga517d5d68ec9f24583d8933aab713be8e">◆ </a></span>hwloc_topology_get_allowed_cpuset()</h2> |
| 64 |
|
| 65 |
<div class="memitem"> |
| 66 |
<div class="memproto"> |
| 67 |
<table class="memname"> |
| 68 |
<tr> |
| 69 |
<td class="memname"><a class="el" href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a> hwloc_topology_get_allowed_cpuset </td> |
| 70 |
<td>(</td> |
| 71 |
<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><td>)</td> |
| 72 |
<td></td> |
| 73 |
</tr> |
| 74 |
</table> |
| 75 |
</div><div class="memdoc"> |
| 76 |
|
| 77 |
<p>Get allowed CPU set. </p> |
| 78 |
<dl class="section return"><dt>Returns</dt><dd>the CPU set of allowed processors of the system.</dd></dl> |
| 79 |
<dl class="section note"><dt>Note</dt><dd>This function cannot return <code>NULL</code>.</dd> |
| 80 |
<dd> |
| 81 |
If the topology flag <a class="el" href="a00176.html#ggada025d3ec20b4b420f8038d23d6e7bdea10907044bbb306fd0dc76acf046d9258" title="Detect the whole system, ignore reservations, include disallowed objects.">HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED</a> was not set, this is identical to <a class="el" href="#ga79212faa07b70dd26588941b17d9fa82" title="Get topology CPU set.">hwloc_topology_get_topology_cpuset()</a>, which means all PUs are allowed.</dd> |
| 82 |
<dd> |
| 83 |
If <a class="el" href="a00176.html#ggada025d3ec20b4b420f8038d23d6e7bdea10907044bbb306fd0dc76acf046d9258" title="Detect the whole system, ignore reservations, include disallowed objects.">HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED</a> was set, applying <a class="el" href="a00188.html#gaefa070f9232857ba5a57297ea9a08ea2" title="Test whether bitmaps bitmap1 and bitmap2 intersects.">hwloc_bitmap_intersects()</a> on the result of this function and on an object cpuset checks whether there are allowed PUs inside that object. Applying <a class="el" href="a00188.html#ga674533016ffed922a28b4f0b49b82cd4" title="And bitmaps bitmap1 and bitmap2 and store the result in bitmap res.">hwloc_bitmap_and()</a> returns the list of these allowed PUs.</dd> |
| 84 |
<dd> |
| 85 |
The returned cpuset is not newly allocated and should thus not be changed or freed, <a class="el" href="a00188.html#gae679434c1a5f41d3560a8a7e2c1b0dee" title="Duplicate bitmap bitmap by allocating a new bitmap and copying bitmap contents.">hwloc_bitmap_dup()</a> must be used to obtain a local copy. </dd></dl> |
| 86 |
|
| 87 |
</div> |
| 88 |
</div> |
| 89 |
<a id="ga21a4d7237a11e76b912ed4524ab78cbd" name="ga21a4d7237a11e76b912ed4524ab78cbd"></a> |
| 90 |
<h2 class="memtitle"><span class="permalink"><a href="#ga21a4d7237a11e76b912ed4524ab78cbd">◆ </a></span>hwloc_topology_get_allowed_nodeset()</h2> |
| 91 |
|
| 92 |
<div class="memitem"> |
| 93 |
<div class="memproto"> |
| 94 |
<table class="memname"> |
| 95 |
<tr> |
| 96 |
<td class="memname"><a class="el" href="a00166.html#ga2f5276235841ad66a79bedad16a5a10c">hwloc_const_nodeset_t</a> hwloc_topology_get_allowed_nodeset </td> |
| 97 |
<td>(</td> |
| 98 |
<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><td>)</td> |
| 99 |
<td></td> |
| 100 |
</tr> |
| 101 |
</table> |
| 102 |
</div><div class="memdoc"> |
| 103 |
|
| 104 |
<p>Get allowed node set. </p> |
| 105 |
<dl class="section return"><dt>Returns</dt><dd>the node set of allowed memory of the system.</dd></dl> |
| 106 |
<dl class="section note"><dt>Note</dt><dd>This function cannot return <code>NULL</code>.</dd> |
| 107 |
<dd> |
| 108 |
If the topology flag <a class="el" href="a00176.html#ggada025d3ec20b4b420f8038d23d6e7bdea10907044bbb306fd0dc76acf046d9258" title="Detect the whole system, ignore reservations, include disallowed objects.">HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED</a> was not set, this is identical to <a class="el" href="#ga3fd37303e99ace8b0d0ea03f95f8c514" title="Get topology node set.">hwloc_topology_get_topology_nodeset()</a>, which means all NUMA nodes are allowed.</dd> |
| 109 |
<dd> |
| 110 |
If <a class="el" href="a00176.html#ggada025d3ec20b4b420f8038d23d6e7bdea10907044bbb306fd0dc76acf046d9258" title="Detect the whole system, ignore reservations, include disallowed objects.">HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED</a> was set, applying <a class="el" href="a00188.html#gaefa070f9232857ba5a57297ea9a08ea2" title="Test whether bitmaps bitmap1 and bitmap2 intersects.">hwloc_bitmap_intersects()</a> on the result of this function and on an object nodeset checks whether there are allowed NUMA nodes inside that object. Applying <a class="el" href="a00188.html#ga674533016ffed922a28b4f0b49b82cd4" title="And bitmaps bitmap1 and bitmap2 and store the result in bitmap res.">hwloc_bitmap_and()</a> returns the list of these allowed NUMA nodes.</dd> |
| 111 |
<dd> |
| 112 |
The returned nodeset is not newly allocated and should thus not be changed or freed, <a class="el" href="a00188.html#gae679434c1a5f41d3560a8a7e2c1b0dee" title="Duplicate bitmap bitmap by allocating a new bitmap and copying bitmap contents.">hwloc_bitmap_dup()</a> must be used to obtain a local copy. </dd></dl> |
| 113 |
|
| 114 |
</div> |
| 115 |
</div> |
| 116 |
<a id="gaee30e03391c1ed7dfd617fb5c7bbb033" name="gaee30e03391c1ed7dfd617fb5c7bbb033"></a> |
| 117 |
<h2 class="memtitle"><span class="permalink"><a href="#gaee30e03391c1ed7dfd617fb5c7bbb033">◆ </a></span>hwloc_topology_get_complete_cpuset()</h2> |
| 118 |
|
| 119 |
<div class="memitem"> |
| 120 |
<div class="memproto"> |
| 121 |
<table class="memname"> |
| 122 |
<tr> |
| 123 |
<td class="memname"><a class="el" href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a> hwloc_topology_get_complete_cpuset </td> |
| 124 |
<td>(</td> |
| 125 |
<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><td>)</td> |
| 126 |
<td></td> |
| 127 |
</tr> |
| 128 |
</table> |
| 129 |
</div><div class="memdoc"> |
| 130 |
|
| 131 |
<p>Get complete CPU set. </p> |
| 132 |
<dl class="section return"><dt>Returns</dt><dd>the complete CPU set of processors of the system.</dd></dl> |
| 133 |
<dl class="section note"><dt>Note</dt><dd>This function cannot return <code>NULL</code>.</dd> |
| 134 |
<dd> |
| 135 |
The returned cpuset is not newly allocated and should thus not be changed or freed; <a class="el" href="a00188.html#gae679434c1a5f41d3560a8a7e2c1b0dee" title="Duplicate bitmap bitmap by allocating a new bitmap and copying bitmap contents.">hwloc_bitmap_dup()</a> must be used to obtain a local copy.</dd> |
| 136 |
<dd> |
| 137 |
This is equivalent to retrieving the root object complete CPU-set. </dd></dl> |
| 138 |
|
| 139 |
</div> |
| 140 |
</div> |
| 141 |
<a id="ga773fd98949461ef4c1e3170bb0c0418f" name="ga773fd98949461ef4c1e3170bb0c0418f"></a> |
| 142 |
<h2 class="memtitle"><span class="permalink"><a href="#ga773fd98949461ef4c1e3170bb0c0418f">◆ </a></span>hwloc_topology_get_complete_nodeset()</h2> |
| 143 |
|
| 144 |
<div class="memitem"> |
| 145 |
<div class="memproto"> |
| 146 |
<table class="memname"> |
| 147 |
<tr> |
| 148 |
<td class="memname"><a class="el" href="a00166.html#ga2f5276235841ad66a79bedad16a5a10c">hwloc_const_nodeset_t</a> hwloc_topology_get_complete_nodeset </td> |
| 149 |
<td>(</td> |
| 150 |
<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><td>)</td> |
| 151 |
<td></td> |
| 152 |
</tr> |
| 153 |
</table> |
| 154 |
</div><div class="memdoc"> |
| 155 |
|
| 156 |
<p>Get complete node set. </p> |
| 157 |
<dl class="section return"><dt>Returns</dt><dd>the complete node set of memory of the system.</dd></dl> |
| 158 |
<dl class="section note"><dt>Note</dt><dd>This function cannot return <code>NULL</code>.</dd> |
| 159 |
<dd> |
| 160 |
The returned nodeset is not newly allocated and should thus not be changed or freed; <a class="el" href="a00188.html#gae679434c1a5f41d3560a8a7e2c1b0dee" title="Duplicate bitmap bitmap by allocating a new bitmap and copying bitmap contents.">hwloc_bitmap_dup()</a> must be used to obtain a local copy.</dd> |
| 161 |
<dd> |
| 162 |
This is equivalent to retrieving the root object complete nodeset. </dd></dl> |
| 163 |
|
| 164 |
</div> |
| 165 |
</div> |
| 166 |
<a id="ga79212faa07b70dd26588941b17d9fa82" name="ga79212faa07b70dd26588941b17d9fa82"></a> |
| 167 |
<h2 class="memtitle"><span class="permalink"><a href="#ga79212faa07b70dd26588941b17d9fa82">◆ </a></span>hwloc_topology_get_topology_cpuset()</h2> |
| 168 |
|
| 169 |
<div class="memitem"> |
| 170 |
<div class="memproto"> |
| 171 |
<table class="memname"> |
| 172 |
<tr> |
| 173 |
<td class="memname"><a class="el" href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a> hwloc_topology_get_topology_cpuset </td> |
| 174 |
<td>(</td> |
| 175 |
<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><td>)</td> |
| 176 |
<td></td> |
| 177 |
</tr> |
| 178 |
</table> |
| 179 |
</div><div class="memdoc"> |
| 180 |
|
| 181 |
<p>Get topology CPU set. </p> |
| 182 |
<dl class="section return"><dt>Returns</dt><dd>the CPU set of processors of the system for which hwloc provides topology information. This is equivalent to the cpuset of the system object.</dd></dl> |
| 183 |
<dl class="section note"><dt>Note</dt><dd>This function cannot return <code>NULL</code>.</dd> |
| 184 |
<dd> |
| 185 |
The returned cpuset is not newly allocated and should thus not be changed or freed; <a class="el" href="a00188.html#gae679434c1a5f41d3560a8a7e2c1b0dee" title="Duplicate bitmap bitmap by allocating a new bitmap and copying bitmap contents.">hwloc_bitmap_dup()</a> must be used to obtain a local copy.</dd> |
| 186 |
<dd> |
| 187 |
This is equivalent to retrieving the root object CPU-set. </dd></dl> |
| 188 |
|
| 189 |
</div> |
| 190 |
</div> |
| 191 |
<a id="ga3fd37303e99ace8b0d0ea03f95f8c514" name="ga3fd37303e99ace8b0d0ea03f95f8c514"></a> |
| 192 |
<h2 class="memtitle"><span class="permalink"><a href="#ga3fd37303e99ace8b0d0ea03f95f8c514">◆ </a></span>hwloc_topology_get_topology_nodeset()</h2> |
| 193 |
|
| 194 |
<div class="memitem"> |
| 195 |
<div class="memproto"> |
| 196 |
<table class="memname"> |
| 197 |
<tr> |
| 198 |
<td class="memname"><a class="el" href="a00166.html#ga2f5276235841ad66a79bedad16a5a10c">hwloc_const_nodeset_t</a> hwloc_topology_get_topology_nodeset </td> |
| 199 |
<td>(</td> |
| 200 |
<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><td>)</td> |
| 201 |
<td></td> |
| 202 |
</tr> |
| 203 |
</table> |
| 204 |
</div><div class="memdoc"> |
| 205 |
|
| 206 |
<p>Get topology node set. </p> |
| 207 |
<dl class="section return"><dt>Returns</dt><dd>the node set of memory of the system for which hwloc provides topology information. This is equivalent to the nodeset of the system object.</dd></dl> |
| 208 |
<dl class="section note"><dt>Note</dt><dd>This function cannot return <code>NULL</code>.</dd> |
| 209 |
<dd> |
| 210 |
The returned nodeset is not newly allocated and should thus not be changed or freed; <a class="el" href="a00188.html#gae679434c1a5f41d3560a8a7e2c1b0dee" title="Duplicate bitmap bitmap by allocating a new bitmap and copying bitmap contents.">hwloc_bitmap_dup()</a> must be used to obtain a local copy.</dd> |
| 211 |
<dd> |
| 212 |
This is equivalent to retrieving the root object nodeset. </dd></dl> |
| 213 |
|
| 214 |
</div> |
| 215 |
</div> |
| 216 |
</div><!-- contents --> |
| 217 |
<!-- start footer part --> |
| 218 |
<hr class="footer"/><address class="footer"><small> |
| 219 |
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 |
| 220 |
</small></address> |
| 221 |
</div><!-- doc-content --> |
| 222 |
</body> |
| 223 |
</html> |