Open MPI logo

Portable Hardware Locality (hwloc) Documentation: v2.7.0

  |   Home   |   Support   |   FAQ   |  
distances.h
1 /*
2  * Copyright © 2010-2021 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 
54  unsigned nbobjs;
60  unsigned long kind;
61  hwloc_uint64_t *values;
66 };
67 
88 
103 
110 };
111 
135 HWLOC_DECLSPEC int
137  unsigned *nr, struct hwloc_distances_s **distances,
138  unsigned long kind, unsigned long flags);
139 
144 HWLOC_DECLSPEC int
146  unsigned *nr, struct hwloc_distances_s **distances,
147  unsigned long kind, unsigned long flags);
148 
153 HWLOC_DECLSPEC int
155  unsigned *nr, struct hwloc_distances_s **distances,
156  unsigned long kind, unsigned long flags);
157 
165 HWLOC_DECLSPEC int
167  unsigned *nr, struct hwloc_distances_s **distances,
168  unsigned long flags);
169 
175 HWLOC_DECLSPEC const char *
177 
182 HWLOC_DECLSPEC void
184 
201 
215 
224 
231 };
232 
259 HWLOC_DECLSPEC int hwloc_distances_transform(hwloc_topology_t topology, struct hwloc_distances_s *distances,
260  enum hwloc_distances_transform_e transform,
261  void *transform_attr,
262  unsigned long flags);
263 
276 static __hwloc_inline int
278 {
279  unsigned i;
280  for(i=0; i<distances->nbobjs; i++)
281  if (distances->objs[i] == obj)
282  return (int)i;
283  return -1;
284 }
285 
293 static __hwloc_inline int
295  hwloc_obj_t obj1, hwloc_obj_t obj2,
296  hwloc_uint64_t *value1to2, hwloc_uint64_t *value2to1)
297 {
298  int i1 = hwloc_distances_obj_index(distances, obj1);
299  int i2 = hwloc_distances_obj_index(distances, obj2);
300  if (i1 < 0 || i2 < 0)
301  return -1;
302  *value1to2 = distances->values[i1 * distances->nbobjs + i2];
303  *value2to1 = distances->values[i2 * distances->nbobjs + i1];
304  return 0;
305 }
306 
331 
352 HWLOC_DECLSPEC hwloc_distances_add_handle_t
354  const char *name, unsigned long kind,
355  unsigned long flags);
356 
379 HWLOC_DECLSPEC int hwloc_distances_add_values(hwloc_topology_t topology,
381  unsigned nbobjs, hwloc_obj_t *objs,
382  hwloc_uint64_t *values,
383  unsigned long flags);
384 
398 };
399 
416 HWLOC_DECLSPEC int hwloc_distances_add_commit(hwloc_topology_t topology,
418  unsigned long flags);
419 
436 HWLOC_DECLSPEC int hwloc_distances_remove(hwloc_topology_t topology);
437 
442 HWLOC_DECLSPEC int hwloc_distances_remove_by_depth(hwloc_topology_t topology, int depth);
443 
448 static __hwloc_inline int
450 {
451  int depth = hwloc_get_type_depth(topology, type);
452  if (depth == HWLOC_TYPE_DEPTH_UNKNOWN || depth == HWLOC_TYPE_DEPTH_MULTIPLE)
453  return 0;
454  return hwloc_distances_remove_by_depth(topology, depth);
455 }
456 
461 HWLOC_DECLSPEC int hwloc_distances_release_remove(hwloc_topology_t topology, struct hwloc_distances_s *distances);
462 
466 #ifdef __cplusplus
467 } /* extern "C" */
468 #endif
469 
470 
471 #endif /* HWLOC_DISTANCES_H */
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:176
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:692
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
No object of given type exists in the topology.
Definition: hwloc.h:822
@ HWLOC_TYPE_DEPTH_MULTIPLE
Objects of given type exist at different depth in the topology (only for Groups).
Definition: hwloc.h:823
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
Transformations of distances structures.
Definition: distances.h:186
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_get(hwloc_topology_t topology, unsigned *nr, struct hwloc_distances_s **distances, unsigned long kind, unsigned long flags)
Retrieve distance matrices.
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.
const char * hwloc_distances_get_name(hwloc_topology_t topology, struct hwloc_distances_s *distances)
Get a description of what a distances structure contains.
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
Kinds of distance matrices.
Definition: distances.h:79
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
Apply a transitive closure to the matrix to connect objects across switches. This currently only appl...
Definition: distances.h:230
@ 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:223
@ HWLOC_DISTANCES_TRANSFORM_LINKS
Replace bandwidth values with a number of links.
Definition: distances.h:214
@ HWLOC_DISTANCES_TRANSFORM_REMOVE_NULL
Remove NULL objects from the distances structure.
Definition: distances.h:200
@ HWLOC_DISTANCES_KIND_FROM_USER
These distances were provided by the user.
Definition: distances.h:87
@ 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
These distances were obtained from the operating system or hardware.
Definition: distances.h:83
@ 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
Distance values are similar to latencies between objects. Values are smaller for closer objects,...
Definition: distances.h:95
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:294
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:277
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
Flags for adding a new distances to a topology.
Definition: distances.h:386
void * hwloc_distances_add_handle_t
Handle to a new distances structure during its addition to the topology.
Definition: distances.h:330
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.
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
If grouping, consider the distance values as inaccurate and relax the comparisons during the grouping...
Definition: distances.h:397
@ HWLOC_DISTANCES_ADD_FLAG_GROUP
Try to group objects based on the newly provided distance information. This is ignored for distances ...
Definition: distances.h:391
int hwloc_distances_release_remove(hwloc_topology_t topology, struct hwloc_distances_s *distances)
Release and remove the given distance matrice from the topology.
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:449
int hwloc_distances_remove_by_depth(hwloc_topology_t topology, int depth)
Remove distance matrices for objects at a specific depth in the topology.
int hwloc_distances_remove(hwloc_topology_t topology)
Remove all distance matrices from a topology.
Structure of a topology object.
Definition: hwloc.h:396
Matrix of distances between a set of objects.
Definition: distances.h:53
unsigned nbobjs
Number of objects described by the distance matrix.
Definition: distances.h:54
hwloc_uint64_t * values
Matrix of distances between objects, stored as a one-dimension array.
Definition: distances.h:61
unsigned long kind
OR'ed set of hwloc_distances_kind_e.
Definition: distances.h:60
hwloc_obj_t * objs
Array of objects described by the distance matrix. These objects are not in any particular order,...
Definition: distances.h:55