Hardware Locality (hwloc): hwloc.h Source File

Hardware Locality (hwloc) 1.9

- 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 *=====================================================================*/
38
47 #ifndef HWLOC_H
48 #define HWLOC_H
49
50 #include <hwloc/autogen/config.h>
51 #include <sys/types.h>
52 #include <stdio.h>
53 #include <string.h>
54 #include <limits.h>
55
56 /*
57 * Symbol transforms
58 */
59 #include <hwloc/rename.h>
60
61 /*
62 * Bitmap definitions
63 */
64
65 #include <hwloc/bitmap.h>
66
67
68 #ifdef __cplusplus
69 extern "C" {
70 #endif
71
72
78 #define HWLOC_API_VERSION 0x00010900
79
81 HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);
82
84 #define HWLOC_COMPONENT_ABI 3
85
116 typedef hwloc_bitmap_t hwloc_cpuset_t;
118 typedef hwloc_const_bitmap_t hwloc_const_cpuset_t;
119
133 typedef hwloc_bitmap_t hwloc_nodeset_t;
136 typedef hwloc_const_bitmap_t hwloc_const_nodeset_t;
137
152 typedef enum {
153 /* ***************************************************************
154 WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
155
156 If new enum values are added here, you MUST also go update the
157 obj_type_order[] and obj_order_type[] arrays in src/topology.c.
158
159 WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
160 *************************************************************** */
161
162 HWLOC_OBJ_SYSTEM,
167 HWLOC_OBJ_MACHINE,
172 HWLOC_OBJ_NODE,
176 HWLOC_OBJ_SOCKET,
180 HWLOC_OBJ_CACHE,
183 HWLOC_OBJ_CORE,
187 HWLOC_OBJ_PU,
196 HWLOC_OBJ_GROUP,
208 HWLOC_OBJ_MISC,
213 HWLOC_OBJ_BRIDGE,
220 HWLOC_OBJ_PCI_DEVICE,
225 HWLOC_OBJ_OS_DEVICE,
231 HWLOC_OBJ_TYPE_MAX
233 /* ***************************************************************
234 WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
235
236 If new enum values are added here, you MUST also go update the
237 obj_type_order[] and obj_order_type[] arrays in src/topology.c.
238
239 WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
240 *************************************************************** */
241 } hwloc_obj_type_t;
242
244 typedef enum hwloc_obj_cache_type_e {
245 HWLOC_OBJ_CACHE_UNIFIED,
246 HWLOC_OBJ_CACHE_DATA,
247 HWLOC_OBJ_CACHE_INSTRUCTION
249 } hwloc_obj_cache_type_t;
250
252 typedef enum hwloc_obj_bridge_type_e {
253 HWLOC_OBJ_BRIDGE_HOST,
254 HWLOC_OBJ_BRIDGE_PCI
255 } hwloc_obj_bridge_type_t;
256
258 typedef enum hwloc_obj_osdev_type_e {
259 HWLOC_OBJ_OSDEV_BLOCK,
261 HWLOC_OBJ_OSDEV_GPU,
264 HWLOC_OBJ_OSDEV_NETWORK,
266 HWLOC_OBJ_OSDEV_OPENFABRICS,
268 HWLOC_OBJ_OSDEV_DMA,
270 HWLOC_OBJ_OSDEV_COPROC
274 } hwloc_obj_osdev_type_t;
275
293 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
294
295 enum hwloc_compare_types_e {
296 HWLOC_TYPE_UNORDERED = INT_MAX
297 };
298
307 union hwloc_obj_attr_u;
308
310 struct hwloc_obj_memory_s {
311 hwloc_uint64_t total_memory;
312 hwloc_uint64_t local_memory;
315 unsigned page_types_len;
321 struct hwloc_obj_memory_page_type_s {
322 hwloc_uint64_t size;
323 hwloc_uint64_t count;
324 } * page_types;
325 };
326
331 struct hwloc_obj {
332 /* physical information */
333 hwloc_obj_type_t type;
334 unsigned os_index;
335 char *name;
337 struct hwloc_obj_memory_s memory;
339 union hwloc_obj_attr_u *attr;
342 /* global position */
343 unsigned depth;
348 unsigned logical_index;
350 signed os_level;
352 /* cousins are all objects of the same type (and depth) across the entire topology */
353 struct hwloc_obj *next_cousin;
354 struct hwloc_obj *prev_cousin;
356 /* children of the same parent are siblings, even if they may have different type and depth */
357 struct hwloc_obj *parent;
358 unsigned sibling_rank;
359 struct hwloc_obj *next_sibling;
360 struct hwloc_obj *prev_sibling;
362 /* children array below this object */
363 unsigned arity;
364 struct hwloc_obj **children;
365 struct hwloc_obj *first_child;
366 struct hwloc_obj *last_child;
368 /* misc */
369 void *userdata;
374 /* cpusets and nodesets */
375 hwloc_cpuset_t cpuset;
388 hwloc_cpuset_t complete_cpuset;
399 hwloc_cpuset_t online_cpuset;
407 hwloc_cpuset_t allowed_cpuset;
418 hwloc_nodeset_t nodeset;
435 hwloc_nodeset_t complete_nodeset;
449 hwloc_nodeset_t allowed_nodeset;
462 struct hwloc_distances_s **distances;
463 unsigned distances_count;
464
465 struct hwloc_obj_info_s *infos;
466 unsigned infos_count;
468 int symmetric_subtree;
473 };
477 typedef struct hwloc_obj * hwloc_obj_t;
478
480 union hwloc_obj_attr_u {
482 struct hwloc_cache_attr_s {
483 hwloc_uint64_t size;
484 unsigned depth;
485 unsigned linesize;
486 int associativity;
488 hwloc_obj_cache_type_t type;
489 } cache;
491 struct hwloc_group_attr_s {
492 unsigned depth;
493 } group;
495 struct hwloc_pcidev_attr_s {
496 unsigned short domain;
497 unsigned char bus, dev, func;
498 unsigned short class_id;
499 unsigned short vendor_id, device_id, subvendor_id, subdevice_id;
500 unsigned char revision;
501 float linkspeed; /* in GB/s */
502 } pcidev;
504 struct hwloc_bridge_attr_s {
505 union {
506 struct hwloc_pcidev_attr_s pci;
507 } upstream;
508 hwloc_obj_bridge_type_t upstream_type;
509 union {
510 struct {
511 unsigned short domain;
512 unsigned char secondary_bus, subordinate_bus;
513 } pci;
514 } downstream;
515 hwloc_obj_bridge_type_t downstream_type;
516 unsigned depth;
517 } bridge;
519 struct hwloc_osdev_attr_s {
520 hwloc_obj_osdev_type_t type;
521 } osdev;
522 };
523
538 struct hwloc_distances_s {
539 unsigned relative_depth;
541 unsigned nbobjs;
546 float *latency;
551 float latency_max;
552 float latency_base;
556 };
557
559 struct hwloc_obj_info_s {
560 char *name;
561 char *value;
562 };
563
572 struct hwloc_topology;
577 typedef struct hwloc_topology * hwloc_topology_t;
578
585 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
586
604 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
605
610 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
611
623 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
624
659 HWLOC_DECLSPEC int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type);
660
669 HWLOC_DECLSPEC int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type);
670
678 HWLOC_DECLSPEC int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology);
679
685 enum hwloc_topology_flags_e {
693 HWLOC_TOPOLOGY_FLAG_WHOLE_SYSTEM = (1UL<<0),
694
713 HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM = (1UL<<1),
714
725 HWLOC_TOPOLOGY_FLAG_IO_DEVICES = (1UL<<2),
726
734 HWLOC_TOPOLOGY_FLAG_IO_BRIDGES = (1UL<<3),
735
743 HWLOC_TOPOLOGY_FLAG_WHOLE_IO = (1UL<<4),
744
751 HWLOC_TOPOLOGY_FLAG_ICACHES = (1UL<<5)
752 };
753
763 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
764
771 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
772
787 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
788
815 HWLOC_DECLSPEC int hwloc_topology_set_fsroot(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict fsroot_path);
816
844 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
845
872 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
873
900 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
901
921 HWLOC_DECLSPEC int hwloc_topology_set_custom(hwloc_topology_t topology);
922
940 HWLOC_DECLSPEC int hwloc_topology_set_distance_matrix(hwloc_topology_t __hwloc_restrict topology,
941 hwloc_obj_type_t type, unsigned nbobjs,
942 unsigned *os_index, float *distances);
943
951 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
952
954 struct hwloc_topology_discovery_support {
956 unsigned char pu;
957 };
958
960 struct hwloc_topology_cpubind_support {
962 unsigned char set_thisproc_cpubind;
964 unsigned char get_thisproc_cpubind;
966 unsigned char set_proc_cpubind;
968 unsigned char get_proc_cpubind;
970 unsigned char set_thisthread_cpubind;
972 unsigned char get_thisthread_cpubind;
974 unsigned char set_thread_cpubind;
976 unsigned char get_thread_cpubind;
978 unsigned char get_thisproc_last_cpu_location;
980 unsigned char get_proc_last_cpu_location;
982 unsigned char get_thisthread_last_cpu_location;
983 };
984
986 struct hwloc_topology_membind_support {
988 unsigned char set_thisproc_membind;
990 unsigned char get_thisproc_membind;
992 unsigned char set_proc_membind;
994 unsigned char get_proc_membind;
996 unsigned char set_thisthread_membind;
998 unsigned char get_thisthread_membind;
1000 unsigned char set_area_membind;
1002 unsigned char get_area_membind;
1004 unsigned char alloc_membind;
1006 unsigned char firsttouch_membind;
1008 unsigned char bind_membind;
1010 unsigned char interleave_membind;
1012 unsigned char replicate_membind;
1014 unsigned char nexttouch_membind;
1015
1017 unsigned char migrate_membind;
1018 };
1019
1026 struct hwloc_topology_support {
1027 struct hwloc_topology_discovery_support *discovery;
1028 struct hwloc_topology_cpubind_support *cpubind;
1029 struct hwloc_topology_membind_support *membind;
1030 };
1031
1033 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
1034
1052 HWLOC_DECLSPEC unsigned hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1053
1076 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
1077
1078 enum hwloc_get_type_depth_e {
1079 HWLOC_TYPE_DEPTH_UNKNOWN = -1,
1080 HWLOC_TYPE_DEPTH_MULTIPLE = -2,
1081 HWLOC_TYPE_DEPTH_BRIDGE = -3,
1082 HWLOC_TYPE_DEPTH_PCI_DEVICE = -4,
1083 HWLOC_TYPE_DEPTH_OS_DEVICE = -5
1084 };
1085
1095 static __hwloc_inline int
1096 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1097
1107 static __hwloc_inline int
1108 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1109
1114 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1115
1118 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1119
1125 static __hwloc_inline int
1126 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1127
1133 static __hwloc_inline hwloc_obj_t
1134 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
1135
1137 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, unsigned depth, unsigned idx) __hwloc_attribute_pure;
1138
1145 static __hwloc_inline hwloc_obj_t
1146 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
1147
1152 static __hwloc_inline hwloc_obj_t
1153 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev);
1154
1161 static __hwloc_inline hwloc_obj_t
1162 hwloc_get_next_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type,
1163 hwloc_obj_t prev);
1164
1174 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
1175
1202 HWLOC_DECLSPEC int hwloc_obj_type_sscanf(const char *string,
1203 hwloc_obj_type_t *typep,
1204 int *depthattrp,
1205 void *typeattrp, size_t typeattrsize);
1206
1217 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj,
1218 int verbose);
1219
1231 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj, const char * __hwloc_restrict separator,
1232 int verbose);
1233
1241 HWLOC_DECLSPEC int hwloc_obj_cpuset_snprintf(char * __hwloc_restrict str, size_t size, size_t nobj, const hwloc_obj_t * __hwloc_restrict objs);
1242
1249 static __hwloc_inline const char *
1250 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1251
1266 HWLOC_DECLSPEC void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1267
1325 typedef enum {
1328 HWLOC_CPUBIND_PROCESS = (1<<0),
1329
1332 HWLOC_CPUBIND_THREAD = (1<<1),
1333
1357 HWLOC_CPUBIND_STRICT = (1<<2),
1358
1374 HWLOC_CPUBIND_NOMEMBIND = (1<<3)
1375 } hwloc_cpubind_flags_t;
1376
1382 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1383
1389 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1390
1402 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1403
1415 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1416
1417 #ifdef hwloc_thread_t
1418
1425 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1426 #endif
1427
1428 #ifdef hwloc_thread_t
1429
1436 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1437 #endif
1438
1452 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1453
1470 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1471
1539 typedef enum {
1542 HWLOC_MEMBIND_DEFAULT = 0,
1543
1552 HWLOC_MEMBIND_FIRSTTOUCH = 1,
1553
1556 HWLOC_MEMBIND_BIND = 2,
1557
1565 HWLOC_MEMBIND_INTERLEAVE = 3,
1566
1578 HWLOC_MEMBIND_REPLICATE = 4,
1579
1585 HWLOC_MEMBIND_NEXTTOUCH = 5,
1586
1591 HWLOC_MEMBIND_MIXED = -1
1592 } hwloc_membind_policy_t;
1593
1605 typedef enum {
1610 HWLOC_MEMBIND_PROCESS = (1<<0),
1611
1615 HWLOC_MEMBIND_THREAD = (1<<1),
1616
1623 HWLOC_MEMBIND_STRICT = (1<<2),
1624
1629 HWLOC_MEMBIND_MIGRATE = (1<<3),
1630
1642 HWLOC_MEMBIND_NOCPUBIND = (1<<4)
1643 } hwloc_membind_flags_t;
1644
1657 HWLOC_DECLSPEC int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags);
1658
1672 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags);
1673
1714 HWLOC_DECLSPEC int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t * policy, int flags);
1715
1761 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_cpuset_t cpuset, hwloc_membind_policy_t * policy, int flags);
1762
1772 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);
1773
1783 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);
1784
1821 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);
1822
1862 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);
1863
1870 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);
1871
1878 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);
1879
1902 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);
1903
1928 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);
1929
1937 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
1938
1948 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;
1949
1959 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;
1960
1967 static __hwloc_inline void *
1968 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;
1969
1974 static __hwloc_inline void *
1975 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;
1976
1980 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
1981
2004 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, const char *name);
2005
2021 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2022
2024 enum hwloc_restrict_flags_e {
2029 HWLOC_RESTRICT_FLAG_ADAPT_DISTANCES = (1<<0),
2030
2035 HWLOC_RESTRICT_FLAG_ADAPT_MISC = (1<<1),
2036
2041 HWLOC_RESTRICT_FLAG_ADAPT_IO = (1<<2)
2042 };
2043
2065 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags);
2066
2074 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
2075
2109 HWLOC_DECLSPEC int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2110
2132 HWLOC_DECLSPEC hwloc_obj_t hwloc_custom_insert_group_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, int groupdepth);
2133
2157 HWLOC_DECLSPEC int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath);
2158
2175 HWLOC_DECLSPEC int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen);
2176
2178 HWLOC_DECLSPEC void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer);
2179
2196 HWLOC_DECLSPEC void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology,
2197 void (*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2198
2224 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);
2225
2239 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);
2240
2261 HWLOC_DECLSPEC void hwloc_topology_set_userdata_import_callback(hwloc_topology_t topology,
2262 void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length));
2263
2268 #ifdef __cplusplus
2269 } /* extern "C" */
2270 #endif
2271
2272
2273 /* high-level helpers */
2274 #include <hwloc/helper.h>
2275
2276 /* inline code of some functions above */
2277 #include <hwloc/inlines.h>
2278
2279 /* topology diffs */
2280 #include <hwloc/diff.h>
2281
2282 /* deprecated headers */
2283 #include <hwloc/deprecated.h>
2284
2285 #endif /* HWLOC_H */
hwloc_obj_attr_u::hwloc_pcidev_attr_s::class_id
unsigned short class_id
Definition: hwloc.h:498
hwloc_obj_attr_u::hwloc_osdev_attr_s::type
hwloc_obj_osdev_type_t type
Definition: hwloc.h:520
hwloc_topology_cpubind_support::get_thisproc_last_cpu_location
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:978
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:244
HWLOC_MEMBIND_NOCPUBIND
Avoid any effect on CPU binding.
Definition: hwloc.h:1642
HWLOC_TOPOLOGY_FLAG_WHOLE_IO
Detect the whole PCI hierarchy.
Definition: hwloc.h:743
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:751
hwloc_topology_membind_support::get_proc_membind
unsigned char get_proc_membind
Definition: hwloc.h:994
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:350
hwloc_obj::parent
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:357
hwloc_topology_membind_support::get_thisproc_membind
unsigned char get_thisproc_membind
Definition: hwloc.h:990
HWLOC_MEMBIND_REPLICATE
Replicate memory on the given nodes; reads from this memory will attempt to be serviced from the NUMA...
Definition: hwloc.h:1578
hwloc_obj_type_t
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:152
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:1325
hwloc_obj_attr_u::hwloc_cache_attr_s::linesize
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:485
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:252
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:321
HWLOC_TOPOLOGY_FLAG_IO_BRIDGES
Detect PCI bridges.
Definition: hwloc.h:734
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:133
hwloc_topology_membind_support::firsttouch_membind
unsigned char firsttouch_membind
Definition: hwloc.h:1006
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:323
hwloc_obj::arity
unsigned arity
Number of children.
Definition: hwloc.h:363
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:231
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:322
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:462
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:2035
hwloc_obj_attr_u::hwloc_bridge_attr_s::secondary_bus
unsigned char secondary_bus
Definition: hwloc.h:512
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:1010
HWLOC_CPUBIND_PROCESS
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1328
hwloc_obj_attr_u::hwloc_pcidev_attr_s
PCI Device specific Object Attributes.
Definition: hwloc.h:495
hwloc_obj_attr_u::hwloc_bridge_attr_s
Bridge specific Object Attribues.
Definition: hwloc.h:504
hwloc_topology_cpubind_support::get_thisthread_last_cpu_location
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:982
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:258
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:343
hwloc_topology_flags_e
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:685
hwloc_obj_attr_u::hwloc_pcidev_attr_s::subdevice_id
unsigned short subdevice_id
Definition: hwloc.h:499
HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:713
hwloc_topology_support::discovery
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1027
hwloc_obj_attr_u::hwloc_cache_attr_s::type
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:488
hwloc_obj::name
char * name
Object description if any.
Definition: hwloc.h:335
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:552
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_obj_attr_u::hwloc_group_attr_s
Group-specific Object Attributes.
Definition: hwloc.h:491
hwloc_obj_attr_u::hwloc_cache_attr_s::depth
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:484
hwloc_obj_attr_u::hwloc_pcidev_attr_s::vendor_id
unsigned short vendor_id
Definition: hwloc.h:499
hwloc_obj_attr_u::hwloc_bridge_attr_s::downstream_type
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:515
hwloc_topology_membind_support::get_area_membind
unsigned char get_area_membind
Definition: hwloc.h:1002
hwloc_compare_types_e
hwloc_compare_types_e
Definition: hwloc.h:295
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:2029
hwloc_topology_membind_support::set_area_membind
unsigned char set_area_membind
Definition: hwloc.h:1000
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:45
hwloc_obj_attr_u::hwloc_pcidev_attr_s::bus
unsigned char bus
Definition: hwloc.h:497
HWLOC_MEMBIND_FIRSTTOUCH
Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allo...
Definition: hwloc.h:1552
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:539
HWLOC_MEMBIND_DEFAULT
Reset the memory allocation policy to the system default.
Definition: hwloc.h:1542
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:516
hwloc_obj::infos
struct hwloc_obj_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:465
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:254
HWLOC_TYPE_DEPTH_BRIDGE
Virtual depth for bridge object level.
Definition: hwloc.h:1081
hwloc_obj_info_s::value
char * value
Info value.
Definition: hwloc.h:561
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:196
hwloc_obj_attr_u::hwloc_cache_attr_s::size
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:483
hwloc_topology_cpubind_support
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:960
hwloc_topology_cpubind_support::get_thisproc_cpubind
unsigned char get_thisproc_cpubind
Definition: hwloc.h:964
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:1556
hwloc_topology_cpubind_support::get_thread_cpubind
unsigned char get_thread_cpubind
Definition: hwloc.h:976
hwloc_obj_attr_u::hwloc_osdev_attr_s
OS Device specific Object Attributes.
Definition: hwloc.h:519
hwloc_obj_attr_u::hwloc_pcidev_attr_s::linkspeed
float linkspeed
Definition: hwloc.h:501
hwloc_obj::prev_sibling
struct hwloc_obj * prev_sibling
Previous object below the same parent.
Definition: hwloc.h:360
hwloc_obj::allowed_nodeset
hwloc_nodeset_t allowed_nodeset
The set of allowed NUMA memory nodes.
Definition: hwloc.h:449
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 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:315
HWLOC_OBJ_OSDEV_OPENFABRICS
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA device on Linux...
Definition: hwloc.h:266
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:497
hwloc_topology_discovery_support::pu
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:956
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:1012
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:541
HWLOC_TOPOLOGY_FLAG_IO_DEVICES
Detect PCI devices.
Definition: hwloc.h:725
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:1029
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:996
hwloc_topology_cpubind_support::get_proc_cpubind
unsigned char get_proc_cpubind
Definition: hwloc.h:968
hwloc_obj::last_child
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:366
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:1585
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:559
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:974
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:339
hwloc_obj::first_child
struct hwloc_obj * first_child
First child.
Definition: hwloc.h:365
hwloc_restrict_flags_e
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2024
hwloc_obj::cpuset
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:375
hwloc_obj_attr_u::hwloc_bridge_attr_s::upstream_type
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:508
hwloc_obj_attr_u::hwloc_pcidev_attr_s::dev
unsigned char dev
Definition: hwloc.h:497
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:172
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:546
HWLOC_CPUBIND_NOMEMBIND
Avoid any effect on memory binding.
Definition: hwloc.h:1374
HWLOC_OBJ_OSDEV_COPROC
Operating system co-processor device. For instance "mic0" for a Xeon Phi (MIC) on Linux...
Definition: hwloc.h:270
hwloc_obj_attr_u::hwloc_pcidev_attr_s::domain
unsigned short domain
Definition: hwloc.h:496
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:220
HWLOC_OBJ_SYSTEM
Whole system (may be a cluster of machines). The whole system that is accessible to hwloc...
Definition: hwloc.h:162
HWLOC_OBJ_PU
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:187
hwloc_obj_attr_u::hwloc_bridge_attr_s::subordinate_bus
unsigned char subordinate_bus
Definition: hwloc.h:512
HWLOC_OBJ_MACHINE
Machine. The typical root object type. A set of processors and memory with cache coherency.
Definition: hwloc.h:167
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:407
hwloc_obj_info_s::name
char * name
Info name.
Definition: hwloc.h:560
hwloc_topology_membind_support::set_proc_membind
unsigned char set_proc_membind
Definition: hwloc.h:992
HWLOC_TOPOLOGY_FLAG_WHOLE_SYSTEM
Detect the whole system, ignore reservations and offline settings.
Definition: hwloc.h:693
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:538
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:369
hwloc_topology_membind_support::bind_membind
unsigned char bind_membind
Definition: hwloc.h:1008
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:1078
HWLOC_MEMBIND_STRICT
Definition: hwloc.h:1623
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:1083
hwloc_topology_cpubind_support::get_proc_last_cpu_location
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:980
hwloc_topology_membind_support::nexttouch_membind
unsigned char nexttouch_membind
Definition: hwloc.h:1014
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:1017
HWLOC_TYPE_DEPTH_MULTIPLE
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1080
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:1539
HWLOC_MEMBIND_INTERLEAVE
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1565
hwloc_topology_membind_support::get_thisthread_membind
unsigned char get_thisthread_membind
Definition: hwloc.h:998
hwloc_obj_attr_u::group
struct hwloc_obj_attr_u::hwloc_group_attr_s group
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:966
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:245
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...
Definition: hwloc.h:348
hwloc_obj_attr_u
Object type-specific Attributes.
Definition: hwloc.h:480
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:246
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:261
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:1026
hwloc_obj::sibling_rank
unsigned sibling_rank
Index in parent's children[] array.
Definition: hwloc.h:358
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:954
hwloc_obj::nodeset
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:418
hwloc_obj_t
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:477
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:364
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:225
hwloc_obj_memory_s
Object memory.
Definition: hwloc.h:310
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:468
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:492
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:213
hwloc_topology_membind_support::set_thisproc_membind
unsigned char set_thisproc_membind
Definition: hwloc.h:988
HWLOC_MEMBIND_THREAD
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1615
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:253
hwloc_obj::next_sibling
struct hwloc_obj * next_sibling
Next object below the same parent.
Definition: hwloc.h:359
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:118
HWLOC_MEMBIND_PROCESS
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1610
hwloc_obj::next_cousin
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:353
hwloc_obj_attr_u::hwloc_pcidev_attr_s::subvendor_id
unsigned short subvendor_id
Definition: hwloc.h:499
hwloc_obj::infos_count
unsigned infos_count
Size of infos array.
Definition: hwloc.h:466
hwloc_obj::complete_cpuset
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:388
hwloc_const_nodeset_t
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:136
HWLOC_OBJ_SOCKET
Socket, physical package, or chip. In the physical meaning, i.e. that you can add or remove physicall...
Definition: hwloc.h:176
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:1357
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:2041
hwloc_obj_attr_u::hwloc_bridge_attr_s::domain
unsigned short domain
Definition: hwloc.h:511
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:259
hwloc_obj_attr_u::hwloc_cache_attr_s
Cache-specific Object Attributes.
Definition: hwloc.h:482
hwloc_obj::online_cpuset
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:399
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:1004
hwloc_obj_attr_u::hwloc_cache_attr_s::associativity
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:486
hwloc_topology_cpubind_support::set_thisthread_cpubind
unsigned char set_thisthread_cpubind
Definition: hwloc.h:970
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:506
hwloc_membind_flags_t
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1605
HWLOC_OBJ_OSDEV_NETWORK
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:264
hwloc_obj_attr_u::hwloc_pcidev_attr_s::revision
unsigned char revision
Definition: hwloc.h:500
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:1028
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:208
hwloc_obj::distances_count
unsigned distances_count
Definition: hwloc.h:463
hwloc_obj_memory_s::local_memory
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:312
hwloc_const_bitmap_t
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:47
HWLOC_TYPE_DEPTH_UNKNOWN
No object of given type exists in the topology.
Definition: hwloc.h:1079
hwloc_topology_membind_support
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:986
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:962
HWLOC_OBJ_CACHE
Cache. Can be L1i, L1d, L2, L3, ...
Definition: hwloc.h:180
HWLOC_OBJ_CACHE_INSTRUCTION
Instruction cache. Only used when the HWLOC_TOPOLOGY_FLAG_ICACHES topology flag is set...
Definition: hwloc.h:247
hwloc_obj::os_index
unsigned os_index
OS-provided physical index number.
Definition: hwloc.h:334
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:116
HWLOC_OBJ_OSDEV_DMA
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:268
hwloc_obj::memory
struct hwloc_obj_memory_s memory
Memory attributes.
Definition: hwloc.h:337
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:354
hwloc_obj::complete_nodeset
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:435
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_topology_t
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:577
HWLOC_OBJ_CORE
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:183
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:1629
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:1332
hwloc_topology_cpubind_support::get_thisthread_cpubind
unsigned char get_thisthread_cpubind
Definition: hwloc.h:972
HWLOC_TYPE_UNORDERED
Value returned by hwloc_compare_types when types can not be compared.
Definition: hwloc.h:296
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:499
HWLOC_MEMBIND_MIXED
Returned by hwloc_get_membind*() functions when multiple threads or parts of a memory area have diffe...
Definition: hwloc.h:1591
hwloc_obj::type
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:333
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:1082
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:551
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:331
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:311