Open MPI logo

Portable Hardware Locality (hwloc) Documentation: v2.7.1

  |   Home   |   Support   |   FAQ   |  
hwloc.h
1 /*
2  * Copyright © 2009 CNRS
3  * Copyright © 2009-2021 Inria. All rights reserved.
4  * Copyright © 2009-2012 Université Bordeaux
5  * Copyright © 2009-2020 Cisco Systems, Inc. All rights reserved.
6  * See COPYING in top-level directory.
7  */
8 
9 /*=====================================================================
10  * PLEASE GO READ THE DOCUMENTATION!
11  * ------------------------------------------------
12  * $tarball_directory/doc/doxygen-doc/
13  * or
14  * https://www.open-mpi.org/projects/hwloc/doc/
15  *=====================================================================
16  *
17  * FAIR WARNING: Do NOT expect to be able to figure out all the
18  * subtleties of hwloc by simply reading function prototypes and
19  * constant descrptions here in this file.
20  *
21  * Hwloc has wonderful documentation in both PDF and HTML formats for
22  * your reading pleasure. The formal documentation explains a LOT of
23  * hwloc-specific concepts, provides definitions, and discusses the
24  * "big picture" for many of the things that you'll find here in this
25  * header file.
26  *
27  * The PDF/HTML documentation was generated via Doxygen; much of what
28  * you'll see in there is also here in this file. BUT THERE IS A LOT
29  * THAT IS IN THE PDF/HTML THAT IS ***NOT*** IN hwloc.h!
30  *
31  * There are entire paragraph-length descriptions, discussions, and
32  * pretty pictures to explain subtle corner cases, provide concrete
33  * examples, etc.
34  *
35  * Please, go read the documentation. :-)
36  *
37  * Moreover there are several examples of hwloc use under doc/examples
38  * in the source tree.
39  *
40  *=====================================================================*/
41 
53 #ifndef HWLOC_H
54 #define HWLOC_H
55 
56 #include "hwloc/autogen/config.h"
57 
58 #include <sys/types.h>
59 #include <stdio.h>
60 #include <string.h>
61 #include <limits.h>
62 
63 /*
64  * Symbol transforms
65  */
66 #include "hwloc/rename.h"
67 
68 /*
69  * Bitmap definitions
70  */
71 
72 #include "hwloc/bitmap.h"
73 
74 
75 #ifdef __cplusplus
76 extern "C" {
77 #endif
78 
79 
96 #define HWLOC_API_VERSION 0x00020500
97 
102 HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);
103 
105 #define HWLOC_COMPONENT_ABI 7
106 
143 
161 
176 typedef enum {
177 
179 #define HWLOC_OBJ_TYPE_MIN HWLOC_OBJ_MACHINE /* Sentinel value */
201  HWLOC_OBJ_PU,
318  HWLOC_OBJ_DIE,
322  HWLOC_OBJ_TYPE_MAX
324 
331 
337 
357 
377 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
378 
380 #define HWLOC_TYPE_UNORDERED INT_MAX
381 
390 union hwloc_obj_attr_u;
391 
396 struct hwloc_obj {
397  /* physical information */
399  char *subtype;
401  unsigned os_index;
406 #define HWLOC_UNKNOWN_INDEX (unsigned)-1
407 
408  char *name;
413  hwloc_uint64_t total_memory;
418  /* global position */
419  int depth;
434  unsigned logical_index;
441  /* cousins are all objects of the same type (and depth) across the entire topology */
445  /* children of the same parent are siblings, even if they may have different type and depth */
446  struct hwloc_obj *parent;
447  unsigned sibling_rank;
452  unsigned arity;
456  struct hwloc_obj **children;
472  unsigned memory_arity;
490  unsigned io_arity;
502  unsigned misc_arity;
511  /* cpusets and nodesets */
578  struct hwloc_info_s *infos;
579  unsigned infos_count;
581  /* misc */
582  void *userdata;
587  hwloc_uint64_t gp_index;
592 };
596 typedef struct hwloc_obj * hwloc_obj_t;
597 
602  hwloc_uint64_t local_memory;
603  unsigned page_types_len;
610  hwloc_uint64_t size;
611  hwloc_uint64_t count;
614 
617  hwloc_uint64_t size;
618  unsigned depth;
619  unsigned linesize;
623  } cache;
626  unsigned depth;
628  unsigned kind;
629  unsigned subkind;
630  unsigned char dont_merge;
631  } group;
634 #ifndef HWLOC_HAVE_32BITS_PCI_DOMAIN
635  unsigned short domain; /* Only 16bits PCI domains are supported by default */
636 #else
637  unsigned int domain; /* 32bits PCI domain support break the library ABI, hence it's disabled by default */
638 #endif
639  unsigned char bus, dev, func;
640  unsigned short class_id;
642  unsigned char revision;
643  float linkspeed; /* in GB/s */
647  union {
648  struct hwloc_pcidev_attr_s pci;
651  union {
652  struct {
653 #ifndef HWLOC_HAVE_32BITS_PCI_DOMAIN
654  unsigned short domain; /* Only 16bits PCI domains are supported by default */
655 #else
656  unsigned int domain; /* 32bits PCI domain support break the library ABI, hence it's disabled by default */
657 #endif
659  } pci;
662  unsigned depth;
667  } osdev;
668 };
669 
674 struct hwloc_info_s {
675  char *name;
676  char *value;
677 };
678 
687 struct hwloc_topology;
692 typedef struct hwloc_topology * hwloc_topology_t;
693 
700 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
701 
722 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
723 
728 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
729 
740 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
741 
759 HWLOC_DECLSPEC int hwloc_topology_abi_check(hwloc_topology_t topology);
760 
772 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
773 
794 HWLOC_DECLSPEC int hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
795 
819 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
820 
830 };
831 
851 HWLOC_DECLSPEC int hwloc_get_memory_parents_depth (hwloc_topology_t topology);
852 
866 static __hwloc_inline int
867 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
868 
882 static __hwloc_inline int
883 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
884 
892 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, int depth) __hwloc_attribute_pure;
893 
896 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, int depth) __hwloc_attribute_pure;
897 
903 static __hwloc_inline int
904 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
905 
910 static __hwloc_inline hwloc_obj_t
911 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
912 
914 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, int depth, unsigned idx) __hwloc_attribute_pure;
915 
922 static __hwloc_inline hwloc_obj_t
923 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
924 
929 static __hwloc_inline hwloc_obj_t
931 
938 static __hwloc_inline hwloc_obj_t
940  hwloc_obj_t prev);
941 
958 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
959 
977 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size,
978  hwloc_obj_t obj,
979  int verbose);
980 
992 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size,
993  hwloc_obj_t obj, const char * __hwloc_restrict separator,
994  int verbose);
995 
1019 HWLOC_DECLSPEC int hwloc_type_sscanf(const char *string,
1020  hwloc_obj_type_t *typep,
1021  union hwloc_obj_attr_u *attrp, size_t attrsize);
1022 
1044 HWLOC_DECLSPEC int hwloc_type_sscanf_as_depth(const char *string,
1045  hwloc_obj_type_t *typep,
1046  hwloc_topology_t topology, int *depthp);
1047 
1063 static __hwloc_inline const char *
1064 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1065 
1082 HWLOC_DECLSPEC int hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1083 
1155 typedef enum {
1159 
1163 
1188 
1204  HWLOC_CPUBIND_NOMEMBIND = (1<<3)
1206 
1212 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1213 
1220 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1221 
1233 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1234 
1250 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1251 
1252 #ifdef hwloc_thread_t
1260 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1261 #endif
1262 
1263 #ifdef hwloc_thread_t
1275 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1276 #endif
1277 
1295 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1296 
1317 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1318 
1398 typedef enum {
1407 
1418 
1422 
1431 
1438 
1445  HWLOC_MEMBIND_MIXED = -1
1447 
1461 typedef enum {
1467 
1472 
1480 
1486 
1499 
1509  HWLOC_MEMBIND_BYNODESET = (1<<5)
1511 
1527 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
1528 
1576 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
1577 
1590 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);
1591 
1634 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);
1635 
1646 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);
1647 
1678 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);
1679 
1700 HWLOC_DECLSPEC int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags);
1701 
1709 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
1710 
1725 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;
1726 
1739 static __hwloc_inline void *
1740 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;
1741 
1745 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
1746 
1783 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
1784 
1813 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
1814 
1841 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
1842 
1869 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
1870 
1878 };
1879 
1894 HWLOC_DECLSPEC int hwloc_topology_set_components(hwloc_topology_t __hwloc_restrict topology, unsigned long flags, const char * __hwloc_restrict name);
1895 
1937 
1957 
1978 
2002 
2027 
2049 
2064 };
2065 
2077 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
2078 
2088 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
2089 
2097 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
2098 
2102  unsigned char pu;
2104  unsigned char numa;
2106  unsigned char numa_memory;
2108  unsigned char disallowed_pu;
2110  unsigned char disallowed_numa;
2112  unsigned char cpukind_efficiency;
2113 };
2114 
2122  unsigned char set_thisproc_cpubind;
2124  unsigned char get_thisproc_cpubind;
2126  unsigned char set_proc_cpubind;
2128  unsigned char get_proc_cpubind;
2130  unsigned char set_thisthread_cpubind;
2132  unsigned char get_thisthread_cpubind;
2134  unsigned char set_thread_cpubind;
2136  unsigned char get_thread_cpubind;
2143 };
2144 
2152  unsigned char set_thisproc_membind;
2154  unsigned char get_thisproc_membind;
2156  unsigned char set_proc_membind;
2158  unsigned char get_proc_membind;
2160  unsigned char set_thisthread_membind;
2162  unsigned char get_thisthread_membind;
2164  unsigned char set_area_membind;
2166  unsigned char get_area_membind;
2168  unsigned char alloc_membind;
2170  unsigned char firsttouch_membind;
2172  unsigned char bind_membind;
2174  unsigned char interleave_membind;
2176  unsigned char nexttouch_membind;
2178  unsigned char migrate_membind;
2180  unsigned char get_area_memlocation;
2181 };
2182 
2187  unsigned char imported_support;
2188 };
2189 
2201 };
2202 
2224 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
2225 
2242 
2250 
2264 
2279 };
2280 
2284 
2288 
2294 
2300 
2306 
2310 
2321 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
2322 
2328 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
2329 
2346 
2352 
2359 
2365 
2370  HWLOC_RESTRICT_FLAG_ADAPT_IO = (1UL<<2)
2371 };
2372 
2397 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_bitmap_t set, unsigned long flags);
2398 
2406 
2415 
2418  HWLOC_ALLOW_FLAG_CUSTOM = (1UL<<2)
2419 };
2420 
2436 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);
2437 
2459 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2460 
2469 
2517 
2528 
2543 HWLOC_DECLSPEC int hwloc_topology_refresh(hwloc_topology_t topology);
2544 
2549 #ifdef __cplusplus
2550 } /* extern "C" */
2551 #endif
2552 
2553 
2554 /* high-level helpers */
2555 #include "hwloc/helper.h"
2556 
2557 /* inline code of some functions above */
2558 #include "hwloc/inlines.h"
2559 
2560 /* memory attributes */
2561 #include "hwloc/memattrs.h"
2562 
2563 /* kinds of CPU cores */
2564 #include "hwloc/cpukinds.h"
2565 
2566 /* exporting to XML or synthetic */
2567 #include "hwloc/export.h"
2568 
2569 /* distances */
2570 #include "hwloc/distances.h"
2571 
2572 /* topology diffs */
2573 #include "hwloc/diff.h"
2574 
2575 /* deprecated headers */
2576 #include "hwloc/deprecated.h"
2577 
2578 #endif /* HWLOC_H */
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:142
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:160
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_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
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:333
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:339
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:326
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:176
@ HWLOC_OBJ_BRIDGE_HOST
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:334
@ HWLOC_OBJ_BRIDGE_PCI
PCI-side of a bridge.
Definition: hwloc.h:335
@ HWLOC_OBJ_OSDEV_COPROC
Operating system co-processor device. For instance "opencl0d0" for a OpenCL device,...
Definition: hwloc.h:353
@ HWLOC_OBJ_OSDEV_OPENFABRICS
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA, "hfi1_0" Omni-Path int...
Definition: hwloc.h:347
@ HWLOC_OBJ_OSDEV_BLOCK
Operating system block device, or non-volatile memory device. For instance "sda" or "dax2....
Definition: hwloc.h:340
@ HWLOC_OBJ_OSDEV_DMA
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:351
@ 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:342
@ HWLOC_OBJ_OSDEV_NETWORK
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:345
@ HWLOC_OBJ_CACHE_UNIFIED
Unified cache.
Definition: hwloc.h:327
@ HWLOC_OBJ_CACHE_INSTRUCTION
Instruction cache (filtered out by default).
Definition: hwloc.h:329
@ HWLOC_OBJ_CACHE_DATA
Data cache.
Definition: hwloc.h:328
@ HWLOC_OBJ_MEMCACHE
Memory-side cache (filtered out by default). A cache in front of a specific NUMA node.
Definition: hwloc.h:305
@ HWLOC_OBJ_L2ICACHE
Level 2 instruction Cache (filtered out by default).
Definition: hwloc.h:220
@ HWLOC_OBJ_L2CACHE
Level 2 Data (or Unified) Cache.
Definition: hwloc.h:214
@ HWLOC_OBJ_MISC
Miscellaneous objects (filtered out by default). Objects without particular meaning,...
Definition: hwloc.h:290
@ HWLOC_OBJ_L3CACHE
Level 3 Data (or Unified) Cache.
Definition: hwloc.h:215
@ HWLOC_OBJ_MACHINE
Machine. A set of processors and memory with cache coherency.
Definition: hwloc.h:182
@ HWLOC_OBJ_OS_DEVICE
Operating system device (filtered out by default).
Definition: hwloc.h:279
@ 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_L4CACHE
Level 4 Data (or Unified) Cache.
Definition: hwloc.h:216
@ HWLOC_OBJ_L1CACHE
Level 1 Data (or Unified) Cache.
Definition: hwloc.h:213
@ HWLOC_OBJ_PCI_DEVICE
PCI device (filtered out by default).
Definition: hwloc.h:269
@ HWLOC_OBJ_L5CACHE
Level 5 Data (or Unified) Cache.
Definition: hwloc.h:217
@ 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_NUMANODE
NUMA node. An object that contains memory that is directly and byte-accessible to the host processors...
Definition: hwloc.h:236
@ HWLOC_OBJ_PACKAGE
Physical package. The physical package that usually gets inserted into a socket on the motherboard....
Definition: hwloc.h:191
@ HWLOC_OBJ_PU
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:201
@ HWLOC_OBJ_L3ICACHE
Level 3 instruction Cache (filtered out by default).
Definition: hwloc.h:221
@ HWLOC_OBJ_CORE
Core. A computation unit (may be shared by several PUs, aka logical processors).
Definition: hwloc.h:197
@ HWLOC_OBJ_DIE
Die within a physical package. A subpart of the physical package, that contains multiple cores.
Definition: hwloc.h:318
@ HWLOC_OBJ_L1ICACHE
Level 1 instruction Cache (filtered out by default).
Definition: hwloc.h:219
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:596
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:692
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.
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, int depth)
Returns the width of level at depth depth.
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
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.
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.
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.
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
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.
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.
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
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.
int hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
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:821
@ HWLOC_TYPE_DEPTH_UNKNOWN
No object of given type exists in the topology.
Definition: hwloc.h:822
@ HWLOC_TYPE_DEPTH_NUMANODE
Virtual depth for NUMA nodes.
Definition: hwloc.h:824
@ HWLOC_TYPE_DEPTH_MEMCACHE
Virtual depth for MemCache object.
Definition: hwloc.h:829
@ HWLOC_TYPE_DEPTH_MISC
Virtual depth for Misc object.
Definition: hwloc.h:828
@ HWLOC_TYPE_DEPTH_PCI_DEVICE
Virtual depth for PCI device object level.
Definition: hwloc.h:826
@ HWLOC_TYPE_DEPTH_MULTIPLE
Objects of given type exist at different depth in the topology (only for Groups).
Definition: hwloc.h:823
@ HWLOC_TYPE_DEPTH_BRIDGE
Virtual depth for bridge object level.
Definition: hwloc.h:825
@ HWLOC_TYPE_DEPTH_OS_DEVICE
Virtual depth for software device object level.
Definition: hwloc.h:827
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.
static const char * hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name)
Search the given key name in object infos and return the corresponding value.
int hwloc_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_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1155
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:1158
@ HWLOC_CPUBIND_NOMEMBIND
Avoid any effect on memory binding.
Definition: hwloc.h:1204
@ HWLOC_CPUBIND_STRICT
Request for strict binding from the OS.
Definition: hwloc.h:1187
@ HWLOC_CPUBIND_THREAD
Bind current thread of current process.
Definition: hwloc.h:1162
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.
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:1461
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.
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:1398
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:1479
@ HWLOC_MEMBIND_PROCESS
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1466
@ HWLOC_MEMBIND_THREAD
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1471
@ HWLOC_MEMBIND_BYNODESET
Consider the bitmap argument as a nodeset.
Definition: hwloc.h:1509
@ HWLOC_MEMBIND_MIGRATE
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1485
@ HWLOC_MEMBIND_NOCPUBIND
Avoid any effect on CPU binding.
Definition: hwloc.h:1498
@ HWLOC_MEMBIND_DEFAULT
Reset the memory allocation policy to the system default. Depending on the operating system,...
Definition: hwloc.h:1406
@ HWLOC_MEMBIND_MIXED
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1445
@ HWLOC_MEMBIND_FIRSTTOUCH
Allocate each memory page individually on the local NUMA node of the thread that touches it.
Definition: hwloc.h:1417
@ HWLOC_MEMBIND_BIND
Allocate memory on the specified nodes.
Definition: hwloc.h:1421
@ HWLOC_MEMBIND_INTERLEAVE
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1430
@ HWLOC_MEMBIND_NEXTTOUCH
For each page bound with this policy, by next time it is touched (and next time only),...
Definition: hwloc.h:1437
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:1873
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:1877
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:2235
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:1914
@ HWLOC_TYPE_FILTER_KEEP_NONE
Ignore all objects of this type.
Definition: hwloc.h:2249
@ HWLOC_TYPE_FILTER_KEEP_IMPORTANT
Only keep likely-important objects of the given type.
Definition: hwloc.h:2278
@ HWLOC_TYPE_FILTER_KEEP_STRUCTURE
Only ignore objects if their entire level does not bring any structure.
Definition: hwloc.h:2263
@ HWLOC_TYPE_FILTER_KEEP_ALL
Keep all objects of this type.
Definition: hwloc.h:2241
@ HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED
Detect the whole system, ignore reservations, include disallowed objects.
Definition: hwloc.h:1936
@ 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:1977
@ HWLOC_TOPOLOGY_FLAG_RESTRICT_TO_MEMBINDING
Do not consider resources outside of the process memory binding.
Definition: hwloc.h:2048
@ HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM
Assume that the selected backend provides the topology for the system on which we are running.
Definition: hwloc.h:1956
@ HWLOC_TOPOLOGY_FLAG_RESTRICT_TO_CPUBINDING
Do not consider resources outside of the process CPU binding.
Definition: hwloc.h:2026
@ HWLOC_TOPOLOGY_FLAG_IMPORT_SUPPORT
Import support from the imported topology.
Definition: hwloc.h:2001
@ HWLOC_TOPOLOGY_FLAG_DONT_CHANGE_BINDING
Do not ever modify the process or thread binding during discovery.
Definition: hwloc.h:2063
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:2400
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:2339
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:2418
@ HWLOC_ALLOW_FLAG_LOCAL_RESTRICTIONS
Only allow objects that are available to the current process.
Definition: hwloc.h:2414
@ HWLOC_ALLOW_FLAG_ALL
Mark all objects as allowed in the topology.
Definition: hwloc.h:2405
@ 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:2364
@ 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:2345
@ 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:2370
@ HWLOC_RESTRICT_FLAG_BYNODESET
Restrict by nodeset instead of CPU set. Only keep objects whose nodeset is included or partially incl...
Definition: hwloc.h:2351
@ 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:2358
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:68
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:70
Structure of a topology object.
Definition: hwloc.h:396
struct hwloc_obj ** children
Normal children, children[0 .. arity -1].
Definition: hwloc.h:456
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:540
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:434
int symmetric_subtree
Set if the subtree of normal objects below this object is symmetric, which means all normal children ...
Definition: hwloc.h:461
unsigned misc_arity
Number of Misc children. These children are listed in misc_first_child.
Definition: hwloc.h:502
int depth
Vertical index in the hierarchy.
Definition: hwloc.h:419
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:505
char * subtype
Subtype string to better describe the type field.
Definition: hwloc.h:399
unsigned os_index
OS-provided physical index number. It is not guaranteed unique across the entire machine,...
Definition: hwloc.h:401
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:512
unsigned memory_arity
Number of Memory children. These children are listed in memory_first_child.
Definition: hwloc.h:472
hwloc_uint64_t total_memory
Total memory (in bytes) in NUMA nodes below this object.
Definition: hwloc.h:413
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:582
unsigned io_arity
Number of I/O children. These children are listed in io_first_child.
Definition: hwloc.h:490
struct hwloc_obj * prev_sibling
Previous object below the same parent (inside the same list of children).
Definition: hwloc.h:449
struct hwloc_obj * next_sibling
Next object below the same parent (inside the same list of children).
Definition: hwloc.h:448
struct hwloc_obj * last_child
Last normal child.
Definition: hwloc.h:458
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:442
struct hwloc_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:578
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:493
hwloc_cpuset_t complete_cpuset
The complete CPU set of processors of this object,.
Definition: hwloc.h:527
hwloc_uint64_t gp_index
Global persistent index. Generated by hwloc, unique across the topology (contrary to os_index) and pe...
Definition: hwloc.h:587
unsigned infos_count
Size of infos array.
Definition: hwloc.h:579
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:447
unsigned arity
Number of normal children. Memory, Misc and I/O children are not listed here but rather in their dedi...
Definition: hwloc.h:452
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:408
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:475
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:562
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:443
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:398
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:415
struct hwloc_obj * parent
Parent, NULL if root (Machine object)
Definition: hwloc.h:446
struct hwloc_obj * first_child
First normal child.
Definition: hwloc.h:457
Object type-specific Attributes.
Definition: hwloc.h:599
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
NUMA node-specific Object Attributes.
Definition: hwloc.h:601
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:603
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:602
struct hwloc_obj_attr_u::hwloc_numanode_attr_s::hwloc_memory_page_type_s * page_types
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:609
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:610
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:611
Cache-specific Object Attributes.
Definition: hwloc.h:616
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:618
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:619
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:617
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:620
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:622
Group-specific Object Attributes.
Definition: hwloc.h:625
unsigned kind
Internally-used kind of group.
Definition: hwloc.h:628
unsigned subkind
Internally-used subkind to distinguish different levels of groups with same kind.
Definition: hwloc.h:629
unsigned depth
Depth of group object. It may change if intermediate Group objects are added.
Definition: hwloc.h:626
unsigned char dont_merge
Flag preventing groups from being automatically merged with identical parent or children.
Definition: hwloc.h:630
PCI Device specific Object Attributes.
Definition: hwloc.h:633
unsigned char revision
Definition: hwloc.h:642
unsigned short device_id
Definition: hwloc.h:641
unsigned char dev
Definition: hwloc.h:639
unsigned short subvendor_id
Definition: hwloc.h:641
float linkspeed
Definition: hwloc.h:643
unsigned char func
Definition: hwloc.h:639
unsigned short domain
Definition: hwloc.h:635
unsigned short vendor_id
Definition: hwloc.h:641
unsigned char bus
Definition: hwloc.h:639
unsigned short subdevice_id
Definition: hwloc.h:641
unsigned short class_id
Definition: hwloc.h:640
Bridge specific Object Attributes.
Definition: hwloc.h:646
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:650
unsigned short domain
Definition: hwloc.h:654
unsigned depth
Definition: hwloc.h:662
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
struct hwloc_pcidev_attr_s pci
Definition: hwloc.h:648
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@0 upstream
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:661
unsigned char secondary_bus
Definition: hwloc.h:658
unsigned char subordinate_bus
Definition: hwloc.h:658
OS Device specific Object Attributes.
Definition: hwloc.h:665
hwloc_obj_osdev_type_t type
Definition: hwloc.h:666
Object info.
Definition: hwloc.h:674
char * name
Info name.
Definition: hwloc.h:675
char * value
Info value.
Definition: hwloc.h:676
Flags describing actual discovery support for this topology.
Definition: hwloc.h:2100
unsigned char numa
Detecting the number of NUMA nodes is supported.
Definition: hwloc.h:2104
unsigned char disallowed_numa
Detecting and identifying NUMA nodes that are not available to the current process is supported.
Definition: hwloc.h:2110
unsigned char cpukind_efficiency
Detecting the efficiency of CPU kinds is supported, see Kinds of CPU cores.
Definition: hwloc.h:2112
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:2102
unsigned char numa_memory
Detecting the amount of memory in NUMA nodes is supported.
Definition: hwloc.h:2106
unsigned char disallowed_pu
Detecting and identifying PU objects that are not available to the current process is supported.
Definition: hwloc.h:2108
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:2120
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:2140
unsigned char set_thread_cpubind
Definition: hwloc.h:2134
unsigned char set_thisthread_cpubind
Definition: hwloc.h:2130
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:2142
unsigned char get_thisproc_cpubind
Definition: hwloc.h:2124
unsigned char get_thisthread_cpubind
Definition: hwloc.h:2132
unsigned char get_thread_cpubind
Definition: hwloc.h:2136
unsigned char set_thisproc_cpubind
Definition: hwloc.h:2122
unsigned char set_proc_cpubind
Definition: hwloc.h:2126
unsigned char get_proc_cpubind
Definition: hwloc.h:2128
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:2138
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:2150
unsigned char set_thisthread_membind
Definition: hwloc.h:2160
unsigned char get_area_membind
Definition: hwloc.h:2166
unsigned char firsttouch_membind
Definition: hwloc.h:2170
unsigned char get_area_memlocation
Definition: hwloc.h:2180
unsigned char set_thisproc_membind
Definition: hwloc.h:2152
unsigned char interleave_membind
Definition: hwloc.h:2174
unsigned char get_thisproc_membind
Definition: hwloc.h:2154
unsigned char set_area_membind
Definition: hwloc.h:2164
unsigned char get_thisthread_membind
Definition: hwloc.h:2162
unsigned char set_proc_membind
Definition: hwloc.h:2156
unsigned char get_proc_membind
Definition: hwloc.h:2158
unsigned char migrate_membind
Definition: hwloc.h:2178
unsigned char nexttouch_membind
Definition: hwloc.h:2176
unsigned char alloc_membind
Definition: hwloc.h:2168
unsigned char bind_membind
Definition: hwloc.h:2172
Flags describing miscellaneous features.
Definition: hwloc.h:2185
unsigned char imported_support
Definition: hwloc.h:2187
Set of flags describing actual support for this topology.
Definition: hwloc.h:2196
struct hwloc_topology_misc_support * misc
Definition: hwloc.h:2200
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:2199
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:2198
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:2197