Hardware Locality (hwloc)  1.11.9
hwloc.h
1 /*
2  * Copyright © 2009 CNRS
3  * Copyright © 2009-2017 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 
89 #define HWLOC_API_VERSION 0x00010b06
90 
95 HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);
96 
98 #define HWLOC_COMPONENT_ABI 4
99 
136 
156 
171 typedef enum {
172  /* ***************************************************************
173  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
174 
175  If new enum values are added here, you MUST also go update the
176  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
177 
178  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
179  *************************************************************** */
180 
258  HWLOC_OBJ_TYPE_MAX
260  /* ***************************************************************
261  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
262 
263  If new enum values are added here, you MUST also go update the
264  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
265 
266  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
267  *************************************************************** */
269 
277 
283 
303 
321 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
322 
325 };
326 
335 union hwloc_obj_attr_u;
336 
339  hwloc_uint64_t total_memory;
340  hwloc_uint64_t local_memory;
343  unsigned page_types_len;
350  hwloc_uint64_t size;
351  hwloc_uint64_t count;
352  } * page_types;
353 };
354 
359 struct hwloc_obj {
360  /* physical information */
361  hwloc_obj_type_t type;
363  unsigned os_index;
367  char *name;
372  struct hwloc_obj_memory_s memory;
377  /* global position */
378  unsigned depth;
393  unsigned logical_index;
397  signed os_level;
399  /* cousins are all objects of the same type (and depth) across the entire topology */
403  /* children of the same parent are siblings, even if they may have different type and depth */
404  struct hwloc_obj *parent;
405  unsigned sibling_rank;
409  /* children array below this object */
410  unsigned arity;
411  struct hwloc_obj **children;
415  /* misc */
416  void *userdata;
421  /* cpusets and nodesets */
422  hwloc_cpuset_t cpuset;
435  hwloc_cpuset_t complete_cpuset;
446  hwloc_cpuset_t online_cpuset;
454  hwloc_cpuset_t allowed_cpuset;
465  hwloc_nodeset_t nodeset;
482  hwloc_nodeset_t complete_nodeset;
496  hwloc_nodeset_t allowed_nodeset;
510  unsigned distances_count;
511 
513  unsigned infos_count;
520 };
524 typedef struct hwloc_obj * hwloc_obj_t;
525 
530  hwloc_uint64_t size;
531  unsigned depth;
532  unsigned linesize;
535  hwloc_obj_cache_type_t type;
536  } cache;
539  unsigned depth;
540  } group;
543  unsigned short domain;
544  unsigned char bus, dev, func;
545  unsigned short class_id;
546  unsigned short vendor_id, device_id, subvendor_id, subdevice_id;
547  unsigned char revision;
548  float linkspeed; /* in GB/s */
549  } pcidev;
552  union {
554  } upstream;
555  hwloc_obj_bridge_type_t upstream_type;
556  union {
557  struct {
558  unsigned short domain;
559  unsigned char secondary_bus, subordinate_bus;
560  } pci;
561  } downstream;
562  hwloc_obj_bridge_type_t downstream_type;
563  unsigned depth;
564  } bridge;
567  hwloc_obj_osdev_type_t type;
568  } osdev;
569 };
570 
585  unsigned relative_depth;
587  unsigned nbobjs;
592  float *latency;
604  float latency_max;
605  float latency_base;
609 };
610 
616  char *name;
617  char *value;
618 };
619 
628 struct hwloc_topology;
633 typedef struct hwloc_topology * hwloc_topology_t;
634 
641 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
642 
663 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
664 
669 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
670 
681 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
682 
694 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
695 
732 HWLOC_DECLSPEC int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type);
733 
742 HWLOC_DECLSPEC int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type);
743 
750 HWLOC_DECLSPEC int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology);
751 
774 
794 
807 
816 
826 
834 
855 };
856 
866 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
867 
874 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
875 
890 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
891 
918 HWLOC_DECLSPEC int hwloc_topology_set_fsroot(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict fsroot_path);
919 
947 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
948 
975 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
976 
1003 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
1004 
1024 HWLOC_DECLSPEC int hwloc_topology_set_custom(hwloc_topology_t topology);
1025 
1044 HWLOC_DECLSPEC int hwloc_topology_set_distance_matrix(hwloc_topology_t __hwloc_restrict topology,
1045  hwloc_obj_type_t type, unsigned nbobjs,
1046  unsigned *os_index, float *distances);
1047 
1055 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1056 
1060  unsigned char pu;
1061 };
1062 
1070  unsigned char set_thisproc_cpubind;
1072  unsigned char get_thisproc_cpubind;
1074  unsigned char set_proc_cpubind;
1076  unsigned char get_proc_cpubind;
1078  unsigned char set_thisthread_cpubind;
1080  unsigned char get_thisthread_cpubind;
1082  unsigned char set_thread_cpubind;
1084  unsigned char get_thread_cpubind;
1091 };
1092 
1100  unsigned char set_thisproc_membind;
1102  unsigned char get_thisproc_membind;
1104  unsigned char set_proc_membind;
1106  unsigned char get_proc_membind;
1108  unsigned char set_thisthread_membind;
1110  unsigned char get_thisthread_membind;
1112  unsigned char set_area_membind;
1114  unsigned char get_area_membind;
1116  unsigned char alloc_membind;
1118  unsigned char firsttouch_membind;
1120  unsigned char bind_membind;
1122  unsigned char interleave_membind;
1124  unsigned char replicate_membind;
1126  unsigned char nexttouch_membind;
1128  unsigned char migrate_membind;
1130  unsigned char get_area_memlocation;
1131 };
1132 
1143 };
1144 
1154 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
1155 
1166 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
1167 
1173 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
1174 
1195 HWLOC_DECLSPEC unsigned hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1196 
1221 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
1222 
1229 };
1230 
1240 static __hwloc_inline int
1241 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1242 
1252 static __hwloc_inline int
1253 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1254 
1261 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1262 
1265 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1266 
1272 static __hwloc_inline int
1273 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1274 
1280 static __hwloc_inline hwloc_obj_t
1281 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
1282 
1284 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, unsigned depth, unsigned idx) __hwloc_attribute_pure;
1285 
1292 static __hwloc_inline hwloc_obj_t
1293 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
1294 
1299 static __hwloc_inline hwloc_obj_t
1300 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev);
1301 
1308 static __hwloc_inline hwloc_obj_t
1309 hwloc_get_next_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type,
1310  hwloc_obj_t prev);
1311 
1327 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
1328 
1342 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj,
1343  int verbose);
1344 
1356 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj, const char * __hwloc_restrict separator,
1357  int verbose);
1358 
1366 HWLOC_DECLSPEC int hwloc_obj_cpuset_snprintf(char * __hwloc_restrict str, size_t size, size_t nobj, const hwloc_obj_t * __hwloc_restrict objs);
1367 
1397 HWLOC_DECLSPEC int hwloc_obj_type_sscanf(const char *string,
1398  hwloc_obj_type_t *typep,
1399  int *depthattrp,
1400  void *typeattrp, size_t typeattrsize);
1401 
1417 static __hwloc_inline const char *
1418 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1419 
1434 HWLOC_DECLSPEC void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1435 
1504 typedef enum {
1508 
1512 
1537 
1555 
1561 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1562 
1568 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1569 
1581 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1582 
1594 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1595 
1596 #ifdef hwloc_thread_t
1597 
1604 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1605 #endif
1606 
1607 #ifdef hwloc_thread_t
1608 
1615 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1616 #endif
1617 
1631 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1632 
1649 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1650 
1732 typedef enum {
1743 
1753 
1757 
1766 
1779 
1786 
1793 
1807 typedef enum {
1813 
1818 
1826 
1832 
1845 
1858 
1871 HWLOC_DECLSPEC int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags);
1872 
1888 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
1889 
1931 HWLOC_DECLSPEC int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t * policy, int flags);
1932 
1977 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
1978 
1988 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);
1989 
2002 HWLOC_DECLSPEC int hwloc_set_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
2003 
2040 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);
2041 
2081 HWLOC_DECLSPEC int hwloc_get_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
2082 
2090 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);
2091 
2102 HWLOC_DECLSPEC int hwloc_set_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
2103 
2128 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);
2129 
2157 HWLOC_DECLSPEC int hwloc_get_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
2158 
2178 HWLOC_DECLSPEC int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags);
2179 
2187 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
2188 
2200 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;
2201 
2216 HWLOC_DECLSPEC void *hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags) __hwloc_attribute_malloc;
2217 
2224 static __hwloc_inline void *
2225 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;
2226 
2236 static __hwloc_inline void *
2237 hwloc_alloc_membind_policy(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags) __hwloc_attribute_malloc;
2238 
2242 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
2243 
2266 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, const char *name);
2267 
2283 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2284 
2292 
2298 
2304 };
2305 
2327 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags);
2328 
2362 HWLOC_DECLSPEC int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2363 
2385 HWLOC_DECLSPEC hwloc_obj_t hwloc_custom_insert_group_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, int groupdepth);
2386 
2412 HWLOC_DECLSPEC int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath);
2413 
2432 HWLOC_DECLSPEC int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen);
2433 
2435 HWLOC_DECLSPEC void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer);
2436 
2455 HWLOC_DECLSPEC void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology,
2456  void (*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2457 
2483 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);
2484 
2498 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);
2499 
2522 HWLOC_DECLSPEC void hwloc_topology_set_userdata_import_callback(hwloc_topology_t topology,
2523  void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length));
2524 
2543 
2551 };
2552 
2571  HWLOC_DECLSPEC int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags);
2572 
2577 #ifdef __cplusplus
2578 } /* extern "C" */
2579 #endif
2580 
2581 
2582 /* high-level helpers */
2583 #include <hwloc/helper.h>
2584 
2585 /* inline code of some functions above */
2586 #include <hwloc/inlines.h>
2587 
2588 /* topology diffs */
2589 #include <hwloc/diff.h>
2590 
2591 /* deprecated headers */
2592 #include <hwloc/deprecated.h>
2593 
2594 #endif /* HWLOC_H */
int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology)
Ignore all objects that do not bring any structure.
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:221
Virtual depth for bridge object level.
Definition: hwloc.h:1226
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:530
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
Allocate memory on the specified nodes.
Definition: hwloc.h:1756
Instruction cache. Only used when the HWLOC_TOPOLOGY_FLAG_ICACHES topology flag is set...
Definition: hwloc.h:274
struct hwloc_obj * next_sibling
Next object below the same parent.
Definition: hwloc.h:406
OS Device specific Object Attributes.
Definition: hwloc.h:566
float latency_max
The maximal value in the latency matrix.
Definition: hwloc.h:604
unsigned char alloc_membind
Definition: hwloc.h:1116
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:393
unsigned arity
Number of children.
Definition: hwloc.h:410
hwloc_compare_types_e
Definition: hwloc.h:323
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR&#39;ed flags of a topology.
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1812
Operating system block device. For instance "sda" on Linux.
Definition: hwloc.h:286
unsigned sibling_rank
Index in parent&#39;s children[] array.
Definition: hwloc.h:405
Data cache.
Definition: hwloc.h:273
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.
unsigned char set_thisthread_membind
Definition: hwloc.h:1108
int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen)
Export the topology into a newly-allocated XML memory buffer.
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which process the topology is viewed from.
struct hwloc_obj_memory_s::hwloc_obj_memory_page_type_s * page_types
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:1141
char * name
Info name.
Definition: hwloc.h:616
Avoid any effect on CPU binding.
Definition: hwloc.h:1844
unsigned depth
Depth of group object.
Definition: hwloc.h:539
Do not export level attributes.
Definition: hwloc.h:2550
unsigned char get_thisthread_membind
Definition: hwloc.h:1110
int hwloc_get_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_bitmap_t set, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the specified process.
int hwloc_topology_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())...
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1831
int hwloc_topology_set_custom(hwloc_topology_t topology)
Prepare the topology for custom assembly.
Virtual depth for software device object level.
Definition: hwloc.h:1228
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:1098
Reset the memory allocation policy to the system default. Depending on the operating system...
Definition: hwloc.h:1742
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:152
unsigned infos_count
Size of infos array.
Definition: hwloc.h:513
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:271
Object info.
Definition: hwloc.h:615
void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer)
Free a buffer allocated by hwloc_topology_export_xmlbuffer()
unsigned short domain
Definition: hwloc.h:558
static void * hwloc_alloc_membind_policy_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by nodeset.
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:416
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:435
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:280
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:363
unsigned char get_thisproc_cpubind
Definition: hwloc.h:1072
static void * hwloc_alloc_membind_policy(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by set.
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1225
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 constant stringified 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 ).
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:155
float linkspeed
Definition: hwloc.h:548
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
unsigned short domain
Definition: hwloc.h:543
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.
Miscellaneous objects. Objects without particular meaning, that can e.g. be added by the application ...
Definition: hwloc.h:234
hwloc_obj_t hwloc_get_obj_by_depth(hwloc_topology_t topology, unsigned depth, unsigned idx)
Returns the topology object at logical index idx from depth depth.
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1732
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2303
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:53
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:562
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:171
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:285
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...
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:401
unsigned depth
Definition: hwloc.h:563
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:296
unsigned depth
Vertical index in the hierarchy.
Definition: hwloc.h:378
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 nbobjs
Number of objects considered in the matrix. It is the number of descendant objects at relative_depth ...
Definition: hwloc.h:587
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:531
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1817
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.
Detect the whole system, ignore reservations and offline settings.
Definition: hwloc.h:773
float latency_base
The multiplier that should be applied to latency matrix to retrieve the original OS-provided latencie...
Definition: hwloc.h:605
Cache. Can be L1i, L1d, L2, L3, ...
Definition: hwloc.h:205
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
int hwloc_free(hwloc_topology_t topology, void *addr, size_t len)
Free memory that was previously allocated by hwloc_alloc() or hwloc_alloc_membind().
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.
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:349
unsigned char bind_membind
Definition: hwloc.h:1120
int hwloc_set_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the specified process to prefer the NUMA node(s) specified b...
Whole system (may be a cluster of machines). The whole system that is accessible to hwloc...
Definition: hwloc.h:181
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 get_proc_membind
Definition: hwloc.h:1106
unsigned char revision
Definition: hwloc.h:547
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1142
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
Bridge. Any bridge that connects the host or an I/O bus, to another I/O bus. Bridge objects have neit...
Definition: hwloc.h:240
Operating system device. These objects have neither CPU sets nor node sets. They are not added to the...
Definition: hwloc.h:252
unsigned hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
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.
Bridge specific Object Attribues.
Definition: hwloc.h:551
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:757
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:1090
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_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:512
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:340
PCI-side of a bridge.
Definition: hwloc.h:281
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.
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 interleave_membind
Definition: hwloc.h:1122
Bind current thread of current process.
Definition: hwloc.h:1511
void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value)
Add the given info name and value pair to the given object.
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2286
unsigned char replicate_membind
Definition: hwloc.h:1124
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:1068
int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags)
Get the NUMA nodes where memory identified by (addr, len ) is physically allocated.
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.
Object type-specific Attributes.
Definition: hwloc.h:527
Distances between objects.
Definition: hwloc.h:584
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.
No object of given type exists in the topology.
Definition: hwloc.h:1224
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:212
unsigned char get_thread_cpubind
Definition: hwloc.h:1084
Adapt distance matrices according to objects being removed during restriction. If this flag is not se...
Definition: hwloc.h:2291
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:535
Value returned by hwloc_compare_types() when types can not be compared.
Definition: hwloc.h:324
Detect PCI bridges.
Definition: hwloc.h:815
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1807
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:1785
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:1060
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_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1140
NUMA node. An object that contains memory that is directly and byte-accessible to the host processors...
Definition: hwloc.h:191
unsigned relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:585
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:374
struct hwloc_obj * prev_sibling
Previous object below the same parent.
Definition: hwloc.h:407
hwloc_nodeset_t allowed_nodeset
The set of allowed NUMA memory nodes.
Definition: hwloc.h:496
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:524
Avoid any effect on memory binding.
Definition: hwloc.h:1553
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
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.
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...
hwloc_topology_export_synthetic_flags_e
Flags for exporting synthetic topologies.
Definition: hwloc.h:2536
unsigned char subordinate_bus
Definition: hwloc.h:559
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:1088
Replicate memory on the given nodes; reads from this memory will attempt to be serviced from the NUMA...
Definition: hwloc.h:1778
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1507
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:288
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:247
Set of flags describing actual support for this topology.
Definition: hwloc.h:1139
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.
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_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.
Flags describing actual discovery support for this topology.
Definition: hwloc.h:1058
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.
Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allo...
Definition: hwloc.h:1752
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1504
Virtual depth for PCI device object level.
Definition: hwloc.h:1227
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:135
struct hwloc_obj * first_child
First child.
Definition: hwloc.h:412
unsigned char func
Definition: hwloc.h:544
int hwloc_set_area_membind_nodeset(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) specified by nodeset...
float * latency
Matrix of latencies between objects, stored as a one-dimension array. May be NULL if the distances co...
Definition: hwloc.h:592
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:291
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
hwloc_get_type_depth_e
Definition: hwloc.h:1223
Machine. The typical root object type. A set of processors and memory with cache coherency.
Definition: hwloc.h:186
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2297
Object memory.
Definition: hwloc.h:338
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:343
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1765
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:208
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:404
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 set_thread_cpubind
Definition: hwloc.h:1082
void * hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by set.
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_cpubind
Definition: hwloc.h:1070
Consider the bitmap argument as a nodeset.
Definition: hwloc.h:1856
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
unsigned char get_thisthread_cpubind
Definition: hwloc.h:1080
unsigned char nexttouch_membind
Definition: hwloc.h:1126
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, unsigned depth)
Returns the width of level 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.
unsigned short vendor_id
Definition: hwloc.h:546
Definition: hwloc.h:1825
Unified cache.
Definition: hwloc.h:272
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.
Group-specific Object Attributes.
Definition: hwloc.h:538
int hwloc_get_membind(hwloc_topology_t topology, hwloc_bitmap_t set, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the current process or thread...
hwloc_uint64_t total_memory
Total memory (in bytes) in this object and its children.
Definition: hwloc.h:339
int symmetric_subtree
Set if the subtree of objects below this object is symmetric, which means all children and their chil...
Definition: hwloc.h:515
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1791
Physical package. The physical package that usually gets inserted into a socket on the motherboard...
Definition: hwloc.h:200
Structure of a topology object.
Definition: hwloc.h:359
unsigned char migrate_membind
Definition: hwloc.h:1128
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:482
Request for strict binding from the OS.
Definition: hwloc.h:1536
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:411
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.
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the current process or thread to prefer the NUMA node(s) spe...
unsigned char set_proc_membind
Definition: hwloc.h:1104
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:446
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR&#39;ed flags to non-yet-loaded topology.
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.
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA, or "hfi1_0" Omni-Path ...
Definition: hwloc.h:293
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_bitmap_t set, hwloc_membind_policy_t *policy, int flags)
Query the CPUs near the physical NUMA node(s) and binding policy of the memory identified by (addr...
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:279
unsigned char set_thisproc_membind
Definition: hwloc.h:1100
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.
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:1086
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:532
unsigned distances_count
Definition: hwloc.h:510
unsigned char set_thisthread_cpubind
Definition: hwloc.h:1078
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:367
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.
Detect instruction caches.
Definition: hwloc.h:833
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:465
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.
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:361
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:555
void * hwloc_alloc_membind_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by nodeset.
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 char get_area_memlocation
Definition: hwloc.h:1130
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:793
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
int hwloc_set_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) specified by set...
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:422
int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath)
Export the topology into an XML file.
unsigned char get_area_membind
Definition: hwloc.h:1114
unsigned char get_proc_cpubind
Definition: hwloc.h:1076
Cache-specific Object Attributes.
Definition: hwloc.h:529
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.
Detect the whole PCI hierarchy.
Definition: hwloc.h:825
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:633
Detect PCI devices.
Definition: hwloc.h:806
int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
unsigned char set_proc_cpubind
Definition: hwloc.h:1074
char * value
Info value.
Definition: hwloc.h:617
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:51
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.
Operating system co-processor device. For instance "mic0" for a Xeon Phi (MIC) on Linux...
Definition: hwloc.h:298
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.
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:351
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:350
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:133
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:413
unsigned short class_id
Definition: hwloc.h:545
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...
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:400
signed os_level
OS-provided physical level, -1 if unknown or meaningless.
Definition: hwloc.h:397
unsigned char set_area_membind
Definition: hwloc.h:1112
unsigned char get_thisproc_membind
Definition: hwloc.h:1102
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:454
unsigned char firsttouch_membind
Definition: hwloc.h:1118
Get the set of allowed resources from the local operating system even if the topology was loaded from...
Definition: hwloc.h:854
PCI Device specific Object Attributes.
Definition: hwloc.h:542
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, unsigned depth)
Returns the type of objects at depth depth.
struct hwloc_distances_s ** distances
Distances between all objects at same depth below this object.
Definition: hwloc.h:509
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:533
hwloc_obj_osdev_type_t type
Definition: hwloc.h:567
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
Export extended types such as L2dcache as basic types such as Cache.
Definition: hwloc.h:2542