Hardware Locality (hwloc)  1.11.6
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 
81 #define HWLOC_API_VERSION 0x00010b00
82 
87 HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);
88 
90 #define HWLOC_COMPONENT_ABI 4
91 
128 
148 
163 typedef enum {
164  /* ***************************************************************
165  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
166 
167  If new enum values are added here, you MUST also go update the
168  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
169 
170  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
171  *************************************************************** */
172 
244  HWLOC_OBJ_TYPE_MAX
246  /* ***************************************************************
247  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
248 
249  If new enum values are added here, you MUST also go update the
250  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
251 
252  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
253  *************************************************************** */
255 
263 
269 
289 
307 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
308 
311 };
312 
321 union hwloc_obj_attr_u;
322 
325  hwloc_uint64_t total_memory;
326  hwloc_uint64_t local_memory;
329  unsigned page_types_len;
336  hwloc_uint64_t size;
337  hwloc_uint64_t count;
338  } * page_types;
339 };
340 
345 struct hwloc_obj {
346  /* physical information */
347  hwloc_obj_type_t type;
349  unsigned os_index;
353  char *name;
358  struct hwloc_obj_memory_s memory;
363  /* global position */
364  unsigned depth;
369  unsigned logical_index;
373  signed os_level;
375  /* cousins are all objects of the same type (and depth) across the entire topology */
379  /* children of the same parent are siblings, even if they may have different type and depth */
380  struct hwloc_obj *parent;
381  unsigned sibling_rank;
385  /* children array below this object */
386  unsigned arity;
387  struct hwloc_obj **children;
391  /* misc */
392  void *userdata;
397  /* cpusets and nodesets */
398  hwloc_cpuset_t cpuset;
411  hwloc_cpuset_t complete_cpuset;
422  hwloc_cpuset_t online_cpuset;
430  hwloc_cpuset_t allowed_cpuset;
441  hwloc_nodeset_t nodeset;
458  hwloc_nodeset_t complete_nodeset;
472  hwloc_nodeset_t allowed_nodeset;
486  unsigned distances_count;
487 
489  unsigned infos_count;
496 };
500 typedef struct hwloc_obj * hwloc_obj_t;
501 
506  hwloc_uint64_t size;
507  unsigned depth;
508  unsigned linesize;
511  hwloc_obj_cache_type_t type;
512  } cache;
515  unsigned depth;
516  } group;
519  unsigned short domain;
520  unsigned char bus, dev, func;
521  unsigned short class_id;
522  unsigned short vendor_id, device_id, subvendor_id, subdevice_id;
523  unsigned char revision;
524  float linkspeed; /* in GB/s */
525  } pcidev;
528  union {
530  } upstream;
531  hwloc_obj_bridge_type_t upstream_type;
532  union {
533  struct {
534  unsigned short domain;
535  unsigned char secondary_bus, subordinate_bus;
536  } pci;
537  } downstream;
538  hwloc_obj_bridge_type_t downstream_type;
539  unsigned depth;
540  } bridge;
543  hwloc_obj_osdev_type_t type;
544  } osdev;
545 };
546 
561  unsigned relative_depth;
563  unsigned nbobjs;
568  float *latency;
580  float latency_max;
581  float latency_base;
585 };
586 
592  char *name;
593  char *value;
594 };
595 
604 struct hwloc_topology;
609 typedef struct hwloc_topology * hwloc_topology_t;
610 
617 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
618 
639 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
640 
645 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
646 
657 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
658 
670 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
671 
708 HWLOC_DECLSPEC int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type);
709 
718 HWLOC_DECLSPEC int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type);
719 
726 HWLOC_DECLSPEC int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology);
727 
750 
770 
783 
792 
802 
810 
831 };
832 
842 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
843 
850 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
851 
866 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
867 
894 HWLOC_DECLSPEC int hwloc_topology_set_fsroot(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict fsroot_path);
895 
923 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
924 
951 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
952 
979 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
980 
1000 HWLOC_DECLSPEC int hwloc_topology_set_custom(hwloc_topology_t topology);
1001 
1020 HWLOC_DECLSPEC int hwloc_topology_set_distance_matrix(hwloc_topology_t __hwloc_restrict topology,
1021  hwloc_obj_type_t type, unsigned nbobjs,
1022  unsigned *os_index, float *distances);
1023 
1031 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1032 
1036  unsigned char pu;
1037 };
1038 
1046  unsigned char set_thisproc_cpubind;
1048  unsigned char get_thisproc_cpubind;
1050  unsigned char set_proc_cpubind;
1052  unsigned char get_proc_cpubind;
1054  unsigned char set_thisthread_cpubind;
1056  unsigned char get_thisthread_cpubind;
1058  unsigned char set_thread_cpubind;
1060  unsigned char get_thread_cpubind;
1067 };
1068 
1076  unsigned char set_thisproc_membind;
1078  unsigned char get_thisproc_membind;
1080  unsigned char set_proc_membind;
1082  unsigned char get_proc_membind;
1084  unsigned char set_thisthread_membind;
1086  unsigned char get_thisthread_membind;
1088  unsigned char set_area_membind;
1090  unsigned char get_area_membind;
1092  unsigned char alloc_membind;
1094  unsigned char firsttouch_membind;
1096  unsigned char bind_membind;
1098  unsigned char interleave_membind;
1100  unsigned char replicate_membind;
1102  unsigned char nexttouch_membind;
1104  unsigned char migrate_membind;
1106  unsigned char get_area_memlocation;
1107 };
1108 
1119 };
1120 
1130 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
1131 
1142 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
1143 
1149 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
1150 
1171 HWLOC_DECLSPEC unsigned hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1172 
1197 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
1198 
1205 };
1206 
1216 static __hwloc_inline int
1217 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1218 
1228 static __hwloc_inline int
1229 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1230 
1237 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1238 
1241 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1242 
1248 static __hwloc_inline int
1249 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1250 
1256 static __hwloc_inline hwloc_obj_t
1257 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
1258 
1260 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, unsigned depth, unsigned idx) __hwloc_attribute_pure;
1261 
1268 static __hwloc_inline hwloc_obj_t
1269 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
1270 
1275 static __hwloc_inline hwloc_obj_t
1276 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev);
1277 
1284 static __hwloc_inline hwloc_obj_t
1285 hwloc_get_next_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type,
1286  hwloc_obj_t prev);
1287 
1303 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
1304 
1318 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj,
1319  int verbose);
1320 
1332 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj, const char * __hwloc_restrict separator,
1333  int verbose);
1334 
1342 HWLOC_DECLSPEC int hwloc_obj_cpuset_snprintf(char * __hwloc_restrict str, size_t size, size_t nobj, const hwloc_obj_t * __hwloc_restrict objs);
1343 
1373 HWLOC_DECLSPEC int hwloc_obj_type_sscanf(const char *string,
1374  hwloc_obj_type_t *typep,
1375  int *depthattrp,
1376  void *typeattrp, size_t typeattrsize);
1377 
1393 static __hwloc_inline const char *
1394 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1395 
1410 HWLOC_DECLSPEC void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1411 
1480 typedef enum {
1484 
1488 
1513 
1531 
1537 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1538 
1544 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1545 
1557 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1558 
1570 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1571 
1572 #ifdef hwloc_thread_t
1573 
1580 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1581 #endif
1582 
1583 #ifdef hwloc_thread_t
1584 
1591 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1592 #endif
1593 
1607 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1608 
1625 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1626 
1708 typedef enum {
1719 
1729 
1733 
1742 
1755 
1762 
1769 
1783 typedef enum {
1789 
1794 
1802 
1808 
1821 
1833 
1846 HWLOC_DECLSPEC int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags);
1847 
1863 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
1864 
1906 HWLOC_DECLSPEC int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t * policy, int flags);
1907 
1952 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
1953 
1963 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);
1964 
1977 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);
1978 
2015 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);
2016 
2056 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);
2057 
2065 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);
2066 
2077 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);
2078 
2103 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);
2104 
2132 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);
2133 
2155 HWLOC_DECLSPEC int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags);
2156 
2164 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
2165 
2177 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;
2178 
2193 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;
2194 
2201 static __hwloc_inline void *
2202 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;
2203 
2213 static __hwloc_inline void *
2214 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;
2215 
2219 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
2220 
2243 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, const char *name);
2244 
2260 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2261 
2269 
2275 
2281 };
2282 
2304 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags);
2305 
2339 HWLOC_DECLSPEC int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2340 
2362 HWLOC_DECLSPEC hwloc_obj_t hwloc_custom_insert_group_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, int groupdepth);
2363 
2389 HWLOC_DECLSPEC int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath);
2390 
2409 HWLOC_DECLSPEC int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen);
2410 
2412 HWLOC_DECLSPEC void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer);
2413 
2432 HWLOC_DECLSPEC void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology,
2433  void (*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2434 
2460 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);
2461 
2475 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);
2476 
2499 HWLOC_DECLSPEC void hwloc_topology_set_userdata_import_callback(hwloc_topology_t topology,
2500  void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length));
2501 
2520 
2528 };
2529 
2548  HWLOC_DECLSPEC int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags);
2549 
2554 #ifdef __cplusplus
2555 } /* extern "C" */
2556 #endif
2557 
2558 
2559 /* high-level helpers */
2560 #include <hwloc/helper.h>
2561 
2562 /* inline code of some functions above */
2563 #include <hwloc/inlines.h>
2564 
2565 /* topology diffs */
2566 #include <hwloc/diff.h>
2567 
2568 /* deprecated headers */
2569 #include <hwloc/deprecated.h>
2570 
2571 #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:376
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:337
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:147
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:505
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:538
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:1754
Export extended types such as L2dcache as basic types such as Cache.
Definition: hwloc.h:2519
Avoid any effect on CPU binding.
Definition: hwloc.h:1820
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:194
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:521
Request for strict binding from the OS.
Definition: hwloc.h:1512
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:326
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:1480
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:163
unsigned char get_thisthread_membind
Definition: hwloc.h:1086
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:271
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:531
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:1044
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:1088
float linkspeed
Definition: hwloc.h:524
unsigned char get_proc_membind
Definition: hwloc.h:1082
unsigned short domain
Definition: hwloc.h:519
NUMA node. A set of processors around memory which the processors can directly access.
Definition: hwloc.h:183
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:560
Reset the memory allocation policy to the system default. Depending on the operating system...
Definition: hwloc.h:1718
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1788
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:1092
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:1783
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
unsigned char set_thread_cpubind
Definition: hwloc.h:1058
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:125
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
unsigned short domain
Definition: hwloc.h:534
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:1741
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:733
hwloc_topology_export_synthetic_flags_e
Flags for exporting synthetic topologies.
Definition: hwloc.h:2513
unsigned char interleave_membind
Definition: hwloc.h:1098
Adapt distance matrices according to objects being removed during restriction. If this flag is not se...
Definition: hwloc.h:2268
float * latency
Matrix of latencies between objects, stored as a one-dimension array. May be NULL if the distances co...
Definition: hwloc.h:568
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:1117
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:506
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:1807
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:329
unsigned char firsttouch_membind
Definition: hwloc.h:1094
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1118
Set of flags describing actual support for this topology.
Definition: hwloc.h:1115
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:277
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:178
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:422
Flags describing actual discovery support for this topology.
Definition: hwloc.h:1034
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:389
Detect instruction caches.
Definition: hwloc.h:809
unsigned char set_thisproc_cpubind
Definition: hwloc.h:1046
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:1056
unsigned char set_thisthread_membind
Definition: hwloc.h:1084
unsigned char set_thisthread_cpubind
Definition: hwloc.h:1054
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:1116
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:769
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:1100
Detect the whole PCI hierarchy.
Definition: hwloc.h:801
unsigned char subordinate_bus
Definition: hwloc.h:535
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:353
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:430
Detect PCI devices.
Definition: hwloc.h:782
struct hwloc_obj_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:488
struct hwloc_distances_s ** distances
Distances between all objects at same depth below this object.
Definition: hwloc.h:485
unsigned char get_proc_cpubind
Definition: hwloc.h:1052
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:388
Unified cache.
Definition: hwloc.h:258
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:383
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:507
Physical package, what goes into a socket. In the physical meaning, i.e. that you can add or remove p...
Definition: hwloc.h:187
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:593
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:1062
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:508
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:144
unsigned depth
Vertical index in the hierarchy. If the topology is symmetric, this is equal to the parent depth plus...
Definition: hwloc.h:364
Bind current thread of current process.
Definition: hwloc.h:1487
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA, or "hfi1_0" Omni-Path ...
Definition: hwloc.h:279
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:411
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:257
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:1529
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:360
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:127
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:1199
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:1483
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:2527
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:207
unsigned char set_proc_cpubind
Definition: hwloc.h:1050
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:1761
Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allo...
Definition: hwloc.h:1728
unsigned short vendor_id
Definition: hwloc.h:522
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:284
Data cache.
Definition: hwloc.h:259
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:511
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:1096
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:335
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:523
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:509
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:830
Allocate memory on the specified nodes.
Definition: hwloc.h:1732
hwloc_obj_osdev_type_t type
Definition: hwloc.h:543
unsigned relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:561
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:382
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:1036
unsigned depth
Definition: hwloc.h:539
unsigned nbobjs
Number of objects considered in the matrix. It is the number of descendant objects at relative_depth ...
Definition: hwloc.h:563
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:265
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:581
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:2280
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:266
PCI Device specific Object Attributes.
Definition: hwloc.h:518
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:503
Virtual depth for bridge object level.
Definition: hwloc.h:1202
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:347
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:1793
Instruction cache. Only used when the HWLOC_TOPOLOGY_FLAG_ICACHES topology flag is set...
Definition: hwloc.h:260
unsigned char set_thisproc_membind
Definition: hwloc.h:1076
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:520
unsigned char get_thisproc_cpubind
Definition: hwloc.h:1048
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:609
Operating system block device. For instance "sda" on Linux.
Definition: hwloc.h:272
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:458
char * name
Info name.
Definition: hwloc.h:592
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:441
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:1078
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:349
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:2274
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:1106
unsigned char migrate_membind
Definition: hwloc.h:1104
OS Device specific Object Attributes.
Definition: hwloc.h:542
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:369
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:377
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:398
Virtual depth for software device object level.
Definition: hwloc.h:1204
unsigned char nexttouch_membind
Definition: hwloc.h:1102
Cache. Can be L1i, L1d, L2, L3, ...
Definition: hwloc.h:191
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:472
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:386
Bridge. Any bridge that connects the host or an I/O bus, to another I/O bus. Bridge objects have neit...
Definition: hwloc.h:226
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:1801
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:387
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:1074
hwloc_uint64_t total_memory
Total memory (in bytes) in this object and its children.
Definition: hwloc.h:325
Object memory.
Definition: hwloc.h:324
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2263
PCI-side of a bridge.
Definition: hwloc.h:267
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:336
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:591
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1201
unsigned char get_area_membind
Definition: hwloc.h:1090
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:373
hwloc_compare_types_e
Definition: hwloc.h:309
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:220
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:486
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:1200
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:198
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1767
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:310
Group-specific Object Attributes.
Definition: hwloc.h:514
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:500
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1708
Detect PCI bridges.
Definition: hwloc.h:791
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:282
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:345
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:1066
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:380
Detect the whole system, ignore reservations and offline settings.
Definition: hwloc.h:749
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:491
unsigned char get_thread_cpubind
Definition: hwloc.h:1060
unsigned char set_proc_membind
Definition: hwloc.h:1080
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:173
unsigned sibling_rank
Index in parent&#39;s children[] array.
Definition: hwloc.h:381
Operating system device. These objects have neither CPU sets nor node sets. They are not added to the...
Definition: hwloc.h:238
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:392
unsigned infos_count
Size of infos array.
Definition: hwloc.h:489
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:274
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:233
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:1064
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:1203
Bridge specific Object Attribues.
Definition: hwloc.h:527
Consider the bitmap argument as a nodeset.
Definition: hwloc.h:1831
float latency_max
The maximal value in the latency matrix.
Definition: hwloc.h:580
unsigned depth
Depth of group object.
Definition: hwloc.h:515