Hardware Locality (hwloc)  2.0.0
distances.h
1 /*
2  * Copyright © 2010-2017 Inria. All rights reserved.
3  * See COPYING in top-level directory.
4  */
5 
10 #ifndef HWLOC_DISTANCES_H
11 #define HWLOC_DISTANCES_H
12 
13 #ifndef HWLOC_H
14 #error Please include the main hwloc.h instead
15 #endif
16 
17 
18 #ifdef __cplusplus
19 extern "C" {
20 #elif 0
21 }
22 #endif
23 
24 
42  unsigned nbobjs;
48  unsigned long kind;
49  hwloc_uint64_t *values;
54 };
55 
76 
91 };
92 
115 HWLOC_DECLSPEC int
117  unsigned *nr, struct hwloc_distances_s **distances,
118  unsigned long kind, unsigned long flags);
119 
124 HWLOC_DECLSPEC int
126  unsigned *nr, struct hwloc_distances_s **distances,
127  unsigned long kind, unsigned long flags);
128 
133 static __hwloc_inline int
135  unsigned *nr, struct hwloc_distances_s **distances,
136  unsigned long kind, unsigned long flags)
137 {
138  int depth = hwloc_get_type_depth(topology, type);
139  if (depth == HWLOC_TYPE_DEPTH_UNKNOWN || depth == HWLOC_TYPE_DEPTH_MULTIPLE) {
140  *nr = 0;
141  return 0;
142  }
143  return hwloc_distances_get_by_depth(topology, depth, nr, distances, kind, flags);
144 }
145 
147 HWLOC_DECLSPEC void
148 hwloc_distances_release(hwloc_topology_t topology, struct hwloc_distances_s *distances);
149 
162 static __hwloc_inline int
164 {
165  unsigned i;
166  for(i=0; i<distances->nbobjs; i++)
167  if (distances->objs[i] == obj)
168  return (int)i;
169  return -1;
170 }
171 
179 static __hwloc_inline int
181  hwloc_obj_t obj1, hwloc_obj_t obj2,
182  hwloc_uint64_t *value1to2, hwloc_uint64_t *value2to1)
183 {
184  int i1 = hwloc_distances_obj_index(distances, obj1);
185  int i2 = hwloc_distances_obj_index(distances, obj2);
186  if (i1 < 0 || i2 < 0)
187  return -1;
188  *value1to2 = distances->values[i1 * distances->nbobjs + i2];
189  *value2to1 = distances->values[i2 * distances->nbobjs + i1];
190  return 0;
191 }
192 
213 };
214 
229 HWLOC_DECLSPEC int hwloc_distances_add(hwloc_topology_t topology,
230  unsigned nbobjs, hwloc_obj_t *objs, hwloc_uint64_t *values,
231  unsigned long kind, unsigned long flags);
232 
241 HWLOC_DECLSPEC int hwloc_distances_remove(hwloc_topology_t topology);
242 
247 HWLOC_DECLSPEC int hwloc_distances_remove_by_depth(hwloc_topology_t topology, int depth);
248 
253 static __hwloc_inline int
255 {
256  int depth = hwloc_get_type_depth(topology, type);
257  if (depth == HWLOC_TYPE_DEPTH_UNKNOWN || depth == HWLOC_TYPE_DEPTH_MULTIPLE)
258  return 0;
259  return hwloc_distances_remove_by_depth(topology, depth);
260 }
261 
265 #ifdef __cplusplus
266 } /* extern "C" */
267 #endif
268 
269 
270 #endif /* HWLOC_DISTANCES_H */
void hwloc_distances_release(hwloc_topology_t topology, struct hwloc_distances_s *distances)
Release a distance structure previously returned by hwloc_distances_get().
int hwloc_distances_get_by_depth(hwloc_topology_t topology, int depth, unsigned *nr, struct hwloc_distances_s **distances, unsigned long kind, unsigned long flags)
Retrieve distance matrices for object at a specific depth in the topology.
int hwloc_distances_remove_by_depth(hwloc_topology_t topology, int depth)
Remove distance matrices for objects at a specific depth in the topology.
static int hwloc_distances_get_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, unsigned *nr, struct hwloc_distances_s **distances, unsigned long kind, unsigned long flags)
Retrieve distance matrices for object of a specific type.
Definition: distances.h:134
Matrix of distances between a set of objects.
Definition: distances.h:41
Distance values are similar to bandwidths between objects. Values are higher for closer objects...
Definition: distances.h:90
Distance values are similar to latencies between objects. Values are smaller for closer objects...
Definition: distances.h:83
Structure of a topology object.
Definition: hwloc.h:347
static int hwloc_distances_remove_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Remove distance matrices for objects of a specific type in the topology.
Definition: distances.h:254
hwloc_obj_type_t
Definition: hwloc.h:172
If grouping, consider the distance values as inaccurate and relax the comparisons during the grouping...
Definition: distances.h:212
hwloc_distances_add_flag_e
Flags for adding a new distances to a topology.
Definition: distances.h:202
static int hwloc_distances_obj_pair_values(struct hwloc_distances_s *distances, hwloc_obj_t obj1, hwloc_obj_t obj2, hwloc_uint64_t *value1to2, hwloc_uint64_t *value2to1)
Find the values between two objects in a distances structure.
Definition: distances.h:180
int hwloc_distances_get(hwloc_topology_t topology, unsigned *nr, struct hwloc_distances_s **distances, unsigned long kind, unsigned long flags)
Retrieve distance matrices.
These distances were provided by the user.
Definition: distances.h:75
hwloc_uint64_t * values
Matrix of distances between objects, stored as a one-dimension array.
Definition: distances.h:49
int hwloc_distances_add(hwloc_topology_t topology, unsigned nbobjs, hwloc_obj_t *objs, hwloc_uint64_t *values, unsigned long kind, unsigned long flags)
Provide a distance matrix.
These distances were obtained from the operating system or hardware.
Definition: distances.h:71
int hwloc_distances_remove(hwloc_topology_t topology)
Remove all distance matrices from a topology.
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:626
hwloc_obj_t * objs
Array of objects described by the distance matrix. These objects are not in any particular order...
Definition: distances.h:43
Objects of given type exist at different depth in the topology (only for Groups). ...
Definition: hwloc.h:757
static int hwloc_distances_obj_index(struct hwloc_distances_s *distances, hwloc_obj_t obj)
Find the index of an object in a distances structure.
Definition: distances.h:163
No object of given type exists in the topology.
Definition: hwloc.h:756
Try to group objects based on the newly provided distance information.
Definition: distances.h:206
unsigned nbobjs
Number of objects described by the distance matrix.
Definition: distances.h:42
hwloc_distances_kind_e
Kinds of distance matrices.
Definition: distances.h:67
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
unsigned long kind
OR&#39;ed set of hwloc_distances_kind_e.
Definition: distances.h:48