Hardware Locality (hwloc)  1.10.0
hwloc.h
1 /*
2  * Copyright © 2009 CNRS
3  * Copyright © 2009-2014 Inria. All rights reserved.
4  * Copyright © 2009-2012 Université Bordeaux 1
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 0x00010a00
83 
85 HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);
86 
88 #define HWLOC_COMPONENT_ABI 4
89 
126 
146 
161 typedef enum {
162  /* ***************************************************************
163  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
164 
165  If new enum values are added here, you MUST also go update the
166  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
167 
168  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
169  *************************************************************** */
170 
242  /* ***************************************************************
243  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
244 
245  If new enum values are added here, you MUST also go update the
246  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
247 
248  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
249  *************************************************************** */
251 
259 
265 
284 
302 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
303 
306 };
307 
316 union hwloc_obj_attr_u;
317 
320  hwloc_uint64_t total_memory;
321  hwloc_uint64_t local_memory;
324  unsigned page_types_len;
331  hwloc_uint64_t size;
332  hwloc_uint64_t count;
333  } * page_types;
334 };
335 
340 struct hwloc_obj {
341  /* physical information */
343  unsigned os_index;
344  char *name;
351  /* global position */
352  unsigned depth;
357  unsigned logical_index;
359  signed os_level;
361  /* cousins are all objects of the same type (and depth) across the entire topology */
365  /* children of the same parent are siblings, even if they may have different type and depth */
366  struct hwloc_obj *parent;
367  unsigned sibling_rank;
371  /* children array below this object */
372  unsigned arity;
373  struct hwloc_obj **children;
377  /* misc */
378  void *userdata;
383  /* cpusets and nodesets */
384  hwloc_cpuset_t cpuset;
397  hwloc_cpuset_t complete_cpuset;
408  hwloc_cpuset_t online_cpuset;
416  hwloc_cpuset_t allowed_cpuset;
427  hwloc_nodeset_t nodeset;
444  hwloc_nodeset_t complete_nodeset;
458  hwloc_nodeset_t allowed_nodeset;
472  unsigned distances_count;
473 
475  unsigned infos_count;
482 };
486 typedef struct hwloc_obj * hwloc_obj_t;
487 
492  hwloc_uint64_t size;
493  unsigned depth;
494  unsigned linesize;
498  } cache;
501  unsigned depth;
502  } group;
505  unsigned short domain;
506  unsigned char bus, dev, func;
507  unsigned short class_id;
509  unsigned char revision;
510  float linkspeed; /* in GB/s */
511  } pcidev;
514  union {
516  } upstream;
518  union {
519  struct {
520  unsigned short domain;
522  } pci;
523  } downstream;
525  unsigned depth;
526  } bridge;
530  } osdev;
531 };
532 
548  unsigned relative_depth;
550  unsigned nbobjs;
555  float *latency;
560  float latency_max;
561  float latency_base;
565 };
566 
569  char *name;
570  char *value;
571 };
572 
581 struct hwloc_topology;
586 typedef struct hwloc_topology * hwloc_topology_t;
587 
594 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
595 
613 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
614 
619 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
620 
632 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
633 
668 HWLOC_DECLSPEC int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type);
669 
678 HWLOC_DECLSPEC int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type);
679 
687 HWLOC_DECLSPEC int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology);
688 
703 
723 
735 
744 
753 
761 };
762 
772 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
773 
780 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
781 
796 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
797 
824 HWLOC_DECLSPEC int hwloc_topology_set_fsroot(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict fsroot_path);
825 
853 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
854 
881 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
882 
909 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
910 
930 HWLOC_DECLSPEC int hwloc_topology_set_custom(hwloc_topology_t topology);
931 
949 HWLOC_DECLSPEC int hwloc_topology_set_distance_matrix(hwloc_topology_t __hwloc_restrict topology,
950  hwloc_obj_type_t type, unsigned nbobjs,
951  unsigned *os_index, float *distances);
952 
960 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
961 
965  unsigned char pu;
966 };
967 
971  unsigned char set_thisproc_cpubind;
973  unsigned char get_thisproc_cpubind;
975  unsigned char set_proc_cpubind;
977  unsigned char get_proc_cpubind;
979  unsigned char set_thisthread_cpubind;
981  unsigned char get_thisthread_cpubind;
983  unsigned char set_thread_cpubind;
985  unsigned char get_thread_cpubind;
992 };
993 
997  unsigned char set_thisproc_membind;
999  unsigned char get_thisproc_membind;
1001  unsigned char set_proc_membind;
1003  unsigned char get_proc_membind;
1005  unsigned char set_thisthread_membind;
1007  unsigned char get_thisthread_membind;
1009  unsigned char set_area_membind;
1011  unsigned char get_area_membind;
1013  unsigned char alloc_membind;
1015  unsigned char firsttouch_membind;
1017  unsigned char bind_membind;
1019  unsigned char interleave_membind;
1021  unsigned char replicate_membind;
1023  unsigned char nexttouch_membind;
1024 
1026  unsigned char migrate_membind;
1027 };
1028 
1039 };
1040 
1042 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
1043 
1054 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
1055 
1061 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
1062 
1080 HWLOC_DECLSPEC unsigned hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1081 
1104 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
1105 
1112 };
1113 
1123 static __hwloc_inline int
1124 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1125 
1135 static __hwloc_inline int
1136 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1137 
1142 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1143 
1146 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1147 
1153 static __hwloc_inline int
1154 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1155 
1161 static __hwloc_inline hwloc_obj_t
1162 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
1163 
1165 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, unsigned depth, unsigned idx) __hwloc_attribute_pure;
1166 
1173 static __hwloc_inline hwloc_obj_t
1174 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
1175 
1180 static __hwloc_inline hwloc_obj_t
1181 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev);
1182 
1189 static __hwloc_inline hwloc_obj_t
1190 hwloc_get_next_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type,
1191  hwloc_obj_t prev);
1192 
1202 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
1203 
1230 HWLOC_DECLSPEC int hwloc_obj_type_sscanf(const char *string,
1231  hwloc_obj_type_t *typep,
1232  int *depthattrp,
1233  void *typeattrp, size_t typeattrsize);
1234 
1245 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj,
1246  int verbose);
1247 
1259 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj, const char * __hwloc_restrict separator,
1260  int verbose);
1261 
1269 HWLOC_DECLSPEC int hwloc_obj_cpuset_snprintf(char * __hwloc_restrict str, size_t size, size_t nobj, const hwloc_obj_t * __hwloc_restrict objs);
1270 
1277 static __hwloc_inline const char *
1278 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1279 
1294 HWLOC_DECLSPEC void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1295 
1364 typedef enum {
1368 
1372 
1397 
1415 
1421 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1422 
1428 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1429 
1441 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1442 
1454 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1455 
1456 #ifdef hwloc_thread_t
1457 
1464 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1465 #endif
1466 
1467 #ifdef hwloc_thread_t
1468 
1475 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1476 #endif
1477 
1491 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1492 
1509 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1510 
1587 typedef enum {
1591 
1601 
1605 
1614 
1627 
1634 
1641 
1655 typedef enum {
1661 
1666 
1674 
1680 
1694 
1707 HWLOC_DECLSPEC int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags);
1708 
1722 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags);
1723 
1764 HWLOC_DECLSPEC int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t * policy, int flags);
1765 
1811 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_cpuset_t cpuset, hwloc_membind_policy_t * policy, int flags);
1812 
1822 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);
1823 
1833 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);
1834 
1871 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);
1872 
1912 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);
1913 
1920 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);
1921 
1928 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);
1929 
1952 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);
1953 
1978 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);
1979 
1987 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
1988 
2000 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;
2001 
2013 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;
2014 
2021 static __hwloc_inline void *
2022 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;
2023 
2028 static __hwloc_inline void *
2029 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;
2030 
2034 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
2035 
2058 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, const char *name);
2059 
2075 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2076 
2084 
2090 
2096 };
2097 
2119 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags);
2120 
2128 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
2129 
2163 HWLOC_DECLSPEC int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2164 
2186 HWLOC_DECLSPEC hwloc_obj_t hwloc_custom_insert_group_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, int groupdepth);
2187 
2213 HWLOC_DECLSPEC int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath);
2214 
2233 HWLOC_DECLSPEC int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen);
2234 
2236 HWLOC_DECLSPEC void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer);
2237 
2256 HWLOC_DECLSPEC void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology,
2257  void (*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2258 
2284 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);
2285 
2299 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);
2300 
2323 HWLOC_DECLSPEC void hwloc_topology_set_userdata_import_callback(hwloc_topology_t topology,
2324  void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length));
2325 
2344 
2352 };
2353 
2372  HWLOC_DECLSPEC int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags);
2373 
2378 #ifdef __cplusplus
2379 } /* extern "C" */
2380 #endif
2381 
2382 
2383 /* high-level helpers */
2384 #include <hwloc/helper.h>
2385 
2386 /* inline code of some functions above */
2387 #include <hwloc/inlines.h>
2388 
2389 /* topology diffs */
2390 #include <hwloc/diff.h>
2391 
2392 /* deprecated headers */
2393 #include <hwloc/deprecated.h>
2394 
2395 #endif /* HWLOC_H */
unsigned short class_id
Definition: hwloc.h:507
hwloc_obj_osdev_type_t type
Definition: hwloc.h:529
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:987
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@0 upstream
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.
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:253
Avoid any effect on CPU binding.
Definition: hwloc.h:1692
Detect the whole PCI hierarchy.
Definition: hwloc.h:752
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
Detect instruction caches.
Definition: hwloc.h:760
unsigned char get_proc_membind
Definition: hwloc.h:1003
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.
signed os_level
OS-provided physical level, -1 if unknown or meaningless.
Definition: hwloc.h:359
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:366
unsigned char get_thisproc_membind
Definition: hwloc.h:999
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
Replicate memory on the given nodes; reads from this memory will attempt to be serviced from the NUMA...
Definition: hwloc.h:1626
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:161
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:1364
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:494
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_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:261
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:330
Detect PCI bridges.
Definition: hwloc.h:743
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:142
unsigned char firsttouch_membind
Definition: hwloc.h:1015
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...
int hwloc_export_obj_userdata(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length)
Export some object userdata to XML.
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:332
unsigned arity
Number of children.
Definition: hwloc.h:372
void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer)
Free a buffer allocated by hwloc_topology_export_xmlbuffer()
Definition: hwloc.h:240
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.
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:331
hwloc_topology_export_synthetic_flags_e
Flags for exporting synthetic topologies.
Definition: hwloc.h:2337
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
struct hwloc_distances_s ** distances
Distances between all objects at same depth below this object.
Definition: hwloc.h:471
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2089
unsigned char secondary_bus
Definition: hwloc.h:521
struct hwloc_obj_memory_s::hwloc_obj_memory_page_type_s * page_types
static hwloc_obj_t hwloc_get_obj_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx)
Returns the topology object at logical index idx with type type.
unsigned char interleave_membind
Definition: hwloc.h:1019
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1367
PCI Device specific Object Attributes.
Definition: hwloc.h:504
Bridge specific Object Attribues.
Definition: hwloc.h:513
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:991
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, unsigned depth)
Returns the width of level at depth depth.
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:267
unsigned depth
Vertical index in the hierarchy. If the topology is symmetric, this is equal to the parent depth plus...
Definition: hwloc.h:352
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:694
unsigned short subdevice_id
Definition: hwloc.h:508
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:722
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1036
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:497
char * name
Object description if any.
Definition: hwloc.h:344
float latency_base
The multiplier that should be applied to latency matrix to retrieve the original OS-provided latencie...
Definition: hwloc.h:561
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 ).
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:52
Group-specific Object Attributes.
Definition: hwloc.h:500
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:493
unsigned short vendor_id
Definition: hwloc.h:508
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:524
unsigned char get_area_membind
Definition: hwloc.h:1011
hwloc_compare_types_e
Definition: hwloc.h:304
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
Adapt distance matrices according to objects being removed during restriction. If this flag is not se...
Definition: hwloc.h:2083
unsigned char set_area_membind
Definition: hwloc.h:1009
unsigned char bus
Definition: hwloc.h:506
Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allo...
Definition: hwloc.h:1600
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
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.
unsigned relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:548
Reset the memory allocation policy to the system default.
Definition: hwloc.h:1590
int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology)
Ignore all objects that do not bring any structure.
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...
struct hwloc_obj_attr_u::hwloc_bridge_attr_s bridge
unsigned depth
Definition: hwloc.h:525
struct hwloc_obj_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:474
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_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...
PCI-side of a bridge.
Definition: hwloc.h:263
Virtual depth for bridge object level.
Definition: hwloc.h:1109
char * value
Info value.
Definition: hwloc.h:570
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:205
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:492
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:969
unsigned char get_thisproc_cpubind
Definition: hwloc.h:973
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.
Allocate memory on the specified nodes.
Definition: hwloc.h:1604
unsigned char get_thread_cpubind
Definition: hwloc.h:985
OS Device specific Object Attributes.
Definition: hwloc.h:528
float linkspeed
Definition: hwloc.h:510
struct hwloc_obj * prev_sibling
Previous object below the same parent.
Definition: hwloc.h:369
hwloc_nodeset_t allowed_nodeset
The set of allowed NUMA memory nodes.
Definition: hwloc.h:458
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.
void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology, void(*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj))
Set the application-specific callback for exporting object userdata.
int hwloc_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...
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 page_types_len
Size of array page_types.
Definition: hwloc.h:324
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA device on Linux...
Definition: hwloc.h:275
int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags)
Bind a thread thread on cpus given in physical bitmap set.
unsigned char func
Definition: hwloc.h:506
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:965
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
unsigned char replicate_membind
Definition: hwloc.h:1021
unsigned nbobjs
Number of objects considered in the matrix. It is the number of descendant objects at relative_depth ...
Definition: hwloc.h:550
Detect PCI devices.
Definition: hwloc.h:734
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.
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR'ed flags of a topology.
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...
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.
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1038
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
unsigned char set_thisthread_membind
Definition: hwloc.h:1005
unsigned char get_proc_cpubind
Definition: hwloc.h:977
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:375
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:1633
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
Object info.
Definition: hwloc.h:568
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.
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.
unsigned char set_thread_cpubind
Definition: hwloc.h:983
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:348
struct hwloc_obj * first_child
First child.
Definition: hwloc.h:374
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2078
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:384
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:517
unsigned char dev
Definition: hwloc.h:506
int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags)
Get the last physical CPU where a process ran.
int hwloc_topology_set_custom(hwloc_topology_t topology)
Prepare the topology for custom assembly.
NUMA node. A set of processors around memory which the processors can directly access.
Definition: hwloc.h:181
float * latency
Matrix of latencies between objects, stored as a one-dimension array. May be NULL if the distances co...
Definition: hwloc.h:555
Avoid any effect on memory binding.
Definition: hwloc.h:1413
Operating system co-processor device. For instance "mic0" for a Xeon Phi (MIC) on Linux...
Definition: hwloc.h:279
unsigned short domain
Definition: hwloc.h:505
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:229
Whole system (may be a cluster of machines). The whole system that is accessible to hwloc...
Definition: hwloc.h:171
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:196
unsigned char subordinate_bus
Definition: hwloc.h:521
Machine. The typical root object type. A set of processors and memory with cache coherency.
Definition: hwloc.h:176
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:416
char * name
Info name.
Definition: hwloc.h:569
unsigned char set_proc_membind
Definition: hwloc.h:1001
Detect the whole system, ignore reservations and offline settings.
Definition: hwloc.h:702
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
Distances between objects.
Definition: hwloc.h:547
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:378
unsigned char bind_membind
Definition: hwloc.h:1017
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_get_type_depth_e
Definition: hwloc.h:1106
Definition: hwloc.h:1673
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
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...
Virtual depth for software device object level.
Definition: hwloc.h:1111
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:989
unsigned char nexttouch_membind
Definition: hwloc.h:1023
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())...
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.
unsigned char migrate_membind
Definition: hwloc.h:1026
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1108
int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags)
Get the current physical binding of process pid.
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1587
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1613
unsigned char get_thisthread_membind
Definition: hwloc.h:1007
struct hwloc_obj_attr_u::hwloc_group_attr_s group
Do not export level attributes.
Definition: hwloc.h:2351
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.
unsigned char set_proc_cpubind
Definition: hwloc.h:975
int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
Unified cache.
Definition: hwloc.h:254
unsigned logical_index
Horizontal index in the whole list of similar objects, could be a "cousin_rank" since it's the rank w...
Definition: hwloc.h:357
Object type-specific Attributes.
Definition: hwloc.h:489
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_export_xml(hwloc_topology_t topology, const char *xmlpath)
Export the topology into an XML file.
Data cache.
Definition: hwloc.h:255
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:270
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
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_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which pid the topology is viewed from.
Set of flags describing actual support for this topology.
Definition: hwloc.h:1035
unsigned sibling_rank
Index in parent's children[] array.
Definition: hwloc.h:367
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
Flags describing actual discovery support for this topology.
Definition: hwloc.h:963
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:427
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:486
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.
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:373
Operating system device. These objects have neither CPU sets nor node sets. They are not added to the...
Definition: hwloc.h:234
int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags)
Export the topology as a synthetic string.
Object memory.
Definition: hwloc.h:319
int symmetric_subtree
Set if the subtree of objects below this object is symmetric, which means all children and their chil...
Definition: hwloc.h:477
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 depth
Depth of group object.
Definition: hwloc.h:501
Bridge. Any bridge that connects the host or an I/O bus, to another I/O bus. Bridge objects have neit...
Definition: hwloc.h:222
unsigned char set_thisproc_membind
Definition: hwloc.h:997
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1665
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.
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:262
struct hwloc_obj * next_sibling
Next object below the same parent.
Definition: hwloc.h:368
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:125
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1660
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:362
unsigned short subvendor_id
Definition: hwloc.h:508
unsigned infos_count
Size of infos array.
Definition: hwloc.h:475
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:397
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:145
Socket, physical package, or chip. In the physical meaning, i.e. that you can add or remove physicall...
Definition: hwloc.h:185
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, unsigned depth)
Returns the type of objects at depth depth.
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.
Request for strict binding from the OS.
Definition: hwloc.h:1396
struct hwloc_obj_attr_u::hwloc_cache_attr_s cache
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2095
unsigned short domain
Definition: hwloc.h:520
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen)
Export the topology into a newly-allocated XML memory buffer.
Operating system block device. For instance "sda" on Linux.
Definition: hwloc.h:268
Cache-specific Object Attributes.
Definition: hwloc.h:491
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:408
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
unsigned char alloc_membind
Definition: hwloc.h:1013
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:495
unsigned char set_thisthread_cpubind
Definition: hwloc.h:979
int hwloc_topology_set_distance_matrix(hwloc_topology_t restrict topology, hwloc_obj_type_t type, unsigned nbobjs, unsigned *os_index, float *distances)
Provide a distance matrix.
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR'ed flags to non-yet-loaded topology.
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...
struct hwloc_pcidev_attr_s pci
Definition: hwloc.h:515
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1655
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:273
unsigned char revision
Definition: hwloc.h:509
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a stringified topology object type.
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:1037
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
Miscellaneous objects. Objects without particular meaning, that can e.g. be added by the application ...
Definition: hwloc.h:217
unsigned distances_count
Definition: hwloc.h:472
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:321
No object of given type exists in the topology.
Definition: hwloc.h:1107
Export extended types such as L2dcache as basic types such as Cache.
Definition: hwloc.h:2343
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:995
int hwloc_obj_cpuset_snprintf(char *restrict str, size_t size, size_t nobj, const hwloc_obj_t *restrict objs)
Stringify the cpuset containing a set of objects.
unsigned char set_thisproc_cpubind
Definition: hwloc.h:971
Cache. Can be L1i, L1d, L2, L3, ...
Definition: hwloc.h:189
Instruction cache. Only used when the HWLOC_TOPOLOGY_FLAG_ICACHES topology flag is set...
Definition: hwloc.h:256
unsigned os_index
OS-provided physical index number.
Definition: hwloc.h:343
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:123
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:277
struct hwloc_obj_memory_s memory
Memory attributes.
Definition: hwloc.h:346
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:363
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:444
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
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:586
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:192
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.
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1679
int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type.
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...
Bind current thread of current process.
Definition: hwloc.h:1371
unsigned char get_thisthread_cpubind
Definition: hwloc.h:981
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
Value returned by hwloc_compare_types when types can not be compared.
Definition: hwloc.h:305
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.
unsigned short device_id
Definition: hwloc.h:508
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1639
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:342
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
Virtual depth for PCI device object level.
Definition: hwloc.h:1110
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...
unsigned hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
float latency_max
The maximal value in the latency matrix.
Definition: hwloc.h:560
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 ...
Structure of a topology object.
Definition: hwloc.h:340
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
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_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_uint64_t total_memory
Total memory (in bytes) in this object and its children.
Definition: hwloc.h:320