|
| 1 | +<?php |
| 2 | +$topdir = "../../../.."; |
| 3 | +# Note that we must use the PHP "$$" indirection to assign to the |
| 4 | +# "title" variable, because if we list "$ title" (without the space) |
| 5 | +# in this file, Doxygen will replace it with a string title. |
| 6 | +$ver = basename(getcwd()); |
| 7 | +$thwarting_doxygen_preprocessor = "title"; |
| 8 | +$$thwarting_doxygen_preprocessor = "Portable Hardware Locality (hwloc) Documentation: $ver"; |
| 9 | +$header_include_file = "$topdir/projects/hwloc/doc/$ver/www.open-mpi.org-css.inc"; |
| 10 | +include_once("$topdir/projects/hwloc/nav.inc"); |
| 11 | +include_once("$topdir/includes/header.inc"); |
| 12 | +include_once("$topdir/includes/code.inc"); |
| 13 | +?> |
| 14 | +<!-- Generated by Doxygen 1.9.8 --> |
| 15 | +<script type="text/javascript" src="menudata.js"></script> |
| 16 | +<script type="text/javascript" src="menu.js"></script> |
| 17 | +<script type="text/javascript"> |
| 18 | +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| 19 | +$(function() { |
| 20 | + initMenu('',false,false,'search.php','Search'); |
| 21 | +}); |
| 22 | +/* @license-end */ |
| 23 | +</script> |
| 24 | +<div id="main-nav"></div> |
| 25 | +<script type="text/javascript"> |
| 26 | +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| 27 | +$(document).ready(function() { init_codefold(0); }); |
| 28 | +/* @license-end */ |
| 29 | +</script> |
| 30 | +<div id="nav-path" class="navpath"> |
| 31 | + <ul> |
| 32 | +<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.php">include</a></li><li class="navelem"><a class="el" href="dir_5cb306d949c7931a3b6c77517393dd34.php">hwloc</a></li> </ul> |
| 33 | +</div> |
| 34 | +</div><!-- top --> |
| 35 | +<div class="header"> |
| 36 | + <div class="headertitle"><div class="title">cpukinds.h</div></div> |
| 37 | +</div><!--header--> |
| 38 | +<div class="contents"> |
| 39 | +<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| 40 | +<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Copyright © 2020-2021 Inria. All rights reserved.</span></div> |
| 41 | +<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * See COPYING in top-level directory.</span></div> |
| 42 | +<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> */</span></div> |
| 43 | +<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div> |
| 44 | +<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#ifndef HWLOC_CPUKINDS_H</span></div> |
| 45 | +<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#define HWLOC_CPUKINDS_H</span></div> |
| 46 | +<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div> |
| 47 | +<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include "hwloc.h"</span></div> |
| 48 | +<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div> |
| 49 | +<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#ifdef __cplusplus</span></div> |
| 50 | +<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> |
| 51 | +<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#elif 0</span></div> |
| 52 | +<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>}</div> |
| 53 | +<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#endif</span></div> |
| 54 | +<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div> |
| 55 | +<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span>HWLOC_DECLSPEC <span class="keywordtype">int</span></div> |
| 56 | +<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="a00170.php#ga7553f7c6d3920b169f3fc18dfe6a33e3"> 82</a></span><a class="code hl_function" href="a00170.php#ga7553f7c6d3920b169f3fc18dfe6a33e3">hwloc_cpukinds_get_nr</a>(<a class="code hl_typedef" href="a00142.php#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology,</div> |
| 57 | +<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags);</div> |
| 58 | +<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div> |
| 59 | +<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span>HWLOC_DECLSPEC <span class="keywordtype">int</span></div> |
| 60 | +<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="a00170.php#gaf979833aab18d2e7f4b17c932cbcf5d8"> 97</a></span><a class="code hl_function" href="a00170.php#gaf979833aab18d2e7f4b17c932cbcf5d8">hwloc_cpukinds_get_by_cpuset</a>(<a class="code hl_typedef" href="a00142.php#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology,</div> |
| 61 | +<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <a class="code hl_typedef" href="a00161.php#gae991a108af01d408be2776c5b2c467b2">hwloc_const_bitmap_t</a> cpuset,</div> |
| 62 | +<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags);</div> |
| 63 | +<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div> |
| 64 | +<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span>HWLOC_DECLSPEC <span class="keywordtype">int</span></div> |
| 65 | +<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"><a class="line" href="a00170.php#gae1b38fbe9c645583fc16052ce6fbb275"> 135</a></span><a class="code hl_function" href="a00170.php#gae1b38fbe9c645583fc16052ce6fbb275">hwloc_cpukinds_get_info</a>(<a class="code hl_typedef" href="a00142.php#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology,</div> |
| 66 | +<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> <span class="keywordtype">unsigned</span> kind_index,</div> |
| 67 | +<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <a class="code hl_typedef" href="a00161.php#gaa3c2bf4c776d603dcebbb61b0c923d84">hwloc_bitmap_t</a> cpuset,</div> |
| 68 | +<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <span class="keywordtype">int</span> *efficiency,</div> |
| 69 | +<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <span class="keywordtype">unsigned</span> *nr_infos, <span class="keyword">struct</span> <a class="code hl_struct" href="a00245.php">hwloc_info_s</a> **infos,</div> |
| 70 | +<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags);</div> |
| 71 | +<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> </div> |
| 72 | +<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span>HWLOC_DECLSPEC <span class="keywordtype">int</span></div> |
| 73 | +<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"><a class="line" href="a00170.php#ga6164ba92cfd06f530ec2c4a18a0dd5a9"> 180</a></span><a class="code hl_function" href="a00170.php#ga6164ba92cfd06f530ec2c4a18a0dd5a9">hwloc_cpukinds_register</a>(<a class="code hl_typedef" href="a00142.php#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology,</div> |
| 74 | +<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> <a class="code hl_typedef" href="a00161.php#gaa3c2bf4c776d603dcebbb61b0c923d84">hwloc_bitmap_t</a> cpuset,</div> |
| 75 | +<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span> <span class="keywordtype">int</span> forced_efficiency,</div> |
| 76 | +<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> <span class="keywordtype">unsigned</span> nr_infos, <span class="keyword">struct</span> <a class="code hl_struct" href="a00245.php">hwloc_info_s</a> *infos,</div> |
| 77 | +<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags);</div> |
| 78 | +<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> </div> |
| 79 | +<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span><span class="preprocessor">#ifdef __cplusplus</span></div> |
| 80 | +<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span>} <span class="comment">/* extern "C" */</span></div> |
| 81 | +<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span><span class="preprocessor">#endif</span></div> |
| 82 | +<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span> </div> |
| 83 | +<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> </div> |
| 84 | +<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span><span class="preprocessor">#endif </span><span class="comment">/* HWLOC_CPUKINDS_H */</span><span class="preprocessor"></span></div> |
| 85 | +<div class="ttc" id="aa00142_php_ga9d1e76ee15a7dee158b786c30b6a6e38"><div class="ttname"><a href="a00142.php#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:742</div></div> |
| 86 | +<div class="ttc" id="aa00161_php_gaa3c2bf4c776d603dcebbb61b0c923d84"><div class="ttname"><a href="a00161.php#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:69</div></div> |
| 87 | +<div class="ttc" id="aa00161_php_gae991a108af01d408be2776c5b2c467b2"><div class="ttname"><a href="a00161.php#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:71</div></div> |
| 88 | +<div class="ttc" id="aa00170_php_ga6164ba92cfd06f530ec2c4a18a0dd5a9"><div class="ttname"><a href="a00170.php#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> |
| 89 | +<div class="ttc" id="aa00170_php_ga7553f7c6d3920b169f3fc18dfe6a33e3"><div class="ttname"><a href="a00170.php#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> |
| 90 | +<div class="ttc" id="aa00170_php_gae1b38fbe9c645583fc16052ce6fbb275"><div class="ttname"><a href="a00170.php#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> |
| 91 | +<div class="ttc" id="aa00170_php_gaf979833aab18d2e7f4b17c932cbcf5d8"><div class="ttname"><a href="a00170.php#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> |
| 92 | +<div class="ttc" id="aa00245_php"><div class="ttname"><a href="a00245.php">hwloc_info_s</a></div><div class="ttdoc">Object info attribute (name and value strings)</div><div class="ttdef"><b>Definition</b> hwloc.h:724</div></div> |
| 93 | +</div><!-- fragment --></div><!-- contents --> |
| 94 | +<?php |
| 95 | +include_once("$topdir/includes/footer.inc"); |
0 commit comments