Hardware Locality (hwloc)  1.11.4
hwloc.h
1 /*
2  * Copyright © 2009 CNRS
3  * Copyright © 2009-2016 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 
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 */
349  unsigned os_index;
353  char *name;
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;
512  } cache;
515  unsigned depth;
516  } group;
519  unsigned short domain;
520  unsigned char bus, dev, func;
521  unsigned short class_id;
523  unsigned char revision;
524  float linkspeed; /* in GB/s */
525  } pcidev;
528  union {
530  } upstream;
532  union {
533  struct {
534  unsigned short domain;
536  } pci;
537  } downstream;
539  unsigned depth;
540  } bridge;
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 
636 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
637 
642 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
643 
654 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
655 
667 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
668 
705 HWLOC_DECLSPEC int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type);
706 
715 HWLOC_DECLSPEC int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type);
716 
723 HWLOC_DECLSPEC int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology);
724 
743 
763 
776 
785 
795 
803 };
804 
814 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
815 
822 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
823 
838 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
839 
866 HWLOC_DECLSPEC int hwloc_topology_set_fsroot(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict fsroot_path);
867 
895 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
896 
923 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
924 
951 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
952 
972 HWLOC_DECLSPEC int hwloc_topology_set_custom(hwloc_topology_t topology);
973 
992 HWLOC_DECLSPEC int hwloc_topology_set_distance_matrix(hwloc_topology_t __hwloc_restrict topology,
993  hwloc_obj_type_t type, unsigned nbobjs,
994  unsigned *os_index, float *distances);
995 
1003 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1004 
1008  unsigned char pu;
1009 };
1010 
1018  unsigned char set_thisproc_cpubind;
1020  unsigned char get_thisproc_cpubind;
1022  unsigned char set_proc_cpubind;
1024  unsigned char get_proc_cpubind;
1026  unsigned char set_thisthread_cpubind;
1028  unsigned char get_thisthread_cpubind;
1030  unsigned char set_thread_cpubind;
1032  unsigned char get_thread_cpubind;
1039 };
1040 
1048  unsigned char set_thisproc_membind;
1050  unsigned char get_thisproc_membind;
1052  unsigned char set_proc_membind;
1054  unsigned char get_proc_membind;
1056  unsigned char set_thisthread_membind;
1058  unsigned char get_thisthread_membind;
1060  unsigned char set_area_membind;
1062  unsigned char get_area_membind;
1064  unsigned char alloc_membind;
1066  unsigned char firsttouch_membind;
1068  unsigned char bind_membind;
1070  unsigned char interleave_membind;
1072  unsigned char replicate_membind;
1074  unsigned char nexttouch_membind;
1076  unsigned char migrate_membind;
1078  unsigned char get_area_memlocation;
1079 };
1080 
1091 };
1092 
1102 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
1103 
1114 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
1115 
1121 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
1122 
1140 HWLOC_DECLSPEC unsigned hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1141 
1164 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
1165 
1172 };
1173 
1183 static __hwloc_inline int
1184 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1185 
1195 static __hwloc_inline int
1196 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1197 
1204 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1205 
1208 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1209 
1215 static __hwloc_inline int
1216 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1217 
1223 static __hwloc_inline hwloc_obj_t
1224 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
1225 
1227 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, unsigned depth, unsigned idx) __hwloc_attribute_pure;
1228 
1235 static __hwloc_inline hwloc_obj_t
1236 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
1237 
1242 static __hwloc_inline hwloc_obj_t
1243 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev);
1244 
1251 static __hwloc_inline hwloc_obj_t
1252 hwloc_get_next_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type,
1253  hwloc_obj_t prev);
1254 
1270 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
1271 
1285 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj,
1286  int verbose);
1287 
1299 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj, const char * __hwloc_restrict separator,
1300  int verbose);
1301 
1309 HWLOC_DECLSPEC int hwloc_obj_cpuset_snprintf(char * __hwloc_restrict str, size_t size, size_t nobj, const hwloc_obj_t * __hwloc_restrict objs);
1310 
1340 HWLOC_DECLSPEC int hwloc_obj_type_sscanf(const char *string,
1341  hwloc_obj_type_t *typep,
1342  int *depthattrp,
1343  void *typeattrp, size_t typeattrsize);
1344 
1360 static __hwloc_inline const char *
1361 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1362 
1377 HWLOC_DECLSPEC void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1378 
1447 typedef enum {
1451 
1455 
1480 
1498 
1504 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1505 
1511 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1512 
1524 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1525 
1537 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1538 
1539 #ifdef hwloc_thread_t
1540 
1547 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1548 #endif
1549 
1550 #ifdef hwloc_thread_t
1551 
1558 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1559 #endif
1560 
1574 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1575 
1592 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1593 
1675 typedef enum {
1686 
1696 
1700 
1709 
1722 
1729 
1736 
1750 typedef enum {
1756 
1761 
1769 
1775 
1788 
1800 
1813 HWLOC_DECLSPEC int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags);
1814 
1830 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
1831 
1873 HWLOC_DECLSPEC int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t * policy, int flags);
1874 
1919 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
1920 
1930 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);
1931 
1944 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);
1945 
1982 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);
1983 
2023 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);
2024 
2032 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);
2033 
2044 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);
2045 
2070 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);
2071 
2099 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);
2100 
2122 HWLOC_DECLSPEC int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags);
2123 
2131 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
2132 
2144 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;
2145 
2160 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;
2161 
2168 static __hwloc_inline void *
2169 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;
2170 
2180 static __hwloc_inline void *
2181 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;
2182 
2186 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
2187 
2210 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, const char *name);
2211 
2227 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2228 
2236 
2242 
2248 };
2249 
2271 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags);
2272 
2306 HWLOC_DECLSPEC int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2307 
2329 HWLOC_DECLSPEC hwloc_obj_t hwloc_custom_insert_group_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, int groupdepth);
2330 
2356 HWLOC_DECLSPEC int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath);
2357 
2376 HWLOC_DECLSPEC int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen);
2377 
2379 HWLOC_DECLSPEC void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer);
2380 
2399 HWLOC_DECLSPEC void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology,
2400  void (*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2401 
2427 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);
2428 
2442 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);
2443 
2466 HWLOC_DECLSPEC void hwloc_topology_set_userdata_import_callback(hwloc_topology_t topology,
2467  void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length));
2468 
2487 
2495 };
2496 
2515  HWLOC_DECLSPEC int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags);
2516 
2521 #ifdef __cplusplus
2522 } /* extern "C" */
2523 #endif
2524 
2525 
2526 /* high-level helpers */
2527 #include <hwloc/helper.h>
2528 
2529 /* inline code of some functions above */
2530 #include <hwloc/inlines.h>
2531 
2532 /* topology diffs */
2533 #include <hwloc/diff.h>
2534 
2535 /* deprecated headers */
2536 #include <hwloc/deprecated.h>
2537 
2538 #endif /* HWLOC_H */
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:531
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:257
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:511
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:609
Whole system (may be a cluster of machines). The whole system that is accessible to hwloc...
Definition: hwloc.h:173
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.
int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type.
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
unsigned distances_count
Definition: hwloc.h:486
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, unsigned depth)
Returns the width of level at depth depth.
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:326
hwloc_get_type_depth_e
Definition: hwloc.h:1166
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.
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
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:52
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA, or "hfi1_0" Omni-Path ...
Definition: hwloc.h:279
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:277
Machine. The typical root object type. A set of processors and memory with cache coherency.
Definition: hwloc.h:178
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
unsigned char subordinate_bus
Definition: hwloc.h:535
Object type-specific Attributes.
Definition: hwloc.h:503
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:50
struct hwloc_obj_memory_s memory
Memory attributes.
Definition: hwloc.h:358
unsigned relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:561
Miscellaneous objects. Objects without particular meaning, that can e.g. be added by the application ...
Definition: hwloc.h:220
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:509
int hwloc_obj_type_snprintf(char *restrict string, size_t size, hwloc_obj_t obj, int verbose)
Stringify the type of a given topology object into a human-readable form.
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:377
Set of flags describing actual support for this topology.
Definition: hwloc.h:1087
Detect the whole PCI hierarchy.
Definition: hwloc.h:794
unsigned nbobjs
Number of objects considered in the matrix. It is the number of descendant objects at relative_depth ...
Definition: hwloc.h:563
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1447
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.
int hwloc_obj_attr_snprintf(char *restrict string, size_t size, hwloc_obj_t obj, const char *restrict separator, int verbose)
Stringify the attributes of a given topology object into a human-readable form.
float latency_base
The multiplier that should be applied to latency matrix to retrieve the original OS-provided latencie...
Definition: hwloc.h:581
Avoid any effect on CPU binding.
Definition: hwloc.h:1787
unsigned short subdevice_id
Definition: hwloc.h:522
PCI Device specific Object Attributes.
Definition: hwloc.h:518
unsigned char get_thisthread_cpubind
Definition: hwloc.h:1028
struct hwloc_obj_attr_u::hwloc_bridge_attr_s bridge
struct hwloc_obj_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:488
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1774
Detect PCI bridges.
Definition: hwloc.h:784
Object memory.
Definition: hwloc.h:324
Adapt distance matrices according to objects being removed during restriction. If this flag is not se...
Definition: hwloc.h:2235
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:163
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:762
int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags)
Export the topology as a synthetic string.
Value returned by hwloc_compare_types() when types can not be compared.
Definition: hwloc.h:310
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
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_obj * prev_sibling
Previous object below the same parent.
Definition: hwloc.h:383
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:337
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
hwloc_nodeset_t allowed_nodeset
The set of allowed NUMA memory nodes.
Definition: hwloc.h:472
hwloc_obj_t hwloc_get_obj_by_depth(hwloc_topology_t topology, unsigned depth, unsigned idx)
Returns the topology object at logical index idx from depth depth.
hwloc_bitmap_t hwloc_nodeset_t
A node set is a bitmap whose bits are set according to NUMA memory node physical OS indexes...
Definition: hwloc.h:144
unsigned char replicate_membind
Definition: hwloc.h:1072
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 get_thisproc_last_cpu_location
Definition: hwloc.h:1034
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
Unified cache.
Definition: hwloc.h:258
NUMA node. A set of processors around memory which the processors can directly access.
Definition: hwloc.h:183
unsigned char get_proc_membind
Definition: hwloc.h:1054
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:506
unsigned char get_thisproc_membind
Definition: hwloc.h:1050
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:398
Allocate memory on the specified nodes.
Definition: hwloc.h:1699
unsigned arity
Number of children.
Definition: hwloc.h:386
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:730
struct hwloc_pcidev_attr_s pci
Definition: hwloc.h:529
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...
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2230
Physical package, what goes into a socket. In the physical meaning, i.e. that you can add or remove p...
Definition: hwloc.h:187
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:265
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:1046
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:336
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.
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.
Instruction cache. Only used when the HWLOC_TOPOLOGY_FLAG_ICACHES topology flag is set...
Definition: hwloc.h:260
OS Device specific Object Attributes.
Definition: hwloc.h:542
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:508
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...
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:335
Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allo...
Definition: hwloc.h:1695
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:430
Reset the memory allocation policy to the system default. Depending on the operating system...
Definition: hwloc.h:1685
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:353
int hwloc_export_obj_userdata(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length)
Export some object userdata to XML.
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, unsigned depth)
Returns the type of objects at depth depth.
Operating system co-processor device. For instance "mic0" for a Xeon Phi (MIC) on Linux...
Definition: hwloc.h:284
static int hwloc_get_type_or_below_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type or below.
int hwloc_obj_type_sscanf(const char *string, hwloc_obj_type_t *typep, int *depthattrp, void *typeattrp, size_t typeattrsize)
Return an object type and attributes from a type string.
int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology)
Ignore all objects that do not bring any structure.
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:507
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.
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:1036
unsigned char nexttouch_membind
Definition: hwloc.h:1074
void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer)
Free a buffer allocated by hwloc_topology_export_xmlbuffer()
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1708
unsigned char get_area_membind
Definition: hwloc.h:1062
static hwloc_obj_t hwloc_get_next_obj_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, hwloc_obj_t prev)
Returns the next object of type type.
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
Structure of a topology object.
Definition: hwloc.h:345
Detect PCI devices.
Definition: hwloc.h:775
void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology, void(*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj))
Set the application-specific callback for exporting object userdata.
unsigned char get_thisthread_membind
Definition: hwloc.h:1058
struct hwloc_obj_attr_u::hwloc_group_attr_s group
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.
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1168
unsigned short domain
Definition: hwloc.h:519
unsigned short class_id
Definition: hwloc.h:521
unsigned short vendor_id
Definition: hwloc.h:522
unsigned hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
unsigned char set_area_membind
Definition: hwloc.h:1060
unsigned char set_proc_cpubind
Definition: hwloc.h:1022
char * name
Info name.
Definition: hwloc.h:592
hwloc_uint64_t total_memory
Total memory (in bytes) in this object and its children.
Definition: hwloc.h:325
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:207
float latency_max
The maximal value in the latency matrix.
Definition: hwloc.h:580
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR'ed flags of a topology.
unsigned depth
Definition: hwloc.h:539
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())...
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:1728
Definition: hwloc.h:1768
int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:441
unsigned char get_thisproc_cpubind
Definition: hwloc.h:1020
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:387
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.
unsigned char revision
Definition: hwloc.h:523
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.
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
Virtual depth for bridge object level.
Definition: hwloc.h:1169
unsigned char get_thread_cpubind
Definition: hwloc.h:1032
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...
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1760
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.
static hwloc_obj_t hwloc_get_next_obj_by_depth(hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev)
Returns the next object at depth depth.
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
hwloc_topology_export_synthetic_flags_e
Flags for exporting synthetic topologies.
Definition: hwloc.h:2480
hwloc_obj_osdev_type_t type
Definition: hwloc.h:543
char * value
Info value.
Definition: hwloc.h:593
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which process the topology is viewed from.
static const char * hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name)
Search the given key name in object infos and return the corresponding value.
int hwloc_obj_cpuset_snprintf(char *restrict str, size_t size, size_t nobj, const hwloc_obj_t *restrict objs)
Stringify the cpuset containing a set of objects.
struct hwloc_obj * next_sibling
Next object below the same parent.
Definition: hwloc.h:382
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 char secondary_bus
Definition: hwloc.h:535
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@0 upstream
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:376
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 ).
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_topology_set_custom(hwloc_topology_t topology)
Prepare the topology for custom assembly.
unsigned infos_count
Size of infos array.
Definition: hwloc.h:489
Bridge specific Object Attribues.
Definition: hwloc.h:527
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.
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:282
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...
unsigned char set_thisthread_membind
Definition: hwloc.h:1056
unsigned char get_proc_cpubind
Definition: hwloc.h:1024
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:389
Detect the whole system, ignore reservations and offline settings.
Definition: hwloc.h:742
unsigned short domain
Definition: hwloc.h:534
unsigned char dev
Definition: hwloc.h:520
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:422
unsigned char set_thread_cpubind
Definition: hwloc.h:1030
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:360
struct hwloc_obj * first_child
First child.
Definition: hwloc.h:388
int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the current process or thread to prefer the NUMA node(s) spe...
unsigned short device_id
Definition: hwloc.h:522
unsigned char set_thisthread_cpubind
Definition: hwloc.h:1026
Group-specific Object Attributes.
Definition: hwloc.h:514
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:127
No object of given type exists in the topology.
Definition: hwloc.h:1167
Do not export level attributes.
Definition: hwloc.h:2494
Flags describing actual discovery support for this topology.
Definition: hwloc.h:1006
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2247
Operating system block device. For instance "sda" on Linux.
Definition: hwloc.h:272
int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type if it does not bring any structure.
float linkspeed
Definition: hwloc.h:524
hwloc_obj_t hwloc_topology_insert_misc_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, const char *name)
Add a MISC object as a leaf of the topology.
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:538
float * latency
Matrix of latencies between objects, stored as a one-dimension array. May be NULL if the distances co...
Definition: hwloc.h:568
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
Consider the bitmap argument as a nodeset.
Definition: hwloc.h:1798
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
unsigned char set_thisproc_cpubind
Definition: hwloc.h:1018
Object info.
Definition: hwloc.h:591
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1675
Bind current thread of current process.
Definition: hwloc.h:1454
hwloc_compare_types_e
Definition: hwloc.h:309
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...
unsigned char set_proc_membind
Definition: hwloc.h:1052
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR'ed flags to non-yet-loaded topology.
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2241
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:458
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...
unsigned char get_area_memlocation
Definition: hwloc.h:1078
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:274
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_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...
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.
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:392
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
unsigned char bind_membind
Definition: hwloc.h:1068
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:1016
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.
Avoid any effect on memory binding.
Definition: hwloc.h:1496
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:1089
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.
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:271
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:347
unsigned char migrate_membind
Definition: hwloc.h:1076
Cache-specific Object Attributes.
Definition: hwloc.h:505
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1090
Virtual depth for software device object level.
Definition: hwloc.h:1171
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
unsigned short subvendor_id
Definition: hwloc.h:522
Operating system device. These objects have neither CPU sets nor node sets. They are not added to the...
Definition: hwloc.h:238
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:369
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.
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
unsigned char bus
Definition: hwloc.h:520
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1088
int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath)
Export the topology into an XML file.
Data cache.
Definition: hwloc.h:259
unsigned sibling_rank
Index in parent's children[] array.
Definition: hwloc.h:381
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
Definition: hwloc.h:244
static hwloc_obj_t hwloc_get_obj_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx)
Returns the topology object at logical index idx with type type.
signed os_level
OS-provided physical level, -1 if unknown or meaningless.
Definition: hwloc.h:373
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:380
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:147
Cache. Can be L1i, L1d, L2, L3, ...
Definition: hwloc.h:191
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1734
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:233
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
Export extended types such as L2dcache as basic types such as Cache.
Definition: hwloc.h:2486
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a constant stringified object type.
int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen)
Export the topology into a newly-allocated XML memory buffer.
unsigned depth
Depth of group object.
Definition: hwloc.h:515
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1450
unsigned char firsttouch_membind
Definition: hwloc.h:1066
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
unsigned char set_thisproc_membind
Definition: hwloc.h:1048
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:1008
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:329
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_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.
Request for strict binding from the OS.
Definition: hwloc.h:1479
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:198
int hwloc_topology_set_distance_matrix(hwloc_topology_t restrict topology, hwloc_obj_type_t type, unsigned nbobjs, unsigned *os_index, float *distances)
Provide a distance matrix.
struct hwloc_distances_s ** distances
Distances between all objects at same depth below this object.
Definition: hwloc.h:485
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1750
unsigned char func
Definition: hwloc.h:520
PCI-side of a bridge.
Definition: hwloc.h:267
struct hwloc_obj_memory_s::hwloc_obj_memory_page_type_s * page_types
unsigned char interleave_membind
Definition: hwloc.h:1070
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:411
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
struct hwloc_obj_attr_u::hwloc_cache_attr_s cache
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:1038
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:500
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
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().
unsigned char alloc_membind
Definition: hwloc.h:1064
Detect instruction caches.
Definition: hwloc.h:802
Replicate memory on the given nodes; reads from this memory will attempt to be serviced from the NUMA...
Definition: hwloc.h:1721
unsigned depth
Vertical index in the hierarchy. If the topology is symmetric, this is equal to the parent depth plus...
Definition: hwloc.h:364
Virtual depth for PCI device object level.
Definition: hwloc.h:1170
Distances between objects.
Definition: hwloc.h:560
static int hwloc_get_type_or_above_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type or above.
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:266
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1755