Debian Codegraph @

doc/doxygen-doc/html/a00149_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): gl.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">gl.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 © 2012 Blue Brain Project, EPFL. All rights reserved.</span></div>
55 <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * Copyright © 2012-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"> * See COPYING in top-level directory.</span></div>
57 <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> */</span></div>
58 <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span></div>
59 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
60 <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#ifndef HWLOC_GL_H</span></div>
61 <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#define HWLOC_GL_H</span></div>
62 <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
63 <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include &quot;hwloc.h&quot;</span></div>
64 <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
65 <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include &lt;stdio.h&gt;</span></div>
66 <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include &lt;string.h&gt;</span></div>
67 <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
68 <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
69 <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#ifdef __cplusplus</span></div>
70 <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
71 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#endif</span></div>
72 <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
73 <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span></div>
74 <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span></div>
75 <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="keyword">static</span> __hwloc_inline <a class="code hl_typedef" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a></div>
76 <div class="foldopen" id="foldopen00062" data-start="{" data-end="}">
77 <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="a00210.html#ga0d921ec05cc6ad4f94260f70c09aa15c"> 62</a></span><a class="code hl_function" href="a00210.html#ga0d921ec05cc6ad4f94260f70c09aa15c">hwloc_gl_get_display_osdev_by_port_device</a>(<a class="code hl_typedef" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology,</div>
78 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keywordtype">unsigned</span> port, <span class="keywordtype">unsigned</span> device)</div>
79 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span>{</div>
80 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordtype">unsigned</span> x = (unsigned) -1, y = (<span class="keywordtype">unsigned</span>) -1;</div>
81 <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <a class="code hl_typedef" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> osdev = NULL;</div>
82 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keywordflow">while</span> ((osdev = <a class="code hl_function" href="a00187.html#ga17bba843ffa24978505961f104ee2efb">hwloc_get_next_osdev</a>(topology, osdev)) != NULL) {</div>
83 <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keywordflow">if</span> (<a class="code hl_enumvalue" href="a00167.html#gga64f5d539df299c97ae80ce53fc4b56c0aa3a09798ef2836abb236dc3a645ffc90">HWLOC_OBJ_OSDEV_GPU</a> == osdev-&gt;<a class="code hl_variable" href="a00224.html#accd40e29f71f19e88db62ea3df02adc8">attr</a>-&gt;<a class="code hl_variable" href="a00228.html#aaf7a5c38b5185703ff18c46ad2761dcf">osdev</a>.<a class="code hl_variable" href="a00268.html#a31e019e27e54ac6138d04be639bb96f9">type</a></div>
84 <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> &amp;&amp; osdev-&gt;<a class="code hl_variable" href="a00224.html#abb709ec38f2970677e4e57d1d30be96d">name</a></div>
85 <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> &amp;&amp; sscanf(osdev-&gt;<a class="code hl_variable" href="a00224.html#abb709ec38f2970677e4e57d1d30be96d">name</a>, <span class="stringliteral">&quot;:%u.%u&quot;</span>, &amp;x, &amp;y) == 2</div>
86 <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> &amp;&amp; port == x &amp;&amp; device == y)</div>
87 <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keywordflow">return</span> osdev;</div>
88 <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> }</div>
89 <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> errno = EINVAL;</div>
90 <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordflow">return</span> NULL;</div>
91 <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span>}</div>
92 </div>
93 <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span></div>
94 <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="keyword">static</span> __hwloc_inline <a class="code hl_typedef" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a></div>
95 <div class="foldopen" id="foldopen00097" data-start="{" data-end="}">
96 <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="a00210.html#gac643ba3fb237f02b99936ed1c777dfa1"> 97</a></span><a class="code hl_function" href="a00210.html#gac643ba3fb237f02b99936ed1c777dfa1">hwloc_gl_get_display_osdev_by_name</a>(<a class="code hl_typedef" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology,</div>
97 <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *name)</div>
98 <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span>{</div>
99 <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <a class="code hl_typedef" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> osdev = NULL;</div>
100 <div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="keywordflow">while</span> ((osdev = <a class="code hl_function" href="a00187.html#ga17bba843ffa24978505961f104ee2efb">hwloc_get_next_osdev</a>(topology, osdev)) != NULL) {</div>
101 <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <span class="keywordflow">if</span> (<a class="code hl_enumvalue" href="a00167.html#gga64f5d539df299c97ae80ce53fc4b56c0aa3a09798ef2836abb236dc3a645ffc90">HWLOC_OBJ_OSDEV_GPU</a> == osdev-&gt;<a class="code hl_variable" href="a00224.html#accd40e29f71f19e88db62ea3df02adc8">attr</a>-&gt;<a class="code hl_variable" href="a00228.html#aaf7a5c38b5185703ff18c46ad2761dcf">osdev</a>.<a class="code hl_variable" href="a00268.html#a31e019e27e54ac6138d04be639bb96f9">type</a></div>
102 <div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> &amp;&amp; osdev-&gt;<a class="code hl_variable" href="a00224.html#abb709ec38f2970677e4e57d1d30be96d">name</a></div>
103 <div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> &amp;&amp; !strcmp(name, osdev-&gt;<a class="code hl_variable" href="a00224.html#abb709ec38f2970677e4e57d1d30be96d">name</a>))</div>
104 <div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="keywordflow">return</span> osdev;</div>
105 <div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> }</div>
106 <div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> errno = EINVAL;</div>
107 <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <span class="keywordflow">return</span> NULL;</div>
108 <div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span>}</div>
109 </div>
110 <div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span></div>
111 <div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span><span class="keyword">static</span> __hwloc_inline <span class="keywordtype">int</span></div>
112 <div class="foldopen" id="foldopen00129" data-start="{" data-end="}">
113 <div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="a00210.html#ga3239c297cebe672c5a11cac94d6a60ef"> 129</a></span><a class="code hl_function" href="a00210.html#ga3239c297cebe672c5a11cac94d6a60ef">hwloc_gl_get_display_by_osdev</a>(<a class="code hl_typedef" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology __hwloc_attribute_unused,</div>
114 <div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> <a class="code hl_typedef" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> osdev,</div>
115 <div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> <span class="keywordtype">unsigned</span> *port, <span class="keywordtype">unsigned</span> *device)</div>
116 <div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span>{</div>
117 <div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> <span class="keywordtype">unsigned</span> x = -1, y = -1;</div>
118 <div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> <span class="keywordflow">if</span> (<a class="code hl_enumvalue" href="a00167.html#gga64f5d539df299c97ae80ce53fc4b56c0aa3a09798ef2836abb236dc3a645ffc90">HWLOC_OBJ_OSDEV_GPU</a> == osdev-&gt;<a class="code hl_variable" href="a00224.html#accd40e29f71f19e88db62ea3df02adc8">attr</a>-&gt;<a class="code hl_variable" href="a00228.html#aaf7a5c38b5185703ff18c46ad2761dcf">osdev</a>.<a class="code hl_variable" href="a00268.html#a31e019e27e54ac6138d04be639bb96f9">type</a></div>
119 <div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> &amp;&amp; sscanf(osdev-&gt;<a class="code hl_variable" href="a00224.html#abb709ec38f2970677e4e57d1d30be96d">name</a>, <span class="stringliteral">&quot;:%u.%u&quot;</span>, &amp;x, &amp;y) == 2) {</div>
120 <div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> *port = x;</div>
121 <div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> *device = y;</div>
122 <div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <span class="keywordflow">return</span> 0;</div>
123 <div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> }</div>
124 <div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> errno = EINVAL;</div>
125 <div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> <span class="keywordflow">return</span> -1;</div>
126 <div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span>}</div>
127 </div>
128 <div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span></div>
129 <div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> </div>
130 <div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> </div>
131 <div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span><span class="preprocessor">#ifdef __cplusplus</span></div>
132 <div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span>} <span class="comment">/* extern &quot;C&quot; */</span></div>
133 <div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span><span class="preprocessor">#endif</span></div>
134 <div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> </div>
135 <div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> </div>
136 <div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span><span class="preprocessor">#endif </span><span class="comment">/* HWLOC_GL_H */</span><span class="preprocessor"></span></div>
137 <div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> </div>
138 <div class="ttc" id="aa00167_html_gga64f5d539df299c97ae80ce53fc4b56c0aa3a09798ef2836abb236dc3a645ffc90"><div class="ttname"><a href="a00167.html#gga64f5d539df299c97ae80ce53fc4b56c0aa3a09798ef2836abb236dc3a645ffc90">HWLOC_OBJ_OSDEV_GPU</a></div><div class="ttdeci">@ HWLOC_OBJ_OSDEV_GPU</div><div class="ttdoc">Operating system GPU device. For instance &quot;:0.0&quot; for a GL display, &quot;card0&quot; for a Linux DRM device.</div><div class="ttdef"><b>Definition</b> hwloc.h:380</div></div>
139 <div class="ttc" id="aa00168_html_ga79b8ab56877ef99ac59b833203391c7d"><div class="ttname"><a href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a></div><div class="ttdeci">struct hwloc_obj * hwloc_obj_t</div><div class="ttdoc">Convenience typedef; a pointer to a struct hwloc_obj.</div><div class="ttdef"><b>Definition</b> hwloc.h:637</div></div>
140 <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>
141 <div class="ttc" id="aa00187_html_ga17bba843ffa24978505961f104ee2efb"><div class="ttname"><a href="a00187.html#ga17bba843ffa24978505961f104ee2efb">hwloc_get_next_osdev</a></div><div class="ttdeci">hwloc_obj_t hwloc_get_next_osdev(hwloc_topology_t topology, hwloc_obj_t prev)</div><div class="ttdoc">Get the next OS device in the system.</div><div class="ttdef"><b>Definition</b> helper.h:1291</div></div>
142 <div class="ttc" id="aa00210_html_ga0d921ec05cc6ad4f94260f70c09aa15c"><div class="ttname"><a href="a00210.html#ga0d921ec05cc6ad4f94260f70c09aa15c">hwloc_gl_get_display_osdev_by_port_device</a></div><div class="ttdeci">hwloc_obj_t hwloc_gl_get_display_osdev_by_port_device(hwloc_topology_t topology, unsigned port, unsigned device)</div><div class="ttdoc">Get the hwloc OS device object corresponding to the OpenGL display given by port and device index.</div><div class="ttdef"><b>Definition</b> gl.h:62</div></div>
143 <div class="ttc" id="aa00210_html_ga3239c297cebe672c5a11cac94d6a60ef"><div class="ttname"><a href="a00210.html#ga3239c297cebe672c5a11cac94d6a60ef">hwloc_gl_get_display_by_osdev</a></div><div class="ttdeci">int hwloc_gl_get_display_by_osdev(hwloc_topology_t topology, hwloc_obj_t osdev, unsigned *port, unsigned *device)</div><div class="ttdoc">Get the OpenGL display port and device corresponding to the given hwloc OS object.</div><div class="ttdef"><b>Definition</b> gl.h:129</div></div>
144 <div class="ttc" id="aa00210_html_gac643ba3fb237f02b99936ed1c777dfa1"><div class="ttname"><a href="a00210.html#gac643ba3fb237f02b99936ed1c777dfa1">hwloc_gl_get_display_osdev_by_name</a></div><div class="ttdeci">hwloc_obj_t hwloc_gl_get_display_osdev_by_name(hwloc_topology_t topology, const char *name)</div><div class="ttdoc">Get the hwloc OS device object corresponding to the OpenGL display given by name.</div><div class="ttdef"><b>Definition</b> gl.h:97</div></div>
145 <div class="ttc" id="aa00224_html_abb709ec38f2970677e4e57d1d30be96d"><div class="ttname"><a href="a00224.html#abb709ec38f2970677e4e57d1d30be96d">hwloc_obj::name</a></div><div class="ttdeci">char * name</div><div class="ttdoc">Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...</div><div class="ttdef"><b>Definition</b> hwloc.h:449</div></div>
146 <div class="ttc" id="aa00224_html_accd40e29f71f19e88db62ea3df02adc8"><div class="ttname"><a href="a00224.html#accd40e29f71f19e88db62ea3df02adc8">hwloc_obj::attr</a></div><div class="ttdeci">union hwloc_obj_attr_u * attr</div><div class="ttdoc">Object type-specific Attributes, may be NULL if no attribute value was found.</div><div class="ttdef"><b>Definition</b> hwloc.h:456</div></div>
147 <div class="ttc" id="aa00228_html_aaf7a5c38b5185703ff18c46ad2761dcf"><div class="ttname"><a href="a00228.html#aaf7a5c38b5185703ff18c46ad2761dcf">hwloc_obj_attr_u::osdev</a></div><div class="ttdeci">struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev</div></div>
148 <div class="ttc" id="aa00268_html_a31e019e27e54ac6138d04be639bb96f9"><div class="ttname"><a href="a00268.html#a31e019e27e54ac6138d04be639bb96f9">hwloc_obj_attr_u::hwloc_osdev_attr_s::type</a></div><div class="ttdeci">hwloc_obj_osdev_type_t type</div><div class="ttdef"><b>Definition</b> hwloc.h:722</div></div>
149 </div><!-- fragment --></div><!-- contents -->
150 <!-- start footer part -->
151 <hr class="footer"/><address class="footer"><small>
152 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
153 </small></address>
154 </div><!-- doc-content -->
155 </body>
156 </html>