Debian Codegraph @

doc/doxygen-doc/html/a00113_source.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): cpukinds.h Source File</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 id="nav-path" class="navpath">
43 <ul>
44 <li class="navelem"><a href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a href="dir_5cb306d949c7931a3b6c77517393dd34.html">hwloc</a></li> </ul>
45 </div>
46 </div><!-- top -->
47 <div id="doc-content">
48 <div class="header">
49 <div class="headertitle"><div class="title">cpukinds.h</div></div>
50 </div><!--header-->
51 <div class="contents">
52 <div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
53 <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * SPDX-License-Identifier: BSD-3-Clause</span></div>
54 <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Copyright © 2020-2021 Inria. All rights reserved.</span></div>
55 <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * See COPYING in top-level directory.</span></div>
56 <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> */</span></div>
57 <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span></div>
58 <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
59 <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#ifndef HWLOC_CPUKINDS_H</span></div>
60 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#define HWLOC_CPUKINDS_H</span></div>
61 <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
62 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &quot;hwloc.h&quot;</span></div>
63 <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
64 <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#ifdef __cplusplus</span></div>
65 <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
66 <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#elif 0</span></div>
67 <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span>}</div>
68 <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#endif</span></div>
69 <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span></div>
70 <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span></div>
71 <div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span>HWLOC_DECLSPEC <span class="keywordtype">int</span></div>
72 <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="a00197.html#ga7553f7c6d3920b169f3fc18dfe6a33e3"> 83</a></span><a class="code hl_function" href="a00197.html#ga7553f7c6d3920b169f3fc18dfe6a33e3">hwloc_cpukinds_get_nr</a>(<a class="code hl_typedef" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology,</div>
73 <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags);</div>
74 <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span></div>
75 <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span>HWLOC_DECLSPEC <span class="keywordtype">int</span></div>
76 <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="a00197.html#gaf979833aab18d2e7f4b17c932cbcf5d8"> 98</a></span><a class="code hl_function" href="a00197.html#gaf979833aab18d2e7f4b17c932cbcf5d8">hwloc_cpukinds_get_by_cpuset</a>(<a class="code hl_typedef" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology,</div>
77 <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <a class="code hl_typedef" href="a00188.html#gae991a108af01d408be2776c5b2c467b2">hwloc_const_bitmap_t</a> cpuset,</div>
78 <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags);</div>
79 <div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span></div>
80 <div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span>HWLOC_DECLSPEC <span class="keywordtype">int</span></div>
81 <div class="line"><a id="l00136" name="l00136"></a><span class="lineno"><a class="line" href="a00197.html#gae1b38fbe9c645583fc16052ce6fbb275"> 136</a></span><a class="code hl_function" href="a00197.html#gae1b38fbe9c645583fc16052ce6fbb275">hwloc_cpukinds_get_info</a>(<a class="code hl_typedef" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology,</div>
82 <div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <span class="keywordtype">unsigned</span> kind_index,</div>
83 <div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <a class="code hl_typedef" href="a00188.html#gaa3c2bf4c776d603dcebbb61b0c923d84">hwloc_bitmap_t</a> cpuset,</div>
84 <div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <span class="keywordtype">int</span> *efficiency,</div>
85 <div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> <span class="keywordtype">unsigned</span> *nr_infos, <span class="keyword">struct</span> <a class="code hl_struct" href="a00272.html">hwloc_info_s</a> **infos,</div>
86 <div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags);</div>
87 <div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span></div>
88 <div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span>HWLOC_DECLSPEC <span class="keywordtype">int</span></div>
89 <div class="line"><a id="l00181" name="l00181"></a><span class="lineno"><a class="line" href="a00197.html#ga6164ba92cfd06f530ec2c4a18a0dd5a9"> 181</a></span><a class="code hl_function" href="a00197.html#ga6164ba92cfd06f530ec2c4a18a0dd5a9">hwloc_cpukinds_register</a>(<a class="code hl_typedef" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology,</div>
90 <div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span> <a class="code hl_typedef" href="a00188.html#gaa3c2bf4c776d603dcebbb61b0c923d84">hwloc_bitmap_t</a> cpuset,</div>
91 <div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> <span class="keywordtype">int</span> forced_efficiency,</div>
92 <div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> <span class="keywordtype">unsigned</span> nr_infos, <span class="keyword">struct</span> <a class="code hl_struct" href="a00272.html">hwloc_info_s</a> *infos,</div>
93 <div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags);</div>
94 <div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span></div>
95 <div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> </div>
96 <div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span><span class="preprocessor">#ifdef __cplusplus</span></div>
97 <div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span>} <span class="comment">/* extern &quot;C&quot; */</span></div>
98 <div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span><span class="preprocessor">#endif</span></div>
99 <div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> </div>
100 <div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span> </div>
101 <div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span><span class="preprocessor">#endif </span><span class="comment">/* HWLOC_CPUKINDS_H */</span><span class="preprocessor"></span></div>
102 <div class="ttc" id="aa00169_html_ga9d1e76ee15a7dee158b786c30b6a6e38"><div class="ttname"><a href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></div><div class="ttdeci">struct hwloc_topology * hwloc_topology_t</div><div class="ttdoc">Topology context.</div><div class="ttdef"><b>Definition</b> hwloc.h:748</div></div>
103 <div class="ttc" id="aa00188_html_gaa3c2bf4c776d603dcebbb61b0c923d84"><div class="ttname"><a href="a00188.html#gaa3c2bf4c776d603dcebbb61b0c923d84">hwloc_bitmap_t</a></div><div class="ttdeci">struct hwloc_bitmap_s * hwloc_bitmap_t</div><div class="ttdoc">Set of bits represented as an opaque pointer to an internal bitmap.</div><div class="ttdef"><b>Definition</b> bitmap.h:70</div></div>
104 <div class="ttc" id="aa00188_html_gae991a108af01d408be2776c5b2c467b2"><div class="ttname"><a href="a00188.html#gae991a108af01d408be2776c5b2c467b2">hwloc_const_bitmap_t</a></div><div class="ttdeci">const struct hwloc_bitmap_s * hwloc_const_bitmap_t</div><div class="ttdoc">a non-modifiable hwloc_bitmap_t</div><div class="ttdef"><b>Definition</b> bitmap.h:72</div></div>
105 <div class="ttc" id="aa00197_html_ga6164ba92cfd06f530ec2c4a18a0dd5a9"><div class="ttname"><a href="a00197.html#ga6164ba92cfd06f530ec2c4a18a0dd5a9">hwloc_cpukinds_register</a></div><div class="ttdeci">int hwloc_cpukinds_register(hwloc_topology_t topology, hwloc_bitmap_t cpuset, int forced_efficiency, unsigned nr_infos, struct hwloc_info_s *infos, unsigned long flags)</div><div class="ttdoc">Register a kind of CPU in the topology.</div></div>
106 <div class="ttc" id="aa00197_html_ga7553f7c6d3920b169f3fc18dfe6a33e3"><div class="ttname"><a href="a00197.html#ga7553f7c6d3920b169f3fc18dfe6a33e3">hwloc_cpukinds_get_nr</a></div><div class="ttdeci">int hwloc_cpukinds_get_nr(hwloc_topology_t topology, unsigned long flags)</div><div class="ttdoc">Get the number of different kinds of CPU cores in the topology.</div></div>
107 <div class="ttc" id="aa00197_html_gae1b38fbe9c645583fc16052ce6fbb275"><div class="ttname"><a href="a00197.html#gae1b38fbe9c645583fc16052ce6fbb275">hwloc_cpukinds_get_info</a></div><div class="ttdeci">int hwloc_cpukinds_get_info(hwloc_topology_t topology, unsigned kind_index, hwloc_bitmap_t cpuset, int *efficiency, unsigned *nr_infos, struct hwloc_info_s **infos, unsigned long flags)</div><div class="ttdoc">Get the CPU set and infos about a CPU kind in the topology.</div></div>
108 <div class="ttc" id="aa00197_html_gaf979833aab18d2e7f4b17c932cbcf5d8"><div class="ttname"><a href="a00197.html#gaf979833aab18d2e7f4b17c932cbcf5d8">hwloc_cpukinds_get_by_cpuset</a></div><div class="ttdeci">int hwloc_cpukinds_get_by_cpuset(hwloc_topology_t topology, hwloc_const_bitmap_t cpuset, unsigned long flags)</div><div class="ttdoc">Get the index of the CPU kind that contains CPUs listed in cpuset.</div></div>
109 <div class="ttc" id="aa00272_html"><div class="ttname"><a href="a00272.html">hwloc_info_s</a></div><div class="ttdoc">Object info attribute (name and value strings).</div><div class="ttdef"><b>Definition</b> hwloc.h:730</div></div>
110 </div><!-- fragment --></div><!-- contents -->
111 <!-- start footer part -->
112 <hr class="footer"/><address class="footer"><small>
113 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
114 </small></address>
115 </div><!-- doc-content -->
116 </body>
117 </html>