Debian Codegraph @

doc/doxygen-doc/html/a00178.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): Kinds of object Type</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <script type="text/javascript" src="clipboard.js"></script>
13 <link href="doxygen.css" rel="stylesheet" type="text/css" />
14 </head>
15 <body>
16 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
17 <div id="titlearea">
18 <table cellspacing="0" cellpadding="0">
19 <tbody>
20 <tr id="projectrow">
21 <td id="projectalign">
22 <div id="projectname">Hardware Locality (hwloc)<span id="projectnumber">&#160;2.14.0</span>
23 </div>
24 </td>
25 </tr>
26 </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.15.0 -->
31 <script type="text/javascript">
32 $(function() { codefold.init(); });
33 </script>
34 <script type="text/javascript" src="menudata.js"></script>
35 <script type="text/javascript" src="menu.js"></script>
36 <script type="text/javascript">
37 $(function() {
38 initMenu('',false,false,'search.php','Search',false);
39 });
40 </script>
41 <div id="main-nav"></div>
42 </div><!-- top -->
43 <div id="doc-content">
44 <div class="header">
45 <div class="summary">
46 <a href="#func-members">Functions</a> </div>
47 <div class="headertitle"><div class="title">Kinds of object Type </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:ga52ef38431eba383b048b98c669b59a16" id="r_ga52ef38431eba383b048b98c669b59a16"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga52ef38431eba383b048b98c669b59a16">hwloc_obj_type_is_normal</a> (<a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type)</td></tr>
54 <tr class="memitem:gac8a954ed37a4376097234c828068cbef" id="r_gac8a954ed37a4376097234c828068cbef"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gac8a954ed37a4376097234c828068cbef">hwloc_obj_type_is_io</a> (<a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type)</td></tr>
55 <tr class="memitem:ga1d074390c8a3dc3088d84f73fb73f966" id="r_ga1d074390c8a3dc3088d84f73fb73f966"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1d074390c8a3dc3088d84f73fb73f966">hwloc_obj_type_is_memory</a> (<a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type)</td></tr>
56 <tr class="memitem:ga2ed589bea28711e80b92066510a5607d" id="r_ga2ed589bea28711e80b92066510a5607d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2ed589bea28711e80b92066510a5607d">hwloc_obj_type_is_cache</a> (<a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type)</td></tr>
57 <tr class="memitem:ga395e48cd221d107e5891689624e1aec4" id="r_ga395e48cd221d107e5891689624e1aec4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga395e48cd221d107e5891689624e1aec4">hwloc_obj_type_is_dcache</a> (<a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type)</td></tr>
58 <tr class="memitem:ga8abcee67b9b074332c1866405a3648a9" id="r_ga8abcee67b9b074332c1866405a3648a9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8abcee67b9b074332c1866405a3648a9">hwloc_obj_type_is_icache</a> (<a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type)</td></tr>
59 </table>
60 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
61 <p>Each object type is either Normal (i.e. <a class="el" href="#ga52ef38431eba383b048b98c669b59a16" title="Check whether an object type is Normal.">hwloc_obj_type_is_normal()</a> returns 1), or Memory (i.e. <a class="el" href="#ga1d074390c8a3dc3088d84f73fb73f966" title="Check whether an object type is Memory.">hwloc_obj_type_is_memory()</a> returns 1) or I/O (i.e. <a class="el" href="#gac8a954ed37a4376097234c828068cbef" title="Check whether an object type is I/O.">hwloc_obj_type_is_io()</a> returns 1) or Misc (i.e. equal to <a class="el" href="a00167.html#ggacd37bb612667dc437d66bfb175a8dc55a19f8a6953fa91efc76bcbcdf2d22de4d" title="Miscellaneous objects (filtered out by default). Objects without particular meaning,...">HWLOC_OBJ_MISC</a>). It cannot be of more than one of these kinds.</p>
62 <p>See also Object Kind in <a class="el" href="a00371.html">Terms and Definitions</a>. </p>
63 <a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
64 <a id="ga2ed589bea28711e80b92066510a5607d" name="ga2ed589bea28711e80b92066510a5607d"></a>
65 <h2 class="memtitle"><span class="permalink"><a href="#ga2ed589bea28711e80b92066510a5607d">&#9670;&#160;</a></span>hwloc_obj_type_is_cache()</h2>
66
67 <div class="memitem">
68 <div class="memproto">
69 <table class="memname">
70 <tr>
71 <td class="memname">int hwloc_obj_type_is_cache </td>
72 <td>(</td>
73 <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><td>)</td>
74 <td></td>
75 </tr>
76 </table>
77 </div><div class="memdoc">
78
79 <p>Check whether an object type is a CPU Cache (Data, Unified or Instruction). </p>
80 <p>Memory-side caches are not CPU caches.</p>
81 <dl class="section return"><dt>Returns</dt><dd>1 if an object of type <code class="param">type</code> is a Cache, 0 otherwise. </dd></dl>
82
83 </div>
84 </div>
85 <a id="ga395e48cd221d107e5891689624e1aec4" name="ga395e48cd221d107e5891689624e1aec4"></a>
86 <h2 class="memtitle"><span class="permalink"><a href="#ga395e48cd221d107e5891689624e1aec4">&#9670;&#160;</a></span>hwloc_obj_type_is_dcache()</h2>
87
88 <div class="memitem">
89 <div class="memproto">
90 <table class="memname">
91 <tr>
92 <td class="memname">int hwloc_obj_type_is_dcache </td>
93 <td>(</td>
94 <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><td>)</td>
95 <td></td>
96 </tr>
97 </table>
98 </div><div class="memdoc">
99
100 <p>Check whether an object type is a CPU Data or Unified Cache. </p>
101 <p>Memory-side caches are not CPU caches.</p>
102 <dl class="section return"><dt>Returns</dt><dd>1 if an object of type <code class="param">type</code> is a CPU Data or Unified Cache, 0 otherwise. </dd></dl>
103
104 </div>
105 </div>
106 <a id="ga8abcee67b9b074332c1866405a3648a9" name="ga8abcee67b9b074332c1866405a3648a9"></a>
107 <h2 class="memtitle"><span class="permalink"><a href="#ga8abcee67b9b074332c1866405a3648a9">&#9670;&#160;</a></span>hwloc_obj_type_is_icache()</h2>
108
109 <div class="memitem">
110 <div class="memproto">
111 <table class="memname">
112 <tr>
113 <td class="memname">int hwloc_obj_type_is_icache </td>
114 <td>(</td>
115 <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><td>)</td>
116 <td></td>
117 </tr>
118 </table>
119 </div><div class="memdoc">
120
121 <p>Check whether an object type is a CPU Instruction Cache,. </p>
122 <p>Memory-side caches are not CPU caches.</p>
123 <dl class="section return"><dt>Returns</dt><dd>1 if an object of type <code class="param">type</code> is a CPU Instruction Cache, 0 otherwise. </dd></dl>
124
125 </div>
126 </div>
127 <a id="gac8a954ed37a4376097234c828068cbef" name="gac8a954ed37a4376097234c828068cbef"></a>
128 <h2 class="memtitle"><span class="permalink"><a href="#gac8a954ed37a4376097234c828068cbef">&#9670;&#160;</a></span>hwloc_obj_type_is_io()</h2>
129
130 <div class="memitem">
131 <div class="memproto">
132 <table class="memname">
133 <tr>
134 <td class="memname">int hwloc_obj_type_is_io </td>
135 <td>(</td>
136 <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><td>)</td>
137 <td></td>
138 </tr>
139 </table>
140 </div><div class="memdoc">
141
142 <p>Check whether an object type is I/O. </p>
143 <p>I/O objects are objects attached to their parents in the I/O children list. This current includes Bridges, PCI and OS devices.</p>
144 <dl class="section return"><dt>Returns</dt><dd>1 if an object of type <code class="param">type</code> is a I/O object, 0 otherwise. </dd></dl>
145
146 </div>
147 </div>
148 <a id="ga1d074390c8a3dc3088d84f73fb73f966" name="ga1d074390c8a3dc3088d84f73fb73f966"></a>
149 <h2 class="memtitle"><span class="permalink"><a href="#ga1d074390c8a3dc3088d84f73fb73f966">&#9670;&#160;</a></span>hwloc_obj_type_is_memory()</h2>
150
151 <div class="memitem">
152 <div class="memproto">
153 <table class="memname">
154 <tr>
155 <td class="memname">int hwloc_obj_type_is_memory </td>
156 <td>(</td>
157 <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><td>)</td>
158 <td></td>
159 </tr>
160 </table>
161 </div><div class="memdoc">
162
163 <p>Check whether an object type is Memory. </p>
164 <p>Memory objects are objects attached to their parents in the Memory children list. This current includes NUMA nodes and Memory-side caches.</p>
165 <dl class="section return"><dt>Returns</dt><dd>1 if an object of type <code class="param">type</code> is a Memory object, 0 otherwise. </dd></dl>
166
167 </div>
168 </div>
169 <a id="ga52ef38431eba383b048b98c669b59a16" name="ga52ef38431eba383b048b98c669b59a16"></a>
170 <h2 class="memtitle"><span class="permalink"><a href="#ga52ef38431eba383b048b98c669b59a16">&#9670;&#160;</a></span>hwloc_obj_type_is_normal()</h2>
171
172 <div class="memitem">
173 <div class="memproto">
174 <table class="memname">
175 <tr>
176 <td class="memname">int hwloc_obj_type_is_normal </td>
177 <td>(</td>
178 <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><td>)</td>
179 <td></td>
180 </tr>
181 </table>
182 </div><div class="memdoc">
183
184 <p>Check whether an object type is Normal. </p>
185 <p>Normal objects are objects of the main CPU hierarchy (Machine, Package, Core, PU, CPU caches, etc.), but they are not NUMA nodes, I/O devices or Misc objects.</p>
186 <p>They are attached to parent as Normal children, not as Memory, I/O or Misc children.</p>
187 <dl class="section return"><dt>Returns</dt><dd>1 if an object of type <code class="param">type</code> is a Normal object, 0 otherwise. </dd></dl>
188
189 </div>
190 </div>
191 </div><!-- contents -->
192 <!-- start footer part -->
193 <hr class="footer"/><address class="footer"><small>
194 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
195 </small></address>
196 </div><!-- doc-content -->
197 </body>
198 </html>