Hardware Locality (hwloc): distances.h Source File

Hardware Locality (hwloc) 2.9.1

distances.h
1 /*
2 * Copyright © 2010-2022 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
53 struct hwloc_distances_s {
54 unsigned nbobjs;
55 hwloc_obj_t *objs;
60 unsigned long kind;
61 hwloc_uint64_t *values;
66 };
67
79 enum hwloc_distances_kind_e {
83 HWLOC_DISTANCES_KIND_FROM_OS = (1UL<<0),
87 HWLOC_DISTANCES_KIND_FROM_USER = (1UL<<1),
88
95 HWLOC_DISTANCES_KIND_MEANS_LATENCY = (1UL<<2),
102 HWLOC_DISTANCES_KIND_MEANS_BANDWIDTH = (1UL<<3),
103
109 HWLOC_DISTANCES_KIND_HETEROGENEOUS_TYPES = (1UL<<4)
110 };
111
135 HWLOC_DECLSPEC int
136 hwloc_distances_get(hwloc_topology_t topology,
137 unsigned *nr, struct hwloc_distances_s **distances,
138 unsigned long kind, unsigned long flags);
139
144 HWLOC_DECLSPEC int
145 hwloc_distances_get_by_depth(hwloc_topology_t topology, int depth,
146 unsigned *nr, struct hwloc_distances_s **distances,
147 unsigned long kind, unsigned long flags);
148
153 HWLOC_DECLSPEC int
154 hwloc_distances_get_by_type(hwloc_topology_t topology, hwloc_obj_type_t type,
155 unsigned *nr, struct hwloc_distances_s **distances,
156 unsigned long kind, unsigned long flags);
157
166 HWLOC_DECLSPEC int
167 hwloc_distances_get_by_name(hwloc_topology_t topology, const char *name,
168 unsigned *nr, struct hwloc_distances_s **distances,
169 unsigned long flags);
170
176 HWLOC_DECLSPEC const char *
177 hwloc_distances_get_name(hwloc_topology_t topology, struct hwloc_distances_s *distances);
178
183 HWLOC_DECLSPEC void
184 hwloc_distances_release(hwloc_topology_t topology, struct hwloc_distances_s *distances);
185
187 enum hwloc_distances_transform_e {
201 HWLOC_DISTANCES_TRANSFORM_REMOVE_NULL = 0,
202
215 HWLOC_DISTANCES_TRANSFORM_LINKS = 1,
216
224 HWLOC_DISTANCES_TRANSFORM_MERGE_SWITCH_PORTS = 2,
225
231 HWLOC_DISTANCES_TRANSFORM_TRANSITIVE_CLOSURE = 3
232 };
233
260 HWLOC_DECLSPEC int hwloc_distances_transform(hwloc_topology_t topology, struct hwloc_distances_s *distances,
261 enum hwloc_distances_transform_e transform,
262 void *transform_attr,
263 unsigned long flags);
264
277 static __hwloc_inline int
278 hwloc_distances_obj_index(struct hwloc_distances_s *distances, hwloc_obj_t obj)
279 {
280 unsigned i;
281 for(i=0; i<distances->nbobjs; i++)
282 if (distances->objs[i] == obj)
283 return (int)i;
284 return -1;
285 }
286
294 static __hwloc_inline int
295 hwloc_distances_obj_pair_values(struct hwloc_distances_s *distances,
296 hwloc_obj_t obj1, hwloc_obj_t obj2,
297 hwloc_uint64_t *value1to2, hwloc_uint64_t *value2to1)
298 {
299 int i1 = hwloc_distances_obj_index(distances, obj1);
300 int i2 = hwloc_distances_obj_index(distances, obj2);
301 if (i1 < 0 || i2 < 0)
302 return -1;
303 *value1to2 = distances->values[i1 * distances->nbobjs + i2];
304 *value2to1 = distances->values[i2 * distances->nbobjs + i1];
305 return 0;
306 }
307
331 typedef void * hwloc_distances_add_handle_t;
332
353 HWLOC_DECLSPEC hwloc_distances_add_handle_t
354 hwloc_distances_add_create(hwloc_topology_t topology,
355 const char *name, unsigned long kind,
356 unsigned long flags);
357
380 HWLOC_DECLSPEC int hwloc_distances_add_values(hwloc_topology_t topology,
381 hwloc_distances_add_handle_t handle,
382 unsigned nbobjs, hwloc_obj_t *objs,
383 hwloc_uint64_t *values,
384 unsigned long flags);
385
387 enum hwloc_distances_add_flag_e {
392 HWLOC_DISTANCES_ADD_FLAG_GROUP = (1UL<<0),
398 HWLOC_DISTANCES_ADD_FLAG_GROUP_INACCURATE = (1UL<<1)
399 };
400
417 HWLOC_DECLSPEC int hwloc_distances_add_commit(hwloc_topology_t topology,
418 hwloc_distances_add_handle_t handle,
419 unsigned long flags);
420
437 HWLOC_DECLSPEC int hwloc_distances_remove(hwloc_topology_t topology);
438
443 HWLOC_DECLSPEC int hwloc_distances_remove_by_depth(hwloc_topology_t topology, int depth);
444
449 static __hwloc_inline int
450 hwloc_distances_remove_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
451 {
452 int depth = hwloc_get_type_depth(topology, type);
453 if (depth == HWLOC_TYPE_DEPTH_UNKNOWN || depth == HWLOC_TYPE_DEPTH_MULTIPLE)
454 return 0;
455 return hwloc_distances_remove_by_depth(topology, depth);
456 }
457
462 HWLOC_DECLSPEC int hwloc_distances_release_remove(hwloc_topology_t topology, struct hwloc_distances_s *distances);
463
467 #ifdef __cplusplus
468 } /* extern "C" */
469 #endif
470
471
472 #endif /* HWLOC_DISTANCES_H */
hwloc_obj_type_t
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:176
hwloc_topology_t
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:692
hwloc_get_type_depth
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
HWLOC_TYPE_DEPTH_UNKNOWN
@ HWLOC_TYPE_DEPTH_UNKNOWN
No object of given type exists in the topology.
Definition: hwloc.h:822
HWLOC_TYPE_DEPTH_MULTIPLE
@ HWLOC_TYPE_DEPTH_MULTIPLE
Objects of given type exist at different depth in the topology (only for Groups).
Definition: hwloc.h:823
hwloc_distances_release
void hwloc_distances_release(hwloc_topology_t topology, struct hwloc_distances_s *distances)
Release a distance matrix structure previously returned by hwloc_distances_get().
hwloc_distances_transform_e
hwloc_distances_transform_e
Transformations of distances structures.
Definition: distances.h:187
hwloc_distances_get_by_depth
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.
hwloc_distances_get
int hwloc_distances_get(hwloc_topology_t topology, unsigned *nr, struct hwloc_distances_s **distances, unsigned long kind, unsigned long flags)
Retrieve distance matrices.
hwloc_distances_get_by_name
int hwloc_distances_get_by_name(hwloc_topology_t topology, const char *name, unsigned *nr, struct hwloc_distances_s **distances, unsigned long flags)
Retrieve a distance matrix with the given name.
hwloc_distances_get_name
const char * hwloc_distances_get_name(hwloc_topology_t topology, struct hwloc_distances_s *distances)
Get a description of what a distances structure contains.
hwloc_distances_get_by_type
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.
hwloc_distances_kind_e
hwloc_distances_kind_e
Kinds of distance matrices.
Definition: distances.h:79
hwloc_distances_transform
int hwloc_distances_transform(hwloc_topology_t topology, struct hwloc_distances_s *distances, enum hwloc_distances_transform_e transform, void *transform_attr, unsigned long flags)
Apply a transformation to a distances structure.
HWLOC_DISTANCES_TRANSFORM_TRANSITIVE_CLOSURE
@ HWLOC_DISTANCES_TRANSFORM_TRANSITIVE_CLOSURE
Apply a transitive closure to the matrix to connect objects across switches. This currently only appl...
Definition: distances.h:231
HWLOC_DISTANCES_TRANSFORM_MERGE_SWITCH_PORTS
@ HWLOC_DISTANCES_TRANSFORM_MERGE_SWITCH_PORTS
Merge switches with multiple ports into a single object. This currently only applies to NVSwitches wh...
Definition: distances.h:224
HWLOC_DISTANCES_TRANSFORM_LINKS
@ HWLOC_DISTANCES_TRANSFORM_LINKS
Replace bandwidth values with a number of links.
Definition: distances.h:215
HWLOC_DISTANCES_TRANSFORM_REMOVE_NULL
@ HWLOC_DISTANCES_TRANSFORM_REMOVE_NULL
Remove NULL objects from the distances structure.
Definition: distances.h:201
HWLOC_DISTANCES_KIND_FROM_USER
@ HWLOC_DISTANCES_KIND_FROM_USER
These distances were provided by the user.
Definition: distances.h:87
HWLOC_DISTANCES_KIND_MEANS_BANDWIDTH
@ HWLOC_DISTANCES_KIND_MEANS_BANDWIDTH
Distance values are similar to bandwidths between objects. Values are higher for closer objects,...
Definition: distances.h:102
HWLOC_DISTANCES_KIND_FROM_OS
@ HWLOC_DISTANCES_KIND_FROM_OS
These distances were obtained from the operating system or hardware.
Definition: distances.h:83
HWLOC_DISTANCES_KIND_HETEROGENEOUS_TYPES
@ HWLOC_DISTANCES_KIND_HETEROGENEOUS_TYPES
This distances structure covers objects of different types. This may apply to the "NVLinkBandwidth" s...
Definition: distances.h:109
HWLOC_DISTANCES_KIND_MEANS_LATENCY
@ HWLOC_DISTANCES_KIND_MEANS_LATENCY
Distance values are similar to latencies between objects. Values are smaller for closer objects,...
Definition: distances.h:95
hwloc_distances_obj_pair_values
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 distance matrices.
Definition: distances.h:295
hwloc_distances_obj_index
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:278
hwloc_distances_add_commit
int hwloc_distances_add_commit(hwloc_topology_t topology, hwloc_distances_add_handle_t handle, unsigned long flags)
Commit a new distances structure.
hwloc_distances_add_flag_e
hwloc_distances_add_flag_e
Flags for adding a new distances to a topology.
Definition: distances.h:387
hwloc_distances_add_handle_t
void * hwloc_distances_add_handle_t
Handle to a new distances structure during its addition to the topology.
Definition: distances.h:331
hwloc_distances_add_create
hwloc_distances_add_handle_t hwloc_distances_add_create(hwloc_topology_t topology, const char *name, unsigned long kind, unsigned long flags)
Create a new empty distances structure.
hwloc_distances_add_values
int hwloc_distances_add_values(hwloc_topology_t topology, hwloc_distances_add_handle_t handle, unsigned nbobjs, hwloc_obj_t *objs, hwloc_uint64_t *values, unsigned long flags)
Specify the objects and values in a new empty distances structure.
HWLOC_DISTANCES_ADD_FLAG_GROUP_INACCURATE
@ HWLOC_DISTANCES_ADD_FLAG_GROUP_INACCURATE
If grouping, consider the distance values as inaccurate and relax the comparisons during the grouping...
Definition: distances.h:398
HWLOC_DISTANCES_ADD_FLAG_GROUP
@ HWLOC_DISTANCES_ADD_FLAG_GROUP
Try to group objects based on the newly provided distance information. This is ignored for distances ...
Definition: distances.h:392
hwloc_distances_release_remove
int hwloc_distances_release_remove(hwloc_topology_t topology, struct hwloc_distances_s *distances)
Release and remove the given distance matrice from the topology.
hwloc_distances_remove_by_type
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:450
hwloc_distances_remove_by_depth
int hwloc_distances_remove_by_depth(hwloc_topology_t topology, int depth)
Remove distance matrices for objects at a specific depth in the topology.
hwloc_distances_remove
int hwloc_distances_remove(hwloc_topology_t topology)
Remove all distance matrices from a topology.
hwloc_obj
Structure of a topology object.
Definition: hwloc.h:396
hwloc_distances_s
Matrix of distances between a set of objects.
Definition: distances.h:53
hwloc_distances_s::nbobjs
unsigned nbobjs
Number of objects described by the distance matrix.
Definition: distances.h:54
hwloc_distances_s::values
hwloc_uint64_t * values
Matrix of distances between objects, stored as a one-dimension array.
Definition: distances.h:61
hwloc_distances_s::kind
unsigned long kind
OR'ed set of hwloc_distances_kind_e.
Definition: distances.h:60
hwloc_distances_s::objs
hwloc_obj_t * objs
Array of objects described by the distance matrix. These objects are not in any particular order,...
Definition: distances.h:55