| 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): Components and Plugins: distances</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"> 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="#typedef-members">Typedefs</a> | |
| 47 |
<a href="#func-members">Functions</a> </div> |
| 48 |
<div class="headertitle"><div class="title">Components and Plugins: distances </div></div> |
| 49 |
</div><!--header--> |
| 50 |
<div class="contents"> |
| 51 |
<table class="memberdecls"> |
| 52 |
<tr class="heading"><td colspan="2"><h2 id="header-typedef-members" class="groupheader"><a id="typedef-members" name="typedef-members"></a> |
| 53 |
Typedefs</h2></td></tr> |
| 54 |
<tr class="memitem:gafe5e49d32dd0a28ead94b6e31048e042" id="r_gafe5e49d32dd0a28ead94b6e31048e042"><td class="memItemLeft" align="right" valign="top">typedef void * </td><td class="memItemRight" valign="bottom"><a class="el" href="#gafe5e49d32dd0a28ead94b6e31048e042">hwloc_backend_distances_add_handle_t</a></td></tr> |
| 55 |
</table><table class="memberdecls"> |
| 56 |
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a> |
| 57 |
Functions</h2></td></tr> |
| 58 |
<tr class="memitem:gaa66a0bd519a5b1183a3e9b0c35a7f6cc" id="r_gaa66a0bd519a5b1183a3e9b0c35a7f6cc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#gafe5e49d32dd0a28ead94b6e31048e042">hwloc_backend_distances_add_handle_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa66a0bd519a5b1183a3e9b0c35a7f6cc">hwloc_backend_distances_add_create</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, const char *name, unsigned long kind, unsigned long flags)</td></tr> |
| 59 |
<tr class="memitem:gaa27036bd83102f8e406f1051d560da6c" id="r_gaa27036bd83102f8e406f1051d560da6c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa27036bd83102f8e406f1051d560da6c">hwloc_backend_distances_add_values</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="#gafe5e49d32dd0a28ead94b6e31048e042">hwloc_backend_distances_add_handle_t</a> handle, unsigned nbobjs, <a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> *objs, hwloc_uint64_t *values, unsigned long flags)</td></tr> |
| 60 |
<tr class="memitem:ga1468ac5f0bfb0e18bfc04c9ce5a5a4a3" id="r_ga1468ac5f0bfb0e18bfc04c9ce5a5a4a3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1468ac5f0bfb0e18bfc04c9ce5a5a4a3">hwloc_backend_distances_add_commit</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="#gafe5e49d32dd0a28ead94b6e31048e042">hwloc_backend_distances_add_handle_t</a> handle, unsigned long flags)</td></tr> |
| 61 |
</table> |
| 62 |
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2> |
| 63 |
<dl class="section note"><dt>Note</dt><dd>These structures and functions may change when <a class="el" href="a00165.html#gaac5bc1f46f55e10ef0141a68ce70e21f" title="Current component and plugin ABI version (see hwloc/plugins.h).">HWLOC_COMPONENT_ABI</a> is modified. </dd></dl> |
| 64 |
<a name="doc-typedef-members" id="doc-typedef-members"></a><h2 id="header-doc-typedef-members" class="groupheader">Typedef Documentation</h2> |
| 65 |
<a id="gafe5e49d32dd0a28ead94b6e31048e042" name="gafe5e49d32dd0a28ead94b6e31048e042"></a> |
| 66 |
<h2 class="memtitle"><span class="permalink"><a href="#gafe5e49d32dd0a28ead94b6e31048e042">◆ </a></span>hwloc_backend_distances_add_handle_t</h2> |
| 67 |
|
| 68 |
<div class="memitem"> |
| 69 |
<div class="memproto"> |
| 70 |
<table class="memname"> |
| 71 |
<tr> |
| 72 |
<td class="memname">typedef void* <a class="el" href="#gafe5e49d32dd0a28ead94b6e31048e042">hwloc_backend_distances_add_handle_t</a></td> |
| 73 |
</tr> |
| 74 |
</table> |
| 75 |
</div><div class="memdoc"> |
| 76 |
|
| 77 |
<p>Handle to a new distances structure during its addition to the topology. </p> |
| 78 |
|
| 79 |
</div> |
| 80 |
</div> |
| 81 |
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2> |
| 82 |
<a id="ga1468ac5f0bfb0e18bfc04c9ce5a5a4a3" name="ga1468ac5f0bfb0e18bfc04c9ce5a5a4a3"></a> |
| 83 |
<h2 class="memtitle"><span class="permalink"><a href="#ga1468ac5f0bfb0e18bfc04c9ce5a5a4a3">◆ </a></span>hwloc_backend_distances_add_commit()</h2> |
| 84 |
|
| 85 |
<div class="memitem"> |
| 86 |
<div class="memproto"> |
| 87 |
<table class="memname"> |
| 88 |
<tr> |
| 89 |
<td class="memname">int hwloc_backend_distances_add_commit </td> |
| 90 |
<td>(</td> |
| 91 |
<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> |
| 92 |
</tr> |
| 93 |
<tr> |
| 94 |
<td class="paramkey"></td> |
| 95 |
<td></td> |
| 96 |
<td class="paramtype"><a class="el" href="#gafe5e49d32dd0a28ead94b6e31048e042">hwloc_backend_distances_add_handle_t</a></td> <td class="paramname"><span class="paramname"><em>handle</em></span>, </td> |
| 97 |
</tr> |
| 98 |
<tr> |
| 99 |
<td class="paramkey"></td> |
| 100 |
<td></td> |
| 101 |
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>flags</em></span> )</td> |
| 102 |
</tr> |
| 103 |
</table> |
| 104 |
</div><div class="memdoc"> |
| 105 |
|
| 106 |
<p>Commit a new distances structure. </p> |
| 107 |
<p>This is similar to <a class="el" href="a00193.html#ga1f5a29760ebb8f9af831e645315f553c" title="Commit a new distances structure.">hwloc_distances_add_commit()</a> but this variant is designed for backend inserting distances during topology discovery. </p> |
| 108 |
|
| 109 |
</div> |
| 110 |
</div> |
| 111 |
<a id="gaa66a0bd519a5b1183a3e9b0c35a7f6cc" name="gaa66a0bd519a5b1183a3e9b0c35a7f6cc"></a> |
| 112 |
<h2 class="memtitle"><span class="permalink"><a href="#gaa66a0bd519a5b1183a3e9b0c35a7f6cc">◆ </a></span>hwloc_backend_distances_add_create()</h2> |
| 113 |
|
| 114 |
<div class="memitem"> |
| 115 |
<div class="memproto"> |
| 116 |
<table class="memname"> |
| 117 |
<tr> |
| 118 |
<td class="memname"><a class="el" href="#gafe5e49d32dd0a28ead94b6e31048e042">hwloc_backend_distances_add_handle_t</a> hwloc_backend_distances_add_create </td> |
| 119 |
<td>(</td> |
| 120 |
<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> |
| 121 |
</tr> |
| 122 |
<tr> |
| 123 |
<td class="paramkey"></td> |
| 124 |
<td></td> |
| 125 |
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td> |
| 126 |
</tr> |
| 127 |
<tr> |
| 128 |
<td class="paramkey"></td> |
| 129 |
<td></td> |
| 130 |
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>kind</em></span>, </td> |
| 131 |
</tr> |
| 132 |
<tr> |
| 133 |
<td class="paramkey"></td> |
| 134 |
<td></td> |
| 135 |
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>flags</em></span> )</td> |
| 136 |
</tr> |
| 137 |
</table> |
| 138 |
</div><div class="memdoc"> |
| 139 |
|
| 140 |
<p>Create a new empty distances structure. </p> |
| 141 |
<p>This is identical to <a class="el" href="a00193.html#ga823d38fa8d21dc338497fb0f79c96704" title="Create a new empty distances structure.">hwloc_distances_add_create()</a> but this variant is designed for backend inserting distances during topology discovery. </p> |
| 142 |
|
| 143 |
</div> |
| 144 |
</div> |
| 145 |
<a id="gaa27036bd83102f8e406f1051d560da6c" name="gaa27036bd83102f8e406f1051d560da6c"></a> |
| 146 |
<h2 class="memtitle"><span class="permalink"><a href="#gaa27036bd83102f8e406f1051d560da6c">◆ </a></span>hwloc_backend_distances_add_values()</h2> |
| 147 |
|
| 148 |
<div class="memitem"> |
| 149 |
<div class="memproto"> |
| 150 |
<table class="memname"> |
| 151 |
<tr> |
| 152 |
<td class="memname">int hwloc_backend_distances_add_values </td> |
| 153 |
<td>(</td> |
| 154 |
<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> |
| 155 |
</tr> |
| 156 |
<tr> |
| 157 |
<td class="paramkey"></td> |
| 158 |
<td></td> |
| 159 |
<td class="paramtype"><a class="el" href="#gafe5e49d32dd0a28ead94b6e31048e042">hwloc_backend_distances_add_handle_t</a></td> <td class="paramname"><span class="paramname"><em>handle</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>nbobjs</em></span>, </td> |
| 165 |
</tr> |
| 166 |
<tr> |
| 167 |
<td class="paramkey"></td> |
| 168 |
<td></td> |
| 169 |
<td class="paramtype"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> *</td> <td class="paramname"><span class="paramname"><em>objs</em></span>, </td> |
| 170 |
</tr> |
| 171 |
<tr> |
| 172 |
<td class="paramkey"></td> |
| 173 |
<td></td> |
| 174 |
<td class="paramtype">hwloc_uint64_t *</td> <td class="paramname"><span class="paramname"><em>values</em></span>, </td> |
| 175 |
</tr> |
| 176 |
<tr> |
| 177 |
<td class="paramkey"></td> |
| 178 |
<td></td> |
| 179 |
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>flags</em></span> )</td> |
| 180 |
</tr> |
| 181 |
</table> |
| 182 |
</div><div class="memdoc"> |
| 183 |
|
| 184 |
<p>Specify the objects and values in a new empty distances structure. </p> |
| 185 |
<p>This is similar to <a class="el" href="a00193.html#ga8c9715481b0bce344c8a33c6e6a56469" title="Specify the objects and values in a new empty distances structure.">hwloc_distances_add_values()</a> but this variant is designed for backend inserting distances during topology discovery.</p> |
| 186 |
<p>The only semantical difference is that <code class="param">objs</code> and <code class="param">values</code> are not duplicated, but directly attached to the topology. On success, these arrays are given to the core and should not ever be freed by the caller anymore. </p> |
| 187 |
|
| 188 |
</div> |
| 189 |
</div> |
| 190 |
</div><!-- contents --> |
| 191 |
<!-- start footer part --> |
| 192 |
<hr class="footer"/><address class="footer"><small> |
| 193 |
Generated by <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> |