50 #include <hwloc/autogen/config.h>
51 #include <sys/types.h>
59 #include <hwloc/rename.h>
65 #include <hwloc/bitmap.h>
66 #include <hwloc/cpuset.h>
79 #define HWLOC_API_VERSION 0x00010800
85 #define HWLOC_COMPONENT_ABI 3
573 struct hwloc_topology;
943 unsigned *os_index,
float *distances);
1134 static inline hwloc_obj_t
1146 static inline hwloc_obj_t
1153 static inline hwloc_obj_t
1162 static inline hwloc_obj_t
1207 int hwloc_obj_attr_snprintf(
char * restrict
string,
size_t size, hwloc_obj_t obj,
const char * restrict separator,
1225 static inline
const char *
1358 int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set,
int flags);
1365 int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set,
int flags);
1374 int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set,
int flags);
1389 #ifdef hwloc_thread_t
1397 int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set,
int flags);
1400 #ifdef hwloc_thread_t
1907 void *
hwloc_alloc(hwloc_topology_t topology,
size_t len);
1937 static inline
void *
1944 static inline
void *
1950 int hwloc_free(hwloc_topology_t topology,
void *addr,
size_t len);
2035 int hwloc_topology_restrict(hwloc_topology_t restrict topology, hwloc_const_cpuset_t cpuset,
unsigned long flags);
2079 int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2165 void (*export_cb)(
void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2192 int hwloc_export_obj_userdata(
void *reserved, hwloc_topology_t topology, hwloc_obj_t obj,
const char *name,
const void *buffer,
size_t length);
2230 void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj,
const char *name,
const void *buffer,
size_t length));
2242 #include <hwloc/helper.h>
2245 #include <hwloc/inlines.h>
2248 #include <hwloc/diff.h>
2251 #include <hwloc/deprecated.h>
unsigned short domain
Definition: hwloc.h:512
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:184
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:254
unsigned char get_thisproc_cpubind
Definition: hwloc.h:965
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.
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA device on Linux...
Definition: hwloc.h:267
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:265
hwloc_obj_type_t hwloc_obj_type_of_string(const char *string)
Return an object type from the string.
static inline 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 replicate_membind
Definition: hwloc.h:1013
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1304
Detect PCI bridges.
Definition: hwloc.h:735
hwloc_uint64_t total_memory
Total memory (in bytes) in this object and its children.
Definition: hwloc.h:312
struct hwloc_distances_s ** distances
Distances between all objects at same depth below this object.
Definition: hwloc.h:463
Detect instruction caches.
Definition: hwloc.h:752
float latency_max
The maximal value in the latency matrix.
Definition: hwloc.h:552
static inline 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.
static inline hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
Object info.
Definition: hwloc.h:560
unsigned depth
Definition: hwloc.h:517
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
unsigned distances_count
Definition: hwloc.h:464
int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen)
Export the topology into a newly-allocated XML memory buffer.
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.
char * value
Info value.
Definition: hwloc.h:562
int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology)
Ignore all objects that do not bring any structure.
Whole system (may be a cluster of machines). The whole system that is accessible to hwloc...
Definition: hwloc.h:163
unsigned char set_thisthread_cpubind
Definition: hwloc.h:971
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:961
unsigned char alloc_membind
Definition: hwloc.h:1005
Avoid any effect on CPU binding.
Definition: hwloc.h:1612
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...
unsigned depth
Depth of group object.
Definition: hwloc.h:493
Value returned by hwloc_compare_types when types can not be compared.
Definition: hwloc.h:297
hwloc_nodeset_t allowed_nodeset
The set of allowed NUMA memory nodes.
Definition: hwloc.h:450
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())...
OS Device specific Object Attributes.
Definition: hwloc.h:520
unsigned arity
Number of children.
Definition: hwloc.h:364
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.
Unified cache.
Definition: hwloc.h:246
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.
hwloc_compare_types_e
Definition: hwloc.h:296
unsigned char secondary_bus
Definition: hwloc.h:513
struct hwloc_obj_memory_s::hwloc_obj_memory_page_type_s * page_types
struct hwloc_obj_attr_u::hwloc_bridge_attr_s bridge
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
static inline 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 short device_id
Definition: hwloc.h:500
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.
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:367
Adapt distance matrices according to objects being removed during restriction. If this flag is not se...
Definition: hwloc.h:1999
struct hwloc_obj_attr_u::hwloc_cache_attr_s cache
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:1994
int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
Bridge. Any bridge that connects the host or an I/O bus, to another I/O bus. Bridge objects have neit...
Definition: hwloc.h:214
unsigned char get_thisthread_membind
Definition: hwloc.h:999
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.
Distances between objects.
Definition: hwloc.h:539
static inline 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.
Detect the whole PCI hierarchy.
Definition: hwloc.h:744
unsigned depth
Vertical index in the hierarchy. If the topology is symmetric, this is equal to the parent depth plus...
Definition: hwloc.h:344
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
unsigned char bus
Definition: hwloc.h:498
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 * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:478
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:509
unsigned char set_thisproc_cpubind
Definition: hwloc.h:963
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1028
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
Socket, physical package, or chip. In the physical meaning, i.e. that you can add or remove physicall...
Definition: hwloc.h:177
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:578
Reset the memory allocation policy to the system default.
Definition: hwloc.h:1512
unsigned char get_thisthread_cpubind
Definition: hwloc.h:973
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:714
float * latency
Matrix of latencies between objects, stored as a one-dimension array. May be NULL if the distances co...
Definition: hwloc.h:547
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:358
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR'ed flags of a topology.
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.
struct hwloc_obj * prev_sibling
Previous object below the same parent.
Definition: hwloc.h:361
Set of flags describing actual support for this topology.
Definition: hwloc.h:1027
char * name
Info name.
Definition: hwloc.h:561
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:316
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_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.
unsigned char set_area_membind
Definition: hwloc.h:1001
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:259
static inline 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.
PCI Device specific Object Attributes.
Definition: hwloc.h:496
NUMA node. A set of processors around memory which the processors can directly access.
Definition: hwloc.h:173
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:370
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.
Object memory.
Definition: hwloc.h:311
void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value)
Add the given info name and value pair to the given object.
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:979
Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allo...
Definition: hwloc.h:1522
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...
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:323
Operating system co-processor device. For instance "mic0" for a Xeon Phi (MIC) on Linux...
Definition: hwloc.h:271
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.
Allocate memory on the specified nodes.
Definition: hwloc.h:1526
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1030
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().
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1575
int hwloc_get_area_membind_nodeset(hwloc_topology_t topology, const void *addr, size_t len, hwloc_nodeset_t nodeset, hwloc_membind_policy_t *policy, int flags)
Query the physical NUMA node(s) and binding policy of the memory identified by (addr, len ).
int hwloc_topology_set_custom(hwloc_topology_t topology)
Prepare the topology for custom assembly.
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.
Virtual depth for bridge object level.
Definition: hwloc.h:1082
Instruction cache. Only used when the HWLOC_TOPOLOGY_FLAG_ICACHES topology flag is set...
Definition: hwloc.h:248
static inline int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:487
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:340
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
Avoid any effect on memory binding.
Definition: hwloc.h:1350
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...
unsigned short subdevice_id
Definition: hwloc.h:500
unsigned char set_proc_membind
Definition: hwloc.h:993
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1301
Object type-specific Attributes.
Definition: hwloc.h:481
char * name
Object description if any.
Definition: hwloc.h:336
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:485
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:197
unsigned char get_proc_membind
Definition: hwloc.h:995
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:516
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.
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1081
int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the current process or thread to prefer the NUMA node(s) spe...
unsigned char subordinate_bus
Definition: hwloc.h:513
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:137
unsigned relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:540
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_obj * first_child
First child.
Definition: hwloc.h:366
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:153
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:1555
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.
Detect PCI devices.
Definition: hwloc.h:726
unsigned nbobjs
Number of objects considered in the matrix. It is the number of descendant objects at relative_depth ...
Definition: hwloc.h:542
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer)
Free a buffer allocated by hwloc_topology_export_xmlbuffer()
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which pid the topology is viewed from.
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:686
struct hwloc_obj_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:466
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:484
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:245
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:269
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.
static inline void * hwloc_alloc_membind_policy_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Allocate some memory on the given nodeset nodeset.
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR'ed flags to non-yet-loaded topology.
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:408
Cache-specific Object Attributes.
Definition: hwloc.h:483
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1535
hwloc_obj_osdev_type_t type
Definition: hwloc.h:521
int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath)
Export the topology into an XML file.
unsigned char nexttouch_membind
Definition: hwloc.h:1015
unsigned char get_thisproc_membind
Definition: hwloc.h:991
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
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...
Structure of a topology object.
Definition: hwloc.h:332
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a stringified topology object type.
Request for strict binding from the OS.
Definition: hwloc.h:1333
int symmetric_subtree
Set if the subtree of objects below this object is symmetric, which means all children and their chil...
Definition: hwloc.h:469
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:987
struct hwloc_obj_attr_u::hwloc_group_attr_s group
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...
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:983
hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, const char *name)
Add a MISC object to the topology.
static inline 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.
Detect the whole system, ignore reservations and offline settings.
Definition: hwloc.h:694
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:376
int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type.
Operating system block device. For instance "sda" on Linux.
Definition: hwloc.h:260
unsigned char func
Definition: hwloc.h:498
float latency_base
The multiplier that should be applied to latency matrix to retrieve the original OS-provided latencie...
Definition: hwloc.h:553
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:322
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:262
Virtual depth for software device object level.
Definition: hwloc.h:1084
unsigned short subvendor_id
Definition: hwloc.h:500
unsigned sibling_rank
Index in parent's children[] array.
Definition: hwloc.h:359
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2011
unsigned char bind_membind
Definition: hwloc.h:1009
unsigned short vendor_id
Definition: hwloc.h:500
Operating system device. These objects have neither CPU sets nor node sets. They are not added to the...
Definition: hwloc.h:226
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.
unsigned char set_thisthread_membind
Definition: hwloc.h:997
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:365
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
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.
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:400
unsigned char set_thisproc_membind
Definition: hwloc.h:989
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.
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.
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
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.
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2005
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_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:119
struct hwloc_obj * next_sibling
Next object below the same parent.
Definition: hwloc.h:360
Bridge specific Object Attribues.
Definition: hwloc.h:505
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@0 upstream
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:354
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.
unsigned short domain
Definition: hwloc.h:497
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:313
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1585
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:389
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
Data cache.
Definition: hwloc.h:247
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:981
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:134
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1580
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:486
unsigned os_index
OS-provided physical index number.
Definition: hwloc.h:335
Virtual depth for PCI device object level.
Definition: hwloc.h:1083
struct hwloc_obj_memory_s memory
Memory attributes.
Definition: hwloc.h:338
float linkspeed
Definition: hwloc.h:502
Cache. Can be L1i, L1d, L2, L3, ...
Definition: hwloc.h:181
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.
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, unsigned depth)
Returns the width of level at depth depth.
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:436
Bind current thread of current process.
Definition: hwloc.h:1308
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:349
struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:957
Returned by hwloc_get_membind*() functions when multiple threads or parts of a memory area have diffe...
Definition: hwloc.h:1561
struct hwloc_pcidev_attr_s pci
Definition: hwloc.h:507
Flags describing actual discovery support for this topology.
Definition: hwloc.h:955
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 ...
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
unsigned char revision
Definition: hwloc.h:501
static inline 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.
unsigned char interleave_membind
Definition: hwloc.h:1011
unsigned char set_thread_cpubind
Definition: hwloc.h:975
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:221
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:419
unsigned hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
unsigned char get_area_membind
Definition: hwloc.h:1003
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:45
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_get_type_depth_e
Definition: hwloc.h:1079
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
unsigned char migrate_membind
Definition: hwloc.h:1018
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...
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:188
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:324
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:117
unsigned char firsttouch_membind
Definition: hwloc.h:1007
unsigned char get_thread_cpubind
Definition: hwloc.h:977
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:355
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:253
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1599
PCI-side of a bridge.
Definition: hwloc.h:255
unsigned char get_proc_cpubind
Definition: hwloc.h:969
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1509
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, unsigned depth)
Returns the type of objects at depth depth.
int hwloc_get_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_cpuset_t cpuset, hwloc_membind_policy_t *policy, int flags)
Query the CPUs near the physical NUMA node(s) and binding policy of the memory identified by (addr...
unsigned short class_id
Definition: hwloc.h:499
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:489
unsigned char dev
Definition: hwloc.h:498
Replicate memory on the given nodes; reads from this memory will attempt to be serviced from the NUMA...
Definition: hwloc.h:1548
No object of given type exists in the topology.
Definition: hwloc.h:1080
unsigned infos_count
Size of infos array.
Definition: hwloc.h:467
Machine. The typical root object type. A set of processors and memory with cache coherency.
Definition: hwloc.h:168
Group-specific Object Attributes.
Definition: hwloc.h:492
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:1029
unsigned char set_proc_cpubind
Definition: hwloc.h:967
Miscellaneous objects. Objects without particular meaning, that can e.g. be added by the application ...
Definition: hwloc.h:209
signed os_level
OS-provided physical level, -1 if unknown or meaningless.
Definition: hwloc.h:351
struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:47
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:334