Hardware Locality (hwloc)  1.11.2
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 
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 
288 
306 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
307 
310 };
311 
320 union hwloc_obj_attr_u;
321 
324  hwloc_uint64_t total_memory;
325  hwloc_uint64_t local_memory;
328  unsigned page_types_len;
335  hwloc_uint64_t size;
336  hwloc_uint64_t count;
337  } * page_types;
338 };
339 
344 struct hwloc_obj {
345  /* physical information */
347  unsigned os_index;
351  char *name;
358  /* global position */
359  unsigned depth;
364  unsigned logical_index;
368  signed os_level;
370  /* cousins are all objects of the same type (and depth) across the entire topology */
374  /* children of the same parent are siblings, even if they may have different type and depth */
375  struct hwloc_obj *parent;
376  unsigned sibling_rank;
380  /* children array below this object */
381  unsigned arity;
382  struct hwloc_obj **children;
386  /* misc */
387  void *userdata;
392  /* cpusets and nodesets */
393  hwloc_cpuset_t cpuset;
406  hwloc_cpuset_t complete_cpuset;
417  hwloc_cpuset_t online_cpuset;
425  hwloc_cpuset_t allowed_cpuset;
436  hwloc_nodeset_t nodeset;
453  hwloc_nodeset_t complete_nodeset;
467  hwloc_nodeset_t allowed_nodeset;
481  unsigned distances_count;
482 
484  unsigned infos_count;
491 };
495 typedef struct hwloc_obj * hwloc_obj_t;
496 
501  hwloc_uint64_t size;
502  unsigned depth;
503  unsigned linesize;
507  } cache;
510  unsigned depth;
511  } group;
514  unsigned short domain;
515  unsigned char bus, dev, func;
516  unsigned short class_id;
518  unsigned char revision;
519  float linkspeed; /* in GB/s */
520  } pcidev;
523  union {
525  } upstream;
527  union {
528  struct {
529  unsigned short domain;
531  } pci;
532  } downstream;
534  unsigned depth;
535  } bridge;
539  } osdev;
540 };
541 
556  unsigned relative_depth;
558  unsigned nbobjs;
563  float *latency;
575  float latency_max;
576  float latency_base;
580 };
581 
584  char *name;
585  char *value;
586 };
587 
596 struct hwloc_topology;
601 typedef struct hwloc_topology * hwloc_topology_t;
602 
609 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
610 
628 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
629 
634 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
635 
643 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
644 
656 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
657 
694 HWLOC_DECLSPEC int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type);
695 
704 HWLOC_DECLSPEC int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type);
705 
712 HWLOC_DECLSPEC int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology);
713 
732 
752 
765 
774 
784 
792 };
793 
803 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
804 
811 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
812 
827 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
828 
855 HWLOC_DECLSPEC int hwloc_topology_set_fsroot(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict fsroot_path);
856 
884 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
885 
912 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
913 
940 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
941 
961 HWLOC_DECLSPEC int hwloc_topology_set_custom(hwloc_topology_t topology);
962 
980 HWLOC_DECLSPEC int hwloc_topology_set_distance_matrix(hwloc_topology_t __hwloc_restrict topology,
981  hwloc_obj_type_t type, unsigned nbobjs,
982  unsigned *os_index, float *distances);
983 
991 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
992 
996  unsigned char pu;
997 };
998 
1002  unsigned char set_thisproc_cpubind;
1004  unsigned char get_thisproc_cpubind;
1006  unsigned char set_proc_cpubind;
1008  unsigned char get_proc_cpubind;
1010  unsigned char set_thisthread_cpubind;
1012  unsigned char get_thisthread_cpubind;
1014  unsigned char set_thread_cpubind;
1016  unsigned char get_thread_cpubind;
1023 };
1024 
1028  unsigned char set_thisproc_membind;
1030  unsigned char get_thisproc_membind;
1032  unsigned char set_proc_membind;
1034  unsigned char get_proc_membind;
1036  unsigned char set_thisthread_membind;
1038  unsigned char get_thisthread_membind;
1040  unsigned char set_area_membind;
1042  unsigned char get_area_membind;
1044  unsigned char alloc_membind;
1046  unsigned char firsttouch_membind;
1048  unsigned char bind_membind;
1050  unsigned char interleave_membind;
1052  unsigned char replicate_membind;
1054  unsigned char nexttouch_membind;
1055 
1057  unsigned char migrate_membind;
1058 };
1059 
1070 };
1071 
1073 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
1074 
1085 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
1086 
1092 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
1093 
1111 HWLOC_DECLSPEC unsigned hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1112 
1135 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
1136 
1143 };
1144 
1154 static __hwloc_inline int
1155 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1156 
1166 static __hwloc_inline int
1167 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1168 
1175 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1176 
1179 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1180 
1186 static __hwloc_inline int
1187 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1188 
1194 static __hwloc_inline hwloc_obj_t
1195 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
1196 
1198 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, unsigned depth, unsigned idx) __hwloc_attribute_pure;
1199 
1206 static __hwloc_inline hwloc_obj_t
1207 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
1208 
1213 static __hwloc_inline hwloc_obj_t
1214 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev);
1215 
1222 static __hwloc_inline hwloc_obj_t
1223 hwloc_get_next_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type,
1224  hwloc_obj_t prev);
1225 
1235 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
1236 
1263 HWLOC_DECLSPEC int hwloc_obj_type_sscanf(const char *string,
1264  hwloc_obj_type_t *typep,
1265  int *depthattrp,
1266  void *typeattrp, size_t typeattrsize);
1267 
1278 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj,
1279  int verbose);
1280 
1292 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj, const char * __hwloc_restrict separator,
1293  int verbose);
1294 
1302 HWLOC_DECLSPEC int hwloc_obj_cpuset_snprintf(char * __hwloc_restrict str, size_t size, size_t nobj, const hwloc_obj_t * __hwloc_restrict objs);
1303 
1310 static __hwloc_inline const char *
1311 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1312 
1327 HWLOC_DECLSPEC void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1328 
1397 typedef enum {
1401 
1405 
1430 
1448 
1454 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1455 
1461 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1462 
1474 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1475 
1487 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1488 
1489 #ifdef hwloc_thread_t
1490 
1497 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1498 #endif
1499 
1500 #ifdef hwloc_thread_t
1501 
1508 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1509 #endif
1510 
1524 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1525 
1542 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1543 
1620 typedef enum {
1627 
1637 
1641 
1650 
1663 
1670 
1677 
1691 typedef enum {
1697 
1702 
1710 
1716 
1730 
1743 HWLOC_DECLSPEC int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags);
1744 
1758 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags);
1759 
1800 HWLOC_DECLSPEC int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t * policy, int flags);
1801 
1847 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_cpuset_t cpuset, hwloc_membind_policy_t * policy, int flags);
1848 
1858 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);
1859 
1869 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);
1870 
1907 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);
1908 
1948 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);
1949 
1956 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);
1957 
1964 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);
1965 
1988 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);
1989 
2014 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);
2015 
2023 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
2024 
2036 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;
2037 
2049 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;
2050 
2057 static __hwloc_inline void *
2058 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;
2059 
2064 static __hwloc_inline void *
2065 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;
2066 
2070 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
2071 
2094 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, const char *name);
2095 
2111 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2112 
2120 
2126 
2132 };
2133 
2155 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags);
2156 
2190 HWLOC_DECLSPEC int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2191 
2213 HWLOC_DECLSPEC hwloc_obj_t hwloc_custom_insert_group_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, int groupdepth);
2214 
2240 HWLOC_DECLSPEC int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath);
2241 
2260 HWLOC_DECLSPEC int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen);
2261 
2263 HWLOC_DECLSPEC void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer);
2264 
2283 HWLOC_DECLSPEC void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology,
2284  void (*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2285 
2311 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);
2312 
2326 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);
2327 
2350 HWLOC_DECLSPEC void hwloc_topology_set_userdata_import_callback(hwloc_topology_t topology,
2351  void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length));
2352 
2371 
2379 };
2380 
2399  HWLOC_DECLSPEC int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags);
2400 
2405 #ifdef __cplusplus
2406 } /* extern "C" */
2407 #endif
2408 
2409 
2410 /* high-level helpers */
2411 #include <hwloc/helper.h>
2412 
2413 /* inline code of some functions above */
2414 #include <hwloc/inlines.h>
2415 
2416 /* topology diffs */
2417 #include <hwloc/diff.h>
2418 
2419 /* deprecated headers */
2420 #include <hwloc/deprecated.h>
2421 
2422 #endif /* HWLOC_H */
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:526
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:257
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:506
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:601
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:481
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:325
hwloc_get_type_depth_e
Definition: hwloc.h:1137
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: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:347
unsigned char subordinate_bus
Definition: hwloc.h:530
Object type-specific Attributes.
Definition: hwloc.h:498
struct hwloc_obj_memory_s memory
Memory attributes.
Definition: hwloc.h:353
unsigned relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:556
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:504
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:372
Set of flags describing actual support for this topology.
Definition: hwloc.h:1066
Detect the whole PCI hierarchy.
Definition: hwloc.h:783
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:558
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1620
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:576
unsigned short subdevice_id
Definition: hwloc.h:517
PCI Device specific Object Attributes.
Definition: hwloc.h:513
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:1012
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:483
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:773
Object memory.
Definition: hwloc.h:323
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:1626
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:751
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:309
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:378
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:1669
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:336
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:467
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:1052
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:1018
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: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:1034
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:501
unsigned char get_thisproc_membind
Definition: hwloc.h:1030
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:393
unsigned arity
Number of children.
Definition: hwloc.h:381
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:719
struct hwloc_pcidev_attr_s pci
Definition: hwloc.h:524
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1715
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2125
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:1026
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:335
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:537
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:503
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1691
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:334
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:425
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:351
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:283
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:1728
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:2364
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:502
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:1020
unsigned char nexttouch_membind
Definition: hwloc.h:1054
unsigned char get_area_membind
Definition: hwloc.h:1042
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:344
Detect PCI devices.
Definition: hwloc.h:764
Avoid any effect on memory binding.
Definition: hwloc.h:1446
unsigned char get_thisthread_membind
Definition: hwloc.h:1038
struct hwloc_obj_attr_u::hwloc_group_attr_s group
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1139
Adapt distance matrices according to objects being removed during restriction. If this flag is not se...
Definition: hwloc.h:2119
unsigned short domain
Definition: hwloc.h:514
unsigned short class_id
Definition: hwloc.h:516
unsigned short vendor_id
Definition: hwloc.h:517
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:1040
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:1006
char * name
Info name.
Definition: hwloc.h:584
hwloc_uint64_t total_memory
Total memory (in bytes) in this object and its children.
Definition: hwloc.h:324
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:575
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1701
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR'ed flags of a topology.
unsigned depth
Definition: hwloc.h:534
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:1640
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:436
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2131
unsigned char get_thisproc_cpubind
Definition: hwloc.h:1004
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:382
Definition: hwloc.h:1709
unsigned char revision
Definition: hwloc.h:518
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:1140
unsigned char get_thread_cpubind
Definition: hwloc.h:1016
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:538
char * value
Info value.
Definition: hwloc.h:585
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:377
unsigned char secondary_bus
Definition: hwloc.h:530
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:371
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:484
Bridge specific Object Attribues.
Definition: hwloc.h:522
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:281
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1675
unsigned char set_thisthread_membind
Definition: hwloc.h:1036
unsigned char get_proc_cpubind
Definition: hwloc.h:1008
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:384
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:731
unsigned short domain
Definition: hwloc.h:529
unsigned char dev
Definition: hwloc.h:515
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:417
unsigned char set_thread_cpubind
Definition: hwloc.h:1014
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2114
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:355
struct hwloc_obj * first_child
First child.
Definition: hwloc.h:383
Request for strict binding from the OS.
Definition: hwloc.h:1429
unsigned short device_id
Definition: hwloc.h:517
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:1636
unsigned char set_thisthread_cpubind
Definition: hwloc.h:1010
Group-specific Object Attributes.
Definition: hwloc.h:509
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:1138
Flags describing actual discovery support for this topology.
Definition: hwloc.h:994
Operating system block device. For instance "sda" on Linux.
Definition: hwloc.h:272
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1649
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:519
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:533
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:563
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:1002
Object info.
Definition: hwloc.h:583
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1696
Export extended types such as L2dcache as basic types such as Cache.
Definition: hwloc.h:2370
hwloc_compare_types_e
Definition: hwloc.h:308
unsigned char set_proc_membind
Definition: hwloc.h:1032
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:453
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:274
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:387
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
unsigned char bind_membind
Definition: hwloc.h:1048
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:1000
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:1068
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:346
unsigned char migrate_membind
Definition: hwloc.h:1057
Cache-specific Object Attributes.
Definition: hwloc.h:500
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1069
Do not export level attributes.
Definition: hwloc.h:2378
Virtual depth for software device object level.
Definition: hwloc.h:1142
Bind current thread of current process.
Definition: hwloc.h:1404
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:517
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:238
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:364
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:515
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1067
Data cache.
Definition: hwloc.h:259
unsigned sibling_rank
Index in parent's children[] array.
Definition: hwloc.h:376
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: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:368
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:375
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: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:486
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:510
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:1046
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
unsigned char set_thisproc_membind
Definition: hwloc.h:1028
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:996
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:328
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:1662
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:480
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:515
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:1050
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:406
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:1397
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:1022
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1400
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:495
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:1044
Detect instruction caches.
Definition: hwloc.h:791
unsigned depth
Vertical index in the hierarchy. If the topology is symmetric, this is equal to the parent depth plus...
Definition: hwloc.h:359
Virtual depth for PCI device object level.
Definition: hwloc.h:1141
Distances between objects.
Definition: hwloc.h:555
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?
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...