Debian Codegraph @

doc/doxygen-doc/html/a00125_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): glibc-sched.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">glibc-sched.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 © 2009 CNRS</span></div>
55 <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * Copyright © 2009-2023 Inria. All rights reserved.</span></div>
56 <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * Copyright © 2009-2011 Université Bordeaux</span></div>
57 <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * Copyright © 2011 Cisco Systems, Inc. All rights reserved.</span></div>
58 <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * See COPYING in top-level directory.</span></div>
59 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> */</span></div>
60 <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span></div>
61 <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
62 <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#ifndef HWLOC_GLIBC_SCHED_H</span></div>
63 <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#define HWLOC_GLIBC_SCHED_H</span></div>
64 <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
65 <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include &quot;hwloc.h&quot;</span></div>
66 <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include &quot;hwloc/helper.h&quot;</span></div>
67 <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
68 <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;assert.h&gt;</span></div>
69 <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
70 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#if !defined _GNU_SOURCE || (!defined _SCHED_H &amp;&amp; !defined _SCHED_H_) || (!defined CPU_SETSIZE &amp;&amp; !defined sched_priority)</span></div>
71 <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#error Please make sure to include sched.h before including glibc-sched.h, and define _GNU_SOURCE before any inclusion of sched.h</span></div>
72 <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#endif</span></div>
73 <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
74 <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
75 <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#ifdef __cplusplus</span></div>
76 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
77 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#endif</span></div>
78 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
79 <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
80 <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#ifdef HWLOC_HAVE_CPU_SET</span></div>
81 <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
82 <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span></div>
83 <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
84 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span></div>
85 <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="keyword">static</span> __hwloc_inline <span class="keywordtype">int</span></div>
86 <div class="foldopen" id="foldopen00060" data-start="{" data-end="}">
87 <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="a00202.html#ga8029317e72d01945afab179892f8581e"> 60</a></span><a class="code hl_function" href="a00202.html#ga8029317e72d01945afab179892f8581e">hwloc_cpuset_to_glibc_sched_affinity</a>(<a class="code hl_typedef" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology __hwloc_attribute_unused, <a class="code hl_typedef" href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a> hwlocset,</div>
88 <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> cpu_set_t *schedset, <span class="keywordtype">size_t</span> schedsetsize)</div>
89 <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span>{</div>
90 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="preprocessor">#ifdef CPU_ZERO_S</span></div>
91 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keywordtype">unsigned</span> cpu;</div>
92 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> CPU_ZERO_S(schedsetsize, schedset);</div>
93 <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <a class="code hl_define" href="a00188.html#ga3f6861045a8029ade373510ffa727d2a">hwloc_bitmap_foreach_begin</a>(cpu, hwlocset)</div>
94 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> CPU_SET_S(cpu, schedsetsize, schedset);</div>
95 <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <a class="code hl_define" href="a00188.html#gafcf3246db406218d4e155735b3fa6528">hwloc_bitmap_foreach_end</a>();</div>
96 <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="preprocessor">#else </span><span class="comment">/* !CPU_ZERO_S */</span><span class="preprocessor"></span></div>
97 <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordtype">unsigned</span> cpu;</div>
98 <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> CPU_ZERO(schedset);</div>
99 <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> assert(schedsetsize == <span class="keyword">sizeof</span>(cpu_set_t));</div>
100 <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <a class="code hl_define" href="a00188.html#ga3f6861045a8029ade373510ffa727d2a">hwloc_bitmap_foreach_begin</a>(cpu, hwlocset)</div>
101 <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> CPU_SET(cpu, schedset);</div>
102 <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <a class="code hl_define" href="a00188.html#gafcf3246db406218d4e155735b3fa6528">hwloc_bitmap_foreach_end</a>();</div>
103 <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="preprocessor">#endif </span><span class="comment">/* !CPU_ZERO_S */</span><span class="preprocessor"></span></div>
104 <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keywordflow">return</span> 0;</div>
105 <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span>}</div>
106 </div>
107 <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span></div>
108 <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="keyword">static</span> __hwloc_inline <span class="keywordtype">int</span></div>
109 <div class="foldopen" id="foldopen00091" data-start="{" data-end="}">
110 <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="a00202.html#gaa3945bd96a56822fe43d912e384236cb"> 91</a></span><a class="code hl_function" href="a00202.html#gaa3945bd96a56822fe43d912e384236cb">hwloc_cpuset_from_glibc_sched_affinity</a>(<a class="code hl_typedef" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology __hwloc_attribute_unused, <a class="code hl_typedef" href="a00166.html#ga4bbf39b68b6f568fb92739e7c0ea7801">hwloc_cpuset_t</a> hwlocset,</div>
111 <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">const</span> cpu_set_t *schedset, <span class="keywordtype">size_t</span> schedsetsize)</div>
112 <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span>{</div>
113 <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keywordtype">int</span> cpu;</div>
114 <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="preprocessor">#ifdef CPU_ZERO_S</span></div>
115 <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keywordtype">int</span> count;</div>
116 <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="preprocessor">#endif</span></div>
117 <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <a class="code hl_function" href="a00188.html#gaa97c5217613c8cae9862287170ea2132">hwloc_bitmap_zero</a>(hwlocset);</div>
118 <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="preprocessor">#ifdef CPU_ZERO_S</span></div>
119 <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> count = CPU_COUNT_S(schedsetsize, schedset);</div>
120 <div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> cpu = 0;</div>
121 <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <span class="keywordflow">while</span> (count) {</div>
122 <div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keywordflow">if</span> (CPU_ISSET_S(cpu, schedsetsize, schedset)) {</div>
123 <div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="a00188.html#ga062dbff93baeff3b425a7260c5463646">hwloc_bitmap_set</a>(hwlocset, cpu) &lt; 0)</div>
124 <div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="keywordflow">return</span> -1;</div>
125 <div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> count--;</div>
126 <div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> }</div>
127 <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> cpu++;</div>
128 <div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> }</div>
129 <div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span><span class="preprocessor">#else </span><span class="comment">/* !CPU_ZERO_S */</span><span class="preprocessor"></span></div>
130 <div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> <span class="comment">/* sched.h does not support dynamic cpu_set_t (introduced in glibc 2.7),</span></div>
131 <div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><span class="comment"> * assume we have a very old interface without CPU_COUNT (added in 2.6)</span></div>
132 <div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span><span class="comment"> */</span></div>
133 <div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> assert(schedsetsize == <span class="keyword">sizeof</span>(cpu_set_t));</div>
134 <div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="keywordflow">for</span>(cpu=0; cpu&lt;CPU_SETSIZE; cpu++)</div>
135 <div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <span class="keywordflow">if</span> (CPU_ISSET(cpu, schedset))</div>
136 <div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="a00188.html#ga062dbff93baeff3b425a7260c5463646">hwloc_bitmap_set</a>(hwlocset, cpu) &lt; 0)</div>
137 <div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="keywordflow">return</span> -1;</div>
138 <div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span><span class="preprocessor">#endif </span><span class="comment">/* !CPU_ZERO_S */</span><span class="preprocessor"></span></div>
139 <div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <span class="keywordflow">return</span> 0;</div>
140 <div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span>}</div>
141 </div>
142 <div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span></div>
143 <div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> </div>
144 <div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div>
145 <div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><span class="preprocessor">#endif </span><span class="comment">/* CPU_SET */</span><span class="preprocessor"></span></div>
146 <div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div>
147 <div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> </div>
148 <div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span><span class="preprocessor">#ifdef __cplusplus</span></div>
149 <div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span>} <span class="comment">/* extern &quot;C&quot; */</span></div>
150 <div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span><span class="preprocessor">#endif</span></div>
151 <div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div>
152 <div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> </div>
153 <div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span><span class="preprocessor">#endif </span><span class="comment">/* HWLOC_GLIBC_SCHED_H */</span><span class="preprocessor"></span></div>
154 <div class="ttc" id="aa00166_html_ga1f784433e9b606261f62d1134f6a3b25"><div class="ttname"><a href="a00166.html#ga1f784433e9b606261f62d1134f6a3b25">hwloc_const_cpuset_t</a></div><div class="ttdeci">hwloc_const_bitmap_t hwloc_const_cpuset_t</div><div class="ttdoc">A non-modifiable hwloc_cpuset_t.</div><div class="ttdef"><b>Definition</b> hwloc.h:167</div></div>
155 <div class="ttc" id="aa00166_html_ga4bbf39b68b6f568fb92739e7c0ea7801"><div class="ttname"><a href="a00166.html#ga4bbf39b68b6f568fb92739e7c0ea7801">hwloc_cpuset_t</a></div><div class="ttdeci">hwloc_bitmap_t hwloc_cpuset_t</div><div class="ttdoc">A CPU set is a bitmap whose bits are set according to CPU physical OS indexes.</div><div class="ttdef"><b>Definition</b> hwloc.h:165</div></div>
156 <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>
157 <div class="ttc" id="aa00188_html_ga062dbff93baeff3b425a7260c5463646"><div class="ttname"><a href="a00188.html#ga062dbff93baeff3b425a7260c5463646">hwloc_bitmap_set</a></div><div class="ttdeci">int hwloc_bitmap_set(hwloc_bitmap_t bitmap, unsigned id)</div><div class="ttdoc">Add index id in bitmap bitmap.</div></div>
158 <div class="ttc" id="aa00188_html_ga3f6861045a8029ade373510ffa727d2a"><div class="ttname"><a href="a00188.html#ga3f6861045a8029ade373510ffa727d2a">hwloc_bitmap_foreach_begin</a></div><div class="ttdeci">#define hwloc_bitmap_foreach_begin(id, bitmap)</div><div class="ttdoc">Loop macro iterating on bitmap bitmap.</div><div class="ttdef"><b>Definition</b> bitmap.h:455</div></div>
159 <div class="ttc" id="aa00188_html_gaa97c5217613c8cae9862287170ea2132"><div class="ttname"><a href="a00188.html#gaa97c5217613c8cae9862287170ea2132">hwloc_bitmap_zero</a></div><div class="ttdeci">void hwloc_bitmap_zero(hwloc_bitmap_t bitmap)</div><div class="ttdoc">Empty the bitmap bitmap.</div></div>
160 <div class="ttc" id="aa00188_html_gafcf3246db406218d4e155735b3fa6528"><div class="ttname"><a href="a00188.html#gafcf3246db406218d4e155735b3fa6528">hwloc_bitmap_foreach_end</a></div><div class="ttdeci">#define hwloc_bitmap_foreach_end()</div><div class="ttdoc">End of loop macro iterating on a bitmap.</div><div class="ttdef"><b>Definition</b> bitmap.h:469</div></div>
161 <div class="ttc" id="aa00202_html_ga8029317e72d01945afab179892f8581e"><div class="ttname"><a href="a00202.html#ga8029317e72d01945afab179892f8581e">hwloc_cpuset_to_glibc_sched_affinity</a></div><div class="ttdeci">int hwloc_cpuset_to_glibc_sched_affinity(hwloc_topology_t topology, hwloc_const_cpuset_t hwlocset, cpu_set_t *schedset, size_t schedsetsize)</div><div class="ttdoc">Convert hwloc CPU set toposet into glibc sched affinity CPU set schedset.</div><div class="ttdef"><b>Definition</b> glibc-sched.h:60</div></div>
162 <div class="ttc" id="aa00202_html_gaa3945bd96a56822fe43d912e384236cb"><div class="ttname"><a href="a00202.html#gaa3945bd96a56822fe43d912e384236cb">hwloc_cpuset_from_glibc_sched_affinity</a></div><div class="ttdeci">int hwloc_cpuset_from_glibc_sched_affinity(hwloc_topology_t topology, hwloc_cpuset_t hwlocset, const cpu_set_t *schedset, size_t schedsetsize)</div><div class="ttdoc">Convert glibc sched affinity CPU set schedset into hwloc CPU set.</div><div class="ttdef"><b>Definition</b> glibc-sched.h:91</div></div>
163 </div><!-- fragment --></div><!-- contents -->
164 <!-- start footer part -->
165 <hr class="footer"/><address class="footer"><small>
166 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
167 </small></address>
168 </div><!-- doc-content -->
169 </body>
170 </html>