/usr/share/doc/libhwloc-doc/html/a00099.html is in libhwloc-doc 1.10.0-3.
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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 | <!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.8"/>
<title>Hardware Locality (hwloc): Components and Plugins: Discovery backends</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.10.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<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="#nested-classes">Data Structures</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Components and Plugins: Discovery backends</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html">hwloc_backend</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga21513209613570877b6bfa9898106f2a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00099.html#ga21513209613570877b6bfa9898106f2a">hwloc_backend_flag_e</a> { <a class="el" href="a00099.html#gga21513209613570877b6bfa9898106f2aadc96f2cf3bdd5d41e102dfa1e1976b24">HWLOC_BACKEND_FLAG_NEED_LEVELS</a>
}</td></tr>
<tr class="separator:ga21513209613570877b6bfa9898106f2a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga330a0b581de4817d0cf1e7401db22436"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="a00029.html">hwloc_backend</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00099.html#ga330a0b581de4817d0cf1e7401db22436">hwloc_backend_alloc</a> (struct <a class="el" href="a00033.html">hwloc_disc_component</a> *component)</td></tr>
<tr class="separator:ga330a0b581de4817d0cf1e7401db22436"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa4edf46c5d88eef53b3b8f572d88b9c5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00099.html#gaa4edf46c5d88eef53b3b8f572d88b9c5">hwloc_backend_enable</a> (struct hwloc_topology *topology, struct <a class="el" href="a00029.html">hwloc_backend</a> *backend)</td></tr>
<tr class="separator:gaa4edf46c5d88eef53b3b8f572d88b9c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga505a5470745bf0b601f4d25a69601411"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00099.html#ga505a5470745bf0b601f4d25a69601411">hwloc_backends_get_obj_cpuset</a> (struct <a class="el" href="a00029.html">hwloc_backend</a> *caller, struct <a class="el" href="a00036.html">hwloc_obj</a> *obj, <a class="el" href="a00096.html#gaa3c2bf4c776d603dcebbb61b0c923d84">hwloc_bitmap_t</a> cpuset)</td></tr>
<tr class="separator:ga505a5470745bf0b601f4d25a69601411"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad8ac8bba9ab6b9af423baba0c8337c6b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00099.html#gad8ac8bba9ab6b9af423baba0c8337c6b">hwloc_backends_notify_new_object</a> (struct <a class="el" href="a00029.html">hwloc_backend</a> *caller, struct <a class="el" href="a00036.html">hwloc_obj</a> *obj)</td></tr>
<tr class="separator:gad8ac8bba9ab6b9af423baba0c8337c6b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga21513209613570877b6bfa9898106f2a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00099.html#ga21513209613570877b6bfa9898106f2a">hwloc_backend_flag_e</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Backend flags. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga21513209613570877b6bfa9898106f2aadc96f2cf3bdd5d41e102dfa1e1976b24"></a>HWLOC_BACKEND_FLAG_NEED_LEVELS </td><td class="fielddoc">
<p>Levels should be reconnected before this backend discover() is used. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga330a0b581de4817d0cf1e7401db22436"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="a00029.html">hwloc_backend</a>* hwloc_backend_alloc </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="a00033.html">hwloc_disc_component</a> * </td>
<td class="paramname"><em>component</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate a backend structure, set good default values, initialize backend->component and topology, etc. The caller will then modify whatever needed, and call <a class="el" href="a00099.html#gaa4edf46c5d88eef53b3b8f572d88b9c5" title="Enable a previously allocated and setup backend. ">hwloc_backend_enable()</a>. </p>
</div>
</div>
<a class="anchor" id="gaa4edf46c5d88eef53b3b8f572d88b9c5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int hwloc_backend_enable </td>
<td>(</td>
<td class="paramtype">struct hwloc_topology * </td>
<td class="paramname"><em>topology</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="a00029.html">hwloc_backend</a> * </td>
<td class="paramname"><em>backend</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable a previously allocated and setup backend. </p>
</div>
</div>
<a class="anchor" id="ga505a5470745bf0b601f4d25a69601411"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int hwloc_backends_get_obj_cpuset </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="a00029.html">hwloc_backend</a> * </td>
<td class="paramname"><em>caller</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="a00036.html">hwloc_obj</a> * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00096.html#gaa3c2bf4c776d603dcebbb61b0c923d84">hwloc_bitmap_t</a> </td>
<td class="paramname"><em>cpuset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Used by backends discovery callbacks to request locality information from others. </p>
<p>Traverse the list of enabled backends until one has a get_obj_cpuset() method, and call it. </p>
</div>
</div>
<a class="anchor" id="gad8ac8bba9ab6b9af423baba0c8337c6b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int hwloc_backends_notify_new_object </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="a00029.html">hwloc_backend</a> * </td>
<td class="paramname"><em>caller</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="a00036.html">hwloc_obj</a> * </td>
<td class="paramname"><em>obj</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Used by backends discovery callbacks to notify other backends of new objects. </p>
<p>Traverse the list of enabled backends (all but caller) and invoke their notify_new_object() method to notify them that a new object just got added to the topology.</p>
<p>Currently only used for notifying of new PCI device objects. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Nov 2 2014 15:34:33 for Hardware Locality (hwloc) by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
|