Debian Codegraph @

doc/doxygen-doc/html/a00210.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 OpenGL displays</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 OpenGL displays </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:ga0d921ec05cc6ad4f94260f70c09aa15c" id="r_ga0d921ec05cc6ad4f94260f70c09aa15c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0d921ec05cc6ad4f94260f70c09aa15c">hwloc_gl_get_display_osdev_by_port_device</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, unsigned port, unsigned device)</td></tr>
54 <tr class="memitem:gac643ba3fb237f02b99936ed1c777dfa1" id="r_gac643ba3fb237f02b99936ed1c777dfa1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gac643ba3fb237f02b99936ed1c777dfa1">hwloc_gl_get_display_osdev_by_name</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, const char *name)</td></tr>
55 <tr class="memitem:ga3239c297cebe672c5a11cac94d6a60ef" id="r_ga3239c297cebe672c5a11cac94d6a60ef"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3239c297cebe672c5a11cac94d6a60ef">hwloc_gl_get_display_by_osdev</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> osdev, unsigned *port, unsigned *device)</td></tr>
56 </table>
57 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
58 <p>This interface offers ways to retrieve topology information about OpenGL displays.</p>
59 <p>Only the NVIDIA display locality information is currently available, using the NV-CONTROL X11 extension and the NVCtrl library.</p>
60 <p>This code may hang when trying to connect to the X server. Hence the GL component is disabled unless HWLOC_GL=1 in the environment. </p>
61 <a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
62 <a id="ga3239c297cebe672c5a11cac94d6a60ef" name="ga3239c297cebe672c5a11cac94d6a60ef"></a>
63 <h2 class="memtitle"><span class="permalink"><a href="#ga3239c297cebe672c5a11cac94d6a60ef">&#9670;&#160;</a></span>hwloc_gl_get_display_by_osdev()</h2>
64
65 <div class="memitem">
66 <div class="memproto">
67 <table class="mlabels">
68 <tr>
69 <td class="mlabels-left">
70 <table class="memname">
71 <tr>
72 <td class="memname">int hwloc_gl_get_display_by_osdev </td>
73 <td>(</td>
74 <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>
75 </tr>
76 <tr>
77 <td class="paramkey"></td>
78 <td></td>
79 <td class="paramtype"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a></td> <td class="paramname"><span class="paramname"><em>osdev</em></span>, </td>
80 </tr>
81 <tr>
82 <td class="paramkey"></td>
83 <td></td>
84 <td class="paramtype">unsigned *</td> <td class="paramname"><span class="paramname"><em>port</em></span>, </td>
85 </tr>
86 <tr>
87 <td class="paramkey"></td>
88 <td></td>
89 <td class="paramtype">unsigned *</td> <td class="paramname"><span class="paramname"><em>device</em></span>&#160;)</td>
90 </tr>
91 </table>
92 </td>
93 <td class="mlabels-right">
94 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
95 </tr>
96 </table>
97 </div><div class="memdoc">
98
99 <p>Get the OpenGL display port and device corresponding to the given hwloc OS object. </p>
100 <p>Retrieves the OpenGL display port (server) in <code class="param">port</code> and device (screen) in <code class="param">screen</code> that correspond to the given hwloc OS device object.</p>
101 <dl class="section return"><dt>Returns</dt><dd>0 on success. </dd>
102 <dd>
103 -1 if none could be found.</dd></dl>
104 <p>The topology <code class="param">topology</code> does not necessarily have to match the current machine. For instance the topology may be an XML import of a remote host. I/O devices detection and the GL component must be enabled in the topology.</p>
105 <dl class="section note"><dt>Note</dt><dd>The GL backend creating these OS devices is disabled by default since it may cause hwloc to hang when trying to connect to the X server. Set HWLOC_GL=1 in the environment to reenable it. </dd></dl>
106
107 </div>
108 </div>
109 <a id="gac643ba3fb237f02b99936ed1c777dfa1" name="gac643ba3fb237f02b99936ed1c777dfa1"></a>
110 <h2 class="memtitle"><span class="permalink"><a href="#gac643ba3fb237f02b99936ed1c777dfa1">&#9670;&#160;</a></span>hwloc_gl_get_display_osdev_by_name()</h2>
111
112 <div class="memitem">
113 <div class="memproto">
114 <table class="mlabels">
115 <tr>
116 <td class="mlabels-left">
117 <table class="memname">
118 <tr>
119 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_gl_get_display_osdev_by_name </td>
120 <td>(</td>
121 <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>
122 </tr>
123 <tr>
124 <td class="paramkey"></td>
125 <td></td>
126 <td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em></span>&#160;)</td>
127 </tr>
128 </table>
129 </td>
130 <td class="mlabels-right">
131 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
132 </tr>
133 </table>
134 </div><div class="memdoc">
135
136 <p>Get the hwloc OS device object corresponding to the OpenGL display given by name. </p>
137 <dl class="section return"><dt>Returns</dt><dd>The hwloc OS device object describing the OpenGL display whose name is <code class="param">name</code>, built as ":port.device" such as ":0.0" . </dd>
138 <dd>
139 <code>NULL</code> if none could be found.</dd></dl>
140 <p>The topology <code class="param">topology</code> does not necessarily have to match the current machine. For instance the topology may be an XML import of a remote host. I/O devices detection and the GL component must be enabled in the topology.</p>
141 <dl class="section note"><dt>Note</dt><dd>The GL backend creating these OS devices is disabled by default since it may cause hwloc to hang when trying to connect to the X server. Set HWLOC_GL=1 in the environment to reenable it.</dd>
142 <dd>
143 The corresponding PCI device object can be obtained by looking at the OS device parent object (unless PCI devices are filtered out). </dd></dl>
144
145 </div>
146 </div>
147 <a id="ga0d921ec05cc6ad4f94260f70c09aa15c" name="ga0d921ec05cc6ad4f94260f70c09aa15c"></a>
148 <h2 class="memtitle"><span class="permalink"><a href="#ga0d921ec05cc6ad4f94260f70c09aa15c">&#9670;&#160;</a></span>hwloc_gl_get_display_osdev_by_port_device()</h2>
149
150 <div class="memitem">
151 <div class="memproto">
152 <table class="mlabels">
153 <tr>
154 <td class="mlabels-left">
155 <table class="memname">
156 <tr>
157 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_gl_get_display_osdev_by_port_device </td>
158 <td>(</td>
159 <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>
160 </tr>
161 <tr>
162 <td class="paramkey"></td>
163 <td></td>
164 <td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>port</em></span>, </td>
165 </tr>
166 <tr>
167 <td class="paramkey"></td>
168 <td></td>
169 <td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>device</em></span>&#160;)</td>
170 </tr>
171 </table>
172 </td>
173 <td class="mlabels-right">
174 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
175 </tr>
176 </table>
177 </div><div class="memdoc">
178
179 <p>Get the hwloc OS device object corresponding to the OpenGL display given by port and device index. </p>
180 <dl class="section return"><dt>Returns</dt><dd>The hwloc OS device object describing the OpenGL display whose port (server) is <code class="param">port</code> and device (screen) is <code class="param">device</code>. </dd>
181 <dd>
182 <code>NULL</code> if none could be found.</dd></dl>
183 <p>The topology <code class="param">topology</code> does not necessarily have to match the current machine. For instance the topology may be an XML import of a remote host. I/O devices detection and the GL component must be enabled in the topology.</p>
184 <dl class="section note"><dt>Note</dt><dd>The GL backend creating these OS devices is disabled by default since it may cause hwloc to hang when trying to connect to the X server. Set HWLOC_GL=1 in the environment to reenable it.</dd>
185 <dd>
186 The corresponding PCI device object can be obtained by looking at the OS device parent object (unless PCI devices are filtered out). </dd></dl>
187
188 </div>
189 </div>
190 </div><!-- contents -->
191 <!-- start footer part -->
192 <hr class="footer"/><address class="footer"><small>
193 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
194 </small></address>
195 </div><!-- doc-content -->
196 </body>
197 </html>