Debian Codegraph @

doc/doxygen-doc/html/a00224.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): hwloc_obj Struct Reference</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="#pub-attribs">Data Fields</a> </div>
47 <div class="headertitle"><div class="title">hwloc_obj Struct Reference<div class="ingroups"><a class="el" href="a00168.html">Object Structure and Attributes</a></div></div></div>
48 </div><!--header-->
49 <div class="contents">
50
51 <p><code>#include &lt;<a class="el" href="a00095_source.html">hwloc.h</a>&gt;</code></p>
52 <table class="memberdecls">
53 <tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
54 Data Fields</h2></td></tr>
55 <tr class="memitem:acc4f0803f244867e68fe0036800be5de" id="r_acc4f0803f244867e68fe0036800be5de"><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="#acc4f0803f244867e68fe0036800be5de">type</a></td></tr>
56 <tr class="memitem:a5d4f97e76723a9ec8d38046f19e00d33" id="r_a5d4f97e76723a9ec8d38046f19e00d33"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5d4f97e76723a9ec8d38046f19e00d33">subtype</a></td></tr>
57 <tr class="memitem:a61a7a80a68eaccbaaa28269e678c81a9" id="r_a61a7a80a68eaccbaaa28269e678c81a9"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a61a7a80a68eaccbaaa28269e678c81a9">os_index</a></td></tr>
58 <tr class="memitem:abb709ec38f2970677e4e57d1d30be96d" id="r_abb709ec38f2970677e4e57d1d30be96d"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abb709ec38f2970677e4e57d1d30be96d">name</a></td></tr>
59 <tr class="memitem:a75603fc36c9284ba48ce814b772a58b6" id="r_a75603fc36c9284ba48ce814b772a58b6"><td class="memItemLeft" align="right" valign="top">hwloc_uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a75603fc36c9284ba48ce814b772a58b6">total_memory</a></td></tr>
60 <tr class="memitem:accd40e29f71f19e88db62ea3df02adc8" id="r_accd40e29f71f19e88db62ea3df02adc8"><td class="memItemLeft" align="right" valign="top">union <a class="el" href="a00228.html">hwloc_obj_attr_u</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#accd40e29f71f19e88db62ea3df02adc8">attr</a></td></tr>
61 <tr class="memitem:a4876fd165b4fff35521f07ebd85355ed" id="r_a4876fd165b4fff35521f07ebd85355ed"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4876fd165b4fff35521f07ebd85355ed">depth</a></td></tr>
62 <tr class="memitem:a0d07fb7b8935e137c94d75a3eb492ae9" id="r_a0d07fb7b8935e137c94d75a3eb492ae9"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0d07fb7b8935e137c94d75a3eb492ae9">logical_index</a></td></tr>
63 <tr class="memitem:a85a788017457129589318b6c39451acf" id="r_a85a788017457129589318b6c39451acf"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="a00224.html">hwloc_obj</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a85a788017457129589318b6c39451acf">next_cousin</a></td></tr>
64 <tr class="memitem:ac715989f55ff5a0eb6be2969ee477ec0" id="r_ac715989f55ff5a0eb6be2969ee477ec0"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="a00224.html">hwloc_obj</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac715989f55ff5a0eb6be2969ee477ec0">prev_cousin</a></td></tr>
65 <tr class="memitem:adc494f6aed939992be1c55cca5822900" id="r_adc494f6aed939992be1c55cca5822900"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="a00224.html">hwloc_obj</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adc494f6aed939992be1c55cca5822900">parent</a></td></tr>
66 <tr class="memitem:aaa6043eee6f55869933c1d974efd9acd" id="r_aaa6043eee6f55869933c1d974efd9acd"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaa6043eee6f55869933c1d974efd9acd">sibling_rank</a></td></tr>
67 <tr class="memitem:a7f2343ed476fe4942e6fffd4cade1b40" id="r_a7f2343ed476fe4942e6fffd4cade1b40"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="a00224.html">hwloc_obj</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7f2343ed476fe4942e6fffd4cade1b40">next_sibling</a></td></tr>
68 <tr class="memitem:a7b89e8c189876c0158a9282aaaf17f50" id="r_a7b89e8c189876c0158a9282aaaf17f50"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="a00224.html">hwloc_obj</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7b89e8c189876c0158a9282aaaf17f50">prev_sibling</a></td></tr>
69 <tr class="memitem:a0f41a1d67dc6b661906f2217563637f3" id="r_a0f41a1d67dc6b661906f2217563637f3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0f41a1d67dc6b661906f2217563637f3">symmetric_subtree</a></td></tr>
70 <tr class="memitem:a67925e0f2c47f50408fbdb9bddd0790f" id="r_a67925e0f2c47f50408fbdb9bddd0790f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00166.html#ga4bbf39b68b6f568fb92739e7c0ea7801">hwloc_cpuset_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a67925e0f2c47f50408fbdb9bddd0790f">cpuset</a></td></tr>
71 <tr class="memitem:a91788a9da687beb7224cc1fd7b75208c" id="r_a91788a9da687beb7224cc1fd7b75208c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00166.html#ga4bbf39b68b6f568fb92739e7c0ea7801">hwloc_cpuset_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a91788a9da687beb7224cc1fd7b75208c">complete_cpuset</a></td></tr>
72 <tr class="memitem:a08f0d0e16c619a6e653526cbee4ffea3" id="r_a08f0d0e16c619a6e653526cbee4ffea3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00166.html#ga37e35730fa7e775b5bb0afe893d6d508">hwloc_nodeset_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a08f0d0e16c619a6e653526cbee4ffea3">nodeset</a></td></tr>
73 <tr class="memitem:ac38c4012127525ef74c5615c526f4c2e" id="r_ac38c4012127525ef74c5615c526f4c2e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00166.html#ga37e35730fa7e775b5bb0afe893d6d508">hwloc_nodeset_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac38c4012127525ef74c5615c526f4c2e">complete_nodeset</a></td></tr>
74 <tr class="memitem:a8604654c38b7a720efae5025d3a96ee6" id="r_a8604654c38b7a720efae5025d3a96ee6"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="a00272.html">hwloc_info_s</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8604654c38b7a720efae5025d3a96ee6">infos</a></td></tr>
75 <tr class="memitem:a9843acc28cfbba903b63ea14b137ff70" id="r_a9843acc28cfbba903b63ea14b137ff70"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9843acc28cfbba903b63ea14b137ff70">infos_count</a></td></tr>
76 <tr class="memitem:a76fd3ac94401cf32dfccc3a3a8de68a5" id="r_a76fd3ac94401cf32dfccc3a3a8de68a5"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a76fd3ac94401cf32dfccc3a3a8de68a5">userdata</a></td></tr>
77 <tr class="memitem:a957984a355fa61c85f46605c336e7551" id="r_a957984a355fa61c85f46605c336e7551"><td class="memItemLeft" align="right" valign="top">hwloc_uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a957984a355fa61c85f46605c336e7551">gp_index</a></td></tr>
78 <tr id="pub-attribs-0" class="groupHeader"><td colspan="2"><div class="groupHeader">List and array of normal children below this object (except Memory, I/O and Misc children).</div></td></tr>
79 <tr class="memitem:aac3f6da35c9b57599909a44ce2b716c1" id="r_aac3f6da35c9b57599909a44ce2b716c1"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aac3f6da35c9b57599909a44ce2b716c1">arity</a></td></tr>
80 <tr class="memitem:a04d05403da37bfe17cd63b7c7dd07b1f" id="r_a04d05403da37bfe17cd63b7c7dd07b1f"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="a00224.html">hwloc_obj</a> **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a04d05403da37bfe17cd63b7c7dd07b1f">children</a></td></tr>
81 <tr class="memitem:af51d08a0a79dba517c06c5afedc8d2dc" id="r_af51d08a0a79dba517c06c5afedc8d2dc"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="a00224.html">hwloc_obj</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af51d08a0a79dba517c06c5afedc8d2dc">first_child</a></td></tr>
82 <tr class="memitem:a84bd65634dbc55f4158b74443a9bd04f" id="r_a84bd65634dbc55f4158b74443a9bd04f"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="a00224.html">hwloc_obj</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a84bd65634dbc55f4158b74443a9bd04f">last_child</a></td></tr>
83 <tr id="pub-attribs-1" class="groupHeader"><td colspan="2"><div class="groupHeader">List of Memory children below this object.</div></td></tr>
84 <tr class="memitem:a6f834ea4dd26553cdea601d2fae6d3b7" id="r_a6f834ea4dd26553cdea601d2fae6d3b7"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6f834ea4dd26553cdea601d2fae6d3b7">memory_arity</a></td></tr>
85 <tr class="memitem:ac0e8200dba25b90d5954bd4ec61f97d3" id="r_ac0e8200dba25b90d5954bd4ec61f97d3"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="a00224.html">hwloc_obj</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac0e8200dba25b90d5954bd4ec61f97d3">memory_first_child</a></td></tr>
86 <tr id="pub-attribs-2" class="groupHeader"><td colspan="2"><div class="groupHeader">List of I/O children below this object.</div></td></tr>
87 <tr class="memitem:a7b3b29f0be377c7d2d52262019fc7d11" id="r_a7b3b29f0be377c7d2d52262019fc7d11"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7b3b29f0be377c7d2d52262019fc7d11">io_arity</a></td></tr>
88 <tr class="memitem:a8d14c88e1ebc4ae67cc69f9e928558b3" id="r_a8d14c88e1ebc4ae67cc69f9e928558b3"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="a00224.html">hwloc_obj</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8d14c88e1ebc4ae67cc69f9e928558b3">io_first_child</a></td></tr>
89 <tr id="pub-attribs-3" class="groupHeader"><td colspan="2"><div class="groupHeader">List of Misc children below this object.</div></td></tr>
90 <tr class="memitem:a2bb7862ce722d7ceda23cfa153da165a" id="r_a2bb7862ce722d7ceda23cfa153da165a"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2bb7862ce722d7ceda23cfa153da165a">misc_arity</a></td></tr>
91 <tr class="memitem:a57812a313fe9b1a9500489f47c3011cc" id="r_a57812a313fe9b1a9500489f47c3011cc"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="a00224.html">hwloc_obj</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a57812a313fe9b1a9500489f47c3011cc">misc_first_child</a></td></tr>
92 </table>
93 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
94 <div class="textblock"><p>Structure of a topology object. </p>
95 <p>Applications must not modify any field except <code class="param"><a class="el" href="#a76fd3ac94401cf32dfccc3a3a8de68a5" title="Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...">hwloc_obj.userdata</a></code>. </p>
96 </div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
97 <a id="aac3f6da35c9b57599909a44ce2b716c1" name="aac3f6da35c9b57599909a44ce2b716c1"></a>
98 <h2 class="memtitle"><span class="permalink"><a href="#aac3f6da35c9b57599909a44ce2b716c1">&#9670;&#160;</a></span>arity</h2>
99
100 <div class="memitem">
101 <div class="memproto">
102 <table class="memname">
103 <tr>
104 <td class="memname">unsigned hwloc_obj::arity</td>
105 </tr>
106 </table>
107 </div><div class="memdoc">
108
109 <p>Number of normal children. Memory, Misc and I/O children are not listed here but rather in their dedicated children list. </p>
110
111 </div>
112 </div>
113 <a id="accd40e29f71f19e88db62ea3df02adc8" name="accd40e29f71f19e88db62ea3df02adc8"></a>
114 <h2 class="memtitle"><span class="permalink"><a href="#accd40e29f71f19e88db62ea3df02adc8">&#9670;&#160;</a></span>attr</h2>
115
116 <div class="memitem">
117 <div class="memproto">
118 <table class="memname">
119 <tr>
120 <td class="memname">union <a class="el" href="a00228.html">hwloc_obj_attr_u</a>* hwloc_obj::attr</td>
121 </tr>
122 </table>
123 </div><div class="memdoc">
124
125 <p>Object type-specific Attributes, may be <code>NULL</code> if no attribute value was found. </p>
126
127 </div>
128 </div>
129 <a id="a04d05403da37bfe17cd63b7c7dd07b1f" name="a04d05403da37bfe17cd63b7c7dd07b1f"></a>
130 <h2 class="memtitle"><span class="permalink"><a href="#a04d05403da37bfe17cd63b7c7dd07b1f">&#9670;&#160;</a></span>children</h2>
131
132 <div class="memitem">
133 <div class="memproto">
134 <table class="memname">
135 <tr>
136 <td class="memname">struct <a class="el" href="a00224.html">hwloc_obj</a>** hwloc_obj::children</td>
137 </tr>
138 </table>
139 </div><div class="memdoc">
140
141 <p>Normal children, <code>children</code>[0 .. arity -1]. </p>
142
143 </div>
144 </div>
145 <a id="a91788a9da687beb7224cc1fd7b75208c" name="a91788a9da687beb7224cc1fd7b75208c"></a>
146 <h2 class="memtitle"><span class="permalink"><a href="#a91788a9da687beb7224cc1fd7b75208c">&#9670;&#160;</a></span>complete_cpuset</h2>
147
148 <div class="memitem">
149 <div class="memproto">
150 <table class="memname">
151 <tr>
152 <td class="memname"><a class="el" href="a00166.html#ga4bbf39b68b6f568fb92739e7c0ea7801">hwloc_cpuset_t</a> hwloc_obj::complete_cpuset</td>
153 </tr>
154 </table>
155 </div><div class="memdoc">
156
157 <p>The complete CPU set of processors of this object,. </p>
158 <p>This may include not only the same as the cpuset field, but also some CPUs for which topology information is unknown or incomplete, some offlines CPUs, and the CPUs that are ignored when the <a class="el" href="a00176.html#ggada025d3ec20b4b420f8038d23d6e7bdea10907044bbb306fd0dc76acf046d9258" title="Detect the whole system, ignore reservations, include disallowed objects.">HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED</a> flag is not set. Thus no corresponding PU object may be found in the topology, because the precise position is undefined. It is however known that it would be somewhere under this object.</p>
159 <dl class="section note"><dt>Note</dt><dd>Its value must not be changed, <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 instead. </dd></dl>
160
161 </div>
162 </div>
163 <a id="ac38c4012127525ef74c5615c526f4c2e" name="ac38c4012127525ef74c5615c526f4c2e"></a>
164 <h2 class="memtitle"><span class="permalink"><a href="#ac38c4012127525ef74c5615c526f4c2e">&#9670;&#160;</a></span>complete_nodeset</h2>
165
166 <div class="memitem">
167 <div class="memproto">
168 <table class="memname">
169 <tr>
170 <td class="memname"><a class="el" href="a00166.html#ga37e35730fa7e775b5bb0afe893d6d508">hwloc_nodeset_t</a> hwloc_obj::complete_nodeset</td>
171 </tr>
172 </table>
173 </div><div class="memdoc">
174
175 <p>The complete NUMA node set of this object,. </p>
176 <p>This may include not only the same as the nodeset field, but also some NUMA nodes for which topology information is unknown or incomplete, some offlines nodes, and the nodes that are ignored when the <a class="el" href="a00176.html#ggada025d3ec20b4b420f8038d23d6e7bdea10907044bbb306fd0dc76acf046d9258" title="Detect the whole system, ignore reservations, include disallowed objects.">HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED</a> flag is not set. Thus no corresponding NUMA node object may be found in the topology, because the precise position is undefined. It is however known that it would be somewhere under this object.</p>
177 <p>If there are no NUMA nodes in the machine, all the memory is close to this object, so only the first bit is set in <code class="param">complete_nodeset</code>.</p>
178 <dl class="section note"><dt>Note</dt><dd>Its value must not be changed, <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 instead. </dd></dl>
179
180 </div>
181 </div>
182 <a id="a67925e0f2c47f50408fbdb9bddd0790f" name="a67925e0f2c47f50408fbdb9bddd0790f"></a>
183 <h2 class="memtitle"><span class="permalink"><a href="#a67925e0f2c47f50408fbdb9bddd0790f">&#9670;&#160;</a></span>cpuset</h2>
184
185 <div class="memitem">
186 <div class="memproto">
187 <table class="memname">
188 <tr>
189 <td class="memname"><a class="el" href="a00166.html#ga4bbf39b68b6f568fb92739e7c0ea7801">hwloc_cpuset_t</a> hwloc_obj::cpuset</td>
190 </tr>
191 </table>
192 </div><div class="memdoc">
193
194 <p>CPUs covered by this object. </p>
195 <p>This is the set of CPUs for which there are PU objects in the topology under this object, i.e. which are known to be physically contained in this object and known how (the children path between this object and the PU objects).</p>
196 <p>If the <a class="el" href="a00176.html#ggada025d3ec20b4b420f8038d23d6e7bdea10907044bbb306fd0dc76acf046d9258" title="Detect the whole system, ignore reservations, include disallowed objects.">HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED</a> configuration flag is set, some of these CPUs may be online but not allowed for binding, see <a class="el" href="a00185.html#ga517d5d68ec9f24583d8933aab713be8e" title="Get allowed CPU set.">hwloc_topology_get_allowed_cpuset()</a>.</p>
197 <dl class="section note"><dt>Note</dt><dd>All objects have non-NULL CPU and node sets except Misc and I/O objects.</dd>
198 <dd>
199 Its value must not be changed, <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 instead. </dd></dl>
200
201 </div>
202 </div>
203 <a id="a4876fd165b4fff35521f07ebd85355ed" name="a4876fd165b4fff35521f07ebd85355ed"></a>
204 <h2 class="memtitle"><span class="permalink"><a href="#a4876fd165b4fff35521f07ebd85355ed">&#9670;&#160;</a></span>depth</h2>
205
206 <div class="memitem">
207 <div class="memproto">
208 <table class="memname">
209 <tr>
210 <td class="memname">int hwloc_obj::depth</td>
211 </tr>
212 </table>
213 </div><div class="memdoc">
214
215 <p>Vertical index in the hierarchy. </p>
216 <p>For normal objects, this is the depth of the horizontal level that contains this object and its cousins of the same type. If the topology is symmetric, this is equal to the parent depth plus one, and also equal to the number of parent/child links from the root object to here.</p>
217 <p>For special objects (NUMA nodes, I/O and Misc) that are not in the main tree, this is a special negative value that corresponds to their dedicated level, see <a class="el" href="a00170.html#ga8bec782e21be313750da70cf7428b374" title="Returns the depth of objects of type type.">hwloc_get_type_depth()</a> and <a class="el" href="a00170.html#gaf4e663cf42bbe20756b849c6293ef575">hwloc_get_type_depth_e</a>. Those special values can be passed to hwloc functions such <a class="el" href="a00170.html#ga1d5ceafe8130fe6e8657bf0bc666ba50" title="Returns the width of level at depth depth.">hwloc_get_nbobjs_by_depth()</a> as usual. </p>
218
219 </div>
220 </div>
221 <a id="af51d08a0a79dba517c06c5afedc8d2dc" name="af51d08a0a79dba517c06c5afedc8d2dc"></a>
222 <h2 class="memtitle"><span class="permalink"><a href="#af51d08a0a79dba517c06c5afedc8d2dc">&#9670;&#160;</a></span>first_child</h2>
223
224 <div class="memitem">
225 <div class="memproto">
226 <table class="memname">
227 <tr>
228 <td class="memname">struct <a class="el" href="a00224.html">hwloc_obj</a>* hwloc_obj::first_child</td>
229 </tr>
230 </table>
231 </div><div class="memdoc">
232
233 <p>First normal child. </p>
234
235 </div>
236 </div>
237 <a id="a957984a355fa61c85f46605c336e7551" name="a957984a355fa61c85f46605c336e7551"></a>
238 <h2 class="memtitle"><span class="permalink"><a href="#a957984a355fa61c85f46605c336e7551">&#9670;&#160;</a></span>gp_index</h2>
239
240 <div class="memitem">
241 <div class="memproto">
242 <table class="memname">
243 <tr>
244 <td class="memname">hwloc_uint64_t hwloc_obj::gp_index</td>
245 </tr>
246 </table>
247 </div><div class="memdoc">
248
249 <p>Global persistent index. Generated by hwloc, unique across the topology (contrary to os_index) and persistent across topology changes (contrary to logical_index). Mostly used internally, but could also be used by application to identify objects. </p>
250
251 </div>
252 </div>
253 <a id="a8604654c38b7a720efae5025d3a96ee6" name="a8604654c38b7a720efae5025d3a96ee6"></a>
254 <h2 class="memtitle"><span class="permalink"><a href="#a8604654c38b7a720efae5025d3a96ee6">&#9670;&#160;</a></span>infos</h2>
255
256 <div class="memitem">
257 <div class="memproto">
258 <table class="memname">
259 <tr>
260 <td class="memname">struct <a class="el" href="a00272.html">hwloc_info_s</a>* hwloc_obj::infos</td>
261 </tr>
262 </table>
263 </div><div class="memdoc">
264
265 <p>Array of info attributes (name and value strings). </p>
266
267 </div>
268 </div>
269 <a id="a9843acc28cfbba903b63ea14b137ff70" name="a9843acc28cfbba903b63ea14b137ff70"></a>
270 <h2 class="memtitle"><span class="permalink"><a href="#a9843acc28cfbba903b63ea14b137ff70">&#9670;&#160;</a></span>infos_count</h2>
271
272 <div class="memitem">
273 <div class="memproto">
274 <table class="memname">
275 <tr>
276 <td class="memname">unsigned hwloc_obj::infos_count</td>
277 </tr>
278 </table>
279 </div><div class="memdoc">
280
281 <p>Size of infos array. </p>
282
283 </div>
284 </div>
285 <a id="a7b3b29f0be377c7d2d52262019fc7d11" name="a7b3b29f0be377c7d2d52262019fc7d11"></a>
286 <h2 class="memtitle"><span class="permalink"><a href="#a7b3b29f0be377c7d2d52262019fc7d11">&#9670;&#160;</a></span>io_arity</h2>
287
288 <div class="memitem">
289 <div class="memproto">
290 <table class="memname">
291 <tr>
292 <td class="memname">unsigned hwloc_obj::io_arity</td>
293 </tr>
294 </table>
295 </div><div class="memdoc">
296
297 <p>Number of I/O children. These children are listed in <code class="param">io_first_child</code>. </p>
298
299 </div>
300 </div>
301 <a id="a8d14c88e1ebc4ae67cc69f9e928558b3" name="a8d14c88e1ebc4ae67cc69f9e928558b3"></a>
302 <h2 class="memtitle"><span class="permalink"><a href="#a8d14c88e1ebc4ae67cc69f9e928558b3">&#9670;&#160;</a></span>io_first_child</h2>
303
304 <div class="memitem">
305 <div class="memproto">
306 <table class="memname">
307 <tr>
308 <td class="memname">struct <a class="el" href="a00224.html">hwloc_obj</a>* hwloc_obj::io_first_child</td>
309 </tr>
310 </table>
311 </div><div class="memdoc">
312
313 <p>First I/O child. Bridges, PCI and OS devices are listed here (<code class="param">io_arity</code> and <code class="param">io_first_child</code>) instead of in the normal children list. See also <a class="el" href="a00178.html#gac8a954ed37a4376097234c828068cbef" title="Check whether an object type is I/O.">hwloc_obj_type_is_io()</a>. </p>
314
315 </div>
316 </div>
317 <a id="a84bd65634dbc55f4158b74443a9bd04f" name="a84bd65634dbc55f4158b74443a9bd04f"></a>
318 <h2 class="memtitle"><span class="permalink"><a href="#a84bd65634dbc55f4158b74443a9bd04f">&#9670;&#160;</a></span>last_child</h2>
319
320 <div class="memitem">
321 <div class="memproto">
322 <table class="memname">
323 <tr>
324 <td class="memname">struct <a class="el" href="a00224.html">hwloc_obj</a>* hwloc_obj::last_child</td>
325 </tr>
326 </table>
327 </div><div class="memdoc">
328
329 <p>Last normal child. </p>
330
331 </div>
332 </div>
333 <a id="a0d07fb7b8935e137c94d75a3eb492ae9" name="a0d07fb7b8935e137c94d75a3eb492ae9"></a>
334 <h2 class="memtitle"><span class="permalink"><a href="#a0d07fb7b8935e137c94d75a3eb492ae9">&#9670;&#160;</a></span>logical_index</h2>
335
336 <div class="memitem">
337 <div class="memproto">
338 <table class="memname">
339 <tr>
340 <td class="memname">unsigned hwloc_obj::logical_index</td>
341 </tr>
342 </table>
343 </div><div class="memdoc">
344
345 <p>Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire machine. Could be a "cousin_rank" since it's the rank within the "cousin" list below Note that this index may change when restricting the topology or when inserting a group. </p>
346
347 </div>
348 </div>
349 <a id="a6f834ea4dd26553cdea601d2fae6d3b7" name="a6f834ea4dd26553cdea601d2fae6d3b7"></a>
350 <h2 class="memtitle"><span class="permalink"><a href="#a6f834ea4dd26553cdea601d2fae6d3b7">&#9670;&#160;</a></span>memory_arity</h2>
351
352 <div class="memitem">
353 <div class="memproto">
354 <table class="memname">
355 <tr>
356 <td class="memname">unsigned hwloc_obj::memory_arity</td>
357 </tr>
358 </table>
359 </div><div class="memdoc">
360
361 <p>Number of Memory children. These children are listed in <code class="param">memory_first_child</code>. </p>
362
363 </div>
364 </div>
365 <a id="ac0e8200dba25b90d5954bd4ec61f97d3" name="ac0e8200dba25b90d5954bd4ec61f97d3"></a>
366 <h2 class="memtitle"><span class="permalink"><a href="#ac0e8200dba25b90d5954bd4ec61f97d3">&#9670;&#160;</a></span>memory_first_child</h2>
367
368 <div class="memitem">
369 <div class="memproto">
370 <table class="memname">
371 <tr>
372 <td class="memname">struct <a class="el" href="a00224.html">hwloc_obj</a>* hwloc_obj::memory_first_child</td>
373 </tr>
374 </table>
375 </div><div class="memdoc">
376
377 <p>First Memory child. NUMA nodes and Memory-side caches are listed here (<code class="param">memory_arity</code> and <code class="param">memory_first_child</code>) instead of in the normal children list. See also <a class="el" href="a00178.html#ga1d074390c8a3dc3088d84f73fb73f966" title="Check whether an object type is Memory.">hwloc_obj_type_is_memory()</a>. </p>
378 <p>A memory hierarchy starts from a normal CPU-side object (e.g. Package) and ends with NUMA nodes as leaves. There might exist some memory-side caches between them in the middle of the memory subtree. </p>
379
380 </div>
381 </div>
382 <a id="a2bb7862ce722d7ceda23cfa153da165a" name="a2bb7862ce722d7ceda23cfa153da165a"></a>
383 <h2 class="memtitle"><span class="permalink"><a href="#a2bb7862ce722d7ceda23cfa153da165a">&#9670;&#160;</a></span>misc_arity</h2>
384
385 <div class="memitem">
386 <div class="memproto">
387 <table class="memname">
388 <tr>
389 <td class="memname">unsigned hwloc_obj::misc_arity</td>
390 </tr>
391 </table>
392 </div><div class="memdoc">
393
394 <p>Number of Misc children. These children are listed in <code class="param">misc_first_child</code>. </p>
395
396 </div>
397 </div>
398 <a id="a57812a313fe9b1a9500489f47c3011cc" name="a57812a313fe9b1a9500489f47c3011cc"></a>
399 <h2 class="memtitle"><span class="permalink"><a href="#a57812a313fe9b1a9500489f47c3011cc">&#9670;&#160;</a></span>misc_first_child</h2>
400
401 <div class="memitem">
402 <div class="memproto">
403 <table class="memname">
404 <tr>
405 <td class="memname">struct <a class="el" href="a00224.html">hwloc_obj</a>* hwloc_obj::misc_first_child</td>
406 </tr>
407 </table>
408 </div><div class="memdoc">
409
410 <p>First Misc child. Misc objects are listed here (<code class="param">misc_arity</code> and <code class="param">misc_first_child</code>) instead of in the normal children list. </p>
411
412 </div>
413 </div>
414 <a id="abb709ec38f2970677e4e57d1d30be96d" name="abb709ec38f2970677e4e57d1d30be96d"></a>
415 <h2 class="memtitle"><span class="permalink"><a href="#abb709ec38f2970677e4e57d1d30be96d">&#9670;&#160;</a></span>name</h2>
416
417 <div class="memitem">
418 <div class="memproto">
419 <table class="memname">
420 <tr>
421 <td class="memname">char* hwloc_obj::name</td>
422 </tr>
423 </table>
424 </div><div class="memdoc">
425
426 <p>Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name string is more useful than numerical indexes. </p>
427
428 </div>
429 </div>
430 <a id="a85a788017457129589318b6c39451acf" name="a85a788017457129589318b6c39451acf"></a>
431 <h2 class="memtitle"><span class="permalink"><a href="#a85a788017457129589318b6c39451acf">&#9670;&#160;</a></span>next_cousin</h2>
432
433 <div class="memitem">
434 <div class="memproto">
435 <table class="memname">
436 <tr>
437 <td class="memname">struct <a class="el" href="a00224.html">hwloc_obj</a>* hwloc_obj::next_cousin</td>
438 </tr>
439 </table>
440 </div><div class="memdoc">
441
442 <p>Next object of same type and depth. </p>
443
444 </div>
445 </div>
446 <a id="a7f2343ed476fe4942e6fffd4cade1b40" name="a7f2343ed476fe4942e6fffd4cade1b40"></a>
447 <h2 class="memtitle"><span class="permalink"><a href="#a7f2343ed476fe4942e6fffd4cade1b40">&#9670;&#160;</a></span>next_sibling</h2>
448
449 <div class="memitem">
450 <div class="memproto">
451 <table class="memname">
452 <tr>
453 <td class="memname">struct <a class="el" href="a00224.html">hwloc_obj</a>* hwloc_obj::next_sibling</td>
454 </tr>
455 </table>
456 </div><div class="memdoc">
457
458 <p>Next object below the same parent (inside the same list of children). </p>
459
460 </div>
461 </div>
462 <a id="a08f0d0e16c619a6e653526cbee4ffea3" name="a08f0d0e16c619a6e653526cbee4ffea3"></a>
463 <h2 class="memtitle"><span class="permalink"><a href="#a08f0d0e16c619a6e653526cbee4ffea3">&#9670;&#160;</a></span>nodeset</h2>
464
465 <div class="memitem">
466 <div class="memproto">
467 <table class="memname">
468 <tr>
469 <td class="memname"><a class="el" href="a00166.html#ga37e35730fa7e775b5bb0afe893d6d508">hwloc_nodeset_t</a> hwloc_obj::nodeset</td>
470 </tr>
471 </table>
472 </div><div class="memdoc">
473
474 <p>NUMA nodes covered by this object or containing this object. </p>
475 <p>This is the set of NUMA nodes for which there are NUMA node objects in the topology under or above this object, i.e. which are known to be physically contained in this object or containing it and known how (the children path between this object and the NUMA node objects).</p>
476 <p>In the end, these nodes are those that are close to the current object. Function <a class="el" href="a00195.html#ga569e80c5be7ef27649b0ef5aa52ffcdc" title="Return an array of local NUMA nodes.">hwloc_get_local_numanode_objs()</a> may be used to list those NUMA nodes more precisely.</p>
477 <p>If the <a class="el" href="a00176.html#ggada025d3ec20b4b420f8038d23d6e7bdea10907044bbb306fd0dc76acf046d9258" title="Detect the whole system, ignore reservations, include disallowed objects.">HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED</a> configuration flag is set, some of these nodes may be online but not allowed for allocation, see <a class="el" href="a00185.html#ga21a4d7237a11e76b912ed4524ab78cbd" title="Get allowed node set.">hwloc_topology_get_allowed_nodeset()</a>.</p>
478 <p>If there are no NUMA nodes in the machine, all the memory is close to this object, so only the first bit may be set in <code class="param">nodeset</code>.</p>
479 <dl class="section note"><dt>Note</dt><dd>All objects have non-NULL CPU and node sets except Misc and I/O objects.</dd>
480 <dd>
481 Its value must not be changed, <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 instead. </dd></dl>
482
483 </div>
484 </div>
485 <a id="a61a7a80a68eaccbaaa28269e678c81a9" name="a61a7a80a68eaccbaaa28269e678c81a9"></a>
486 <h2 class="memtitle"><span class="permalink"><a href="#a61a7a80a68eaccbaaa28269e678c81a9">&#9670;&#160;</a></span>os_index</h2>
487
488 <div class="memitem">
489 <div class="memproto">
490 <table class="memname">
491 <tr>
492 <td class="memname">unsigned hwloc_obj::os_index</td>
493 </tr>
494 </table>
495 </div><div class="memdoc">
496
497 <p>OS-provided physical index number. It is not guaranteed unique across the entire machine, except for PUs and NUMA nodes. Set to HWLOC_UNKNOWN_INDEX if unknown or irrelevant for this object. </p>
498
499 </div>
500 </div>
501 <a id="adc494f6aed939992be1c55cca5822900" name="adc494f6aed939992be1c55cca5822900"></a>
502 <h2 class="memtitle"><span class="permalink"><a href="#adc494f6aed939992be1c55cca5822900">&#9670;&#160;</a></span>parent</h2>
503
504 <div class="memitem">
505 <div class="memproto">
506 <table class="memname">
507 <tr>
508 <td class="memname">struct <a class="el" href="a00224.html">hwloc_obj</a>* hwloc_obj::parent</td>
509 </tr>
510 </table>
511 </div><div class="memdoc">
512
513 <p>Parent, <code>NULL</code> if root (Machine object). </p>
514
515 </div>
516 </div>
517 <a id="ac715989f55ff5a0eb6be2969ee477ec0" name="ac715989f55ff5a0eb6be2969ee477ec0"></a>
518 <h2 class="memtitle"><span class="permalink"><a href="#ac715989f55ff5a0eb6be2969ee477ec0">&#9670;&#160;</a></span>prev_cousin</h2>
519
520 <div class="memitem">
521 <div class="memproto">
522 <table class="memname">
523 <tr>
524 <td class="memname">struct <a class="el" href="a00224.html">hwloc_obj</a>* hwloc_obj::prev_cousin</td>
525 </tr>
526 </table>
527 </div><div class="memdoc">
528
529 <p>Previous object of same type and depth. </p>
530
531 </div>
532 </div>
533 <a id="a7b89e8c189876c0158a9282aaaf17f50" name="a7b89e8c189876c0158a9282aaaf17f50"></a>
534 <h2 class="memtitle"><span class="permalink"><a href="#a7b89e8c189876c0158a9282aaaf17f50">&#9670;&#160;</a></span>prev_sibling</h2>
535
536 <div class="memitem">
537 <div class="memproto">
538 <table class="memname">
539 <tr>
540 <td class="memname">struct <a class="el" href="a00224.html">hwloc_obj</a>* hwloc_obj::prev_sibling</td>
541 </tr>
542 </table>
543 </div><div class="memdoc">
544
545 <p>Previous object below the same parent (inside the same list of children). </p>
546
547 </div>
548 </div>
549 <a id="aaa6043eee6f55869933c1d974efd9acd" name="aaa6043eee6f55869933c1d974efd9acd"></a>
550 <h2 class="memtitle"><span class="permalink"><a href="#aaa6043eee6f55869933c1d974efd9acd">&#9670;&#160;</a></span>sibling_rank</h2>
551
552 <div class="memitem">
553 <div class="memproto">
554 <table class="memname">
555 <tr>
556 <td class="memname">unsigned hwloc_obj::sibling_rank</td>
557 </tr>
558 </table>
559 </div><div class="memdoc">
560
561 <p>Index in parent's <code>children</code>[] array. Or the index in parent's Memory, I/O or Misc children list. </p>
562
563 </div>
564 </div>
565 <a id="a5d4f97e76723a9ec8d38046f19e00d33" name="a5d4f97e76723a9ec8d38046f19e00d33"></a>
566 <h2 class="memtitle"><span class="permalink"><a href="#a5d4f97e76723a9ec8d38046f19e00d33">&#9670;&#160;</a></span>subtype</h2>
567
568 <div class="memitem">
569 <div class="memproto">
570 <table class="memname">
571 <tr>
572 <td class="memname">char* hwloc_obj::subtype</td>
573 </tr>
574 </table>
575 </div><div class="memdoc">
576
577 <p>Subtype string to better describe the type field. </p>
578
579 </div>
580 </div>
581 <a id="a0f41a1d67dc6b661906f2217563637f3" name="a0f41a1d67dc6b661906f2217563637f3"></a>
582 <h2 class="memtitle"><span class="permalink"><a href="#a0f41a1d67dc6b661906f2217563637f3">&#9670;&#160;</a></span>symmetric_subtree</h2>
583
584 <div class="memitem">
585 <div class="memproto">
586 <table class="memname">
587 <tr>
588 <td class="memname">int hwloc_obj::symmetric_subtree</td>
589 </tr>
590 </table>
591 </div><div class="memdoc">
592
593 <p>Set if the subtree of normal objects below this object is symmetric, which means all normal children and their children have identical subtrees. </p>
594 <p>Memory, I/O and Misc children are ignored.</p>
595 <p>If set in the topology root object, lstopo may export the topology as a synthetic string. </p>
596
597 </div>
598 </div>
599 <a id="a75603fc36c9284ba48ce814b772a58b6" name="a75603fc36c9284ba48ce814b772a58b6"></a>
600 <h2 class="memtitle"><span class="permalink"><a href="#a75603fc36c9284ba48ce814b772a58b6">&#9670;&#160;</a></span>total_memory</h2>
601
602 <div class="memitem">
603 <div class="memproto">
604 <table class="memname">
605 <tr>
606 <td class="memname">hwloc_uint64_t hwloc_obj::total_memory</td>
607 </tr>
608 </table>
609 </div><div class="memdoc">
610
611 <p>Total memory (in bytes) in NUMA nodes below this object. </p>
612
613 </div>
614 </div>
615 <a id="acc4f0803f244867e68fe0036800be5de" name="acc4f0803f244867e68fe0036800be5de"></a>
616 <h2 class="memtitle"><span class="permalink"><a href="#acc4f0803f244867e68fe0036800be5de">&#9670;&#160;</a></span>type</h2>
617
618 <div class="memitem">
619 <div class="memproto">
620 <table class="memname">
621 <tr>
622 <td class="memname"><a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> hwloc_obj::type</td>
623 </tr>
624 </table>
625 </div><div class="memdoc">
626
627 <p>Type of object. </p>
628
629 </div>
630 </div>
631 <a id="a76fd3ac94401cf32dfccc3a3a8de68a5" name="a76fd3ac94401cf32dfccc3a3a8de68a5"></a>
632 <h2 class="memtitle"><span class="permalink"><a href="#a76fd3ac94401cf32dfccc3a3a8de68a5">&#9670;&#160;</a></span>userdata</h2>
633
634 <div class="memitem">
635 <div class="memproto">
636 <table class="memname">
637 <tr>
638 <td class="memname">void* hwloc_obj::userdata</td>
639 </tr>
640 </table>
641 </div><div class="memdoc">
642
643 <p>Application-given private data pointer, initialized to <code>NULL</code>, use it as you wish. See <a class="el" href="a00189.html#ga9d6ff0f7a8dd45be9aa8575ef31978cc" title="Set the application-specific callback for exporting object userdata.">hwloc_topology_set_userdata_export_callback()</a> in <a class="el" href="a00104_source.html">hwloc/export.h</a> if you wish to export this field to XML. </p>
644
645 </div>
646 </div>
647 <hr/>The documentation for this struct was generated from the following file:<ul>
648 <li><a class="el" href="a00095_source.html">hwloc.h</a></li>
649 </ul>
650 </div><!-- contents -->
651 <!-- start footer part -->
652 <hr class="footer"/><address class="footer"><small>
653 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
654 </small></address>
655 </div><!-- doc-content -->
656 </body>
657 </html>