56 #include "hwloc/autogen/config.h" 58 #include <sys/types.h> 66 #include "hwloc/rename.h" 72 #include "hwloc/bitmap.h" 115 #define HWLOC_API_VERSION 0x00020a00 126 #define HWLOC_COMPONENT_ABI 7 200 #define HWLOC_OBJ_TYPE_MIN HWLOC_OBJ_MACHINE 415 #define HWLOC_TYPE_UNORDERED INT_MAX 441 #define HWLOC_UNKNOWN_INDEX (unsigned)-1 669 #ifndef HWLOC_HAVE_32BITS_PCI_DOMAIN 700 #ifndef HWLOC_HAVE_32BITS_PCI_DOMAIN 737 struct hwloc_topology;
923 static __hwloc_inline
int 939 static __hwloc_inline
int 965 static __hwloc_inline
int 1068 hwloc_obj_t obj,
const char * __hwloc_restrict separator,
1141 static __hwloc_inline
const char *
1337 #ifdef hwloc_thread_t 1350 #ifdef hwloc_thread_t 1852 static __hwloc_inline
void *
2819 #include "hwloc/helper.h" 2822 #include "hwloc/inlines.h" 2825 #include "hwloc/memattrs.h" 2828 #include "hwloc/cpukinds.h" 2831 #include "hwloc/export.h" 2834 #include "hwloc/distances.h" 2837 #include "hwloc/diff.h" 2840 #include "hwloc/deprecated.h" void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
Keep all objects of this type.
Definition: hwloc.h:2417
char * subtype
Subtype string to better describe the type field.
Definition: hwloc.h:434
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:637
Level 1 Data (or Unified) Cache.
Definition: hwloc.h:234
Ignore CPU Kinds.
Definition: hwloc.h:2224
unsigned short class_id
The class number (first two bytes, without the prog_if).
Definition: hwloc.h:679
unsigned char dev
Device number (zz in the PCI BDF notation xxxx:yy:zz.t).
Definition: hwloc.h:677
unsigned char set_thisthread_cpubind
Definition: hwloc.h:2298
Operating system device (filtered out by default).
Definition: hwloc.h:305
struct hwloc_obj_attr_u::hwloc_numanode_attr_s::hwloc_memory_page_type_s * page_types
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:2270
Virtual depth for bridge object level.
Definition: hwloc.h:882
Consider the bitmap argument as a nodeset.
Definition: hwloc.h:1608
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1544
Cache-specific Object Attributes.
Definition: hwloc.h:651
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.
unsigned char set_thread_cpubind
Definition: hwloc.h:2302
int hwloc_get_memory_parents_depth(hwloc_topology_t topology)
Return the depth of parents where memory objects are attached.
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:377
Set of flags describing actual support for this topology.
Definition: hwloc.h:2364
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
unsigned io_arity
Number of I/O children. These children are listed in io_first_child.
Definition: hwloc.h:525
Object type-specific Attributes.
Definition: hwloc.h:634
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
unsigned char interleave_membind
Definition: hwloc.h:2342
unsigned char set_area_membind
Definition: hwloc.h:2332
Machine. A set of processors and memory with cache coherency.
Definition: hwloc.h:203
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1233
Ignore all objects of this type.
Definition: hwloc.h:2425
No object of given type exists in the topology.
Definition: hwloc.h:879
struct hwloc_obj * misc_first_child
First Misc child. Misc objects are listed here (misc_arity and misc_first_child) instead of in the no...
Definition: hwloc.h:540
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1491
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.
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
unsigned memory_arity
Number of Memory children. These children are listed in memory_first_child.
Definition: hwloc.h:507
Bind current thread of current process.
Definition: hwloc.h:1240
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
int hwloc_topology_set_io_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all I/O object types.
unsigned char bus
Bus number (yy in the PCI BDF notation xxxx:yy:zz.t).
Definition: hwloc.h:676
Only keep likely-important objects of the given type.
Definition: hwloc.h:2454
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:71
unsigned char get_proc_membind
Definition: hwloc.h:2326
unsigned char get_thisproc_membind
Definition: hwloc.h:2322
struct hwloc_obj * first_child
First normal child.
Definition: hwloc.h:492
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:657
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:358
hwloc_uint64_t total_memory
Total memory (in bytes) in NUMA nodes below this object.
Definition: hwloc.h:448
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1236
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:163
Do not consider resources outside of the process memory binding.
Definition: hwloc.h:2189
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR'ed flags of a topology.
unsigned infos_count
Size of infos array.
Definition: hwloc.h:614
Request for strict binding from the OS.
Definition: hwloc.h:1265
PCI Device specific Object Attributes.
Definition: hwloc.h:668
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:638
Ignore distances.
Definition: hwloc.h:2211
Unified cache.
Definition: hwloc.h:359
unsigned char cpukind_efficiency
Detecting the efficiency of CPU kinds is supported, see Kinds of CPU cores.
Definition: hwloc.h:2280
unsigned char get_area_membind
Definition: hwloc.h:2334
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:181
Virtual depth for software device object level.
Definition: hwloc.h:884
Avoid any effect on CPU binding.
Definition: hwloc.h:1597
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:644
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:631
int hwloc_topology_set_icache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all CPU instruction cache object types.
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:443
Virtual depth for MemCache object.
Definition: hwloc.h:886
unsigned char revision
Revision number.
Definition: hwloc.h:684
int hwloc_topology_set_all_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all object types.
Physical package. The physical package that usually gets inserted into a socket on the motherboard...
Definition: hwloc.h:212
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:646
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.
Structure of a topology object.
Definition: hwloc.h:431
unsigned char firsttouch_membind
Definition: hwloc.h:2338
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, int depth)
Returns the type of objects at depth depth.
Allocate each memory page individually on the local NUMA node of the thread that touches it...
Definition: hwloc.h:1510
unsigned short device_id
Device ID (yyyy in [xxxx:yyyy]).
Definition: hwloc.h:681
hwloc_topology_components_flag_e
Flags to be passed to hwloc_topology_set_components()
Definition: hwloc.h:2011
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...
hwloc_obj_bridge_type_t downstream_type
Downstream Bridge type.
Definition: hwloc.h:711
Reset the memory allocation policy to the system default. Depending on the operating system...
Definition: hwloc.h:1499
Level 3 Data (or Unified) Cache.
Definition: hwloc.h:236
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:197
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:371
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:2288
Virtual depth for NUMA nodes.
Definition: hwloc.h:881
hwloc_obj_t hwloc_topology_insert_misc_object(hwloc_topology_t topology, hwloc_obj_t parent, const char *name)
Add a MISC object as a leaf of the topology.
int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
OS Device specific Object Attributes.
Definition: hwloc.h:715
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
struct hwloc_obj * memory_first_child
First Memory child. NUMA nodes and Memory-side caches are listed here (memory_arity and memory_first_...
Definition: hwloc.h:510
Get the set of allowed resources from the local operating system even if the topology was loaded from...
Definition: hwloc.h:2118
Die within a physical package. A subpart of the physical package, that contains multiple cores...
Definition: hwloc.h:344
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.
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:450
hwloc_obj_t hwloc_get_obj_by_depth(hwloc_topology_t topology, int depth, unsigned idx)
Returns the topology object at logical index idx from depth depth.
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, int depth)
Returns the width of level at depth depth.
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
unsigned depth
Depth of group object. It may change if intermediate Group objects are added.
Definition: hwloc.h:661
hwloc_cpuset_t complete_cpuset
The complete CPU set of processors of this object,.
Definition: hwloc.h:562
Group-specific Object Attributes.
Definition: hwloc.h:660
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1560
int hwloc_topology_allow(hwloc_topology_t restrict topology, hwloc_const_cpuset_t cpuset, hwloc_const_nodeset_t nodeset, unsigned long flags)
Change the sets of allowed PUs and NUMA nodes in the topology.
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
unsigned short subvendor_id
Sub-Vendor ID.
Definition: hwloc.h:682
struct hwloc_obj * prev_sibling
Previous object below the same parent (inside the same list of children).
Definition: hwloc.h:484
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
Allocate memory on the specified nodes.
Definition: hwloc.h:1520
int hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
int hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value)
Add the given name and value pair to the given object info attributes.
Operating system co-processor device. For instance "opencl0d0" for a OpenCL device, "cuda0" for a CUDA device.
Definition: hwloc.h:385
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
Only allow objects that are available to the current process.
Definition: hwloc.h:2616
Flags describing miscellaneous features.
Definition: hwloc.h:2353
unsigned char set_thisthread_membind
Definition: hwloc.h:2328
unsigned char dont_merge
Flag preventing groups from being automatically merged with identical parent or children.
Definition: hwloc.h:665
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:2366
struct hwloc_pcidev_attr_s pci
PCI attribute of the upstream part as a PCI device.
Definition: hwloc.h:695
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.
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a constant stringified object type.
struct hwloc_obj_attr_u::hwloc_numanode_attr_s numanode
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2561
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@0 upstream
Flags describing actual discovery support for this topology.
Definition: hwloc.h:2268
hwloc_obj_t hwloc_topology_alloc_group_object(hwloc_topology_t topology)
Allocate a Group object to insert later with hwloc_topology_insert_group_object().
hwloc_type_filter_e
Type filtering flags.
Definition: hwloc.h:2411
Level 2 instruction Cache (filtered out by default).
Definition: hwloc.h:241
unsigned char get_proc_cpubind
Definition: hwloc.h:2296
unsigned char get_thread_cpubind
Definition: hwloc.h:2304
unsigned char migrate_membind
Definition: hwloc.h:2346
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.
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2555
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.
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...
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:742
Objects of given type exist at different depth in the topology (only for Groups). ...
Definition: hwloc.h:880
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
struct hwloc_obj * io_first_child
First I/O child. Bridges, PCI and OS devices are listed here (io_arity and io_first_child) instead of...
Definition: hwloc.h:528
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA, "hfi1_0" Omni-Path int...
Definition: hwloc.h:379
unsigned short subdevice_id
Sub-Device ID.
Definition: hwloc.h:683
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:2097
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:652
char * name
Info name.
Definition: hwloc.h:725
unsigned char func
Function number (t in the PCI BDF notation xxxx:yy:zz.t).
Definition: hwloc.h:678
hwloc_obj_t hwloc_topology_insert_group_object(hwloc_topology_t topology, hwloc_obj_t group)
Add more structure to the topology by adding an intermediate Group.
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:366
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.
Level 1 instruction Cache (filtered out by default).
Definition: hwloc.h:240
int hwloc_topology_set_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e filter)
Set the filtering for the given object type.
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:654
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:2055
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
hwloc_obj_osdev_type_t type
Definition: hwloc.h:716
int hwloc_topology_get_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e *filter)
Get the current filtering for the given object type.
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:2308
struct hwloc_obj * next_sibling
Next object below the same parent (inside the same list of children).
Definition: hwloc.h:483
Level 4 Data (or Unified) Cache.
Definition: hwloc.h:237
Remove all objects that became Memory-less. By default, only objects that contain no PU and no memory...
Definition: hwloc.h:2549
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:2310
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
unsigned char set_proc_membind
Definition: hwloc.h:2324
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:2318
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
Instruction cache (filtered out by default).
Definition: hwloc.h:361
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:244
struct hwloc_obj ** children
Normal children, children[0 .. arity -1].
Definition: hwloc.h:491
int hwloc_topology_restrict(hwloc_topology_t restrict topology, hwloc_const_bitmap_t set, unsigned long flags)
Restrict the topology to the given CPU set or nodeset.
unsigned short domain
Domain number the downstream PCI buses. Only 16bits PCI domains are supported by default.
Definition: hwloc.h:701
Do not ever modify the process or thread binding during discovery.
Definition: hwloc.h:2204
hwloc_uint64_t gp_index
Global persistent index. Generated by hwloc, unique across the topology (contrary to os_index) and pe...
Definition: hwloc.h:622
struct hwloc_obj_attr_u::hwloc_cache_attr_s cache
Virtual depth for Misc object.
Definition: hwloc.h:885
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.
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:69
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1529
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:433
unsigned char imported_support
Definition: hwloc.h:2355
Data cache.
Definition: hwloc.h:360
struct hwloc_topology_misc_support * misc
Definition: hwloc.h:2368
Mark all objects as allowed in the topology.
Definition: hwloc.h:2607
Ignore memory attributes and tiers.
Definition: hwloc.h:2218
int depth
Vertical index in the hierarchy.
Definition: hwloc.h:454
unsigned char get_thisthread_membind
Definition: hwloc.h:2330
Memory-side cache (filtered out by default). A cache in front of a specific NUMA node.
Definition: hwloc.h:331
unsigned char nexttouch_membind
Definition: hwloc.h:2344
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.
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:1536
unsigned char get_thisproc_cpubind
Definition: hwloc.h:2292
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())...
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.
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.
unsigned kind
Internally-used kind of group.
Definition: hwloc.h:663
Detect the whole system, ignore reservations, include disallowed objects.
Definition: hwloc.h:2077
Blacklist the target component from being used.
Definition: hwloc.h:2015
int hwloc_topology_abi_check(hwloc_topology_t topology)
Verify that the topology is compatible with the current hwloc library.
unsigned char set_thisproc_cpubind
Definition: hwloc.h:2290
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:653
unsigned short vendor_id
Vendor ID (xxxx in [xxxx:yyyy]).
Definition: hwloc.h:680
struct hwloc_obj_attr_u::hwloc_group_attr_s group
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...
Avoid any effect on memory binding.
Definition: hwloc.h:1282
Allow a custom set of objects, given to hwloc_topology_allow() as cpuset and/or nodeset parameters...
Definition: hwloc.h:2620
unsigned misc_arity
Number of Misc children. These children are listed in misc_first_child.
Definition: hwloc.h:537
Only ignore objects if their entire level does not bring any structure.
Definition: hwloc.h:2439
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which process the topology is viewed from.
unsigned depth
Definition: hwloc.h:712
Remove all objects that became CPU-less. By default, only objects that contain no PU and no memory ar...
Definition: hwloc.h:2536
unsigned char alloc_membind
Definition: hwloc.h:2336
Level 3 instruction Cache (filtered out by default).
Definition: hwloc.h:242
PCI-side of a bridge.
Definition: hwloc.h:367
int hwloc_obj_add_other_obj_sets(hwloc_obj_t dst, hwloc_obj_t src)
Setup object cpusets/nodesets by OR'ing another object's sets.
int hwloc_topology_set_components(hwloc_topology_t restrict topology, unsigned long flags, const char *restrict name)
Prevent a discovery component from being used for a topology.
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1570
int hwloc_type_sscanf(const char *string, hwloc_obj_type_t *typep, union hwloc_obj_attr_u *attrp, size_t attrsize)
Return an object type and attributes from a type string.
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:575
static const char * hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name)
Search the given name in object infos and return the corresponding value.
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:617
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1565
Import support from the imported topology.
Definition: hwloc.h:2142
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2530
unsigned char set_proc_cpubind
Definition: hwloc.h:2294
Level 5 Data (or Unified) Cache.
Definition: hwloc.h:238
unsigned short domain
Domain number (xxxx in the PCI BDF notation xxxx:yy:zz.t). Only 16bits PCI domains are supported by d...
Definition: hwloc.h:670
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1584
Miscellaneous objects (filtered out by default). Objects without particular meaning, that can e.g. be added by the application for its own use, or by hwloc for miscellaneous objects such as MemoryModule (DIMMs).
Definition: hwloc.h:316
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().
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
Operating system block device, or non-volatile memory device. For instance "sda" or "dax2...
Definition: hwloc.h:372
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:478
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:365
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...
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.
hwloc_allow_flags_e
Flags to be given to hwloc_topology_allow().
Definition: hwloc.h:2602
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:222
int hwloc_topology_set_cache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all CPU cache object types.
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
Do not consider resources outside of the process CPU binding.
Definition: hwloc.h:2167
static hwloc_obj_t hwloc_get_next_obj_by_depth(hwloc_topology_t topology, int depth, hwloc_obj_t prev)
Returns the next object at depth depth.
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:597
unsigned char disallowed_pu
Detecting and identifying PU objects that are not available to the current process is supported...
Definition: hwloc.h:2276
unsigned char numa
Detecting the number of NUMA nodes is supported.
Definition: hwloc.h:2272
NUMA node-specific Object Attributes.
Definition: hwloc.h:636
unsigned os_index
OS-provided physical index number. It is not guaranteed unique across the entire machine, except for PUs and NUMA nodes. Set to HWLOC_UNKNOWN_INDEX if unknown or irrelevant for this object.
Definition: hwloc.h:436
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
unsigned arity
Number of normal children. Memory, Misc and I/O children are not listed here but rather in their dedi...
Definition: hwloc.h:487
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 hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
int hwloc_topology_free_group_object(hwloc_topology_t topology, hwloc_obj_t group)
Free a group object allocated with hwloc_topology_alloc_group_object().
unsigned char bind_membind
Definition: hwloc.h:2340
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.
Virtual depth for PCI device object level.
Definition: hwloc.h:883
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:655
unsigned char secondary_bus
First PCI bus number below the bridge.
Definition: hwloc.h:707
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:469
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:2365
hwloc_obj_bridge_type_t upstream_type
Upstream Bridge type.
Definition: hwloc.h:697
unsigned char numa_memory
Detecting the amount of memory in NUMA nodes is supported.
Definition: hwloc.h:2274
Restrict by nodeset instead of CPU set. Only keep objects whose nodeset is included or partially incl...
Definition: hwloc.h:2542
struct hwloc_obj * parent
Parent, NULL if root (Machine object)
Definition: hwloc.h:481
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:374
PCI device (filtered out by default).
Definition: hwloc.h:295
int symmetric_subtree
Set if the subtree of normal objects below this object is symmetric, which means all normal children ...
Definition: hwloc.h:496
Bridge (filtered out by default). Any bridge (or PCI switch) that connects the host or an I/O bus...
Definition: hwloc.h:283
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:477
int hwloc_type_sscanf_as_depth(const char *string, hwloc_obj_type_t *typep, hwloc_topology_t topology, int *depthp)
Return an object type and its level depth from a type string.
unsigned char subordinate_bus
Highest PCI bus number below the bridge.
Definition: hwloc.h:708
unsigned char set_thisproc_membind
Definition: hwloc.h:2320
hwloc_get_type_depth_e
Definition: hwloc.h:878
unsigned sibling_rank
Index in parent's children[] array. Or the index in parent's Memory, I/O or Misc children list...
Definition: hwloc.h:482
unsigned subkind
Internally-used subkind to distinguish different levels of groups with same kind. ...
Definition: hwloc.h:664
Bridge specific Object Attributes.
Definition: hwloc.h:693
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR'ed flags to non-yet-loaded topology.
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
float linkspeed
Link speed in GB/s. This datarate is the currently configured speed of the entire PCI link (sum of th...
Definition: hwloc.h:685
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...
unsigned char get_area_memlocation
Definition: hwloc.h:2348
unsigned char get_thisthread_cpubind
Definition: hwloc.h:2300
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_topology_refresh(hwloc_topology_t topology)
Refresh internal structures after topology modification.
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:2306
unsigned char disallowed_numa
Detecting and identifying NUMA nodes that are not available to the current process is supported...
Definition: hwloc.h:2278
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:178
Core. A computation unit (may be shared by several PUs, aka logical processors).
Definition: hwloc.h:218
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:547
struct hwloc_obj_attr_u::hwloc_bridge_attr_s bridge
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:2367
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
struct hwloc_obj * last_child
Last normal child.
Definition: hwloc.h:493
Level 2 Data (or Unified) Cache.
Definition: hwloc.h:235
char * value
Info value.
Definition: hwloc.h:726
NUMA node. An object that contains memory that is directly and byte-accessible to the host processors...
Definition: hwloc.h:257
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:645
struct hwloc_info_s * infos
Array of info attributes (name and value strings).
Definition: hwloc.h:613
Object info attribute (name and value strings)
Definition: hwloc.h:724
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:383