53 #include <hwloc/autogen/config.h> 54 #include <sys/types.h> 62 #include <hwloc/rename.h> 68 #include <hwloc/bitmap.h> 88 #define HWLOC_API_VERSION 0x00010b06 97 #define HWLOC_COMPONENT_ABI 4 320 HWLOC_DECLSPEC
int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
545 unsigned short vendor_id, device_id, subvendor_id, subdevice_id;
627 struct hwloc_topology;
680 HWLOC_DECLSPEC
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
917 HWLOC_DECLSPEC
int hwloc_topology_set_fsroot(hwloc_topology_t __hwloc_restrict topology,
const char * __hwloc_restrict fsroot_path);
974 HWLOC_DECLSPEC
int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology,
const char * __hwloc_restrict xmlpath);
1044 hwloc_obj_type_t type,
unsigned nbobjs,
1045 unsigned *os_index,
float *distances);
1194 HWLOC_DECLSPEC
unsigned hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1244 static __hwloc_inline
int 1261 static __hwloc_inline
int 1270 HWLOC_DECLSPEC hwloc_obj_type_t
hwloc_get_depth_type (hwloc_topology_t topology,
unsigned depth) __hwloc_attribute_pure;
1281 static __hwloc_inline
int 1289 static __hwloc_inline hwloc_obj_t
1293 HWLOC_DECLSPEC hwloc_obj_t
hwloc_get_obj_by_depth (hwloc_topology_t topology,
unsigned depth,
unsigned idx) __hwloc_attribute_pure;
1301 static __hwloc_inline hwloc_obj_t
1302 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type,
unsigned idx) __hwloc_attribute_pure;
1308 static __hwloc_inline hwloc_obj_t
1317 static __hwloc_inline hwloc_obj_t
1365 HWLOC_DECLSPEC
int hwloc_obj_attr_snprintf(
char * __hwloc_restrict
string,
size_t size, hwloc_obj_t obj,
const char * __hwloc_restrict separator,
1375 HWLOC_DECLSPEC
int hwloc_obj_cpuset_snprintf(
char * __hwloc_restrict str,
size_t size,
size_t nobj,
const hwloc_obj_t * __hwloc_restrict objs);
1407 hwloc_obj_type_t *typep,
1409 void *typeattrp,
size_t typeattrsize);
1426 static __hwloc_inline
const char *
1443 HWLOC_DECLSPEC
void hwloc_obj_add_info(hwloc_obj_t obj,
const char *name,
const char *value);
1573 HWLOC_DECLSPEC
int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t
set,
int flags);
1580 HWLOC_DECLSPEC
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t
set,
int flags);
1593 HWLOC_DECLSPEC
int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t
set,
int flags);
1606 HWLOC_DECLSPEC
int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t
set,
int flags);
1608 #ifdef hwloc_thread_t 1616 HWLOC_DECLSPEC
int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t
set,
int flags);
1619 #ifdef hwloc_thread_t 1627 HWLOC_DECLSPEC
int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t
set,
int flags);
2199 HWLOC_DECLSPEC
void *
hwloc_alloc(hwloc_topology_t topology,
size_t len);
2236 static __hwloc_inline
void *
2248 static __hwloc_inline
void *
2254 HWLOC_DECLSPEC
int hwloc_free(hwloc_topology_t topology,
void *addr,
size_t len);
2339 HWLOC_DECLSPEC
int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset,
unsigned long flags);
2374 HWLOC_DECLSPEC
int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2471 void (*export_cb)(
void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2498 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);
2513 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);
2538 void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj,
const char *name,
const void *buffer,
size_t length));
2598 #include <hwloc/helper.h> 2601 #include <hwloc/inlines.h> 2604 #include <hwloc/diff.h> 2607 #include <hwloc/deprecated.h> 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.
Operating system device. These objects have neither CPU sets nor node sets. They are not added to the...
Definition: hwloc.h:251
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
Bridge specific Object Attribues.
Definition: hwloc.h:550
Detect PCI devices.
Definition: hwloc.h:805
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:211
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...
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:531
Avoid any effect on memory binding.
Definition: hwloc.h:1565
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:756
Export extended types such as L2dcache as basic types such as Cache.
Definition: hwloc.h:2557
Virtual depth for bridge object level.
Definition: hwloc.h:1225
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 set_thisthread_cpubind
Definition: hwloc.h:1077
Miscellaneous objects. Objects without particular meaning, that can e.g. be added by the application ...
Definition: hwloc.h:233
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1824
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.
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1224
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:220
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:403
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 depth
Vertical index in the hierarchy.
Definition: hwloc.h:377
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:1067
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:270
Data cache.
Definition: hwloc.h:272
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:246
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
Distances between objects.
Definition: hwloc.h:583
Bridge. Any bridge that connects the host or an I/O bus, to another I/O bus. Bridge objects have neit...
Definition: hwloc.h:239
float latency_base
The multiplier that should be applied to latency matrix to retrieve the original OS-provided latencie...
Definition: hwloc.h:604
No object of given type exists in the topology.
Definition: hwloc.h:1223
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.
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR'ed flags of a topology.
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_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...
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:279
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1139
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1777
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1516
Unified cache.
Definition: hwloc.h:271
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.
unsigned char subordinate_bus
Definition: hwloc.h:558
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.
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:399
Allocate memory on the specified nodes.
Definition: hwloc.h:1768
hwloc_nodeset_t allowed_nodeset
The set of allowed NUMA memory nodes.
Definition: hwloc.h:495
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:373
struct hwloc_distances_s ** distances
Distances between all objects at same depth below this object.
Definition: hwloc.h:508
Set of flags describing actual support for this topology.
Definition: hwloc.h:1138
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.
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.
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.
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.
Operating system block device. For instance "sda" on Linux.
Definition: hwloc.h:285
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:392
Detect PCI bridges.
Definition: hwloc.h:814
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:400
unsigned char set_area_membind
Definition: hwloc.h:1111
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.
Virtual depth for software device object level.
Definition: hwloc.h:1227
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...
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:134
Detect instruction caches.
Definition: hwloc.h:832
float latency_max
The maximal value in the latency matrix.
Definition: hwloc.h:603
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:529
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1819
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.
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...
signed os_level
OS-provided physical level, -1 if unknown or meaningless.
Definition: hwloc.h:396
Replicate memory on the given nodes; reads from this memory will attempt to be serviced from the NUMA...
Definition: hwloc.h:1790
unsigned char firsttouch_membind
Definition: hwloc.h:1117
int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type.
Object memory.
Definition: hwloc.h:337
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2309
unsigned nbobjs
Number of objects considered in the matrix. It is the number of descendant objects at relative_depth ...
Definition: hwloc.h:586
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:339
unsigned arity
Number of children.
Definition: hwloc.h:409
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.
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.
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.
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:632
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_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_get_type_depth_e
Definition: hwloc.h:1222
hwloc_obj_osdev_type_t type
Definition: hwloc.h:566
void * hwloc_alloc_membind_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by nodeset.
unsigned char func
Definition: hwloc.h:543
int hwloc_set_area_membind_nodeset(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) specified by nodeset...
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:132
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:366
unsigned depth
Definition: hwloc.h:562
unsigned depth
Depth of group object.
Definition: hwloc.h:538
Instruction cache. Only used when the HWLOC_TOPOLOGY_FLAG_ICACHES topology flag is set...
Definition: hwloc.h:273
struct hwloc_obj_memory_s::hwloc_obj_memory_page_type_s * page_types
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:534
unsigned char set_thread_cpubind
Definition: hwloc.h:1081
unsigned char get_proc_membind
Definition: hwloc.h:1105
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:295
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.
unsigned char get_thread_cpubind
Definition: hwloc.h:1083
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1519
unsigned distances_count
Definition: hwloc.h:509
int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath)
Export the topology into an XML file.
unsigned short domain
Definition: hwloc.h:542
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:287
Detect the whole PCI hierarchy.
Definition: hwloc.h:824
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:290
Reset the memory allocation policy to the system default. Depending on the operating system...
Definition: hwloc.h:1754
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:350
Request for strict binding from the OS.
Definition: hwloc.h:1548
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:421
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:453
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1141
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:434
struct hwloc_obj_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:511
char * name
Info name.
Definition: hwloc.h:615
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:207
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR'ed flags to non-yet-loaded topology.
unsigned sibling_rank
Index in parent's children[] array.
Definition: hwloc.h:404
unsigned char set_proc_membind
Definition: hwloc.h:1103
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:412
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 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:362
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1803
Cache-specific Object Attributes.
Definition: hwloc.h:528
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...
Value returned by hwloc_compare_types() when types can not be compared.
Definition: hwloc.h:323
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:1085
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:348
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:554
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 ).
Cache. Can be L1i, L1d, L2, L3, ...
Definition: hwloc.h:204
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:481
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:170
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1843
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.
unsigned char get_thisproc_membind
Definition: hwloc.h:1101
Physical package. The physical package that usually gets inserted into a socket on the motherboard...
Definition: hwloc.h:199
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:154
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:561
unsigned char get_proc_cpubind
Definition: hwloc.h:1075
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, unsigned depth)
Returns the width of level at depth depth.
char * value
Info value.
Definition: hwloc.h:616
unsigned char migrate_membind
Definition: hwloc.h:1127
Get the set of allowed resources from the local operating system even if the topology was loaded from...
Definition: hwloc.h:853
hwloc_topology_export_synthetic_flags_e
Flags for exporting synthetic topologies.
Definition: hwloc.h:2551
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
unsigned char get_thisthread_cpubind
Definition: hwloc.h:1079
PCI Device specific Object Attributes.
Definition: hwloc.h:541
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2298
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:1087
unsigned short class_id
Definition: hwloc.h:544
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:1089
int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen)
Export the topology into a newly-allocated XML memory buffer.
hwloc_uint64_t total_memory
Total memory (in bytes) in this object and its children.
Definition: hwloc.h:338
Detect the whole system, ignore reservations and offline settings.
Definition: hwloc.h:772
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())...
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:1059
Consider the bitmap argument as a nodeset.
Definition: hwloc.h:1868
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:445
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.
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.
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
unsigned infos_count
Size of infos array.
Definition: hwloc.h:512
Flags describing actual discovery support for this topology.
Definition: hwloc.h:1057
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:523
float * latency
Matrix of latencies between objects, stored as a one-dimension array. May be NULL if the distances co...
Definition: hwloc.h:591
Do not export level attributes.
Definition: hwloc.h:2565
OS Device specific Object Attributes.
Definition: hwloc.h:565
void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer)
Free a buffer allocated by hwloc_topology_export_xmlbuffer()
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:342
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.
PCI-side of a bridge.
Definition: hwloc.h:280
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 * next_sibling
Next object below the same parent.
Definition: hwloc.h:405
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.
int symmetric_subtree
Set if the subtree of objects below this object is symmetric, which means all children and their chil...
Definition: hwloc.h:514
int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology)
Ignore all objects that do not bring any structure.
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:65
unsigned char set_thisproc_cpubind
Definition: hwloc.h:1069
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:284
Operating system co-processor device. For instance "mic0" for a Xeon Phi (MIC) on Linux...
Definition: hwloc.h:297
float linkspeed
Definition: hwloc.h:547
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:415
unsigned char bind_membind
Definition: hwloc.h:1119
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:1797
struct hwloc_obj * prev_sibling
Previous object below the same parent.
Definition: hwloc.h:406
unsigned char get_area_memlocation
Definition: hwloc.h:1129
Object type-specific Attributes.
Definition: hwloc.h:526
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.
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().
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:1097
unsigned char set_thisthread_membind
Definition: hwloc.h:1107
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:360
Avoid any effect on CPU binding.
Definition: hwloc.h:1856
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
int hwloc_topology_set_custom(hwloc_topology_t topology)
Prepare the topology for custom assembly.
Virtual depth for PCI device object level.
Definition: hwloc.h:1226
unsigned char revision
Definition: hwloc.h:546
unsigned char set_thisproc_membind
Definition: hwloc.h:1099
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, unsigned depth)
Returns the type of objects at depth depth.
Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allo...
Definition: hwloc.h:1764
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 nexttouch_membind
Definition: hwloc.h:1125
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
NUMA node. An object that contains memory that is directly and byte-accessible to the host processors...
Definition: hwloc.h:190
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:464
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1744
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 * first_child
First child.
Definition: hwloc.h:411
Machine. The typical root object type. A set of processors and memory with cache coherency.
Definition: hwloc.h:185
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
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.
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA, or "hfi1_0" Omni-Path ...
Definition: hwloc.h:292
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:530
unsigned short domain
Definition: hwloc.h:557
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2315
int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags)
Export the topology as a synthetic string.
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:349
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:151
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
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.
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1829
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...
unsigned hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
Whole system (may be a cluster of machines). The whole system that is accessible to hwloc...
Definition: hwloc.h:180
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:1140
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 constant stringified object type.
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:792
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:278
unsigned char alloc_membind
Definition: hwloc.h:1115
Group-specific Object Attributes.
Definition: hwloc.h:537
unsigned char get_thisproc_cpubind
Definition: hwloc.h:1071
Structure of a topology object.
Definition: hwloc.h:358
hwloc_compare_types_e
Definition: hwloc.h:322
static void * hwloc_alloc_membind_policy_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by nodeset.
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_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_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:410
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
unsigned char interleave_membind
Definition: hwloc.h:1121
unsigned short vendor_id
Definition: hwloc.h:545
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
unsigned char set_proc_cpubind
Definition: hwloc.h:1073
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
unsigned char replicate_membind
Definition: hwloc.h:1123
Adapt distance matrices according to objects being removed during restriction. If this flag is not se...
Definition: hwloc.h:2303
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.
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which process the topology is viewed from.
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...
int hwloc_set_proc_membind_nodeset(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the specified process to prefer the NUMA node(s) specified b...
unsigned char get_area_membind
Definition: hwloc.h:1113
Object info.
Definition: hwloc.h:614
Bind current thread of current process.
Definition: hwloc.h:1523
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:63
unsigned relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:584
unsigned char get_thisthread_membind
Definition: hwloc.h:1109
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:532