Hardware Locality (hwloc)  2.13.0rc2-git
hwloc.h
1 /*
2  * SPDX-License-Identifier: BSD-3-Clause
3  * Copyright © 2009 CNRS
4  * Copyright © 2009-2025 Inria. All rights reserved.
5  * Copyright © 2009-2012 Université Bordeaux
6  * Copyright © 2009-2020 Cisco Systems, Inc. All rights reserved.
7  * See COPYING in top-level directory.
8  */
9 
10 /*=====================================================================
11  * PLEASE GO READ THE DOCUMENTATION!
12  * ------------------------------------------------
13  * $tarball_directory/doc/doxygen-doc/
14  * or
15  * https://www.open-mpi.org/projects/hwloc/doc/
16  *=====================================================================
17  *
18  * FAIR WARNING: Do NOT expect to be able to figure out all the
19  * subtleties of hwloc by simply reading function prototypes and
20  * constant descrptions here in this file.
21  *
22  * Hwloc has wonderful documentation in both PDF and HTML formats for
23  * your reading pleasure. The formal documentation explains a LOT of
24  * hwloc-specific concepts, provides definitions, and discusses the
25  * "big picture" for many of the things that you'll find here in this
26  * header file.
27  *
28  * The PDF/HTML documentation was generated via Doxygen; much of what
29  * you'll see in there is also here in this file. BUT THERE IS A LOT
30  * THAT IS IN THE PDF/HTML THAT IS ***NOT*** IN hwloc.h!
31  *
32  * There are entire paragraph-length descriptions, discussions, and
33  * pretty pictures to explain subtle corner cases, provide concrete
34  * examples, etc.
35  *
36  * Please, go read the documentation. :-)
37  *
38  * Moreover there are several examples of hwloc use under doc/examples
39  * in the source tree.
40  *
41  *=====================================================================*/
42 
56 #ifndef HWLOC_H
57 #define HWLOC_H
58 
59 #include "hwloc/autogen/config.h"
60 
61 #include <sys/types.h>
62 #include <stdio.h>
63 #include <string.h>
64 #include <limits.h>
65 
66 /*
67  * Symbol transforms
68  */
69 #include "hwloc/rename.h"
70 
71 /*
72  * Bitmap definitions
73  */
74 
75 #include "hwloc/bitmap.h"
76 
77 
78 #ifdef __cplusplus
79 extern "C" {
80 #endif
81 
82 
118 #define HWLOC_API_VERSION 0x00020c00
119 
126 HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);
127 
129 #define HWLOC_COMPONENT_ABI 7
130 
168 
187 
202 typedef enum {
203 
205 #define HWLOC_OBJ_TYPE_MIN HWLOC_OBJ_MACHINE /* Sentinel value */
227  HWLOC_OBJ_PU,
349  HWLOC_OBJ_DIE,
360  HWLOC_OBJ_TYPE_MAX
362 
369 
375 
395 
418 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
419 
421 #define HWLOC_TYPE_UNORDERED INT_MAX
422 
431 union hwloc_obj_attr_u;
432 
437 struct hwloc_obj {
438  /* physical information */
440  char *subtype;
442  unsigned os_index;
447 #define HWLOC_UNKNOWN_INDEX (unsigned)-1
448 
449  char *name;
454  hwloc_uint64_t total_memory;
459  /* global position */
460  int depth;
475  unsigned logical_index;
482  /* cousins are all objects of the same type (and depth) across the entire topology */
486  /* children of the same parent are siblings, even if they may have different type and depth */
487  struct hwloc_obj *parent;
488  unsigned sibling_rank;
493  unsigned arity;
497  struct hwloc_obj **children;
513  unsigned memory_arity;
531  unsigned io_arity;
543  unsigned misc_arity;
552  /* cpusets and nodesets */
619  struct hwloc_info_s *infos;
620  unsigned infos_count;
622  /* misc */
623  void *userdata;
628  hwloc_uint64_t gp_index;
633 };
637 typedef struct hwloc_obj * hwloc_obj_t;
638 
643  hwloc_uint64_t local_memory;
644  unsigned page_types_len;
651  hwloc_uint64_t size;
652  hwloc_uint64_t count;
655 
658  hwloc_uint64_t size;
659  unsigned depth;
660  unsigned linesize;
664  } cache;
667  unsigned depth;
669  unsigned kind;
670  unsigned subkind;
671  unsigned char dont_merge;
672  } group;
675 #ifndef HWLOC_HAVE_32BITS_PCI_DOMAIN
676  unsigned short domain;
678 #else
679  unsigned int domain;
681 #endif
682  unsigned char bus;
683  unsigned char dev;
684  unsigned char func;
685  unsigned short class_id;
686  unsigned short vendor_id;
687  unsigned short device_id;
688  unsigned short subvendor_id;
689  unsigned short subdevice_id;
690  unsigned char revision;
691  float linkspeed;
700  union {
701  struct hwloc_pcidev_attr_s pci;
704  union {
705  struct {
706 #ifndef HWLOC_HAVE_32BITS_PCI_DOMAIN
707  unsigned short domain;
709 #else
710  unsigned int domain;
712 #endif
713  unsigned char secondary_bus;
714  unsigned char subordinate_bus;
715  } pci;
718  unsigned depth;
723  } osdev;
724 };
725 
730 struct hwloc_info_s {
731  char *name;
732  char *value;
733 };
734 
743 struct hwloc_topology;
748 typedef struct hwloc_topology * hwloc_topology_t;
749 
756 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
757 
778 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
779 
784 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
785 
798 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
799 
817 HWLOC_DECLSPEC int hwloc_topology_abi_check(hwloc_topology_t topology);
818 
830 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
831 
854 HWLOC_DECLSPEC int hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
855 
882 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
883 
893 };
894 
914 HWLOC_DECLSPEC int hwloc_get_memory_parents_depth (hwloc_topology_t topology);
915 
929 static __hwloc_inline int
930 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
931 
945 static __hwloc_inline int
946 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
947 
956 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, int depth) __hwloc_attribute_pure;
957 
963 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, int depth) __hwloc_attribute_pure;
964 
971 static __hwloc_inline int
972 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
973 
980 static __hwloc_inline hwloc_obj_t
981 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
982 
988 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, int depth, unsigned idx) __hwloc_attribute_pure;
989 
997 static __hwloc_inline hwloc_obj_t
998 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
999 
1006 static __hwloc_inline hwloc_obj_t
1008 
1017 static __hwloc_inline hwloc_obj_t
1019  hwloc_obj_t prev);
1020 
1039 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
1040 
1058 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size,
1059  hwloc_obj_t obj,
1060  int verbose);
1061 
1073 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size,
1074  hwloc_obj_t obj, const char * __hwloc_restrict separator,
1075  int verbose);
1076 
1100 HWLOC_DECLSPEC int hwloc_type_sscanf(const char *string,
1101  hwloc_obj_type_t *typep,
1102  union hwloc_obj_attr_u *attrp, size_t attrsize);
1103 
1125 HWLOC_DECLSPEC int hwloc_type_sscanf_as_depth(const char *string,
1126  hwloc_obj_type_t *typep,
1127  hwloc_topology_t topology, int *depthp);
1128 
1147 static __hwloc_inline const char *
1148 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1149 
1166 HWLOC_DECLSPEC int hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1167 
1182 HWLOC_DECLSPEC int hwloc_obj_set_subtype(hwloc_topology_t topology, hwloc_obj_t obj, const char *subtype);
1183 
1255 typedef enum {
1259 
1263 
1288 
1304  HWLOC_CPUBIND_NOMEMBIND = (1<<3)
1306 
1313 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1314 
1323 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1324 
1338 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1339 
1357 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1358 
1359 #ifdef hwloc_thread_t
1369 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1370 #endif
1371 
1372 #ifdef hwloc_thread_t
1386 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1387 #endif
1388 
1408 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1409 
1432 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1433 
1513 typedef enum {
1522 
1533 
1543 
1552 
1562 
1569 
1576  HWLOC_MEMBIND_MIXED = -1
1578 
1592 typedef enum {
1598 
1603 
1611 
1617 
1630 
1640  HWLOC_MEMBIND_BYNODESET = (1<<5)
1642 
1659 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
1660 
1710 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
1711 
1725 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);
1726 
1771 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);
1772 
1783 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);
1784 
1816 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);
1817 
1840 HWLOC_DECLSPEC int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags);
1841 
1851 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
1852 
1868 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;
1869 
1884 static __hwloc_inline void *
1885 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;
1886 
1892 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
1893 
1939 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
1940 
1972 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
1973 
2005 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
2006 
2039 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
2040 
2048 };
2049 
2067 HWLOC_DECLSPEC int hwloc_topology_set_components(hwloc_topology_t __hwloc_restrict topology, unsigned long flags, const char * __hwloc_restrict name);
2068 
2110 
2130 
2151 
2175 
2200 
2222 
2237 
2244 
2251 
2257 };
2258 
2273 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
2274 
2286 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
2287 
2297 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
2298 
2302  unsigned char pu;
2304  unsigned char numa;
2306  unsigned char numa_memory;
2308  unsigned char disallowed_pu;
2310  unsigned char disallowed_numa;
2312  unsigned char cpukind_efficiency;
2313 };
2314 
2322  unsigned char set_thisproc_cpubind;
2324  unsigned char get_thisproc_cpubind;
2326  unsigned char set_proc_cpubind;
2328  unsigned char get_proc_cpubind;
2330  unsigned char set_thisthread_cpubind;
2332  unsigned char get_thisthread_cpubind;
2334  unsigned char set_thread_cpubind;
2336  unsigned char get_thread_cpubind;
2343 };
2344 
2352  unsigned char set_thisproc_membind;
2354  unsigned char get_thisproc_membind;
2356  unsigned char set_proc_membind;
2358  unsigned char get_proc_membind;
2360  unsigned char set_thisthread_membind;
2362  unsigned char get_thisthread_membind;
2364  unsigned char set_area_membind;
2366  unsigned char get_area_membind;
2368  unsigned char alloc_membind;
2370  unsigned char firsttouch_membind;
2372  unsigned char bind_membind;
2374  unsigned char interleave_membind;
2376  unsigned char nexttouch_membind;
2378  unsigned char migrate_membind;
2380  unsigned char get_area_memlocation;
2383 };
2384 
2389  unsigned char imported_support;
2390 };
2391 
2403 };
2404 
2434 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
2435 
2452 
2460 
2474 
2489 };
2490 
2496 
2502 
2510 
2518 
2526 
2532 
2543 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
2544 
2553 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
2554 
2571 
2577 
2584 
2590 
2595  HWLOC_RESTRICT_FLAG_ADAPT_IO = (1UL<<2)
2596 };
2597 
2633 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_bitmap_t set, unsigned long flags);
2634 
2642 
2651 
2654  HWLOC_ALLOW_FLAG_CUSTOM = (1UL<<2)
2655 };
2656 
2674 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);
2675 
2700 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2701 
2720 
2733 
2811 
2825 
2843 HWLOC_DECLSPEC int hwloc_topology_refresh(hwloc_topology_t topology);
2844 
2849 #ifdef __cplusplus
2850 } /* extern "C" */
2851 #endif
2852 
2853 
2854 /* high-level helpers */
2855 #include "hwloc/helper.h"
2856 
2857 /* inline code of some functions above */
2858 #include "hwloc/inlines.h"
2859 
2860 /* memory attributes */
2861 #include "hwloc/memattrs.h"
2862 
2863 /* kinds of CPU cores */
2864 #include "hwloc/cpukinds.h"
2865 
2866 /* exporting to XML or synthetic */
2867 #include "hwloc/export.h"
2868 
2869 /* distances */
2870 #include "hwloc/distances.h"
2871 
2872 /* topology diffs */
2873 #include "hwloc/diff.h"
2874 
2875 /* deprecated headers */
2876 #include "hwloc/deprecated.h"
2877 
2878 #endif /* HWLOC_H */
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:70
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:72
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR'ed flags of a topology.
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.
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.
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
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_set_icache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all CPU instruction cache object types.
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
hwloc_type_filter_e
Type filtering flags.
Definition: hwloc.h:2445
int hwloc_topology_set_all_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all object types.
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR'ed flags to non-yet-loaded topology.
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
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_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:2087
@ HWLOC_TYPE_FILTER_KEEP_NONE
Ignore all objects of this type.
Definition: hwloc.h:2459
@ HWLOC_TYPE_FILTER_KEEP_IMPORTANT
Only keep likely-important objects of the given type.
Definition: hwloc.h:2488
@ HWLOC_TYPE_FILTER_KEEP_STRUCTURE
Only ignore objects if their entire level does not bring any structure.
Definition: hwloc.h:2473
@ HWLOC_TYPE_FILTER_KEEP_ALL
Keep all objects of this type.
Definition: hwloc.h:2451
@ HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED
Detect the whole system, ignore reservations, include disallowed objects.
Definition: hwloc.h:2109
@ 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:2150
@ HWLOC_TOPOLOGY_FLAG_NO_CPUKINDS
Ignore CPU Kinds.
Definition: hwloc.h:2256
@ HWLOC_TOPOLOGY_FLAG_RESTRICT_TO_MEMBINDING
Do not consider resources outside of the process memory binding.
Definition: hwloc.h:2221
@ HWLOC_TOPOLOGY_FLAG_NO_DISTANCES
Ignore distances.
Definition: hwloc.h:2243
@ HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM
Assume that the selected backend provides the topology for the system on which we are running.
Definition: hwloc.h:2129
@ HWLOC_TOPOLOGY_FLAG_RESTRICT_TO_CPUBINDING
Do not consider resources outside of the process CPU binding.
Definition: hwloc.h:2199
@ HWLOC_TOPOLOGY_FLAG_NO_MEMATTRS
Ignore memory attributes and tiers.
Definition: hwloc.h:2250
@ HWLOC_TOPOLOGY_FLAG_IMPORT_SUPPORT
Import support from the imported topology.
Definition: hwloc.h:2174
@ HWLOC_TOPOLOGY_FLAG_DONT_CHANGE_BINDING
Do not ever modify the process or thread binding during discovery.
Definition: hwloc.h:2236
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1255
int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags)
Bind a process pid on CPUs given in physical bitmap set.
int hwloc_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 hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags)
Get the last physical CPU where a process ran.
int hwloc_get_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_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
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.
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.
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_CPUBIND_PROCESS
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1258
@ HWLOC_CPUBIND_NOMEMBIND
Avoid any effect on memory binding.
Definition: hwloc.h:1304
@ HWLOC_CPUBIND_STRICT
Request for strict binding from the OS.
Definition: hwloc.h:1287
@ HWLOC_CPUBIND_THREAD
Bind current thread of current process.
Definition: hwloc.h:1262
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
int hwloc_topology_abi_check(hwloc_topology_t topology)
Verify that the topology is compatible with the current hwloc library.
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:748
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
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_obj_set_subtype(hwloc_topology_t topology, hwloc_obj_t obj, const char *subtype)
Set (or replace) the subtype of an object.
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.
int hwloc_get_type_or_above_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type or above.
hwloc_obj_t hwloc_get_obj_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx)
Returns the topology object at logical index idx with type type.
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, int depth)
Returns the width of level at depth 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_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, int depth)
Returns the type of objects at depth depth.
int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
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_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_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
int hwloc_get_type_or_below_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type or below.
int hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
int hwloc_get_memory_parents_depth(hwloc_topology_t topology)
Return the depth of parents where memory objects are attached.
hwloc_get_type_depth_e
Definition: hwloc.h:884
@ HWLOC_TYPE_DEPTH_UNKNOWN
No object of given type exists in the topology.
Definition: hwloc.h:885
@ HWLOC_TYPE_DEPTH_NUMANODE
Virtual depth for NUMA nodes.
Definition: hwloc.h:887
@ HWLOC_TYPE_DEPTH_MEMCACHE
Virtual depth for MemCache object.
Definition: hwloc.h:892
@ HWLOC_TYPE_DEPTH_MISC
Virtual depth for Misc object.
Definition: hwloc.h:891
@ HWLOC_TYPE_DEPTH_PCI_DEVICE
Virtual depth for PCI device object level.
Definition: hwloc.h:889
@ HWLOC_TYPE_DEPTH_MULTIPLE
Objects of given type exist at different depth in the topology (only for Groups).
Definition: hwloc.h:886
@ HWLOC_TYPE_DEPTH_BRIDGE
Virtual depth for bridge object level.
Definition: hwloc.h:888
@ HWLOC_TYPE_DEPTH_OS_DEVICE
Virtual depth for software device object level.
Definition: hwloc.h:890
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...
void * hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by set.
void * hwloc_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.
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.
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().
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.
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
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_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1592
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_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1513
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.
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_MEMBIND_STRICT
Definition: hwloc.h:1610
@ HWLOC_MEMBIND_PROCESS
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1597
@ HWLOC_MEMBIND_THREAD
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1602
@ HWLOC_MEMBIND_BYNODESET
Consider the bitmap argument as a nodeset.
Definition: hwloc.h:1640
@ HWLOC_MEMBIND_MIGRATE
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1616
@ HWLOC_MEMBIND_NOCPUBIND
Avoid any effect on CPU binding.
Definition: hwloc.h:1629
@ HWLOC_MEMBIND_DEFAULT
Reset the memory allocation policy to the system default. Depending on the operating system,...
Definition: hwloc.h:1521
@ HWLOC_MEMBIND_MIXED
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1576
@ HWLOC_MEMBIND_FIRSTTOUCH
Allocate each memory page individually on the local NUMA node of the thread that touches it.
Definition: hwloc.h:1532
@ HWLOC_MEMBIND_WEIGHTED_INTERLEAVE
Allocate memory on the given nodes in an interleaved / weighted manner. The precise layout of the mem...
Definition: hwloc.h:1561
@ HWLOC_MEMBIND_BIND
Allocate memory on the specified nodes.
Definition: hwloc.h:1542
@ HWLOC_MEMBIND_INTERLEAVE
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1551
@ HWLOC_MEMBIND_NEXTTOUCH
For each page bound with this policy, by next time it is touched (and next time only),...
Definition: hwloc.h:1568
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:167
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:186
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:183
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:165
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.
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.
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a constant stringified object type.
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.
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.
int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:371
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:377
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:364
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:202
@ HWLOC_OBJ_BRIDGE_HOST
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:372
@ HWLOC_OBJ_BRIDGE_PCI
PCI-side of a bridge.
Definition: hwloc.h:373
@ HWLOC_OBJ_OSDEV_COPROC
Operating system co-processor device. For instance "opencl0d0" for a OpenCL device,...
Definition: hwloc.h:391
@ HWLOC_OBJ_OSDEV_OPENFABRICS
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA, "hfi1_0" Omni-Path int...
Definition: hwloc.h:385
@ HWLOC_OBJ_OSDEV_BLOCK
Operating system block device, or non-volatile memory device. For instance "sda" or "dax2....
Definition: hwloc.h:378
@ HWLOC_OBJ_OSDEV_DMA
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:389
@ 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:380
@ HWLOC_OBJ_OSDEV_NETWORK
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:383
@ HWLOC_OBJ_CACHE_UNIFIED
Unified cache.
Definition: hwloc.h:365
@ HWLOC_OBJ_CACHE_INSTRUCTION
Instruction cache (filtered out by default).
Definition: hwloc.h:367
@ HWLOC_OBJ_CACHE_DATA
Data cache.
Definition: hwloc.h:366
@ HWLOC_OBJ_MEMCACHE
Memory-side cache (filtered out by default). A cache in front of a specific NUMA node.
Definition: hwloc.h:336
@ HWLOC_OBJ_L2ICACHE
Level 2 instruction Cache (filtered out by default).
Definition: hwloc.h:246
@ HWLOC_OBJ_L2CACHE
Level 2 Data (or Unified) Cache.
Definition: hwloc.h:240
@ HWLOC_OBJ_MISC
Miscellaneous objects (filtered out by default). Objects without particular meaning,...
Definition: hwloc.h:321
@ HWLOC_OBJ_L3CACHE
Level 3 Data (or Unified) Cache.
Definition: hwloc.h:241
@ HWLOC_OBJ_MACHINE
Machine. A set of processors and memory with cache coherency.
Definition: hwloc.h:208
@ HWLOC_OBJ_OS_DEVICE
Operating system device (filtered out by default).
Definition: hwloc.h:310
@ 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:249
@ HWLOC_OBJ_L4CACHE
Level 4 Data (or Unified) Cache.
Definition: hwloc.h:242
@ HWLOC_OBJ_L1CACHE
Level 1 Data (or Unified) Cache.
Definition: hwloc.h:239
@ HWLOC_OBJ_PCI_DEVICE
PCI device (filtered out by default).
Definition: hwloc.h:300
@ HWLOC_OBJ_L5CACHE
Level 5 Data (or Unified) Cache.
Definition: hwloc.h:243
@ 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:288
@ HWLOC_OBJ_NUMANODE
NUMA node. An object that contains memory that is directly and byte-accessible to the host processors...
Definition: hwloc.h:262
@ HWLOC_OBJ_PACKAGE
Physical package. The physical package that usually gets inserted into a socket on the motherboard....
Definition: hwloc.h:217
@ HWLOC_OBJ_PU
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:227
@ HWLOC_OBJ_L3ICACHE
Level 3 instruction Cache (filtered out by default).
Definition: hwloc.h:247
@ HWLOC_OBJ_CORE
Core. A computation unit (may be shared by several PUs, aka logical processors).
Definition: hwloc.h:223
@ HWLOC_OBJ_DIE
Die within a physical package. A subpart of the physical package, that contains multiple cores.
Definition: hwloc.h:349
@ HWLOC_OBJ_L1ICACHE
Level 1 instruction Cache (filtered out by default).
Definition: hwloc.h:245
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:637
int hwloc_topology_set_xmlbuffer(hwloc_topology_t restrict topology, const char *restrict buffer, int size)
Enable XML based topology using a memory buffer (instead of a file, as with hwloc_topology_set_xml())...
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which process the topology is viewed from.
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
hwloc_topology_components_flag_e
Flags to be passed to hwloc_topology_set_components()
Definition: hwloc.h:2043
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_TOPOLOGY_COMPONENTS_FLAG_BLACKLIST
Blacklist the target component from being used.
Definition: hwloc.h:2047
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_allow_flags_e
Flags to be given to hwloc_topology_allow().
Definition: hwloc.h:2636
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().
int hwloc_topology_refresh(hwloc_topology_t topology)
Refresh internal structures after topology modification.
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_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2564
int hwloc_topology_free_group_object(hwloc_topology_t topology, hwloc_obj_t group)
Free a group object allocated with hwloc_topology_alloc_group_object().
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_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_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_ALLOW_FLAG_CUSTOM
Allow a custom set of objects, given to hwloc_topology_allow() as cpuset and/or nodeset parameters.
Definition: hwloc.h:2654
@ HWLOC_ALLOW_FLAG_LOCAL_RESTRICTIONS
Only allow objects that are available to the current process.
Definition: hwloc.h:2650
@ HWLOC_ALLOW_FLAG_ALL
Mark all objects as allowed in the topology.
Definition: hwloc.h:2641
@ 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:2589
@ 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:2570
@ 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:2595
@ HWLOC_RESTRICT_FLAG_BYNODESET
Restrict by nodeset instead of CPU set. Only keep objects whose nodeset is included or partially incl...
Definition: hwloc.h:2576
@ 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:2583
Object info attribute (name and value strings)
Definition: hwloc.h:730
char * name
Info name.
Definition: hwloc.h:731
char * value
Info value.
Definition: hwloc.h:732
Bridge specific Object Attributes.
Definition: hwloc.h:699
hwloc_obj_bridge_type_t upstream_type
Upstream Bridge type.
Definition: hwloc.h:703
unsigned short domain
Domain number the downstream PCI buses. Only 16bits PCI domains are supported by default.
Definition: hwloc.h:707
unsigned depth
Definition: hwloc.h:718
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
struct hwloc_pcidev_attr_s pci
PCI attribute of the upstream part as a PCI device.
Definition: hwloc.h:701
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@0 upstream
hwloc_obj_bridge_type_t downstream_type
Downstream Bridge type.
Definition: hwloc.h:717
unsigned char secondary_bus
First PCI bus number below the bridge.
Definition: hwloc.h:713
unsigned char subordinate_bus
Highest PCI bus number below the bridge.
Definition: hwloc.h:714
Cache-specific Object Attributes.
Definition: hwloc.h:657
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:659
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:660
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:658
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:661
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:663
Group-specific Object Attributes.
Definition: hwloc.h:666
unsigned kind
Internally-used kind of group.
Definition: hwloc.h:669
unsigned subkind
Internally-used subkind to distinguish different levels of groups with same kind.
Definition: hwloc.h:670
unsigned depth
Depth of group object. It may change if intermediate Group objects are added.
Definition: hwloc.h:667
unsigned char dont_merge
Flag preventing groups from being automatically merged with identical parent or children.
Definition: hwloc.h:671
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:650
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:651
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:652
NUMA node-specific Object Attributes.
Definition: hwloc.h:642
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:644
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:643
struct hwloc_obj_attr_u::hwloc_numanode_attr_s::hwloc_memory_page_type_s * page_types
OS Device specific Object Attributes.
Definition: hwloc.h:721
hwloc_obj_osdev_type_t type
Definition: hwloc.h:722
PCI Device specific Object Attributes.
Definition: hwloc.h:674
unsigned char revision
Revision number.
Definition: hwloc.h:690
unsigned short device_id
Device ID (yyyy in [xxxx:yyyy]).
Definition: hwloc.h:687
unsigned char dev
Device number (zz in the PCI BDF notation xxxx:yy:zz.t).
Definition: hwloc.h:683
unsigned short subvendor_id
Sub-Vendor ID.
Definition: hwloc.h:688
float linkspeed
Link speed in GB/s. This datarate is the currently configured speed of the entire PCI link (sum of th...
Definition: hwloc.h:691
unsigned char func
Function number (t in the PCI BDF notation xxxx:yy:zz.t).
Definition: hwloc.h:684
unsigned short domain
Domain number (xxxx in the PCI BDF notation xxxx:yy:zz.t). Only 16bits PCI domains are supported by d...
Definition: hwloc.h:676
unsigned short vendor_id
Vendor ID (xxxx in [xxxx:yyyy]).
Definition: hwloc.h:686
unsigned char bus
Bus number (yy in the PCI BDF notation xxxx:yy:zz.t).
Definition: hwloc.h:682
unsigned short subdevice_id
Sub-Device ID.
Definition: hwloc.h:689
unsigned short class_id
The class number (first two bytes, without the prog_if).
Definition: hwloc.h:685
Structure of a topology object.
Definition: hwloc.h:437
struct hwloc_obj ** children
Normal children, children[0 .. arity -1].
Definition: hwloc.h:497
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:581
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:475
int symmetric_subtree
Set if the subtree of normal objects below this object is symmetric, which means all normal children ...
Definition: hwloc.h:502
unsigned misc_arity
Number of Misc children. These children are listed in misc_first_child.
Definition: hwloc.h:543
int depth
Vertical index in the hierarchy.
Definition: hwloc.h:460
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:546
char * subtype
Subtype string to better describe the type field.
Definition: hwloc.h:440
unsigned os_index
OS-provided physical index number. It is not guaranteed unique across the entire machine,...
Definition: hwloc.h:442
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:553
unsigned memory_arity
Number of Memory children. These children are listed in memory_first_child.
Definition: hwloc.h:513
hwloc_uint64_t total_memory
Total memory (in bytes) in NUMA nodes below this object.
Definition: hwloc.h:454
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:623
unsigned io_arity
Number of I/O children. These children are listed in io_first_child.
Definition: hwloc.h:531
struct hwloc_obj * prev_sibling
Previous object below the same parent (inside the same list of children).
Definition: hwloc.h:490
struct hwloc_obj * next_sibling
Next object below the same parent (inside the same list of children).
Definition: hwloc.h:489
struct hwloc_obj * last_child
Last normal child.
Definition: hwloc.h:499
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:483
struct hwloc_info_s * infos
Array of info attributes (name and value strings).
Definition: hwloc.h:619
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:534
hwloc_cpuset_t complete_cpuset
The complete CPU set of processors of this object,.
Definition: hwloc.h:568
hwloc_uint64_t gp_index
Global persistent index. Generated by hwloc, unique across the topology (contrary to os_index) and pe...
Definition: hwloc.h:628
unsigned infos_count
Size of infos array.
Definition: hwloc.h:620
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:488
unsigned arity
Number of normal children. Memory, Misc and I/O children are not listed here but rather in their dedi...
Definition: hwloc.h:493
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:449
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:516
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:603
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:484
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:439
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:456
struct hwloc_obj * parent
Parent, NULL if root (Machine object)
Definition: hwloc.h:487
struct hwloc_obj * first_child
First normal child.
Definition: hwloc.h:498
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:2320
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:2340
unsigned char set_thread_cpubind
Definition: hwloc.h:2334
unsigned char set_thisthread_cpubind
Definition: hwloc.h:2330
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:2342
unsigned char get_thisproc_cpubind
Definition: hwloc.h:2324
unsigned char get_thisthread_cpubind
Definition: hwloc.h:2332
unsigned char get_thread_cpubind
Definition: hwloc.h:2336
unsigned char set_thisproc_cpubind
Definition: hwloc.h:2322
unsigned char set_proc_cpubind
Definition: hwloc.h:2326
unsigned char get_proc_cpubind
Definition: hwloc.h:2328
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:2338
Flags describing actual discovery support for this topology.
Definition: hwloc.h:2300
unsigned char numa
Detecting the number of NUMA nodes is supported.
Definition: hwloc.h:2304
unsigned char disallowed_numa
Detecting and identifying NUMA nodes that are not available to the current process is supported.
Definition: hwloc.h:2310
unsigned char cpukind_efficiency
Detecting the efficiency of CPU kinds is supported, see Kinds of CPU cores.
Definition: hwloc.h:2312
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:2302
unsigned char numa_memory
Detecting the amount of memory in NUMA nodes is supported.
Definition: hwloc.h:2306
unsigned char disallowed_pu
Detecting and identifying PU objects that are not available to the current process is supported.
Definition: hwloc.h:2308
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:2350
unsigned char set_thisthread_membind
Definition: hwloc.h:2360
unsigned char get_area_membind
Definition: hwloc.h:2366
unsigned char firsttouch_membind
Definition: hwloc.h:2370
unsigned char get_area_memlocation
Definition: hwloc.h:2380
unsigned char set_thisproc_membind
Definition: hwloc.h:2352
unsigned char interleave_membind
Definition: hwloc.h:2374
unsigned char get_thisproc_membind
Definition: hwloc.h:2354
unsigned char set_area_membind
Definition: hwloc.h:2364
unsigned char weighted_interleave_membind
Definition: hwloc.h:2382
unsigned char get_thisthread_membind
Definition: hwloc.h:2362
unsigned char set_proc_membind
Definition: hwloc.h:2356
unsigned char get_proc_membind
Definition: hwloc.h:2358
unsigned char migrate_membind
Definition: hwloc.h:2378
unsigned char nexttouch_membind
Definition: hwloc.h:2376
unsigned char alloc_membind
Definition: hwloc.h:2368
unsigned char bind_membind
Definition: hwloc.h:2372
Flags describing miscellaneous features.
Definition: hwloc.h:2387
unsigned char imported_support
Definition: hwloc.h:2389
Set of flags describing actual support for this topology.
Definition: hwloc.h:2398
struct hwloc_topology_misc_support * misc
Definition: hwloc.h:2402
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:2401
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:2400
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:2399
Object type-specific Attributes.
Definition: hwloc.h:640
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
struct hwloc_obj_attr_u::hwloc_bridge_attr_s bridge
struct hwloc_obj_attr_u::hwloc_cache_attr_s cache
struct hwloc_obj_attr_u::hwloc_group_attr_s group
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
struct hwloc_obj_attr_u::hwloc_numanode_attr_s numanode