Hardware Locality (hwloc) 2.9.2

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
16 extern "C" {
17#elif 0
18}
19#endif
20
69 enum hwloc_memattr_id_e {
79 HWLOC_MEMATTR_ID_CAPACITY = 0,
80
94 HWLOC_MEMATTR_ID_LOCALITY = 1,
95
109 HWLOC_MEMATTR_ID_BANDWIDTH = 2,
110
120 HWLOC_MEMATTR_ID_READ_BANDWIDTH = 4,
121
131 HWLOC_MEMATTR_ID_WRITE_BANDWIDTH = 5,
132
146 HWLOC_MEMATTR_ID_LATENCY = 3,
147
157 HWLOC_MEMATTR_ID_READ_LATENCY = 6,
158
168 HWLOC_MEMATTR_ID_WRITE_LATENCY = 7,
169
170 /* TODO persistence? */
171
172 HWLOC_MEMATTR_ID_MAX
173};
174
178 typedef unsigned hwloc_memattr_id_t;
179
185HWLOC_DECLSPEC int
186 hwloc_memattr_get_by_name(hwloc_topology_t topology,
187 const char *name,
188 hwloc_memattr_id_t *id);
189
190
192 enum hwloc_location_type_e {
194 HWLOC_LOCATION_TYPE_CPUSET = 1,
196 HWLOC_LOCATION_TYPE_OBJECT = 0
197};
198
200 struct hwloc_location {
202 enum hwloc_location_type_e type;
204 union hwloc_location_u {
206 hwloc_cpuset_t cpuset;
208 hwloc_obj_t object;
209 } location;
210};
211
212
214 enum hwloc_local_numanode_flag_e {
220 HWLOC_LOCAL_NUMANODE_FLAG_LARGER_LOCALITY = (1UL<<0),
221
227 HWLOC_LOCAL_NUMANODE_FLAG_SMALLER_LOCALITY = (1UL<<1),
228
233 HWLOC_LOCAL_NUMANODE_FLAG_ALL = (1UL<<2)
234};
235
267HWLOC_DECLSPEC int
268 hwloc_get_local_numanode_objs(hwloc_topology_t topology,
269 struct hwloc_location *location,
270 unsigned *nr,
271 hwloc_obj_t *nodes,
272 unsigned long flags);
273
274
275
294HWLOC_DECLSPEC int
295 hwloc_memattr_get_value(hwloc_topology_t topology,
296 hwloc_memattr_id_t attribute,
297 hwloc_obj_t target_node,
298 struct hwloc_location *initiator,
299 unsigned long flags,
300 hwloc_uint64_t *value);
301
330HWLOC_DECLSPEC int
331 hwloc_memattr_get_best_target(hwloc_topology_t topology,
332 hwloc_memattr_id_t attribute,
333 struct hwloc_location *initiator,
334 unsigned long flags,
335 hwloc_obj_t *best_target, hwloc_uint64_t *value);
336
358HWLOC_DECLSPEC int
359 hwloc_memattr_get_best_initiator(hwloc_topology_t topology,
360 hwloc_memattr_id_t attribute,
361 hwloc_obj_t target,
362 unsigned long flags,
363 struct hwloc_location *best_initiator, hwloc_uint64_t *value);
364
377HWLOC_DECLSPEC int
378 hwloc_memattr_get_name(hwloc_topology_t topology,
379 hwloc_memattr_id_t attribute,
380 const char **name);
381
389HWLOC_DECLSPEC int
390 hwloc_memattr_get_flags(hwloc_topology_t topology,
391 hwloc_memattr_id_t attribute,
392 unsigned long *flags);
393
397 enum hwloc_memattr_flag_e {
401 HWLOC_MEMATTR_FLAG_HIGHER_FIRST = (1UL<<0),
405 HWLOC_MEMATTR_FLAG_LOWER_FIRST = (1UL<<1),
409 HWLOC_MEMATTR_FLAG_NEED_INITIATOR = (1UL<<2)
410};
411
421HWLOC_DECLSPEC int
422 hwloc_memattr_register(hwloc_topology_t topology,
423 const char *name,
424 unsigned long flags,
425 hwloc_memattr_id_t *id);
426
447HWLOC_DECLSPEC int
448 hwloc_memattr_set_value(hwloc_topology_t topology,
449 hwloc_memattr_id_t attribute,
450 hwloc_obj_t target_node,
451 struct hwloc_location *initiator,
452 unsigned long flags,
453 hwloc_uint64_t value);
454
493HWLOC_DECLSPEC int
494 hwloc_memattr_get_targets(hwloc_topology_t topology,
495 hwloc_memattr_id_t attribute,
496 struct hwloc_location *initiator,
497 unsigned long flags,
498 unsigned *nr, hwloc_obj_t *targets, hwloc_uint64_t *values);
499
531HWLOC_DECLSPEC int
532 hwloc_memattr_get_initiators(hwloc_topology_t topology,
533 hwloc_memattr_id_t attribute,
534 hwloc_obj_t target_node,
535 unsigned long flags,
536 unsigned *nr, struct hwloc_location *initiators, hwloc_uint64_t *values);
539#ifdef __cplusplus
540} /* extern "C" */
541#endif
542
543
544#endif /* HWLOC_MEMATTR_H */
hwloc_cpuset_t
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
hwloc_topology_t
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:716
hwloc_memattr_get_value
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
hwloc_location_type_e
Type of location.
Definition: memattrs.h:192
hwloc_get_local_numanode_objs
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.
hwloc_memattr_get_by_name
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.
hwloc_memattr_get_best_target
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.
hwloc_memattr_get_best_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
hwloc_memattr_id_e
Memory node attributes.
Definition: memattrs.h:69
hwloc_local_numanode_flag_e
hwloc_local_numanode_flag_e
Flags for selecting target NUMA nodes.
Definition: memattrs.h:214
hwloc_memattr_id_t
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:178
HWLOC_LOCATION_TYPE_CPUSET
@ HWLOC_LOCATION_TYPE_CPUSET
Location is given as a cpuset, in the location cpuset union field.
Definition: memattrs.h:194
HWLOC_LOCATION_TYPE_OBJECT
@ HWLOC_LOCATION_TYPE_OBJECT
Location is given as an object, in the location object union field.
Definition: memattrs.h:196
HWLOC_MEMATTR_ID_BANDWIDTH
@ HWLOC_MEMATTR_ID_BANDWIDTH
The "Bandwidth" is returned in MiB/s, as seen from the given initiator location.
Definition: memattrs.h:109
HWLOC_MEMATTR_ID_WRITE_BANDWIDTH
@ HWLOC_MEMATTR_ID_WRITE_BANDWIDTH
The "WriteBandwidth" is returned in MiB/s, as seen from the given initiator location.
Definition: memattrs.h:131
HWLOC_MEMATTR_ID_READ_LATENCY
@ HWLOC_MEMATTR_ID_READ_LATENCY
The "ReadLatency" is returned as nanoseconds, as seen from the given initiator location.
Definition: memattrs.h:157
HWLOC_MEMATTR_ID_LOCALITY
@ 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:94
HWLOC_MEMATTR_ID_CAPACITY
@ HWLOC_MEMATTR_ID_CAPACITY
The "Capacity" is returned in bytes (local_memory attribute in objects).
Definition: memattrs.h:79
HWLOC_MEMATTR_ID_WRITE_LATENCY
@ HWLOC_MEMATTR_ID_WRITE_LATENCY
The "WriteLatency" is returned as nanoseconds, as seen from the given initiator location.
Definition: memattrs.h:168
HWLOC_MEMATTR_ID_READ_BANDWIDTH
@ HWLOC_MEMATTR_ID_READ_BANDWIDTH
The "ReadBandwidth" is returned in MiB/s, as seen from the given initiator location.
Definition: memattrs.h:120
HWLOC_MEMATTR_ID_LATENCY
@ HWLOC_MEMATTR_ID_LATENCY
The "Latency" is returned as nanoseconds, as seen from the given initiator location.
Definition: memattrs.h:146
HWLOC_LOCAL_NUMANODE_FLAG_LARGER_LOCALITY
@ 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:220
HWLOC_LOCAL_NUMANODE_FLAG_SMALLER_LOCALITY
@ 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:227
HWLOC_LOCAL_NUMANODE_FLAG_ALL
@ HWLOC_LOCAL_NUMANODE_FLAG_ALL
Select all NUMA nodes in the topology. The initiator initiator is ignored.
Definition: memattrs.h:233
hwloc_memattr_get_initiators
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.
hwloc_memattr_get_flags
int hwloc_memattr_get_flags(hwloc_topology_t topology, hwloc_memattr_id_t attribute, unsigned long *flags)
Return the flags of the given attribute.
hwloc_memattr_get_name
int hwloc_memattr_get_name(hwloc_topology_t topology, hwloc_memattr_id_t attribute, const char **name)
Return the name of a memory attribute.
hwloc_memattr_register
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
hwloc_memattr_flag_e
Memory attribute flags. Given to hwloc_memattr_register() and returned by hwloc_memattr_get_flags().
Definition: memattrs.h:397
hwloc_memattr_set_value
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.
hwloc_memattr_get_targets
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
@ HWLOC_MEMATTR_FLAG_LOWER_FIRST
The best nodes for this memory attribute are those with the lower values. For instance Latency.
Definition: memattrs.h:405
HWLOC_MEMATTR_FLAG_NEED_INITIATOR
@ HWLOC_MEMATTR_FLAG_NEED_INITIATOR
The value returned for this memory attribute depends on the given initiator. For instance Bandwidth a...
Definition: memattrs.h:409
HWLOC_MEMATTR_FLAG_HIGHER_FIRST
@ HWLOC_MEMATTR_FLAG_HIGHER_FIRST
The best nodes for this memory attribute are those with the higher values. For instance Bandwidth.
Definition: memattrs.h:401
hwloc_obj
Structure of a topology object.
Definition: hwloc.h:420
hwloc_location
Where to measure attributes from.
Definition: memattrs.h:200
hwloc_location::location
union hwloc_location::hwloc_location_u location
hwloc_location::type
enum hwloc_location_type_e type
Type of location.
Definition: memattrs.h:202
hwloc_location::hwloc_location_u
Actual location.
Definition: memattrs.h:204
hwloc_location::hwloc_location_u::cpuset
hwloc_cpuset_t cpuset
Location as a cpuset, when the location type is HWLOC_LOCATION_TYPE_CPUSET.
Definition: memattrs.h:206
hwloc_location::hwloc_location_u::object
hwloc_obj_t object
Location as an object, when the location type is HWLOC_LOCATION_TYPE_OBJECT.
Definition: memattrs.h:208