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 #include <hwloc/cpuset.h>
70 
71 
72 #ifdef __cplusplus
73 extern "C" {
74 #endif
75 
76 
82 #define HWLOC_API_VERSION 0x00010b00
83 
88 HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);
89 
91 #define HWLOC_COMPONENT_ABI 4
92 
129 
149 
164 typedef enum {
165  /* ***************************************************************
166  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
167 
168  If new enum values are added here, you MUST also go update the
169  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
170 
171  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
172  *************************************************************** */
173 
245  HWLOC_OBJ_TYPE_MAX
247  /* ***************************************************************
248  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
249 
250  If new enum values are added here, you MUST also go update the
251  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
252 
253  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
254  *************************************************************** */
256 
264 
270 
289 
307 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
308 
311 };
312 
321 union hwloc_obj_attr_u;
322 
325  hwloc_uint64_t total_memory;
326  hwloc_uint64_t local_memory;
329  unsigned page_types_len;
336  hwloc_uint64_t size;
337  hwloc_uint64_t count;
338  } * page_types;
339 };
340 
345 struct hwloc_obj {
346  /* physical information */
347  hwloc_obj_type_t type;
348  unsigned os_index;
352  char *name;
354  struct hwloc_obj_memory_s memory;
359  /* global position */
360  unsigned depth;
365  unsigned logical_index;
369  signed os_level;
371  /* cousins are all objects of the same type (and depth) across the entire topology */
375  /* children of the same parent are siblings, even if they may have different type and depth */
376  struct hwloc_obj *parent;
377  unsigned sibling_rank;
381  /* children array below this object */
382  unsigned arity;
383  struct hwloc_obj **children;
387  /* misc */
388  void *userdata;
393  /* cpusets and nodesets */
394  hwloc_cpuset_t cpuset;
407  hwloc_cpuset_t complete_cpuset;
418  hwloc_cpuset_t online_cpuset;
426  hwloc_cpuset_t allowed_cpuset;
437  hwloc_nodeset_t nodeset;
454  hwloc_nodeset_t complete_nodeset;
468  hwloc_nodeset_t allowed_nodeset;
482  unsigned distances_count;
483 
485  unsigned infos_count;
492 };
496 typedef struct hwloc_obj * hwloc_obj_t;
497 
502  hwloc_uint64_t size;
503  unsigned depth;
504  unsigned linesize;
507  hwloc_obj_cache_type_t type;
508  } cache;
511  unsigned depth;
512  } group;
515  unsigned short domain;
516  unsigned char bus, dev, func;
517  unsigned short class_id;
518  unsigned short vendor_id, device_id, subvendor_id, subdevice_id;
519  unsigned char revision;
520  float linkspeed; /* in GB/s */
521  } pcidev;
524  union {
526  } upstream;
527  hwloc_obj_bridge_type_t upstream_type;
528  union {
529  struct {
530  unsigned short domain;
531  unsigned char secondary_bus, subordinate_bus;
532  } pci;
533  } downstream;
534  hwloc_obj_bridge_type_t downstream_type;
535  unsigned depth;
536  } bridge;
539  hwloc_obj_osdev_type_t type;
540  } osdev;
541 };
542 
557  unsigned relative_depth;
559  unsigned nbobjs;
564  float *latency;
576  float latency_max;
577  float latency_base;
581 };
582 
585  char *name;
586  char *value;
587 };
588 
597 struct hwloc_topology;
602 typedef struct hwloc_topology * hwloc_topology_t;
603 
610 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
611 
629 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
630 
635 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
636 
644 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
645 
657 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
658 
695 HWLOC_DECLSPEC int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type);
696 
705 HWLOC_DECLSPEC int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type);
706 
713 HWLOC_DECLSPEC int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology);
714 
733 
753 
766 
775 
785 
793 };
794 
804 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
805 
812 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
813 
828 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
829 
856 HWLOC_DECLSPEC int hwloc_topology_set_fsroot(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict fsroot_path);
857 
885 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
886 
913 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
914 
941 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
942 
962 HWLOC_DECLSPEC int hwloc_topology_set_custom(hwloc_topology_t topology);
963 
981 HWLOC_DECLSPEC int hwloc_topology_set_distance_matrix(hwloc_topology_t __hwloc_restrict topology,
982  hwloc_obj_type_t type, unsigned nbobjs,
983  unsigned *os_index, float *distances);
984 
992 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
993 
997  unsigned char pu;
998 };
999 
1003  unsigned char set_thisproc_cpubind;
1005  unsigned char get_thisproc_cpubind;
1007  unsigned char set_proc_cpubind;
1009  unsigned char get_proc_cpubind;
1011  unsigned char set_thisthread_cpubind;
1013  unsigned char get_thisthread_cpubind;
1015  unsigned char set_thread_cpubind;
1017  unsigned char get_thread_cpubind;
1024 };
1025 
1029  unsigned char set_thisproc_membind;
1031  unsigned char get_thisproc_membind;
1033  unsigned char set_proc_membind;
1035  unsigned char get_proc_membind;
1037  unsigned char set_thisthread_membind;
1039  unsigned char get_thisthread_membind;
1041  unsigned char set_area_membind;
1043  unsigned char get_area_membind;
1045  unsigned char alloc_membind;
1047  unsigned char firsttouch_membind;
1049  unsigned char bind_membind;
1051  unsigned char interleave_membind;
1053  unsigned char replicate_membind;
1055  unsigned char nexttouch_membind;
1056 
1058  unsigned char migrate_membind;
1059 };
1060 
1071 };
1072 
1074 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
1075 
1086 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
1087 
1093 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
1094 
1112 HWLOC_DECLSPEC unsigned hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1113 
1136 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
1137 
1144 };
1145 
1155 static __hwloc_inline int
1156 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1157 
1167 static __hwloc_inline int
1168 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1169 
1176 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1177 
1180 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1181 
1187 static __hwloc_inline int
1188 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1189 
1195 static __hwloc_inline hwloc_obj_t
1196 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
1197 
1199 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, unsigned depth, unsigned idx) __hwloc_attribute_pure;
1200 
1207 static __hwloc_inline hwloc_obj_t
1208 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
1209 
1214 static __hwloc_inline hwloc_obj_t
1215 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev);
1216 
1223 static __hwloc_inline hwloc_obj_t
1224 hwloc_get_next_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type,
1225  hwloc_obj_t prev);
1226 
1236 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
1237 
1264 HWLOC_DECLSPEC int hwloc_obj_type_sscanf(const char *string,
1265  hwloc_obj_type_t *typep,
1266  int *depthattrp,
1267  void *typeattrp, size_t typeattrsize);
1268 
1279 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj,
1280  int verbose);
1281 
1293 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj, const char * __hwloc_restrict separator,
1294  int verbose);
1295 
1303 HWLOC_DECLSPEC int hwloc_obj_cpuset_snprintf(char * __hwloc_restrict str, size_t size, size_t nobj, const hwloc_obj_t * __hwloc_restrict objs);
1304 
1311 static __hwloc_inline const char *
1312 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1313 
1328 HWLOC_DECLSPEC void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1329 
1398 typedef enum {
1402 
1406 
1431 
1449 
1455 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1456 
1462 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1463 
1475 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1476 
1488 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1489 
1490 #ifdef hwloc_thread_t
1491 
1498 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1499 #endif
1500 
1501 #ifdef hwloc_thread_t
1502 
1509 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1510 #endif
1511 
1525 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1526 
1543 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1544 
1621 typedef enum {
1628 
1638 
1642 
1651 
1664 
1671 
1678 
1692 typedef enum {
1698 
1703 
1711 
1717 
1731 
1744 HWLOC_DECLSPEC int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags);
1745 
1759 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags);
1760 
1801 HWLOC_DECLSPEC int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t * policy, int flags);
1802 
1848 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_cpuset_t cpuset, hwloc_membind_policy_t * policy, int flags);
1849 
1859 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);
1860 
1870 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);
1871 
1908 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);
1909 
1949 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);
1950 
1957 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);
1958 
1965 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);
1966 
1989 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);
1990 
2015 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);
2016 
2024 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
2025 
2037 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;
2038 
2050 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;
2051 
2058 static __hwloc_inline void *
2059 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;
2060 
2065 static __hwloc_inline void *
2066 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;
2067 
2071 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
2072 
2095 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, const char *name);
2096 
2112 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2113 
2121 
2127 
2133 };
2134 
2156 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags);
2157 
2191 HWLOC_DECLSPEC int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2192 
2214 HWLOC_DECLSPEC hwloc_obj_t hwloc_custom_insert_group_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, int groupdepth);
2215 
2241 HWLOC_DECLSPEC int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath);
2242 
2261 HWLOC_DECLSPEC int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen);
2262 
2264 HWLOC_DECLSPEC void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer);
2265 
2284 HWLOC_DECLSPEC void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology,
2285  void (*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2286 
2312 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);
2313 
2327 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);
2328 
2351 HWLOC_DECLSPEC void hwloc_topology_set_userdata_import_callback(hwloc_topology_t topology,
2352  void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length));
2353 
2372 
2380 };
2381 
2400  HWLOC_DECLSPEC int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags);
2401 
2406 #ifdef __cplusplus
2407 } /* extern "C" */
2408 #endif
2409 
2410 
2411 /* high-level helpers */
2412 #include <hwloc/helper.h>
2413 
2414 /* inline code of some functions above */
2415 #include <hwloc/inlines.h>
2416 
2417 /* topology diffs */
2418 #include <hwloc/diff.h>
2419 
2420 /* deprecated headers */
2421 #include <hwloc/deprecated.h>
2422 
2423 #endif /* HWLOC_H */
struct hwloc_distances_s ** distances
Distances between all objects at same depth below this object.
Definition: hwloc.h:481
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:534
Structure of a topology object.
Definition: hwloc.h:345
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:752
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a stringified topology object type.
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_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.
Distances between objects.
Definition: hwloc.h:556
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:1670
Replicate memory on the given nodes; reads from this memory will attempt to be serviced from the NUMA...
Definition: hwloc.h:1663
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:1019
unsigned char migrate_membind
Definition: hwloc.h:1058
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
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.
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:1729
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.
Virtual depth for PCI device object level.
Definition: hwloc.h:1142
Detect PCI bridges.
Definition: hwloc.h:774
PCI-side of a bridge.
Definition: hwloc.h:268
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:335
unsigned char get_thisthread_membind
Definition: hwloc.h:1039
char * name
Info name.
Definition: hwloc.h:585
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.
int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags)
Bind current process or thread on cpus given in physical bitmap set.
unsigned char set_proc_membind
Definition: hwloc.h:1033
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1401
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
hwloc_get_type_depth_e
Definition: hwloc.h:1138
float latency_base
The multiplier that should be applied to latency matrix to retrieve the original OS-provided latencie...
Definition: hwloc.h:577
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:282
int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen)
Export the topology into a newly-allocated XML memory buffer.
unsigned depth
Definition: hwloc.h:535
Set of flags describing actual support for this topology.
Definition: hwloc.h:1067
Detect instruction caches.
Definition: hwloc.h:792
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:347
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
PCI Device specific Object Attributes.
Definition: hwloc.h:514
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.
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:1023
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 ...
Request for strict binding from the OS.
Definition: hwloc.h:1430
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
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.
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:507
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.
unsigned short class_id
Definition: hwloc.h:517
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.
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:394
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...
hwloc_uint64_t total_memory
Total memory (in bytes) in this object and its children.
Definition: hwloc.h:325
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:329
int hwloc_free(hwloc_topology_t topology, void *addr, size_t len)
Free memory that was previously allocated by hwloc_alloc() or hwloc_alloc_membind().
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:365
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.
unsigned char get_area_membind
Definition: hwloc.h:1043
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.
unsigned short domain
Definition: hwloc.h:530
float linkspeed
Definition: hwloc.h:520
unsigned sibling_rank
Index in parent&#39;s children[] array.
Definition: hwloc.h:377
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:602
int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the current process or thread...
unsigned char set_area_membind
Definition: hwloc.h:1041
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.
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:50
Group-specific Object Attributes.
Definition: hwloc.h:510
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:376
Detect the whole PCI hierarchy.
Definition: hwloc.h:784
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
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.
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:418
unsigned char get_thread_cpubind
Definition: hwloc.h:1017
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:356
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...
Whole system (may be a cluster of machines). The whole system that is accessible to hwloc...
Definition: hwloc.h:174
NUMA node. A set of processors around memory which the processors can directly access.
Definition: hwloc.h:184
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:504
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:527
char * name
Object description if any.
Definition: hwloc.h:352
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
Detect PCI devices.
Definition: hwloc.h:765
int hwloc_topology_set_custom(hwloc_topology_t topology)
Prepare the topology for custom assembly.
unsigned char subordinate_bus
Definition: hwloc.h:531
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1716
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR&#39;ed flags of a topology.
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, unsigned depth)
Returns the type of objects at depth depth.
Bridge specific Object Attribues.
Definition: hwloc.h:523
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:1021
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...
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:502
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:1027
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...
unsigned char nexttouch_membind
Definition: hwloc.h:1055
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
Adapt distance matrices according to objects being removed during restriction. If this flag is not se...
Definition: hwloc.h:2120
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2126
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:388
unsigned char interleave_membind
Definition: hwloc.h:1051
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
unsigned char alloc_membind
Definition: hwloc.h:1045
unsigned distances_count
Definition: hwloc.h:482
Machine. The typical root object type. A set of processors and memory with cache coherency.
Definition: hwloc.h:179
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which process the topology is viewed from.
float * latency
Matrix of latencies between objects, stored as a one-dimension array. May be NULL if the distances co...
Definition: hwloc.h:564
unsigned char bind_membind
Definition: hwloc.h:1049
unsigned char set_thisthread_cpubind
Definition: hwloc.h:1011
hwloc_topology_export_synthetic_flags_e
Flags for exporting synthetic topologies.
Definition: hwloc.h:2365
unsigned char set_thisthread_membind
Definition: hwloc.h:1037
void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer)
Free a buffer allocated by hwloc_topology_export_xmlbuffer()
Object info.
Definition: hwloc.h:584
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:373
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.
unsigned char get_proc_cpubind
Definition: hwloc.h:1009
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:326
struct hwloc_obj_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:484
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
unsigned infos_count
Size of infos array.
Definition: hwloc.h:485
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:272
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:258
unsigned char set_proc_cpubind
Definition: hwloc.h:1007
signed os_level
OS-provided physical level, -1 if unknown or meaningless.
Definition: hwloc.h:369
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.
Data cache.
Definition: hwloc.h:260
int symmetric_subtree
Set if the subtree of objects below this object is symmetric, which means all children and their chil...
Definition: hwloc.h:487
OS Device specific Object Attributes.
Definition: hwloc.h:538
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:337
unsigned char replicate_membind
Definition: hwloc.h:1053
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:266
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...
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.
Definition: hwloc.h:1710
unsigned char get_proc_membind
Definition: hwloc.h:1035
Bind current thread of current process.
Definition: hwloc.h:1405
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:208
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.
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1676
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1621
void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value)
Add the given info name and value pair to the given object.
unsigned relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:557
int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type.
unsigned char get_thisthread_cpubind
Definition: hwloc.h:1013
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:164
unsigned char set_thread_cpubind
Definition: hwloc.h:1015
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA device on Linux...
Definition: hwloc.h:280
Virtual depth for bridge object level.
Definition: hwloc.h:1141
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:148
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.
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR&#39;ed flags to non-yet-loaded topology.
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.
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.
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:234
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.
Do not export level attributes.
Definition: hwloc.h:2379
unsigned arity
Number of children.
Definition: hwloc.h:382
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1650
unsigned char firsttouch_membind
Definition: hwloc.h:1047
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 depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:503
Instruction cache. Only used when the HWLOC_TOPOLOGY_FLAG_ICACHES topology flag is set...
Definition: hwloc.h:261
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.
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:199
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.
unsigned nbobjs
Number of objects considered in the matrix. It is the number of descendant objects at relative_depth ...
Definition: hwloc.h:559
Object type-specific Attributes.
Definition: hwloc.h:499
Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allo...
Definition: hwloc.h:1637
unsigned depth
Depth of group object.
Definition: hwloc.h:511
unsigned char func
Definition: hwloc.h:516
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 char set_thisproc_membind
Definition: hwloc.h:1029
No object of given type exists in the topology.
Definition: hwloc.h:1139
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:385
Flags describing actual discovery support for this topology.
Definition: hwloc.h:995
float latency_max
The maximal value in the latency matrix.
Definition: hwloc.h:576
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:496
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:348
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:278
unsigned short vendor_id
Definition: hwloc.h:518
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1702
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.
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:426
unsigned char get_thisproc_cpubind
Definition: hwloc.h:1005
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:1069
Operating system co-processor device. For instance "mic0" for a Xeon Phi (MIC) on Linux...
Definition: hwloc.h:284
unsigned hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
Miscellaneous objects. Objects without particular meaning, that can e.g. be added by the application ...
Definition: hwloc.h:221
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:720
Allocate memory on the specified nodes.
Definition: hwloc.h:1641
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1697
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1070
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
struct hwloc_obj_memory_s::hwloc_obj_memory_page_type_s * page_types
unsigned char set_thisproc_cpubind
Definition: hwloc.h:1003
Cache. Can be L1i, L1d, L2, L3, ...
Definition: hwloc.h:192
Virtual depth for software device object level.
Definition: hwloc.h:1143
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())...
hwloc_compare_types_e
Definition: hwloc.h:309
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:128
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.
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:195
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2132
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...
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:1001
struct hwloc_obj * prev_sibling
Previous object below the same parent.
Definition: hwloc.h:379
hwloc_nodeset_t allowed_nodeset
The set of allowed NUMA memory nodes.
Definition: hwloc.h:468
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:454
Value returned by hwloc_compare_types() when types can not be compared.
Definition: hwloc.h:310
static hwloc_obj_t hwloc_get_next_obj_by_depth(hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev)
Returns the next object at depth depth.
int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type if it does not bring any structure.
hwloc_obj_osdev_type_t type
Definition: hwloc.h:539
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:997
Bridge. Any bridge that connects the host or an I/O bus, to another I/O bus. Bridge objects have neit...
Definition: hwloc.h:227
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:505
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2115
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:407
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:437
Avoid any effect on memory binding.
Definition: hwloc.h:1447
Unified cache.
Definition: hwloc.h:259
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:267
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:383
Object memory.
Definition: hwloc.h:324
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1140
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:275
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1068
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.
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1398
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:52
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.
unsigned depth
Vertical index in the hierarchy. If the topology is symmetric, this is equal to the parent depth plus...
Definition: hwloc.h:360
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.
Reset the memory allocation policy to the system default. Depending on the operating system...
Definition: hwloc.h:1627
Operating system block device. For instance "sda" on Linux.
Definition: hwloc.h:273
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
Operating system device. These objects have neither CPU sets nor node sets. They are not added to the...
Definition: hwloc.h:239
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:126
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.
struct hwloc_obj * next_sibling
Next object below the same parent.
Definition: hwloc.h:378
Detect the whole system, ignore reservations and offline settings.
Definition: hwloc.h:732
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:372
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology)
Ignore all objects that do not bring any structure.
Physical package, what goes into a socket. In the physical meaning, i.e. that you can add or remove p...
Definition: hwloc.h:188
Export extended types such as L2dcache as basic types such as Cache.
Definition: hwloc.h:2371
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.
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:145
int hwloc_get_proc_membind_nodeset(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_nodeset_t nodeset, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the specified process.
unsigned char get_thisproc_membind
Definition: hwloc.h:1031
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:336
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
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...
Cache-specific Object Attributes.
Definition: hwloc.h:501
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, unsigned depth)
Returns the width of level at depth depth.
int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath)
Export the topology into an XML file.
unsigned char revision
Definition: hwloc.h:519
unsigned short domain
Definition: hwloc.h:515
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.
struct hwloc_obj * first_child
First child.
Definition: hwloc.h:384
char * value
Info value.
Definition: hwloc.h:586
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1692