Debian Codegraph @

doc/doxygen-doc/html/a00186.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): Converting between CPU sets and node sets</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">Converting between CPU sets and node sets </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:gaa06b612bcf2babdccfe0071f470ec9b7" id="r_gaa06b612bcf2babdccfe0071f470ec9b7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa06b612bcf2babdccfe0071f470ec9b7">hwloc_cpuset_to_nodeset</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> _cpuset, <a class="el" href="a00166.html#ga37e35730fa7e775b5bb0afe893d6d508">hwloc_nodeset_t</a> nodeset)</td></tr>
54 <tr class="memitem:gae8180d79a731d610836f2a4789e00db1" id="r_gae8180d79a731d610836f2a4789e00db1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gae8180d79a731d610836f2a4789e00db1">hwloc_cpuset_from_nodeset</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00166.html#ga4bbf39b68b6f568fb92739e7c0ea7801">hwloc_cpuset_t</a> _cpuset, <a class="el" href="a00166.html#ga2f5276235841ad66a79bedad16a5a10c">hwloc_const_nodeset_t</a> nodeset)</td></tr>
55 </table>
56 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
57 <a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
58 <a id="gae8180d79a731d610836f2a4789e00db1" name="gae8180d79a731d610836f2a4789e00db1"></a>
59 <h2 class="memtitle"><span class="permalink"><a href="#gae8180d79a731d610836f2a4789e00db1">&#9670;&#160;</a></span>hwloc_cpuset_from_nodeset()</h2>
60
61 <div class="memitem">
62 <div class="memproto">
63 <table class="mlabels">
64 <tr>
65 <td class="mlabels-left">
66 <table class="memname">
67 <tr>
68 <td class="memname">int hwloc_cpuset_from_nodeset </td>
69 <td>(</td>
70 <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>
71 </tr>
72 <tr>
73 <td class="paramkey"></td>
74 <td></td>
75 <td class="paramtype"><a class="el" href="a00166.html#ga4bbf39b68b6f568fb92739e7c0ea7801">hwloc_cpuset_t</a></td> <td class="paramname"><span class="paramname"><em>_cpuset</em></span>, </td>
76 </tr>
77 <tr>
78 <td class="paramkey"></td>
79 <td></td>
80 <td class="paramtype"><a class="el" href="a00166.html#ga2f5276235841ad66a79bedad16a5a10c">hwloc_const_nodeset_t</a></td> <td class="paramname"><span class="paramname"><em>nodeset</em></span>&#160;)</td>
81 </tr>
82 </table>
83 </td>
84 <td class="mlabels-right">
85 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
86 </tr>
87 </table>
88 </div><div class="memdoc">
89
90 <p>Convert a NUMA node set into a CPU set. </p>
91 <p>For each NUMA node included in the input <code class="param">nodeset</code>, set the corresponding local PUs in the output <code class="param">_cpuset</code>.</p>
92 <p>If some CPUs have no local NUMA nodes, this function never sets their indexes in the output CPU set, even if a full node set is given in input.</p>
93 <p>Hence the entire topology node set is converted into the set of all CPUs that have some local NUMA nodes.</p>
94 <dl class="section return"><dt>Returns</dt><dd>0 on success. </dd>
95 <dd>
96 -1 with errno set to <code>ENOMEM</code> on internal reallocation failure. </dd></dl>
97
98 </div>
99 </div>
100 <a id="gaa06b612bcf2babdccfe0071f470ec9b7" name="gaa06b612bcf2babdccfe0071f470ec9b7"></a>
101 <h2 class="memtitle"><span class="permalink"><a href="#gaa06b612bcf2babdccfe0071f470ec9b7">&#9670;&#160;</a></span>hwloc_cpuset_to_nodeset()</h2>
102
103 <div class="memitem">
104 <div class="memproto">
105 <table class="mlabels">
106 <tr>
107 <td class="mlabels-left">
108 <table class="memname">
109 <tr>
110 <td class="memname">int hwloc_cpuset_to_nodeset </td>
111 <td>(</td>
112 <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>
113 </tr>
114 <tr>
115 <td class="paramkey"></td>
116 <td></td>
117 <td class="paramtype"><a class="el" href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a></td> <td class="paramname"><span class="paramname"><em>_cpuset</em></span>, </td>
118 </tr>
119 <tr>
120 <td class="paramkey"></td>
121 <td></td>
122 <td class="paramtype"><a class="el" href="a00166.html#ga37e35730fa7e775b5bb0afe893d6d508">hwloc_nodeset_t</a></td> <td class="paramname"><span class="paramname"><em>nodeset</em></span>&#160;)</td>
123 </tr>
124 </table>
125 </td>
126 <td class="mlabels-right">
127 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
128 </tr>
129 </table>
130 </div><div class="memdoc">
131
132 <p>Convert a CPU set into a NUMA node set. </p>
133 <p>For each PU included in the input <code class="param">_cpuset</code>, set the corresponding local NUMA node(s) in the output <code class="param">nodeset</code>.</p>
134 <p>If some NUMA nodes have no CPUs at all, this function never sets their indexes in the output node set, even if a full CPU set is given in input.</p>
135 <p>Hence the entire topology CPU set is converted into the set of all nodes that have some local CPUs.</p>
136 <dl class="section return"><dt>Returns</dt><dd>0 on success. </dd>
137 <dd>
138 -1 with errno set to <code>ENOMEM</code> on internal reallocation failure. </dd></dl>
139
140 </div>
141 </div>
142 </div><!-- contents -->
143 <!-- start footer part -->
144 <hr class="footer"/><address class="footer"><small>
145 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
146 </small></address>
147 </div><!-- doc-content -->
148 </body>
149 </html>