Hardware Locality (hwloc)  1.11.0
hwloc.h
1 /*
2  * Copyright © 2009 CNRS
3  * Copyright © 2009-2015 Inria. All rights reserved.
4  * Copyright © 2009-2012 Université Bordeaux
5  * Copyright © 2009-2011 Cisco Systems, Inc. All rights reserved.
6  * See COPYING in top-level directory.
7  */
8 
9 /*=====================================================================
10  * PLEASE GO READ THE DOCUMENTATION!
11  * ------------------------------------------------
12  * $tarball_directory/doc/doxygen-doc/
13  * or
14  * http://www.open-mpi.org/projects/hwloc/doc/
15  *=====================================================================
16  *
17  * FAIR WARNING: Do NOT expect to be able to figure out all the
18  * subtleties of hwloc by simply reading function prototypes and
19  * constant descrptions here in this file.
20  *
21  * Hwloc has wonderful documentation in both PDF and HTML formats for
22  * your reading pleasure. The formal documentation explains a LOT of
23  * hwloc-specific concepts, provides definitions, and discusses the
24  * "big picture" for many of the things that you'll find here in this
25  * header file.
26  *
27  * The PDF/HTML documentation was generated via Doxygen; much of what
28  * you'll see in there is also here in this file. BUT THERE IS A LOT
29  * THAT IS IN THE PDF/HTML THAT IS ***NOT*** IN hwloc.h!
30  *
31  * There are entire paragraph-length descriptions, discussions, and
32  * pretty prictures to explain subtle corner cases, provide concrete
33  * examples, etc.
34  *
35  * Please, go read the documentation. :-)
36  *
37  * Moreover there are several examples of hwloc use under doc/examples
38  * in the source tree.
39  *
40  *=====================================================================*/
41 
50 #ifndef HWLOC_H
51 #define HWLOC_H
52 
53 #include <hwloc/autogen/config.h>
54 #include <sys/types.h>
55 #include <stdio.h>
56 #include <string.h>
57 #include <limits.h>
58 
59 /*
60  * Symbol transforms
61  */
62 #include <hwloc/rename.h>
63 
64 /*
65  * Bitmap definitions
66  */
67 
68 #include <hwloc/bitmap.h>
69 #include <hwloc/cpuset.h>
70 
71 
72 #ifdef __cplusplus
73 extern "C" {
74 #endif
75 
76 
82 #define HWLOC_API_VERSION 0x00010b00
83 
85 HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);
86 
88 #define HWLOC_COMPONENT_ABI 4
89 
126 
146 
161 typedef enum {
162  /* ***************************************************************
163  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
164 
165  If new enum values are added here, you MUST also go update the
166  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
167 
168  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
169  *************************************************************** */
170 
243  /* ***************************************************************
244  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
245 
246  If new enum values are added here, you MUST also go update the
247  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
248 
249  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
250  *************************************************************** */
252 
260 
266 
285 
303 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
304 
307 };
308 
317 union hwloc_obj_attr_u;
318 
321  hwloc_uint64_t total_memory;
322  hwloc_uint64_t local_memory;
325  unsigned page_types_len;
332  hwloc_uint64_t size;
333  hwloc_uint64_t count;
334  } * page_types;
335 };
336 
341 struct hwloc_obj {
342  /* physical information */
344  unsigned os_index;
348  char *name;
355  /* global position */
356  unsigned depth;
361  unsigned logical_index;
365  signed os_level;
367  /* cousins are all objects of the same type (and depth) across the entire topology */
371  /* children of the same parent are siblings, even if they may have different type and depth */
372  struct hwloc_obj *parent;
373  unsigned sibling_rank;
377  /* children array below this object */
378  unsigned arity;
379  struct hwloc_obj **children;
383  /* misc */
384  void *userdata;
389  /* cpusets and nodesets */
390  hwloc_cpuset_t cpuset;
403  hwloc_cpuset_t complete_cpuset;
414  hwloc_cpuset_t online_cpuset;
422  hwloc_cpuset_t allowed_cpuset;
433  hwloc_nodeset_t nodeset;
450  hwloc_nodeset_t complete_nodeset;
464  hwloc_nodeset_t allowed_nodeset;
478  unsigned distances_count;
479 
481  unsigned infos_count;
488 };
492 typedef struct hwloc_obj * hwloc_obj_t;
493 
498  hwloc_uint64_t size;
499  unsigned depth;
500  unsigned linesize;
504  } cache;
507  unsigned depth;
508  } group;
511  unsigned short domain;
512  unsigned char bus, dev, func;
513  unsigned short class_id;
515  unsigned char revision;
516  float linkspeed; /* in GB/s */
517  } pcidev;
520  union {
522  } upstream;
524  union {
525  struct {
526  unsigned short domain;
528  } pci;
529  } downstream;
531  unsigned depth;
532  } bridge;
536  } osdev;
537 };
538 
553  unsigned relative_depth;
555  unsigned nbobjs;
560  float *latency;
572  float latency_max;
573  float latency_base;
577 };
578 
581  char *name;
582  char *value;
583 };
584 
593 struct hwloc_topology;
598 typedef struct hwloc_topology * hwloc_topology_t;
599 
606 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
607 
625 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
626 
631 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
632 
640 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
641 
653 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
654 
691 HWLOC_DECLSPEC int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type);
692 
701 HWLOC_DECLSPEC int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type);
702 
710 HWLOC_DECLSPEC int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology);
711 
726 
746 
759 
768 
778 
786 };
787 
797 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
798 
805 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
806 
821 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
822 
849 HWLOC_DECLSPEC int hwloc_topology_set_fsroot(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict fsroot_path);
850 
878 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
879 
906 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
907 
934 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
935 
955 HWLOC_DECLSPEC int hwloc_topology_set_custom(hwloc_topology_t topology);
956 
974 HWLOC_DECLSPEC int hwloc_topology_set_distance_matrix(hwloc_topology_t __hwloc_restrict topology,
975  hwloc_obj_type_t type, unsigned nbobjs,
976  unsigned *os_index, float *distances);
977 
985 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
986 
990  unsigned char pu;
991 };
992 
996  unsigned char set_thisproc_cpubind;
998  unsigned char get_thisproc_cpubind;
1000  unsigned char set_proc_cpubind;
1002  unsigned char get_proc_cpubind;
1004  unsigned char set_thisthread_cpubind;
1006  unsigned char get_thisthread_cpubind;
1008  unsigned char set_thread_cpubind;
1010  unsigned char get_thread_cpubind;
1017 };
1018 
1022  unsigned char set_thisproc_membind;
1024  unsigned char get_thisproc_membind;
1026  unsigned char set_proc_membind;
1028  unsigned char get_proc_membind;
1030  unsigned char set_thisthread_membind;
1032  unsigned char get_thisthread_membind;
1034  unsigned char set_area_membind;
1036  unsigned char get_area_membind;
1038  unsigned char alloc_membind;
1040  unsigned char firsttouch_membind;
1042  unsigned char bind_membind;
1044  unsigned char interleave_membind;
1046  unsigned char replicate_membind;
1048  unsigned char nexttouch_membind;
1049 
1051  unsigned char migrate_membind;
1052 };
1053 
1064 };
1065 
1067 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
1068 
1079 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
1080 
1086 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
1087 
1105 HWLOC_DECLSPEC unsigned hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1106 
1129 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
1130 
1137 };
1138 
1148 static __hwloc_inline int
1149 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1150 
1160 static __hwloc_inline int
1161 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1162 
1167 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1168 
1171 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1172 
1178 static __hwloc_inline int
1179 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1180 
1186 static __hwloc_inline hwloc_obj_t
1187 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
1188 
1190 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, unsigned depth, unsigned idx) __hwloc_attribute_pure;
1191 
1198 static __hwloc_inline hwloc_obj_t
1199 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
1200 
1205 static __hwloc_inline hwloc_obj_t
1206 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev);
1207 
1214 static __hwloc_inline hwloc_obj_t
1215 hwloc_get_next_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type,
1216  hwloc_obj_t prev);
1217 
1227 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
1228 
1255 HWLOC_DECLSPEC int hwloc_obj_type_sscanf(const char *string,
1256  hwloc_obj_type_t *typep,
1257  int *depthattrp,
1258  void *typeattrp, size_t typeattrsize);
1259 
1270 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj,
1271  int verbose);
1272 
1284 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj, const char * __hwloc_restrict separator,
1285  int verbose);
1286 
1294 HWLOC_DECLSPEC int hwloc_obj_cpuset_snprintf(char * __hwloc_restrict str, size_t size, size_t nobj, const hwloc_obj_t * __hwloc_restrict objs);
1295 
1302 static __hwloc_inline const char *
1303 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1304 
1319 HWLOC_DECLSPEC void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1320 
1389 typedef enum {
1393 
1397 
1422 
1440 
1446 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1447 
1453 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1454 
1466 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1467 
1479 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1480 
1481 #ifdef hwloc_thread_t
1482 
1489 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1490 #endif
1491 
1492 #ifdef hwloc_thread_t
1493 
1500 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1501 #endif
1502 
1516 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1517 
1534 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1535 
1612 typedef enum {
1619 
1629 
1633 
1642 
1655 
1662 
1669 
1683 typedef enum {
1689 
1694 
1702 
1708 
1722 
1735 HWLOC_DECLSPEC int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags);
1736 
1750 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags);
1751 
1792 HWLOC_DECLSPEC int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t * policy, int flags);
1793 
1839 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_cpuset_t cpuset, hwloc_membind_policy_t * policy, int flags);
1840 
1850 HWLOC_DECLSPEC int hwloc_set_proc_membind_nodeset(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags);
1851 
1861 HWLOC_DECLSPEC int hwloc_set_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags);
1862 
1899 HWLOC_DECLSPEC int hwloc_get_proc_membind_nodeset(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_nodeset_t nodeset, hwloc_membind_policy_t * policy, int flags);
1900 
1940 HWLOC_DECLSPEC int hwloc_get_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t cpuset, hwloc_membind_policy_t * policy, int flags);
1941 
1948 HWLOC_DECLSPEC int hwloc_set_area_membind_nodeset(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags);
1949 
1956 HWLOC_DECLSPEC int hwloc_set_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags);
1957 
1980 HWLOC_DECLSPEC int hwloc_get_area_membind_nodeset(hwloc_topology_t topology, const void *addr, size_t len, hwloc_nodeset_t nodeset, hwloc_membind_policy_t * policy, int flags);
1981 
2006 HWLOC_DECLSPEC int hwloc_get_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_cpuset_t cpuset, hwloc_membind_policy_t * policy, int flags);
2007 
2015 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
2016 
2028 HWLOC_DECLSPEC void *hwloc_alloc_membind_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags) __hwloc_attribute_malloc;
2029 
2041 HWLOC_DECLSPEC void *hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags) __hwloc_attribute_malloc;
2042 
2049 static __hwloc_inline void *
2050 hwloc_alloc_membind_policy_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags) __hwloc_attribute_malloc;
2051 
2056 static __hwloc_inline void *
2057 hwloc_alloc_membind_policy(hwloc_topology_t topology, size_t len, hwloc_const_cpuset_t set, hwloc_membind_policy_t policy, int flags) __hwloc_attribute_malloc;
2058 
2062 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
2063 
2086 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, const char *name);
2087 
2103 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2104 
2112 
2118 
2124 };
2125 
2147 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags);
2148 
2182 HWLOC_DECLSPEC int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2183 
2205 HWLOC_DECLSPEC hwloc_obj_t hwloc_custom_insert_group_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, int groupdepth);
2206 
2232 HWLOC_DECLSPEC int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath);
2233 
2252 HWLOC_DECLSPEC int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen);
2253 
2255 HWLOC_DECLSPEC void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer);
2256 
2275 HWLOC_DECLSPEC void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology,
2276  void (*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2277 
2303 HWLOC_DECLSPEC int hwloc_export_obj_userdata(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length);
2304 
2318 HWLOC_DECLSPEC int hwloc_export_obj_userdata_base64(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length);
2319 
2342 HWLOC_DECLSPEC void hwloc_topology_set_userdata_import_callback(hwloc_topology_t topology,
2343  void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length));
2344 
2363 
2371 };
2372 
2391  HWLOC_DECLSPEC int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags);
2392 
2397 #ifdef __cplusplus
2398 } /* extern "C" */
2399 #endif
2400 
2401 
2402 /* high-level helpers */
2403 #include <hwloc/helper.h>
2404 
2405 /* inline code of some functions above */
2406 #include <hwloc/inlines.h>
2407 
2408 /* topology diffs */
2409 #include <hwloc/diff.h>
2410 
2411 /* deprecated headers */
2412 #include <hwloc/deprecated.h>
2413 
2414 #endif /* HWLOC_H */
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:523
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:254
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:503
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:598
Whole system (may be a cluster of machines). The whole system that is accessible to hwloc...
Definition: hwloc.h:171
int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type.
unsigned distances_count
Definition: hwloc.h:478
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, unsigned depth)
Returns the width of level at depth depth.
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:322
hwloc_get_type_depth_e
Definition: hwloc.h:1131
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
int hwloc_set_area_membind_nodeset(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) in physical nodeset...
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:192
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA device on Linux...
Definition: hwloc.h:276
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:274
Machine. The typical root object type. A set of processors and memory with cache coherency.
Definition: hwloc.h:176
unsigned os_index
OS-provided physical index number. It is not guaranteed unique across the entire machine, except for PUs and NUMA nodes.
Definition: hwloc.h:344
unsigned char subordinate_bus
Definition: hwloc.h:527
Object type-specific Attributes.
Definition: hwloc.h:495
struct hwloc_obj_memory_s memory
Memory attributes.
Definition: hwloc.h:350
unsigned relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:553
Miscellaneous objects. Objects without particular meaning, that can e.g. be added by the application ...
Definition: hwloc.h:217
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:501
int hwloc_obj_type_snprintf(char *restrict string, size_t size, hwloc_obj_t obj, int verbose)
Stringify the type of a given topology object into a human-readable form.
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:369
Set of flags describing actual support for this topology.
Definition: hwloc.h:1060
Detect the whole PCI hierarchy.
Definition: hwloc.h:777
int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath)
Export the topology into an XML file.
unsigned nbobjs
Number of objects considered in the matrix. It is the number of descendant objects at relative_depth ...
Definition: hwloc.h:555
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1612
int hwloc_obj_attr_snprintf(char *restrict string, size_t size, hwloc_obj_t obj, const char *restrict separator, int verbose)
Stringify the attributes of a given topology object into a human-readable form.
float latency_base
The multiplier that should be applied to latency matrix to retrieve the original OS-provided latencie...
Definition: hwloc.h:573
unsigned short subdevice_id
Definition: hwloc.h:514
PCI Device specific Object Attributes.
Definition: hwloc.h:510
int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, 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...
unsigned char get_thisthread_cpubind
Definition: hwloc.h:1006
struct hwloc_obj_attr_u::hwloc_bridge_attr_s bridge
struct hwloc_obj_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:480
int hwloc_export_obj_userdata(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length)
Export some object userdata to XML.
Detect PCI bridges.
Definition: hwloc.h:767
Object memory.
Definition: hwloc.h:320
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:161
Reset the memory allocation policy to the system default. Depending on the operating system...
Definition: hwloc.h:1618
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:745
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.
Value returned by hwloc_compare_types when types can not be compared.
Definition: hwloc.h:306
void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer)
Free a buffer allocated by hwloc_topology_export_xmlbuffer()
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot)
Insert an existing topology inside a custom topology.
struct hwloc_obj * prev_sibling
Previous object below the same parent.
Definition: hwloc.h:375
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:1661
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:333
Bridge. Any bridge that connects the host or an I/O bus, to another I/O bus. Bridge objects have neit...
Definition: hwloc.h:223
hwloc_nodeset_t allowed_nodeset
The set of allowed NUMA memory nodes.
Definition: hwloc.h:464
hwloc_obj_t hwloc_get_obj_by_depth(hwloc_topology_t topology, unsigned depth, unsigned idx)
Returns the topology object at logical index idx from depth depth.
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:142
void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology, void(*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj))
Set the application-specific callback for exporting object userdata.
unsigned char replicate_membind
Definition: hwloc.h:1046
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:1012
int hwloc_set_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the specified process to prefer the NUMA node(s) near the sp...
int hwloc_export_obj_userdata_base64(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length)
Encode and export some object userdata to XML.
Unified cache.
Definition: hwloc.h:255
NUMA node. A set of processors around memory which the processors can directly access.
Definition: hwloc.h:181
unsigned char get_proc_membind
Definition: hwloc.h:1028
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:498
unsigned char get_thisproc_membind
Definition: hwloc.h:1024
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen)
Export the topology into a newly-allocated XML memory buffer.
hwloc_obj_t hwloc_custom_insert_group_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, int groupdepth)
Insert a new group object inside a custom topology.
int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags)
Bind a thread thread on cpus given in physical bitmap set.
int hwloc_get_membind(hwloc_topology_t topology, hwloc_cpuset_t cpuset, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the current process or thread (the l...
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:390
unsigned arity
Number of children.
Definition: hwloc.h:378
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:717
struct hwloc_pcidev_attr_s pci
Definition: hwloc.h:521
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1707
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2117
Physical package, what goes into a socket. In the physical meaning, i.e. that you can add or remove p...
Definition: hwloc.h:185
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:262
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:1020
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:52
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:332
Instruction cache. Only used when the HWLOC_TOPOLOGY_FLAG_ICACHES topology flag is set...
Definition: hwloc.h:257
OS Device specific Object Attributes.
Definition: hwloc.h:534
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 linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:500
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1683
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:331
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:422
hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, const char *name)
Add a MISC object to the topology.
static void * hwloc_alloc_membind_policy_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Allocate some memory on the given nodeset nodeset.
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.
char * name
Object description if any.
Definition: hwloc.h:348
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, unsigned depth)
Returns the type of objects at depth depth.
Operating system co-processor device. For instance "mic0" for a Xeon Phi (MIC) on Linux...
Definition: hwloc.h:280
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.
int hwloc_obj_type_sscanf(const char *string, hwloc_obj_type_t *typep, int *depthattrp, void *typeattrp, size_t typeattrsize)
Return an object type and attributes from a type string.
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.
Avoid any effect on CPU binding.
Definition: hwloc.h:1720
int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology)
Ignore all objects that do not bring any structure.
hwloc_topology_export_synthetic_flags_e
Flags for exporting synthetic topologies.
Definition: hwloc.h:2356
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:499
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:1014
unsigned char nexttouch_membind
Definition: hwloc.h:1048
unsigned char get_area_membind
Definition: hwloc.h:1036
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.
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
Structure of a topology object.
Definition: hwloc.h:341
Detect PCI devices.
Definition: hwloc.h:758
Avoid any effect on memory binding.
Definition: hwloc.h:1438
unsigned char get_thisthread_membind
Definition: hwloc.h:1032
struct hwloc_obj_attr_u::hwloc_group_attr_s group
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1133
Adapt distance matrices according to objects being removed during restriction. If this flag is not se...
Definition: hwloc.h:2111
unsigned short domain
Definition: hwloc.h:511
unsigned short class_id
Definition: hwloc.h:513
unsigned short vendor_id
Definition: hwloc.h:514
unsigned hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
unsigned char set_area_membind
Definition: hwloc.h:1034
int hwloc_get_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_cpuset_t cpuset, 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...
unsigned char set_proc_cpubind
Definition: hwloc.h:1000
char * name
Info name.
Definition: hwloc.h:581
hwloc_uint64_t total_memory
Total memory (in bytes) in this object and its children.
Definition: hwloc.h:321
void hwloc_topology_set_userdata_import_callback(hwloc_topology_t topology, void(*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length))
Set the application-specific callback for importing userdata.
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:205
float latency_max
The maximal value in the latency matrix.
Definition: hwloc.h:572
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1693
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR'ed flags of a topology.
unsigned depth
Definition: hwloc.h:531
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())...
Allocate memory on the specified nodes.
Definition: hwloc.h:1632
int hwloc_get_area_membind_nodeset(hwloc_topology_t topology, const void *addr, size_t len, hwloc_nodeset_t nodeset, hwloc_membind_policy_t *policy, int flags)
Query the physical NUMA node(s) and binding policy of the memory identified by (addr, len ).
int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
int hwloc_get_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t cpuset, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the specified process (the locality ...
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:433
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2123
unsigned char get_thisproc_cpubind
Definition: hwloc.h:998
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:379
Definition: hwloc.h:1701
unsigned char revision
Definition: hwloc.h:515
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
Virtual depth for bridge object level.
Definition: hwloc.h:1134
unsigned char get_thread_cpubind
Definition: hwloc.h:1010
void * hwloc_alloc_membind_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Allocate some memory on the given physical nodeset nodeset.
static hwloc_obj_t hwloc_get_next_obj_by_depth(hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev)
Returns the next object at depth depth.
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
hwloc_obj_osdev_type_t type
Definition: hwloc.h:535
char * value
Info value.
Definition: hwloc.h:582
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which pid the topology is viewed from.
int hwloc_obj_cpuset_snprintf(char *restrict str, size_t size, size_t nobj, const hwloc_obj_t *restrict objs)
Stringify the cpuset containing a set of objects.
struct hwloc_obj * next_sibling
Next object below the same parent.
Definition: hwloc.h:374
unsigned char secondary_bus
Definition: hwloc.h:527
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@0 upstream
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:368
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
int hwloc_topology_set_custom(hwloc_topology_t topology)
Prepare the topology for custom assembly.
unsigned infos_count
Size of infos array.
Definition: hwloc.h:481
Bridge specific Object Attribues.
Definition: hwloc.h:519
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:278
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1667
unsigned char set_thisthread_membind
Definition: hwloc.h:1030
unsigned char get_proc_cpubind
Definition: hwloc.h:1002
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:381
int hwloc_set_proc_membind_nodeset(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_nodeset_t nodeset, 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...
Detect the whole system, ignore reservations and offline settings.
Definition: hwloc.h:725
unsigned short domain
Definition: hwloc.h:526
unsigned char dev
Definition: hwloc.h:512
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:414
unsigned char set_thread_cpubind
Definition: hwloc.h:1008
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2106
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:352
struct hwloc_obj * first_child
First child.
Definition: hwloc.h:380
Request for strict binding from the OS.
Definition: hwloc.h:1421
unsigned short device_id
Definition: hwloc.h:514
static void * hwloc_alloc_membind_policy(hwloc_topology_t topology, size_t len, hwloc_const_cpuset_t set, hwloc_membind_policy_t policy, int flags)
Allocate some memory on the memory nodes near given cpuset cpuset.
Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allo...
Definition: hwloc.h:1628
unsigned char set_thisthread_cpubind
Definition: hwloc.h:1004
Group-specific Object Attributes.
Definition: hwloc.h:506
void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value)
Add the given info name and value pair to the given object.
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:125
No object of given type exists in the topology.
Definition: hwloc.h:1132
Flags describing actual discovery support for this topology.
Definition: hwloc.h:988
Operating system block device. For instance "sda" on Linux.
Definition: hwloc.h:269
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1641
int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type if it does not bring any structure.
float linkspeed
Definition: hwloc.h:516
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:530
int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the current process or thread...
float * latency
Matrix of latencies between objects, stored as a one-dimension array. May be NULL if the distances co...
Definition: hwloc.h:560
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
unsigned char set_thisproc_cpubind
Definition: hwloc.h:996
Object info.
Definition: hwloc.h:580
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1688
Export extended types such as L2dcache as basic types such as Cache.
Definition: hwloc.h:2362
hwloc_compare_types_e
Definition: hwloc.h:305
unsigned char set_proc_membind
Definition: hwloc.h:1026
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR'ed flags to non-yet-loaded topology.
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:450
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:271
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:384
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
unsigned char bind_membind
Definition: hwloc.h:1042
void * hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags)
Allocate some memory on memory nodes near the given physical cpuset cpuset.
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:994
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:1062
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:268
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:343
unsigned char migrate_membind
Definition: hwloc.h:1051
Cache-specific Object Attributes.
Definition: hwloc.h:497
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1063
Do not export level attributes.
Definition: hwloc.h:2370
Virtual depth for software device object level.
Definition: hwloc.h:1136
Bind current thread of current process.
Definition: hwloc.h:1396
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags)
Export the topology as a synthetic string.
unsigned short subvendor_id
Definition: hwloc.h:514
int hwloc_topology_restrict(hwloc_topology_t restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags)
Restrict the topology to the given CPU set.
Operating system device. These objects have neither CPU sets nor node sets. They are not added to the...
Definition: hwloc.h:235
int hwloc_get_proc_membind_nodeset(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_nodeset_t nodeset, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the specified process.
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:50
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:361
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
unsigned char bus
Definition: hwloc.h:512
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1061
Data cache.
Definition: hwloc.h:256
unsigned sibling_rank
Index in parent's children[] array.
Definition: hwloc.h:373
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
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().
Definition: hwloc.h:241
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.
signed os_level
OS-provided physical level, -1 if unknown or meaningless.
Definition: hwloc.h:365
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:372
int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, 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) nea...
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:145
Cache. Can be L1i, L1d, L2, L3, ...
Definition: hwloc.h:189
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:230
int symmetric_subtree
Set if the subtree of objects below this object is symmetric, which means all children and their chil...
Definition: hwloc.h:483
hwloc_obj_t hwloc_topology_insert_misc_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, const char *name)
Add a MISC object as a leaf of the topology.
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a stringified topology object type.
unsigned depth
Depth of group object.
Definition: hwloc.h:507
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.
unsigned char firsttouch_membind
Definition: hwloc.h:1040
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
unsigned char set_thisproc_membind
Definition: hwloc.h:1022
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:990
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:325
int hwloc_topology_set_fsroot(hwloc_topology_t restrict topology, const char *restrict fsroot_path)
Change the file-system root path when building the topology from sysfs/procfs.
Replicate memory on the given nodes; reads from this memory will attempt to be serviced from the NUMA...
Definition: hwloc.h:1654
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:196
static const char * hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name)
Search the given key name in object infos and return the corresponding value.
int hwloc_topology_set_distance_matrix(hwloc_topology_t restrict topology, hwloc_obj_type_t type, unsigned nbobjs, unsigned *os_index, float *distances)
Provide a distance matrix.
struct hwloc_distances_s ** distances
Distances between all objects at same depth below this object.
Definition: hwloc.h:477
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
unsigned char func
Definition: hwloc.h:512
PCI-side of a bridge.
Definition: hwloc.h:264
struct hwloc_obj_memory_s::hwloc_obj_memory_page_type_s * page_types
unsigned char interleave_membind
Definition: hwloc.h:1044
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:403
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
struct hwloc_obj_attr_u::hwloc_cache_attr_s cache
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_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1389
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:1016
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1392
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:492
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:123
unsigned char alloc_membind
Definition: hwloc.h:1038
Detect instruction caches.
Definition: hwloc.h:785
unsigned depth
Vertical index in the hierarchy. If the topology is symmetric, this is equal to the parent depth plus...
Definition: hwloc.h:356
Virtual depth for PCI device object level.
Definition: hwloc.h:1135
Distances between objects.
Definition: hwloc.h:552
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.
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:263
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
int hwloc_set_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) near physical cpuset...