Open MPI logo

Portable Hardware Locality (hwloc) Documentation: v1.8

  |   Home   |   Support   |   FAQ   |  
hwloc.h
1 /*
2  * Copyright © 2009 CNRS
3  * Copyright © 2009-2013 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  *=====================================================================*/
38 
47 #ifndef HWLOC_H
48 #define HWLOC_H
49 
50 #include <hwloc/autogen/config.h>
51 #include <sys/types.h>
52 #include <stdio.h>
53 #include <string.h>
54 #include <limits.h>
55 
56 /*
57  * Symbol transforms
58  */
59 #include <hwloc/rename.h>
60 
61 /*
62  * Bitmap definitions
63  */
64 
65 #include <hwloc/bitmap.h>
66 
67 
68 #ifdef __cplusplus
69 extern "C" {
70 #endif
71 
72 
78 #define HWLOC_API_VERSION 0x00010800
79 
81 HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);
82 
84 #define HWLOC_COMPONENT_ABI 3
85 
119 
137 
152 typedef enum {
153  /* ***************************************************************
154  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
155 
156  If new enum values are added here, you MUST also go update the
157  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
158 
159  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
160  *************************************************************** */
161 
233  /* ***************************************************************
234  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
235 
236  If new enum values are added here, you MUST also go update the
237  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
238 
239  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
240  *************************************************************** */
242 
250 
256 
275 
293 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
294 
297 };
298 
307 union hwloc_obj_attr_u;
308 
311  hwloc_uint64_t total_memory;
312  hwloc_uint64_t local_memory;
315  unsigned page_types_len;
322  hwloc_uint64_t size;
323  hwloc_uint64_t count;
324  } * page_types;
325 };
326 
331 struct hwloc_obj {
332  /* physical information */
334  unsigned os_index;
335  char *name;
342  /* global position */
343  unsigned depth;
348  unsigned logical_index;
350  signed os_level;
352  /* cousins are all objects of the same type (and depth) across the entire topology */
356  /* children of the same parent are siblings, even if they may have different type and depth */
357  struct hwloc_obj *parent;
358  unsigned sibling_rank;
362  /* children array below this object */
363  unsigned arity;
364  struct hwloc_obj **children;
368  /* misc */
369  void *userdata;
374  /* cpusets and nodesets */
375  hwloc_cpuset_t cpuset;
388  hwloc_cpuset_t complete_cpuset;
399  hwloc_cpuset_t online_cpuset;
407  hwloc_cpuset_t allowed_cpuset;
418  hwloc_nodeset_t nodeset;
435  hwloc_nodeset_t complete_nodeset;
449  hwloc_nodeset_t allowed_nodeset;
463  unsigned distances_count;
464 
466  unsigned infos_count;
473 };
477 typedef struct hwloc_obj * hwloc_obj_t;
478 
483  hwloc_uint64_t size;
484  unsigned depth;
485  unsigned linesize;
489  } cache;
492  unsigned depth;
493  } group;
496  unsigned short domain;
497  unsigned char bus, dev, func;
498  unsigned short class_id;
500  unsigned char revision;
501  float linkspeed; /* in GB/s */
502  } pcidev;
505  union {
507  } upstream;
509  union {
510  struct {
511  unsigned short domain;
513  } pci;
514  } downstream;
516  unsigned depth;
517  } bridge;
521  } osdev;
522 };
523 
539  unsigned relative_depth;
541  unsigned nbobjs;
546  float *latency;
551  float latency_max;
552  float latency_base;
556 };
557 
560  char *name;
561  char *value;
562 };
563 
572 struct hwloc_topology;
577 typedef struct hwloc_topology * hwloc_topology_t;
578 
585 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
586 
604 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
605 
610 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
611 
623 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
624 
659 HWLOC_DECLSPEC int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type);
660 
669 HWLOC_DECLSPEC int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type);
670 
678 HWLOC_DECLSPEC int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology);
679 
694 
714 
726 
735 
744 
752 };
753 
763 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
764 
771 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
772 
787 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
788 
815 HWLOC_DECLSPEC int hwloc_topology_set_fsroot(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict fsroot_path);
816 
844 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
845 
872 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
873 
900 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
901 
921 HWLOC_DECLSPEC int hwloc_topology_set_custom(hwloc_topology_t topology);
922 
940 HWLOC_DECLSPEC int hwloc_topology_set_distance_matrix(hwloc_topology_t __hwloc_restrict topology,
941  hwloc_obj_type_t type, unsigned nbobjs,
942  unsigned *os_index, float *distances);
943 
951 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
952 
956  unsigned char pu;
957 };
958 
962  unsigned char set_thisproc_cpubind;
964  unsigned char get_thisproc_cpubind;
966  unsigned char set_proc_cpubind;
968  unsigned char get_proc_cpubind;
970  unsigned char set_thisthread_cpubind;
972  unsigned char get_thisthread_cpubind;
974  unsigned char set_thread_cpubind;
976  unsigned char get_thread_cpubind;
983 };
984 
988  unsigned char set_thisproc_membind;
990  unsigned char get_thisproc_membind;
992  unsigned char set_proc_membind;
994  unsigned char get_proc_membind;
996  unsigned char set_thisthread_membind;
998  unsigned char get_thisthread_membind;
1000  unsigned char set_area_membind;
1002  unsigned char get_area_membind;
1004  unsigned char alloc_membind;
1006  unsigned char firsttouch_membind;
1008  unsigned char bind_membind;
1010  unsigned char interleave_membind;
1012  unsigned char replicate_membind;
1014  unsigned char nexttouch_membind;
1015 
1017  unsigned char migrate_membind;
1018 };
1019 
1030 };
1031 
1033 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
1034 
1052 HWLOC_DECLSPEC unsigned hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1053 
1076 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
1077 
1084 };
1085 
1095 static __hwloc_inline int
1096 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1097 
1107 static __hwloc_inline int
1108 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1109 
1114 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1115 
1118 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1119 
1125 static __hwloc_inline int
1126 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1127 
1133 static __hwloc_inline hwloc_obj_t
1134 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
1135 
1137 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, unsigned depth, unsigned idx) __hwloc_attribute_pure;
1138 
1145 static __hwloc_inline hwloc_obj_t
1146 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
1147 
1152 static __hwloc_inline hwloc_obj_t
1153 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev);
1154 
1161 static __hwloc_inline hwloc_obj_t
1162 hwloc_get_next_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type,
1163  hwloc_obj_t prev);
1164 
1174 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
1175 
1180 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_obj_type_of_string (const char * string) __hwloc_attribute_pure;
1181 
1192 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj,
1193  int verbose);
1194 
1206 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj, const char * __hwloc_restrict separator,
1207  int verbose);
1208 
1216 HWLOC_DECLSPEC int hwloc_obj_cpuset_snprintf(char * __hwloc_restrict str, size_t size, size_t nobj, const hwloc_obj_t * __hwloc_restrict objs);
1217 
1224 static __hwloc_inline const char *
1225 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1226 
1241 HWLOC_DECLSPEC void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1242 
1300 typedef enum {
1304 
1308 
1333 
1351 
1357 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1358 
1364 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1365 
1373 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1374 
1386 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1387 
1388 #ifdef hwloc_thread_t
1389 
1396 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1397 #endif
1398 
1399 #ifdef hwloc_thread_t
1400 
1407 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1408 #endif
1409 
1423 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1424 
1439 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1440 
1508 typedef enum {
1512 
1522 
1526 
1535 
1548 
1555 
1562 
1574 typedef enum {
1580 
1585 
1593 
1599 
1613 
1626 HWLOC_DECLSPEC int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags);
1627 
1641 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags);
1642 
1683 HWLOC_DECLSPEC int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t * policy, int flags);
1684 
1730 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_cpuset_t cpuset, hwloc_membind_policy_t * policy, int flags);
1731 
1741 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);
1742 
1752 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);
1753 
1790 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);
1791 
1831 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);
1832 
1839 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);
1840 
1847 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);
1848 
1871 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);
1872 
1897 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);
1898 
1906 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
1907 
1917 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;
1918 
1928 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;
1929 
1936 static __hwloc_inline void *
1937 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;
1938 
1943 static __hwloc_inline void *
1944 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;
1945 
1949 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
1950 
1973 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, const char *name);
1974 
1990 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
1991 
1999 
2005 
2011 };
2012 
2034 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags);
2035 
2043 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
2044 
2078 HWLOC_DECLSPEC int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2079 
2101 HWLOC_DECLSPEC hwloc_obj_t hwloc_custom_insert_group_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, int groupdepth);
2102 
2124 HWLOC_DECLSPEC int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath);
2125 
2142 HWLOC_DECLSPEC int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen);
2143 
2145 HWLOC_DECLSPEC void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer);
2146 
2163 HWLOC_DECLSPEC void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology,
2164  void (*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2165 
2191 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);
2192 
2206 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);
2207 
2228 HWLOC_DECLSPEC void hwloc_topology_set_userdata_import_callback(hwloc_topology_t topology,
2229  void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length));
2230 
2235 #ifdef __cplusplus
2236 } /* extern "C" */
2237 #endif
2238 
2239 
2240 /* high-level helpers */
2241 #include <hwloc/helper.h>
2242 
2243 /* inline code of some functions above */
2244 #include <hwloc/inlines.h>
2245 
2246 /* topology diffs */
2247 #include <hwloc/diff.h>
2248 
2249 /* deprecated headers */
2250 #include <hwloc/deprecated.h>
2251 
2252 #endif /* HWLOC_H */
Group-specific Object Attributes.
Definition: hwloc.h:491
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@0 upstream
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)
Set the default memory binding policy of the specified process to prefer the NUMA node(s) near the sp...
Set of flags describing actual support for this topology.
Definition: hwloc.h:1026
static __hwloc_inline int hwloc_get_type_or_below_depth(hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure
Returns the depth of objects of type type or below.
Request for strict binding from the OS.
Definition: hwloc.h:1332
unsigned char get_proc_cpubind
Definition: hwloc.h:968
HWLOC_DECLSPEC 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.
struct hwloc_obj_attr_u::hwloc_bridge_attr_s bridge
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)
Set the default memory binding policy of the specified process to prefer the NUMA node(s) specified b...
HWLOC_DECLSPEC 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().
HWLOC_DECLSPEC void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer)
Free a buffer allocated by hwloc_topology_export_xmlbuffer()
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:187
HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
Avoid any effect on memory binding.
Definition: hwloc.h:1349
Bind current thread of current process.
Definition: hwloc.h:1307
HWLOC_DECLSPEC int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
unsigned char interleave_membind
Definition: hwloc.h:1010
HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure
Does the topology context come from this system?
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1584
struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:47
HWLOC_DECLSPEC 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_memory_s::hwloc_obj_memory_page_type_s * page_types
hwloc_get_type_depth_e
Definition: hwloc.h:1078
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:485
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:366
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:152
Flags describing actual discovery support for this topology.
Definition: hwloc.h:954
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
Allocate some memory on memory nodes near the given physical cpuset cpuset.
Value returned by hwloc_compare_types when types can not be compared.
Definition: hwloc.h:296
struct hwloc_obj * prev_sibling
Previous object below the same parent.
Definition: hwloc.h:360
Allocate memory on the specified nodes.
Definition: hwloc.h:1525
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:354
unsigned distances_count
Definition: hwloc.h:463
HWLOC_DECLSPEC 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_DECLSPEC 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 userdata.
Operating system device. These objects have neither CPU sets nor node sets. They are not added to the...
Definition: hwloc.h:225
HWLOC_DECLSPEC const char * hwloc_obj_type_string(hwloc_obj_type_t type) __hwloc_attribute_const
Return a stringified topology object type.
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)
Query the physical NUMA node(s) and binding policy of the memory identified by (addr, len ).
Detect the whole system, ignore reservations and offline settings.
Definition: hwloc.h:693
HWLOC_DECLSPEC unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags)
Bind a process pid on cpus given in physical bitmap set.
struct hwloc_obj_attr_u::hwloc_cache_attr_s cache
HWLOC_DECLSPEC int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the current process or thread to prefer the NUMA node(s) spe...
unsigned os_index
OS-provided physical index number.
Definition: hwloc.h:334
Virtual depth for software device object level.
Definition: hwloc.h:1083
OS Device specific Object Attributes.
Definition: hwloc.h:519
unsigned char alloc_membind
Definition: hwloc.h:1004
Operating system co-processor device. For instance &quot;mic0&quot; for a Xeon Phi (MIC) on Linux...
Definition: hwloc.h:270
unsigned logical_index
Horizontal index in the whole list of similar objects, could be a &quot;cousin_rank&quot; since it&#39;s the rank...
Definition: hwloc.h:348
Operating system network device. For instance the &quot;eth0&quot; interface on Linux.
Definition: hwloc.h:264
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
Allocate some memory on the given physical nodeset nodeset.
unsigned nbobjs
Number of objects considered in the matrix. It is the number of descendant objects at relative_depth ...
Definition: hwloc.h:541
unsigned depth
Vertical index in the hierarchy. If the topology is symmetric, this is equal to the parent depth plus...
Definition: hwloc.h:343
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1027
unsigned short domain
Definition: hwloc.h:511
HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid)
Change which pid the topology is viewed from.
HWLOC_DECLSPEC int hwloc_topology_set_fsroot(hwloc_topology_t __hwloc_restrict topology, const char *__hwloc_restrict fsroot_path)
Change the file-system root path when building the topology from sysfs/procfs.
int symmetric_subtree
Set if the subtree of objects below this object is symmetric, which means all children and their chil...
Definition: hwloc.h:468
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:1993
struct hwloc_obj_memory_s memory
Memory attributes.
Definition: hwloc.h:337
Object info.
Definition: hwloc.h:559
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:483
unsigned char get_thisthread_membind
Definition: hwloc.h:998
unsigned infos_count
Size of infos array.
Definition: hwloc.h:466
unsigned depth
Depth of group object.
Definition: hwloc.h:492
HWLOC_DECLSPEC int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type.
Definition: hwloc.h:231
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:982
HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure
Returns the type of objects at depth depth.
HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char *__hwloc_restrict string, size_t size, hwloc_obj_t obj, const char *__hwloc_restrict separator, int verbose)
Stringify the attributes of a given topology object into a human-readable form.
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:321
unsigned short vendor_id
Definition: hwloc.h:499
hwloc_compare_types_e
Definition: hwloc.h:295
HWLOC_DECLSPEC 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...
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1574
Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allo...
Definition: hwloc.h:1521
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1029
unsigned char set_proc_cpubind
Definition: hwloc.h:966
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:196
HWLOC_DECLSPEC 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.
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:357
PCI-side of a bridge.
Definition: hwloc.h:254
PCI Device specific Object Attributes.
Definition: hwloc.h:495
hwloc_nodeset_t allowed_nodeset
The set of allowed NUMA memory nodes.
Definition: hwloc.h:449
float linkspeed
Definition: hwloc.h:501
unsigned char revision
Definition: hwloc.h:500
static __hwloc_inline int hwloc_get_type_or_above_depth(hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure
Returns the depth of objects of type type or above.
Data cache.
Definition: hwloc.h:246
Detect PCI bridges.
Definition: hwloc.h:734
Structure of a topology object.
Definition: hwloc.h:331
float * latency
Matrix of latencies between objects, stored as a one-dimension array. May be NULL if the distances co...
Definition: hwloc.h:546
unsigned char subordinate_bus
Definition: hwloc.h:512
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1598
HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char *__hwloc_restrict xmlpath)
Enable XML-file based topology.
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)
Query the CPUs near the physical NUMA node(s) and binding policy of the memory identified by (addr...
char * value
Info value.
Definition: hwloc.h:561
Detect the whole PCI hierarchy.
Definition: hwloc.h:743
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:315
unsigned char set_thisproc_cpubind
Definition: hwloc.h:962
Detect instruction caches.
Definition: hwloc.h:751
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)
Encode and export some object userdata to XML.
HWLOC_DECLSPEC int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
struct hwloc_distances_s ** distances
Distances between all objects at same depth below this object.
Definition: hwloc.h:462
Cache-specific Object Attributes.
Definition: hwloc.h:482
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:980
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1080
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:258
unsigned relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:539
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)
Export some object userdata to XML.
unsigned short device_id
Definition: hwloc.h:499
static __hwloc_inline 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) __hwloc_attribute_malloc
Allocate some memory on the given nodeset nodeset.
static __hwloc_inline void * 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
Allocate some memory on the memory nodes near given cpuset cpuset.
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:488
HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags)
Get the current physical binding of process pid.
unsigned char get_area_membind
Definition: hwloc.h:1002
HWLOC_DECLSPEC int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR&#39;ed flags to non-yet-loaded topology.
Operating system openfabrics device. For instance the &quot;mlx4_0&quot; InfiniBand HCA device on Linux...
Definition: hwloc.h:266
Distances between objects.
Definition: hwloc.h:538
HWLOC_DECLSPEC void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:388
HWLOC_DECLSPEC hwloc_obj_type_t hwloc_obj_type_of_string(const char *string) __hwloc_attribute_pure
Return an object type from the string.
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:477
Replicate memory on the given nodes; reads from this memory will attempt to be serviced from the NUMA...
Definition: hwloc.h:1547
HWLOC_DECLSPEC void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:45
unsigned char nexttouch_membind
Definition: hwloc.h:1014
static __hwloc_inline hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology) __hwloc_attribute_pure
Returns the top-object of the topology-tree.
HWLOC_DECLSPEC int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen)
Export the topology into a newly-allocated XML memory buffer.
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
static __hwloc_inline 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_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)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) near physical cpuset...
unsigned sibling_rank
Index in parent&#39;s children[] array.
Definition: hwloc.h:358
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:685
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:312
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
HWLOC_DECLSPEC 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.
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1534
struct hwloc_obj * first_child
First child.
Definition: hwloc.h:365
HWLOC_DECLSPEC int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology)
Ignore all objects that do not bring any structure.
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:515
Reset the memory allocation policy to the system default.
Definition: hwloc.h:1511
hwloc_obj_osdev_type_t type
Definition: hwloc.h:520
NUMA node. A set of processors around memory which the processors can directly access.
Definition: hwloc.h:172
unsigned char get_thisproc_cpubind
Definition: hwloc.h:964
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1579
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:118
unsigned char set_thisproc_membind
Definition: hwloc.h:988
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:484
HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure
Returns the width of level at depth depth.
Machine. The typical root object type. A set of processors and memory with cache coherency.
Definition: hwloc.h:167
Operating system GPU device. For instance &quot;:0.0&quot; for a GL display, &quot;card0&quot; for a Linux DRM device...
Definition: hwloc.h:261
HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth(hwloc_topology_t topology, unsigned depth, unsigned idx) __hwloc_attribute_pure
Returns the topology object at logical index idx from depth depth.
HWLOC_DECLSPEC 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...
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:333
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2004
HWLOC_DECLSPEC int hwloc_topology_set_distance_matrix(hwloc_topology_t __hwloc_restrict topology, hwloc_obj_type_t type, unsigned nbobjs, unsigned *os_index, float *distances)
Provide a distance matrix.
unsigned char bind_membind
Definition: hwloc.h:1008
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1300
char * name
Object description if any.
Definition: hwloc.h:335
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:133
HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags)
Restrict the topology to the given CPU set.
unsigned char migrate_membind
Definition: hwloc.h:1017
HWLOC_DECLSPEC 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.
unsigned char set_proc_membind
Definition: hwloc.h:992
unsigned depth
Definition: hwloc.h:516
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:253
Detect PCI devices.
Definition: hwloc.h:725
unsigned char get_thread_cpubind
Definition: hwloc.h:976
Object memory.
Definition: hwloc.h:310
signed os_level
OS-provided physical level, -1 if unknown or meaningless.
Definition: hwloc.h:350
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:353
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:435
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:986
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)
Query the default memory binding policy and physical locality of the specified process (the locality ...
unsigned char secondary_bus
Definition: hwloc.h:512
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:407
HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
Virtual depth for bridge object level.
Definition: hwloc.h:1081
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:418
unsigned short subvendor_id
Definition: hwloc.h:499
Adapt distance matrices according to objects being removed during restriction. If this flag is not se...
Definition: hwloc.h:1998
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1303
unsigned short domain
Definition: hwloc.h:496
float latency_max
The maximal value in the latency matrix.
Definition: hwloc.h:551
hwloc_uint64_t total_memory
Total memory (in bytes) in this object and its children.
Definition: hwloc.h:311
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:339
Cache. Can be L1i, L1d, L2, L3, ...
Definition: hwloc.h:180
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:375
unsigned char get_thisproc_membind
Definition: hwloc.h:990
struct hwloc_obj * next_sibling
Next object below the same parent.
Definition: hwloc.h:359
HWLOC_DECLSPEC 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.
unsigned char set_thread_cpubind
Definition: hwloc.h:974
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:713
Avoid any effect on CPU binding.
Definition: hwloc.h:1611
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
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:1554
unsigned char firsttouch_membind
Definition: hwloc.h:1006
HWLOC_DECLSPEC 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.
Virtual depth for PCI device object level.
Definition: hwloc.h:1082
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:577
HWLOC_DECLSPEC int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath)
Export the topology into an XML file.
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:399
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:978
Whole system (may be a cluster of machines). The whole system that is accessible to hwloc...
Definition: hwloc.h:162
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:369
HWLOC_DECLSPEC 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...
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:183
HWLOC_DECLSPEC 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.
No object of given type exists in the topology.
Definition: hwloc.h:1079
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:220
unsigned char get_thisthread_cpubind
Definition: hwloc.h:972
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)
Query the default memory binding policy and physical locality of the specified process.
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
Socket, physical package, or chip. In the physical meaning, i.e. that you can add or remove physicall...
Definition: hwloc.h:176
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:136
static __hwloc_inline int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure
Returns the width of level type type.
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:956
static __hwloc_inline const char * hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure
Search the given key name in object infos and return the corresponding value.
Unified cache.
Definition: hwloc.h:245
HWLOC_DECLSPEC 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.
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
struct hwloc_pcidev_attr_s pci
Definition: hwloc.h:506
HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char *__hwloc_restrict description)
Enable synthetic topology.
HWLOC_DECLSPEC struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology)
Retrieve the topology support.
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:244
unsigned char bus
Definition: hwloc.h:497
struct hwloc_obj_attr_u::hwloc_group_attr_s group
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:252
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:323
Bridge specific Object Attribues.
Definition: hwloc.h:504
HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR&#39;ed flags of a topology.
Bridge. Any bridge that connects the host or an I/O bus, to another I/O bus. Bridge objects have neit...
Definition: hwloc.h:213
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:960
HWLOC_DECLSPEC hwloc_obj_t hwloc_custom_insert_group_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, int groupdepth)
Insert a new group object inside a custom topology.
unsigned arity
Number of children.
Definition: hwloc.h:363
HWLOC_DECLSPEC unsigned hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure
Get the depth of the hierarchical tree of objects.
Object type-specific Attributes.
Definition: hwloc.h:480
unsigned char get_proc_membind
Definition: hwloc.h:994
HWLOC_DECLSPEC 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.
struct hwloc_obj_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:465
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:1028
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:508
unsigned short class_id
Definition: hwloc.h:498
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:486
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:364
Returned by hwloc_get_membind*() functions when multiple threads or parts of a memory area have diffe...
Definition: hwloc.h:1560
Operating system dma engine device. For instance the &quot;dma0chan0&quot; DMA channel on Linux.
Definition: hwloc.h:268
unsigned char set_thisthread_membind
Definition: hwloc.h:996
unsigned char func
Definition: hwloc.h:497
Definition: hwloc.h:1592
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1508
HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char *__hwloc_restrict buffer, int size)
Enable XML based topology using a memory buffer (instead of a file, as with hwloc_topology_set_xml())...
HWLOC_DECLSPEC int hwloc_topology_set_custom(hwloc_topology_t topology)
Prepare the topology for custom assembly.
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
unsigned short subdevice_id
Definition: hwloc.h:499
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:322
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:116
char * name
Info name.
Definition: hwloc.h:560
unsigned char set_area_membind
Definition: hwloc.h:1000
static __hwloc_inline 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.
Operating system block device. For instance &quot;sda&quot; on Linux.
Definition: hwloc.h:259
Miscellaneous objects. Objects without particular meaning, that can e.g. be added by the application ...
Definition: hwloc.h:208
HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char *__hwloc_restrict string, size_t size, hwloc_obj_t obj, int verbose)
Stringify the type of a given topology object into a human-readable form.
float latency_base
The multiplier that should be applied to latency matrix to retrieve the original OS-provided latencie...
Definition: hwloc.h:552
unsigned char replicate_membind
Definition: hwloc.h:1012
Instruction cache. Only used when the HWLOC_TOPOLOGY_FLAG_ICACHES topology flag is set...
Definition: hwloc.h:247
static __hwloc_inline hwloc_obj_t hwloc_get_obj_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure
Returns the topology object at logical index idx with type type.
HWLOC_DECLSPEC int hwloc_obj_cpuset_snprintf(char *__hwloc_restrict str, size_t size, size_t nobj, const hwloc_obj_t *__hwloc_restrict objs)
Stringify the cpuset containing a set of objects.
unsigned char dev
Definition: hwloc.h:497
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2010
HWLOC_DECLSPEC int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const
Compare the depth of two object types.
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)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) in physical nodeset...
unsigned char set_thisthread_cpubind
Definition: hwloc.h:970