Hardware Locality (hwloc) 2.2.0

hwloc.h
1 /*
2 * Copyright © 2009 CNRS
3 * Copyright © 2009-2020 Inria. All rights reserved.
4 * Copyright © 2009-2012 Université Bordeaux
5 * Copyright © 2009-2011 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 * http://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 prictures 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
96 #define HWLOC_API_VERSION 0x00020100
97
102 HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);
103
105 #define HWLOC_COMPONENT_ABI 6
106
140 typedef hwloc_bitmap_t hwloc_cpuset_t;
142 typedef hwloc_const_bitmap_t hwloc_const_cpuset_t;
143
157 typedef hwloc_bitmap_t hwloc_nodeset_t;
160 typedef hwloc_const_bitmap_t hwloc_const_nodeset_t;
161
176 typedef enum {
177
179 #define HWLOC_OBJ_TYPE_MIN HWLOC_OBJ_MACHINE /* Sentinel value */
180
182 HWLOC_OBJ_MACHINE,
191 HWLOC_OBJ_PACKAGE,
197 HWLOC_OBJ_CORE,
201 HWLOC_OBJ_PU,
213 HWLOC_OBJ_L1CACHE,
214 HWLOC_OBJ_L2CACHE,
215 HWLOC_OBJ_L3CACHE,
216 HWLOC_OBJ_L4CACHE,
217 HWLOC_OBJ_L5CACHE,
219 HWLOC_OBJ_L1ICACHE,
220 HWLOC_OBJ_L2ICACHE,
221 HWLOC_OBJ_L3ICACHE,
223 HWLOC_OBJ_GROUP,
236 HWLOC_OBJ_NUMANODE,
257 HWLOC_OBJ_BRIDGE,
266 HWLOC_OBJ_PCI_DEVICE,
273 HWLOC_OBJ_OS_DEVICE,
281 HWLOC_OBJ_MISC,
292 HWLOC_OBJ_MEMCACHE,
305 HWLOC_OBJ_DIE,
310 HWLOC_OBJ_TYPE_MAX
311 } hwloc_obj_type_t;
312
314 typedef enum hwloc_obj_cache_type_e {
315 HWLOC_OBJ_CACHE_UNIFIED,
316 HWLOC_OBJ_CACHE_DATA,
317 HWLOC_OBJ_CACHE_INSTRUCTION
318 } hwloc_obj_cache_type_t;
319
321 typedef enum hwloc_obj_bridge_type_e {
322 HWLOC_OBJ_BRIDGE_HOST,
323 HWLOC_OBJ_BRIDGE_PCI
324 } hwloc_obj_bridge_type_t;
325
327 typedef enum hwloc_obj_osdev_type_e {
328 HWLOC_OBJ_OSDEV_BLOCK,
330 HWLOC_OBJ_OSDEV_GPU,
333 HWLOC_OBJ_OSDEV_NETWORK,
335 HWLOC_OBJ_OSDEV_OPENFABRICS,
338 HWLOC_OBJ_OSDEV_DMA,
340 HWLOC_OBJ_OSDEV_COPROC
344 } hwloc_obj_osdev_type_t;
345
365 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
366
368 #define HWLOC_TYPE_UNORDERED INT_MAX
369
378 union hwloc_obj_attr_u;
379
384 struct hwloc_obj {
385 /* physical information */
386 hwloc_obj_type_t type;
387 char *subtype;
389 unsigned os_index;
394 #define HWLOC_UNKNOWN_INDEX (unsigned)-1
395
396 char *name;
401 hwloc_uint64_t total_memory;
403 union hwloc_obj_attr_u *attr;
406 /* global position */
407 int depth;
422 unsigned logical_index;
429 /* cousins are all objects of the same type (and depth) across the entire topology */
430 struct hwloc_obj *next_cousin;
431 struct hwloc_obj *prev_cousin;
433 /* children of the same parent are siblings, even if they may have different type and depth */
434 struct hwloc_obj *parent;
435 unsigned sibling_rank;
436 struct hwloc_obj *next_sibling;
437 struct hwloc_obj *prev_sibling;
440 unsigned arity;
444 struct hwloc_obj **children;
445 struct hwloc_obj *first_child;
446 struct hwloc_obj *last_child;
449 int symmetric_subtree;
460 unsigned memory_arity;
463 struct hwloc_obj *memory_first_child;
478 unsigned io_arity;
481 struct hwloc_obj *io_first_child;
490 unsigned misc_arity;
493 struct hwloc_obj *misc_first_child;
499 /* cpusets and nodesets */
500 hwloc_cpuset_t cpuset;
515 hwloc_cpuset_t complete_cpuset;
528 hwloc_nodeset_t nodeset;
548 hwloc_nodeset_t complete_nodeset;
564 struct hwloc_info_s *infos;
565 unsigned infos_count;
567 /* misc */
568 void *userdata;
573 hwloc_uint64_t gp_index;
578 };
582 typedef struct hwloc_obj * hwloc_obj_t;
583
585 union hwloc_obj_attr_u {
587 struct hwloc_numanode_attr_s {
588 hwloc_uint64_t local_memory;
589 unsigned page_types_len;
595 struct hwloc_memory_page_type_s {
596 hwloc_uint64_t size;
597 hwloc_uint64_t count;
598 } * page_types;
599 } numanode;
600
602 struct hwloc_cache_attr_s {
603 hwloc_uint64_t size;
604 unsigned depth;
605 unsigned linesize;
606 int associativity;
608 hwloc_obj_cache_type_t type;
609 } cache;
611 struct hwloc_group_attr_s {
612 unsigned depth;
614 unsigned kind;
615 unsigned subkind;
616 unsigned char dont_merge;
617 } group;
619 struct hwloc_pcidev_attr_s {
620 #ifndef HWLOC_HAVE_32BITS_PCI_DOMAIN
621 unsigned short domain; /* Only 16bits PCI domains are supported by default */
622 #else
623 unsigned int domain; /* 32bits PCI domain support break the library ABI, hence it's disabled by default */
624 #endif
625 unsigned char bus, dev, func;
626 unsigned short class_id;
627 unsigned short vendor_id, device_id, subvendor_id, subdevice_id;
628 unsigned char revision;
629 float linkspeed; /* in GB/s */
630 } pcidev;
632 struct hwloc_bridge_attr_s {
633 union {
634 struct hwloc_pcidev_attr_s pci;
635 } upstream;
636 hwloc_obj_bridge_type_t upstream_type;
637 union {
638 struct {
639 #ifndef HWLOC_HAVE_32BITS_PCI_DOMAIN
640 unsigned short domain; /* Only 16bits PCI domains are supported by default */
641 #else
642 unsigned int domain; /* 32bits PCI domain support break the library ABI, hence it's disabled by default */
643 #endif
644 unsigned char secondary_bus, subordinate_bus;
645 } pci;
646 } downstream;
647 hwloc_obj_bridge_type_t downstream_type;
648 unsigned depth;
649 } bridge;
651 struct hwloc_osdev_attr_s {
652 hwloc_obj_osdev_type_t type;
653 } osdev;
654 };
655
660 struct hwloc_info_s {
661 char *name;
662 char *value;
663 };
664
673 struct hwloc_topology;
678 typedef struct hwloc_topology * hwloc_topology_t;
679
686 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
687
708 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
709
714 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
715
726 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
727
745 HWLOC_DECLSPEC int hwloc_topology_abi_check(hwloc_topology_t topology);
746
758 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
759
780 HWLOC_DECLSPEC int hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
781
805 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
806
807 enum hwloc_get_type_depth_e {
808 HWLOC_TYPE_DEPTH_UNKNOWN = -1,
809 HWLOC_TYPE_DEPTH_MULTIPLE = -2,
810 HWLOC_TYPE_DEPTH_NUMANODE = -3,
811 HWLOC_TYPE_DEPTH_BRIDGE = -4,
812 HWLOC_TYPE_DEPTH_PCI_DEVICE = -5,
813 HWLOC_TYPE_DEPTH_OS_DEVICE = -6,
814 HWLOC_TYPE_DEPTH_MISC = -7,
815 HWLOC_TYPE_DEPTH_MEMCACHE = -8
816 };
817
837 HWLOC_DECLSPEC int hwloc_get_memory_parents_depth (hwloc_topology_t topology);
838
852 static __hwloc_inline int
853 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
854
868 static __hwloc_inline int
869 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
870
878 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, int depth) __hwloc_attribute_pure;
879
882 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, int depth) __hwloc_attribute_pure;
883
889 static __hwloc_inline int
890 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
891
896 static __hwloc_inline hwloc_obj_t
897 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
898
900 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, int depth, unsigned idx) __hwloc_attribute_pure;
901
908 static __hwloc_inline hwloc_obj_t
909 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
910
915 static __hwloc_inline hwloc_obj_t
916 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, int depth, hwloc_obj_t prev);
917
924 static __hwloc_inline hwloc_obj_t
925 hwloc_get_next_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type,
926 hwloc_obj_t prev);
927
944 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
945
963 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size,
964 hwloc_obj_t obj,
965 int verbose);
966
978 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size,
979 hwloc_obj_t obj, const char * __hwloc_restrict separator,
980 int verbose);
981
1005 HWLOC_DECLSPEC int hwloc_type_sscanf(const char *string,
1006 hwloc_obj_type_t *typep,
1007 union hwloc_obj_attr_u *attrp, size_t attrsize);
1008
1030 HWLOC_DECLSPEC int hwloc_type_sscanf_as_depth(const char *string,
1031 hwloc_obj_type_t *typep,
1032 hwloc_topology_t topology, int *depthp);
1033
1049 static __hwloc_inline const char *
1050 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1051
1068 HWLOC_DECLSPEC int hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1069
1141 typedef enum {
1144 HWLOC_CPUBIND_PROCESS = (1<<0),
1145
1148 HWLOC_CPUBIND_THREAD = (1<<1),
1149
1173 HWLOC_CPUBIND_STRICT = (1<<2),
1174
1190 HWLOC_CPUBIND_NOMEMBIND = (1<<3)
1191 } hwloc_cpubind_flags_t;
1192
1198 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1199
1205 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1206
1218 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1219
1231 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1232
1233 #ifdef hwloc_thread_t
1234
1241 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1242 #endif
1243
1244 #ifdef hwloc_thread_t
1245
1252 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1253 #endif
1254
1268 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1269
1286 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1287
1367 typedef enum {
1375 HWLOC_MEMBIND_DEFAULT = 0,
1376
1386 HWLOC_MEMBIND_FIRSTTOUCH = 1,
1387
1390 HWLOC_MEMBIND_BIND = 2,
1391
1399 HWLOC_MEMBIND_INTERLEAVE = 3,
1400
1406 HWLOC_MEMBIND_NEXTTOUCH = 4,
1407
1414 HWLOC_MEMBIND_MIXED = -1
1415 } hwloc_membind_policy_t;
1416
1430 typedef enum {
1435 HWLOC_MEMBIND_PROCESS = (1<<0),
1436
1440 HWLOC_MEMBIND_THREAD = (1<<1),
1441
1448 HWLOC_MEMBIND_STRICT = (1<<2),
1449
1454 HWLOC_MEMBIND_MIGRATE = (1<<3),
1455
1467 HWLOC_MEMBIND_NOCPUBIND = (1<<4),
1468
1478 HWLOC_MEMBIND_BYNODESET = (1<<5)
1479 } hwloc_membind_flags_t;
1480
1496 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
1497
1542 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
1543
1556 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);
1557
1597 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);
1598
1609 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);
1610
1638 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);
1639
1659 HWLOC_DECLSPEC int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags);
1660
1668 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
1669
1684 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;
1685
1695 static __hwloc_inline void *
1696 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;
1697
1701 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
1702
1739 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
1740
1769 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
1770
1797 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
1798
1825 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
1826
1829 enum hwloc_topology_components_flag_e {
1833 HWLOC_TOPOLOGY_COMPONENTS_FLAG_BLACKLIST = (1UL<<0)
1834 };
1835
1850 HWLOC_DECLSPEC int hwloc_topology_set_components(hwloc_topology_t __hwloc_restrict topology, unsigned long flags, const char * __hwloc_restrict name);
1851
1870 enum hwloc_topology_flags_e {
1891 HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED = (1UL<<0),
1892
1911 HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM = (1UL<<1),
1912
1932 HWLOC_TOPOLOGY_FLAG_THISSYSTEM_ALLOWED_RESOURCES = (1UL<<2)
1933 };
1934
1944 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
1945
1952 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
1953
1961 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1962
1964 struct hwloc_topology_discovery_support {
1966 unsigned char pu;
1968 unsigned char numa;
1970 unsigned char numa_memory;
1972 unsigned char disallowed_pu;
1974 unsigned char disallowed_numa;
1975 };
1976
1982 struct hwloc_topology_cpubind_support {
1984 unsigned char set_thisproc_cpubind;
1986 unsigned char get_thisproc_cpubind;
1988 unsigned char set_proc_cpubind;
1990 unsigned char get_proc_cpubind;
1992 unsigned char set_thisthread_cpubind;
1994 unsigned char get_thisthread_cpubind;
1996 unsigned char set_thread_cpubind;
1998 unsigned char get_thread_cpubind;
2000 unsigned char get_thisproc_last_cpu_location;
2002 unsigned char get_proc_last_cpu_location;
2004 unsigned char get_thisthread_last_cpu_location;
2005 };
2006
2012 struct hwloc_topology_membind_support {
2014 unsigned char set_thisproc_membind;
2016 unsigned char get_thisproc_membind;
2018 unsigned char set_proc_membind;
2020 unsigned char get_proc_membind;
2022 unsigned char set_thisthread_membind;
2024 unsigned char get_thisthread_membind;
2026 unsigned char set_area_membind;
2028 unsigned char get_area_membind;
2030 unsigned char alloc_membind;
2032 unsigned char firsttouch_membind;
2034 unsigned char bind_membind;
2036 unsigned char interleave_membind;
2038 unsigned char nexttouch_membind;
2040 unsigned char migrate_membind;
2042 unsigned char get_area_memlocation;
2043 };
2044
2051 struct hwloc_topology_support {
2052 struct hwloc_topology_discovery_support *discovery;
2053 struct hwloc_topology_cpubind_support *cpubind;
2054 struct hwloc_topology_membind_support *membind;
2055 };
2056
2066 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
2067
2077 enum hwloc_type_filter_e {
2083 HWLOC_TYPE_FILTER_KEEP_ALL = 0,
2084
2091 HWLOC_TYPE_FILTER_KEEP_NONE = 1,
2092
2105 HWLOC_TYPE_FILTER_KEEP_STRUCTURE = 2,
2106
2120 HWLOC_TYPE_FILTER_KEEP_IMPORTANT = 3
2121 };
2122
2125 HWLOC_DECLSPEC int hwloc_topology_set_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e filter);
2126
2129 HWLOC_DECLSPEC int hwloc_topology_get_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e *filter);
2130
2135 HWLOC_DECLSPEC int hwloc_topology_set_all_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2136
2141 HWLOC_DECLSPEC int hwloc_topology_set_cache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2142
2147 HWLOC_DECLSPEC int hwloc_topology_set_icache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2148
2151 HWLOC_DECLSPEC int hwloc_topology_set_io_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2152
2163 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
2164
2170 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
2171
2181 enum hwloc_restrict_flags_e {
2187 HWLOC_RESTRICT_FLAG_REMOVE_CPULESS = (1UL<<0),
2188
2193 HWLOC_RESTRICT_FLAG_BYNODESET = (1UL<<3),
2194
2200 HWLOC_RESTRICT_FLAG_REMOVE_MEMLESS = (1UL<<4),
2201
2206 HWLOC_RESTRICT_FLAG_ADAPT_MISC = (1UL<<1),
2207
2212 HWLOC_RESTRICT_FLAG_ADAPT_IO = (1UL<<2)
2213 };
2214
2239 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_bitmap_t set, unsigned long flags);
2240
2242 enum hwloc_allow_flags_e {
2247 HWLOC_ALLOW_FLAG_ALL = (1UL<<0),
2248
2256 HWLOC_ALLOW_FLAG_LOCAL_RESTRICTIONS = (1UL<<1),
2257
2260 HWLOC_ALLOW_FLAG_CUSTOM = (1UL<<2)
2261 };
2262
2278 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);
2279
2301 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2302
2323 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_alloc_group_object(hwloc_topology_t topology);
2324
2361 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_group_object(hwloc_topology_t topology, hwloc_obj_t group);
2362
2372 HWLOC_DECLSPEC int hwloc_obj_add_other_obj_sets(hwloc_obj_t dst, hwloc_obj_t src);
2373
2378 #ifdef __cplusplus
2379 } /* extern "C" */
2380 #endif
2381
2382
2383 /* high-level helpers */
2384 #include "hwloc/helper.h"
2385
2386 /* inline code of some functions above */
2387 #include "hwloc/inlines.h"
2388
2389 /* exporting to XML or synthetic */
2390 #include "hwloc/export.h"
2391
2392 /* distances */
2393 #include "hwloc/distances.h"
2394
2395 /* topology diffs */
2396 #include "hwloc/diff.h"
2397
2398 /* deprecated headers */
2399 #include "hwloc/deprecated.h"
2400
2401 #endif /* HWLOC_H */
hwloc_set_proc_membind
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...
hwloc_obj_osdev_type_t
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
HWLOC_OBJ_OSDEV_OPENFABRICS
@ HWLOC_OBJ_OSDEV_OPENFABRICS
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA, or "hfi1_0" Omni-Path ...
Definition: hwloc.h:335
HWLOC_MEMBIND_STRICT
@ HWLOC_MEMBIND_STRICT
Definition: hwloc.h:1448
HWLOC_MEMBIND_MIXED
@ HWLOC_MEMBIND_MIXED
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1414
hwloc_membind_flags_t
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1430
HWLOC_OBJ_PCI_DEVICE
@ HWLOC_OBJ_PCI_DEVICE
PCI device (filtered out by default). They are not added to the topology unless I/O discovery is enab...
Definition: hwloc.h:266
hwloc_obj_attr_u::group
struct hwloc_obj_attr_u::hwloc_group_attr_s group
hwloc_topology_set_flags
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR'ed flags to non-yet-loaded topology.
hwloc_obj_attr_u::hwloc_bridge_attr_s::downstream_type
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:647
HWLOC_OBJ_MEMCACHE
@ HWLOC_OBJ_MEMCACHE
Memory-side cache (filtered out by default). A cache in front of a specific NUMA node.
Definition: hwloc.h:292
HWLOC_MEMBIND_THREAD
@ HWLOC_MEMBIND_THREAD
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1440
hwloc_obj::memory_arity
unsigned memory_arity
Number of Memory children. These children are listed in memory_first_child.
Definition: hwloc.h:460
HWLOC_OBJ_CACHE_INSTRUCTION
@ HWLOC_OBJ_CACHE_INSTRUCTION
Instruction cache (filtered out by default).
Definition: hwloc.h:317
hwloc_set_cpubind
int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags)
Bind current process or thread on cpus given in physical bitmap set.
hwloc_topology_membind_support::get_thisthread_membind
unsigned char get_thisthread_membind
Definition: hwloc.h:2024
hwloc_topology_membind_support::set_area_membind
unsigned char set_area_membind
Definition: hwloc.h:2026
hwloc_obj_get_info_by_name
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.
hwloc_topology_set_icache_types_filter
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_CORE
@ HWLOC_OBJ_CORE
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:197
hwloc_topology_membind_support::get_proc_membind
unsigned char get_proc_membind
Definition: hwloc.h:2020
hwloc_const_bitmap_t
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:70
hwloc_obj_attr_u::hwloc_osdev_attr_s::type
hwloc_obj_osdev_type_t type
Definition: hwloc.h:652
hwloc_obj_attr_u::hwloc_pcidev_attr_s::domain
unsigned short domain
Definition: hwloc.h:621
hwloc_obj::sibling_rank
unsigned sibling_rank
Index in parent's children[] array. Or the index in parent's Memory, I/O or Misc children list.
Definition: hwloc.h:435
hwloc_topology_cpubind_support::get_proc_cpubind
unsigned char get_proc_cpubind
Definition: hwloc.h:1990
hwloc_topology_cpubind_support::get_thisthread_last_cpu_location
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:2004
hwloc_topology_destroy
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
hwloc_topology_membind_support::alloc_membind
unsigned char alloc_membind
Definition: hwloc.h:2030
hwloc_obj::next_sibling
struct hwloc_obj * next_sibling
Next object below the same parent (inside the same list of children).
Definition: hwloc.h:436
hwloc_obj_attr_u::hwloc_group_attr_s::depth
unsigned depth
Depth of group object. It may change if intermediate Group objects are added.
Definition: hwloc.h:612
hwloc_obj::os_index
unsigned os_index
OS-provided physical index number. It is not guaranteed unique across the entire machine,...
Definition: hwloc.h:389
hwloc_topology_cpubind_support::get_thread_cpubind
unsigned char get_thread_cpubind
Definition: hwloc.h:1998
hwloc_get_proc_membind
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_get_cpubind
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
hwloc_obj_attr_u::hwloc_pcidev_attr_s::subdevice_id
unsigned short subdevice_id
Definition: hwloc.h:627
HWLOC_TYPE_FILTER_KEEP_ALL
@ HWLOC_TYPE_FILTER_KEEP_ALL
Keep all objects of this type.
Definition: hwloc.h:2083
hwloc_topology_set_type_filter
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.
HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM
@ HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM
Assume that the selected backend provides the topology for the system on which we are running.
Definition: hwloc.h:1911
hwloc_topology_init
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
hwloc_topology_membind_support::interleave_membind
unsigned char interleave_membind
Definition: hwloc.h:2036
HWLOC_OBJ_L1CACHE
@ HWLOC_OBJ_L1CACHE
Level 1 Data (or Unified) Cache.
Definition: hwloc.h:213
hwloc_info_s
Object info.
Definition: hwloc.h:660
hwloc_set_proc_cpubind
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.
hwloc_get_type_depth
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
hwloc_obj::misc_first_child
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:493
hwloc_topology_support::cpubind
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:2053
hwloc_obj_attr_u::osdev
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
hwloc_obj_attr_u::hwloc_pcidev_attr_s::class_id
unsigned short class_id
Definition: hwloc.h:626
HWLOC_CPUBIND_NOMEMBIND
@ HWLOC_CPUBIND_NOMEMBIND
Avoid any effect on memory binding.
Definition: hwloc.h:1190
hwloc_obj::next_cousin
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:430
HWLOC_TOPOLOGY_COMPONENTS_FLAG_BLACKLIST
@ HWLOC_TOPOLOGY_COMPONENTS_FLAG_BLACKLIST
Blacklist the target component from being used.
Definition: hwloc.h:1833
hwloc_obj::type
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:386
hwloc_obj_attr_u::hwloc_numanode_attr_s::page_types_len
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:589
hwloc_topology_cpubind_support::get_proc_last_cpu_location
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:2002
hwloc_topology_membind_support::firsttouch_membind
unsigned char firsttouch_membind
Definition: hwloc.h:2032
hwloc_get_obj_by_type
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_topology_support::membind
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:2054
hwloc_obj_attr_u::hwloc_cache_attr_s::size
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:603
hwloc_topology_support
Set of flags describing actual support for this topology.
Definition: hwloc.h:2051
HWLOC_MEMBIND_BIND
@ HWLOC_MEMBIND_BIND
Allocate memory on the specified nodes.
Definition: hwloc.h:1390
HWLOC_OBJ_MISC
@ HWLOC_OBJ_MISC
Miscellaneous objects (filtered out by default). Objects without particular meaning,...
Definition: hwloc.h:281
hwloc_obj_attr_u::hwloc_bridge_attr_s::downstream
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
hwloc_obj_t
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:582
hwloc_obj::attr
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:403
hwloc_obj_attr_u::hwloc_pcidev_attr_s::func
unsigned char func
Definition: hwloc.h:625
HWLOC_OBJ_OS_DEVICE
@ HWLOC_OBJ_OS_DEVICE
Operating system device (filtered out by default). They are not added to the topology unless I/O disc...
Definition: hwloc.h:273
hwloc_type_sscanf
int hwloc_type_sscanf(const char *string, hwloc_obj_type_t *typep, union hwloc_obj_attr_u *attrp, size_t attrsize)
Return an object type and attributes from a type string.
hwloc_get_area_membind
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,...
hwloc_get_root_obj
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
hwloc_topology_t
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:678
hwloc_topology_cpubind_support::set_proc_cpubind
unsigned char set_proc_cpubind
Definition: hwloc.h:1988
hwloc_topology_membind_support::set_thisthread_membind
unsigned char set_thisthread_membind
Definition: hwloc.h:2022
hwloc_topology_support::discovery
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:2052
hwloc_topology_check
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
hwloc_obj_attr_u::hwloc_bridge_attr_s
Bridge specific Object Attribues.
Definition: hwloc.h:632
hwloc_obj_attr_u::hwloc_pcidev_attr_s::device_id
unsigned short device_id
Definition: hwloc.h:627
hwloc_get_nbobjs_by_type
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
hwloc_info_s::name
char * name
Info name.
Definition: hwloc.h:661
hwloc_obj::prev_cousin
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:431
hwloc_bitmap_t
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:68
hwloc_topology_cpubind_support
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:1982
hwloc_topology_discovery_support::numa_memory
unsigned char numa_memory
Detecting the amount of memory in NUMA nodes is supported.
Definition: hwloc.h:1970
HWLOC_TYPE_DEPTH_MULTIPLE
@ HWLOC_TYPE_DEPTH_MULTIPLE
Objects of given type exist at different depth in the topology (only for Groups).
Definition: hwloc.h:809
HWLOC_RESTRICT_FLAG_REMOVE_MEMLESS
@ HWLOC_RESTRICT_FLAG_REMOVE_MEMLESS
Remove all objects that became Memory-less. By default, only objects that contain no PU and no memory...
Definition: hwloc.h:2200
hwloc_obj_attr_u::hwloc_cache_attr_s::type
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:608
hwloc_topology_set_xmlbuffer
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())...
HWLOC_OBJ_BRIDGE_PCI
@ HWLOC_OBJ_BRIDGE_PCI
PCI-side of a bridge.
Definition: hwloc.h:323
HWLOC_OBJ_L2ICACHE
@ HWLOC_OBJ_L2ICACHE
Level 2 instruction Cache (filtered out by default).
Definition: hwloc.h:220
hwloc_obj_attr_u::hwloc_osdev_attr_s
OS Device specific Object Attributes.
Definition: hwloc.h:651
hwloc_obj_osdev_type_e
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:327
HWLOC_MEMBIND_FIRSTTOUCH
@ HWLOC_MEMBIND_FIRSTTOUCH
Allocate each memory page individually on the local NUMA node of the thread that touches it.
Definition: hwloc.h:1386
hwloc_obj_attr_u::hwloc_cache_attr_s::linesize
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:605
hwloc_obj
Structure of a topology object.
Definition: hwloc.h:384
hwloc_topology_cpubind_support::set_thread_cpubind
unsigned char set_thread_cpubind
Definition: hwloc.h:1996
hwloc_obj::arity
unsigned arity
Number of normal children. Memory, Misc and I/O children are not listed here but rather in their dedi...
Definition: hwloc.h:440
HWLOC_OBJ_BRIDGE
@ HWLOC_OBJ_BRIDGE
Bridge (filtered out by default). Any bridge (or PCI switch) that connects the host or an I/O bus,...
Definition: hwloc.h:257
hwloc_obj_attr_u::cache
struct hwloc_obj_attr_u::hwloc_cache_attr_s cache
hwloc_obj::children
struct hwloc_obj ** children
Normal children, children[0 .. arity -1].
Definition: hwloc.h:444
hwloc_obj_attr_u::hwloc_pcidev_attr_s::revision
unsigned char revision
Definition: hwloc.h:628
hwloc_obj_attr_u::hwloc_bridge_attr_s::pci
struct hwloc_pcidev_attr_s pci
Definition: hwloc.h:634
hwloc_topology_insert_misc_object
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.
HWLOC_OBJ_GROUP
@ HWLOC_OBJ_GROUP
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:223
HWLOC_OBJ_BRIDGE_HOST
@ HWLOC_OBJ_BRIDGE_HOST
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:322
hwloc_topology_discovery_support::pu
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:1966
HWLOC_MEMBIND_PROCESS
@ HWLOC_MEMBIND_PROCESS
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1435
hwloc_get_memory_parents_depth
int hwloc_get_memory_parents_depth(hwloc_topology_t topology)
Return the depth of parents where memory objects are attached.
hwloc_compare_types
int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
HWLOC_OBJ_L4CACHE
@ HWLOC_OBJ_L4CACHE
Level 4 Data (or Unified) Cache.
Definition: hwloc.h:216
hwloc_obj_attr_u::hwloc_group_attr_s::dont_merge
unsigned char dont_merge
Flag preventing groups from being automatically merged with identical parent or children.
Definition: hwloc.h:616
hwloc_obj::name
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:396
hwloc_get_api_version
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
hwloc_obj_attr_u::hwloc_pcidev_attr_s
PCI Device specific Object Attributes.
Definition: hwloc.h:619
hwloc_topology_set_userdata
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
hwloc_get_obj_by_depth
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.
hwloc_info_s::value
char * value
Info value.
Definition: hwloc.h:662
hwloc_obj::userdata
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:568
hwloc_obj::infos
struct hwloc_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:564
HWLOC_OBJ_OSDEV_GPU
@ HWLOC_OBJ_OSDEV_GPU
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device.
Definition: hwloc.h:330
hwloc_membind_policy_t
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1367
hwloc_obj_attr_u::hwloc_pcidev_attr_s::bus
unsigned char bus
Definition: hwloc.h:625
hwloc_obj_attr_u::hwloc_numanode_attr_s::local_memory
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:588
HWLOC_TYPE_DEPTH_UNKNOWN
@ HWLOC_TYPE_DEPTH_UNKNOWN
No object of given type exists in the topology.
Definition: hwloc.h:808
HWLOC_TYPE_DEPTH_NUMANODE
@ HWLOC_TYPE_DEPTH_NUMANODE
Virtual depth for NUMA nodes.
Definition: hwloc.h:810
hwloc_obj::total_memory
hwloc_uint64_t total_memory
Total memory (in bytes) in NUMA nodes below this object.
Definition: hwloc.h:401
hwloc_topology_discovery_support
Flags describing actual discovery support for this topology.
Definition: hwloc.h:1964
hwloc_obj_attr_u::hwloc_pcidev_attr_s::subvendor_id
unsigned short subvendor_id
Definition: hwloc.h:627
hwloc_obj::io_first_child
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:481
hwloc_topology_cpubind_support::set_thisproc_cpubind
unsigned char set_thisproc_cpubind
Definition: hwloc.h:1984
hwloc_topology_is_thissystem
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
hwloc_obj::misc_arity
unsigned misc_arity
Number of Misc children. These children are listed in misc_first_child.
Definition: hwloc.h:490
hwloc_const_nodeset_t
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:160
HWLOC_TOPOLOGY_FLAG_THISSYSTEM_ALLOWED_RESOURCES
@ HWLOC_TOPOLOGY_FLAG_THISSYSTEM_ALLOWED_RESOURCES
Get the set of allowed resources from the local operating system even if the topology was loaded from...
Definition: hwloc.h:1932
HWLOC_MEMBIND_DEFAULT
@ HWLOC_MEMBIND_DEFAULT
Reset the memory allocation policy to the system default. Depending on the operating system,...
Definition: hwloc.h:1375
hwloc_topology_cpubind_support::get_thisthread_cpubind
unsigned char get_thisthread_cpubind
Definition: hwloc.h:1994
hwloc_obj_attr_u::bridge
struct hwloc_obj_attr_u::hwloc_bridge_attr_s bridge
hwloc_obj::cpuset
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:500
HWLOC_OBJ_DIE
@ HWLOC_OBJ_DIE
Die within a physical package. A subpart of the physical package, that contains multiple cores.
Definition: hwloc.h:305
hwloc_obj::gp_index
hwloc_uint64_t gp_index
Global persistent index. Generated by hwloc, unique across the topology (contrary to os_index) and pe...
Definition: hwloc.h:573
hwloc_topology_cpubind_support::set_thisthread_cpubind
unsigned char set_thisthread_cpubind
Definition: hwloc.h:1992
hwloc_topology_abi_check
int hwloc_topology_abi_check(hwloc_topology_t topology)
Verify that the topology is compatible with the current hwloc library.
HWLOC_RESTRICT_FLAG_REMOVE_CPULESS
@ HWLOC_RESTRICT_FLAG_REMOVE_CPULESS
Remove all objects that became CPU-less. By default, only objects that contain no PU and no memory ar...
Definition: hwloc.h:2187
hwloc_obj_attr_u::hwloc_bridge_attr_s::subordinate_bus
unsigned char subordinate_bus
Definition: hwloc.h:644
HWLOC_TYPE_DEPTH_PCI_DEVICE
@ HWLOC_TYPE_DEPTH_PCI_DEVICE
Virtual depth for PCI device object level.
Definition: hwloc.h:812
hwloc_obj::parent
struct hwloc_obj * parent
Parent, NULL if root (Machine object)
Definition: hwloc.h:434
hwloc_set_thread_cpubind
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.
hwloc_obj_cache_type_e
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:314
hwloc_obj_attr_u::hwloc_numanode_attr_s::hwloc_memory_page_type_s::size
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:596
hwloc_get_proc_cpubind
int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags)
Get the current physical binding of process pid.
hwloc_obj::complete_cpuset
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:515
hwloc_obj_cache_type_t
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
hwloc_get_nbobjs_by_depth
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, int depth)
Returns the width of level at depth depth.
hwloc_topology_discovery_support::disallowed_pu
unsigned char disallowed_pu
Detecting and identifying PU objects that are not available to the current process is supported.
Definition: hwloc.h:1972
HWLOC_TYPE_FILTER_KEEP_IMPORTANT
@ HWLOC_TYPE_FILTER_KEEP_IMPORTANT
Only keep likely-important objects of the given type.
Definition: hwloc.h:2120
hwloc_topology_membind_support::bind_membind
unsigned char bind_membind
Definition: hwloc.h:2034
hwloc_obj_type_snprintf
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::last_child
struct hwloc_obj * last_child
Last normal child.
Definition: hwloc.h:446
HWLOC_OBJ_OSDEV_NETWORK
@ HWLOC_OBJ_OSDEV_NETWORK
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:333
hwloc_topology_get_userdata
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
hwloc_topology_allow
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.
hwloc_type_sscanf_as_depth
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.
hwloc_obj_attr_u::pcidev
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
hwloc_topology_set_cache_types_filter
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.
hwloc_cpuset_t
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:140
hwloc_topology_cpubind_support::get_thisproc_last_cpu_location
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:2000
HWLOC_OBJ_OSDEV_DMA
@ HWLOC_OBJ_OSDEV_DMA
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:338
hwloc_topology_get_type_filter
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.
hwloc_type_filter_e
hwloc_type_filter_e
Type filtering flags.
Definition: hwloc.h:2077
hwloc_obj_type_t
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:176
HWLOC_ALLOW_FLAG_LOCAL_RESTRICTIONS
@ HWLOC_ALLOW_FLAG_LOCAL_RESTRICTIONS
Only allow objects that are available to the current process.
Definition: hwloc.h:2256
hwloc_topology_alloc_group_object
hwloc_obj_t hwloc_topology_alloc_group_object(hwloc_topology_t topology)
Allocate a Group object to insert later with hwloc_topology_insert_group_object().
hwloc_topology_discovery_support::disallowed_numa
unsigned char disallowed_numa
Detecting and identifying NUMA nodes that are not available to the current process is supported.
Definition: hwloc.h:1974
hwloc_obj_attr_u::hwloc_numanode_attr_s
NUMA node-specific Object Attributes.
Definition: hwloc.h:587
HWLOC_RESTRICT_FLAG_ADAPT_IO
@ HWLOC_RESTRICT_FLAG_ADAPT_IO
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2212
HWLOC_TYPE_FILTER_KEEP_STRUCTURE
@ HWLOC_TYPE_FILTER_KEEP_STRUCTURE
Only ignore objects if their entire level does not bring any structure.
Definition: hwloc.h:2105
hwloc_get_next_obj_by_depth
static hwloc_obj_t hwloc_get_next_obj_by_depth(hwloc_topology_t topology, int depth, hwloc_obj_t prev)
Returns the next object at depth depth.
hwloc_allow_flags_e
hwloc_allow_flags_e
Flags to be given to hwloc_topology_allow().
Definition: hwloc.h:2242
HWLOC_RESTRICT_FLAG_BYNODESET
@ HWLOC_RESTRICT_FLAG_BYNODESET
Restrict by nodeset instead of CPU set. Only keep objects whose nodeset is included or partially incl...
Definition: hwloc.h:2193
HWLOC_OBJ_OSDEV_BLOCK
@ HWLOC_OBJ_OSDEV_BLOCK
Operating system block device, or non-volatile memory device. For instance "sda" or "dax2....
Definition: hwloc.h:328
hwloc_get_proc_last_cpu_location
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.
hwloc_set_area_membind
int hwloc_set_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) specified by set.
HWLOC_TYPE_DEPTH_MEMCACHE
@ HWLOC_TYPE_DEPTH_MEMCACHE
Virtual depth for MemCache object.
Definition: hwloc.h:815
hwloc_topology_membind_support::set_thisproc_membind
unsigned char set_thisproc_membind
Definition: hwloc.h:2014
hwloc_obj_add_info
int 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.
hwloc_obj_attr_u::hwloc_bridge_attr_s::upstream_type
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:636
HWLOC_OBJ_PACKAGE
@ HWLOC_OBJ_PACKAGE
Physical package. The physical package that usually gets inserted into a socket on the motherboard....
Definition: hwloc.h:191
hwloc_topology_insert_group_object
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.
hwloc_obj_attr_u::hwloc_cache_attr_s::associativity
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:606
hwloc_obj_attr_u::hwloc_group_attr_s::kind
unsigned kind
Internally-used kind of group.
Definition: hwloc.h:614
hwloc_topology_set_components
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.
hwloc_alloc_membind_policy
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.
hwloc_obj_attr_u::hwloc_bridge_attr_s::depth
unsigned depth
Definition: hwloc.h:648
HWLOC_OBJ_CACHE_UNIFIED
@ HWLOC_OBJ_CACHE_UNIFIED
Unified cache.
Definition: hwloc.h:315
hwloc_obj_attr_u::hwloc_bridge_attr_s::domain
unsigned short domain
Definition: hwloc.h:640
hwloc_topology_membind_support::get_thisproc_membind
unsigned char get_thisproc_membind
Definition: hwloc.h:2016
hwloc_obj::infos_count
unsigned infos_count
Size of infos array.
Definition: hwloc.h:565
HWLOC_RESTRICT_FLAG_ADAPT_MISC
@ HWLOC_RESTRICT_FLAG_ADAPT_MISC
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2206
hwloc_obj_type_string
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a constant stringified object type.
hwloc_cpubind_flags_t
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1141
hwloc_topology_membind_support::get_area_memlocation
unsigned char get_area_memlocation
Definition: hwloc.h:2042
hwloc_topology_membind_support::migrate_membind
unsigned char migrate_membind
Definition: hwloc.h:2040
hwloc_obj::subtype
char * subtype
Subtype string to better describe the type field.
Definition: hwloc.h:387
hwloc_topology_restrict
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.
hwloc_obj_attr_u::hwloc_cache_attr_s
Cache-specific Object Attributes.
Definition: hwloc.h:602
HWLOC_OBJ_MACHINE
@ HWLOC_OBJ_MACHINE
Machine. A set of processors and memory with cache coherency.
Definition: hwloc.h:182
hwloc_get_depth_type
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, int depth)
Returns the type of objects at depth depth.
hwloc_obj_attr_u
Object type-specific Attributes.
Definition: hwloc.h:585
hwloc_obj_attr_u::hwloc_numanode_attr_s::hwloc_memory_page_type_s::count
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:597
hwloc_obj_attr_u::hwloc_bridge_attr_s::secondary_bus
unsigned char secondary_bus
Definition: hwloc.h:644
hwloc_get_membind
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.
hwloc_topology_discovery_support::numa
unsigned char numa
Detecting the number of NUMA nodes is supported.
Definition: hwloc.h:1968
hwloc_get_type_or_below_depth
static int hwloc_get_type_or_below_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type or below.
hwloc_obj_attr_u::hwloc_group_attr_s::subkind
unsigned subkind
Internally-used subkind to distinguish different levels of groups with same kind.
Definition: hwloc.h:615
hwloc_topology_membind_support::nexttouch_membind
unsigned char nexttouch_membind
Definition: hwloc.h:2038
hwloc_get_type_depth_e
hwloc_get_type_depth_e
Definition: hwloc.h:807
hwloc_topology_load
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
hwloc_obj_bridge_type_e
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:321
hwloc_obj::symmetric_subtree
int symmetric_subtree
Set if the subtree of normal objects below this object is symmetric, which means all normal children ...
Definition: hwloc.h:449
hwloc_obj_add_other_obj_sets
int hwloc_obj_add_other_obj_sets(hwloc_obj_t dst, hwloc_obj_t src)
Setup object cpusets/nodesets by OR'ing another object's sets.
hwloc_obj_attr_u::hwloc_pcidev_attr_s::dev
unsigned char dev
Definition: hwloc.h:625
HWLOC_CPUBIND_THREAD
@ HWLOC_CPUBIND_THREAD
Bind current thread of current process.
Definition: hwloc.h:1148
hwloc_obj::prev_sibling
struct hwloc_obj * prev_sibling
Previous object below the same parent (inside the same list of children).
Definition: hwloc.h:437
HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED
@ HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED
Detect the whole system, ignore reservations, include disallowed objects.
Definition: hwloc.h:1891
hwloc_nodeset_t
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:157
hwloc_topology_components_flag_e
hwloc_topology_components_flag_e
Flags to be passed to hwloc_topology_set_components()
Definition: hwloc.h:1829
hwloc_free
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().
hwloc_topology_membind_support
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:2012
hwloc_restrict_flags_e
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2181
hwloc_get_area_memlocation
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.
HWLOC_OBJ_L2CACHE
@ HWLOC_OBJ_L2CACHE
Level 2 Data (or Unified) Cache.
Definition: hwloc.h:214
hwloc_const_cpuset_t
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:142
hwloc_topology_set_io_types_filter
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.
HWLOC_CPUBIND_PROCESS
@ HWLOC_CPUBIND_PROCESS
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1144
hwloc_get_type_or_above_depth
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_get_last_cpu_location
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_OBJ_L3CACHE
@ HWLOC_OBJ_L3CACHE
Level 3 Data (or Unified) Cache.
Definition: hwloc.h:215
hwloc_topology_membind_support::get_area_membind
unsigned char get_area_membind
Definition: hwloc.h:2028
hwloc_topology_set_pid
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which process the topology is viewed from.
HWLOC_ALLOW_FLAG_ALL
@ HWLOC_ALLOW_FLAG_ALL
Mark all objects as allowed in the topology.
Definition: hwloc.h:2247
hwloc_obj::nodeset
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:528
hwloc_obj_attr_u::hwloc_numanode_attr_s::hwloc_memory_page_type_s
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:595
HWLOC_TYPE_FILTER_KEEP_NONE
@ HWLOC_TYPE_FILTER_KEEP_NONE
Ignore all objects of this type.
Definition: hwloc.h:2091
hwloc_topology_get_flags
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR'ed flags of a topology.
hwloc_topology_cpubind_support::get_thisproc_cpubind
unsigned char get_thisproc_cpubind
Definition: hwloc.h:1986
hwloc_obj_attr_snprintf
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.
hwloc_alloc
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
HWLOC_MEMBIND_MIGRATE
@ HWLOC_MEMBIND_MIGRATE
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1454
hwloc_obj_attr_u::hwloc_pcidev_attr_s::linkspeed
float linkspeed
Definition: hwloc.h:629
hwloc_topology_flags_e
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:1870
HWLOC_MEMBIND_BYNODESET
@ HWLOC_MEMBIND_BYNODESET
Consider the bitmap argument as a nodeset.
Definition: hwloc.h:1478
hwloc_obj_attr_u::hwloc_cache_attr_s::depth
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:604
HWLOC_TYPE_DEPTH_MISC
@ HWLOC_TYPE_DEPTH_MISC
Virtual depth for Misc object.
Definition: hwloc.h:814
hwloc_alloc_membind
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.
HWLOC_OBJ_NUMANODE
@ HWLOC_OBJ_NUMANODE
NUMA node. An object that contains memory that is directly and byte-accessible to the host processors...
Definition: hwloc.h:236
HWLOC_CPUBIND_STRICT
@ HWLOC_CPUBIND_STRICT
Request for strict binding from the OS.
Definition: hwloc.h:1173
hwloc_obj::logical_index
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:422
hwloc_obj::first_child
struct hwloc_obj * first_child
First normal child.
Definition: hwloc.h:445
HWLOC_OBJ_L5CACHE
@ HWLOC_OBJ_L5CACHE
Level 5 Data (or Unified) Cache.
Definition: hwloc.h:217
HWLOC_TYPE_DEPTH_BRIDGE
@ HWLOC_TYPE_DEPTH_BRIDGE
Virtual depth for bridge object level.
Definition: hwloc.h:811
HWLOC_OBJ_L3ICACHE
@ HWLOC_OBJ_L3ICACHE
Level 3 instruction Cache (filtered out by default).
Definition: hwloc.h:221
hwloc_obj_attr_u::hwloc_bridge_attr_s::upstream
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@0 upstream
hwloc_obj_attr_u::hwloc_numanode_attr_s::page_types
struct hwloc_obj_attr_u::hwloc_numanode_attr_s::hwloc_memory_page_type_s * page_types
HWLOC_MEMBIND_NEXTTOUCH
@ HWLOC_MEMBIND_NEXTTOUCH
For each page bound with this policy, by next time it is touched (and next time only),...
Definition: hwloc.h:1406
hwloc_topology_get_support
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
hwloc_obj_attr_u::numanode
struct hwloc_obj_attr_u::hwloc_numanode_attr_s numanode
HWLOC_MEMBIND_INTERLEAVE
@ HWLOC_MEMBIND_INTERLEAVE
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1399
hwloc_obj::io_arity
unsigned io_arity
Number of I/O children. These children are listed in io_first_child.
Definition: hwloc.h:478
HWLOC_ALLOW_FLAG_CUSTOM
@ HWLOC_ALLOW_FLAG_CUSTOM
Allow a custom set of objects, given to hwloc_topology_allow() as cpuset and/or nodeset parameters.
Definition: hwloc.h:2260
HWLOC_OBJ_L1ICACHE
@ HWLOC_OBJ_L1ICACHE
Level 1 instruction Cache (filtered out by default).
Definition: hwloc.h:219
hwloc_obj::memory_first_child
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:463
HWLOC_MEMBIND_NOCPUBIND
@ HWLOC_MEMBIND_NOCPUBIND
Avoid any effect on CPU binding.
Definition: hwloc.h:1467
hwloc_topology_membind_support::set_proc_membind
unsigned char set_proc_membind
Definition: hwloc.h:2018
hwloc_obj_attr_u::hwloc_pcidev_attr_s::vendor_id
unsigned short vendor_id
Definition: hwloc.h:627
HWLOC_OBJ_OSDEV_COPROC
@ HWLOC_OBJ_OSDEV_COPROC
Operating system co-processor device. For instance "mic0" for a Xeon Phi (MIC) on Linux,...
Definition: hwloc.h:340
hwloc_obj::complete_nodeset
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:548
HWLOC_OBJ_PU
@ HWLOC_OBJ_PU
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:201
hwloc_topology_set_synthetic
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
hwloc_topology_dup
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
hwloc_topology_set_xml
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
hwloc_set_membind
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...
hwloc_topology_set_all_types_filter
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_obj_attr_u::hwloc_group_attr_s
Group-specific Object Attributes.
Definition: hwloc.h:611
hwloc_get_next_obj_by_type
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.
hwloc_obj::depth
int depth
Vertical index in the hierarchy.
Definition: hwloc.h:407
HWLOC_TYPE_DEPTH_OS_DEVICE
@ HWLOC_TYPE_DEPTH_OS_DEVICE
Virtual depth for software device object level.
Definition: hwloc.h:813
hwloc_get_thread_cpubind
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_OBJ_CACHE_DATA
@ HWLOC_OBJ_CACHE_DATA
Data cache.
Definition: hwloc.h:316
hwloc_obj_bridge_type_t
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
hwloc_topology_get_depth
int hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.