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>
82 #define HWLOC_API_VERSION 0x00010b00
91 #define HWLOC_COMPONENT_ABI 4
596 struct hwloc_topology;
643 HWLOC_DECLSPEC
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
855 HWLOC_DECLSPEC
int hwloc_topology_set_fsroot(hwloc_topology_t __hwloc_restrict topology,
const char * __hwloc_restrict fsroot_path);
912 HWLOC_DECLSPEC
int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology,
const char * __hwloc_restrict xmlpath);
940 HWLOC_DECLSPEC
int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology,
const char * __hwloc_restrict buffer,
int size);
982 unsigned *os_index,
float *distances);
1111 HWLOC_DECLSPEC
unsigned hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1154 static __hwloc_inline
int
1166 static __hwloc_inline
int
1186 static __hwloc_inline
int
1194 static __hwloc_inline hwloc_obj_t
1198 HWLOC_DECLSPEC hwloc_obj_t
hwloc_get_obj_by_depth (hwloc_topology_t topology,
unsigned depth,
unsigned idx) __hwloc_attribute_pure;
1206 static __hwloc_inline hwloc_obj_t
1213 static __hwloc_inline hwloc_obj_t
1222 static __hwloc_inline hwloc_obj_t
1266 void *typeattrp,
size_t typeattrsize);
1292 HWLOC_DECLSPEC
int hwloc_obj_attr_snprintf(
char * __hwloc_restrict
string,
size_t size, hwloc_obj_t obj,
const char * __hwloc_restrict separator,
1302 HWLOC_DECLSPEC
int hwloc_obj_cpuset_snprintf(
char * __hwloc_restrict str,
size_t size,
size_t nobj,
const hwloc_obj_t * __hwloc_restrict objs);
1310 static __hwloc_inline
const char *
1327 HWLOC_DECLSPEC
void hwloc_obj_add_info(hwloc_obj_t obj,
const char *name,
const char *value);
1454 HWLOC_DECLSPEC
int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set,
int flags);
1461 HWLOC_DECLSPEC
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set,
int flags);
1474 HWLOC_DECLSPEC
int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set,
int flags);
1487 HWLOC_DECLSPEC
int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set,
int flags);
1489 #ifdef hwloc_thread_t
1497 HWLOC_DECLSPEC
int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set,
int flags);
1500 #ifdef hwloc_thread_t
1508 HWLOC_DECLSPEC
int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set,
int flags);
2023 HWLOC_DECLSPEC
void *
hwloc_alloc(hwloc_topology_t topology,
size_t len);
2057 static __hwloc_inline
void *
2064 static __hwloc_inline
void *
2070 HWLOC_DECLSPEC
int hwloc_free(hwloc_topology_t topology,
void *addr,
size_t len);
2155 HWLOC_DECLSPEC
int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset,
unsigned long flags);
2190 HWLOC_DECLSPEC
int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2284 void (*export_cb)(
void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2311 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);
2326 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);
2351 void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj,
const char *name,
const void *buffer,
size_t length));
2411 #include <hwloc/helper.h>
2414 #include <hwloc/inlines.h>
2417 #include <hwloc/diff.h>
2420 #include <hwloc/deprecated.h>
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:526
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:257
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:506
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:601
Whole system (may be a cluster of machines). The whole system that is accessible to hwloc...
Definition: hwloc.h:174
int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type.
unsigned distances_count
Definition: hwloc.h:481
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:325
hwloc_get_type_depth_e
Definition: hwloc.h:1137
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
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) in physical nodeset...
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:195
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA device on Linux...
Definition: hwloc.h:279
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:277
Machine. The typical root object type. A set of processors and memory with cache coherency.
Definition: hwloc.h:179
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:347
unsigned char subordinate_bus
Definition: hwloc.h:530
Object type-specific Attributes.
Definition: hwloc.h:498
struct hwloc_obj_memory_s memory
Memory attributes.
Definition: hwloc.h:353
unsigned relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:556
Miscellaneous objects. Objects without particular meaning, that can e.g. be added by the application ...
Definition: hwloc.h:220
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:504
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:372
Set of flags describing actual support for this topology.
Definition: hwloc.h:1066
Detect the whole PCI hierarchy.
Definition: hwloc.h:783
int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath)
Export the topology into an XML file.
unsigned nbobjs
Number of objects considered in the matrix. It is the number of descendant objects at relative_depth ...
Definition: hwloc.h:558
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1620
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:576
unsigned short subdevice_id
Definition: hwloc.h:517
PCI Device specific Object Attributes.
Definition: hwloc.h:513
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 char get_thisthread_cpubind
Definition: hwloc.h:1012
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:483
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.
Detect PCI bridges.
Definition: hwloc.h:773
Object memory.
Definition: hwloc.h:323
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:164
Reset the memory allocation policy to the system default. Depending on the operating system...
Definition: hwloc.h:1626
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:751
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.
Value returned by hwloc_compare_types() when types can not be compared.
Definition: hwloc.h:309
void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer)
Free a buffer allocated by hwloc_topology_export_xmlbuffer()
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
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.
struct hwloc_obj * prev_sibling
Previous object below the same parent.
Definition: hwloc.h:378
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:1669
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:336
Bridge. Any bridge that connects the host or an I/O bus, to another I/O bus. Bridge objects have neit...
Definition: hwloc.h:226
hwloc_nodeset_t allowed_nodeset
The set of allowed NUMA memory nodes.
Definition: hwloc.h:467
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:145
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 replicate_membind
Definition: hwloc.h:1052
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:1018
int hwloc_set_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the specified process to prefer the NUMA node(s) near the sp...
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.
Unified cache.
Definition: hwloc.h:258
NUMA node. A set of processors around memory which the processors can directly access.
Definition: hwloc.h:184
unsigned char get_proc_membind
Definition: hwloc.h:1034
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:501
unsigned char get_thisproc_membind
Definition: hwloc.h:1030
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen)
Export the topology into a newly-allocated XML memory buffer.
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_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.
int hwloc_get_membind(hwloc_topology_t topology, hwloc_cpuset_t cpuset, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the current process or thread (the l...
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:393
unsigned arity
Number of children.
Definition: hwloc.h:381
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:719
struct hwloc_pcidev_attr_s pci
Definition: hwloc.h:524
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1715
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2125
Physical package, what goes into a socket. In the physical meaning, i.e. that you can add or remove p...
Definition: hwloc.h:188
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:265
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:1026
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:52
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:335
Instruction cache. Only used when the HWLOC_TOPOLOGY_FLAG_ICACHES topology flag is set...
Definition: hwloc.h:260
OS Device specific Object Attributes.
Definition: hwloc.h:537
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.
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:503
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1691
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:334
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:425
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.
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 the given nodeset nodeset.
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.
char * name
Object description if any.
Definition: hwloc.h:351
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:283
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_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.
Avoid any effect on CPU binding.
Definition: hwloc.h:1728
int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology)
Ignore all objects that do not bring any structure.
hwloc_topology_export_synthetic_flags_e
Flags for exporting synthetic topologies.
Definition: hwloc.h:2364
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:502
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:1020
unsigned char nexttouch_membind
Definition: hwloc.h:1054
unsigned char get_area_membind
Definition: hwloc.h:1042
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:344
Detect PCI devices.
Definition: hwloc.h:764
Avoid any effect on memory binding.
Definition: hwloc.h:1446
unsigned char get_thisthread_membind
Definition: hwloc.h:1038
struct hwloc_obj_attr_u::hwloc_group_attr_s group
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1139
Adapt distance matrices according to objects being removed during restriction. If this flag is not se...
Definition: hwloc.h:2119
unsigned short domain
Definition: hwloc.h:514
unsigned short class_id
Definition: hwloc.h:516
unsigned short vendor_id
Definition: hwloc.h:517
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:1040
int hwloc_get_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_cpuset_t cpuset, 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...
unsigned char set_proc_cpubind
Definition: hwloc.h:1006
char * name
Info name.
Definition: hwloc.h:584
hwloc_uint64_t total_memory
Total memory (in bytes) in this object and its children.
Definition: hwloc.h:324
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.
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:208
float latency_max
The maximal value in the latency matrix.
Definition: hwloc.h:575
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1701
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR'ed flags of a topology.
unsigned depth
Definition: hwloc.h:534
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())...
Allocate memory on the specified nodes.
Definition: hwloc.h:1640
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_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
int hwloc_get_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t cpuset, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the specified process (the locality ...
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:436
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2131
unsigned char get_thisproc_cpubind
Definition: hwloc.h:1004
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:382
unsigned char revision
Definition: hwloc.h:518
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:1140
unsigned char get_thread_cpubind
Definition: hwloc.h:1016
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 the given physical nodeset nodeset.
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_obj_osdev_type_t type
Definition: hwloc.h:538
char * value
Info value.
Definition: hwloc.h:585
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which process the topology is viewed from.
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:377
unsigned char secondary_bus
Definition: hwloc.h:530
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:371
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
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:484
Bridge specific Object Attribues.
Definition: hwloc.h:522
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:281
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1675
unsigned char set_thisthread_membind
Definition: hwloc.h:1036
unsigned char get_proc_cpubind
Definition: hwloc.h:1008
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:384
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...
Detect the whole system, ignore reservations and offline settings.
Definition: hwloc.h:731
unsigned short domain
Definition: hwloc.h:529
unsigned char dev
Definition: hwloc.h:515
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:417
unsigned char set_thread_cpubind
Definition: hwloc.h:1014
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2114
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:355
struct hwloc_obj * first_child
First child.
Definition: hwloc.h:383
Request for strict binding from the OS.
Definition: hwloc.h:1429
unsigned short device_id
Definition: hwloc.h:517
static void * hwloc_alloc_membind_policy(hwloc_topology_t topology, size_t len, hwloc_const_cpuset_t set, hwloc_membind_policy_t policy, int flags)
Allocate some memory on the memory nodes near given cpuset cpuset.
Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allo...
Definition: hwloc.h:1636
unsigned char set_thisthread_cpubind
Definition: hwloc.h:1010
Group-specific Object Attributes.
Definition: hwloc.h:509
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.
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:128
No object of given type exists in the topology.
Definition: hwloc.h:1138
Flags describing actual discovery support for this topology.
Definition: hwloc.h:994
Operating system block device. For instance "sda" on Linux.
Definition: hwloc.h:272
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1649
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:519
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:533
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...
float * latency
Matrix of latencies between objects, stored as a one-dimension array. May be NULL if the distances co...
Definition: hwloc.h:563
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
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:1002
Object info.
Definition: hwloc.h:583
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1696
Export extended types such as L2dcache as basic types such as Cache.
Definition: hwloc.h:2370
hwloc_compare_types_e
Definition: hwloc.h:308
unsigned char set_proc_membind
Definition: hwloc.h:1032
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR'ed flags to non-yet-loaded topology.
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:453
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:274
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:387
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
unsigned char bind_membind
Definition: hwloc.h:1048
void * hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags)
Allocate some memory on memory nodes near the given physical cpuset cpuset.
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:1000
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:1068
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:271
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:346
unsigned char migrate_membind
Definition: hwloc.h:1057
Cache-specific Object Attributes.
Definition: hwloc.h:500
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1069
Do not export level attributes.
Definition: hwloc.h:2378
Virtual depth for software device object level.
Definition: hwloc.h:1142
Bind current thread of current process.
Definition: hwloc.h:1404
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags)
Export the topology as a synthetic string.
unsigned short subvendor_id
Definition: hwloc.h:517
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.
Operating system device. These objects have neither CPU sets nor node sets. They are not added to the...
Definition: hwloc.h:238
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.
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:50
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:364
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:515
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1067
Data cache.
Definition: hwloc.h:259
unsigned sibling_rank
Index in parent's children[] array.
Definition: hwloc.h:376
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
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().
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:368
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:375
int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, 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) nea...
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:148
Cache. Can be L1i, L1d, L2, L3, ...
Definition: hwloc.h:192
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:233
int symmetric_subtree
Set if the subtree of objects below this object is symmetric, which means all children and their chil...
Definition: hwloc.h:486
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.
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a stringified topology object type.
unsigned depth
Depth of group object.
Definition: hwloc.h:510
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.
unsigned char firsttouch_membind
Definition: hwloc.h:1046
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
unsigned char set_thisproc_membind
Definition: hwloc.h:1028
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:996
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:328
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.
Replicate memory on the given nodes; reads from this memory will attempt to be serviced from the NUMA...
Definition: hwloc.h:1662
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:199
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_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:480
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
unsigned char func
Definition: hwloc.h:515
PCI-side of a bridge.
Definition: hwloc.h:267
struct hwloc_obj_memory_s::hwloc_obj_memory_page_type_s * page_types
unsigned char interleave_membind
Definition: hwloc.h:1050
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:406
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
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.
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1397
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:1022
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1400
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:495
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:126
unsigned char alloc_membind
Definition: hwloc.h:1044
Detect instruction caches.
Definition: hwloc.h:791
unsigned depth
Vertical index in the hierarchy. If the topology is symmetric, this is equal to the parent depth plus...
Definition: hwloc.h:359
Virtual depth for PCI device object level.
Definition: hwloc.h:1141
Distances between objects.
Definition: hwloc.h:555
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:266
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
int hwloc_set_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) near physical cpuset...