Hardware Locality (hwloc)  1.11.8
hwloc.h
1 /*
2  * Copyright © 2009 CNRS
3  * Copyright © 2009-2017 Inria. All rights reserved.
4  * Copyright © 2009-2012 Université Bordeaux
5  * Copyright © 2009-2011 Cisco Systems, Inc. All rights reserved.
6  * See COPYING in top-level directory.
7  */
8 
9 /*=====================================================================
10  * PLEASE GO READ THE DOCUMENTATION!
11  * ------------------------------------------------
12  * $tarball_directory/doc/doxygen-doc/
13  * or
14  * http://www.open-mpi.org/projects/hwloc/doc/
15  *=====================================================================
16  *
17  * FAIR WARNING: Do NOT expect to be able to figure out all the
18  * subtleties of hwloc by simply reading function prototypes and
19  * constant descrptions here in this file.
20  *
21  * Hwloc has wonderful documentation in both PDF and HTML formats for
22  * your reading pleasure. The formal documentation explains a LOT of
23  * hwloc-specific concepts, provides definitions, and discusses the
24  * "big picture" for many of the things that you'll find here in this
25  * header file.
26  *
27  * The PDF/HTML documentation was generated via Doxygen; much of what
28  * you'll see in there is also here in this file. BUT THERE IS A LOT
29  * THAT IS IN THE PDF/HTML THAT IS ***NOT*** IN hwloc.h!
30  *
31  * There are entire paragraph-length descriptions, discussions, and
32  * pretty prictures to explain subtle corner cases, provide concrete
33  * examples, etc.
34  *
35  * Please, go read the documentation. :-)
36  *
37  * Moreover there are several examples of hwloc use under doc/examples
38  * in the source tree.
39  *
40  *=====================================================================*/
41 
50 #ifndef HWLOC_H
51 #define HWLOC_H
52 
53 #include <hwloc/autogen/config.h>
54 #include <sys/types.h>
55 #include <stdio.h>
56 #include <string.h>
57 #include <limits.h>
58 
59 /*
60  * Symbol transforms
61  */
62 #include <hwloc/rename.h>
63 
64 /*
65  * Bitmap definitions
66  */
67 
68 #include <hwloc/bitmap.h>
69 
70 
71 #ifdef __cplusplus
72 extern "C" {
73 #endif
74 
75 
88 #define HWLOC_API_VERSION 0x00010b00
89 
94 HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);
95 
97 #define HWLOC_COMPONENT_ABI 4
98 
135 
155 
170 typedef enum {
171  /* ***************************************************************
172  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
173 
174  If new enum values are added here, you MUST also go update the
175  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
176 
177  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
178  *************************************************************** */
179 
251  HWLOC_OBJ_TYPE_MAX
253  /* ***************************************************************
254  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
255 
256  If new enum values are added here, you MUST also go update the
257  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
258 
259  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
260  *************************************************************** */
262 
270 
276 
296 
314 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
315 
318 };
319 
328 union hwloc_obj_attr_u;
329 
332  hwloc_uint64_t total_memory;
333  hwloc_uint64_t local_memory;
336  unsigned page_types_len;
343  hwloc_uint64_t size;
344  hwloc_uint64_t count;
345  } * page_types;
346 };
347 
352 struct hwloc_obj {
353  /* physical information */
354  hwloc_obj_type_t type;
356  unsigned os_index;
360  char *name;
365  struct hwloc_obj_memory_s memory;
370  /* global position */
371  unsigned depth;
376  unsigned logical_index;
380  signed os_level;
382  /* cousins are all objects of the same type (and depth) across the entire topology */
386  /* children of the same parent are siblings, even if they may have different type and depth */
387  struct hwloc_obj *parent;
388  unsigned sibling_rank;
392  /* children array below this object */
393  unsigned arity;
394  struct hwloc_obj **children;
398  /* misc */
399  void *userdata;
404  /* cpusets and nodesets */
405  hwloc_cpuset_t cpuset;
418  hwloc_cpuset_t complete_cpuset;
429  hwloc_cpuset_t online_cpuset;
437  hwloc_cpuset_t allowed_cpuset;
448  hwloc_nodeset_t nodeset;
465  hwloc_nodeset_t complete_nodeset;
479  hwloc_nodeset_t allowed_nodeset;
493  unsigned distances_count;
494 
496  unsigned infos_count;
503 };
507 typedef struct hwloc_obj * hwloc_obj_t;
508 
513  hwloc_uint64_t size;
514  unsigned depth;
515  unsigned linesize;
518  hwloc_obj_cache_type_t type;
519  } cache;
522  unsigned depth;
523  } group;
526  unsigned short domain;
527  unsigned char bus, dev, func;
528  unsigned short class_id;
529  unsigned short vendor_id, device_id, subvendor_id, subdevice_id;
530  unsigned char revision;
531  float linkspeed; /* in GB/s */
532  } pcidev;
535  union {
537  } upstream;
538  hwloc_obj_bridge_type_t upstream_type;
539  union {
540  struct {
541  unsigned short domain;
542  unsigned char secondary_bus, subordinate_bus;
543  } pci;
544  } downstream;
545  hwloc_obj_bridge_type_t downstream_type;
546  unsigned depth;
547  } bridge;
550  hwloc_obj_osdev_type_t type;
551  } osdev;
552 };
553 
568  unsigned relative_depth;
570  unsigned nbobjs;
575  float *latency;
587  float latency_max;
588  float latency_base;
592 };
593 
599  char *name;
600  char *value;
601 };
602 
611 struct hwloc_topology;
616 typedef struct hwloc_topology * hwloc_topology_t;
617 
624 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
625 
646 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
647 
652 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
653 
664 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
665 
677 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
678 
715 HWLOC_DECLSPEC int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type);
716 
725 HWLOC_DECLSPEC int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type);
726 
733 HWLOC_DECLSPEC int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology);
734 
757 
777 
790 
799 
809 
817 
838 };
839 
849 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
850 
857 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
858 
873 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
874 
901 HWLOC_DECLSPEC int hwloc_topology_set_fsroot(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict fsroot_path);
902 
930 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
931 
958 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
959 
986 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
987 
1007 HWLOC_DECLSPEC int hwloc_topology_set_custom(hwloc_topology_t topology);
1008 
1027 HWLOC_DECLSPEC int hwloc_topology_set_distance_matrix(hwloc_topology_t __hwloc_restrict topology,
1028  hwloc_obj_type_t type, unsigned nbobjs,
1029  unsigned *os_index, float *distances);
1030 
1038 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1039 
1043  unsigned char pu;
1044 };
1045 
1053  unsigned char set_thisproc_cpubind;
1055  unsigned char get_thisproc_cpubind;
1057  unsigned char set_proc_cpubind;
1059  unsigned char get_proc_cpubind;
1061  unsigned char set_thisthread_cpubind;
1063  unsigned char get_thisthread_cpubind;
1065  unsigned char set_thread_cpubind;
1067  unsigned char get_thread_cpubind;
1074 };
1075 
1083  unsigned char set_thisproc_membind;
1085  unsigned char get_thisproc_membind;
1087  unsigned char set_proc_membind;
1089  unsigned char get_proc_membind;
1091  unsigned char set_thisthread_membind;
1093  unsigned char get_thisthread_membind;
1095  unsigned char set_area_membind;
1097  unsigned char get_area_membind;
1099  unsigned char alloc_membind;
1101  unsigned char firsttouch_membind;
1103  unsigned char bind_membind;
1105  unsigned char interleave_membind;
1107  unsigned char replicate_membind;
1109  unsigned char nexttouch_membind;
1111  unsigned char migrate_membind;
1113  unsigned char get_area_memlocation;
1114 };
1115 
1126 };
1127 
1137 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
1138 
1149 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
1150 
1156 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
1157 
1178 HWLOC_DECLSPEC unsigned hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1179 
1204 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
1205 
1212 };
1213 
1223 static __hwloc_inline int
1224 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1225 
1235 static __hwloc_inline int
1236 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1237 
1244 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1245 
1248 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1249 
1255 static __hwloc_inline int
1256 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1257 
1263 static __hwloc_inline hwloc_obj_t
1264 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
1265 
1267 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, unsigned depth, unsigned idx) __hwloc_attribute_pure;
1268 
1275 static __hwloc_inline hwloc_obj_t
1276 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
1277 
1282 static __hwloc_inline hwloc_obj_t
1283 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev);
1284 
1291 static __hwloc_inline hwloc_obj_t
1292 hwloc_get_next_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type,
1293  hwloc_obj_t prev);
1294 
1310 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
1311 
1325 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj,
1326  int verbose);
1327 
1339 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj, const char * __hwloc_restrict separator,
1340  int verbose);
1341 
1349 HWLOC_DECLSPEC int hwloc_obj_cpuset_snprintf(char * __hwloc_restrict str, size_t size, size_t nobj, const hwloc_obj_t * __hwloc_restrict objs);
1350 
1380 HWLOC_DECLSPEC int hwloc_obj_type_sscanf(const char *string,
1381  hwloc_obj_type_t *typep,
1382  int *depthattrp,
1383  void *typeattrp, size_t typeattrsize);
1384 
1400 static __hwloc_inline const char *
1401 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1402 
1417 HWLOC_DECLSPEC void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1418 
1487 typedef enum {
1491 
1495 
1520 
1538 
1544 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1545 
1551 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1552 
1564 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1565 
1577 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1578 
1579 #ifdef hwloc_thread_t
1580 
1587 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1588 #endif
1589 
1590 #ifdef hwloc_thread_t
1591 
1598 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1599 #endif
1600 
1614 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1615 
1632 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1633 
1715 typedef enum {
1726 
1736 
1740 
1749 
1762 
1769 
1776 
1790 typedef enum {
1796 
1801 
1809 
1815 
1828 
1840 
1853 HWLOC_DECLSPEC int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags);
1854 
1870 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
1871 
1913 HWLOC_DECLSPEC int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t * policy, int flags);
1914 
1959 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
1960 
1970 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);
1971 
1984 HWLOC_DECLSPEC int hwloc_set_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
1985 
2022 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);
2023 
2063 HWLOC_DECLSPEC int hwloc_get_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
2064 
2072 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);
2073 
2084 HWLOC_DECLSPEC int hwloc_set_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
2085 
2110 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);
2111 
2139 HWLOC_DECLSPEC int hwloc_get_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
2140 
2162 HWLOC_DECLSPEC int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags);
2163 
2171 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
2172 
2184 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;
2185 
2200 HWLOC_DECLSPEC void *hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags) __hwloc_attribute_malloc;
2201 
2208 static __hwloc_inline void *
2209 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;
2210 
2220 static __hwloc_inline void *
2221 hwloc_alloc_membind_policy(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags) __hwloc_attribute_malloc;
2222 
2226 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
2227 
2250 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, const char *name);
2251 
2267 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2268 
2276 
2282 
2288 };
2289 
2311 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags);
2312 
2346 HWLOC_DECLSPEC int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2347 
2369 HWLOC_DECLSPEC hwloc_obj_t hwloc_custom_insert_group_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, int groupdepth);
2370 
2396 HWLOC_DECLSPEC int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath);
2397 
2416 HWLOC_DECLSPEC int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen);
2417 
2419 HWLOC_DECLSPEC void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer);
2420 
2439 HWLOC_DECLSPEC void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology,
2440  void (*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2441 
2467 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);
2468 
2482 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);
2483 
2506 HWLOC_DECLSPEC void hwloc_topology_set_userdata_import_callback(hwloc_topology_t topology,
2507  void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length));
2508 
2527 
2535 };
2536 
2555  HWLOC_DECLSPEC int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags);
2556 
2561 #ifdef __cplusplus
2562 } /* extern "C" */
2563 #endif
2564 
2565 
2566 /* high-level helpers */
2567 #include <hwloc/helper.h>
2568 
2569 /* inline code of some functions above */
2570 #include <hwloc/inlines.h>
2571 
2572 /* topology diffs */
2573 #include <hwloc/diff.h>
2574 
2575 /* deprecated headers */
2576 #include <hwloc/deprecated.h>
2577 
2578 #endif /* HWLOC_H */
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.
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:383
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:344
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:154
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.
Cache-specific Object Attributes.
Definition: hwloc.h:512
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:545
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.
Replicate memory on the given nodes; reads from this memory will attempt to be serviced from the NUMA...
Definition: hwloc.h:1761
Export extended types such as L2dcache as basic types such as Cache.
Definition: hwloc.h:2526
Avoid any effect on CPU binding.
Definition: hwloc.h:1827
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:201
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:53
int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath)
Export the topology into an XML file.
unsigned short class_id
Definition: hwloc.h:528
Request for strict binding from the OS.
Definition: hwloc.h:1519
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:333
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1487
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:170
unsigned char get_thisthread_membind
Definition: hwloc.h:1093
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:278
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:538
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:1051
int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags)
Bind a thread thread on cpus given in physical bitmap set.
unsigned char set_area_membind
Definition: hwloc.h:1095
float linkspeed
Definition: hwloc.h:531
unsigned char get_proc_membind
Definition: hwloc.h:1089
unsigned short domain
Definition: hwloc.h:526
NUMA node. A set of processors around memory which the processors can directly access.
Definition: hwloc.h:190
int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
Distances between objects.
Definition: hwloc.h:567
Reset the memory allocation policy to the system default. Depending on the operating system...
Definition: hwloc.h:1725
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1795
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.
unsigned char alloc_membind
Definition: hwloc.h:1099
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_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1790
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
unsigned char set_thread_cpubind
Definition: hwloc.h:1065
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:132
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
unsigned short domain
Definition: hwloc.h:541
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.
unsigned hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1748
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:740
hwloc_topology_export_synthetic_flags_e
Flags for exporting synthetic topologies.
Definition: hwloc.h:2520
unsigned char interleave_membind
Definition: hwloc.h:1105
Adapt distance matrices according to objects being removed during restriction. If this flag is not se...
Definition: hwloc.h:2275
float * latency
Matrix of latencies between objects, stored as a one-dimension array. May be NULL if the distances co...
Definition: hwloc.h:575
int hwloc_get_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, hwloc_membind_policy_t *policy, int flags)
Query the CPUs near the physical NUMA node(s) and binding policy of the memory identified by (addr...
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:1124
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:513
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1814
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:336
unsigned char firsttouch_membind
Definition: hwloc.h:1101
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1125
Set of flags describing actual support for this topology.
Definition: hwloc.h:1122
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:284
int hwloc_get_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_bitmap_t set, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the specified process.
Machine. The typical root object type. A set of processors and memory with cache coherency.
Definition: hwloc.h:185
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:429
Flags describing actual discovery support for this topology.
Definition: hwloc.h:1041
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:396
Detect instruction caches.
Definition: hwloc.h:816
unsigned char set_thisproc_cpubind
Definition: hwloc.h:1053
int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology)
Ignore all objects that do not bring any structure.
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.
int hwloc_get_membind(hwloc_topology_t topology, hwloc_bitmap_t set, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the current process or thread...
unsigned char get_thisthread_cpubind
Definition: hwloc.h:1063
unsigned char set_thisthread_membind
Definition: hwloc.h:1091
unsigned char set_thisthread_cpubind
Definition: hwloc.h:1061
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 NUMA memory nodes specified by nodeset.
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1123
int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the current process or thread to prefer the NUMA node(s) spe...
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:776
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.
unsigned char replicate_membind
Definition: hwloc.h:1107
Detect the whole PCI hierarchy.
Definition: hwloc.h:808
unsigned char subordinate_bus
Definition: hwloc.h:542
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:360
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:437
Detect PCI devices.
Definition: hwloc.h:789
struct hwloc_obj_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:495
struct hwloc_distances_s ** distances
Distances between all objects at same depth below this object.
Definition: hwloc.h:492
unsigned char get_proc_cpubind
Definition: hwloc.h:1059
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen)
Export the topology into a newly-allocated XML memory buffer.
struct hwloc_obj * first_child
First child.
Definition: hwloc.h:395
Unified cache.
Definition: hwloc.h:265
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 NUMA memory nodes specified by nodeset.
struct hwloc_obj * prev_sibling
Previous object below the same parent.
Definition: hwloc.h:390
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:514
Physical package, what goes into a socket. In the physical meaning, i.e. that you can add or remove p...
Definition: hwloc.h:194
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.
char * value
Info value.
Definition: hwloc.h:600
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:1069
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())...
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.
int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot)
Insert an existing topology inside a custom topology.
struct hwloc_obj_memory_s::hwloc_obj_memory_page_type_s * page_types
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:515
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:151
unsigned depth
Vertical index in the hierarchy. If the topology is symmetric, this is equal to the parent depth plus...
Definition: hwloc.h:371
Bind current thread of current process.
Definition: hwloc.h:1494
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA, or "hfi1_0" Omni-Path ...
Definition: hwloc.h:286
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:418
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:264
void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer)
Free a buffer allocated by hwloc_topology_export_xmlbuffer()
Avoid any effect on memory binding.
Definition: hwloc.h:1536
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.
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:367
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:134
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
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_get_type_depth_e
Definition: hwloc.h:1206
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1490
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.
Do not export level attributes.
Definition: hwloc.h:2534
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:214
unsigned char set_proc_cpubind
Definition: hwloc.h:1057
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a constant stringified object type.
int hwloc_obj_type_sscanf(const char *string, hwloc_obj_type_t *typep, int *depthattrp, void *typeattrp, size_t typeattrsize)
Return an object type and attributes from a type string.
int hwloc_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...
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:1768
Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allo...
Definition: hwloc.h:1735
unsigned short vendor_id
Definition: hwloc.h:529
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
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_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.
Operating system co-processor device. For instance "mic0" for a Xeon Phi (MIC) on Linux...
Definition: hwloc.h:291
Data cache.
Definition: hwloc.h:266
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:518
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, unsigned depth)
Returns the width of level at depth depth.
unsigned char bind_membind
Definition: hwloc.h:1103
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:342
int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags)
Get the NUMA nodes where memory identified by (addr, len ) is physically allocated.
unsigned char revision
Definition: hwloc.h:530
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:516
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
Get the set of allowed resources from the local operating system even if the topology was loaded from...
Definition: hwloc.h:837
Allocate memory on the specified nodes.
Definition: hwloc.h:1739
hwloc_obj_osdev_type_t type
Definition: hwloc.h:550
unsigned relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:568
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) specified by nodeset...
struct hwloc_obj * next_sibling
Next object below the same parent.
Definition: hwloc.h:389
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:1043
unsigned depth
Definition: hwloc.h:546
unsigned nbobjs
Number of objects considered in the matrix. It is the number of descendant objects at relative_depth ...
Definition: hwloc.h:570
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:272
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
float latency_base
The multiplier that should be applied to latency matrix to retrieve the original OS-provided latencie...
Definition: hwloc.h:588
static void * hwloc_alloc_membind_policy(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by set.
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2287
void * hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by set.
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:273
PCI Device specific Object Attributes.
Definition: hwloc.h:525
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
int hwloc_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.
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.
int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags)
Export the topology as a synthetic string.
Object type-specific Attributes.
Definition: hwloc.h:510
Virtual depth for bridge object level.
Definition: hwloc.h:1209
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_obj_type_t type
Type of object.
Definition: hwloc.h:354
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1800
Instruction cache. Only used when the HWLOC_TOPOLOGY_FLAG_ICACHES topology flag is set...
Definition: hwloc.h:267
unsigned char set_thisproc_membind
Definition: hwloc.h:1083
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.
unsigned char func
Definition: hwloc.h:527
unsigned char get_thisproc_cpubind
Definition: hwloc.h:1055
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:616
Operating system block device. For instance "sda" on Linux.
Definition: hwloc.h:279
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:465
char * name
Info name.
Definition: hwloc.h:599
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_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:448
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.
unsigned char get_thisproc_membind
Definition: hwloc.h:1085
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.
unsigned os_index
OS-provided physical index number. It is not guaranteed unique across the entire machine, except for PUs and NUMA nodes.
Definition: hwloc.h:356
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:51
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2281
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.
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.
unsigned char get_area_memlocation
Definition: hwloc.h:1113
unsigned char migrate_membind
Definition: hwloc.h:1111
OS Device specific Object Attributes.
Definition: hwloc.h:549
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:376
hwloc_obj_t hwloc_custom_insert_group_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, int groupdepth)
Insert a new group object inside a custom topology.
int hwloc_free(hwloc_topology_t topology, void *addr, size_t len)
Free memory that was previously allocated by hwloc_alloc() or hwloc_alloc_membind().
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:384
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.
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
int hwloc_set_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the specified process to prefer the NUMA node(s) specified b...
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_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:405
Virtual depth for software device object level.
Definition: hwloc.h:1211
unsigned char nexttouch_membind
Definition: hwloc.h:1109
Cache. Can be L1i, L1d, L2, L3, ...
Definition: hwloc.h:198
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_nodeset_t allowed_nodeset
The set of allowed NUMA memory nodes.
Definition: hwloc.h:479
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, unsigned depth)
Returns the type of objects at depth depth.
unsigned arity
Number of children.
Definition: hwloc.h:393
Bridge. Any bridge that connects the host or an I/O bus, to another I/O bus. Bridge objects have neit...
Definition: hwloc.h:233
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.
Definition: hwloc.h:1808
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:394
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:1081
hwloc_uint64_t total_memory
Total memory (in bytes) in this object and its children.
Definition: hwloc.h:332
Object memory.
Definition: hwloc.h:331
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2270
PCI-side of a bridge.
Definition: hwloc.h:274
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:343
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...
Object info.
Definition: hwloc.h:598
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1208
unsigned char get_area_membind
Definition: hwloc.h:1097
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
signed os_level
OS-provided physical level, -1 if unknown or meaningless.
Definition: hwloc.h:380
hwloc_compare_types_e
Definition: hwloc.h:316
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR&#39;ed flags of a topology.
Miscellaneous objects. Objects without particular meaning, that can e.g. be added by the application ...
Definition: hwloc.h:227
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.
unsigned distances_count
Definition: hwloc.h:493
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.
No object of given type exists in the topology.
Definition: hwloc.h:1207
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:205
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1774
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which process the topology is viewed from.
Value returned by hwloc_compare_types() when types can not be compared.
Definition: hwloc.h:317
Group-specific Object Attributes.
Definition: hwloc.h:521
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:507
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1715
Detect PCI bridges.
Definition: hwloc.h:798
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:289
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
Structure of a topology object.
Definition: hwloc.h:352
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:1073
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:387
Detect the whole system, ignore reservations and offline settings.
Definition: hwloc.h:756
int hwloc_topology_set_custom(hwloc_topology_t topology)
Prepare the topology for custom assembly.
int symmetric_subtree
Set if the subtree of objects below this object is symmetric, which means all children and their chil...
Definition: hwloc.h:498
unsigned char get_thread_cpubind
Definition: hwloc.h:1067
unsigned char set_proc_membind
Definition: hwloc.h:1087
int hwloc_set_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) specified by set...
Whole system (may be a cluster of machines). The whole system that is accessible to hwloc...
Definition: hwloc.h:180
unsigned sibling_rank
Index in parent&#39;s children[] array.
Definition: hwloc.h:388
Operating system device. These objects have neither CPU sets nor node sets. They are not added to the...
Definition: hwloc.h:245
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:399
unsigned infos_count
Size of infos array.
Definition: hwloc.h:496
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:281
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:240
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR&#39;ed flags to non-yet-loaded topology.
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:1071
int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type.
Virtual depth for PCI device object level.
Definition: hwloc.h:1210
Bridge specific Object Attribues.
Definition: hwloc.h:534
Consider the bitmap argument as a nodeset.
Definition: hwloc.h:1838
float latency_max
The maximal value in the latency matrix.
Definition: hwloc.h:587
unsigned depth
Depth of group object.
Definition: hwloc.h:522