Hardware Locality (hwloc) 1.10.0

- Main Page
- Related Pages
- Modules
- Data Structures

hwloc.h
1 /*
2 * Copyright © 2009 CNRS
3 * Copyright © 2009-2014 Inria. All rights reserved.
4 * Copyright © 2009-2012 Université Bordeaux 1
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
70
71 #ifdef __cplusplus
72 extern "C" {
73 #endif
74
75
81 #define HWLOC_API_VERSION 0x00010a00
82
84 HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);
85
87 #define HWLOC_COMPONENT_ABI 4
88
122 typedef hwloc_bitmap_t hwloc_cpuset_t;
124 typedef hwloc_const_bitmap_t hwloc_const_cpuset_t;
125
141 typedef hwloc_bitmap_t hwloc_nodeset_t;
144 typedef hwloc_const_bitmap_t hwloc_const_nodeset_t;
145
160 typedef enum {
161 /* ***************************************************************
162 WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
163
164 If new enum values are added here, you MUST also go update the
165 obj_type_order[] and obj_order_type[] arrays in src/topology.c.
166
167 WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
168 *************************************************************** */
169
170 HWLOC_OBJ_SYSTEM,
175 HWLOC_OBJ_MACHINE,
180 HWLOC_OBJ_NODE,
184 HWLOC_OBJ_SOCKET,
188 HWLOC_OBJ_CACHE,
191 HWLOC_OBJ_CORE,
195 HWLOC_OBJ_PU,
204 HWLOC_OBJ_GROUP,
216 HWLOC_OBJ_MISC,
221 HWLOC_OBJ_BRIDGE,
228 HWLOC_OBJ_PCI_DEVICE,
233 HWLOC_OBJ_OS_DEVICE,
239 HWLOC_OBJ_TYPE_MAX
241 /* ***************************************************************
242 WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
243
244 If new enum values are added here, you MUST also go update the
245 obj_type_order[] and obj_order_type[] arrays in src/topology.c.
246
247 WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
248 *************************************************************** */
249 } hwloc_obj_type_t;
250
252 typedef enum hwloc_obj_cache_type_e {
253 HWLOC_OBJ_CACHE_UNIFIED,
254 HWLOC_OBJ_CACHE_DATA,
255 HWLOC_OBJ_CACHE_INSTRUCTION
257 } hwloc_obj_cache_type_t;
258
260 typedef enum hwloc_obj_bridge_type_e {
261 HWLOC_OBJ_BRIDGE_HOST,
262 HWLOC_OBJ_BRIDGE_PCI
263 } hwloc_obj_bridge_type_t;
264
266 typedef enum hwloc_obj_osdev_type_e {
267 HWLOC_OBJ_OSDEV_BLOCK,
269 HWLOC_OBJ_OSDEV_GPU,
272 HWLOC_OBJ_OSDEV_NETWORK,
274 HWLOC_OBJ_OSDEV_OPENFABRICS,
276 HWLOC_OBJ_OSDEV_DMA,
278 HWLOC_OBJ_OSDEV_COPROC
282 } hwloc_obj_osdev_type_t;
283
301 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
302
303 enum hwloc_compare_types_e {
304 HWLOC_TYPE_UNORDERED = INT_MAX
305 };
306
315 union hwloc_obj_attr_u;
316
318 struct hwloc_obj_memory_s {
319 hwloc_uint64_t total_memory;
320 hwloc_uint64_t local_memory;
323 unsigned page_types_len;
329 struct hwloc_obj_memory_page_type_s {
330 hwloc_uint64_t size;
331 hwloc_uint64_t count;
332 } * page_types;
333 };
334
339 struct hwloc_obj {
340 /* physical information */
341 hwloc_obj_type_t type;
342 unsigned os_index;
343 char *name;
345 struct hwloc_obj_memory_s memory;
347 union hwloc_obj_attr_u *attr;
350 /* global position */
351 unsigned depth;
356 unsigned logical_index;
358 signed os_level;
360 /* cousins are all objects of the same type (and depth) across the entire topology */
361 struct hwloc_obj *next_cousin;
362 struct hwloc_obj *prev_cousin;
364 /* children of the same parent are siblings, even if they may have different type and depth */
365 struct hwloc_obj *parent;
366 unsigned sibling_rank;
367 struct hwloc_obj *next_sibling;
368 struct hwloc_obj *prev_sibling;
370 /* children array below this object */
371 unsigned arity;
372 struct hwloc_obj **children;
373 struct hwloc_obj *first_child;
374 struct hwloc_obj *last_child;
376 /* misc */
377 void *userdata;
382 /* cpusets and nodesets */
383 hwloc_cpuset_t cpuset;
396 hwloc_cpuset_t complete_cpuset;
407 hwloc_cpuset_t online_cpuset;
415 hwloc_cpuset_t allowed_cpuset;
426 hwloc_nodeset_t nodeset;
443 hwloc_nodeset_t complete_nodeset;
457 hwloc_nodeset_t allowed_nodeset;
470 struct hwloc_distances_s **distances;
471 unsigned distances_count;
472
473 struct hwloc_obj_info_s *infos;
474 unsigned infos_count;
476 int symmetric_subtree;
481 };
485 typedef struct hwloc_obj * hwloc_obj_t;
486
488 union hwloc_obj_attr_u {
490 struct hwloc_cache_attr_s {
491 hwloc_uint64_t size;
492 unsigned depth;
493 unsigned linesize;
494 int associativity;
496 hwloc_obj_cache_type_t type;
497 } cache;
499 struct hwloc_group_attr_s {
500 unsigned depth;
501 } group;
503 struct hwloc_pcidev_attr_s {
504 unsigned short domain;
505 unsigned char bus, dev, func;
506 unsigned short class_id;
507 unsigned short vendor_id, device_id, subvendor_id, subdevice_id;
508 unsigned char revision;
509 float linkspeed; /* in GB/s */
510 } pcidev;
512 struct hwloc_bridge_attr_s {
513 union {
514 struct hwloc_pcidev_attr_s pci;
515 } upstream;
516 hwloc_obj_bridge_type_t upstream_type;
517 union {
518 struct {
519 unsigned short domain;
520 unsigned char secondary_bus, subordinate_bus;
521 } pci;
522 } downstream;
523 hwloc_obj_bridge_type_t downstream_type;
524 unsigned depth;
525 } bridge;
527 struct hwloc_osdev_attr_s {
528 hwloc_obj_osdev_type_t type;
529 } osdev;
530 };
531
546 struct hwloc_distances_s {
547 unsigned relative_depth;
549 unsigned nbobjs;
554 float *latency;
559 float latency_max;
560 float latency_base;
564 };
565
567 struct hwloc_obj_info_s {
568 char *name;
569 char *value;
570 };
571
580 struct hwloc_topology;
585 typedef struct hwloc_topology * hwloc_topology_t;
586
593 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
594
612 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
613
618 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
619
631 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
632
667 HWLOC_DECLSPEC int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type);
668
677 HWLOC_DECLSPEC int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type);
678
686 HWLOC_DECLSPEC int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology);
687
693 enum hwloc_topology_flags_e {
701 HWLOC_TOPOLOGY_FLAG_WHOLE_SYSTEM = (1UL<<0),
702
721 HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM = (1UL<<1),
722
733 HWLOC_TOPOLOGY_FLAG_IO_DEVICES = (1UL<<2),
734
742 HWLOC_TOPOLOGY_FLAG_IO_BRIDGES = (1UL<<3),
743
751 HWLOC_TOPOLOGY_FLAG_WHOLE_IO = (1UL<<4),
752
759 HWLOC_TOPOLOGY_FLAG_ICACHES = (1UL<<5)
760 };
761
771 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
772
779 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
780
795 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
796
823 HWLOC_DECLSPEC int hwloc_topology_set_fsroot(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict fsroot_path);
824
852 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
853
880 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
881
908 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
909
929 HWLOC_DECLSPEC int hwloc_topology_set_custom(hwloc_topology_t topology);
930
948 HWLOC_DECLSPEC int hwloc_topology_set_distance_matrix(hwloc_topology_t __hwloc_restrict topology,
949 hwloc_obj_type_t type, unsigned nbobjs,
950 unsigned *os_index, float *distances);
951
959 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
960
962 struct hwloc_topology_discovery_support {
964 unsigned char pu;
965 };
966
968 struct hwloc_topology_cpubind_support {
970 unsigned char set_thisproc_cpubind;
972 unsigned char get_thisproc_cpubind;
974 unsigned char set_proc_cpubind;
976 unsigned char get_proc_cpubind;
978 unsigned char set_thisthread_cpubind;
980 unsigned char get_thisthread_cpubind;
982 unsigned char set_thread_cpubind;
984 unsigned char get_thread_cpubind;
986 unsigned char get_thisproc_last_cpu_location;
988 unsigned char get_proc_last_cpu_location;
990 unsigned char get_thisthread_last_cpu_location;
991 };
992
994 struct hwloc_topology_membind_support {
996 unsigned char set_thisproc_membind;
998 unsigned char get_thisproc_membind;
1000 unsigned char set_proc_membind;
1002 unsigned char get_proc_membind;
1004 unsigned char set_thisthread_membind;
1006 unsigned char get_thisthread_membind;
1008 unsigned char set_area_membind;
1010 unsigned char get_area_membind;
1012 unsigned char alloc_membind;
1014 unsigned char firsttouch_membind;
1016 unsigned char bind_membind;
1018 unsigned char interleave_membind;
1020 unsigned char replicate_membind;
1022 unsigned char nexttouch_membind;
1023
1025 unsigned char migrate_membind;
1026 };
1027
1034 struct hwloc_topology_support {
1035 struct hwloc_topology_discovery_support *discovery;
1036 struct hwloc_topology_cpubind_support *cpubind;
1037 struct hwloc_topology_membind_support *membind;
1038 };
1039
1041 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
1042
1053 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
1054
1060 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
1061
1079 HWLOC_DECLSPEC unsigned hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1080
1103 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
1104
1105 enum hwloc_get_type_depth_e {
1106 HWLOC_TYPE_DEPTH_UNKNOWN = -1,
1107 HWLOC_TYPE_DEPTH_MULTIPLE = -2,
1108 HWLOC_TYPE_DEPTH_BRIDGE = -3,
1109 HWLOC_TYPE_DEPTH_PCI_DEVICE = -4,
1110 HWLOC_TYPE_DEPTH_OS_DEVICE = -5
1111 };
1112
1122 static __hwloc_inline int
1123 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1124
1134 static __hwloc_inline int
1135 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1136
1141 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1142
1145 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1146
1152 static __hwloc_inline int
1153 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1154
1160 static __hwloc_inline hwloc_obj_t
1161 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
1162
1164 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, unsigned depth, unsigned idx) __hwloc_attribute_pure;
1165
1172 static __hwloc_inline hwloc_obj_t
1173 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
1174
1179 static __hwloc_inline hwloc_obj_t
1180 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev);
1181
1188 static __hwloc_inline hwloc_obj_t
1189 hwloc_get_next_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type,
1190 hwloc_obj_t prev);
1191
1201 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
1202
1229 HWLOC_DECLSPEC int hwloc_obj_type_sscanf(const char *string,
1230 hwloc_obj_type_t *typep,
1231 int *depthattrp,
1232 void *typeattrp, size_t typeattrsize);
1233
1244 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj,
1245 int verbose);
1246
1258 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj, const char * __hwloc_restrict separator,
1259 int verbose);
1260
1268 HWLOC_DECLSPEC int hwloc_obj_cpuset_snprintf(char * __hwloc_restrict str, size_t size, size_t nobj, const hwloc_obj_t * __hwloc_restrict objs);
1269
1276 static __hwloc_inline const char *
1277 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1278
1293 HWLOC_DECLSPEC void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1294
1363 typedef enum {
1366 HWLOC_CPUBIND_PROCESS = (1<<0),
1367
1370 HWLOC_CPUBIND_THREAD = (1<<1),
1371
1395 HWLOC_CPUBIND_STRICT = (1<<2),
1396
1412 HWLOC_CPUBIND_NOMEMBIND = (1<<3)
1413 } hwloc_cpubind_flags_t;
1414
1420 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1421
1427 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1428
1440 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1441
1453 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1454
1455 #ifdef hwloc_thread_t
1456
1463 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1464 #endif
1465
1466 #ifdef hwloc_thread_t
1467
1474 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1475 #endif
1476
1490 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1491
1508 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1509
1586 typedef enum {
1589 HWLOC_MEMBIND_DEFAULT = 0,
1590
1599 HWLOC_MEMBIND_FIRSTTOUCH = 1,
1600
1603 HWLOC_MEMBIND_BIND = 2,
1604
1612 HWLOC_MEMBIND_INTERLEAVE = 3,
1613
1625 HWLOC_MEMBIND_REPLICATE = 4,
1626
1632 HWLOC_MEMBIND_NEXTTOUCH = 5,
1633
1638 HWLOC_MEMBIND_MIXED = -1
1639 } hwloc_membind_policy_t;
1640
1654 typedef enum {
1659 HWLOC_MEMBIND_PROCESS = (1<<0),
1660
1664 HWLOC_MEMBIND_THREAD = (1<<1),
1665
1672 HWLOC_MEMBIND_STRICT = (1<<2),
1673
1678 HWLOC_MEMBIND_MIGRATE = (1<<3),
1679
1691 HWLOC_MEMBIND_NOCPUBIND = (1<<4)
1692 } hwloc_membind_flags_t;
1693
1706 HWLOC_DECLSPEC int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags);
1707
1721 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags);
1722
1763 HWLOC_DECLSPEC int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t * policy, int flags);
1764
1810 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_cpuset_t cpuset, hwloc_membind_policy_t * policy, int flags);
1811
1821 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);
1822
1832 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);
1833
1870 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);
1871
1911 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);
1912
1919 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);
1920
1927 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);
1928
1951 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);
1952
1977 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);
1978
1986 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
1987
1999 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;
2000
2012 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;
2013
2020 static __hwloc_inline void *
2021 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;
2022
2027 static __hwloc_inline void *
2028 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;
2029
2033 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
2034
2057 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, const char *name);
2058
2074 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2075
2077 enum hwloc_restrict_flags_e {
2082 HWLOC_RESTRICT_FLAG_ADAPT_DISTANCES = (1<<0),
2083
2088 HWLOC_RESTRICT_FLAG_ADAPT_MISC = (1<<1),
2089
2094 HWLOC_RESTRICT_FLAG_ADAPT_IO = (1<<2)
2095 };
2096
2118 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags);
2119
2127 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
2128
2162 HWLOC_DECLSPEC int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2163
2185 HWLOC_DECLSPEC hwloc_obj_t hwloc_custom_insert_group_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, int groupdepth);
2186
2212 HWLOC_DECLSPEC int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath);
2213
2232 HWLOC_DECLSPEC int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen);
2233
2235 HWLOC_DECLSPEC void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer);
2236
2255 HWLOC_DECLSPEC void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology,
2256 void (*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2257
2283 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);
2284
2298 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);
2299
2322 HWLOC_DECLSPEC void hwloc_topology_set_userdata_import_callback(hwloc_topology_t topology,
2323 void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length));
2324
2336 enum hwloc_topology_export_synthetic_flags_e {
2342 HWLOC_TOPOLOGY_EXPORT_SYNTHETIC_FLAG_NO_EXTENDED_TYPES = (1UL<<0),
2343
2350 HWLOC_TOPOLOGY_EXPORT_SYNTHETIC_FLAG_NO_ATTRS = (1UL<<1)
2351 };
2352
2371 HWLOC_DECLSPEC int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags);
2372
2377 #ifdef __cplusplus
2378 } /* extern "C" */
2379 #endif
2380
2381
2382 /* high-level helpers */
2383 #include <hwloc/helper.h>
2384
2385 /* inline code of some functions above */
2386 #include <hwloc/inlines.h>
2387
2388 /* topology diffs */
2389 #include <hwloc/diff.h>
2390
2391 /* deprecated headers */
2392 #include <hwloc/deprecated.h>
2393
2394 #endif /* HWLOC_H */
hwloc_obj_attr_u::hwloc_pcidev_attr_s::class_id
unsigned short class_id
Definition: hwloc.h:506
hwloc_obj_attr_u::hwloc_osdev_attr_s::type
hwloc_obj_osdev_type_t type
Definition: hwloc.h:528
hwloc_topology_cpubind_support::get_thisproc_last_cpu_location
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:986
hwloc_obj_attr_u::hwloc_bridge_attr_s::upstream
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@0 upstream
hwloc_alloc_membind_nodeset
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.
hwloc_obj_cache_type_e
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:252
HWLOC_MEMBIND_NOCPUBIND
Avoid any effect on CPU binding.
Definition: hwloc.h:1691
HWLOC_TOPOLOGY_FLAG_WHOLE_IO
Detect the whole PCI hierarchy.
Definition: hwloc.h:751
hwloc_topology_set_xml
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
HWLOC_TOPOLOGY_FLAG_ICACHES
Detect instruction caches.
Definition: hwloc.h:759
hwloc_topology_membind_support::get_proc_membind
unsigned char get_proc_membind
Definition: hwloc.h:1002
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::os_level
signed os_level
OS-provided physical level, -1 if unknown or meaningless.
Definition: hwloc.h:358
hwloc_obj::parent
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:365
hwloc_topology_membind_support::get_thisproc_membind
unsigned char get_thisproc_membind
Definition: hwloc.h:998
hwloc_topology_get_userdata
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
HWLOC_MEMBIND_REPLICATE
Replicate memory on the given nodes; reads from this memory will attempt to be serviced from the NUMA...
Definition: hwloc.h:1625
hwloc_obj_type_t
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:160
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_cpubind_flags_t
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1363
hwloc_obj_attr_u::hwloc_cache_attr_s::linesize
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:493
hwloc_custom_insert_topology
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.
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:260
hwloc_obj_memory_s::hwloc_obj_memory_page_type_s
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:329
HWLOC_TOPOLOGY_FLAG_IO_BRIDGES
Detect PCI bridges.
Definition: hwloc.h:742
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:141
hwloc_topology_membind_support::firsttouch_membind
unsigned char firsttouch_membind
Definition: hwloc.h:1014
hwloc_set_proc_membind_nodeset
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...
hwloc_export_obj_userdata
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.
hwloc_obj_memory_s::hwloc_obj_memory_page_type_s::count
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:331
hwloc_obj::arity
unsigned arity
Number of children.
Definition: hwloc.h:371
hwloc_free_xmlbuffer
void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer)
Free a buffer allocated by hwloc_topology_export_xmlbuffer()
HWLOC_OBJ_TYPE_MAX
Definition: hwloc.h:239
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_obj_memory_s::hwloc_obj_memory_page_type_s::size
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:330
hwloc_topology_export_synthetic_flags_e
hwloc_topology_export_synthetic_flags_e
Flags for exporting synthetic topologies.
Definition: hwloc.h:2336
hwloc_topology_is_thissystem
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
hwloc_obj::distances
struct hwloc_distances_s ** distances
Distances between all objects at same depth below this object.
Definition: hwloc.h:470
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:2088
hwloc_obj_attr_u::hwloc_bridge_attr_s::secondary_bus
unsigned char secondary_bus
Definition: hwloc.h:520
hwloc_obj_memory_s::page_types
struct hwloc_obj_memory_s::hwloc_obj_memory_page_type_s * page_types
hwloc_get_obj_by_type
static hwloc_obj_t hwloc_get_obj_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx)
Returns the topology object at logical index idx with type type.
hwloc_topology_membind_support::interleave_membind
unsigned char interleave_membind
Definition: hwloc.h:1018
HWLOC_CPUBIND_PROCESS
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1366
hwloc_obj_attr_u::hwloc_pcidev_attr_s
PCI Device specific Object Attributes.
Definition: hwloc.h:503
hwloc_obj_attr_u::hwloc_bridge_attr_s
Bridge specific Object Attribues.
Definition: hwloc.h:512
hwloc_topology_cpubind_support::get_thisthread_last_cpu_location
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:990
hwloc_get_nbobjs_by_depth
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, unsigned depth)
Returns the width of level at depth depth.
hwloc_obj_osdev_type_e
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:266
hwloc_obj::depth
unsigned depth
Vertical index in the hierarchy. If the topology is symmetric, this is equal to the parent depth plus...
Definition: hwloc.h:351
hwloc_topology_flags_e
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:693
hwloc_obj_attr_u::hwloc_pcidev_attr_s::subdevice_id
unsigned short subdevice_id
Definition: hwloc.h:507
HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:721
hwloc_topology_support::discovery
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1035
hwloc_obj_attr_u::hwloc_cache_attr_s::type
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:496
hwloc_obj::name
char * name
Object description if any.
Definition: hwloc.h:343
hwloc_distances_s::latency_base
float latency_base
The multiplier that should be applied to latency matrix to retrieve the original OS-provided latencie...
Definition: hwloc.h:560
hwloc_get_area_membind_nodeset
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 ).
hwloc_const_bitmap_t
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:52
hwloc_obj_attr_u::hwloc_group_attr_s
Group-specific Object Attributes.
Definition: hwloc.h:499
hwloc_obj_attr_u::hwloc_cache_attr_s::depth
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:492
hwloc_obj_attr_u::hwloc_pcidev_attr_s::vendor_id
unsigned short vendor_id
Definition: hwloc.h:507
hwloc_obj_attr_u::hwloc_bridge_attr_s::downstream_type
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:523
hwloc_topology_membind_support::get_area_membind
unsigned char get_area_membind
Definition: hwloc.h:1010
hwloc_compare_types_e
hwloc_compare_types_e
Definition: hwloc.h:303
hwloc_obj_attr_u::pcidev
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
HWLOC_RESTRICT_FLAG_ADAPT_DISTANCES
Adapt distance matrices according to objects being removed during restriction. If this flag is not se...
Definition: hwloc.h:2082
hwloc_topology_membind_support::set_area_membind
unsigned char set_area_membind
Definition: hwloc.h:1008
hwloc_obj_attr_u::hwloc_pcidev_attr_s::bus
unsigned char bus
Definition: hwloc.h:505
HWLOC_MEMBIND_FIRSTTOUCH
Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allo...
Definition: hwloc.h:1599
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_attr_snprintf
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.
hwloc_distances_s::relative_depth
unsigned relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:547
HWLOC_MEMBIND_DEFAULT
Reset the memory allocation policy to the system default.
Definition: hwloc.h:1589
hwloc_topology_ignore_all_keep_structure
int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology)
Ignore all objects that do not bring any structure.
hwloc_set_area_membind
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...
hwloc_obj_attr_u::bridge
struct hwloc_obj_attr_u::hwloc_bridge_attr_s bridge
hwloc_obj_attr_u::hwloc_bridge_attr_s::depth
unsigned depth
Definition: hwloc.h:524
hwloc_obj::infos
struct hwloc_obj_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:473
hwloc_get_type_or_above_depth
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.
hwloc_set_proc_membind
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...
HWLOC_OBJ_BRIDGE_PCI
PCI-side of a bridge.
Definition: hwloc.h:262
HWLOC_TYPE_DEPTH_BRIDGE
Virtual depth for bridge object level.
Definition: hwloc.h:1108
hwloc_obj_info_s::value
char * value
Info value.
Definition: hwloc.h:569
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:204
hwloc_obj_attr_u::hwloc_cache_attr_s::size
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:491
hwloc_topology_cpubind_support
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:968
hwloc_topology_cpubind_support::get_thisproc_cpubind
unsigned char get_thisproc_cpubind
Definition: hwloc.h:972
hwloc_topology_insert_misc_object_by_cpuset
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.
HWLOC_MEMBIND_BIND
Allocate memory on the specified nodes.
Definition: hwloc.h:1603
hwloc_topology_cpubind_support::get_thread_cpubind
unsigned char get_thread_cpubind
Definition: hwloc.h:984
hwloc_obj_attr_u::hwloc_osdev_attr_s
OS Device specific Object Attributes.
Definition: hwloc.h:527
hwloc_obj_attr_u::hwloc_pcidev_attr_s::linkspeed
float linkspeed
Definition: hwloc.h:509
hwloc_obj::prev_sibling
struct hwloc_obj * prev_sibling
Previous object below the same parent.
Definition: hwloc.h:368
hwloc_obj::allowed_nodeset
hwloc_nodeset_t allowed_nodeset
The set of allowed NUMA memory nodes.
Definition: hwloc.h:457
hwloc_custom_insert_group_object_by_parent
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.
hwloc_topology_set_userdata_export_callback
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.
hwloc_set_area_membind_nodeset
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...
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_memory_s::page_types_len
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:323
HWLOC_OBJ_OSDEV_OPENFABRICS
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA device on Linux...
Definition: hwloc.h:274
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_obj_attr_u::hwloc_pcidev_attr_s::func
unsigned char func
Definition: hwloc.h:505
hwloc_topology_discovery_support::pu
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:964
hwloc_get_api_version
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
hwloc_topology_membind_support::replicate_membind
unsigned char replicate_membind
Definition: hwloc.h:1020
hwloc_distances_s::nbobjs
unsigned nbobjs
Number of objects considered in the matrix. It is the number of descendant objects at relative_depth ...
Definition: hwloc.h:549
HWLOC_TOPOLOGY_FLAG_IO_DEVICES
Detect PCI devices.
Definition: hwloc.h:733
hwloc_get_next_obj_by_type
static hwloc_obj_t hwloc_get_next_obj_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, hwloc_obj_t prev)
Returns the next object of type type.
hwloc_topology_get_flags
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR'ed flags of a topology.
hwloc_get_membind_nodeset
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...
hwloc_obj_add_info
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_topology_support::membind
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1037
hwloc_get_root_obj
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
hwloc_topology_membind_support::set_thisthread_membind
unsigned char set_thisthread_membind
Definition: hwloc.h:1004
hwloc_topology_cpubind_support::get_proc_cpubind
unsigned char get_proc_cpubind
Definition: hwloc.h:976
hwloc_obj::last_child
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:374
HWLOC_MEMBIND_NEXTTOUCH
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:1632
hwloc_topology_get_support
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
hwloc_obj_info_s
Object info.
Definition: hwloc.h:567
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_userdata_import_callback
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.
hwloc_topology_cpubind_support::set_thread_cpubind
unsigned char set_thread_cpubind
Definition: hwloc.h:982
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:347
hwloc_obj::first_child
struct hwloc_obj * first_child
First child.
Definition: hwloc.h:373
hwloc_restrict_flags_e
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2077
hwloc_obj::cpuset
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:383
hwloc_obj_attr_u::hwloc_bridge_attr_s::upstream_type
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:516
hwloc_obj_attr_u::hwloc_pcidev_attr_s::dev
unsigned char dev
Definition: hwloc.h:505
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_set_custom
int hwloc_topology_set_custom(hwloc_topology_t topology)
Prepare the topology for custom assembly.
HWLOC_OBJ_NODE
NUMA node. A set of processors around memory which the processors can directly access.
Definition: hwloc.h:180
hwloc_distances_s::latency
float * latency
Matrix of latencies between objects, stored as a one-dimension array. May be NULL if the distances co...
Definition: hwloc.h:554
HWLOC_CPUBIND_NOMEMBIND
Avoid any effect on memory binding.
Definition: hwloc.h:1412
HWLOC_OBJ_OSDEV_COPROC
Operating system co-processor device. For instance "mic0" for a Xeon Phi (MIC) on Linux...
Definition: hwloc.h:278
hwloc_obj_attr_u::hwloc_pcidev_attr_s::domain
unsigned short domain
Definition: hwloc.h:504
HWLOC_OBJ_PCI_DEVICE
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:228
HWLOC_OBJ_SYSTEM
Whole system (may be a cluster of machines). The whole system that is accessible to hwloc...
Definition: hwloc.h:170
HWLOC_OBJ_PU
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:195
hwloc_obj_attr_u::hwloc_bridge_attr_s::subordinate_bus
unsigned char subordinate_bus
Definition: hwloc.h:520
HWLOC_OBJ_MACHINE
Machine. The typical root object type. A set of processors and memory with cache coherency.
Definition: hwloc.h:175
hwloc_get_nbobjs_by_type
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
hwloc_obj::allowed_cpuset
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:415
hwloc_obj_info_s::name
char * name
Info name.
Definition: hwloc.h:568
hwloc_topology_membind_support::set_proc_membind
unsigned char set_proc_membind
Definition: hwloc.h:1000
HWLOC_TOPOLOGY_FLAG_WHOLE_SYSTEM
Detect the whole system, ignore reservations and offline settings.
Definition: hwloc.h:701
hwloc_obj_attr_u::hwloc_bridge_attr_s::downstream
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
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_alloc
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
hwloc_distances_s
Distances between objects.
Definition: hwloc.h:546
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:377
hwloc_topology_membind_support::bind_membind
unsigned char bind_membind
Definition: hwloc.h:1016
hwloc_topology_ignore_type_keep_structure
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.
hwloc_get_type_depth_e
hwloc_get_type_depth_e
Definition: hwloc.h:1105
HWLOC_MEMBIND_STRICT
Definition: hwloc.h:1672
hwloc_obj_osdev_type_t
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
hwloc_set_membind
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...
HWLOC_TYPE_DEPTH_OS_DEVICE
Virtual depth for software device object level.
Definition: hwloc.h:1110
hwloc_topology_cpubind_support::get_proc_last_cpu_location
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:988
hwloc_topology_membind_support::nexttouch_membind
unsigned char nexttouch_membind
Definition: hwloc.h:1022
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_export_obj_userdata_base64
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.
hwloc_topology_membind_support::migrate_membind
unsigned char migrate_membind
Definition: hwloc.h:1025
HWLOC_TYPE_DEPTH_MULTIPLE
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1107
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_membind_policy_t
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1586
HWLOC_MEMBIND_INTERLEAVE
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1612
hwloc_topology_membind_support::get_thisthread_membind
unsigned char get_thisthread_membind
Definition: hwloc.h:1006
hwloc_obj_attr_u::group
struct hwloc_obj_attr_u::hwloc_group_attr_s group
HWLOC_TOPOLOGY_EXPORT_SYNTHETIC_FLAG_NO_ATTRS
Do not export level attributes.
Definition: hwloc.h:2350
hwloc_topology_insert_misc_object_by_parent
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.
hwloc_topology_cpubind_support::set_proc_cpubind
unsigned char set_proc_cpubind
Definition: hwloc.h:974
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_CACHE_UNIFIED
Unified cache.
Definition: hwloc.h:253
hwloc_obj::logical_index
unsigned logical_index
Horizontal index in the whole list of similar objects, could be a "cousin_rank" since it's the rank w...
Definition: hwloc.h:356
hwloc_obj_attr_u
Object type-specific Attributes.
Definition: hwloc.h:488
hwloc_get_next_obj_by_depth
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.
hwloc_topology_export_xml
int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath)
Export the topology into an XML file.
HWLOC_OBJ_CACHE_DATA
Data cache.
Definition: hwloc.h:254
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:269
hwloc_topology_destroy
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
hwloc_alloc_membind
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.
hwloc_topology_set_pid
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which pid the topology is viewed from.
hwloc_topology_support
Set of flags describing actual support for this topology.
Definition: hwloc.h:1034
hwloc_obj::sibling_rank
unsigned sibling_rank
Index in parent's children[] array.
Definition: hwloc.h:366
hwloc_obj_cache_type_t
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
hwloc_topology_discovery_support
Flags describing actual discovery support for this topology.
Definition: hwloc.h:962
hwloc_obj::nodeset
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:426
hwloc_obj_t
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:485
hwloc_alloc_membind_policy_nodeset
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.
hwloc_obj::children
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:372
HWLOC_OBJ_OS_DEVICE
Operating system device. These objects have neither CPU sets nor node sets. They are not added to the...
Definition: hwloc.h:233
hwloc_topology_export_synthetic
int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags)
Export the topology as a synthetic string.
hwloc_obj_memory_s
Object memory.
Definition: hwloc.h:318
hwloc_obj::symmetric_subtree
int symmetric_subtree
Set if the subtree of objects below this object is symmetric, which means all children and their chil...
Definition: hwloc.h:476
hwloc_obj_type_sscanf
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.
hwloc_obj_attr_u::hwloc_group_attr_s::depth
unsigned depth
Depth of group object.
Definition: hwloc.h:500
HWLOC_OBJ_BRIDGE
Bridge. Any bridge that connects the host or an I/O bus, to another I/O bus. Bridge objects have neit...
Definition: hwloc.h:221
hwloc_topology_membind_support::set_thisproc_membind
unsigned char set_thisproc_membind
Definition: hwloc.h:996
HWLOC_MEMBIND_THREAD
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1664
hwloc_obj_get_info_by_name
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.
HWLOC_OBJ_BRIDGE_HOST
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:261
hwloc_obj::next_sibling
struct hwloc_obj * next_sibling
Next object below the same parent.
Definition: hwloc.h:367
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:124
HWLOC_MEMBIND_PROCESS
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1659
hwloc_obj::next_cousin
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:361
hwloc_obj_attr_u::hwloc_pcidev_attr_s::subvendor_id
unsigned short subvendor_id
Definition: hwloc.h:507
hwloc_obj::infos_count
unsigned infos_count
Size of infos array.
Definition: hwloc.h:474
hwloc_obj::complete_cpuset
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:396
hwloc_const_nodeset_t
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:144
HWLOC_OBJ_SOCKET
Socket, physical package, or chip. In the physical meaning, i.e. that you can add or remove physicall...
Definition: hwloc.h:184
hwloc_get_depth_type
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, unsigned depth)
Returns the type of objects at depth depth.
hwloc_topology_restrict
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.
HWLOC_CPUBIND_STRICT
Request for strict binding from the OS.
Definition: hwloc.h:1395
hwloc_obj_attr_u::cache
struct hwloc_obj_attr_u::hwloc_cache_attr_s cache
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:2094
hwloc_obj_attr_u::hwloc_bridge_attr_s::domain
unsigned short domain
Definition: hwloc.h:519
hwloc_topology_set_synthetic
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
hwloc_topology_export_xmlbuffer
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_OSDEV_BLOCK
Operating system block device. For instance "sda" on Linux.
Definition: hwloc.h:267
hwloc_obj_attr_u::hwloc_cache_attr_s
Cache-specific Object Attributes.
Definition: hwloc.h:490
hwloc_obj::online_cpuset
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:407
hwloc_topology_load
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
hwloc_topology_membind_support::alloc_membind
unsigned char alloc_membind
Definition: hwloc.h:1012
hwloc_obj_attr_u::hwloc_cache_attr_s::associativity
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:494
hwloc_topology_cpubind_support::set_thisthread_cpubind
unsigned char set_thisthread_cpubind
Definition: hwloc.h:978
hwloc_topology_set_distance_matrix
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.
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_set_membind_nodeset
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...
hwloc_obj_attr_u::hwloc_bridge_attr_s::pci
struct hwloc_pcidev_attr_s pci
Definition: hwloc.h:514
hwloc_membind_flags_t
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1654
HWLOC_OBJ_OSDEV_NETWORK
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:272
hwloc_obj_attr_u::hwloc_pcidev_attr_s::revision
unsigned char revision
Definition: hwloc.h:508
hwloc_topology_init
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
hwloc_obj_type_string
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a stringified topology object type.
hwloc_topology_support::cpubind
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:1036
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_MISC
Miscellaneous objects. Objects without particular meaning, that can e.g. be added by the application ...
Definition: hwloc.h:216
hwloc_obj::distances_count
unsigned distances_count
Definition: hwloc.h:471
hwloc_obj_memory_s::local_memory
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:320
HWLOC_TYPE_DEPTH_UNKNOWN
No object of given type exists in the topology.
Definition: hwloc.h:1106
HWLOC_TOPOLOGY_EXPORT_SYNTHETIC_FLAG_NO_EXTENDED_TYPES
Export extended types such as L2dcache as basic types such as Cache.
Definition: hwloc.h:2342
hwloc_topology_membind_support
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:994
hwloc_obj_cpuset_snprintf
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.
hwloc_topology_cpubind_support::set_thisproc_cpubind
unsigned char set_thisproc_cpubind
Definition: hwloc.h:970
HWLOC_OBJ_CACHE
Cache. Can be L1i, L1d, L2, L3, ...
Definition: hwloc.h:188
HWLOC_OBJ_CACHE_INSTRUCTION
Instruction cache. Only used when the HWLOC_TOPOLOGY_FLAG_ICACHES topology flag is set...
Definition: hwloc.h:255
hwloc_obj::os_index
unsigned os_index
OS-provided physical index number.
Definition: hwloc.h:342
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:122
HWLOC_OBJ_OSDEV_DMA
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:276
hwloc_obj::memory
struct hwloc_obj_memory_s memory
Memory attributes.
Definition: hwloc.h:345
hwloc_obj_type_snprintf
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.
hwloc_obj::prev_cousin
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:362
hwloc_obj::complete_nodeset
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:443
hwloc_get_proc_membind_nodeset
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.
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:50
hwloc_topology_t
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:585
HWLOC_OBJ_CORE
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:191
hwloc_get_obj_by_depth
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_MEMBIND_MIGRATE
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1678
hwloc_topology_ignore_type
int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type.
hwloc_get_area_membind
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...
HWLOC_CPUBIND_THREAD
Bind current thread of current process.
Definition: hwloc.h:1370
hwloc_topology_cpubind_support::get_thisthread_cpubind
unsigned char get_thisthread_cpubind
Definition: hwloc.h:980
hwloc_topology_set_userdata
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
HWLOC_TYPE_UNORDERED
Value returned by hwloc_compare_types when types can not be compared.
Definition: hwloc.h:304
hwloc_alloc_membind_policy
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.
hwloc_obj_attr_u::hwloc_pcidev_attr_s::device_id
unsigned short device_id
Definition: hwloc.h:507
HWLOC_MEMBIND_MIXED
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1638
hwloc_obj::type
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:341
hwloc_obj_attr_u::osdev
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
HWLOC_TYPE_DEPTH_PCI_DEVICE
Virtual depth for PCI device object level.
Definition: hwloc.h:1109
hwloc_get_membind
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_topology_get_depth
unsigned hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
hwloc_distances_s::latency_max
float latency_max
The maximal value in the latency matrix.
Definition: hwloc.h:559
hwloc_get_proc_membind
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_obj
Structure of a topology object.
Definition: hwloc.h:339
hwloc_topology_dup
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
hwloc_get_type_or_below_depth
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.
hwloc_topology_set_fsroot
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.
hwloc_obj_memory_s::total_memory
hwloc_uint64_t total_memory
Total memory (in bytes) in this object and its children.
Definition: hwloc.h:319