Hardware Locality (hwloc)  1.11.1
hwloc.h
1 /*
2  * Copyright © 2009 CNRS
3  * Copyright © 2009-2015 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 
245  /* ***************************************************************
246  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
247 
248  If new enum values are added here, you MUST also go update the
249  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
250 
251  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
252  *************************************************************** */
254 
262 
268 
287 
305 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
306 
309 };
310 
319 union hwloc_obj_attr_u;
320 
323  hwloc_uint64_t total_memory;
324  hwloc_uint64_t local_memory;
327  unsigned page_types_len;
334  hwloc_uint64_t size;
335  hwloc_uint64_t count;
336  } * page_types;
337 };
338 
343 struct hwloc_obj {
344  /* physical information */
346  unsigned os_index;
350  char *name;
357  /* global position */
358  unsigned depth;
363  unsigned logical_index;
367  signed os_level;
369  /* cousins are all objects of the same type (and depth) across the entire topology */
373  /* children of the same parent are siblings, even if they may have different type and depth */
374  struct hwloc_obj *parent;
375  unsigned sibling_rank;
379  /* children array below this object */
380  unsigned arity;
381  struct hwloc_obj **children;
385  /* misc */
386  void *userdata;
391  /* cpusets and nodesets */
392  hwloc_cpuset_t cpuset;
405  hwloc_cpuset_t complete_cpuset;
416  hwloc_cpuset_t online_cpuset;
424  hwloc_cpuset_t allowed_cpuset;
435  hwloc_nodeset_t nodeset;
452  hwloc_nodeset_t complete_nodeset;
466  hwloc_nodeset_t allowed_nodeset;
480  unsigned distances_count;
481 
483  unsigned infos_count;
490 };
494 typedef struct hwloc_obj * hwloc_obj_t;
495 
500  hwloc_uint64_t size;
501  unsigned depth;
502  unsigned linesize;
506  } cache;
509  unsigned depth;
510  } group;
513  unsigned short domain;
514  unsigned char bus, dev, func;
515  unsigned short class_id;
517  unsigned char revision;
518  float linkspeed; /* in GB/s */
519  } pcidev;
522  union {
524  } upstream;
526  union {
527  struct {
528  unsigned short domain;
530  } pci;
531  } downstream;
533  unsigned depth;
534  } bridge;
538  } osdev;
539 };
540 
555  unsigned relative_depth;
557  unsigned nbobjs;
562  float *latency;
574  float latency_max;
575  float latency_base;
579 };
580 
583  char *name;
584  char *value;
585 };
586 
595 struct hwloc_topology;
600 typedef struct hwloc_topology * hwloc_topology_t;
601 
608 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
609 
627 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
628 
633 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
634 
642 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
643 
655 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
656 
693 HWLOC_DECLSPEC int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type);
694 
703 HWLOC_DECLSPEC int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type);
704 
711 HWLOC_DECLSPEC int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology);
712 
731 
751 
764 
773 
783 
791 };
792 
802 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
803 
810 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
811 
826 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
827 
854 HWLOC_DECLSPEC int hwloc_topology_set_fsroot(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict fsroot_path);
855 
883 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
884 
911 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
912 
939 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
940 
960 HWLOC_DECLSPEC int hwloc_topology_set_custom(hwloc_topology_t topology);
961 
979 HWLOC_DECLSPEC int hwloc_topology_set_distance_matrix(hwloc_topology_t __hwloc_restrict topology,
980  hwloc_obj_type_t type, unsigned nbobjs,
981  unsigned *os_index, float *distances);
982 
990 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
991 
995  unsigned char pu;
996 };
997 
1001  unsigned char set_thisproc_cpubind;
1003  unsigned char get_thisproc_cpubind;
1005  unsigned char set_proc_cpubind;
1007  unsigned char get_proc_cpubind;
1009  unsigned char set_thisthread_cpubind;
1011  unsigned char get_thisthread_cpubind;
1013  unsigned char set_thread_cpubind;
1015  unsigned char get_thread_cpubind;
1022 };
1023 
1027  unsigned char set_thisproc_membind;
1029  unsigned char get_thisproc_membind;
1031  unsigned char set_proc_membind;
1033  unsigned char get_proc_membind;
1035  unsigned char set_thisthread_membind;
1037  unsigned char get_thisthread_membind;
1039  unsigned char set_area_membind;
1041  unsigned char get_area_membind;
1043  unsigned char alloc_membind;
1045  unsigned char firsttouch_membind;
1047  unsigned char bind_membind;
1049  unsigned char interleave_membind;
1051  unsigned char replicate_membind;
1053  unsigned char nexttouch_membind;
1054 
1056  unsigned char migrate_membind;
1057 };
1058 
1069 };
1070 
1072 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
1073 
1084 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
1085 
1091 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
1092 
1110 HWLOC_DECLSPEC unsigned hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1111 
1134 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
1135 
1142 };
1143 
1153 static __hwloc_inline int
1154 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1155 
1165 static __hwloc_inline int
1166 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1167 
1174 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1175 
1178 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1179 
1185 static __hwloc_inline int
1186 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1187 
1193 static __hwloc_inline hwloc_obj_t
1194 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
1195 
1197 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, unsigned depth, unsigned idx) __hwloc_attribute_pure;
1198 
1205 static __hwloc_inline hwloc_obj_t
1206 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
1207 
1212 static __hwloc_inline hwloc_obj_t
1213 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev);
1214 
1221 static __hwloc_inline hwloc_obj_t
1222 hwloc_get_next_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type,
1223  hwloc_obj_t prev);
1224 
1234 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
1235 
1262 HWLOC_DECLSPEC int hwloc_obj_type_sscanf(const char *string,
1263  hwloc_obj_type_t *typep,
1264  int *depthattrp,
1265  void *typeattrp, size_t typeattrsize);
1266 
1277 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj,
1278  int verbose);
1279 
1291 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj, const char * __hwloc_restrict separator,
1292  int verbose);
1293 
1301 HWLOC_DECLSPEC int hwloc_obj_cpuset_snprintf(char * __hwloc_restrict str, size_t size, size_t nobj, const hwloc_obj_t * __hwloc_restrict objs);
1302 
1309 static __hwloc_inline const char *
1310 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1311 
1326 HWLOC_DECLSPEC void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1327 
1396 typedef enum {
1400 
1404 
1429 
1447 
1453 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1454 
1460 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1461 
1473 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1474 
1486 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1487 
1488 #ifdef hwloc_thread_t
1489 
1496 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1497 #endif
1498 
1499 #ifdef hwloc_thread_t
1500 
1507 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1508 #endif
1509 
1523 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1524 
1541 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1542 
1619 typedef enum {
1626 
1636 
1640 
1649 
1662 
1669 
1676 
1690 typedef enum {
1696 
1701 
1709 
1715 
1729 
1742 HWLOC_DECLSPEC int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags);
1743 
1757 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags);
1758 
1799 HWLOC_DECLSPEC int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t * policy, int flags);
1800 
1846 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_cpuset_t cpuset, hwloc_membind_policy_t * policy, int flags);
1847 
1857 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);
1858 
1868 HWLOC_DECLSPEC int hwloc_set_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags);
1869 
1906 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);
1907 
1947 HWLOC_DECLSPEC int hwloc_get_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t cpuset, hwloc_membind_policy_t * policy, int flags);
1948 
1955 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);
1956 
1963 HWLOC_DECLSPEC int hwloc_set_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags);
1964 
1987 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);
1988 
2013 HWLOC_DECLSPEC int hwloc_get_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_cpuset_t cpuset, hwloc_membind_policy_t * policy, int flags);
2014 
2022 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
2023 
2035 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;
2036 
2048 HWLOC_DECLSPEC void *hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags) __hwloc_attribute_malloc;
2049 
2056 static __hwloc_inline void *
2057 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;
2058 
2063 static __hwloc_inline void *
2064 hwloc_alloc_membind_policy(hwloc_topology_t topology, size_t len, hwloc_const_cpuset_t set, hwloc_membind_policy_t policy, int flags) __hwloc_attribute_malloc;
2065 
2069 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
2070 
2093 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, const char *name);
2094 
2110 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2111 
2119 
2125 
2131 };
2132 
2154 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags);
2155 
2189 HWLOC_DECLSPEC int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2190 
2212 HWLOC_DECLSPEC hwloc_obj_t hwloc_custom_insert_group_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, int groupdepth);
2213 
2239 HWLOC_DECLSPEC int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath);
2240 
2259 HWLOC_DECLSPEC int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen);
2260 
2262 HWLOC_DECLSPEC void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer);
2263 
2282 HWLOC_DECLSPEC void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology,
2283  void (*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2284 
2310 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);
2311 
2325 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);
2326 
2349 HWLOC_DECLSPEC void hwloc_topology_set_userdata_import_callback(hwloc_topology_t topology,
2350  void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length));
2351 
2370 
2378 };
2379 
2398  HWLOC_DECLSPEC int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags);
2399 
2404 #ifdef __cplusplus
2405 } /* extern "C" */
2406 #endif
2407 
2408 
2409 /* high-level helpers */
2410 #include <hwloc/helper.h>
2411 
2412 /* inline code of some functions above */
2413 #include <hwloc/inlines.h>
2414 
2415 /* topology diffs */
2416 #include <hwloc/diff.h>
2417 
2418 /* deprecated headers */
2419 #include <hwloc/deprecated.h>
2420 
2421 #endif /* HWLOC_H */
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:525
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:256
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:505
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:600
Whole system (may be a cluster of machines). The whole system that is accessible to hwloc...
Definition: hwloc.h:173
int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type.
unsigned distances_count
Definition: hwloc.h:480
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:324
hwloc_get_type_depth_e
Definition: hwloc.h:1136
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
int hwloc_set_area_membind_nodeset(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) in physical nodeset...
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:194
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA device on Linux...
Definition: hwloc.h:278
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:276
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:346
unsigned char subordinate_bus
Definition: hwloc.h:529
Object type-specific Attributes.
Definition: hwloc.h:497
struct hwloc_obj_memory_s memory
Memory attributes.
Definition: hwloc.h:352
unsigned relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:555
Miscellaneous objects. Objects without particular meaning, that can e.g. be added by the application ...
Definition: hwloc.h:219
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:503
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:371
Set of flags describing actual support for this topology.
Definition: hwloc.h:1065
Detect the whole PCI hierarchy.
Definition: hwloc.h:782
int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath)
Export the topology into an XML file.
unsigned nbobjs
Number of objects considered in the matrix. It is the number of descendant objects at relative_depth ...
Definition: hwloc.h:557
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1619
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:575
unsigned short subdevice_id
Definition: hwloc.h:516
PCI Device specific Object Attributes.
Definition: hwloc.h:512
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 char get_thisthread_cpubind
Definition: hwloc.h:1011
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:482
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.
Detect PCI bridges.
Definition: hwloc.h:772
Object memory.
Definition: hwloc.h:322
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
Reset the memory allocation policy to the system default. Depending on the operating system...
Definition: hwloc.h:1625
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:750
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.
Value returned by hwloc_compare_types() when types can not be compared.
Definition: hwloc.h:308
void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer)
Free a buffer allocated by hwloc_topology_export_xmlbuffer()
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
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 * prev_sibling
Previous object below the same parent.
Definition: hwloc.h:377
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:1668
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:335
Bridge. Any bridge that connects the host or an I/O bus, to another I/O bus. Bridge objects have neit...
Definition: hwloc.h:225
hwloc_nodeset_t allowed_nodeset
The set of allowed NUMA memory nodes.
Definition: hwloc.h:466
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
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 replicate_membind
Definition: hwloc.h:1051
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:1017
int hwloc_set_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the specified process to prefer the NUMA node(s) near the sp...
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.
Unified cache.
Definition: hwloc.h:257
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:1033
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:500
unsigned char get_thisproc_membind
Definition: hwloc.h:1029
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen)
Export the topology into a newly-allocated XML memory buffer.
hwloc_obj_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_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.
int hwloc_get_membind(hwloc_topology_t topology, hwloc_cpuset_t cpuset, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the current process or thread (the l...
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:392
unsigned arity
Number of children.
Definition: hwloc.h:380
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:718
struct hwloc_pcidev_attr_s pci
Definition: hwloc.h:523
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1714
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2124
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:264
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:1025
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:52
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:334
Instruction cache. Only used when the HWLOC_TOPOLOGY_FLAG_ICACHES topology flag is set...
Definition: hwloc.h:259
OS Device specific Object Attributes.
Definition: hwloc.h:536
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.
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:502
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1690
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:333
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:424
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.
static void * hwloc_alloc_membind_policy_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Allocate some memory on the given nodeset nodeset.
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.
char * name
Object description if any.
Definition: hwloc.h:350
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:282
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_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.
Avoid any effect on CPU binding.
Definition: hwloc.h:1727
int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology)
Ignore all objects that do not bring any structure.
hwloc_topology_export_synthetic_flags_e
Flags for exporting synthetic topologies.
Definition: hwloc.h:2363
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:501
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:1019
unsigned char nexttouch_membind
Definition: hwloc.h:1053
unsigned char get_area_membind
Definition: hwloc.h:1041
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:343
Detect PCI devices.
Definition: hwloc.h:763
Avoid any effect on memory binding.
Definition: hwloc.h:1445
unsigned char get_thisthread_membind
Definition: hwloc.h:1037
struct hwloc_obj_attr_u::hwloc_group_attr_s group
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1138
Adapt distance matrices according to objects being removed during restriction. If this flag is not se...
Definition: hwloc.h:2118
unsigned short domain
Definition: hwloc.h:513
unsigned short class_id
Definition: hwloc.h:515
unsigned short vendor_id
Definition: hwloc.h:516
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:1039
int hwloc_get_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_cpuset_t cpuset, hwloc_membind_policy_t *policy, int flags)
Query the CPUs near the physical NUMA node(s) and binding policy of the memory identified by (addr...
unsigned char set_proc_cpubind
Definition: hwloc.h:1005
char * name
Info name.
Definition: hwloc.h:583
hwloc_uint64_t total_memory
Total memory (in bytes) in this object and its children.
Definition: hwloc.h:323
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.
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:574
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1700
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR'ed flags of a topology.
unsigned depth
Definition: hwloc.h:533
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())...
Allocate memory on the specified nodes.
Definition: hwloc.h:1639
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_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
int hwloc_get_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t cpuset, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the specified process (the locality ...
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:435
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2130
unsigned char get_thisproc_cpubind
Definition: hwloc.h:1003
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:381
Definition: hwloc.h:1708
unsigned char revision
Definition: hwloc.h:517
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:1139
unsigned char get_thread_cpubind
Definition: hwloc.h:1015
void * hwloc_alloc_membind_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Allocate some memory on the given physical nodeset nodeset.
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_obj_osdev_type_t type
Definition: hwloc.h:537
char * value
Info value.
Definition: hwloc.h:584
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which process the topology is viewed from.
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:376
unsigned char secondary_bus
Definition: hwloc.h:529
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:370
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
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:483
Bridge specific Object Attribues.
Definition: hwloc.h:521
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:280
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1674
unsigned char set_thisthread_membind
Definition: hwloc.h:1035
unsigned char get_proc_cpubind
Definition: hwloc.h:1007
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:383
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...
Detect the whole system, ignore reservations and offline settings.
Definition: hwloc.h:730
unsigned short domain
Definition: hwloc.h:528
unsigned char dev
Definition: hwloc.h:514
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:416
unsigned char set_thread_cpubind
Definition: hwloc.h:1013
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2113
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:354
struct hwloc_obj * first_child
First child.
Definition: hwloc.h:382
Request for strict binding from the OS.
Definition: hwloc.h:1428
unsigned short device_id
Definition: hwloc.h:516
static void * hwloc_alloc_membind_policy(hwloc_topology_t topology, size_t len, hwloc_const_cpuset_t set, hwloc_membind_policy_t policy, int flags)
Allocate some memory on the memory nodes near given cpuset cpuset.
Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allo...
Definition: hwloc.h:1635
unsigned char set_thisthread_cpubind
Definition: hwloc.h:1009
Group-specific Object Attributes.
Definition: hwloc.h:508
void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value)
Add the given info name and value pair to the given object.
hwloc_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:1137
Flags describing actual discovery support for this topology.
Definition: hwloc.h:993
Operating system block device. For instance "sda" on Linux.
Definition: hwloc.h:271
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1648
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:518
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:532
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...
float * latency
Matrix of latencies between objects, stored as a one-dimension array. May be NULL if the distances co...
Definition: hwloc.h:562
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
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:1001
Object info.
Definition: hwloc.h:582
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1695
Export extended types such as L2dcache as basic types such as Cache.
Definition: hwloc.h:2369
hwloc_compare_types_e
Definition: hwloc.h:307
unsigned char set_proc_membind
Definition: hwloc.h:1031
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR'ed flags to non-yet-loaded topology.
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:452
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:273
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:386
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
unsigned char bind_membind
Definition: hwloc.h:1047
void * hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags)
Allocate some memory on memory nodes near the given physical cpuset cpuset.
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:999
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:1067
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:270
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:345
unsigned char migrate_membind
Definition: hwloc.h:1056
Cache-specific Object Attributes.
Definition: hwloc.h:499
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1068
Do not export level attributes.
Definition: hwloc.h:2377
Virtual depth for software device object level.
Definition: hwloc.h:1141
Bind current thread of current process.
Definition: hwloc.h:1403
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags)
Export the topology as a synthetic string.
unsigned short subvendor_id
Definition: hwloc.h:516
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.
Operating system device. These objects have neither CPU sets nor node sets. They are not added to the...
Definition: hwloc.h:237
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.
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:50
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:363
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:514
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1066
Data cache.
Definition: hwloc.h:258
unsigned sibling_rank
Index in parent's children[] array.
Definition: hwloc.h:375
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
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().
Definition: hwloc.h:243
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:367
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:374
int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the current process or thread to prefer the NUMA node(s) nea...
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
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
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:232
int symmetric_subtree
Set if the subtree of objects below this object is symmetric, which means all children and their chil...
Definition: hwloc.h:485
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.
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a stringified topology object type.
unsigned depth
Depth of group object.
Definition: hwloc.h:509
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.
unsigned char firsttouch_membind
Definition: hwloc.h:1045
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
unsigned char set_thisproc_membind
Definition: hwloc.h:1027
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:995
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:327
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.
Replicate memory on the given nodes; reads from this memory will attempt to be serviced from the NUMA...
Definition: hwloc.h:1661
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:198
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_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:479
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
unsigned char func
Definition: hwloc.h:514
PCI-side of a bridge.
Definition: hwloc.h:266
struct hwloc_obj_memory_s::hwloc_obj_memory_page_type_s * page_types
unsigned char interleave_membind
Definition: hwloc.h:1049
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:405
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
int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags)
Bind current process or thread on cpus given in physical bitmap set.
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1396
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:1021
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1399
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:494
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
unsigned char alloc_membind
Definition: hwloc.h:1043
Detect instruction caches.
Definition: hwloc.h:790
unsigned depth
Vertical index in the hierarchy. If the topology is symmetric, this is equal to the parent depth plus...
Definition: hwloc.h:358
Virtual depth for PCI device object level.
Definition: hwloc.h:1140
Distances between objects.
Definition: hwloc.h:554
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:265
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
int hwloc_set_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) near physical cpuset...