Hardware Locality (hwloc)  master-20230831.0905.git364652f8b
hwloc.h
1 /*
2  * Copyright © 2009 CNRS
3  * Copyright © 2009-2023 Inria. All rights reserved.
4  * Copyright © 2009-2012 Université Bordeaux
5  * Copyright © 2009-2020 Cisco Systems, Inc. All rights reserved.
6  * See COPYING in top-level directory.
7  */
8 
9 /*=====================================================================
10  * PLEASE GO READ THE DOCUMENTATION!
11  * ------------------------------------------------
12  * $tarball_directory/doc/doxygen-doc/
13  * or
14  * https://www.open-mpi.org/projects/hwloc/doc/
15  *=====================================================================
16  *
17  * FAIR WARNING: Do NOT expect to be able to figure out all the
18  * subtleties of hwloc by simply reading function prototypes and
19  * constant descrptions here in this file.
20  *
21  * Hwloc has wonderful documentation in both PDF and HTML formats for
22  * your reading pleasure. The formal documentation explains a LOT of
23  * hwloc-specific concepts, provides definitions, and discusses the
24  * "big picture" for many of the things that you'll find here in this
25  * header file.
26  *
27  * The PDF/HTML documentation was generated via Doxygen; much of what
28  * you'll see in there is also here in this file. BUT THERE IS A LOT
29  * THAT IS IN THE PDF/HTML THAT IS ***NOT*** IN hwloc.h!
30  *
31  * There are entire paragraph-length descriptions, discussions, and
32  * pretty pictures to explain subtle corner cases, provide concrete
33  * examples, etc.
34  *
35  * Please, go read the documentation. :-)
36  *
37  * Moreover there are several examples of hwloc use under doc/examples
38  * in the source tree.
39  *
40  *=====================================================================*/
41 
53 #ifndef HWLOC_H
54 #define HWLOC_H
55 
56 #include "hwloc/autogen/config.h"
57 
58 #include <sys/types.h>
59 #include <stdio.h>
60 #include <string.h>
61 #include <limits.h>
62 
63 /*
64  * Symbol transforms
65  */
66 #include "hwloc/rename.h"
67 
68 /*
69  * Bitmap definitions
70  */
71 
72 #include "hwloc/bitmap.h"
73 
74 
75 #ifdef __cplusplus
76 extern "C" {
77 #endif
78 
79 
115 #define HWLOC_API_VERSION 0x00030000
116 
123 HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);
124 
126 #define HWLOC_COMPONENT_ABI 8
127 
164 
182 
197 typedef enum {
198 
200 #define HWLOC_OBJ_TYPE_MIN HWLOC_OBJ_MACHINE /* Sentinel value */
201 
343  HWLOC_OBJ_TYPE_MAX
345 
352 
358 
381 
404 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
405 
407 #define HWLOC_TYPE_UNORDERED INT_MAX
408 
417 union hwloc_obj_attr_u;
418 
422 struct hwloc_info_s {
423  char *name;
424  char *value;
425 };
426 
435  struct hwloc_info_s *array;
436  unsigned count;
437  unsigned allocated;
438 };
439 
444 struct hwloc_obj {
445  /* physical information */
447  char *subtype;
449  unsigned os_index;
454 #define HWLOC_UNKNOWN_INDEX (unsigned)-1
455 
456  char *name;
461  hwloc_uint64_t total_memory;
466  /* global position */
467  int depth;
482  unsigned logical_index;
489  /* cousins are all objects of the same type (and depth) across the entire topology */
493  /* children of the same parent are siblings, even if they may have different type and depth */
494  struct hwloc_obj *parent;
495  unsigned sibling_rank;
500  unsigned arity;
504  struct hwloc_obj **children;
520  unsigned memory_arity;
538  unsigned io_arity;
550  unsigned misc_arity;
559  /* cpusets and nodesets */
628  /* misc */
629  void *userdata;
634  hwloc_uint64_t gp_index;
639 };
643 typedef struct hwloc_obj * hwloc_obj_t;
644 
649  hwloc_uint64_t local_memory;
650  unsigned page_types_len;
657  hwloc_uint64_t size;
658  hwloc_uint64_t count;
659  } * page_types;
660  } numanode;
661 
664  hwloc_uint64_t size;
665  unsigned depth;
666  unsigned linesize;
670  } cache;
673  unsigned depth;
675  unsigned kind;
676  unsigned subkind;
677  unsigned char dont_merge;
678  } group;
681  unsigned int domain;
682  unsigned char bus, dev, func;
683  unsigned char prog_if; /* the register-level programming interface */
684  unsigned short class_id;
686  unsigned char revision;
687  float linkspeed; /* in GB/s */
688  } pcidev;
691  union {
693  } upstream;
695  union {
696  struct {
697  unsigned int domain;
699  } pci;
700  } downstream;
702  unsigned depth;
703  } bridge;
707  } osdev;
708 };
709 
718 struct hwloc_topology;
723 typedef struct hwloc_topology * hwloc_topology_t;
724 
731 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
732 
753 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
754 
759 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
760 
773 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
774 
792 HWLOC_DECLSPEC int hwloc_topology_abi_check(hwloc_topology_t topology);
793 
805 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
806 
829 HWLOC_DECLSPEC int hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
830 
857 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
858 
868 };
869 
883 HWLOC_DECLSPEC int hwloc_get_type_depth_with_attr(hwloc_topology_t topology,
884  hwloc_obj_type_t type,
885  union hwloc_obj_attr_u *attrp, size_t attrsize);
886 
906 HWLOC_DECLSPEC int hwloc_get_memory_parents_depth (hwloc_topology_t topology);
907 
921 static __hwloc_inline int
922 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
923 
937 static __hwloc_inline int
938 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
939 
948 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, int depth) __hwloc_attribute_pure;
949 
955 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, int depth) __hwloc_attribute_pure;
956 
963 static __hwloc_inline int
964 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
965 
972 static __hwloc_inline hwloc_obj_t
973 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
974 
980 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, int depth, unsigned idx) __hwloc_attribute_pure;
981 
989 static __hwloc_inline hwloc_obj_t
990 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
991 
998 static __hwloc_inline hwloc_obj_t
999 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, int depth, hwloc_obj_t prev);
1000 
1009 static __hwloc_inline hwloc_obj_t
1011  hwloc_obj_t prev);
1012 
1031 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
1032 
1051 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size,
1052  hwloc_obj_t obj,
1053  unsigned long flags);
1054 
1070 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size,
1071  hwloc_obj_t obj, const char * __hwloc_restrict separator,
1072  unsigned long flags);
1073 
1080 
1086 
1091 
1097 
1104 };
1105 
1127 HWLOC_DECLSPEC int hwloc_type_sscanf(const char *string,
1128  hwloc_obj_type_t *typep,
1129  union hwloc_obj_attr_u *attrp, size_t attrsize);
1130 
1144 static __hwloc_inline const char *
1145 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1146 
1156 static __hwloc_inline const char *
1157 hwloc_get_info_by_name(struct hwloc_infos_s *infos, const char *name) __hwloc_attribute_pure;
1158 
1180 HWLOC_DECLSPEC int hwloc_modify_infos(struct hwloc_infos_s *infos,
1181  unsigned long operation,
1182  const char *name, const char *value);
1183 
1191 
1199 
1209 
1217 };
1218 
1238 static __hwloc_inline int
1239 hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1240 
1249 HWLOC_DECLSPEC struct hwloc_infos_s * hwloc_topology_get_infos(hwloc_topology_t topology);
1250 
1322 typedef enum {
1326 
1330 
1355 
1373 
1380 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1381 
1390 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1391 
1405 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1406 
1424 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1425 
1426 #ifdef hwloc_thread_t
1427 
1436 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1437 #endif
1438 
1439 #ifdef hwloc_thread_t
1440 
1453 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1454 #endif
1455 
1475 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1476 
1499 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1500 
1580 typedef enum {
1589 
1600 
1610 
1619 
1626 
1635 
1649 typedef enum {
1655 
1660 
1668 
1674 
1687 
1699 
1716 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
1717 
1767 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
1768 
1782 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);
1783 
1828 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);
1829 
1840 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);
1841 
1873 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);
1874 
1897 HWLOC_DECLSPEC int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags);
1898 
1908 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
1909 
1925 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;
1926 
1941 static __hwloc_inline void *
1942 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;
1943 
1949 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
1950 
1992 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
1993 
2025 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
2026 
2054 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
2055 
2083 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
2084 
2092 };
2093 
2111 HWLOC_DECLSPEC int hwloc_topology_set_components(hwloc_topology_t __hwloc_restrict topology, unsigned long flags, const char * __hwloc_restrict name);
2112 
2154 
2174 
2195 
2219 
2244 
2266 
2281 
2288 
2294 
2300 };
2301 
2316 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
2317 
2329 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
2330 
2340 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
2341 
2345  unsigned char pu;
2347  unsigned char numa;
2349  unsigned char numa_memory;
2351  unsigned char disallowed_pu;
2353  unsigned char disallowed_numa;
2355  unsigned char cpukind_efficiency;
2356 };
2357 
2365  unsigned char set_thisproc_cpubind;
2367  unsigned char get_thisproc_cpubind;
2369  unsigned char set_proc_cpubind;
2371  unsigned char get_proc_cpubind;
2373  unsigned char set_thisthread_cpubind;
2375  unsigned char get_thisthread_cpubind;
2377  unsigned char set_thread_cpubind;
2379  unsigned char get_thread_cpubind;
2386 };
2387 
2395  unsigned char set_thisproc_membind;
2397  unsigned char get_thisproc_membind;
2399  unsigned char set_proc_membind;
2401  unsigned char get_proc_membind;
2403  unsigned char set_thisthread_membind;
2405  unsigned char get_thisthread_membind;
2407  unsigned char set_area_membind;
2409  unsigned char get_area_membind;
2411  unsigned char alloc_membind;
2413  unsigned char firsttouch_membind;
2415  unsigned char bind_membind;
2417  unsigned char interleave_membind;
2419  unsigned char nexttouch_membind;
2421  unsigned char migrate_membind;
2423  unsigned char get_area_memlocation;
2424 };
2425 
2430  unsigned char imported_support;
2431 };
2432 
2444 };
2445 
2475 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
2476 
2493 
2501 
2515 
2530 };
2531 
2536 HWLOC_DECLSPEC int hwloc_topology_set_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e filter);
2537 
2542 HWLOC_DECLSPEC int hwloc_topology_get_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e *filter);
2543 
2550 HWLOC_DECLSPEC int hwloc_topology_set_all_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2551 
2558 HWLOC_DECLSPEC int hwloc_topology_set_cache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2559 
2566 HWLOC_DECLSPEC int hwloc_topology_set_icache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2567 
2572 HWLOC_DECLSPEC int hwloc_topology_set_io_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2573 
2584 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
2585 
2594 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
2595 
2612 
2618 
2625 
2631 
2637 };
2638 
2674 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_bitmap_t set, unsigned long flags);
2675 
2683 
2692 
2696 };
2697 
2719 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);
2720 
2742 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2743 
2755 
2807 
2820 HWLOC_DECLSPEC int hwloc_obj_add_other_obj_sets(hwloc_obj_t dst, hwloc_obj_t src);
2821 
2839 HWLOC_DECLSPEC int hwloc_topology_refresh(hwloc_topology_t topology);
2840 
2845 #ifdef __cplusplus
2846 } /* extern "C" */
2847 #endif
2848 
2849 
2850 /* high-level helpers */
2851 #include "hwloc/helper.h"
2852 
2853 /* inline code of some functions above */
2854 #include "hwloc/inlines.h"
2855 
2856 /* memory attributes */
2857 #include "hwloc/memattrs.h"
2858 
2859 /* kinds of CPU cores */
2860 #include "hwloc/cpukinds.h"
2861 
2862 /* exporting to XML or synthetic */
2863 #include "hwloc/export.h"
2864 
2865 /* distances */
2866 #include "hwloc/distances.h"
2867 
2868 /* topology diffs */
2869 #include "hwloc/diff.h"
2870 
2871 /* deprecated headers */
2872 #include "hwloc/deprecated.h"
2873 
2874 #endif /* HWLOC_H */
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:363
Add a new info attribute with the given name and value.
Definition: hwloc.h:1190
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
unsigned char interleave_membind
Definition: hwloc.h:2417
hwloc_modify_infos_op_e
Operations given to hwloc_modify_infos().
Definition: hwloc.h:1185
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
hwloc_bitmap_t hwloc_cpuset_t
A CPU set is a bitmap whose bits are set according to CPU physical OS indexes.
Definition: hwloc.h:161
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:482
static const char * hwloc_get_info_by_name(struct hwloc_infos_s *infos, const char *name)
Search the given name in the array of infos and return the corresponding value.
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.
unsigned char numa_memory
Detecting the amount of memory in NUMA nodes is supported.
Definition: hwloc.h:2349
unsigned char get_area_membind
Definition: hwloc.h:2409
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1325
Remove existing info attributes that matches the given name and/or value if not NULL.
Definition: hwloc.h:1216
int symmetric_subtree
Set if the subtree of normal objects below this object is symmetric, which means all normal children ...
Definition: hwloc.h:509
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, int depth)
Returns the type of objects at depth depth.
unsigned char revision
Definition: hwloc.h:686
Request for strict binding from the OS.
Definition: hwloc.h:1354
Die within a physical package. A subpart of the physical package, that contains multiple cores...
Definition: hwloc.h:339
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.
unsigned short device_id
Definition: hwloc.h:685
hwloc_allow_flags_e
Flags to be given to hwloc_topology_allow().
Definition: hwloc.h:2677
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.
unsigned sibling_rank
Index in parent&#39;s children[] array. Or the index in parent&#39;s Memory, I/O or Misc children list...
Definition: hwloc.h:495
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:69
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
float linkspeed
Definition: hwloc.h:687
Replace existing info attributes with the given name, with a single attribute with the given name and...
Definition: hwloc.h:1208
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
For each page bound with this policy, by next time it is touched (and next time only), it is moved from its current location to the local NUMA node of the thread where the memory reference occurred (if it needs to be moved at all).
Definition: hwloc.h:1625
Virtual depth for MemCache object.
Definition: hwloc.h:867
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:523
unsigned char imported_support
Definition: hwloc.h:2430
Level 2 Data (or Unified) Cache.
Definition: hwloc.h:235
hwloc_obj_t hwloc_get_obj_by_depth(hwloc_topology_t topology, int depth, unsigned idx)
Returns the topology object at logical index idx from depth depth.
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which process the topology is viewed from.
unsigned char firsttouch_membind
Definition: hwloc.h:2413
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:372
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:669
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
Virtual depth for bridge object level.
Definition: hwloc.h:863
struct hwloc_obj * last_child
Last normal child.
Definition: hwloc.h:506
Keep all objects of this type.
Definition: hwloc.h:2492
Virtual depth for NUMA nodes.
Definition: hwloc.h:862
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:657
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:665
int hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
struct hwloc_obj * prev_sibling
Previous object below the same parent (inside the same list of children).
Definition: hwloc.h:497
char * subtype
Subtype string to better describe the type field.
Definition: hwloc.h:447
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:2131
int hwloc_obj_add_other_obj_sets(hwloc_obj_t dst, hwloc_obj_t src)
Setup object cpusets/nodesets by OR&#39;ing another object&#39;s sets.
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR&#39;ed flags to non-yet-loaded topology.
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
unsigned short class_id
Definition: hwloc.h:684
unsigned char dev
Definition: hwloc.h:682
unsigned char set_thisthread_cpubind
Definition: hwloc.h:2373
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:2173
No object of given type exists in the topology.
Definition: hwloc.h:860
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1673
unsigned char alloc_membind
Definition: hwloc.h:2411
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
Add a new info attribute with the given name and value only if that pair doesn&#39;t exist yet...
Definition: hwloc.h:1198
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.
unsigned int domain
Definition: hwloc.h:697
unsigned char get_proc_cpubind
Definition: hwloc.h:2371
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.
NUMA node. An object that contains memory that is directly and byte-accessible to the host processors...
Definition: hwloc.h:257
static hwloc_obj_t hwloc_get_obj_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx)
Returns the topology object at logical index idx with type type.
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:354
unsigned char get_thread_cpubind
Definition: hwloc.h:2379
Array of string info attributes (pairs of name and value).
Definition: hwloc.h:434
Machine. A set of processors and memory with cache coherency.
Definition: hwloc.h:203
Display memory sizes in bytes without units.
Definition: hwloc.h:1090
Bind current thread of current process.
Definition: hwloc.h:1329
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1322
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.
char * name
Info name.
Definition: hwloc.h:423
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1580
unsigned char secondary_bus
Definition: hwloc.h:698
int hwloc_get_memory_parents_depth(hwloc_topology_t topology)
Return the depth of parents where memory objects are attached.
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...
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
unsigned char func
Definition: hwloc.h:682
Do not ever modify the process or thread binding during discovery.
Definition: hwloc.h:2280
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:553
struct hwloc_pcidev_attr_s pci
Definition: hwloc.h:692
struct hwloc_infos_s * hwloc_topology_get_infos(hwloc_topology_t topology)
Get the structure of info attributes attached to the topology.
Only keep likely-important objects of the given type.
Definition: hwloc.h:2529
unsigned memory_arity
Number of Memory children. These children are listed in memory_first_child.
Definition: hwloc.h:520
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
Virtual depth for software device object level.
Definition: hwloc.h:865
hwloc_obj_osdev_type_t type
Definition: hwloc.h:706
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1649
struct hwloc_obj * next_sibling
Next object below the same parent (inside the same list of children).
Definition: hwloc.h:496
unsigned char get_thisthread_membind
Definition: hwloc.h:2405
Data cache.
Definition: hwloc.h:349
unsigned char set_proc_membind
Definition: hwloc.h:2399
Level 1 instruction Cache (filtered out by default).
Definition: hwloc.h:240
Avoid any effect on CPU binding.
Definition: hwloc.h:1686
Do not consider resources outside of the process memory binding.
Definition: hwloc.h:2265
struct hwloc_obj * first_child
First normal child.
Definition: hwloc.h:505
Objects of given type exist at different depth in the topology (only for Groups). ...
Definition: hwloc.h:861
struct hwloc_obj ** children
Normal children, children[0 .. arity -1].
Definition: hwloc.h:504
Cache-specific Object Attributes.
Definition: hwloc.h:663
Ignore distances.
Definition: hwloc.h:2287
Remove all objects that became Memory-less. By default, only objects that contain no PU and no memory...
Definition: hwloc.h:2624
unsigned int domain
Definition: hwloc.h:681
int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags)
Get the current physical binding of process pid.
hwloc_uint64_t total_memory
Total memory (in bytes) in NUMA nodes below this object.
Definition: hwloc.h:461
Use long type names such as L2Cache instead of L2.
Definition: hwloc.h:1079
hwloc_topology_components_flag_e
Flags to be passed to hwloc_topology_set_components()
Definition: hwloc.h:2087
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:2441
int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags)
Get the NUMA nodes where memory identified by (addr, len ) is physically allocated.
int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags)
Bind current process or thread on CPUs given in physical bitmap set.
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:694
unsigned char cpukind_efficiency
Detecting the efficiency of CPU kinds is supported, see Kinds of CPU cores.
Definition: hwloc.h:2355
int hwloc_modify_infos(struct hwloc_infos_s *infos, unsigned long operation, const char *name, const char *value)
Modify an array of info attributes.
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:446
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:456
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_uint64_t count
Number of pages of this size.
Definition: hwloc.h:658
Only ignore objects if their entire level does not bring any structure.
Definition: hwloc.h:2514
Level 3 Data (or Unified) Cache.
Definition: hwloc.h:236
int hwloc_topology_refresh(hwloc_topology_t topology)
Refresh internal structures after topology modification.
Remove all objects that became CPU-less. By default, only objects that contain no PU and no memory ar...
Definition: hwloc.h:2611
Operating system memory device (e.g. DAX file for non-volatile or high-bandwidth memory), For instance "dax2.0" on Linux.
Definition: hwloc.h:377
Level 3 instruction Cache (filtered out by default).
Definition: hwloc.h:242
unsigned char get_thisproc_cpubind
Definition: hwloc.h:2367
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2605
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.
Memory-side cache (filtered out by default). A cache in front of a specific NUMA node.
Definition: hwloc.h:326
struct hwloc_infos_s infos
Array of info attributes (name and value strings).
Definition: hwloc.h:626
Get the set of allowed resources from the local operating system even if the topology was loaded from...
Definition: hwloc.h:2194
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:650
Virtual depth for Misc object.
Definition: hwloc.h:866
struct hwloc_obj_attr_u::hwloc_group_attr_s group
hwloc_obj_snprintf_flag_e
Flags to be given to hwloc_obj_type_snprintf() and hwloc_obj_attr_snprintf().
Definition: hwloc.h:1075
Level 5 Data (or Unified) Cache.
Definition: hwloc.h:238
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:163
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
Miscellaneous objects (filtered out by default). Objects without particular meaning, that can e.g. be added by the application for its own use, or by hwloc for miscellaneous objects such as MemoryModule (DIMMs).
Definition: hwloc.h:311
unsigned char prog_if
Definition: hwloc.h:683
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1618
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
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_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...
unsigned char nexttouch_membind
Definition: hwloc.h:2419
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:463
unsigned depth
Depth of group object. It may change if intermediate Group objects are added.
Definition: hwloc.h:673
hwloc_cpuset_t complete_cpuset
The complete CPU set of processors of this object,.
Definition: hwloc.h:575
Blacklist the target component from being used.
Definition: hwloc.h:2091
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:588
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, int depth)
Returns the width of level at depth depth.
unsigned char migrate_membind
Definition: hwloc.h:2421
Object type-specific Attributes.
Definition: hwloc.h:646
Operating system co-processor device. For instance "opencl0d0" for a OpenCL device, "cuda0" for a CUDA device.
Definition: hwloc.h:374
Only allow objects that are available to the current process.
Definition: hwloc.h:2691
int hwloc_type_sscanf(const char *string, hwloc_obj_type_t *typep, union hwloc_obj_attr_u *attrp, size_t attrsize)
Return an object type and attributes from a type string.
unsigned short subvendor_id
Definition: hwloc.h:685
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:2393
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:723
Info attribute (name and value strings)
Definition: hwloc.h:422
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2636
Consider the bitmap argument as a nodeset.
Definition: hwloc.h:1697
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.
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1659
unsigned char dont_merge
Flag preventing groups from being automatically merged with identical parent or children.
Definition: hwloc.h:677
Import support from the imported topology.
Definition: hwloc.h:2218
Backward compatibility with hwloc 2.x verbose mode, shows additional attributes, and memory sizes wit...
Definition: hwloc.h:1103
struct hwloc_obj_attr_u::hwloc_numanode_attr_s numanode
int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
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.
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1633
char * value
Info value.
Definition: hwloc.h:424
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2630
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:664
int hwloc_get_type_depth_with_attr(hwloc_topology_t topology, hwloc_obj_type_t type, union hwloc_obj_attr_u *attrp, size_t attrsize)
Returns the depth of objects of type and attributes attrp.
static int hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value)
Add the given name and value pair to the given object info attributes.
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:610
struct hwloc_topology_misc_support * misc
Definition: hwloc.h:2443
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:222
unsigned char numa
Detecting the number of NUMA nodes is supported.
Definition: hwloc.h:2347
int hwloc_obj_attr_snprintf(char *restrict string, size_t size, hwloc_obj_t obj, const char *restrict separator, unsigned long flags)
Stringify the attributes of a given topology object into a human-readable form.
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA, "hfi1_0" Omni-Path int...
Definition: hwloc.h:368
PCI Device specific Object Attributes.
Definition: hwloc.h:680
Do not consider resources outside of the process CPU binding.
Definition: hwloc.h:2243
static void * hwloc_alloc_membind_policy(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by set.
void * hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by set.
unsigned count
Number of elements in the array.
Definition: hwloc.h:436
int hwloc_obj_type_snprintf(char *restrict string, size_t size, hwloc_obj_t obj, unsigned long flags)
Stringify the type of a given topology object into a human-readable form.
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:541
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:656
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:71
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
hwloc_bitmap_t hwloc_nodeset_t
A node set is a bitmap whose bits are set according to NUMA memory node physical OS indexes...
Definition: hwloc.h:178
Allocate memory on the specified nodes.
Definition: hwloc.h:1609
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
unsigned short subdevice_id
Definition: hwloc.h:685
unsigned char set_thisthread_membind
Definition: hwloc.h:2403
Level 4 Data (or Unified) Cache.
Definition: hwloc.h:237
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
Structure of a topology object.
Definition: hwloc.h:444
struct hwloc_obj * parent
Parent, NULL if root (Machine object)
Definition: hwloc.h:494
Level 2 instruction Cache (filtered out by default).
Definition: hwloc.h:241
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
Definition: hwloc.h:1667
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:244
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR&#39;ed flags of a topology.
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:490
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:2383
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:2385
Restrict by nodeset instead of CPU set. Only keep objects whose nodeset is included or partially incl...
Definition: hwloc.h:2617
hwloc_get_type_depth_e
Definition: hwloc.h:859
PCI device (filtered out by default).
Definition: hwloc.h:290
Core. A computation unit (may be shared by several PUs, aka logical processors).
Definition: hwloc.h:218
unsigned char get_proc_membind
Definition: hwloc.h:2401
Bridge (filtered out by default). Any bridge (or PCI switch) that connects the host or an I/O bus...
Definition: hwloc.h:278
unsigned char get_thisproc_membind
Definition: hwloc.h:2397
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:666
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:701
unsigned subkind
Internally-used subkind to distinguish different levels of groups with same kind. ...
Definition: hwloc.h:676
int hwloc_topology_set_all_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all object types.
Virtual depth for PCI device object level.
Definition: hwloc.h:864
OS Device specific Object Attributes.
Definition: hwloc.h:705
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.
Allocate each memory page individually on the local NUMA node of the thread that touches it...
Definition: hwloc.h:1599
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:649
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:355
Mark all objects as allowed in the topology.
Definition: hwloc.h:2682
hwloc_uint64_t gp_index
Global persistent index. Generated by hwloc, unique across the topology (contrary to os_index) and pe...
Definition: hwloc.h:634
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...
struct hwloc_obj_attr_u::hwloc_cache_attr_s cache
Ignore memory attributes.
Definition: hwloc.h:2293
unsigned char get_thisthread_cpubind
Definition: hwloc.h:2375
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:2381
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().
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
Group-specific Object Attributes.
Definition: hwloc.h:672
unsigned char disallowed_numa
Detecting and identifying NUMA nodes that are not available to the current process is supported...
Definition: hwloc.h:2353
int depth
Vertical index in the hierarchy.
Definition: hwloc.h:467
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:197
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:560
Instruction cache (filtered out by default).
Definition: hwloc.h:350
Avoid any effect on memory binding.
Definition: hwloc.h:1371
NUMA node-specific Object Attributes.
Definition: hwloc.h:648
struct hwloc_obj_attr_u::hwloc_bridge_attr_s bridge
Operating system device (filtered out by default).
Definition: hwloc.h:300
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1654
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.
unsigned kind
Internally-used kind of group.
Definition: hwloc.h:675
Display memory sizes in KB, MB, GB, etc i.e. divide by 1000 instead of 1024 for KiB, MiB, GiB, etc.
Definition: hwloc.h:1096
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.
Display additional attributes such as cache associativity, PCI link speed, and total memory...
Definition: hwloc.h:1085
Set of flags describing actual support for this topology.
Definition: hwloc.h:2439
unsigned char set_thisproc_cpubind
Definition: hwloc.h:2365
unsigned short vendor_id
Definition: hwloc.h:685
unsigned char get_area_memlocation
Definition: hwloc.h:2423
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:366
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:2363
Operating system storage device (e.g. block), For instance "sda" on Linux.
Definition: hwloc.h:361
unsigned misc_arity
Number of Misc children. These children are listed in misc_first_child.
Definition: hwloc.h:550
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:2440
unsigned depth
Definition: hwloc.h:702
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:667
static const char * hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name)
Search the given name in the object array of infos and return the corresponding value.
Level 1 Data (or Unified) Cache.
Definition: hwloc.h:234
int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags)
Get the current physical binding of thread tid.
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:2345
Ignore CPU Kinds.
Definition: hwloc.h:2299
Bridge specific Object Attributes.
Definition: hwloc.h:690
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:347
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:2442
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a constant stringified object type.
Detect the whole system, ignore reservations, include disallowed objects.
Definition: hwloc.h:2153
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:629
unsigned char set_thread_cpubind
Definition: hwloc.h:2377
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:643
hwloc_type_filter_e
Type filtering flags.
Definition: hwloc.h:2486
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
unsigned char bind_membind
Definition: hwloc.h:2415
unsigned io_arity
Number of I/O children. These children are listed in io_first_child.
Definition: hwloc.h:538
unsigned char set_proc_cpubind
Definition: hwloc.h:2369
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:181
Allow a custom set of objects, given to hwloc_topology_allow() as cpuset and/or nodeset parameters...
Definition: hwloc.h:2695
hwloc_obj_t hwloc_topology_alloc_group_object(hwloc_topology_t topology)
Allocate a Group object to insert later with hwloc_topology_insert_group_object().
unsigned char set_area_membind
Definition: hwloc.h:2407
int hwloc_topology_abi_check(hwloc_topology_t topology)
Verify that the topology is compatible with the current hwloc library.
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_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...
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.
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:491
PCI-side of a bridge.
Definition: hwloc.h:356
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@0 upstream
Unified cache.
Definition: hwloc.h:348
struct hwloc_obj_attr_u::hwloc_numanode_attr_s::hwloc_memory_page_type_s * page_types
Flags describing miscellaneous features.
Definition: hwloc.h:2428
int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags)
Bind a thread thread on CPUs given in physical bitmap set.
unsigned char subordinate_bus
Definition: hwloc.h:698
struct hwloc_info_s * array
Array of string pairs.
Definition: hwloc.h:435
Ignore all objects of this type.
Definition: hwloc.h:2500
unsigned char set_thisproc_membind
Definition: hwloc.h:2395
unsigned char disallowed_pu
Detecting and identifying PU objects that are not available to the current process is supported...
Definition: hwloc.h:2351
unsigned char bus
Definition: hwloc.h:682
Physical package. The physical package that usually gets inserted into a socket on the motherboard...
Definition: hwloc.h:212
Reset the memory allocation policy to the system default. Depending on the operating system...
Definition: hwloc.h:1588
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:360
Flags describing actual discovery support for this topology.
Definition: hwloc.h:2343
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_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.
unsigned os_index
OS-provided physical index number. It is not guaranteed unique across the entire machine, except for PUs and NUMA nodes. Set to HWLOC_UNKNOWN_INDEX if unknown or irrelevant for this object.
Definition: hwloc.h:449
unsigned arity
Number of normal children. Memory, Misc and I/O children are not listed here but rather in their dedi...
Definition: hwloc.h:500
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.
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.