53 #include <hwloc/autogen/config.h>
54 #include <sys/types.h>
62 #include <hwloc/rename.h>
68 #include <hwloc/bitmap.h>
69 #include <hwloc/cpuset.h>
89 #define HWLOC_API_VERSION 0x00010b06
98 #define HWLOC_COMPONENT_ABI 4
628 struct hwloc_topology;
681 HWLOC_DECLSPEC
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
918 HWLOC_DECLSPEC
int hwloc_topology_set_fsroot(hwloc_topology_t __hwloc_restrict topology,
const char * __hwloc_restrict fsroot_path);
975 HWLOC_DECLSPEC
int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology,
const char * __hwloc_restrict xmlpath);
1003 HWLOC_DECLSPEC
int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology,
const char * __hwloc_restrict buffer,
int size);
1046 unsigned *os_index,
float *distances);
1195 HWLOC_DECLSPEC
unsigned hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1245 static __hwloc_inline
int
1262 static __hwloc_inline
int
1282 static __hwloc_inline
int
1290 static __hwloc_inline hwloc_obj_t
1294 HWLOC_DECLSPEC hwloc_obj_t
hwloc_get_obj_by_depth (hwloc_topology_t topology,
unsigned depth,
unsigned idx) __hwloc_attribute_pure;
1302 static __hwloc_inline hwloc_obj_t
1309 static __hwloc_inline hwloc_obj_t
1318 static __hwloc_inline hwloc_obj_t
1366 HWLOC_DECLSPEC
int hwloc_obj_attr_snprintf(
char * __hwloc_restrict
string,
size_t size, hwloc_obj_t obj,
const char * __hwloc_restrict separator,
1376 HWLOC_DECLSPEC
int hwloc_obj_cpuset_snprintf(
char * __hwloc_restrict str,
size_t size,
size_t nobj,
const hwloc_obj_t * __hwloc_restrict objs);
1410 void *typeattrp,
size_t typeattrsize);
1427 static __hwloc_inline
const char *
1444 HWLOC_DECLSPEC
void hwloc_obj_add_info(hwloc_obj_t obj,
const char *name,
const char *value);
1574 HWLOC_DECLSPEC
int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set,
int flags);
1581 HWLOC_DECLSPEC
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set,
int flags);
1594 HWLOC_DECLSPEC
int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set,
int flags);
1607 HWLOC_DECLSPEC
int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set,
int flags);
1609 #ifdef hwloc_thread_t
1617 HWLOC_DECLSPEC
int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set,
int flags);
1620 #ifdef hwloc_thread_t
1628 HWLOC_DECLSPEC
int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set,
int flags);
2200 HWLOC_DECLSPEC
void *
hwloc_alloc(hwloc_topology_t topology,
size_t len);
2237 static __hwloc_inline
void *
2249 static __hwloc_inline
void *
2255 HWLOC_DECLSPEC
int hwloc_free(hwloc_topology_t topology,
void *addr,
size_t len);
2340 HWLOC_DECLSPEC
int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset,
unsigned long flags);
2375 HWLOC_DECLSPEC
int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2472 void (*export_cb)(
void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2499 HWLOC_DECLSPEC
int hwloc_export_obj_userdata(
void *reserved, hwloc_topology_t topology, hwloc_obj_t obj,
const char *name,
const void *buffer,
size_t length);
2514 HWLOC_DECLSPEC
int hwloc_export_obj_userdata_base64(
void *reserved, hwloc_topology_t topology, hwloc_obj_t obj,
const char *name,
const void *buffer,
size_t length);
2539 void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj,
const char *name,
const void *buffer,
size_t length));
2599 #include <hwloc/helper.h>
2602 #include <hwloc/inlines.h>
2605 #include <hwloc/diff.h>
2608 #include <hwloc/deprecated.h>
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:555
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:271
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:535
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:633
Whole system (may be a cluster of machines). The whole system that is accessible to hwloc...
Definition: hwloc.h:181
int hwloc_get_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_bitmap_t set, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the specified process.
int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type.
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
unsigned distances_count
Definition: hwloc.h:510
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, unsigned depth)
Returns the width of level at depth depth.
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:340
hwloc_get_type_depth_e
Definition: hwloc.h:1223
int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags)
Get the current physical binding of thread tid.
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:208
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:65
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA, or "hfi1_0" Omni-Path ...
Definition: hwloc.h:293
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:291
Machine. The typical root object type. A set of processors and memory with cache coherency.
Definition: hwloc.h:186
unsigned os_index
OS-provided physical index number. It is not guaranteed unique across the entire machine, except for PUs and NUMA nodes.
Definition: hwloc.h:363
unsigned char subordinate_bus
Definition: hwloc.h:559
Object type-specific Attributes.
Definition: hwloc.h:527
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:63
struct hwloc_obj_memory_s memory
Memory attributes.
Definition: hwloc.h:372
unsigned relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:585
Miscellaneous objects. Objects without particular meaning, that can e.g. be added by the application ...
Definition: hwloc.h:234
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:533
int hwloc_obj_type_snprintf(char *restrict string, size_t size, hwloc_obj_t obj, int verbose)
Stringify the type of a given topology object into a human-readable form.
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:401
Set of flags describing actual support for this topology.
Definition: hwloc.h:1139
Detect the whole PCI hierarchy.
Definition: hwloc.h:825
unsigned nbobjs
Number of objects considered in the matrix. It is the number of descendant objects at relative_depth ...
Definition: hwloc.h:587
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1517
int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags)
Bind a process pid on cpus given in physical bitmap set.
int hwloc_obj_attr_snprintf(char *restrict string, size_t size, hwloc_obj_t obj, const char *restrict separator, int verbose)
Stringify the attributes of a given topology object into a human-readable form.
float latency_base
The multiplier that should be applied to latency matrix to retrieve the original OS-provided latencie...
Definition: hwloc.h:605
Avoid any effect on CPU binding.
Definition: hwloc.h:1857
unsigned short subdevice_id
Definition: hwloc.h:546
PCI Device specific Object Attributes.
Definition: hwloc.h:542
unsigned char get_thisthread_cpubind
Definition: hwloc.h:1080
Get the set of allowed resources from the local operating system even if the topology was loaded from...
Definition: hwloc.h:854
struct hwloc_obj_attr_u::hwloc_bridge_attr_s bridge
struct hwloc_obj_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:512
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1844
Detect PCI bridges.
Definition: hwloc.h:815
Object memory.
Definition: hwloc.h:338
Adapt distance matrices according to objects being removed during restriction. If this flag is not se...
Definition: hwloc.h:2304
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:171
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:793
int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags)
Export the topology as a synthetic string.
Value returned by hwloc_compare_types() when types can not be compared.
Definition: hwloc.h:324
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
static void * hwloc_alloc_membind_policy_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by nodeset.
struct hwloc_obj * prev_sibling
Previous object below the same parent.
Definition: hwloc.h:407
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:351
Bridge. Any bridge that connects the host or an I/O bus, to another I/O bus. Bridge objects have neit...
Definition: hwloc.h:240
hwloc_nodeset_t allowed_nodeset
The set of allowed NUMA memory nodes.
Definition: hwloc.h:496
hwloc_obj_t hwloc_get_obj_by_depth(hwloc_topology_t topology, unsigned depth, unsigned idx)
Returns the topology object at logical index idx from depth depth.
hwloc_bitmap_t hwloc_nodeset_t
A node set is a bitmap whose bits are set according to NUMA memory node physical OS indexes...
Definition: hwloc.h:152
unsigned char replicate_membind
Definition: hwloc.h:1124
void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value)
Add the given info name and value pair to the given object.
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:1086
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
Unified cache.
Definition: hwloc.h:272
NUMA node. An object that contains memory that is directly and byte-accessible to the host processors...
Definition: hwloc.h:191
unsigned char get_proc_membind
Definition: hwloc.h:1106
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:530
unsigned char get_thisproc_membind
Definition: hwloc.h:1102
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:422
Allocate memory on the specified nodes.
Definition: hwloc.h:1769
unsigned arity
Number of children.
Definition: hwloc.h:410
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:757
struct hwloc_pcidev_attr_s pci
Definition: hwloc.h:553
int hwloc_get_membind(hwloc_topology_t topology, hwloc_bitmap_t set, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the current process or thread...
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2299
Physical package. The physical package that usually gets inserted into a socket on the motherboard...
Definition: hwloc.h:200
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:279
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:1098
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:350
int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags)
Bind current process or thread on cpus given in physical bitmap set.
int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags)
Get the NUMA nodes where memory identified by (addr, len ) is physically allocated.
Instruction cache. Only used when the HWLOC_TOPOLOGY_FLAG_ICACHES topology flag is set...
Definition: hwloc.h:274
OS Device specific Object Attributes.
Definition: hwloc.h:566
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:532
int hwloc_get_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, hwloc_membind_policy_t *policy, int flags)
Query the CPUs near the physical NUMA node(s) and binding policy of the memory identified by (addr...
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:349
Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allo...
Definition: hwloc.h:1765
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:454
Reset the memory allocation policy to the system default. Depending on the operating system...
Definition: hwloc.h:1755
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:367
int hwloc_export_obj_userdata(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length)
Export some object userdata to XML.
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, unsigned depth)
Returns the type of objects at depth depth.
Operating system co-processor device. For instance "mic0" for a Xeon Phi (MIC) on Linux...
Definition: hwloc.h:298
static int hwloc_get_type_or_below_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type or below.
int hwloc_obj_type_sscanf(const char *string, hwloc_obj_type_t *typep, int *depthattrp, void *typeattrp, size_t typeattrsize)
Return an object type and attributes from a type string.
int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology)
Ignore all objects that do not bring any structure.
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:531
void * hwloc_alloc_membind_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by nodeset.
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:1088
unsigned char nexttouch_membind
Definition: hwloc.h:1126
void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer)
Free a buffer allocated by hwloc_topology_export_xmlbuffer()
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1778
unsigned char get_area_membind
Definition: hwloc.h:1114
static hwloc_obj_t hwloc_get_next_obj_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, hwloc_obj_t prev)
Returns the next object of type type.
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
Structure of a topology object.
Definition: hwloc.h:359
Detect PCI devices.
Definition: hwloc.h:806
void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology, void(*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj))
Set the application-specific callback for exporting object userdata.
unsigned char get_thisthread_membind
Definition: hwloc.h:1110
struct hwloc_obj_attr_u::hwloc_group_attr_s group
int hwloc_get_proc_membind_nodeset(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_nodeset_t nodeset, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the specified process.
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1225
unsigned short domain
Definition: hwloc.h:543
unsigned short class_id
Definition: hwloc.h:545
unsigned short vendor_id
Definition: hwloc.h:546
unsigned hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
unsigned char set_area_membind
Definition: hwloc.h:1112
unsigned char set_proc_cpubind
Definition: hwloc.h:1074
char * name
Info name.
Definition: hwloc.h:616
hwloc_uint64_t total_memory
Total memory (in bytes) in this object and its children.
Definition: hwloc.h:339
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:221
float latency_max
The maximal value in the latency matrix.
Definition: hwloc.h:604
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR'ed flags of a topology.
unsigned depth
Definition: hwloc.h:563
int hwloc_topology_set_xmlbuffer(hwloc_topology_t restrict topology, const char *restrict buffer, int size)
Enable XML based topology using a memory buffer (instead of a file, as with hwloc_topology_set_xml())...
For each page bound with this policy, by next time it is touched (and next time only), it is moved from its current location to the local NUMA node of the thread where the memory reference occurred (if it needs to be moved at all).
Definition: hwloc.h:1798
int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:465
unsigned char get_thisproc_cpubind
Definition: hwloc.h:1072
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:411
int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot)
Insert an existing topology inside a custom topology.
unsigned char revision
Definition: hwloc.h:547
int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags)
Bind a thread thread on cpus given in physical bitmap set.
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
Virtual depth for bridge object level.
Definition: hwloc.h:1226
unsigned char get_thread_cpubind
Definition: hwloc.h:1084
int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the current process or thread to prefer the NUMA node(s) spe...
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1830
void * hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by set.
static hwloc_obj_t hwloc_get_next_obj_by_depth(hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev)
Returns the next object at depth depth.
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
hwloc_topology_export_synthetic_flags_e
Flags for exporting synthetic topologies.
Definition: hwloc.h:2552
hwloc_obj_osdev_type_t type
Definition: hwloc.h:567
char * value
Info value.
Definition: hwloc.h:617
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which process the topology is viewed from.
static const char * hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name)
Search the given key name in object infos and return the corresponding value.
int hwloc_obj_cpuset_snprintf(char *restrict str, size_t size, size_t nobj, const hwloc_obj_t *restrict objs)
Stringify the cpuset containing a set of objects.
struct hwloc_obj * next_sibling
Next object below the same parent.
Definition: hwloc.h:406
hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, const char *name)
Add a MISC object to the topology.
unsigned char secondary_bus
Definition: hwloc.h:559
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@0 upstream
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:400
int hwloc_set_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the specified process to prefer the NUMA node(s) specified b...
int hwloc_get_area_membind_nodeset(hwloc_topology_t topology, const void *addr, size_t len, hwloc_nodeset_t nodeset, hwloc_membind_policy_t *policy, int flags)
Query the physical NUMA node(s) and binding policy of the memory identified by (addr, len ).
int hwloc_export_obj_userdata_base64(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length)
Encode and export some object userdata to XML.
int hwloc_topology_set_custom(hwloc_topology_t topology)
Prepare the topology for custom assembly.
unsigned infos_count
Size of infos array.
Definition: hwloc.h:513
Bridge specific Object Attribues.
Definition: hwloc.h:551
int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get the last physical CPU where the current process or thread ran.
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:296
int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the current process or thread...
unsigned char set_thisthread_membind
Definition: hwloc.h:1108
unsigned char get_proc_cpubind
Definition: hwloc.h:1076
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:413
Detect the whole system, ignore reservations and offline settings.
Definition: hwloc.h:773
unsigned short domain
Definition: hwloc.h:558
unsigned char dev
Definition: hwloc.h:544
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:446
unsigned char set_thread_cpubind
Definition: hwloc.h:1082
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:374
struct hwloc_obj * first_child
First child.
Definition: hwloc.h:412
int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the current process or thread to prefer the NUMA node(s) spe...
unsigned short device_id
Definition: hwloc.h:546
unsigned char set_thisthread_cpubind
Definition: hwloc.h:1078
Group-specific Object Attributes.
Definition: hwloc.h:538
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:135
No object of given type exists in the topology.
Definition: hwloc.h:1224
Do not export level attributes.
Definition: hwloc.h:2566
Flags describing actual discovery support for this topology.
Definition: hwloc.h:1058
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2316
Operating system block device. For instance "sda" on Linux.
Definition: hwloc.h:286
int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type if it does not bring any structure.
float linkspeed
Definition: hwloc.h:548
hwloc_obj_t hwloc_topology_insert_misc_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, const char *name)
Add a MISC object as a leaf of the topology.
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:562
float * latency
Matrix of latencies between objects, stored as a one-dimension array. May be NULL if the distances co...
Definition: hwloc.h:592
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
Consider the bitmap argument as a nodeset.
Definition: hwloc.h:1869
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
unsigned char set_thisproc_cpubind
Definition: hwloc.h:1070
Object info.
Definition: hwloc.h:615
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1745
Bind current thread of current process.
Definition: hwloc.h:1524
hwloc_compare_types_e
Definition: hwloc.h:323
int hwloc_set_proc_membind_nodeset(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the specified process to prefer the NUMA node(s) specified b...
unsigned char set_proc_membind
Definition: hwloc.h:1104
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR'ed flags to non-yet-loaded topology.
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2310
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:482
int hwloc_set_area_membind_nodeset(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) specified by nodeset...
unsigned char get_area_memlocation
Definition: hwloc.h:1130
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:288
int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags)
Get the last physical CPU where a process ran.
int hwloc_set_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) specified by set...
int hwloc_topology_restrict(hwloc_topology_t restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags)
Restrict the topology to the given CPU set.
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:416
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
unsigned char bind_membind
Definition: hwloc.h:1120
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:1068
int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags)
Get the current physical binding of process pid.
Avoid any effect on memory binding.
Definition: hwloc.h:1566
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:1141
static void * hwloc_alloc_membind_policy(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by set.
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:285
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:361
unsigned char migrate_membind
Definition: hwloc.h:1128
Cache-specific Object Attributes.
Definition: hwloc.h:529
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1142
Virtual depth for software device object level.
Definition: hwloc.h:1228
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
unsigned short subvendor_id
Definition: hwloc.h:546
Operating system device. These objects have neither CPU sets nor node sets. They are not added to the...
Definition: hwloc.h:252
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:393
void hwloc_topology_set_userdata_import_callback(hwloc_topology_t topology, void(*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length))
Set the application-specific callback for importing userdata.
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
unsigned char bus
Definition: hwloc.h:544
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1140
int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath)
Export the topology into an XML file.
Data cache.
Definition: hwloc.h:273
unsigned sibling_rank
Index in parent's children[] array.
Definition: hwloc.h:405
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
static hwloc_obj_t hwloc_get_obj_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx)
Returns the topology object at logical index idx with type type.
signed os_level
OS-provided physical level, -1 if unknown or meaningless.
Definition: hwloc.h:397
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:404
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:155
Cache. Can be L1i, L1d, L2, L3, ...
Definition: hwloc.h:205
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1804
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:247
int symmetric_subtree
Set if the subtree of objects below this object is symmetric, which means all children and their chil...
Definition: hwloc.h:515
Export extended types such as L2dcache as basic types such as Cache.
Definition: hwloc.h:2558
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a constant stringified object type.
int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen)
Export the topology into a newly-allocated XML memory buffer.
unsigned depth
Depth of group object.
Definition: hwloc.h:539
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1520
unsigned char firsttouch_membind
Definition: hwloc.h:1118
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
unsigned char set_thisproc_membind
Definition: hwloc.h:1100
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:1060
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:343
hwloc_obj_t hwloc_custom_insert_group_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, int groupdepth)
Insert a new group object inside a custom topology.
int hwloc_topology_set_fsroot(hwloc_topology_t restrict topology, const char *restrict fsroot_path)
Change the file-system root path when building the topology from sysfs/procfs.
Request for strict binding from the OS.
Definition: hwloc.h:1549
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:212
int hwloc_topology_set_distance_matrix(hwloc_topology_t restrict topology, hwloc_obj_type_t type, unsigned nbobjs, unsigned *os_index, float *distances)
Provide a distance matrix.
struct hwloc_distances_s ** distances
Distances between all objects at same depth below this object.
Definition: hwloc.h:509
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1820
unsigned char func
Definition: hwloc.h:544
PCI-side of a bridge.
Definition: hwloc.h:281
struct hwloc_obj_memory_s::hwloc_obj_memory_page_type_s * page_types
unsigned char interleave_membind
Definition: hwloc.h:1122
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:435
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
struct hwloc_obj_attr_u::hwloc_cache_attr_s cache
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:1090
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:524
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:133
int hwloc_free(hwloc_topology_t topology, void *addr, size_t len)
Free memory that was previously allocated by hwloc_alloc() or hwloc_alloc_membind().
unsigned char alloc_membind
Definition: hwloc.h:1116
Detect instruction caches.
Definition: hwloc.h:833
Replicate memory on the given nodes; reads from this memory will attempt to be serviced from the NUMA...
Definition: hwloc.h:1791
unsigned depth
Vertical index in the hierarchy.
Definition: hwloc.h:378
Virtual depth for PCI device object level.
Definition: hwloc.h:1227
Distances between objects.
Definition: hwloc.h:584
static int hwloc_get_type_or_above_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type or above.
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:280
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1825