Hardware Locality (hwloc)  v2.8-20240516.1852.gitc5dfa82e
hwloc.h
1 /*
2  * Copyright © 2009 CNRS
3  * Copyright © 2009-2022 Inria. All rights reserved.
4  * Copyright © 2009-2012 Université Bordeaux
5  * Copyright © 2009-2020 Cisco Systems, Inc. All rights reserved.
6  * See COPYING in top-level directory.
7  */
8 
9 /*=====================================================================
10  * PLEASE GO READ THE DOCUMENTATION!
11  * ------------------------------------------------
12  * $tarball_directory/doc/doxygen-doc/
13  * or
14  * https://www.open-mpi.org/projects/hwloc/doc/
15  *=====================================================================
16  *
17  * FAIR WARNING: Do NOT expect to be able to figure out all the
18  * subtleties of hwloc by simply reading function prototypes and
19  * constant descrptions here in this file.
20  *
21  * Hwloc has wonderful documentation in both PDF and HTML formats for
22  * your reading pleasure. The formal documentation explains a LOT of
23  * hwloc-specific concepts, provides definitions, and discusses the
24  * "big picture" for many of the things that you'll find here in this
25  * header file.
26  *
27  * The PDF/HTML documentation was generated via Doxygen; much of what
28  * you'll see in there is also here in this file. BUT THERE IS A LOT
29  * THAT IS IN THE PDF/HTML THAT IS ***NOT*** IN hwloc.h!
30  *
31  * There are entire paragraph-length descriptions, discussions, and
32  * pretty pictures to explain subtle corner cases, provide concrete
33  * examples, etc.
34  *
35  * Please, go read the documentation. :-)
36  *
37  * Moreover there are several examples of hwloc use under doc/examples
38  * in the source tree.
39  *
40  *=====================================================================*/
41 
53 #ifndef HWLOC_H
54 #define HWLOC_H
55 
56 #include "hwloc/autogen/config.h"
57 
58 #include <sys/types.h>
59 #include <stdio.h>
60 #include <string.h>
61 #include <limits.h>
62 
63 /*
64  * Symbol transforms
65  */
66 #include "hwloc/rename.h"
67 
68 /*
69  * Bitmap definitions
70  */
71 
72 #include "hwloc/bitmap.h"
73 
74 
75 #ifdef __cplusplus
76 extern "C" {
77 #endif
78 
79 
115 #define HWLOC_API_VERSION 0x00020800
116 
123 HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);
124 
126 #define HWLOC_COMPONENT_ABI 7
127 
164 
182 
197 typedef enum {
198 
200 #define HWLOC_OBJ_TYPE_MIN HWLOC_OBJ_MACHINE /* Sentinel value */
201 
343  HWLOC_OBJ_TYPE_MAX
345 
352 
358 
378 
401 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
402 
404 #define HWLOC_TYPE_UNORDERED INT_MAX
405 
414 union hwloc_obj_attr_u;
415 
420 struct hwloc_obj {
421  /* physical information */
423  char *subtype;
425  unsigned os_index;
430 #define HWLOC_UNKNOWN_INDEX (unsigned)-1
431 
432  char *name;
437  hwloc_uint64_t total_memory;
442  /* global position */
443  int depth;
458  unsigned logical_index;
465  /* cousins are all objects of the same type (and depth) across the entire topology */
469  /* children of the same parent are siblings, even if they may have different type and depth */
470  struct hwloc_obj *parent;
471  unsigned sibling_rank;
476  unsigned arity;
480  struct hwloc_obj **children;
496  unsigned memory_arity;
514  unsigned io_arity;
526  unsigned misc_arity;
535  /* cpusets and nodesets */
602  struct hwloc_info_s *infos;
603  unsigned infos_count;
605  /* misc */
606  void *userdata;
611  hwloc_uint64_t gp_index;
616 };
620 typedef struct hwloc_obj * hwloc_obj_t;
621 
626  hwloc_uint64_t local_memory;
627  unsigned page_types_len;
634  hwloc_uint64_t size;
635  hwloc_uint64_t count;
636  } * page_types;
637  } numanode;
638 
641  hwloc_uint64_t size;
642  unsigned depth;
643  unsigned linesize;
647  } cache;
650  unsigned depth;
652  unsigned kind;
653  unsigned subkind;
654  unsigned char dont_merge;
655  } group;
658 #ifndef HWLOC_HAVE_32BITS_PCI_DOMAIN
659  unsigned short domain; /* Only 16bits PCI domains are supported by default */
660 #else
661  unsigned int domain; /* 32bits PCI domain support break the library ABI, hence it's disabled by default */
662 #endif
663  unsigned char bus, dev, func;
664  unsigned short class_id;
666  unsigned char revision;
667  float linkspeed; /* in GB/s */
668  } pcidev;
671  union {
673  } upstream;
675  union {
676  struct {
677 #ifndef HWLOC_HAVE_32BITS_PCI_DOMAIN
678  unsigned short domain; /* Only 16bits PCI domains are supported by default */
679 #else
680  unsigned int domain; /* 32bits PCI domain support break the library ABI, hence it's disabled by default */
681 #endif
683  } pci;
684  } downstream;
686  unsigned depth;
687  } bridge;
691  } osdev;
692 };
693 
698 struct hwloc_info_s {
699  char *name;
700  char *value;
701 };
702 
711 struct hwloc_topology;
716 typedef struct hwloc_topology * hwloc_topology_t;
717 
724 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
725 
746 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
747 
752 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
753 
766 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
767 
785 HWLOC_DECLSPEC int hwloc_topology_abi_check(hwloc_topology_t topology);
786 
798 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
799 
822 HWLOC_DECLSPEC int hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
823 
850 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
851 
861 };
862 
882 HWLOC_DECLSPEC int hwloc_get_memory_parents_depth (hwloc_topology_t topology);
883 
897 static __hwloc_inline int
898 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
899 
913 static __hwloc_inline int
914 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
915 
924 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, int depth) __hwloc_attribute_pure;
925 
931 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, int depth) __hwloc_attribute_pure;
932 
939 static __hwloc_inline int
940 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
941 
948 static __hwloc_inline hwloc_obj_t
949 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
950 
956 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, int depth, unsigned idx) __hwloc_attribute_pure;
957 
965 static __hwloc_inline hwloc_obj_t
966 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
967 
974 static __hwloc_inline hwloc_obj_t
975 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, int depth, hwloc_obj_t prev);
976 
985 static __hwloc_inline hwloc_obj_t
987  hwloc_obj_t prev);
988 
1007 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
1008 
1026 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size,
1027  hwloc_obj_t obj,
1028  int verbose);
1029 
1041 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size,
1042  hwloc_obj_t obj, const char * __hwloc_restrict separator,
1043  int verbose);
1044 
1068 HWLOC_DECLSPEC int hwloc_type_sscanf(const char *string,
1069  hwloc_obj_type_t *typep,
1070  union hwloc_obj_attr_u *attrp, size_t attrsize);
1071 
1093 HWLOC_DECLSPEC int hwloc_type_sscanf_as_depth(const char *string,
1094  hwloc_obj_type_t *typep,
1095  hwloc_topology_t topology, int *depthp);
1096 
1115 static __hwloc_inline const char *
1116 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1117 
1134 HWLOC_DECLSPEC int hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1135 
1207 typedef enum {
1211 
1215 
1240 
1258 
1265 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1266 
1275 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1276 
1290 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1291 
1309 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1310 
1311 #ifdef hwloc_thread_t
1312 
1321 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1322 #endif
1323 
1324 #ifdef hwloc_thread_t
1325 
1338 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1339 #endif
1340 
1360 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1361 
1384 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1385 
1465 typedef enum {
1474 
1485 
1489 
1498 
1505 
1514 
1528 typedef enum {
1534 
1539 
1547 
1553 
1566 
1578 
1595 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
1596 
1646 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
1647 
1661 HWLOC_DECLSPEC 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);
1662 
1707 HWLOC_DECLSPEC int hwloc_get_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
1708 
1719 HWLOC_DECLSPEC 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);
1720 
1752 HWLOC_DECLSPEC 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);
1753 
1776 HWLOC_DECLSPEC int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags);
1777 
1787 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
1788 
1804 HWLOC_DECLSPEC void *hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags) __hwloc_attribute_malloc;
1805 
1820 static __hwloc_inline void *
1821 hwloc_alloc_membind_policy(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags) __hwloc_attribute_malloc;
1822 
1828 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
1829 
1871 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
1872 
1904 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
1905 
1933 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
1934 
1962 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
1963 
1971 };
1972 
1990 HWLOC_DECLSPEC int hwloc_topology_set_components(hwloc_topology_t __hwloc_restrict topology, unsigned long flags, const char * __hwloc_restrict name);
1991 
2033 
2053 
2074 
2098 
2123 
2145 
2160 
2167 
2173 
2179 };
2180 
2195 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
2196 
2208 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
2209 
2219 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
2220 
2224  unsigned char pu;
2226  unsigned char numa;
2228  unsigned char numa_memory;
2230  unsigned char disallowed_pu;
2232  unsigned char disallowed_numa;
2234  unsigned char cpukind_efficiency;
2235 };
2236 
2244  unsigned char set_thisproc_cpubind;
2246  unsigned char get_thisproc_cpubind;
2248  unsigned char set_proc_cpubind;
2250  unsigned char get_proc_cpubind;
2252  unsigned char set_thisthread_cpubind;
2254  unsigned char get_thisthread_cpubind;
2256  unsigned char set_thread_cpubind;
2258  unsigned char get_thread_cpubind;
2265 };
2266 
2274  unsigned char set_thisproc_membind;
2276  unsigned char get_thisproc_membind;
2278  unsigned char set_proc_membind;
2280  unsigned char get_proc_membind;
2282  unsigned char set_thisthread_membind;
2284  unsigned char get_thisthread_membind;
2286  unsigned char set_area_membind;
2288  unsigned char get_area_membind;
2290  unsigned char alloc_membind;
2292  unsigned char firsttouch_membind;
2294  unsigned char bind_membind;
2296  unsigned char interleave_membind;
2298  unsigned char nexttouch_membind;
2300  unsigned char migrate_membind;
2302  unsigned char get_area_memlocation;
2303 };
2304 
2309  unsigned char imported_support;
2310 };
2311 
2323 };
2324 
2354 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
2355 
2372 
2380 
2394 
2409 };
2410 
2415 HWLOC_DECLSPEC int hwloc_topology_set_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e filter);
2416 
2421 HWLOC_DECLSPEC int hwloc_topology_get_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e *filter);
2422 
2429 HWLOC_DECLSPEC int hwloc_topology_set_all_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2430 
2437 HWLOC_DECLSPEC int hwloc_topology_set_cache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2438 
2445 HWLOC_DECLSPEC int hwloc_topology_set_icache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2446 
2451 HWLOC_DECLSPEC int hwloc_topology_set_io_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2452 
2463 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
2464 
2473 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
2474 
2491 
2497 
2504 
2510 
2516 };
2517 
2542 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_bitmap_t set, unsigned long flags);
2543 
2551 
2560 
2564 };
2565 
2583 HWLOC_DECLSPEC int hwloc_topology_allow(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset, hwloc_const_nodeset_t nodeset, unsigned long flags);
2584 
2606 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2607 
2619 
2667 
2680 HWLOC_DECLSPEC int hwloc_obj_add_other_obj_sets(hwloc_obj_t dst, hwloc_obj_t src);
2681 
2699 HWLOC_DECLSPEC int hwloc_topology_refresh(hwloc_topology_t topology);
2700 
2705 #ifdef __cplusplus
2706 } /* extern "C" */
2707 #endif
2708 
2709 
2710 /* high-level helpers */
2711 #include "hwloc/helper.h"
2712 
2713 /* inline code of some functions above */
2714 #include "hwloc/inlines.h"
2715 
2716 /* memory attributes */
2717 #include "hwloc/memattrs.h"
2718 
2719 /* kinds of CPU cores */
2720 #include "hwloc/cpukinds.h"
2721 
2722 /* exporting to XML or synthetic */
2723 #include "hwloc/export.h"
2724 
2725 /* distances */
2726 #include "hwloc/distances.h"
2727 
2728 /* topology diffs */
2729 #include "hwloc/diff.h"
2730 
2731 /* deprecated headers */
2732 #include "hwloc/deprecated.h"
2733 
2734 #endif /* HWLOC_H */
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
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.
int hwloc_topology_abi_check(hwloc_topology_t topology)
Verify that the topology is compatible with the current hwloc library.
unsigned char get_proc_cpubind
Definition: hwloc.h:2250
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:439
int hwloc_topology_set_cache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all CPU cache object types.
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:564
char * value
Info value.
Definition: hwloc.h:700
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.
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:354
struct hwloc_obj * first_child
First normal child.
Definition: hwloc.h:481
struct hwloc_obj ** children
Normal children, children[0 .. arity -1].
Definition: hwloc.h:480
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
unsigned char set_thisproc_membind
Definition: hwloc.h:2274
unsigned char get_thisproc_cpubind
Definition: hwloc.h:2246
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR&#39;ed flags to non-yet-loaded topology.
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.
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:366
Only keep likely-important objects of the given type.
Definition: hwloc.h:2408
Level 4 Data (or Unified) Cache.
Definition: hwloc.h:237
int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
Group-specific Object Attributes.
Definition: hwloc.h:649
unsigned char subordinate_bus
Definition: hwloc.h:682
PCI-side of a bridge.
Definition: hwloc.h:356
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:536
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:635
NUMA node-specific Object Attributes.
Definition: hwloc.h:625
struct hwloc_topology_misc_support * misc
Definition: hwloc.h:2322
Ignore CPU Kinds.
Definition: hwloc.h:2178
int hwloc_topology_set_io_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all I/O object types.
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:2224
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:2321
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:2262
Operating system co-processor device. For instance "opencl0d0" for a OpenCL device, "cuda0" for a CUDA device.
Definition: hwloc.h:374
Virtual depth for PCI device object level.
Definition: hwloc.h:857
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:163
Do not consider resources outside of the process memory binding.
Definition: hwloc.h:2144
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2515
Remove all objects that became Memory-less. By default, only objects that contain no PU and no memory...
Definition: hwloc.h:2503
unsigned char get_proc_membind
Definition: hwloc.h:2280
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...
Consider the bitmap argument as a nodeset.
Definition: hwloc.h:1576
struct hwloc_obj * io_first_child
First I/O child. Bridges, PCI and OS devices are listed here (io_arity and io_first_child) instead of...
Definition: hwloc.h:517
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:627
unsigned char interleave_membind
Definition: hwloc.h:2296
unsigned char set_thisthread_membind
Definition: hwloc.h:2282
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1538
unsigned misc_arity
Number of Misc children. These children are listed in misc_first_child.
Definition: hwloc.h:526
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:2319
unsigned char set_thisthread_cpubind
Definition: hwloc.h:2252
struct hwloc_obj * parent
Parent, NULL if root (Machine object)
Definition: hwloc.h:470
Bridge specific Object Attributes.
Definition: hwloc.h:670
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:716
Physical package. The physical package that usually gets inserted into a socket on the motherboard...
Definition: hwloc.h:212
Reset the memory allocation policy to the system default. Depending on the operating system...
Definition: hwloc.h:1473
unsigned short subvendor_id
Definition: hwloc.h:665
Machine. A set of processors and memory with cache coherency.
Definition: hwloc.h:203
Cache-specific Object Attributes.
Definition: hwloc.h:640
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA, "hfi1_0" Omni-Path int...
Definition: hwloc.h:368
Bind current thread of current process.
Definition: hwloc.h:1214
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
hwloc_bitmap_t hwloc_cpuset_t
A CPU set is a bitmap whose bits are set according to CPU physical OS indexes.
Definition: hwloc.h:161
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:71
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:347
hwloc_uint64_t gp_index
Global persistent index. Generated by hwloc, unique across the topology (contrary to os_index) and pe...
Definition: hwloc.h:611
struct hwloc_obj_attr_u::hwloc_bridge_attr_s bridge
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
int hwloc_topology_set_icache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all CPU instruction cache object types.
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, int depth)
Returns the type of objects at depth depth.
unsigned short vendor_id
Definition: hwloc.h:665
struct hwloc_obj_attr_u::hwloc_numanode_attr_s::hwloc_memory_page_type_s * page_types
int depth
Vertical index in the hierarchy.
Definition: hwloc.h:443
unsigned char set_thread_cpubind
Definition: hwloc.h:2256
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1552
unsigned char set_proc_membind
Definition: hwloc.h:2278
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.
Object info attribute (name and value strings)
Definition: hwloc.h:698
unsigned os_index
OS-provided physical index number. It is not guaranteed unique across the entire machine, except for PUs and NUMA nodes. Set to HWLOC_UNKNOWN_INDEX if unknown or irrelevant for this object.
Definition: hwloc.h:425
int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags)
Bind current process or thread on CPUs given in physical bitmap set.
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:644
unsigned short domain
Definition: hwloc.h:678
struct hwloc_info_s * infos
Array of info attributes (name and value strings).
Definition: hwloc.h:602
unsigned infos_count
Size of infos array.
Definition: hwloc.h:603
struct hwloc_obj_attr_u::hwloc_group_attr_s group
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:458
int hwloc_type_sscanf(const char *string, hwloc_obj_type_t *typep, union hwloc_obj_attr_u *attrp, size_t attrsize)
Return an object type and attributes from a type string.
unsigned char get_thisproc_membind
Definition: hwloc.h:2276
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:2010
unsigned short device_id
Definition: hwloc.h:665
Remove all objects that became CPU-less. By default, only objects that contain no PU and no memory ar...
Definition: hwloc.h:2490
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:1504
hwloc_obj_t hwloc_get_obj_by_depth(hwloc_topology_t topology, int depth, unsigned idx)
Returns the topology object at logical index idx from depth depth.
int hwloc_topology_get_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e *filter)
Get the current filtering for the given object type.
unsigned depth
Definition: hwloc.h:686
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1465
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.
hwloc_obj_t hwloc_topology_insert_group_object(hwloc_topology_t topology, hwloc_obj_t group)
Add more structure to the topology by adding an intermediate Group.
Level 3 Data (or Unified) Cache.
Definition: hwloc.h:236
static hwloc_obj_t hwloc_get_next_obj_by_depth(hwloc_topology_t topology, int depth, hwloc_obj_t prev)
Returns the next object at depth depth.
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:466
Avoid any effect on memory binding.
Definition: hwloc.h:1256
Operating system device (filtered out by default).
Definition: hwloc.h:300
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a constant stringified object type.
Level 1 instruction Cache (filtered out by default).
Definition: hwloc.h:240
Level 3 instruction Cache (filtered out by default).
Definition: hwloc.h:242
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:222
unsigned char numa_memory
Detecting the amount of memory in NUMA nodes is supported.
Definition: hwloc.h:2228
int hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value)
Add the given name and value pair to the given object info attributes.
hwloc_obj_t hwloc_topology_alloc_group_object(hwloc_topology_t topology)
Allocate a Group object to insert later with hwloc_topology_insert_group_object().
unsigned char nexttouch_membind
Definition: hwloc.h:2298
Restrict by nodeset instead of CPU set. Only keep objects whose nodeset is included or partially incl...
Definition: hwloc.h:2496
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1528
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 depth
Depth of group object. It may change if intermediate Group objects are added.
Definition: hwloc.h:650
unsigned subkind
Internally-used subkind to distinguish different levels of groups with same kind. ...
Definition: hwloc.h:653
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:626
Allocate memory on the specified nodes.
Definition: hwloc.h:1488
struct hwloc_obj_attr_u::hwloc_cache_attr_s cache
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:181
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:2320
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:467
struct hwloc_obj * memory_first_child
First Memory child. NUMA nodes and Memory-side caches are listed here (memory_arity and memory_first_...
Definition: hwloc.h:499
Get the set of allowed resources from the local operating system even if the topology was loaded from...
Definition: hwloc.h:2073
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.
int hwloc_topology_set_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e filter)
Set the filtering for the given object type.
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@0 upstream
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.
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1497
Definition: hwloc.h:1546
unsigned short subdevice_id
Definition: hwloc.h:665
Do not consider resources outside of the process CPU binding.
Definition: hwloc.h:2122
int hwloc_topology_set_components(hwloc_topology_t restrict topology, unsigned long flags, const char *restrict name)
Prevent a discovery component from being used for a topology.
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2509
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 set_thisproc_cpubind
Definition: hwloc.h:2244
NUMA node. An object that contains memory that is directly and byte-accessible to the host processors...
Definition: hwloc.h:257
PCI device (filtered out by default).
Definition: hwloc.h:290
Ignore distances.
Definition: hwloc.h:2166
hwloc_get_type_depth_e
Definition: hwloc.h:852
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1207
unsigned arity
Number of normal children. Memory, Misc and I/O children are not listed here but rather in their dedi...
Definition: hwloc.h:476
unsigned char set_area_membind
Definition: hwloc.h:2286
unsigned char imported_support
Definition: hwloc.h:2309
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...
Memory-side cache (filtered out by default). A cache in front of a specific NUMA node.
Definition: hwloc.h:326
Flags describing miscellaneous features.
Definition: hwloc.h:2307
unsigned char dont_merge
Flag preventing groups from being automatically merged with identical parent or children.
Definition: hwloc.h:654
unsigned kind
Internally-used kind of group.
Definition: hwloc.h:652
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
int hwloc_get_memory_parents_depth(hwloc_topology_t topology)
Return the depth of parents where memory objects are attached.
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.
Flags describing actual discovery support for this topology.
Definition: hwloc.h:2222
unsigned char numa
Detecting the number of NUMA nodes is supported.
Definition: hwloc.h:2226
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:642
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...
Level 2 instruction Cache (filtered out by default).
Definition: hwloc.h:241
int hwloc_obj_add_other_obj_sets(hwloc_obj_t dst, hwloc_obj_t src)
Setup object cpusets/nodesets by OR&#39;ing another object&#39;s sets.
int symmetric_subtree
Set if the subtree of normal objects below this object is symmetric, which means all normal children ...
Definition: hwloc.h:485
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:620
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:643
Blacklist the target component from being used.
Definition: hwloc.h:1970
Ignore memory attributes.
Definition: hwloc.h:2172
unsigned sibling_rank
Index in parent&#39;s children[] array. Or the index in parent&#39;s Memory, I/O or Misc children list...
Definition: hwloc.h:471
Avoid any effect on CPU binding.
Definition: hwloc.h:1565
Allow a custom set of objects, given to hwloc_topology_allow() as cpuset and/or nodeset parameters...
Definition: hwloc.h:2563
unsigned char secondary_bus
Definition: hwloc.h:682
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
Virtual depth for NUMA nodes.
Definition: hwloc.h:855
unsigned char bind_membind
Definition: hwloc.h:2294
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:606
Allocate each memory page individually on the local NUMA node of the thread that touches it...
Definition: hwloc.h:1484
unsigned char migrate_membind
Definition: hwloc.h:2300
unsigned io_arity
Number of I/O children. These children are listed in io_first_child.
Definition: hwloc.h:514
struct hwloc_pcidev_attr_s pci
Definition: hwloc.h:672
Level 5 Data (or Unified) Cache.
Definition: hwloc.h:238
Keep all objects of this type.
Definition: hwloc.h:2371
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:360
char * name
Info name.
Definition: hwloc.h:699
No object of given type exists in the topology.
Definition: hwloc.h:853
Do not ever modify the process or thread binding during discovery.
Definition: hwloc.h:2159
unsigned char firsttouch_membind
Definition: hwloc.h:2292
Only allow objects that are available to the current process.
Definition: hwloc.h:2559
unsigned char disallowed_pu
Detecting and identifying PU objects that are not available to the current process is supported...
Definition: hwloc.h:2230
int hwloc_topology_set_all_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all object types.
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2484
Import support from the imported topology.
Definition: hwloc.h:2097
unsigned char get_thread_cpubind
Definition: hwloc.h:2258
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:2052
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:2264
unsigned char bus
Definition: hwloc.h:663
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:646
Object type-specific Attributes.
Definition: hwloc.h:623
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
Detect the whole system, ignore reservations, include disallowed objects.
Definition: hwloc.h:2032
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
struct hwloc_obj * prev_sibling
Previous object below the same parent (inside the same list of children).
Definition: hwloc.h:473
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:69
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:197
unsigned char revision
Definition: hwloc.h:666
Virtual depth for MemCache object.
Definition: hwloc.h:860
int hwloc_type_sscanf_as_depth(const char *string, hwloc_obj_type_t *typep, hwloc_topology_t topology, int *depthp)
Return an object type and its level depth from a type string.
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
Miscellaneous objects (filtered out by default). Objects without particular meaning, that can e.g. be added by the application for its own use, or by hwloc for miscellaneous objects such as MemoryModule (DIMMs).
Definition: hwloc.h:311
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
unsigned char get_thisthread_cpubind
Definition: hwloc.h:2254
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.
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1512
int hwloc_topology_restrict(hwloc_topology_t restrict topology, hwloc_const_bitmap_t set, unsigned long flags)
Restrict the topology to the given CPU set or nodeset.
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:244
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
hwloc_obj_osdev_type_t type
Definition: hwloc.h:690
Instruction cache (filtered out by default).
Definition: hwloc.h:350
hwloc_bitmap_t hwloc_nodeset_t
A node set is a bitmap whose bits are set according to NUMA memory node physical OS indexes...
Definition: hwloc.h:178
unsigned char disallowed_numa
Detecting and identifying NUMA nodes that are not available to the current process is supported...
Definition: hwloc.h:2232
Data cache.
Definition: hwloc.h:349
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, int depth)
Returns the width of level at depth depth.
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:372
Virtual depth for bridge object level.
Definition: hwloc.h:856
hwloc_type_filter_e
Type filtering flags.
Definition: hwloc.h:2365
Bridge (filtered out by default). Any bridge (or PCI switch) that connects the host or an I/O bus...
Definition: hwloc.h:278
Mark all objects as allowed in the topology.
Definition: hwloc.h:2550
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:634
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...
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:363
PCI Device specific Object Attributes.
Definition: hwloc.h:657
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:2272
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.
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:355
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:2260
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:633
unsigned memory_arity
Number of Memory children. These children are listed in memory_first_child.
Definition: hwloc.h:496
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.
Unified cache.
Definition: hwloc.h:348
struct hwloc_obj * next_sibling
Next object below the same parent (inside the same list of children).
Definition: hwloc.h:472
Die within a physical package. A subpart of the physical package, that contains multiple cores...
Definition: hwloc.h:339
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:685
unsigned char cpukind_efficiency
Detecting the efficiency of CPU kinds is supported, see Kinds of CPU cores.
Definition: hwloc.h:2234
unsigned char func
Definition: hwloc.h:663
Core. A computation unit (may be shared by several PUs, aka logical processors).
Definition: hwloc.h:218
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1533
struct hwloc_obj * last_child
Last normal child.
Definition: hwloc.h:482
int hwloc_get_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, hwloc_membind_policy_t *policy, int flags)
Query the CPUs near the physical NUMA node(s) and binding policy of the memory identified by (addr...
unsigned short class_id
Definition: hwloc.h:664
hwloc_uint64_t total_memory
Total memory (in bytes) in NUMA nodes below this object.
Definition: hwloc.h:437
Operating system block device, or non-volatile memory device. For instance "sda" or "dax2...
Definition: hwloc.h:361
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR&#39;ed flags of a topology.
hwloc_topology_components_flag_e
Flags to be passed to hwloc_topology_set_components()
Definition: hwloc.h:1966
Only ignore objects if their entire level does not bring any structure.
Definition: hwloc.h:2393
Virtual depth for Misc object.
Definition: hwloc.h:859
OS Device specific Object Attributes.
Definition: hwloc.h:689
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
char * subtype
Subtype string to better describe the type field.
Definition: hwloc.h:423
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:674
Ignore all objects of this type.
Definition: hwloc.h:2379
unsigned char alloc_membind
Definition: hwloc.h:2290
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.
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.
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:422
float linkspeed
Definition: hwloc.h:667
unsigned char set_proc_cpubind
Definition: hwloc.h:2248
unsigned short domain
Definition: hwloc.h:659
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1210
Set of flags describing actual support for this topology.
Definition: hwloc.h:2318
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:432
Virtual depth for software device object level.
Definition: hwloc.h:858
Request for strict binding from the OS.
Definition: hwloc.h:1239
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which process the topology is viewed from.
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:586
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:2242
int hwloc_topology_refresh(hwloc_topology_t topology)
Refresh internal structures after topology modification.
hwloc_allow_flags_e
Flags to be given to hwloc_topology_allow().
Definition: hwloc.h:2545
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
Objects of given type exist at different depth in the topology (only for Groups). ...
Definition: hwloc.h:854
static const char * hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name)
Search the given name in object infos and return the corresponding value.
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.
unsigned char dev
Definition: hwloc.h:663
hwloc_obj_t hwloc_topology_insert_misc_object(hwloc_topology_t topology, hwloc_obj_t parent, const char *name)
Add a MISC object as a leaf of the topology.
int hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:641
int hwloc_topology_allow(hwloc_topology_t restrict topology, hwloc_const_cpuset_t cpuset, hwloc_const_nodeset_t nodeset, unsigned long flags)
Change the sets of allowed PUs and NUMA nodes in the topology.
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 char get_area_membind
Definition: hwloc.h:2288
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
unsigned char get_area_memlocation
Definition: hwloc.h:2302
Structure of a topology object.
Definition: hwloc.h:420
struct hwloc_obj_attr_u::hwloc_numanode_attr_s numanode
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())...
struct hwloc_obj * misc_first_child
First Misc child. Misc objects are listed here (misc_arity and misc_first_child) instead of in the no...
Definition: hwloc.h:529
Level 2 Data (or Unified) Cache.
Definition: hwloc.h:235
Level 1 Data (or Unified) Cache.
Definition: hwloc.h:234
unsigned char get_thisthread_membind
Definition: hwloc.h:2284
hwloc_cpuset_t complete_cpuset
The complete CPU set of processors of this object,.
Definition: hwloc.h:551