/usr/share/doc/libhwloc-doc/html/a00106.html is in libhwloc-doc 1.8-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Hardware Locality (hwloc): Interoperability with OpenCL</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Hardware Locality (hwloc)
 <span id="projectnumber">1.8</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Interoperability with OpenCL</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga94b79d9c339f463fa2891e941ab50a7f"><td class="memItemLeft" align="right" valign="top">static inline int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#ga94b79d9c339f463fa2891e941ab50a7f">hwloc_opencl_get_device_cpuset</a> (<a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology , cl_device_id device , <a class="el" href="a00074.html#ga4bbf39b68b6f568fb92739e7c0ea7801">hwloc_cpuset_t</a> set)</td></tr>
<tr class="separator:ga94b79d9c339f463fa2891e941ab50a7f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4a03b63357561e3238535c039d64a2f0"><td class="memItemLeft" align="right" valign="top">static inline <a class="el" href="a00076.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#ga4a03b63357561e3238535c039d64a2f0">hwloc_opencl_get_device_osdev_by_index</a> (<a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, unsigned platform_index, unsigned device_index)</td></tr>
<tr class="separator:ga4a03b63357561e3238535c039d64a2f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8405f20e119f3646a171395c337a712c"><td class="memItemLeft" align="right" valign="top">static inline <a class="el" href="a00076.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#ga8405f20e119f3646a171395c337a712c">hwloc_opencl_get_device_osdev</a> (<a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology , cl_device_id device )</td></tr>
<tr class="separator:ga8405f20e119f3646a171395c337a712c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>This interface offers ways to retrieve topology information about OpenCL devices.</p>
<p>Only the AMD OpenCL interface currently offers useful locality information about its devices. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga94b79d9c339f463fa2891e941ab50a7f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static inline int hwloc_opencl_get_device_cpuset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology </td>
<td class="paramname"><em></em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cl_device_id device </td>
<td class="paramname"><em></em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00074.html#ga4bbf39b68b6f568fb92739e7c0ea7801">hwloc_cpuset_t</a> </td>
<td class="paramname"><em>set</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the CPU set of logical processors that are physically close to OpenCL device <code>device</code>. </p>
<p>Return the CPU set describing the locality of the OpenCL device <code>device</code>.</p>
<p>Topology <code>topology</code> and device <code>device</code> must match the local machine. I/O devices detection and the OpenCL component are not needed in the topology.</p>
<p>The function only returns the locality of the device. If more information about the device is needed, OS objects should be used instead, see <a class="el" href="a00106.html#ga8405f20e119f3646a171395c337a712c" title="Get the hwloc OS device object corresponding to OpenCL device device. ">hwloc_opencl_get_device_osdev()</a> and <a class="el" href="a00106.html#ga4a03b63357561e3238535c039d64a2f0" title="Get the hwloc OS device object corresponding to the OpenCL device for the given indexes. ">hwloc_opencl_get_device_osdev_by_index()</a>.</p>
<p>This function is currently only implemented in a meaningful way for Linux with the AMD OpenCL implementation; other systems will simply get a full cpuset. </p>
</div>
</div>
<a class="anchor" id="ga8405f20e119f3646a171395c337a712c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static inline <a class="el" href="a00076.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_opencl_get_device_osdev </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology </td>
<td class="paramname"><em></em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cl_device_id device </td>
<td class="paramname"><em></em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the hwloc OS device object corresponding to OpenCL device <code>device</code>. </p>
<p>Return the hwloc OS device object that describes the given OpenCL device <code>device</code>. Return NULL if there is none.</p>
<p>Topology <code>topology</code> and device <code>device</code> must match the local machine. I/O devices detection and the OpenCL component must be enabled in the topology. If not, the locality of the object may still be found using <a class="el" href="a00106.html#ga94b79d9c339f463fa2891e941ab50a7f" title="Get the CPU set of logical processors that are physically close to OpenCL device device. ">hwloc_opencl_get_device_cpuset()</a>.</p>
<dl class="section note"><dt>Note</dt><dd>The corresponding hwloc PCI device may be found by looking at the result parent pointer. </dd></dl>
</div>
</div>
<a class="anchor" id="ga4a03b63357561e3238535c039d64a2f0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static inline <a class="el" href="a00076.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> hwloc_opencl_get_device_osdev_by_index </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> </td>
<td class="paramname"><em>topology</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>platform_index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>device_index</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the hwloc OS device object corresponding to the OpenCL device for the given indexes. </p>
<p>Return the OS device object describing the OpenCL device whose platform index is <code>platform_index</code>, and whose device index within this platform if <code>device_index</code>. Return NULL if there is none.</p>
<p>The topology <code>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 OpenCL component must be enabled in the topology.</p>
<dl class="section note"><dt>Note</dt><dd>The corresponding PCI device object can be obtained by looking at the OS device parent object. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2013 16:14:34 for Hardware Locality (hwloc) by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
|