Hardware Locality (hwloc)  master-20250612.0918.gitdcfc86fb1
hwloc.h
1 /*
2  * Copyright © 2009 CNRS
3  * Copyright © 2009-2024 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 
355  HWLOC_OBJ_TYPE_MAX
357 
364 
370 
388  HWLOC_OBJ_OSDEV_GPU = (1ULL<<2),
414  HWLOC_OBJ_OSDEV_DMA = (1ULL<<6)
418 };
419 
423 typedef unsigned long hwloc_obj_osdev_types_t;
424 
447 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
448 
450 #define HWLOC_TYPE_UNORDERED INT_MAX
451 
460 union hwloc_obj_attr_u;
461 
465 struct hwloc_info_s {
466  char *name;
467  char *value;
468 };
469 
478  struct hwloc_info_s *array;
479  unsigned count;
480  unsigned allocated;
481 };
482 
487 struct hwloc_obj {
488  /* physical information */
490  char *subtype;
492  unsigned os_index;
497 #define HWLOC_UNKNOWN_INDEX (unsigned)-1
498 
499  char *name;
504  hwloc_uint64_t total_memory;
509  /* global position */
510  int depth;
525  unsigned logical_index;
532  /* cousins are all objects of the same type (and depth) across the entire topology */
536  /* children of the same parent are siblings, even if they may have different type and depth */
537  struct hwloc_obj *parent;
538  unsigned sibling_rank;
543  unsigned arity;
547  struct hwloc_obj **children;
563  unsigned memory_arity;
581  unsigned io_arity;
593  unsigned misc_arity;
602  /* cpusets and nodesets */
671  /* misc */
672  void *userdata;
677  hwloc_uint64_t gp_index;
682 };
686 typedef struct hwloc_obj * hwloc_obj_t;
687 
692  hwloc_uint64_t local_memory;
693  unsigned page_types_len;
700  hwloc_uint64_t size;
701  hwloc_uint64_t count;
702  } * page_types;
703  } numanode;
704 
707  hwloc_uint64_t size;
708  unsigned depth;
709  unsigned linesize;
713  } cache;
716  unsigned depth;
718  unsigned kind;
719  unsigned subkind;
720  unsigned char dont_merge;
721  } group;
724  unsigned int domain;
725  unsigned char bus;
726  unsigned char dev;
727  unsigned char func;
728  unsigned char prog_if;
729  unsigned short class_id;
730  unsigned short vendor_id;
731  unsigned short device_id;
732  unsigned short subvendor_id;
733  unsigned short subdevice_id;
734  unsigned char revision;
735  float linkspeed;
741  } pcidev;
744  union {
746  } upstream;
748  union {
749  struct {
750  unsigned int domain;
751  unsigned char secondary_bus;
752  unsigned char subordinate_bus;
753  } pci;
754  } downstream;
756  unsigned depth;
757  } bridge;
761  } osdev;
762 };
763 
772 struct hwloc_topology;
777 typedef struct hwloc_topology * hwloc_topology_t;
778 
785 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
786 
807 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
808 
813 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
814 
827 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
828 
846 HWLOC_DECLSPEC int hwloc_topology_abi_check(hwloc_topology_t topology);
847 
859 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
860 
883 HWLOC_DECLSPEC int hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
884 
911 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
912 
922 };
923 
937 HWLOC_DECLSPEC int hwloc_get_type_depth_with_attr(hwloc_topology_t topology,
938  hwloc_obj_type_t type,
939  union hwloc_obj_attr_u *attrp, size_t attrsize);
940 
960 HWLOC_DECLSPEC int hwloc_get_memory_parents_depth (hwloc_topology_t topology);
961 
975 static __hwloc_inline int
976 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
977 
991 static __hwloc_inline int
992 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
993 
1002 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, int depth) __hwloc_attribute_pure;
1003 
1009 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, int depth) __hwloc_attribute_pure;
1010 
1017 static __hwloc_inline int
1018 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1019 
1026 static __hwloc_inline hwloc_obj_t
1027 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
1028 
1034 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, int depth, unsigned idx) __hwloc_attribute_pure;
1035 
1043 static __hwloc_inline hwloc_obj_t
1044 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
1045 
1052 static __hwloc_inline hwloc_obj_t
1053 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, int depth, hwloc_obj_t prev);
1054 
1063 static __hwloc_inline hwloc_obj_t
1065  hwloc_obj_t prev);
1066 
1085 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
1086 
1105 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size,
1106  hwloc_obj_t obj,
1107  unsigned long flags);
1108 
1127 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size,
1128  hwloc_obj_t obj, const char * __hwloc_restrict separator,
1129  unsigned long flags);
1130 
1137 
1144 
1150 
1155 
1161 
1168 };
1169 
1193 HWLOC_DECLSPEC int hwloc_type_sscanf(const char *string,
1194  hwloc_obj_type_t *typep,
1195  union hwloc_obj_attr_u *attrp, size_t attrsize);
1196 
1210 static __hwloc_inline const char *
1211 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1212 
1222 static __hwloc_inline const char *
1223 hwloc_get_info_by_name(struct hwloc_infos_s *infos, const char *name) __hwloc_attribute_pure;
1224 
1246 HWLOC_DECLSPEC int hwloc_modify_infos(struct hwloc_infos_s *infos,
1247  unsigned long operation,
1248  const char *name, const char *value);
1249 
1257 
1265 
1275 
1283 };
1284 
1304 static __hwloc_inline int
1305 hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1306 
1315 HWLOC_DECLSPEC struct hwloc_infos_s * hwloc_topology_get_infos(hwloc_topology_t topology);
1316 
1331 HWLOC_DECLSPEC int hwloc_obj_set_subtype(hwloc_topology_t topology, hwloc_obj_t obj, const char *subtype);
1332 
1404 typedef enum {
1408 
1412 
1437 
1455 
1462 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1463 
1472 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1473 
1487 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1488 
1506 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1507 
1508 #ifdef hwloc_thread_t
1509 
1518 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1519 #endif
1520 
1521 #ifdef hwloc_thread_t
1522 
1535 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1536 #endif
1537 
1557 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1558 
1581 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1582 
1662 typedef enum {
1671 
1682 
1692 
1701 
1711 
1718 
1727 
1741 typedef enum {
1747 
1752 
1760 
1766 
1779 
1791 
1808 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
1809 
1859 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
1860 
1874 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);
1875 
1920 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);
1921 
1932 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);
1933 
1965 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);
1966 
1989 HWLOC_DECLSPEC int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags);
1990 
2000 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
2001 
2017 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;
2018 
2033 static __hwloc_inline void *
2034 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;
2035 
2041 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
2042 
2088 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
2089 
2121 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
2122 
2154 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
2155 
2188 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
2189 
2197 };
2198 
2216 HWLOC_DECLSPEC int hwloc_topology_set_components(hwloc_topology_t __hwloc_restrict topology, unsigned long flags, const char * __hwloc_restrict name);
2217 
2259 
2279 
2300 
2324 
2349 
2371 
2386 
2393 
2400 
2406 };
2407 
2422 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
2423 
2435 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
2436 
2446 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
2447 
2451  unsigned char pu;
2453  unsigned char numa;
2455  unsigned char numa_memory;
2457  unsigned char disallowed_pu;
2459  unsigned char disallowed_numa;
2461  unsigned char cpukind_efficiency;
2462 };
2463 
2471  unsigned char set_thisproc_cpubind;
2473  unsigned char get_thisproc_cpubind;
2475  unsigned char set_proc_cpubind;
2477  unsigned char get_proc_cpubind;
2479  unsigned char set_thisthread_cpubind;
2481  unsigned char get_thisthread_cpubind;
2483  unsigned char set_thread_cpubind;
2485  unsigned char get_thread_cpubind;
2492 };
2493 
2501  unsigned char set_thisproc_membind;
2503  unsigned char get_thisproc_membind;
2505  unsigned char set_proc_membind;
2507  unsigned char get_proc_membind;
2509  unsigned char set_thisthread_membind;
2511  unsigned char get_thisthread_membind;
2512 
2514  unsigned char alloc_membind;
2516  unsigned char set_area_membind;
2518  unsigned char get_area_membind;
2520  unsigned char get_area_memlocation;
2521 
2523  unsigned char firsttouch_membind;
2525  unsigned char bind_membind;
2527  unsigned char interleave_membind;
2531  unsigned char nexttouch_membind;
2533  unsigned char migrate_membind;
2534 };
2535 
2540  unsigned char imported_support;
2541 };
2542 
2554 };
2555 
2585 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
2586 
2603 
2611 
2625 
2640 };
2641 
2646 HWLOC_DECLSPEC int hwloc_topology_set_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e filter);
2647 
2652 HWLOC_DECLSPEC int hwloc_topology_get_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e *filter);
2653 
2660 HWLOC_DECLSPEC int hwloc_topology_set_all_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2661 
2668 HWLOC_DECLSPEC int hwloc_topology_set_cache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2669 
2676 HWLOC_DECLSPEC int hwloc_topology_set_icache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2677 
2682 HWLOC_DECLSPEC int hwloc_topology_set_io_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2683 
2694 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
2695 
2704 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
2705 
2722 
2728 
2735 
2741 
2747 };
2748 
2784 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_bitmap_t set, unsigned long flags);
2785 
2793 
2802 
2806 };
2807 
2829 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);
2830 
2855 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2856 
2875 
2887 HWLOC_DECLSPEC int hwloc_topology_free_group_object(hwloc_topology_t topology, hwloc_obj_t group);
2888 
2966 
2979 HWLOC_DECLSPEC int hwloc_obj_add_other_obj_sets(hwloc_obj_t dst, hwloc_obj_t src);
2980 
2998 HWLOC_DECLSPEC int hwloc_topology_refresh(hwloc_topology_t topology);
2999 
3004 #ifdef __cplusplus
3005 } /* extern "C" */
3006 #endif
3007 
3008 
3009 /* high-level helpers */
3010 #include "hwloc/helper.h"
3011 
3012 /* inline code of some functions above */
3013 #include "hwloc/inlines.h"
3014 
3015 /* memory attributes */
3016 #include "hwloc/memattrs.h"
3017 
3018 /* kinds of CPU cores */
3019 #include "hwloc/cpukinds.h"
3020 
3021 /* exporting to XML or synthetic */
3022 #include "hwloc/export.h"
3023 
3024 /* distances */
3025 #include "hwloc/distances.h"
3026 
3027 /* topology diffs */
3028 #include "hwloc/diff.h"
3029 
3030 /* deprecated headers */
3031 #include "hwloc/deprecated.h"
3032 
3033 #endif /* HWLOC_H */
hwloc_topology_membind_support::set_proc_membind
unsigned char set_proc_membind
Definition: hwloc.h:2505
hwloc_topology_get_infos
struct hwloc_infos_s * hwloc_topology_get_infos(hwloc_topology_t topology)
Get the structure of info attributes attached to the topology.
hwloc_get_root_obj
hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
hwloc_get_obj_by_depth
hwloc_obj_t hwloc_get_obj_by_depth(hwloc_topology_t topology, int depth, unsigned idx)
Returns the topology object at logical index idx from depth depth.
HWLOC_ALLOW_FLAG_LOCAL_RESTRICTIONS
@ HWLOC_ALLOW_FLAG_LOCAL_RESTRICTIONS
Only allow objects that are available to the current process.
Definition: hwloc.h:2801
hwloc_obj_get_info_by_name
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.
hwloc_get_type_or_above_depth
int hwloc_get_type_or_above_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type or above.
hwloc_topology_membind_support::get_thisproc_membind
unsigned char get_thisproc_membind
Definition: hwloc.h:2503
hwloc_set_area_membind
int hwloc_set_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) specified by set.
hwloc_topology_cpubind_support::get_proc_last_cpu_location
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:2489
hwloc_obj_attr_u::group
struct hwloc_obj_attr_u::hwloc_group_attr_s group
hwloc_get_nbobjs_by_type
int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
hwloc_membind_flags_t
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1741
hwloc_obj_attr_u::hwloc_bridge_attr_s::downstream_type
hwloc_obj_bridge_type_t downstream_type
Downstream Bridge type.
Definition: hwloc.h:755
HWLOC_OBJ_OSDEV_GPU
@ HWLOC_OBJ_OSDEV_GPU
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device,...
Definition: hwloc.h:388
hwloc_topology_get_depth
int hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
hwloc_obj::memory_arity
unsigned memory_arity
Number of Memory children. These children are listed in memory_first_child.
Definition: hwloc.h:563
hwloc_get_proc_cpubind
int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags)
Get the current physical binding of process pid.
hwloc_topology_check
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
hwloc_const_cpuset_t
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:163
hwloc_topology_set_io_types_filter
int hwloc_topology_set_io_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all I/O object types.
HWLOC_OBJ_PACKAGE
@ HWLOC_OBJ_PACKAGE
Physical package. The physical package that usually gets inserted into a socket on the motherboard....
Definition: hwloc.h:212
hwloc_topology_discovery_support::numa_memory
unsigned char numa_memory
Detecting the amount of memory in NUMA nodes is supported.
Definition: hwloc.h:2455
hwloc_cpubind_flags_t
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1404
hwloc_infos_s::array
struct hwloc_info_s * array
Array of string pairs.
Definition: hwloc.h:478
hwloc_info_s::value
char * value
Info value.
Definition: hwloc.h:467
HWLOC_OBJ_OS_DEVICE
@ HWLOC_OBJ_OS_DEVICE
Operating system device (filtered out by default).
Definition: hwloc.h:329
hwloc_const_bitmap_t
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:71
HWLOC_OBJ_L5CACHE
@ HWLOC_OBJ_L5CACHE
Level 5 Data (or Unified) Cache.
Definition: hwloc.h:249
hwloc_obj::sibling_rank
unsigned sibling_rank
Index in parent's children[] array. Or the index in parent's Memory, I/O or Misc children list.
Definition: hwloc.h:538
hwloc_obj::next_sibling
struct hwloc_obj * next_sibling
Next object below the same parent (inside the same list of children).
Definition: hwloc.h:539
hwloc_obj_attr_u::hwloc_group_attr_s::depth
unsigned depth
Depth of group object. It may change if intermediate Group objects are added.
Definition: hwloc.h:716
hwloc_obj::os_index
unsigned os_index
OS-provided physical index number. It is not guaranteed unique across the entire machine,...
Definition: hwloc.h:492
HWLOC_TYPE_DEPTH_UNKNOWN
@ HWLOC_TYPE_DEPTH_UNKNOWN
No object of given type exists in the topology.
Definition: hwloc.h:914
HWLOC_OBJ_BRIDGE_HOST
@ HWLOC_OBJ_BRIDGE_HOST
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:367
hwloc_get_depth_type
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, int depth)
Returns the type of objects at depth depth.
HWLOC_MEMBIND_DEFAULT
@ HWLOC_MEMBIND_DEFAULT
Reset the memory allocation policy to the system default. Depending on the operating system,...
Definition: hwloc.h:1670
hwloc_set_membind
int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the current process or thread to prefer the NUMA node(s) spe...
HWLOC_OBJ_PU
@ HWLOC_OBJ_PU
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:233
hwloc_obj_attr_u::hwloc_pcidev_attr_s::subdevice_id
unsigned short subdevice_id
Sub-Device ID.
Definition: hwloc.h:733
HWLOC_RESTRICT_FLAG_ADAPT_MISC
@ HWLOC_RESTRICT_FLAG_ADAPT_MISC
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2740
hwloc_topology_load
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
hwloc_obj_attr_snprintf
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.
hwloc_topology_cpubind_support::get_proc_cpubind
unsigned char get_proc_cpubind
Definition: hwloc.h:2477
hwloc_topology_discovery_support
Flags describing actual discovery support for this topology.
Definition: hwloc.h:2449
hwloc_obj_osdev_type_e
hwloc_obj_osdev_type_e
Single type of a OS device. Multiple of these may be combined for a single device.
Definition: hwloc.h:374
hwloc_obj::misc_first_child
struct hwloc_obj * misc_first_child
First Misc child. Misc objects are listed here (misc_arity and misc_first_child) instead of in the no...
Definition: hwloc.h:596
hwloc_const_nodeset_t
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:181
hwloc_topology_support::cpubind
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:2551
hwloc_obj_attr_u::osdev
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
hwloc_topology_init
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
hwloc_get_memory_parents_depth
int hwloc_get_memory_parents_depth(hwloc_topology_t topology)
Return the depth of parents where memory objects are attached.
hwloc_topology_is_thissystem
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
hwloc_topology_membind_support::set_area_membind
unsigned char set_area_membind
Definition: hwloc.h:2516
hwloc_obj_attr_u::hwloc_pcidev_attr_s::class_id
unsigned short class_id
The class number (first two bytes, without the prog_if).
Definition: hwloc.h:729
hwloc_topology_get_flags
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR'ed flags of a topology.
hwloc_obj::next_cousin
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:533
hwloc_get_type_depth
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
hwloc_get_membind
int hwloc_get_membind(hwloc_topology_t topology, hwloc_bitmap_t set, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the current process or thread.
HWLOC_MEMBIND_BYNODESET
@ HWLOC_MEMBIND_BYNODESET
Consider the bitmap argument as a nodeset.
Definition: hwloc.h:1789
hwloc_obj_set_subtype
int hwloc_obj_set_subtype(hwloc_topology_t topology, hwloc_obj_t obj, const char *subtype)
Set (or replace) the subtype of an object.
hwloc_obj::type
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:489
hwloc_topology_membind_support::weighted_interleave_membind
unsigned char weighted_interleave_membind
Definition: hwloc.h:2529
hwloc_obj_attr_u::hwloc_numanode_attr_s::page_types_len
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:693
HWLOC_MEMBIND_THREAD
@ HWLOC_MEMBIND_THREAD
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1751
hwloc_topology_support::membind
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:2552
hwloc_obj_attr_u::hwloc_cache_attr_s::size
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:707
HWLOC_TYPE_DEPTH_MULTIPLE
@ HWLOC_TYPE_DEPTH_MULTIPLE
Objects of given type exist at different depth in the topology (only for Groups).
Definition: hwloc.h:915
hwloc_topology_support
Set of flags describing actual support for this topology.
Definition: hwloc.h:2549
hwloc_topology_misc_support::imported_support
unsigned char imported_support
Definition: hwloc.h:2540
hwloc_get_type_or_below_depth
int hwloc_get_type_or_below_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type or below.
HWLOC_OBJ_L4CACHE
@ HWLOC_OBJ_L4CACHE
Level 4 Data (or Unified) Cache.
Definition: hwloc.h:248
HWLOC_OBJ_CACHE_INSTRUCTION
@ HWLOC_OBJ_CACHE_INSTRUCTION
Instruction cache (filtered out by default).
Definition: hwloc.h:362
hwloc_topology_cpubind_support::set_proc_cpubind
unsigned char set_proc_cpubind
Definition: hwloc.h:2475
hwloc_obj_attr_u::hwloc_bridge_attr_s::downstream
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
hwloc_get_area_membind
int hwloc_get_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, hwloc_membind_policy_t *policy, int flags)
Query the CPUs near the physical NUMA node(s) and binding policy of the memory identified by (addr,...
HWLOC_OBJ_PCI_DEVICE
@ HWLOC_OBJ_PCI_DEVICE
PCI device (filtered out by default).
Definition: hwloc.h:319
hwloc_obj::attr
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:506
hwloc_obj_attr_u::hwloc_pcidev_attr_s::func
unsigned char func
Function number (t in the PCI BDF notation xxxx:yy:zz.t).
Definition: hwloc.h:727
HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM
@ HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM
Assume that the selected backend provides the topology for the system on which we are running.
Definition: hwloc.h:2278
hwloc_bitmap_t
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:69
hwloc_topology_destroy
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
HWLOC_OBJ_CACHE_DATA
@ HWLOC_OBJ_CACHE_DATA
Data cache.
Definition: hwloc.h:361
hwloc_obj_osdev_types_t
unsigned long hwloc_obj_osdev_types_t
Type(s) of a OS device. OR'ed set of hwloc_obj_osdev_type_e.
Definition: hwloc.h:423
hwloc_topology_components_flag_e
hwloc_topology_components_flag_e
Flags to be passed to hwloc_topology_set_components()
Definition: hwloc.h:2192
hwloc_obj_type_t
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:197
HWLOC_OBJ_MEMCACHE
@ HWLOC_OBJ_MEMCACHE
Memory-side cache (filtered out by default). A cache in front of a specific NUMA node.
Definition: hwloc.h:294
hwloc_topology_t
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:777
hwloc_topology_cpubind_support::get_thisproc_cpubind
unsigned char get_thisproc_cpubind
Definition: hwloc.h:2473
hwloc_get_area_memlocation
int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags)
Get the NUMA nodes where memory identified by (addr, len ) is physically allocated.
HWLOC_OBJ_SNPRINTF_FLAG_OLD_VERBOSE
@ HWLOC_OBJ_SNPRINTF_FLAG_OLD_VERBOSE
Backward compatibility with hwloc 2.x verbose mode, shows additional attributes, and memory sizes wit...
Definition: hwloc.h:1167
hwloc_topology_support::discovery
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:2550
HWLOC_RESTRICT_FLAG_ADAPT_IO
@ HWLOC_RESTRICT_FLAG_ADAPT_IO
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2746
hwloc_obj_attr_u::hwloc_bridge_attr_s
Bridge specific Object Attributes.
Definition: hwloc.h:743
hwloc_topology_set_userdata
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
hwloc_compare_types
int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
hwloc_obj_attr_u::hwloc_pcidev_attr_s::device_id
unsigned short device_id
Device ID (yyyy in [xxxx:yyyy]).
Definition: hwloc.h:731
hwloc_obj_bridge_type_t
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
HWLOC_OBJ_L2CACHE
@ HWLOC_OBJ_L2CACHE
Level 2 Data (or Unified) Cache.
Definition: hwloc.h:246
hwloc_obj_add_info
int hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value)
Add the given name and value pair to the given object info attributes.
hwloc_obj::prev_cousin
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:534
hwloc_topology_cpubind_support::get_thisthread_cpubind
unsigned char get_thisthread_cpubind
Definition: hwloc.h:2481
hwloc_set_cpubind
int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags)
Bind current process or thread on CPUs given in physical bitmap set.
hwloc_topology_membind_support
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:2499
HWLOC_OBJ_SNPRINTF_FLAG_NO_UNITS
@ HWLOC_OBJ_SNPRINTF_FLAG_NO_UNITS
Display memory sizes in bytes without units.
Definition: hwloc.h:1154
hwloc_obj_attr_u::hwloc_cache_attr_s::type
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:712
HWLOC_TOPOLOGY_FLAG_NO_CPUKINDS
@ HWLOC_TOPOLOGY_FLAG_NO_CPUKINDS
Ignore CPU Kinds.
Definition: hwloc.h:2405
hwloc_obj_attr_u::hwloc_osdev_attr_s
OS Device specific Object Attributes.
Definition: hwloc.h:759
hwloc_topology_discovery_support::numa
unsigned char numa
Detecting the number of NUMA nodes is supported.
Definition: hwloc.h:2453
hwloc_obj_attr_u::hwloc_cache_attr_s::linesize
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:709
HWLOC_OBJ_BRIDGE
@ HWLOC_OBJ_BRIDGE
Bridge (filtered out by default). Any bridge (or PCI switch) that connects the host or an I/O bus,...
Definition: hwloc.h:307
hwloc_topology_dup
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
hwloc_obj
Structure of a topology object.
Definition: hwloc.h:487
HWLOC_OBJ_SNPRINTF_FLAG_LONG_NAMES
@ HWLOC_OBJ_SNPRINTF_FLAG_LONG_NAMES
Use long type names such as L2Cache instead of L2.
Definition: hwloc.h:1136
hwloc_topology_set_all_types_filter
int hwloc_topology_set_all_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all object types.
hwloc_topology_membind_support::bind_membind
unsigned char bind_membind
Definition: hwloc.h:2525
HWLOC_OBJ_L3ICACHE
@ HWLOC_OBJ_L3ICACHE
Level 3 instruction Cache (filtered out by default).
Definition: hwloc.h:253
HWLOC_TYPE_FILTER_KEEP_IMPORTANT
@ HWLOC_TYPE_FILTER_KEEP_IMPORTANT
Only keep likely-important objects of the given type.
Definition: hwloc.h:2639
hwloc_obj::arity
unsigned arity
Number of normal children. Memory, Misc and I/O children are not listed here but rather in their dedi...
Definition: hwloc.h:543
HWLOC_TYPE_DEPTH_MEMCACHE
@ HWLOC_TYPE_DEPTH_MEMCACHE
Virtual depth for MemCache object.
Definition: hwloc.h:921
HWLOC_RESTRICT_FLAG_REMOVE_CPULESS
@ HWLOC_RESTRICT_FLAG_REMOVE_CPULESS
Remove all objects that became CPU-less. By default, only objects that contain no PU and no memory ar...
Definition: hwloc.h:2721
hwloc_obj_attr_u::cache
struct hwloc_obj_attr_u::hwloc_cache_attr_s cache
HWLOC_OBJ_OSDEV_MEMORY
@ HWLOC_OBJ_OSDEV_MEMORY
Operating system memory device. For instance "dax2.0" on Linux, either for normal DRAM when not expos...
Definition: hwloc.h:381
hwloc_obj::children
struct hwloc_obj ** children
Normal children, children[0 .. arity -1].
Definition: hwloc.h:547
hwloc_obj_attr_u::hwloc_pcidev_attr_s::prog_if
unsigned char prog_if
Register-level programming interface number (3rd byte of the class).
Definition: hwloc.h:728
hwloc_topology_cpubind_support::set_thread_cpubind
unsigned char set_thread_cpubind
Definition: hwloc.h:2483
hwloc_obj_attr_u::hwloc_pcidev_attr_s::revision
unsigned char revision
Revision number.
Definition: hwloc.h:734
hwloc_topology_discovery_support::cpukind_efficiency
unsigned char cpukind_efficiency
Detecting the efficiency of CPU kinds is supported, see Kinds of CPU cores.
Definition: hwloc.h:2461
hwloc_obj_attr_u::hwloc_bridge_attr_s::pci
struct hwloc_pcidev_attr_s pci
PCI attribute of the upstream part as a PCI device.
Definition: hwloc.h:745
hwloc_obj_attr_u::hwloc_osdev_attr_s::types
hwloc_obj_osdev_types_t types
OR'ed set of at least one hwloc_obj_osdev_type_e.
Definition: hwloc.h:760
HWLOC_TOPOLOGY_FLAG_DONT_CHANGE_BINDING
@ HWLOC_TOPOLOGY_FLAG_DONT_CHANGE_BINDING
Do not ever modify the process or thread binding during discovery.
Definition: hwloc.h:2385
HWLOC_MEMBIND_MIGRATE
@ HWLOC_MEMBIND_MIGRATE
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1765
hwloc_topology_membind_support::set_thisproc_membind
unsigned char set_thisproc_membind
Definition: hwloc.h:2501
hwloc_allow_flags_e
hwloc_allow_flags_e
Flags to be given to hwloc_topology_allow().
Definition: hwloc.h:2787
HWLOC_TYPE_DEPTH_BRIDGE
@ HWLOC_TYPE_DEPTH_BRIDGE
Virtual depth for bridge object level.
Definition: hwloc.h:917
HWLOC_TYPE_DEPTH_MISC
@ HWLOC_TYPE_DEPTH_MISC
Virtual depth for Misc object.
Definition: hwloc.h:920
hwloc_topology_get_userdata
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
HWLOC_OBJ_SNPRINTF_FLAG_SHORT_NAMES
@ HWLOC_OBJ_SNPRINTF_FLAG_SHORT_NAMES
Reduce the name even if it may become ambiguous, for instance by removing the OS device prefix and sh...
Definition: hwloc.h:1143
hwloc_topology_membind_support::firsttouch_membind
unsigned char firsttouch_membind
Definition: hwloc.h:2523
HWLOC_MEMBIND_NEXTTOUCH
@ HWLOC_MEMBIND_NEXTTOUCH
For each page bound with this policy, by next time it is touched (and next time only),...
Definition: hwloc.h:1717
hwloc_topology_support::misc
struct hwloc_topology_misc_support * misc
Definition: hwloc.h:2553
HWLOC_MEMBIND_INTERLEAVE
@ HWLOC_MEMBIND_INTERLEAVE
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1700
hwloc_topology_membind_support::alloc_membind
unsigned char alloc_membind
Definition: hwloc.h:2514
HWLOC_TYPE_FILTER_KEEP_NONE
@ HWLOC_TYPE_FILTER_KEEP_NONE
Ignore all objects of this type.
Definition: hwloc.h:2610
hwloc_obj_attr_u::hwloc_group_attr_s::dont_merge
unsigned char dont_merge
Flag preventing groups from being automatically merged with identical parent or children.
Definition: hwloc.h:720
hwloc_obj::name
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:499
hwloc_obj_attr_u::hwloc_pcidev_attr_s
PCI Device specific Object Attributes.
Definition: hwloc.h:723
hwloc_obj::userdata
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:672
hwloc_topology_cpubind_support::get_thread_cpubind
unsigned char get_thread_cpubind
Definition: hwloc.h:2485
hwloc_obj_attr_u::hwloc_pcidev_attr_s::bus
unsigned char bus
Bus number (yy in the PCI BDF notation xxxx:yy:zz.t).
Definition: hwloc.h:725
hwloc_obj_attr_u::hwloc_numanode_attr_s::local_memory
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:692
hwloc_obj::total_memory
hwloc_uint64_t total_memory
Total memory (in bytes) in NUMA nodes below this object.
Definition: hwloc.h:504
hwloc_topology_cpubind_support
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:2469
hwloc_obj_attr_u::hwloc_pcidev_attr_s::subvendor_id
unsigned short subvendor_id
Sub-Vendor ID.
Definition: hwloc.h:732
hwloc_obj::io_first_child
struct hwloc_obj * io_first_child
First I/O child. Bridges, PCI and OS devices are listed here (io_arity and io_first_child) instead of...
Definition: hwloc.h:584
HWLOC_OBJ_BRIDGE_PCI
@ HWLOC_OBJ_BRIDGE_PCI
PCI-side of a bridge.
Definition: hwloc.h:368
hwloc_obj_add_other_obj_sets
int hwloc_obj_add_other_obj_sets(hwloc_obj_t dst, hwloc_obj_t src)
Setup object cpusets/nodesets by OR'ing another object's sets.
hwloc_obj::misc_arity
unsigned misc_arity
Number of Misc children. These children are listed in misc_first_child.
Definition: hwloc.h:593
HWLOC_OBJ_SNPRINTF_FLAG_UNITS_1000
@ HWLOC_OBJ_SNPRINTF_FLAG_UNITS_1000
Display memory sizes in KB, MB, GB, etc i.e. divide by 1000 instead of 1024 for KiB,...
Definition: hwloc.h:1160
hwloc_topology_membind_support::interleave_membind
unsigned char interleave_membind
Definition: hwloc.h:2527
hwloc_obj_attr_u::bridge
struct hwloc_obj_attr_u::hwloc_bridge_attr_s bridge
hwloc_obj::cpuset
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:603
hwloc_obj_snprintf_flag_e
hwloc_obj_snprintf_flag_e
Flags to be given to hwloc_obj_type_snprintf() and hwloc_obj_attr_snprintf().
Definition: hwloc.h:1132
hwloc_obj::gp_index
hwloc_uint64_t gp_index
Global persistent index. Generated by hwloc, unique across the topology (contrary to os_index) and pe...
Definition: hwloc.h:677
hwloc_topology_membind_support::get_proc_membind
unsigned char get_proc_membind
Definition: hwloc.h:2507
HWLOC_ALLOW_FLAG_CUSTOM
@ HWLOC_ALLOW_FLAG_CUSTOM
Allow a custom set of objects, given to hwloc_topology_allow() as cpuset and/or nodeset parameters.
Definition: hwloc.h:2805
hwloc_obj_attr_u::hwloc_bridge_attr_s::subordinate_bus
unsigned char subordinate_bus
Highest PCI bus number below the bridge.
Definition: hwloc.h:752
HWLOC_TOPOLOGY_FLAG_THISSYSTEM_ALLOWED_RESOURCES
@ HWLOC_TOPOLOGY_FLAG_THISSYSTEM_ALLOWED_RESOURCES
Get the set of allowed resources from the local operating system even if the topology was loaded from...
Definition: hwloc.h:2299
hwloc_get_obj_by_type
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_TYPE_FILTER_KEEP_STRUCTURE
@ HWLOC_TYPE_FILTER_KEEP_STRUCTURE
Only ignore objects if their entire level does not bring any structure.
Definition: hwloc.h:2624
hwloc_obj::parent
struct hwloc_obj * parent
Parent, NULL if root (Machine object)
Definition: hwloc.h:537
HWLOC_TYPE_DEPTH_OS_DEVICE
@ HWLOC_TYPE_DEPTH_OS_DEVICE
Virtual depth for software device object level.
Definition: hwloc.h:919
hwloc_topology_set_type_filter
int hwloc_topology_set_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e filter)
Set the filtering for the given object type.
HWLOC_OBJ_OSDEV_OPENFABRICS
@ HWLOC_OBJ_OSDEV_OPENFABRICS
Operating system OpenFabrics device. For instance the "mlx4_0" InfiniBand HCA, or "hfi1_0" Omni-Path ...
Definition: hwloc.h:408
hwloc_obj_attr_u::hwloc_numanode_attr_s::hwloc_memory_page_type_s::size
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:700
hwloc_obj::complete_cpuset
hwloc_cpuset_t complete_cpuset
The complete CPU set of processors of this object,.
Definition: hwloc.h:618
hwloc_topology_get_type_filter
int hwloc_topology_get_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e *filter)
Get the current filtering for the given object type.
HWLOC_TOPOLOGY_COMPONENTS_FLAG_BLACKLIST
@ HWLOC_TOPOLOGY_COMPONENTS_FLAG_BLACKLIST
Blacklist the target component from being used.
Definition: hwloc.h:2196
hwloc_topology_abi_check
int hwloc_topology_abi_check(hwloc_topology_t topology)
Verify that the topology is compatible with the current hwloc library.
HWLOC_OBJ_L1CACHE
@ HWLOC_OBJ_L1CACHE
Level 1 Data (or Unified) Cache.
Definition: hwloc.h:245
hwloc_obj_t
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:686
hwloc_topology_alloc_group_object
hwloc_obj_t hwloc_topology_alloc_group_object(hwloc_topology_t topology)
Allocate a Group object to insert later with hwloc_topology_insert_group_object().
HWLOC_MODIFY_INFOS_OP_REMOVE
@ HWLOC_MODIFY_INFOS_OP_REMOVE
Remove existing info attributes that matches the given name and/or value if not NULL.
Definition: hwloc.h:1282
hwloc_obj::last_child
struct hwloc_obj * last_child
Last normal child.
Definition: hwloc.h:549
hwloc_topology_membind_support::migrate_membind
unsigned char migrate_membind
Definition: hwloc.h:2533
HWLOC_MEMBIND_BIND
@ HWLOC_MEMBIND_BIND
Allocate memory on the specified nodes.
Definition: hwloc.h:1691
HWLOC_OBJ_DIE
@ HWLOC_OBJ_DIE
Die within a physical package. A subpart of the physical package, that contains multiple cores.
Definition: hwloc.h:218
hwloc_obj_attr_u::pcidev
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
HWLOC_OBJ_CORE
@ HWLOC_OBJ_CORE
Core. A computation unit (may be shared by several PUs, aka logical processors).
Definition: hwloc.h:229
HWLOC_MEMBIND_STRICT
@ HWLOC_MEMBIND_STRICT
Definition: hwloc.h:1759
hwloc_topology_membind_support::get_thisthread_membind
unsigned char get_thisthread_membind
Definition: hwloc.h:2511
hwloc_alloc_membind_policy
void * hwloc_alloc_membind_policy(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by set.
HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED
@ HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED
Detect the whole system, ignore reservations, include disallowed objects.
Definition: hwloc.h:2258
hwloc_get_proc_membind
int hwloc_get_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_bitmap_t set, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the specified process.
hwloc_topology_set_synthetic
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
HWLOC_CPUBIND_STRICT
@ HWLOC_CPUBIND_STRICT
Request for strict binding from the OS.
Definition: hwloc.h:1436
hwloc_get_type_depth_e
hwloc_get_type_depth_e
Definition: hwloc.h:913
hwloc_obj_attr_u::hwloc_numanode_attr_s
NUMA node-specific Object Attributes.
Definition: hwloc.h:691
HWLOC_MODIFY_INFOS_OP_REPLACE
@ HWLOC_MODIFY_INFOS_OP_REPLACE
Replace existing info attributes with the given name, with a single attribute with the given name and...
Definition: hwloc.h:1274
hwloc_obj_attr_u::hwloc_bridge_attr_s::domain
unsigned int domain
Domain number the downstream PCI buses.
Definition: hwloc.h:750
HWLOC_OBJ_OSDEV_COPROC
@ HWLOC_OBJ_OSDEV_COPROC
Operating system co-processor device. For instance "opencl0d0" for a OpenCL device,...
Definition: hwloc.h:395
HWLOC_RESTRICT_FLAG_BYNODESET
@ HWLOC_RESTRICT_FLAG_BYNODESET
Restrict by nodeset instead of CPU set. Only keep objects whose nodeset is included or partially incl...
Definition: hwloc.h:2727
hwloc_obj_cache_type_e
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:359
hwloc_topology_insert_misc_object
hwloc_obj_t hwloc_topology_insert_misc_object(hwloc_topology_t topology, hwloc_obj_t parent, const char *name)
Add a MISC object as a leaf of the topology.
HWLOC_MEMBIND_NOCPUBIND
@ HWLOC_MEMBIND_NOCPUBIND
Avoid any effect on CPU binding.
Definition: hwloc.h:1778
hwloc_set_proc_membind
int hwloc_set_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the specified process to prefer the NUMA node(s) specified b...
hwloc_obj::infos
struct hwloc_infos_s infos
Array of info attributes (name and value strings).
Definition: hwloc.h:669
hwloc_cpuset_t
hwloc_bitmap_t hwloc_cpuset_t
A CPU set is a bitmap whose bits are set according to CPU physical OS indexes.
Definition: hwloc.h:161
HWLOC_OBJ_SNPRINTF_FLAG_MORE_ATTRS
@ HWLOC_OBJ_SNPRINTF_FLAG_MORE_ATTRS
Display additional attributes such as cache associativity, PCI link speed, and total memory.
Definition: hwloc.h:1149
HWLOC_RESTRICT_FLAG_REMOVE_MEMLESS
@ HWLOC_RESTRICT_FLAG_REMOVE_MEMLESS
Remove all objects that became Memory-less. By default, only objects that contain no PU and no memory...
Definition: hwloc.h:2734
hwloc_obj_type_string
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a constant stringified object type.
HWLOC_MEMBIND_FIRSTTOUCH
@ HWLOC_MEMBIND_FIRSTTOUCH
Allocate each memory page individually on the local NUMA node of the thread that touches it.
Definition: hwloc.h:1681
HWLOC_TOPOLOGY_FLAG_IMPORT_SUPPORT
@ HWLOC_TOPOLOGY_FLAG_IMPORT_SUPPORT
Import support from the imported topology.
Definition: hwloc.h:2323
hwloc_topology_allow
int hwloc_topology_allow(hwloc_topology_t restrict topology, hwloc_const_cpuset_t cpuset, hwloc_const_nodeset_t nodeset, unsigned long flags)
Change the sets of allowed PUs and NUMA nodes in the topology.
HWLOC_TOPOLOGY_FLAG_RESTRICT_TO_CPUBINDING
@ HWLOC_TOPOLOGY_FLAG_RESTRICT_TO_CPUBINDING
Do not consider resources outside of the process CPU binding.
Definition: hwloc.h:2348
hwloc_get_info_by_name
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.
HWLOC_OBJ_L3CACHE
@ HWLOC_OBJ_L3CACHE
Level 3 Data (or Unified) Cache.
Definition: hwloc.h:247
hwloc_type_filter_e
hwloc_type_filter_e
Type filtering flags.
Definition: hwloc.h:2596
hwloc_obj_attr_u::hwloc_bridge_attr_s::upstream_type
hwloc_obj_bridge_type_t upstream_type
Upstream Bridge type.
Definition: hwloc.h:747
HWLOC_OBJ_MISC
@ HWLOC_OBJ_MISC
Miscellaneous objects (filtered out by default). Objects without particular meaning,...
Definition: hwloc.h:340
hwloc_topology_free_group_object
int hwloc_topology_free_group_object(hwloc_topology_t topology, hwloc_obj_t group)
Free a group object allocated with hwloc_topology_alloc_group_object().
hwloc_get_nbobjs_by_depth
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, int depth)
Returns the width of level at depth depth.
HWLOC_ALLOW_FLAG_ALL
@ HWLOC_ALLOW_FLAG_ALL
Mark all objects as allowed in the topology.
Definition: hwloc.h:2792
hwloc_restrict_flags_e
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2715
hwloc_obj_attr_u::hwloc_cache_attr_s::associativity
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:710
hwloc_obj_attr_u::hwloc_group_attr_s::kind
unsigned kind
Internally-used kind of group.
Definition: hwloc.h:718
hwloc_obj_attr_u::hwloc_bridge_attr_s::depth
unsigned depth
Definition: hwloc.h:756
hwloc_topology_set_pid
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which process the topology is viewed from.
hwloc_set_thread_cpubind
int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags)
Bind a thread thread on CPUs given in physical bitmap set.
hwloc_topology_cpubind_support::set_thisproc_cpubind
unsigned char set_thisproc_cpubind
Definition: hwloc.h:2471
hwloc_modify_infos
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_type_sscanf
int hwloc_type_sscanf(const char *string, hwloc_obj_type_t *typep, union hwloc_obj_attr_u *attrp, size_t attrsize)
Return an object type and attributes from a type string.
hwloc_obj_bridge_type_e
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:366
hwloc_topology_cpubind_support::get_thisthread_last_cpu_location
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:2491
hwloc_obj::subtype
char * subtype
Subtype string to better describe the type field.
Definition: hwloc.h:490
hwloc_obj_attr_u::hwloc_cache_attr_s
Cache-specific Object Attributes.
Definition: hwloc.h:706
hwloc_topology_insert_group_object
hwloc_obj_t hwloc_topology_insert_group_object(hwloc_topology_t topology, hwloc_obj_t group)
Add more structure to the topology by adding an intermediate Group.
HWLOC_MEMBIND_MIXED
@ HWLOC_MEMBIND_MIXED
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1725
hwloc_obj_type_snprintf
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.
hwloc_topology_flags_e
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:2236
hwloc_obj_attr_u
Object type-specific Attributes.
Definition: hwloc.h:689
hwloc_obj_attr_u::hwloc_numanode_attr_s::hwloc_memory_page_type_s::count
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:701
HWLOC_MODIFY_INFOS_OP_ADD_UNIQUE
@ HWLOC_MODIFY_INFOS_OP_ADD_UNIQUE
Add a new info attribute with the given name and value only if that pair doesn't exist yet.
Definition: hwloc.h:1264
hwloc_get_next_obj_by_type
hwloc_obj_t hwloc_get_next_obj_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, hwloc_obj_t prev)
Returns the next object of type type.
hwloc_topology_refresh
int hwloc_topology_refresh(hwloc_topology_t topology)
Refresh internal structures after topology modification.
hwloc_obj_attr_u::hwloc_bridge_attr_s::secondary_bus
unsigned char secondary_bus
First PCI bus number below the bridge.
Definition: hwloc.h:751
HWLOC_OBJ_MACHINE
@ HWLOC_OBJ_MACHINE
Machine. A set of processors and memory with cache coherency.
Definition: hwloc.h:203
hwloc_obj_attr_u::hwloc_group_attr_s::subkind
unsigned subkind
Internally-used subkind to distinguish different levels of groups with same kind.
Definition: hwloc.h:719
hwloc_modify_infos_op_e
hwloc_modify_infos_op_e
Operations given to hwloc_modify_infos().
Definition: hwloc.h:1251
HWLOC_OBJ_CACHE_UNIFIED
@ HWLOC_OBJ_CACHE_UNIFIED
Unified cache.
Definition: hwloc.h:360
hwloc_topology_discovery_support::pu
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:2451
hwloc_set_proc_cpubind
int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags)
Bind a process pid on CPUs given in physical bitmap set.
hwloc_obj::symmetric_subtree
int symmetric_subtree
Set if the subtree of normal objects below this object is symmetric, which means all normal children ...
Definition: hwloc.h:552
HWLOC_OBJ_OSDEV_STORAGE
@ HWLOC_OBJ_OSDEV_STORAGE
Operating system storage device (e.g. block). For instance "sda" or "pmem0" on Linux,...
Definition: hwloc.h:375
HWLOC_TOPOLOGY_FLAG_NO_MEMATTRS
@ HWLOC_TOPOLOGY_FLAG_NO_MEMATTRS
Ignore memory attributes and tiers.
Definition: hwloc.h:2399
hwloc_obj_attr_u::hwloc_pcidev_attr_s::dev
unsigned char dev
Device number (zz in the PCI BDF notation xxxx:yy:zz.t).
Definition: hwloc.h:726
hwloc_free
int hwloc_free(hwloc_topology_t topology, void *addr, size_t len)
Free memory that was previously allocated by hwloc_alloc() or hwloc_alloc_membind().
hwloc_obj::prev_sibling
struct hwloc_obj * prev_sibling
Previous object below the same parent (inside the same list of children).
Definition: hwloc.h:540
hwloc_info_s::name
char * name
Info name.
Definition: hwloc.h:466
hwloc_topology_misc_support
Flags describing miscellaneous features.
Definition: hwloc.h:2538
hwloc_infos_s
Array of string info attributes (pairs of name and value).
Definition: hwloc.h:477
hwloc_topology_set_flags
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR'ed flags to non-yet-loaded topology.
hwloc_get_thread_cpubind
int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags)
Get the current physical binding of thread tid.
hwloc_topology_set_cache_types_filter
int hwloc_topology_set_cache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all CPU cache object types.
HWLOC_TYPE_FILTER_KEEP_ALL
@ HWLOC_TYPE_FILTER_KEEP_ALL
Keep all objects of this type.
Definition: hwloc.h:2602
HWLOC_OBJ_GROUP
@ HWLOC_OBJ_GROUP
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:255
hwloc_membind_policy_t
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1662
hwloc_topology_set_components
int hwloc_topology_set_components(hwloc_topology_t restrict topology, unsigned long flags, const char *restrict name)
Prevent a discovery component from being used for a topology.
hwloc_get_next_obj_by_depth
hwloc_obj_t hwloc_get_next_obj_by_depth(hwloc_topology_t topology, int depth, hwloc_obj_t prev)
Returns the next object at depth depth.
hwloc_get_type_depth_with_attr
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.
hwloc_get_proc_last_cpu_location
int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags)
Get the last physical CPU where a process ran.
hwloc_topology_discovery_support::disallowed_numa
unsigned char disallowed_numa
Detecting and identifying NUMA nodes that are not available to the current process is supported.
Definition: hwloc.h:2459
hwloc_topology_get_support
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
hwloc_obj::nodeset
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:631
hwloc_obj_attr_u::hwloc_numanode_attr_s::hwloc_memory_page_type_s
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:699
hwloc_topology_set_xmlbuffer
int hwloc_topology_set_xmlbuffer(hwloc_topology_t restrict topology, const char *restrict buffer, int size)
Enable XML based topology using a memory buffer (instead of a file, as with hwloc_topology_set_xml())...
hwloc_alloc_membind
void * hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by set.
hwloc_topology_discovery_support::disallowed_pu
unsigned char disallowed_pu
Detecting and identifying PU objects that are not available to the current process is supported.
Definition: hwloc.h:2457
hwloc_infos_s::count
unsigned count
Number of elements in the array.
Definition: hwloc.h:479
hwloc_obj_attr_u::hwloc_pcidev_attr_s::linkspeed
float linkspeed
Link speed in GB/s. This datarate is the currently configured speed of the entire PCI link (sum of th...
Definition: hwloc.h:735
hwloc_obj_attr_u::hwloc_cache_attr_s::depth
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:708
HWLOC_OBJ_L2ICACHE
@ HWLOC_OBJ_L2ICACHE
Level 2 instruction Cache (filtered out by default).
Definition: hwloc.h:252
HWLOC_CPUBIND_THREAD
@ HWLOC_CPUBIND_THREAD
Bind current thread of current process.
Definition: hwloc.h:1411
hwloc_alloc
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
hwloc_obj::logical_index
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:525
hwloc_topology_membind_support::get_area_memlocation
unsigned char get_area_memlocation
Definition: hwloc.h:2520
hwloc_obj::first_child
struct hwloc_obj * first_child
First normal child.
Definition: hwloc.h:548
HWLOC_CPUBIND_NOMEMBIND
@ HWLOC_CPUBIND_NOMEMBIND
Avoid any effect on memory binding.
Definition: hwloc.h:1453
HWLOC_MEMBIND_PROCESS
@ HWLOC_MEMBIND_PROCESS
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1746
HWLOC_OBJ_L1ICACHE
@ HWLOC_OBJ_L1ICACHE
Level 1 instruction Cache (filtered out by default).
Definition: hwloc.h:251
hwloc_obj_attr_u::hwloc_bridge_attr_s::upstream
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@0 upstream
hwloc_obj_attr_u::hwloc_numanode_attr_s::page_types
struct hwloc_obj_attr_u::hwloc_numanode_attr_s::hwloc_memory_page_type_s * page_types
hwloc_topology_membind_support::set_thisthread_membind
unsigned char set_thisthread_membind
Definition: hwloc.h:2509
hwloc_obj_attr_u::numanode
struct hwloc_obj_attr_u::hwloc_numanode_attr_s numanode
hwloc_obj::io_arity
unsigned io_arity
Number of I/O children. These children are listed in io_first_child.
Definition: hwloc.h:581
hwloc_nodeset_t
hwloc_bitmap_t hwloc_nodeset_t
A node set is a bitmap whose bits are set according to NUMA memory node physical OS indexes.
Definition: hwloc.h:178
hwloc_obj::memory_first_child
struct hwloc_obj * memory_first_child
First Memory child. NUMA nodes and Memory-side caches are listed here (memory_arity and memory_first_...
Definition: hwloc.h:566
hwloc_topology_membind_support::get_area_membind
unsigned char get_area_membind
Definition: hwloc.h:2518
HWLOC_CPUBIND_PROCESS
@ HWLOC_CPUBIND_PROCESS
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1407
hwloc_topology_cpubind_support::set_thisthread_cpubind
unsigned char set_thisthread_cpubind
Definition: hwloc.h:2479
hwloc_topology_membind_support::nexttouch_membind
unsigned char nexttouch_membind
Definition: hwloc.h:2531
HWLOC_MODIFY_INFOS_OP_ADD
@ HWLOC_MODIFY_INFOS_OP_ADD
Add a new info attribute with the given name and value.
Definition: hwloc.h:1256
HWLOC_TYPE_DEPTH_NUMANODE
@ HWLOC_TYPE_DEPTH_NUMANODE
Virtual depth for NUMA nodes.
Definition: hwloc.h:916
hwloc_obj_attr_u::hwloc_pcidev_attr_s::vendor_id
unsigned short vendor_id
Vendor ID (xxxx in [xxxx:yyyy]).
Definition: hwloc.h:730
hwloc_info_s
Info attribute (name and value strings)
Definition: hwloc.h:465
HWLOC_TYPE_DEPTH_PCI_DEVICE
@ HWLOC_TYPE_DEPTH_PCI_DEVICE
Virtual depth for PCI device object level.
Definition: hwloc.h:918
hwloc_obj::complete_nodeset
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:653
hwloc_get_cpubind
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
HWLOC_OBJ_OSDEV_NETWORK
@ HWLOC_OBJ_OSDEV_NETWORK
Operating system network device. For instance the "eth0" interface, "bxi0" Atos/Bull BXI HCA,...
Definition: hwloc.h:401
hwloc_topology_restrict
int hwloc_topology_restrict(hwloc_topology_t restrict topology, hwloc_const_bitmap_t set, unsigned long flags)
Restrict the topology to the given CPU set or nodeset.
hwloc_obj_cache_type_t
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
hwloc_obj_attr_u::hwloc_pcidev_attr_s::domain
unsigned int domain
Domain number (xxxx in the PCI BDF notation xxxx:yy:zz.t).
Definition: hwloc.h:724
hwloc_get_api_version
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
hwloc_obj_attr_u::hwloc_group_attr_s
Group-specific Object Attributes.
Definition: hwloc.h:715
HWLOC_MEMBIND_WEIGHTED_INTERLEAVE
@ HWLOC_MEMBIND_WEIGHTED_INTERLEAVE
Allocate memory on the given nodes in an interleaved / weighted manner. The precise layout of the mem...
Definition: hwloc.h:1710
hwloc_obj::depth
int depth
Vertical index in the hierarchy.
Definition: hwloc.h:510
HWLOC_TOPOLOGY_FLAG_RESTRICT_TO_MEMBINDING
@ HWLOC_TOPOLOGY_FLAG_RESTRICT_TO_MEMBINDING
Do not consider resources outside of the process memory binding.
Definition: hwloc.h:2370
hwloc_topology_set_xml
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
HWLOC_OBJ_NUMANODE
@ HWLOC_OBJ_NUMANODE
NUMA node. An object that contains memory that is directly and byte-accessible to the host processors...
Definition: hwloc.h:268
HWLOC_TOPOLOGY_FLAG_NO_DISTANCES
@ HWLOC_TOPOLOGY_FLAG_NO_DISTANCES
Ignore distances.
Definition: hwloc.h:2392
hwloc_topology_cpubind_support::get_thisproc_last_cpu_location
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:2487
HWLOC_OBJ_OSDEV_DMA
@ HWLOC_OBJ_OSDEV_DMA
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:414
hwloc_get_last_cpu_location
int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get the last physical CPU where the current process or thread ran.
hwloc_topology_set_icache_types_filter
int hwloc_topology_set_icache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all CPU instruction cache object types.