Debian Codegraph @

doc/doxygen-doc/html/a00296.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): hwloc_distances_s Struct Reference</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="#pub-attribs">Data Fields</a> </div>
47 <div class="headertitle"><div class="title">hwloc_distances_s Struct Reference<div class="ingroups"><a class="el" href="a00191.html">Retrieve distances between objects</a></div></div></div>
48 </div><!--header-->
49 <div class="contents">
50
51 <p><code>#include &lt;<a class="el" href="a00107_source.html">distances.h</a>&gt;</code></p>
52 <table class="memberdecls">
53 <tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
54 Data Fields</h2></td></tr>
55 <tr class="memitem:a4ca2af858cebbce7324ec49903d09474" id="r_a4ca2af858cebbce7324ec49903d09474"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4ca2af858cebbce7324ec49903d09474">nbobjs</a></td></tr>
56 <tr class="memitem:af1e78b2d628d191fa6cae3fbfe891078" id="r_af1e78b2d628d191fa6cae3fbfe891078"><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="#af1e78b2d628d191fa6cae3fbfe891078">objs</a></td></tr>
57 <tr class="memitem:aef9c83cf467da1b1fa4c36493febb3b5" id="r_aef9c83cf467da1b1fa4c36493febb3b5"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aef9c83cf467da1b1fa4c36493febb3b5">kind</a></td></tr>
58 <tr class="memitem:ae43e19b2c743de05c93d71a30beaca75" id="r_ae43e19b2c743de05c93d71a30beaca75"><td class="memItemLeft" align="right" valign="top">hwloc_uint64_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae43e19b2c743de05c93d71a30beaca75">values</a></td></tr>
59 </table>
60 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
61 <div class="textblock"><p>Matrix of distances between a set of objects. </p>
62 <p>The most common matrix contains latencies between NUMA nodes (as reported in the System Locality Distance Information Table (SLIT) in the ACPI specification), which may or may not be physically accurate. It corresponds to the latency for accessing the memory of one node from a core in another node. The corresponding kind is <a class="el" href="a00191.html#ggab1bb10d3adb85b52cdc6fe5a7f74f108afd6a3503fbc8f7c1a31235373cefc4c6" title="Distance values are similar to latencies between objects. Values are smaller for closer objects,...">HWLOC_DISTANCES_KIND_MEANS_LATENCY</a> | <a class="el" href="a00191.html#ggab1bb10d3adb85b52cdc6fe5a7f74f108a0148d7f9be833a04f5a55455437c227b" title="These distances were provided by the user.">HWLOC_DISTANCES_KIND_FROM_USER</a>. The name of this distances structure is "NUMALatency".</p>
63 <p>The matrix may also contain bandwidths between random sets of objects, possibly provided by the user, as specified in the <code class="param">kind</code> attribute. Others common distance structures include and "XGMIBandwidth", "XGMIHops", "XeLinkBandwidth" and "NVLinkBandwidth".</p>
64 <p>Pointers <code class="param">objs</code> and <code class="param">values</code> should not be replaced, reallocated, freed, etc. However callers are allowed to modify <code class="param">kind</code> as well as the contents of <code class="param">objs</code> and <code class="param">values</code> arrays. For instance, if there is a single NUMA node per Package, <a class="el" href="a00183.html#gab5df3ad1e8565ea0c2cf06412f6f6233" title="Return an object of a different type with same locality.">hwloc_get_obj_with_same_locality()</a> may be used to convert between them and replace NUMA nodes in the <code class="param">objs</code> array with the corresponding Packages. See also <a class="el" href="a00191.html#gabcadd041f3072999d68f2d94e38670f7" title="Apply a transformation to a distances structure.">hwloc_distances_transform()</a> for applying some transformations to the structure. </p>
65 </div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
66 <a id="aef9c83cf467da1b1fa4c36493febb3b5" name="aef9c83cf467da1b1fa4c36493febb3b5"></a>
67 <h2 class="memtitle"><span class="permalink"><a href="#aef9c83cf467da1b1fa4c36493febb3b5">&#9670;&#160;</a></span>kind</h2>
68
69 <div class="memitem">
70 <div class="memproto">
71 <table class="memname">
72 <tr>
73 <td class="memname">unsigned long hwloc_distances_s::kind</td>
74 </tr>
75 </table>
76 </div><div class="memdoc">
77
78 <p>OR'ed set of <a class="el" href="a00191.html#gab1bb10d3adb85b52cdc6fe5a7f74f108" title="Kinds of distance matrices.">hwloc_distances_kind_e</a>. </p>
79
80 </div>
81 </div>
82 <a id="a4ca2af858cebbce7324ec49903d09474" name="a4ca2af858cebbce7324ec49903d09474"></a>
83 <h2 class="memtitle"><span class="permalink"><a href="#a4ca2af858cebbce7324ec49903d09474">&#9670;&#160;</a></span>nbobjs</h2>
84
85 <div class="memitem">
86 <div class="memproto">
87 <table class="memname">
88 <tr>
89 <td class="memname">unsigned hwloc_distances_s::nbobjs</td>
90 </tr>
91 </table>
92 </div><div class="memdoc">
93
94 <p>Number of objects described by the distance matrix. </p>
95
96 </div>
97 </div>
98 <a id="af1e78b2d628d191fa6cae3fbfe891078" name="af1e78b2d628d191fa6cae3fbfe891078"></a>
99 <h2 class="memtitle"><span class="permalink"><a href="#af1e78b2d628d191fa6cae3fbfe891078">&#9670;&#160;</a></span>objs</h2>
100
101 <div class="memitem">
102 <div class="memproto">
103 <table class="memname">
104 <tr>
105 <td class="memname"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a>* hwloc_distances_s::objs</td>
106 </tr>
107 </table>
108 </div><div class="memdoc">
109
110 <p>Array of objects described by the distance matrix. These objects are not in any particular order, see <a class="el" href="a00192.html#gaef9d6bb018286de69f8ac023129805aa" title="Find the index of an object in a distances structure.">hwloc_distances_obj_index()</a> and <a class="el" href="a00192.html#ga29b891f8737ce5b35495240d977ac2c2" title="Find the values between two objects in a distance matrices.">hwloc_distances_obj_pair_values()</a> for easy ways to find objects in this array and their corresponding values. </p>
111
112 </div>
113 </div>
114 <a id="ae43e19b2c743de05c93d71a30beaca75" name="ae43e19b2c743de05c93d71a30beaca75"></a>
115 <h2 class="memtitle"><span class="permalink"><a href="#ae43e19b2c743de05c93d71a30beaca75">&#9670;&#160;</a></span>values</h2>
116
117 <div class="memitem">
118 <div class="memproto">
119 <table class="memname">
120 <tr>
121 <td class="memname">hwloc_uint64_t* hwloc_distances_s::values</td>
122 </tr>
123 </table>
124 </div><div class="memdoc">
125
126 <p>Matrix of distances between objects, stored as a one-dimension array. </p>
127 <p>Distance from i-th to j-th object is stored in slot i*nbobjs+j. The meaning of the value depends on the <code class="param">kind</code> attribute. </p>
128
129 </div>
130 </div>
131 <hr/>The documentation for this struct was generated from the following file:<ul>
132 <li><a class="el" href="a00107_source.html">distances.h</a></li>
133 </ul>
134 </div><!-- contents -->
135 <!-- start footer part -->
136 <hr class="footer"/><address class="footer"><small>
137 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
138 </small></address>
139 </div><!-- doc-content -->
140 </body>
141 </html>