Open MPI logo

Portable Hardware Locality (hwloc) Documentation: v2.10.0

  |   Home   |   Support   |   FAQ   |  
memattrs.h
1/*
2 * Copyright © 2019-2023 Inria. All rights reserved.
3 * See COPYING in top-level directory.
4 */
5
10#ifndef HWLOC_MEMATTR_H
11#define HWLOC_MEMATTR_H
12
13#include "hwloc.h"
14
15#ifdef __cplusplus
16extern "C" {
17#elif 0
18}
19#endif
20
84
99
114
125
136
151
162
173
174 /* TODO persistence? */
175
176 HWLOC_MEMATTR_ID_MAX
177};
178
182typedef unsigned hwloc_memattr_id_t;
183
189HWLOC_DECLSPEC int
191 const char *name,
193
194
202
214};
215
216
225
232
239
271HWLOC_DECLSPEC int
273 struct hwloc_location *location,
274 unsigned *nr,
275 hwloc_obj_t *nodes,
276 unsigned long flags);
277
278
279
298HWLOC_DECLSPEC int
300 hwloc_memattr_id_t attribute,
301 hwloc_obj_t target_node,
302 struct hwloc_location *initiator,
303 unsigned long flags,
304 hwloc_uint64_t *value);
305
334HWLOC_DECLSPEC int
336 hwloc_memattr_id_t attribute,
337 struct hwloc_location *initiator,
338 unsigned long flags,
339 hwloc_obj_t *best_target, hwloc_uint64_t *value);
340
362HWLOC_DECLSPEC int
364 hwloc_memattr_id_t attribute,
365 hwloc_obj_t target,
366 unsigned long flags,
367 struct hwloc_location *best_initiator, hwloc_uint64_t *value);
368
381HWLOC_DECLSPEC int
383 hwloc_memattr_id_t attribute,
384 const char **name);
385
393HWLOC_DECLSPEC int
395 hwloc_memattr_id_t attribute,
396 unsigned long *flags);
397
415
425HWLOC_DECLSPEC int
427 const char *name,
428 unsigned long flags,
430
451HWLOC_DECLSPEC int
453 hwloc_memattr_id_t attribute,
454 hwloc_obj_t target_node,
455 struct hwloc_location *initiator,
456 unsigned long flags,
457 hwloc_uint64_t value);
458
497HWLOC_DECLSPEC int
499 hwloc_memattr_id_t attribute,
500 struct hwloc_location *initiator,
501 unsigned long flags,
502 unsigned *nr, hwloc_obj_t *targets, hwloc_uint64_t *values);
503
535HWLOC_DECLSPEC int
537 hwloc_memattr_id_t attribute,
538 hwloc_obj_t target_node,
539 unsigned long flags,
540 unsigned *nr, struct hwloc_location *initiators, hwloc_uint64_t *values);
543#ifdef __cplusplus
544} /* extern "C" */
545#endif
546
547
548#endif /* HWLOC_MEMATTR_H */
hwloc_bitmap_t hwloc_cpuset_t
A CPU set is a bitmap whose bits are set according to CPU physical OS indexes.
Definition: hwloc.h:161
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:742
int hwloc_memattr_get_value(hwloc_topology_t topology, hwloc_memattr_id_t attribute, hwloc_obj_t target_node, struct hwloc_location *initiator, unsigned long flags, hwloc_uint64_t *value)
Return an attribute value for a specific target NUMA node.
hwloc_location_type_e
Type of location.
Definition: memattrs.h:196
int hwloc_get_local_numanode_objs(hwloc_topology_t topology, struct hwloc_location *location, unsigned *nr, hwloc_obj_t *nodes, unsigned long flags)
Return an array of local NUMA nodes.
int hwloc_memattr_get_by_name(hwloc_topology_t topology, const char *name, hwloc_memattr_id_t *id)
Return the identifier of the memory attribute with the given name.
int hwloc_memattr_get_best_target(hwloc_topology_t topology, hwloc_memattr_id_t attribute, struct hwloc_location *initiator, unsigned long flags, hwloc_obj_t *best_target, hwloc_uint64_t *value)
Return the best target NUMA node for the given attribute and initiator.
int hwloc_memattr_get_best_initiator(hwloc_topology_t topology, hwloc_memattr_id_t attribute, hwloc_obj_t target, unsigned long flags, struct hwloc_location *best_initiator, hwloc_uint64_t *value)
Return the best initiator for the given attribute and target NUMA node.
hwloc_memattr_id_e
Memory node attributes.
Definition: memattrs.h:73
hwloc_local_numanode_flag_e
Flags for selecting target NUMA nodes.
Definition: memattrs.h:218
unsigned hwloc_memattr_id_t
A memory attribute identifier. May be either one of hwloc_memattr_id_e or a new id returned by hwloc_...
Definition: memattrs.h:182
@ HWLOC_LOCATION_TYPE_CPUSET
Location is given as a cpuset, in the location cpuset union field.
Definition: memattrs.h:198
@ HWLOC_LOCATION_TYPE_OBJECT
Location is given as an object, in the location object union field.
Definition: memattrs.h:200
@ HWLOC_MEMATTR_ID_BANDWIDTH
The "Bandwidth" is returned in MiB/s, as seen from the given initiator location.
Definition: memattrs.h:113
@ HWLOC_MEMATTR_ID_WRITE_BANDWIDTH
The "WriteBandwidth" is returned in MiB/s, as seen from the given initiator location.
Definition: memattrs.h:135
@ HWLOC_MEMATTR_ID_READ_LATENCY
The "ReadLatency" is returned as nanoseconds, as seen from the given initiator location.
Definition: memattrs.h:161
@ HWLOC_MEMATTR_ID_LOCALITY
The "Locality" is returned as the number of PUs in that locality (e.g. the weight of its cpuset).
Definition: memattrs.h:98
@ HWLOC_MEMATTR_ID_CAPACITY
The "Capacity" is returned in bytes (local_memory attribute in objects).
Definition: memattrs.h:83
@ HWLOC_MEMATTR_ID_WRITE_LATENCY
The "WriteLatency" is returned as nanoseconds, as seen from the given initiator location.
Definition: memattrs.h:172
@ HWLOC_MEMATTR_ID_READ_BANDWIDTH
The "ReadBandwidth" is returned in MiB/s, as seen from the given initiator location.
Definition: memattrs.h:124
@ HWLOC_MEMATTR_ID_LATENCY
The "Latency" is returned as nanoseconds, as seen from the given initiator location.
Definition: memattrs.h:150
@ HWLOC_LOCAL_NUMANODE_FLAG_LARGER_LOCALITY
Select NUMA nodes whose locality is larger than the given cpuset. For instance, if a single PU (or it...
Definition: memattrs.h:224
@ HWLOC_LOCAL_NUMANODE_FLAG_SMALLER_LOCALITY
Select NUMA nodes whose locality is smaller than the given cpuset. For instance, if a package (or its...
Definition: memattrs.h:231
@ HWLOC_LOCAL_NUMANODE_FLAG_ALL
Select all NUMA nodes in the topology. The initiator initiator is ignored.
Definition: memattrs.h:237
int hwloc_memattr_get_initiators(hwloc_topology_t topology, hwloc_memattr_id_t attribute, hwloc_obj_t target_node, unsigned long flags, unsigned *nr, struct hwloc_location *initiators, hwloc_uint64_t *values)
Return the initiators that have values for a given attribute for a specific target NUMA node.
int hwloc_memattr_get_flags(hwloc_topology_t topology, hwloc_memattr_id_t attribute, unsigned long *flags)
Return the flags of the given attribute.
int hwloc_memattr_get_name(hwloc_topology_t topology, hwloc_memattr_id_t attribute, const char **name)
Return the name of a memory attribute.
int hwloc_memattr_register(hwloc_topology_t topology, const char *name, unsigned long flags, hwloc_memattr_id_t *id)
Register a new memory attribute.
hwloc_memattr_flag_e
Memory attribute flags. Given to hwloc_memattr_register() and returned by hwloc_memattr_get_flags().
Definition: memattrs.h:401
int hwloc_memattr_set_value(hwloc_topology_t topology, hwloc_memattr_id_t attribute, hwloc_obj_t target_node, struct hwloc_location *initiator, unsigned long flags, hwloc_uint64_t value)
Set an attribute value for a specific target NUMA node.
int hwloc_memattr_get_targets(hwloc_topology_t topology, hwloc_memattr_id_t attribute, struct hwloc_location *initiator, unsigned long flags, unsigned *nr, hwloc_obj_t *targets, hwloc_uint64_t *values)
Return the target NUMA nodes that have some values for a given attribute.
@ HWLOC_MEMATTR_FLAG_LOWER_FIRST
The best nodes for this memory attribute are those with the lower values. For instance Latency.
Definition: memattrs.h:409
@ HWLOC_MEMATTR_FLAG_NEED_INITIATOR
The value returned for this memory attribute depends on the given initiator. For instance Bandwidth a...
Definition: memattrs.h:413
@ HWLOC_MEMATTR_FLAG_HIGHER_FIRST
The best nodes for this memory attribute are those with the higher values. For instance Bandwidth.
Definition: memattrs.h:405
Structure of a topology object.
Definition: hwloc.h:431
Where to measure attributes from.
Definition: memattrs.h:204
union hwloc_location::hwloc_location_u location
enum hwloc_location_type_e type
Type of location.
Definition: memattrs.h:206
Actual location.
Definition: memattrs.h:208
hwloc_cpuset_t cpuset
Location as a cpuset, when the location type is HWLOC_LOCATION_TYPE_CPUSET.
Definition: memattrs.h:210
hwloc_obj_t object
Location as an object, when the location type is HWLOC_LOCATION_TYPE_OBJECT.
Definition: memattrs.h:212