Debian Codegraph @

doc/doxygen-doc/html/a00182.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): Looking at Cache Objects</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">Looking at Cache Objects </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:ga347a289a3956147fcc1f44feb5e6960b" id="r_ga347a289a3956147fcc1f44feb5e6960b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga347a289a3956147fcc1f44feb5e6960b">hwloc_get_cache_type_depth</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, unsigned cachelevel, <a class="el" href="a00167.html#ga552ec74296a024237f474acec98694c0">hwloc_obj_cache_type_t</a> cachetype)</td></tr>
54 <tr class="memitem:ga7285aefd04c7bc6f09fcb01af177231d" id="r_ga7285aefd04c7bc6f09fcb01af177231d"><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="#ga7285aefd04c7bc6f09fcb01af177231d">hwloc_get_cache_covering_cpuset</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a> set)</td></tr>
55 <tr class="memitem:ga100c7b61cc3625bec47f346aabc0f481" id="r_ga100c7b61cc3625bec47f346aabc0f481"><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="#ga100c7b61cc3625bec47f346aabc0f481">hwloc_get_shared_cache_covering_obj</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> obj)</td></tr>
56 </table>
57 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
58 <a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
59 <a id="ga7285aefd04c7bc6f09fcb01af177231d" name="ga7285aefd04c7bc6f09fcb01af177231d"></a>
60 <h2 class="memtitle"><span class="permalink"><a href="#ga7285aefd04c7bc6f09fcb01af177231d">&#9670;&#160;</a></span>hwloc_get_cache_covering_cpuset()</h2>
61
62 <div class="memitem">
63 <div class="memproto">
64 <table class="mlabels">
65 <tr>
66 <td class="mlabels-left">
67 <table class="memname">
68 <tr>
69 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_cache_covering_cpuset </td>
70 <td>(</td>
71 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
72 </tr>
73 <tr>
74 <td class="paramkey"></td>
75 <td></td>
76 <td class="paramtype"><a class="el" href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a></td> <td class="paramname"><span class="paramname"><em>set</em></span>&#160;)</td>
77 </tr>
78 </table>
79 </td>
80 <td class="mlabels-right">
81 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
82 </tr>
83 </table>
84 </div><div class="memdoc">
85
86 <p>Get the first data (or unified) cache covering a cpuset <code class="param">set</code>. </p>
87 <dl class="section return"><dt>Returns</dt><dd>a covering cache, or <code>NULL</code> if no cache matches. </dd></dl>
88
89 </div>
90 </div>
91 <a id="ga347a289a3956147fcc1f44feb5e6960b" name="ga347a289a3956147fcc1f44feb5e6960b"></a>
92 <h2 class="memtitle"><span class="permalink"><a href="#ga347a289a3956147fcc1f44feb5e6960b">&#9670;&#160;</a></span>hwloc_get_cache_type_depth()</h2>
93
94 <div class="memitem">
95 <div class="memproto">
96 <table class="mlabels">
97 <tr>
98 <td class="mlabels-left">
99 <table class="memname">
100 <tr>
101 <td class="memname">int hwloc_get_cache_type_depth </td>
102 <td>(</td>
103 <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>
104 </tr>
105 <tr>
106 <td class="paramkey"></td>
107 <td></td>
108 <td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>cachelevel</em></span>, </td>
109 </tr>
110 <tr>
111 <td class="paramkey"></td>
112 <td></td>
113 <td class="paramtype"><a class="el" href="a00167.html#ga552ec74296a024237f474acec98694c0">hwloc_obj_cache_type_t</a></td> <td class="paramname"><span class="paramname"><em>cachetype</em></span>&#160;)</td>
114 </tr>
115 </table>
116 </td>
117 <td class="mlabels-right">
118 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
119 </tr>
120 </table>
121 </div><div class="memdoc">
122
123 <p>Find the depth of cache objects matching cache level and type. </p>
124 <p>Return the depth of the topology level that contains cache objects whose attributes match <code class="param">cachelevel</code> and <code class="param">cachetype</code>.</p>
125 <p>This function is identical to calling <a class="el" href="a00170.html#ga8bec782e21be313750da70cf7428b374" title="Returns the depth of objects of type type.">hwloc_get_type_depth()</a> with the corresponding type such as <a class="el" href="a00167.html#ggacd37bb612667dc437d66bfb175a8dc55afa834a85d9e53836cf0db6d0bd8329b4" title="Level 1 instruction Cache (filtered out by default).">HWLOC_OBJ_L1ICACHE</a>, except that it may also return a Unified cache when looking for an instruction cache.</p>
126 <dl class="section return"><dt>Returns</dt><dd>the depth of the unique matching unified cache level is returned if <code class="param">cachetype</code> is <a class="el" href="a00167.html#gga791c9875c8fe20f3e1e5871e0657e59ba3900b3b2db54941aac249e5a638a2d7a" title="Unified cache.">HWLOC_OBJ_CACHE_UNIFIED</a>.</dd>
127 <dd>
128 the depth of either a matching cache level or a unified cache level if <code class="param">cachetype</code> is <a class="el" href="a00167.html#gga791c9875c8fe20f3e1e5871e0657e59bacac60ecad4206f85aeb79bef1604b488" title="Data cache.">HWLOC_OBJ_CACHE_DATA</a> or <a class="el" href="a00167.html#gga791c9875c8fe20f3e1e5871e0657e59ba6f98b0d422b38ba90c5f5c79a11b0658" title="Instruction cache (filtered out by default).">HWLOC_OBJ_CACHE_INSTRUCTION</a>.</dd>
129 <dd>
130 the depth of the matching level if <code class="param">cachetype</code> is <code>-1</code> but only one level matches.</dd>
131 <dd>
132 <a class="el" href="a00170.html#ggaf4e663cf42bbe20756b849c6293ef575ae99465995cacde6c210d5fc2e409798c" title="Objects of given type exist at different depth in the topology (only for Groups).">HWLOC_TYPE_DEPTH_MULTIPLE</a> if <code class="param">cachetype</code> is <code>-1</code> but multiple levels match.</dd>
133 <dd>
134 <a class="el" href="a00170.html#ggaf4e663cf42bbe20756b849c6293ef575a0565ab92ab72cb0cec91e23003294aad" title="No object of given type exists in the topology.">HWLOC_TYPE_DEPTH_UNKNOWN</a> if no cache level matches. </dd></dl>
135
136 </div>
137 </div>
138 <a id="ga100c7b61cc3625bec47f346aabc0f481" name="ga100c7b61cc3625bec47f346aabc0f481"></a>
139 <h2 class="memtitle"><span class="permalink"><a href="#ga100c7b61cc3625bec47f346aabc0f481">&#9670;&#160;</a></span>hwloc_get_shared_cache_covering_obj()</h2>
140
141 <div class="memitem">
142 <div class="memproto">
143 <table class="mlabels">
144 <tr>
145 <td class="mlabels-left">
146 <table class="memname">
147 <tr>
148 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_get_shared_cache_covering_obj </td>
149 <td>(</td>
150 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
151 </tr>
152 <tr>
153 <td class="paramkey"></td>
154 <td></td>
155 <td class="paramtype"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a></td> <td class="paramname"><span class="paramname"><em>obj</em></span>&#160;)</td>
156 </tr>
157 </table>
158 </td>
159 <td class="mlabels-right">
160 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
161 </tr>
162 </table>
163 </div><div class="memdoc">
164
165 <p>Get the first data (or unified) cache shared between an object and somebody else. </p>
166 <dl class="section return"><dt>Returns</dt><dd>a shared cache. </dd>
167 <dd>
168 <code>NULL</code> if no cache matches or if an invalid object is given (e.g. I/O object). </dd></dl>
169
170 </div>
171 </div>
172 </div><!-- contents -->
173 <!-- start footer part -->
174 <hr class="footer"/><address class="footer"><small>
175 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
176 </small></address>
177 </div><!-- doc-content -->
178 </body>
179 </html>