Debian Codegraph @

doc/doxygen-doc/html/a00170.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): Object levels, depths and types</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="#enum-members">Enumerations</a> &#124;
47 <a href="#func-members">Functions</a> </div>
48 <div class="headertitle"><div class="title">Object levels, depths and types </div></div>
49 </div><!--header-->
50 <div class="contents">
51 <table class="memberdecls">
52 <tr class="heading"><td colspan="2"><h2 id="header-enum-members" class="groupheader"><a id="enum-members" name="enum-members"></a>
53 Enumerations</h2></td></tr>
54 <tr class="memitem:gaf4e663cf42bbe20756b849c6293ef575" id="r_gaf4e663cf42bbe20756b849c6293ef575"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf4e663cf42bbe20756b849c6293ef575">hwloc_get_type_depth_e</a> { <br />
55 &#160;&#160;<a class="el" href="#ggaf4e663cf42bbe20756b849c6293ef575a0565ab92ab72cb0cec91e23003294aad">HWLOC_TYPE_DEPTH_UNKNOWN</a>
56 , <a class="el" href="#ggaf4e663cf42bbe20756b849c6293ef575ae99465995cacde6c210d5fc2e409798c">HWLOC_TYPE_DEPTH_MULTIPLE</a>
57 , <a class="el" href="#ggaf4e663cf42bbe20756b849c6293ef575a245c34ec9884c2cf5de5049b2153ed9c">HWLOC_TYPE_DEPTH_NUMANODE</a>
58 , <a class="el" href="#ggaf4e663cf42bbe20756b849c6293ef575af93b50182973e4a718d9d4db9e253a90">HWLOC_TYPE_DEPTH_BRIDGE</a>
59 , <br />
60 &#160;&#160;<a class="el" href="#ggaf4e663cf42bbe20756b849c6293ef575ad8b1516e699b57ce1c8d107fbd2f674c">HWLOC_TYPE_DEPTH_PCI_DEVICE</a>
61 , <a class="el" href="#ggaf4e663cf42bbe20756b849c6293ef575afe9a2131073eebbe129d4aa2928d3f46">HWLOC_TYPE_DEPTH_OS_DEVICE</a>
62 , <a class="el" href="#ggaf4e663cf42bbe20756b849c6293ef575a96436a392b4cdcaa1a29bc65351b373f">HWLOC_TYPE_DEPTH_MISC</a>
63 , <a class="el" href="#ggaf4e663cf42bbe20756b849c6293ef575a8b8d7d300c018c0eb65e6c9a9f162101">HWLOC_TYPE_DEPTH_MEMCACHE</a>
64 <br />
65 }</td></tr>
66 </table><table class="memberdecls">
67 <tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
68 Functions</h2></td></tr>
69 <tr class="memitem:gae54d1782ca9b54bea915f5c18a9158fa" id="r_gae54d1782ca9b54bea915f5c18a9158fa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gae54d1782ca9b54bea915f5c18a9158fa">hwloc_topology_get_depth</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> restrict topology)</td></tr>
70 <tr class="memitem:ga8bec782e21be313750da70cf7428b374" id="r_ga8bec782e21be313750da70cf7428b374"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8bec782e21be313750da70cf7428b374">hwloc_get_type_depth</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type)</td></tr>
71 <tr class="memitem:gae85786340b88e24835f8c403a1e2e54b" id="r_gae85786340b88e24835f8c403a1e2e54b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gae85786340b88e24835f8c403a1e2e54b">hwloc_get_memory_parents_depth</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology)</td></tr>
72 <tr class="memitem:gae395d32536ecc0fc916737b655d9d7a1" id="r_gae395d32536ecc0fc916737b655d9d7a1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gae395d32536ecc0fc916737b655d9d7a1">hwloc_get_type_or_below_depth</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type)</td></tr>
73 <tr class="memitem:ga01b8530b755417e25a5ed3153b6680a6" id="r_ga01b8530b755417e25a5ed3153b6680a6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga01b8530b755417e25a5ed3153b6680a6">hwloc_get_type_or_above_depth</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type)</td></tr>
74 <tr class="memitem:ga506b0682b98aa264d53e934d2e9badb0" id="r_ga506b0682b98aa264d53e934d2e9badb0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga506b0682b98aa264d53e934d2e9badb0">hwloc_get_depth_type</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, int depth)</td></tr>
75 <tr class="memitem:ga1d5ceafe8130fe6e8657bf0bc666ba50" id="r_ga1d5ceafe8130fe6e8657bf0bc666ba50"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1d5ceafe8130fe6e8657bf0bc666ba50">hwloc_get_nbobjs_by_depth</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, int depth)</td></tr>
76 <tr class="memitem:ga53caf2bdef1125a2ac4bd792227f86c5" id="r_ga53caf2bdef1125a2ac4bd792227f86c5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga53caf2bdef1125a2ac4bd792227f86c5">hwloc_get_nbobjs_by_type</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type)</td></tr>
77 <tr class="memitem:gae76ac1ab6b8898bfe7667408b84c61d0" id="r_gae76ac1ab6b8898bfe7667408b84c61d0"><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="#gae76ac1ab6b8898bfe7667408b84c61d0">hwloc_get_root_obj</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology)</td></tr>
78 <tr class="memitem:ga391f6b2613f0065673eaa4069b93d4e0" id="r_ga391f6b2613f0065673eaa4069b93d4e0"><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="#ga391f6b2613f0065673eaa4069b93d4e0">hwloc_get_obj_by_depth</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, int depth, unsigned idx)</td></tr>
79 <tr class="memitem:ga1005a33633ddf9f730de692133e83dbd" id="r_ga1005a33633ddf9f730de692133e83dbd"><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="#ga1005a33633ddf9f730de692133e83dbd">hwloc_get_obj_by_type</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type, unsigned idx)</td></tr>
80 <tr class="memitem:ga77627ae88797cb15344ae32cf0298820" id="r_ga77627ae88797cb15344ae32cf0298820"><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="#ga77627ae88797cb15344ae32cf0298820">hwloc_get_next_obj_by_depth</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, int depth, <a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> prev)</td></tr>
81 <tr class="memitem:ga8a90d48363f211740d1154056ea65ad9" id="r_ga8a90d48363f211740d1154056ea65ad9"><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="#ga8a90d48363f211740d1154056ea65ad9">hwloc_get_next_obj_by_type</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <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>
82 </table>
83 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
84 <p>Be sure to see the figure in <a class="el" href="a00371.html">Terms and Definitions</a> that shows a complete topology tree, including depths, child/sibling/cousin relationships, and an example of an asymmetric topology where one package has fewer caches than its peers. </p>
85 <a name="doc-enum-members" id="doc-enum-members"></a><h2 id="header-doc-enum-members" class="groupheader">Enumeration Type Documentation</h2>
86 <a id="gaf4e663cf42bbe20756b849c6293ef575" name="gaf4e663cf42bbe20756b849c6293ef575"></a>
87 <h2 class="memtitle"><span class="permalink"><a href="#gaf4e663cf42bbe20756b849c6293ef575">&#9670;&#160;</a></span>hwloc_get_type_depth_e</h2>
88
89 <div class="memitem">
90 <div class="memproto">
91 <table class="memname">
92 <tr>
93 <td class="memname">enum <a class="el" href="#gaf4e663cf42bbe20756b849c6293ef575">hwloc_get_type_depth_e</a></td>
94 </tr>
95 </table>
96 </div><div class="memdoc">
97 <table class="fieldtable">
98 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaf4e663cf42bbe20756b849c6293ef575a0565ab92ab72cb0cec91e23003294aad" name="ggaf4e663cf42bbe20756b849c6293ef575a0565ab92ab72cb0cec91e23003294aad"></a>HWLOC_TYPE_DEPTH_UNKNOWN&#160;</td><td class="fielddoc"><p>No object of given type exists in the topology. </p>
99 </td></tr>
100 <tr><td class="fieldname"><a id="ggaf4e663cf42bbe20756b849c6293ef575ae99465995cacde6c210d5fc2e409798c" name="ggaf4e663cf42bbe20756b849c6293ef575ae99465995cacde6c210d5fc2e409798c"></a>HWLOC_TYPE_DEPTH_MULTIPLE&#160;</td><td class="fielddoc"><p>Objects of given type exist at different depth in the topology (only for Groups). </p>
101 </td></tr>
102 <tr><td class="fieldname"><a id="ggaf4e663cf42bbe20756b849c6293ef575a245c34ec9884c2cf5de5049b2153ed9c" name="ggaf4e663cf42bbe20756b849c6293ef575a245c34ec9884c2cf5de5049b2153ed9c"></a>HWLOC_TYPE_DEPTH_NUMANODE&#160;</td><td class="fielddoc"><p>Virtual depth for NUMA nodes. </p>
103 </td></tr>
104 <tr><td class="fieldname"><a id="ggaf4e663cf42bbe20756b849c6293ef575af93b50182973e4a718d9d4db9e253a90" name="ggaf4e663cf42bbe20756b849c6293ef575af93b50182973e4a718d9d4db9e253a90"></a>HWLOC_TYPE_DEPTH_BRIDGE&#160;</td><td class="fielddoc"><p>Virtual depth for bridge object level. </p>
105 </td></tr>
106 <tr><td class="fieldname"><a id="ggaf4e663cf42bbe20756b849c6293ef575ad8b1516e699b57ce1c8d107fbd2f674c" name="ggaf4e663cf42bbe20756b849c6293ef575ad8b1516e699b57ce1c8d107fbd2f674c"></a>HWLOC_TYPE_DEPTH_PCI_DEVICE&#160;</td><td class="fielddoc"><p>Virtual depth for PCI device object level. </p>
107 </td></tr>
108 <tr><td class="fieldname"><a id="ggaf4e663cf42bbe20756b849c6293ef575afe9a2131073eebbe129d4aa2928d3f46" name="ggaf4e663cf42bbe20756b849c6293ef575afe9a2131073eebbe129d4aa2928d3f46"></a>HWLOC_TYPE_DEPTH_OS_DEVICE&#160;</td><td class="fielddoc"><p>Virtual depth for software device object level. </p>
109 </td></tr>
110 <tr><td class="fieldname"><a id="ggaf4e663cf42bbe20756b849c6293ef575a96436a392b4cdcaa1a29bc65351b373f" name="ggaf4e663cf42bbe20756b849c6293ef575a96436a392b4cdcaa1a29bc65351b373f"></a>HWLOC_TYPE_DEPTH_MISC&#160;</td><td class="fielddoc"><p>Virtual depth for Misc object. </p>
111 </td></tr>
112 <tr><td class="fieldname"><a id="ggaf4e663cf42bbe20756b849c6293ef575a8b8d7d300c018c0eb65e6c9a9f162101" name="ggaf4e663cf42bbe20756b849c6293ef575a8b8d7d300c018c0eb65e6c9a9f162101"></a>HWLOC_TYPE_DEPTH_MEMCACHE&#160;</td><td class="fielddoc"><p>Virtual depth for MemCache object. </p>
113 </td></tr>
114 </table>
115
116 </div>
117 </div>
118 <a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
119 <a id="ga506b0682b98aa264d53e934d2e9badb0" name="ga506b0682b98aa264d53e934d2e9badb0"></a>
120 <h2 class="memtitle"><span class="permalink"><a href="#ga506b0682b98aa264d53e934d2e9badb0">&#9670;&#160;</a></span>hwloc_get_depth_type()</h2>
121
122 <div class="memitem">
123 <div class="memproto">
124 <table class="memname">
125 <tr>
126 <td class="memname"><a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> hwloc_get_depth_type </td>
127 <td>(</td>
128 <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>
129 </tr>
130 <tr>
131 <td class="paramkey"></td>
132 <td></td>
133 <td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>depth</em></span>&#160;)</td>
134 </tr>
135 </table>
136 </div><div class="memdoc">
137
138 <p>Returns the type of objects at depth <code class="param">depth</code>. </p>
139 <p><code class="param">depth</code> should between 0 and <a class="el" href="#gae54d1782ca9b54bea915f5c18a9158fa" title="Get the depth of the hierarchical tree of objects.">hwloc_topology_get_depth()</a>-1, or a virtual depth such as <a class="el" href="#ggaf4e663cf42bbe20756b849c6293ef575a245c34ec9884c2cf5de5049b2153ed9c" title="Virtual depth for NUMA nodes.">HWLOC_TYPE_DEPTH_NUMANODE</a>.</p>
140 <dl class="section return"><dt>Returns</dt><dd>The type of objects at depth <code class="param">depth</code>. </dd>
141 <dd>
142 (<a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55" title="Type of topology object.">hwloc_obj_type_t</a>)-1 if depth <code class="param">depth</code> does not exist. </dd></dl>
143
144 </div>
145 </div>
146 <a id="gae85786340b88e24835f8c403a1e2e54b" name="gae85786340b88e24835f8c403a1e2e54b"></a>
147 <h2 class="memtitle"><span class="permalink"><a href="#gae85786340b88e24835f8c403a1e2e54b">&#9670;&#160;</a></span>hwloc_get_memory_parents_depth()</h2>
148
149 <div class="memitem">
150 <div class="memproto">
151 <table class="memname">
152 <tr>
153 <td class="memname">int hwloc_get_memory_parents_depth </td>
154 <td>(</td>
155 <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>
156 <td></td>
157 </tr>
158 </table>
159 </div><div class="memdoc">
160
161 <p>Return the depth of parents where memory objects are attached. </p>
162 <p>Memory objects have virtual negative depths because they are not part of the main CPU-side hierarchy of objects. This depth should not be compared with other level depths.</p>
163 <p>If all Memory objects are attached to Normal parents at the same depth, this parent depth may be compared to other as usual, for instance for knowing whether NUMA nodes is attached above or below Packages.</p>
164 <dl class="section return"><dt>Returns</dt><dd>The depth of Normal parents of all memory children if all these parents have the same depth. For instance the depth of the Package level if all NUMA nodes are attached to Package objects.</dd>
165 <dd>
166 <a class="el" href="#ggaf4e663cf42bbe20756b849c6293ef575ae99465995cacde6c210d5fc2e409798c" title="Objects of given type exist at different depth in the topology (only for Groups).">HWLOC_TYPE_DEPTH_MULTIPLE</a> if Normal parents of all memory children do not have the same depth. For instance if some NUMA nodes are attached to Packages while others are attached to Groups. </dd></dl>
167
168 </div>
169 </div>
170 <a id="ga1d5ceafe8130fe6e8657bf0bc666ba50" name="ga1d5ceafe8130fe6e8657bf0bc666ba50"></a>
171 <h2 class="memtitle"><span class="permalink"><a href="#ga1d5ceafe8130fe6e8657bf0bc666ba50">&#9670;&#160;</a></span>hwloc_get_nbobjs_by_depth()</h2>
172
173 <div class="memitem">
174 <div class="memproto">
175 <table class="memname">
176 <tr>
177 <td class="memname">unsigned hwloc_get_nbobjs_by_depth </td>
178 <td>(</td>
179 <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>
180 </tr>
181 <tr>
182 <td class="paramkey"></td>
183 <td></td>
184 <td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>depth</em></span>&#160;)</td>
185 </tr>
186 </table>
187 </div><div class="memdoc">
188
189 <p>Returns the width of level at depth <code class="param">depth</code>. </p>
190 <dl class="section return"><dt>Returns</dt><dd>The number of objects at topology depth <code class="param">depth</code>. </dd>
191 <dd>
192 0 if there are no objects at depth <code class="param">depth</code>. </dd></dl>
193
194 </div>
195 </div>
196 <a id="ga53caf2bdef1125a2ac4bd792227f86c5" name="ga53caf2bdef1125a2ac4bd792227f86c5"></a>
197 <h2 class="memtitle"><span class="permalink"><a href="#ga53caf2bdef1125a2ac4bd792227f86c5">&#9670;&#160;</a></span>hwloc_get_nbobjs_by_type()</h2>
198
199 <div class="memitem">
200 <div class="memproto">
201 <table class="mlabels">
202 <tr>
203 <td class="mlabels-left">
204 <table class="memname">
205 <tr>
206 <td class="memname">int hwloc_get_nbobjs_by_type </td>
207 <td>(</td>
208 <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>
209 </tr>
210 <tr>
211 <td class="paramkey"></td>
212 <td></td>
213 <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>&#160;)</td>
214 </tr>
215 </table>
216 </td>
217 <td class="mlabels-right">
218 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
219 </tr>
220 </table>
221 </div><div class="memdoc">
222
223 <p>Returns the width of level type <code class="param">type</code>. </p>
224 <dl class="section return"><dt>Returns</dt><dd>The number of objects of type <code class="param">type</code>. </dd>
225 <dd>
226 -1 if there are multiple levels with objects of that type, e.g. <a class="el" href="a00167.html#ggacd37bb612667dc437d66bfb175a8dc55a5269ef95be72f88465559d35c9b7ad56" title="Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...">HWLOC_OBJ_GROUP</a>. </dd>
227 <dd>
228 0 if there are no objects at depth <code class="param">depth</code>. </dd></dl>
229
230 </div>
231 </div>
232 <a id="ga77627ae88797cb15344ae32cf0298820" name="ga77627ae88797cb15344ae32cf0298820"></a>
233 <h2 class="memtitle"><span class="permalink"><a href="#ga77627ae88797cb15344ae32cf0298820">&#9670;&#160;</a></span>hwloc_get_next_obj_by_depth()</h2>
234
235 <div class="memitem">
236 <div class="memproto">
237 <table class="mlabels">
238 <tr>
239 <td class="mlabels-left">
240 <table class="memname">
241 <tr>
242 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_next_obj_by_depth </td>
243 <td>(</td>
244 <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>
245 </tr>
246 <tr>
247 <td class="paramkey"></td>
248 <td></td>
249 <td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>depth</em></span>, </td>
250 </tr>
251 <tr>
252 <td class="paramkey"></td>
253 <td></td>
254 <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>
255 </tr>
256 </table>
257 </td>
258 <td class="mlabels-right">
259 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
260 </tr>
261 </table>
262 </div><div class="memdoc">
263
264 <p>Returns the next object at depth <code class="param">depth</code>. </p>
265 <dl class="section return"><dt>Returns</dt><dd>The first object at depth <code class="param">depth</code> if <code class="param">prev</code> is <code>NULL</code>. </dd>
266 <dd>
267 The object after <code class="param">prev</code> at depth <code class="param">depth</code> if <code class="param">prev</code> is not <code>NULL</code>. </dd>
268 <dd>
269 <code>NULL</code> if there is no such object. </dd></dl>
270
271 </div>
272 </div>
273 <a id="ga8a90d48363f211740d1154056ea65ad9" name="ga8a90d48363f211740d1154056ea65ad9"></a>
274 <h2 class="memtitle"><span class="permalink"><a href="#ga8a90d48363f211740d1154056ea65ad9">&#9670;&#160;</a></span>hwloc_get_next_obj_by_type()</h2>
275
276 <div class="memitem">
277 <div class="memproto">
278 <table class="mlabels">
279 <tr>
280 <td class="mlabels-left">
281 <table class="memname">
282 <tr>
283 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_next_obj_by_type </td>
284 <td>(</td>
285 <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>
286 </tr>
287 <tr>
288 <td class="paramkey"></td>
289 <td></td>
290 <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>
291 </tr>
292 <tr>
293 <td class="paramkey"></td>
294 <td></td>
295 <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>
296 </tr>
297 </table>
298 </td>
299 <td class="mlabels-right">
300 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
301 </tr>
302 </table>
303 </div><div class="memdoc">
304
305 <p>Returns the next object of type <code class="param">type</code>. </p>
306 <dl class="section return"><dt>Returns</dt><dd>The first object of type <code class="param">type</code> if <code class="param">prev</code> is <code>NULL</code>. </dd>
307 <dd>
308 The object after <code class="param">prev</code> of type <code class="param">type</code> if <code class="param">prev</code> is not <code>NULL</code>. </dd>
309 <dd>
310 <code>NULL</code> if there is no such object. </dd>
311 <dd>
312 <code>NULL</code> if there are multiple levels with objects of that type (e.g. <a class="el" href="a00167.html#ggacd37bb612667dc437d66bfb175a8dc55a5269ef95be72f88465559d35c9b7ad56" title="Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...">HWLOC_OBJ_GROUP</a>), the caller may fallback to <a class="el" href="#ga391f6b2613f0065673eaa4069b93d4e0" title="Returns the topology object at logical index idx from depth depth.">hwloc_get_obj_by_depth()</a>. </dd></dl>
313
314 </div>
315 </div>
316 <a id="ga391f6b2613f0065673eaa4069b93d4e0" name="ga391f6b2613f0065673eaa4069b93d4e0"></a>
317 <h2 class="memtitle"><span class="permalink"><a href="#ga391f6b2613f0065673eaa4069b93d4e0">&#9670;&#160;</a></span>hwloc_get_obj_by_depth()</h2>
318
319 <div class="memitem">
320 <div class="memproto">
321 <table class="memname">
322 <tr>
323 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_obj_by_depth </td>
324 <td>(</td>
325 <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>
326 </tr>
327 <tr>
328 <td class="paramkey"></td>
329 <td></td>
330 <td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>depth</em></span>, </td>
331 </tr>
332 <tr>
333 <td class="paramkey"></td>
334 <td></td>
335 <td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>idx</em></span>&#160;)</td>
336 </tr>
337 </table>
338 </div><div class="memdoc">
339
340 <p>Returns the topology object at logical index <code class="param">idx</code> from depth <code class="param">depth</code>. </p>
341 <dl class="section return"><dt>Returns</dt><dd>The object if it exists. </dd>
342 <dd>
343 <code>NULL</code> if there is no object with this index and depth. </dd></dl>
344
345 </div>
346 </div>
347 <a id="ga1005a33633ddf9f730de692133e83dbd" name="ga1005a33633ddf9f730de692133e83dbd"></a>
348 <h2 class="memtitle"><span class="permalink"><a href="#ga1005a33633ddf9f730de692133e83dbd">&#9670;&#160;</a></span>hwloc_get_obj_by_type()</h2>
349
350 <div class="memitem">
351 <div class="memproto">
352 <table class="mlabels">
353 <tr>
354 <td class="mlabels-left">
355 <table class="memname">
356 <tr>
357 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_obj_by_type </td>
358 <td>(</td>
359 <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>
360 </tr>
361 <tr>
362 <td class="paramkey"></td>
363 <td></td>
364 <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>
365 </tr>
366 <tr>
367 <td class="paramkey"></td>
368 <td></td>
369 <td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>idx</em></span>&#160;)</td>
370 </tr>
371 </table>
372 </td>
373 <td class="mlabels-right">
374 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
375 </tr>
376 </table>
377 </div><div class="memdoc">
378
379 <p>Returns the topology object at logical index <code class="param">idx</code> with type <code class="param">type</code>. </p>
380 <dl class="section return"><dt>Returns</dt><dd>The object if it exists. </dd>
381 <dd>
382 <code>NULL</code> if there is no object with this index and type. </dd>
383 <dd>
384 <code>NULL</code> if there are multiple levels with objects of that type (e.g. <a class="el" href="a00167.html#ggacd37bb612667dc437d66bfb175a8dc55a5269ef95be72f88465559d35c9b7ad56" title="Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...">HWLOC_OBJ_GROUP</a>), the caller may fallback to <a class="el" href="#ga391f6b2613f0065673eaa4069b93d4e0" title="Returns the topology object at logical index idx from depth depth.">hwloc_get_obj_by_depth()</a>. </dd></dl>
385
386 </div>
387 </div>
388 <a id="gae76ac1ab6b8898bfe7667408b84c61d0" name="gae76ac1ab6b8898bfe7667408b84c61d0"></a>
389 <h2 class="memtitle"><span class="permalink"><a href="#gae76ac1ab6b8898bfe7667408b84c61d0">&#9670;&#160;</a></span>hwloc_get_root_obj()</h2>
390
391 <div class="memitem">
392 <div class="memproto">
393 <table class="mlabels">
394 <tr>
395 <td class="mlabels-left">
396 <table class="memname">
397 <tr>
398 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_root_obj </td>
399 <td>(</td>
400 <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>
401 <td></td>
402 </tr>
403 </table>
404 </td>
405 <td class="mlabels-right">
406 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
407 </tr>
408 </table>
409 </div><div class="memdoc">
410
411 <p>Returns the top-object of the topology-tree. </p>
412 <p>Its type is <a class="el" href="a00167.html#ggacd37bb612667dc437d66bfb175a8dc55a3f4e83ffc4a259354959ae8a9eaa2a80" title="Machine. A set of processors and memory with cache coherency.">HWLOC_OBJ_MACHINE</a>.</p>
413 <p>This function cannot return <code>NULL</code>. </p>
414
415 </div>
416 </div>
417 <a id="ga8bec782e21be313750da70cf7428b374" name="ga8bec782e21be313750da70cf7428b374"></a>
418 <h2 class="memtitle"><span class="permalink"><a href="#ga8bec782e21be313750da70cf7428b374">&#9670;&#160;</a></span>hwloc_get_type_depth()</h2>
419
420 <div class="memitem">
421 <div class="memproto">
422 <table class="memname">
423 <tr>
424 <td class="memname">int hwloc_get_type_depth </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="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a></td> <td class="paramname"><span class="paramname"><em>type</em></span>&#160;)</td>
432 </tr>
433 </table>
434 </div><div class="memdoc">
435
436 <p>Returns the depth of objects of type <code class="param">type</code>. </p>
437 <dl class="section return"><dt>Returns</dt><dd>The depth of objects of type <code class="param">type</code>.</dd>
438 <dd>
439 A negative virtual depth if a NUMA node, I/O or Misc object type is given. These objects are stored in special levels that are not CPU-related. This virtual depth may be passed to other hwloc functions such as <a class="el" href="#ga391f6b2613f0065673eaa4069b93d4e0" title="Returns the topology object at logical index idx from depth depth.">hwloc_get_obj_by_depth()</a> but it should not be considered as an actual depth by the application. In particular, it should not be compared with any other object depth or with the entire topology depth.</dd>
440 <dd>
441 <a class="el" href="#ggaf4e663cf42bbe20756b849c6293ef575a0565ab92ab72cb0cec91e23003294aad" title="No object of given type exists in the topology.">HWLOC_TYPE_DEPTH_UNKNOWN</a> if no object of this type is present on the underlying architecture, or if the OS doesn't provide this kind of information.</dd>
442 <dd>
443 <a class="el" href="#ggaf4e663cf42bbe20756b849c6293ef575ae99465995cacde6c210d5fc2e409798c" title="Objects of given type exist at different depth in the topology (only for Groups).">HWLOC_TYPE_DEPTH_MULTIPLE</a> if type <a class="el" href="a00167.html#ggacd37bb612667dc437d66bfb175a8dc55a5269ef95be72f88465559d35c9b7ad56" title="Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...">HWLOC_OBJ_GROUP</a> is given and multiple levels of Groups exist.</dd></dl>
444 <dl class="section note"><dt>Note</dt><dd>If the type is absent but a similar type is acceptable, see also <a class="el" href="#gae395d32536ecc0fc916737b655d9d7a1" title="Returns the depth of objects of type type or below.">hwloc_get_type_or_below_depth()</a> and <a class="el" href="#ga01b8530b755417e25a5ed3153b6680a6" title="Returns the depth of objects of type type or above.">hwloc_get_type_or_above_depth()</a>.</dd></dl>
445 <dl class="section see"><dt>See also</dt><dd><a class="el" href="#gae85786340b88e24835f8c403a1e2e54b" title="Return the depth of parents where memory objects are attached.">hwloc_get_memory_parents_depth()</a> for managing the depth of memory objects.</dd>
446 <dd>
447 <a class="el" href="a00171.html#ga52c63cd7203e55b804c1314affc9bd12" title="Return an object type and its level depth from a type string.">hwloc_type_sscanf_as_depth()</a> for returning the depth of objects whose type is given as a string. </dd></dl>
448
449 </div>
450 </div>
451 <a id="ga01b8530b755417e25a5ed3153b6680a6" name="ga01b8530b755417e25a5ed3153b6680a6"></a>
452 <h2 class="memtitle"><span class="permalink"><a href="#ga01b8530b755417e25a5ed3153b6680a6">&#9670;&#160;</a></span>hwloc_get_type_or_above_depth()</h2>
453
454 <div class="memitem">
455 <div class="memproto">
456 <table class="mlabels">
457 <tr>
458 <td class="mlabels-left">
459 <table class="memname">
460 <tr>
461 <td class="memname">int hwloc_get_type_or_above_depth </td>
462 <td>(</td>
463 <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>
464 </tr>
465 <tr>
466 <td class="paramkey"></td>
467 <td></td>
468 <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>&#160;)</td>
469 </tr>
470 </table>
471 </td>
472 <td class="mlabels-right">
473 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
474 </tr>
475 </table>
476 </div><div class="memdoc">
477
478 <p>Returns the depth of objects of type <code class="param">type</code> or above. </p>
479 <p>If no object of this type is present on the underlying architecture, the function returns the depth of the first "present" object typically containing <code class="param">type</code>.</p>
480 <p>This function is only meaningful for normal object types. If a memory, I/O or Misc object type is given, the corresponding virtual depth is always returned (see <a class="el" href="#ga8bec782e21be313750da70cf7428b374" title="Returns the depth of objects of type type.">hwloc_get_type_depth()</a>).</p>
481 <p>May return <a class="el" href="#ggaf4e663cf42bbe20756b849c6293ef575ae99465995cacde6c210d5fc2e409798c" title="Objects of given type exist at different depth in the topology (only for Groups).">HWLOC_TYPE_DEPTH_MULTIPLE</a> for <a class="el" href="a00167.html#ggacd37bb612667dc437d66bfb175a8dc55a5269ef95be72f88465559d35c9b7ad56" title="Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...">HWLOC_OBJ_GROUP</a> just like <a class="el" href="#ga8bec782e21be313750da70cf7428b374" title="Returns the depth of objects of type type.">hwloc_get_type_depth()</a>. </p>
482
483 </div>
484 </div>
485 <a id="gae395d32536ecc0fc916737b655d9d7a1" name="gae395d32536ecc0fc916737b655d9d7a1"></a>
486 <h2 class="memtitle"><span class="permalink"><a href="#gae395d32536ecc0fc916737b655d9d7a1">&#9670;&#160;</a></span>hwloc_get_type_or_below_depth()</h2>
487
488 <div class="memitem">
489 <div class="memproto">
490 <table class="mlabels">
491 <tr>
492 <td class="mlabels-left">
493 <table class="memname">
494 <tr>
495 <td class="memname">int hwloc_get_type_or_below_depth </td>
496 <td>(</td>
497 <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>
498 </tr>
499 <tr>
500 <td class="paramkey"></td>
501 <td></td>
502 <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>&#160;)</td>
503 </tr>
504 </table>
505 </td>
506 <td class="mlabels-right">
507 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
508 </tr>
509 </table>
510 </div><div class="memdoc">
511
512 <p>Returns the depth of objects of type <code class="param">type</code> or below. </p>
513 <p>If no object of this type is present on the underlying architecture, the function returns the depth of the first "present" object typically found inside <code class="param">type</code>.</p>
514 <p>This function is only meaningful for normal object types. If a memory, I/O or Misc object type is given, the corresponding virtual depth is always returned (see <a class="el" href="#ga8bec782e21be313750da70cf7428b374" title="Returns the depth of objects of type type.">hwloc_get_type_depth()</a>).</p>
515 <p>May return <a class="el" href="#ggaf4e663cf42bbe20756b849c6293ef575ae99465995cacde6c210d5fc2e409798c" title="Objects of given type exist at different depth in the topology (only for Groups).">HWLOC_TYPE_DEPTH_MULTIPLE</a> for <a class="el" href="a00167.html#ggacd37bb612667dc437d66bfb175a8dc55a5269ef95be72f88465559d35c9b7ad56" title="Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...">HWLOC_OBJ_GROUP</a> just like <a class="el" href="#ga8bec782e21be313750da70cf7428b374" title="Returns the depth of objects of type type.">hwloc_get_type_depth()</a>. </p>
516
517 </div>
518 </div>
519 <a id="gae54d1782ca9b54bea915f5c18a9158fa" name="gae54d1782ca9b54bea915f5c18a9158fa"></a>
520 <h2 class="memtitle"><span class="permalink"><a href="#gae54d1782ca9b54bea915f5c18a9158fa">&#9670;&#160;</a></span>hwloc_topology_get_depth()</h2>
521
522 <div class="memitem">
523 <div class="memproto">
524 <table class="memname">
525 <tr>
526 <td class="memname">int hwloc_topology_get_depth </td>
527 <td>(</td>
528 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> restrict</td> <td class="paramname"><span class="paramname"><em>topology</em></span></td><td>)</td>
529 <td></td>
530 </tr>
531 </table>
532 </div><div class="memdoc">
533
534 <p>Get the depth of the hierarchical tree of objects. </p>
535 <p>This is the depth of <a class="el" href="a00167.html#ggacd37bb612667dc437d66bfb175a8dc55abca6887e80cb291353b0a0c1da83f661" title="Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...">HWLOC_OBJ_PU</a> objects plus one.</p>
536 <dl class="section return"><dt>Returns</dt><dd>the depth of the object tree.</dd></dl>
537 <dl class="section note"><dt>Note</dt><dd>NUMA nodes, I/O and Misc objects are ignored when computing the depth of the tree (they are placed on special levels). </dd></dl>
538
539 </div>
540 </div>
541 </div><!-- contents -->
542 <!-- start footer part -->
543 <hr class="footer"/><address class="footer"><small>
544 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
545 </small></address>
546 </div><!-- doc-content -->
547 </body>
548 </html>