50 #include <hwloc/autogen/config.h>
51 #include <sys/types.h>
59 #include <hwloc/rename.h>
65 #include <hwloc/bitmap.h>
78 #define HWLOC_API_VERSION 0x00010900
84 #define HWLOC_COMPONENT_ABI 3
572 struct hwloc_topology;
815 HWLOC_DECLSPEC
int hwloc_topology_set_fsroot(hwloc_topology_t __hwloc_restrict topology,
const char * __hwloc_restrict fsroot_path);
872 HWLOC_DECLSPEC
int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology,
const char * __hwloc_restrict xmlpath);
900 HWLOC_DECLSPEC
int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology,
const char * __hwloc_restrict buffer,
int size);
942 unsigned *os_index,
float *distances);
1052 HWLOC_DECLSPEC
unsigned hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1095 static __hwloc_inline
int
1107 static __hwloc_inline
int
1125 static __hwloc_inline
int
1133 static __hwloc_inline hwloc_obj_t
1137 HWLOC_DECLSPEC hwloc_obj_t
hwloc_get_obj_by_depth (hwloc_topology_t topology,
unsigned depth,
unsigned idx) __hwloc_attribute_pure;
1145 static __hwloc_inline hwloc_obj_t
1152 static __hwloc_inline hwloc_obj_t
1161 static __hwloc_inline hwloc_obj_t
1205 void *typeattrp,
size_t typeattrsize);
1231 HWLOC_DECLSPEC
int hwloc_obj_attr_snprintf(
char * __hwloc_restrict
string,
size_t size, hwloc_obj_t obj,
const char * __hwloc_restrict separator,
1241 HWLOC_DECLSPEC
int hwloc_obj_cpuset_snprintf(
char * __hwloc_restrict str,
size_t size,
size_t nobj,
const hwloc_obj_t * __hwloc_restrict objs);
1249 static __hwloc_inline
const char *
1266 HWLOC_DECLSPEC
void hwloc_obj_add_info(hwloc_obj_t obj,
const char *name,
const char *value);
1382 HWLOC_DECLSPEC
int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set,
int flags);
1389 HWLOC_DECLSPEC
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set,
int flags);
1402 HWLOC_DECLSPEC
int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set,
int flags);
1415 HWLOC_DECLSPEC
int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set,
int flags);
1417 #ifdef hwloc_thread_t
1425 HWLOC_DECLSPEC
int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set,
int flags);
1428 #ifdef hwloc_thread_t
1436 HWLOC_DECLSPEC
int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set,
int flags);
1937 HWLOC_DECLSPEC
void *
hwloc_alloc(hwloc_topology_t topology,
size_t len);
1967 static __hwloc_inline
void *
1974 static __hwloc_inline
void *
1980 HWLOC_DECLSPEC
int hwloc_free(hwloc_topology_t topology,
void *addr,
size_t len);
2065 HWLOC_DECLSPEC
int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset,
unsigned long flags);
2074 HWLOC_DECLSPEC
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
2109 HWLOC_DECLSPEC
int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2197 void (*export_cb)(
void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2224 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);
2239 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);
2262 void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj,
const char *name,
const void *buffer,
size_t length));
2274 #include <hwloc/helper.h>
2277 #include <hwloc/inlines.h>
2280 #include <hwloc/diff.h>
2283 #include <hwloc/deprecated.h>
unsigned short class_id
Definition: hwloc.h:498
hwloc_obj_osdev_type_t type
Definition: hwloc.h:520
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:978
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@0 upstream
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.
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:244
Avoid any effect on CPU binding.
Definition: hwloc.h:1642
Detect the whole PCI hierarchy.
Definition: hwloc.h:743
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
Detect instruction caches.
Definition: hwloc.h:751
unsigned char get_proc_membind
Definition: hwloc.h:994
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.
signed os_level
OS-provided physical level, -1 if unknown or meaningless.
Definition: hwloc.h:350
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:357
unsigned char get_thisproc_membind
Definition: hwloc.h:990
Replicate memory on the given nodes; reads from this memory will attempt to be serviced from the NUMA...
Definition: hwloc.h:1578
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:152
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:1325
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:485
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.
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:252
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:321
Detect PCI bridges.
Definition: hwloc.h:734
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:133
unsigned char firsttouch_membind
Definition: hwloc.h:1006
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...
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_uint64_t count
Number of pages of this size.
Definition: hwloc.h:323
unsigned arity
Number of children.
Definition: hwloc.h:363
void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer)
Free a buffer allocated by hwloc_topology_export_xmlbuffer()
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.
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:322
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
struct hwloc_distances_s ** distances
Distances between all objects at same depth below this object.
Definition: hwloc.h:462
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2035
unsigned char secondary_bus
Definition: hwloc.h:512
struct hwloc_obj_memory_s::hwloc_obj_memory_page_type_s * page_types
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.
unsigned char interleave_membind
Definition: hwloc.h:1010
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1328
PCI Device specific Object Attributes.
Definition: hwloc.h:495
Bridge specific Object Attribues.
Definition: hwloc.h:504
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:982
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, unsigned depth)
Returns the width of level at depth depth.
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:258
unsigned depth
Vertical index in the hierarchy. If the topology is symmetric, this is equal to the parent depth plus...
Definition: hwloc.h:343
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:685
unsigned short subdevice_id
Definition: hwloc.h:499
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:713
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1027
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:488
char * name
Object description if any.
Definition: hwloc.h:335
float latency_base
The multiplier that should be applied to latency matrix to retrieve the original OS-provided latencie...
Definition: hwloc.h:552
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 ).
Group-specific Object Attributes.
Definition: hwloc.h:491
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:484
unsigned short vendor_id
Definition: hwloc.h:499
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:515
unsigned char get_area_membind
Definition: hwloc.h:1002
hwloc_compare_types_e
Definition: hwloc.h:295
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
Adapt distance matrices according to objects being removed during restriction. If this flag is not se...
Definition: hwloc.h:2029
unsigned char set_area_membind
Definition: hwloc.h:1000
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:45
unsigned char bus
Definition: hwloc.h:497
Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allo...
Definition: hwloc.h:1552
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
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.
unsigned relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:539
Reset the memory allocation policy to the system default.
Definition: hwloc.h:1542
int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology)
Ignore all objects that do not bring any structure.
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...
struct hwloc_obj_attr_u::hwloc_bridge_attr_s bridge
unsigned depth
Definition: hwloc.h:516
struct hwloc_obj_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:465
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.
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...
PCI-side of a bridge.
Definition: hwloc.h:254
Virtual depth for bridge object level.
Definition: hwloc.h:1081
char * value
Info value.
Definition: hwloc.h:561
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:196
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:483
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:960
unsigned char get_thisproc_cpubind
Definition: hwloc.h:964
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.
Allocate memory on the specified nodes.
Definition: hwloc.h:1556
unsigned char get_thread_cpubind
Definition: hwloc.h:976
OS Device specific Object Attributes.
Definition: hwloc.h:519
float linkspeed
Definition: hwloc.h:501
struct hwloc_obj * prev_sibling
Previous object below the same parent.
Definition: hwloc.h:360
hwloc_nodeset_t allowed_nodeset
The set of allowed NUMA memory nodes.
Definition: hwloc.h:449
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.
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 userdata.
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...
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 page_types_len
Size of array page_types.
Definition: hwloc.h:315
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA device on Linux...
Definition: hwloc.h:266
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.
unsigned char func
Definition: hwloc.h:497
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:956
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
unsigned char replicate_membind
Definition: hwloc.h:1012
unsigned nbobjs
Number of objects considered in the matrix. It is the number of descendant objects at relative_depth ...
Definition: hwloc.h:541
Detect PCI devices.
Definition: hwloc.h:725
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.
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR'ed flags of a topology.
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...
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.
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1029
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
unsigned char set_thisthread_membind
Definition: hwloc.h:996
unsigned char get_proc_cpubind
Definition: hwloc.h:968
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:366
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:1585
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
Object info.
Definition: hwloc.h:559
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.
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.
unsigned char set_thread_cpubind
Definition: hwloc.h:974
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:339
struct hwloc_obj * first_child
First child.
Definition: hwloc.h:365
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2024
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:375
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:508
unsigned char dev
Definition: hwloc.h:497
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_topology_set_custom(hwloc_topology_t topology)
Prepare the topology for custom assembly.
NUMA node. A set of processors around memory which the processors can directly access.
Definition: hwloc.h:172
float * latency
Matrix of latencies between objects, stored as a one-dimension array. May be NULL if the distances co...
Definition: hwloc.h:546
Avoid any effect on memory binding.
Definition: hwloc.h:1374
Operating system co-processor device. For instance "mic0" for a Xeon Phi (MIC) on Linux...
Definition: hwloc.h:270
unsigned short domain
Definition: hwloc.h:496
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:220
Whole system (may be a cluster of machines). The whole system that is accessible to hwloc...
Definition: hwloc.h:162
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:187
unsigned char subordinate_bus
Definition: hwloc.h:512
Machine. The typical root object type. A set of processors and memory with cache coherency.
Definition: hwloc.h:167
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:407
char * name
Info name.
Definition: hwloc.h:560
unsigned char set_proc_membind
Definition: hwloc.h:992
Detect the whole system, ignore reservations and offline settings.
Definition: hwloc.h:693
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
Distances between objects.
Definition: hwloc.h:538
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:369
unsigned char bind_membind
Definition: hwloc.h:1008
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.
hwloc_get_type_depth_e
Definition: hwloc.h:1078
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
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...
Virtual depth for software device object level.
Definition: hwloc.h:1083
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:980
unsigned char nexttouch_membind
Definition: hwloc.h:1014
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())...
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.
unsigned char migrate_membind
Definition: hwloc.h:1017
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1080
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.
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1539
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1565
unsigned char get_thisthread_membind
Definition: hwloc.h:998
struct hwloc_obj_attr_u::hwloc_group_attr_s group
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.
unsigned char set_proc_cpubind
Definition: hwloc.h:966
int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
Unified cache.
Definition: hwloc.h:245
unsigned logical_index
Horizontal index in the whole list of similar objects, could be a "cousin_rank" since it's the rank...
Definition: hwloc.h:348
Object type-specific Attributes.
Definition: hwloc.h:480
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.
int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath)
Export the topology into an XML file.
Data cache.
Definition: hwloc.h:246
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:261
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
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.
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which pid the topology is viewed from.
Set of flags describing actual support for this topology.
Definition: hwloc.h:1026
unsigned sibling_rank
Index in parent's children[] array.
Definition: hwloc.h:358
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
Flags describing actual discovery support for this topology.
Definition: hwloc.h:954
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:418
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:477
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.
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:364
Operating system device. These objects have neither CPU sets nor node sets. They are not added to the...
Definition: hwloc.h:225
Object memory.
Definition: hwloc.h:310
int symmetric_subtree
Set if the subtree of objects below this object is symmetric, which means all children and their chil...
Definition: hwloc.h:468
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.
unsigned depth
Depth of group object.
Definition: hwloc.h:492
Bridge. Any bridge that connects the host or an I/O bus, to another I/O bus. Bridge objects have neit...
Definition: hwloc.h:213
unsigned char set_thisproc_membind
Definition: hwloc.h:988
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1615
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.
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:253
struct hwloc_obj * next_sibling
Next object below the same parent.
Definition: hwloc.h:359
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:118
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1610
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:353
unsigned short subvendor_id
Definition: hwloc.h:499
unsigned infos_count
Size of infos array.
Definition: hwloc.h:466
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:388
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:136
Socket, physical package, or chip. In the physical meaning, i.e. that you can add or remove physicall...
Definition: hwloc.h:176
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, unsigned depth)
Returns the type of objects at depth depth.
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.
Request for strict binding from the OS.
Definition: hwloc.h:1357
struct hwloc_obj_attr_u::hwloc_cache_attr_s cache
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2041
unsigned short domain
Definition: hwloc.h:511
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen)
Export the topology into a newly-allocated XML memory buffer.
Operating system block device. For instance "sda" on Linux.
Definition: hwloc.h:259
Cache-specific Object Attributes.
Definition: hwloc.h:482
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:399
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
unsigned char alloc_membind
Definition: hwloc.h:1004
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:486
unsigned char set_thisthread_cpubind
Definition: hwloc.h:970
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.
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR'ed flags to non-yet-loaded topology.
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...
struct hwloc_pcidev_attr_s pci
Definition: hwloc.h:506
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1605
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:264
unsigned char revision
Definition: hwloc.h:500
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a stringified topology object type.
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:1028
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
Miscellaneous objects. Objects without particular meaning, that can e.g. be added by the application ...
Definition: hwloc.h:208
unsigned distances_count
Definition: hwloc.h:463
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:312
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:47
No object of given type exists in the topology.
Definition: hwloc.h:1079
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:986
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.
unsigned char set_thisproc_cpubind
Definition: hwloc.h:962
Cache. Can be L1i, L1d, L2, L3, ...
Definition: hwloc.h:180
Instruction cache. Only used when the HWLOC_TOPOLOGY_FLAG_ICACHES topology flag is set...
Definition: hwloc.h:247
unsigned os_index
OS-provided physical index number.
Definition: hwloc.h:334
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:116
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:268
struct hwloc_obj_memory_s memory
Memory attributes.
Definition: hwloc.h:337
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:354
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:435
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_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:577
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:183
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.
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1629
int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type.
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...
Bind current thread of current process.
Definition: hwloc.h:1332
unsigned char get_thisthread_cpubind
Definition: hwloc.h:972
Value returned by hwloc_compare_types when types can not be compared.
Definition: hwloc.h:296
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.
unsigned short device_id
Definition: hwloc.h:499
Returned by hwloc_get_membind*() functions when multiple threads or parts of a memory area have diffe...
Definition: hwloc.h:1591
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:333
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
Virtual depth for PCI device object level.
Definition: hwloc.h:1082
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...
unsigned hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
float latency_max
The maximal value in the latency matrix.
Definition: hwloc.h:551
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 ...
Structure of a topology object.
Definition: hwloc.h:331
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
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_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.
hwloc_uint64_t total_memory
Total memory (in bytes) in this object and its children.
Definition: hwloc.h:311