Debian Codegraph @

doc/doxygen-doc/html/a00158_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): shmem.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">shmem.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 © 2013-2023 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_SHMEM_H</span></div>
60 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#define HWLOC_SHMEM_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="l00022" name="l00022"></a><span class="lineno"> 22</span></div>
71 <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span></div>
72 <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="a00213.html#ga772ab52750cdd0eec85128df24888001"> 56</a></span>HWLOC_DECLSPEC <span class="keywordtype">int</span> <a class="code hl_function" href="a00213.html#ga772ab52750cdd0eec85128df24888001">hwloc_shmem_topology_get_length</a>(<a class="code hl_typedef" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology,</div>
73 <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keywordtype">size_t</span> *lengthp,</div>
74 <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags);</div>
75 <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span></div>
76 <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="a00213.html#ga61b20e346fc76f76420e3a88cc80a671"> 86</a></span>HWLOC_DECLSPEC <span class="keywordtype">int</span> <a class="code hl_function" href="a00213.html#ga61b20e346fc76f76420e3a88cc80a671">hwloc_shmem_topology_write</a>(<a class="code hl_typedef" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology,</div>
77 <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keywordtype">int</span> fd, hwloc_uint64_t fileoffset,</div>
78 <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordtype">void</span> *mmap_address, <span class="keywordtype">size_t</span> length,</div>
79 <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags);</div>
80 <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span></div>
81 <div class="line"><a id="l00131" name="l00131"></a><span class="lineno"><a class="line" href="a00213.html#ga21545bd0f09d9b554c8e60a630e0e629"> 131</a></span>HWLOC_DECLSPEC <span class="keywordtype">int</span> <a class="code hl_function" href="a00213.html#ga21545bd0f09d9b554c8e60a630e0e629">hwloc_shmem_topology_adopt</a>(<a class="code hl_typedef" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> *topologyp,</div>
82 <div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> <span class="keywordtype">int</span> fd, hwloc_uint64_t fileoffset,</div>
83 <div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> <span class="keywordtype">void</span> *mmap_address, <span class="keywordtype">size_t</span> length,</div>
84 <div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags);</div>
85 <div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> </div>
86 <div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> </div>
87 <div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span><span class="preprocessor">#ifdef __cplusplus</span></div>
88 <div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span>} <span class="comment">/* extern &quot;C&quot; */</span></div>
89 <div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span><span class="preprocessor">#endif</span></div>
90 <div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> </div>
91 <div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> </div>
92 <div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span><span class="preprocessor">#endif </span><span class="comment">/* HWLOC_SHMEM_H */</span><span class="preprocessor"></span></div>
93 <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>
94 <div class="ttc" id="aa00213_html_ga21545bd0f09d9b554c8e60a630e0e629"><div class="ttname"><a href="a00213.html#ga21545bd0f09d9b554c8e60a630e0e629">hwloc_shmem_topology_adopt</a></div><div class="ttdeci">int hwloc_shmem_topology_adopt(hwloc_topology_t *topologyp, int fd, hwloc_uint64_t fileoffset, void *mmap_address, size_t length, unsigned long flags)</div><div class="ttdoc">Adopt a shared memory topology stored in a file.</div></div>
95 <div class="ttc" id="aa00213_html_ga61b20e346fc76f76420e3a88cc80a671"><div class="ttname"><a href="a00213.html#ga61b20e346fc76f76420e3a88cc80a671">hwloc_shmem_topology_write</a></div><div class="ttdeci">int hwloc_shmem_topology_write(hwloc_topology_t topology, int fd, hwloc_uint64_t fileoffset, void *mmap_address, size_t length, unsigned long flags)</div><div class="ttdoc">Duplicate a topology to a shared memory file.</div></div>
96 <div class="ttc" id="aa00213_html_ga772ab52750cdd0eec85128df24888001"><div class="ttname"><a href="a00213.html#ga772ab52750cdd0eec85128df24888001">hwloc_shmem_topology_get_length</a></div><div class="ttdeci">int hwloc_shmem_topology_get_length(hwloc_topology_t topology, size_t *lengthp, unsigned long flags)</div><div class="ttdoc">Get the required shared memory length for storing a topology.</div></div>
97 </div><!-- fragment --></div><!-- contents -->
98 <!-- start footer part -->
99 <hr class="footer"/><address class="footer"><small>
100 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
101 </small></address>
102 </div><!-- doc-content -->
103 </body>
104 </html>