Debian Codegraph @

doc/doxygen-doc/html/a00200.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): Interoperability with Linux libnuma bitmask</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">Interoperability with Linux libnuma bitmask </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:ga2511974d8ace16203a42c64584ce010d" id="r_ga2511974d8ace16203a42c64584ce010d"><td class="memItemLeft" align="right" valign="top">struct bitmask *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2511974d8ace16203a42c64584ce010d">hwloc_cpuset_to_linux_libnuma_bitmask</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)</td></tr>
54 <tr class="memitem:gaff816fe5f4ca66b3c850a8b7787b805d" id="r_gaff816fe5f4ca66b3c850a8b7787b805d"><td class="memItemLeft" align="right" valign="top">struct bitmask *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaff816fe5f4ca66b3c850a8b7787b805d">hwloc_nodeset_to_linux_libnuma_bitmask</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00166.html#ga2f5276235841ad66a79bedad16a5a10c">hwloc_const_nodeset_t</a> nodeset)</td></tr>
55 <tr class="memitem:ga7ae208f867a96ba68bee45f277b8b8c3" id="r_ga7ae208f867a96ba68bee45f277b8b8c3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga7ae208f867a96ba68bee45f277b8b8c3">hwloc_cpuset_from_linux_libnuma_bitmask</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, const struct bitmask *bitmask)</td></tr>
56 <tr class="memitem:ga605c3fbbbee114a6c7d0606849be97fa" id="r_ga605c3fbbbee114a6c7d0606849be97fa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga605c3fbbbee114a6c7d0606849be97fa">hwloc_nodeset_from_linux_libnuma_bitmask</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00166.html#ga37e35730fa7e775b5bb0afe893d6d508">hwloc_nodeset_t</a> nodeset, const struct bitmask *bitmask)</td></tr>
57 </table>
58 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
59 <p>This interface helps converting between Linux libnuma bitmasks and hwloc cpusets and nodesets.</p>
60 <dl class="section note"><dt>Note</dt><dd>Topology <code class="param">topology</code> must match the current machine.</dd>
61 <dd>
62 The behavior of libnuma is undefined if the kernel is not NUMA-aware. (when CONFIG_NUMA is not set in the kernel configuration). This helper and libnuma may thus not be strictly compatible in this case, which may be detected by checking whether numa_available() returns -1. </dd></dl>
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="ga7ae208f867a96ba68bee45f277b8b8c3" name="ga7ae208f867a96ba68bee45f277b8b8c3"></a>
65 <h2 class="memtitle"><span class="permalink"><a href="#ga7ae208f867a96ba68bee45f277b8b8c3">&#9670;&#160;</a></span>hwloc_cpuset_from_linux_libnuma_bitmask()</h2>
66
67 <div class="memitem">
68 <div class="memproto">
69 <table class="mlabels">
70 <tr>
71 <td class="mlabels-left">
72 <table class="memname">
73 <tr>
74 <td class="memname">int hwloc_cpuset_from_linux_libnuma_bitmask </td>
75 <td>(</td>
76 <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>
77 </tr>
78 <tr>
79 <td class="paramkey"></td>
80 <td></td>
81 <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>
82 </tr>
83 <tr>
84 <td class="paramkey"></td>
85 <td></td>
86 <td class="paramtype">const struct bitmask *</td> <td class="paramname"><span class="paramname"><em>bitmask</em></span>&#160;)</td>
87 </tr>
88 </table>
89 </td>
90 <td class="mlabels-right">
91 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
92 </tr>
93 </table>
94 </div><div class="memdoc">
95
96 <p>Convert libnuma bitmask <code class="param">bitmask</code> into hwloc CPU set <code class="param">cpuset</code>. </p>
97 <p>This function may be used after calling many numa_ functions that use a struct bitmask as an output parameter.</p>
98 <dl class="section return"><dt>Returns</dt><dd>0 on success. </dd>
99 <dd>
100 -1 with errno set to <code>ENOMEM</code> if some internal reallocation failed. </dd></dl>
101
102 </div>
103 </div>
104 <a id="ga2511974d8ace16203a42c64584ce010d" name="ga2511974d8ace16203a42c64584ce010d"></a>
105 <h2 class="memtitle"><span class="permalink"><a href="#ga2511974d8ace16203a42c64584ce010d">&#9670;&#160;</a></span>hwloc_cpuset_to_linux_libnuma_bitmask()</h2>
106
107 <div class="memitem">
108 <div class="memproto">
109 <table class="mlabels">
110 <tr>
111 <td class="mlabels-left">
112 <table class="memname">
113 <tr>
114 <td class="memname">struct bitmask * hwloc_cpuset_to_linux_libnuma_bitmask </td>
115 <td>(</td>
116 <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>
117 </tr>
118 <tr>
119 <td class="paramkey"></td>
120 <td></td>
121 <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>&#160;)</td>
122 </tr>
123 </table>
124 </td>
125 <td class="mlabels-right">
126 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
127 </tr>
128 </table>
129 </div><div class="memdoc">
130
131 <p>Convert hwloc CPU set <code class="param">cpuset</code> into the returned libnuma bitmask. </p>
132 <p>The returned bitmask should later be freed with numa_bitmask_free.</p>
133 <p>This function may be used before calling many numa_ functions that use a struct bitmask as an input parameter.</p>
134 <dl class="section return"><dt>Returns</dt><dd>newly allocated struct bitmask, or <code>NULL</code> on error.</dd></dl>
135 <dl class="section note"><dt>Note</dt><dd>On heterogeneous memory platforms, we may return multiple local NUMA nodes even if libnuma reports only one (usually the first one). </dd></dl>
136
137 </div>
138 </div>
139 <a id="ga605c3fbbbee114a6c7d0606849be97fa" name="ga605c3fbbbee114a6c7d0606849be97fa"></a>
140 <h2 class="memtitle"><span class="permalink"><a href="#ga605c3fbbbee114a6c7d0606849be97fa">&#9670;&#160;</a></span>hwloc_nodeset_from_linux_libnuma_bitmask()</h2>
141
142 <div class="memitem">
143 <div class="memproto">
144 <table class="mlabels">
145 <tr>
146 <td class="mlabels-left">
147 <table class="memname">
148 <tr>
149 <td class="memname">int hwloc_nodeset_from_linux_libnuma_bitmask </td>
150 <td>(</td>
151 <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>
152 </tr>
153 <tr>
154 <td class="paramkey"></td>
155 <td></td>
156 <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>, </td>
157 </tr>
158 <tr>
159 <td class="paramkey"></td>
160 <td></td>
161 <td class="paramtype">const struct bitmask *</td> <td class="paramname"><span class="paramname"><em>bitmask</em></span>&#160;)</td>
162 </tr>
163 </table>
164 </td>
165 <td class="mlabels-right">
166 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
167 </tr>
168 </table>
169 </div><div class="memdoc">
170
171 <p>Convert libnuma bitmask <code class="param">bitmask</code> into hwloc NUMA node set <code class="param">nodeset</code>. </p>
172 <p>This function may be used after calling many numa_ functions that use a struct bitmask as an output parameter.</p>
173 <dl class="section return"><dt>Returns</dt><dd>0 on success. </dd>
174 <dd>
175 -1 with errno set to <code>ENOMEM</code> if some internal reallocation failed. </dd></dl>
176
177 </div>
178 </div>
179 <a id="gaff816fe5f4ca66b3c850a8b7787b805d" name="gaff816fe5f4ca66b3c850a8b7787b805d"></a>
180 <h2 class="memtitle"><span class="permalink"><a href="#gaff816fe5f4ca66b3c850a8b7787b805d">&#9670;&#160;</a></span>hwloc_nodeset_to_linux_libnuma_bitmask()</h2>
181
182 <div class="memitem">
183 <div class="memproto">
184 <table class="mlabels">
185 <tr>
186 <td class="mlabels-left">
187 <table class="memname">
188 <tr>
189 <td class="memname">struct bitmask * hwloc_nodeset_to_linux_libnuma_bitmask </td>
190 <td>(</td>
191 <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>
192 </tr>
193 <tr>
194 <td class="paramkey"></td>
195 <td></td>
196 <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>
197 </tr>
198 </table>
199 </td>
200 <td class="mlabels-right">
201 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
202 </tr>
203 </table>
204 </div><div class="memdoc">
205
206 <p>Convert hwloc NUMA node set <code class="param">nodeset</code> into the returned libnuma bitmask. </p>
207 <p>The returned bitmask should later be freed with numa_bitmask_free.</p>
208 <p>This function may be used before calling many numa_ functions that use a struct bitmask as an input parameter.</p>
209 <dl class="section return"><dt>Returns</dt><dd>newly allocated struct bitmask, or <code>NULL</code> on error. </dd></dl>
210
211 </div>
212 </div>
213 </div><!-- contents -->
214 <!-- start footer part -->
215 <hr class="footer"/><address class="footer"><small>
216 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
217 </small></address>
218 </div><!-- doc-content -->
219 </body>
220 </html>