Hardware Locality (hwloc)  1.8.1
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 #include <hwloc/cpuset.h>
67 
68 
69 #ifdef __cplusplus
70 extern "C" {
71 #endif
72 
73 
79 #define HWLOC_API_VERSION 0x00010800
80 
82  unsigned hwloc_get_api_version(void);
83 
85 #define HWLOC_COMPONENT_ABI 3
86 
120 
138 
153 typedef enum {
154  /* ***************************************************************
155  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
156 
157  If new enum values are added here, you MUST also go update the
158  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
159 
160  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
161  *************************************************************** */
162 
234  /* ***************************************************************
235  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
236 
237  If new enum values are added here, you MUST also go update the
238  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
239 
240  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
241  *************************************************************** */
243 
251 
257 
276 
295 
298 };
299 
308 union hwloc_obj_attr_u;
309 
312  hwloc_uint64_t total_memory;
313  hwloc_uint64_t local_memory;
316  unsigned page_types_len;
323  hwloc_uint64_t size;
324  hwloc_uint64_t count;
325  } * page_types;
326 };
327 
332 struct hwloc_obj {
333  /* physical information */
335  unsigned os_index;
336  char *name;
343  /* global position */
344  unsigned depth;
349  unsigned logical_index;
351  signed os_level;
353  /* cousins are all objects of the same type (and depth) across the entire topology */
357  /* children of the same parent are siblings, even if they may have different type and depth */
358  struct hwloc_obj *parent;
359  unsigned sibling_rank;
363  /* children array below this object */
364  unsigned arity;
365  struct hwloc_obj **children;
369  /* misc */
370  void *userdata;
375  /* cpusets and nodesets */
376  hwloc_cpuset_t cpuset;
389  hwloc_cpuset_t complete_cpuset;
400  hwloc_cpuset_t online_cpuset;
408  hwloc_cpuset_t allowed_cpuset;
419  hwloc_nodeset_t nodeset;
436  hwloc_nodeset_t complete_nodeset;
450  hwloc_nodeset_t allowed_nodeset;
464  unsigned distances_count;
465 
467  unsigned infos_count;
474 };
478 typedef struct hwloc_obj * hwloc_obj_t;
479 
484  hwloc_uint64_t size;
485  unsigned depth;
486  unsigned linesize;
490  } cache;
493  unsigned depth;
494  } group;
497  unsigned short domain;
498  unsigned char bus, dev, func;
499  unsigned short class_id;
501  unsigned char revision;
502  float linkspeed; /* in GB/s */
503  } pcidev;
506  union {
508  } upstream;
510  union {
511  struct {
512  unsigned short domain;
514  } pci;
515  } downstream;
517  unsigned depth;
518  } bridge;
522  } osdev;
523 };
524 
540  unsigned relative_depth;
542  unsigned nbobjs;
547  float *latency;
552  float latency_max;
553  float latency_base;
557 };
558 
561  char *name;
562  char *value;
563 };
564 
573 struct hwloc_topology;
578 typedef struct hwloc_topology * hwloc_topology_t;
579 
586  int hwloc_topology_init (hwloc_topology_t *topologyp);
587 
605  int hwloc_topology_load(hwloc_topology_t topology);
606 
611  void hwloc_topology_destroy (hwloc_topology_t topology);
612 
624  void hwloc_topology_check(hwloc_topology_t topology);
625 
660  int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type);
661 
670  int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type);
671 
679  int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology);
680 
695 
715 
727 
736 
745 
753 };
754 
764  int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
765 
772  unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
773 
788  int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid);
789 
816  int hwloc_topology_set_fsroot(hwloc_topology_t restrict topology, const char * restrict fsroot_path);
817 
845  int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char * restrict description);
846 
873  int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char * restrict xmlpath);
874 
901  int hwloc_topology_set_xmlbuffer(hwloc_topology_t restrict topology, const char * restrict buffer, int size);
902 
922  int hwloc_topology_set_custom(hwloc_topology_t topology);
923 
941  int hwloc_topology_set_distance_matrix(hwloc_topology_t restrict topology,
942  hwloc_obj_type_t type, unsigned nbobjs,
943  unsigned *os_index, float *distances);
944 
952  int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology) ;
953 
957  unsigned char pu;
958 };
959 
963  unsigned char set_thisproc_cpubind;
965  unsigned char get_thisproc_cpubind;
967  unsigned char set_proc_cpubind;
969  unsigned char get_proc_cpubind;
971  unsigned char set_thisthread_cpubind;
973  unsigned char get_thisthread_cpubind;
975  unsigned char set_thread_cpubind;
977  unsigned char get_thread_cpubind;
984 };
985 
989  unsigned char set_thisproc_membind;
991  unsigned char get_thisproc_membind;
993  unsigned char set_proc_membind;
995  unsigned char get_proc_membind;
997  unsigned char set_thisthread_membind;
999  unsigned char get_thisthread_membind;
1001  unsigned char set_area_membind;
1003  unsigned char get_area_membind;
1005  unsigned char alloc_membind;
1007  unsigned char firsttouch_membind;
1009  unsigned char bind_membind;
1011  unsigned char interleave_membind;
1013  unsigned char replicate_membind;
1015  unsigned char nexttouch_membind;
1016 
1018  unsigned char migrate_membind;
1019 };
1020 
1031 };
1032 
1034  const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t restrict topology);
1035 
1053  unsigned hwloc_topology_get_depth(hwloc_topology_t restrict topology) ;
1054 
1077  int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
1078 
1085 };
1086 
1096 static inline int
1097 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) ;
1098 
1108 static inline int
1109 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) ;
1110 
1115  hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, unsigned depth) ;
1116 
1119  unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, unsigned depth) ;
1120 
1126 static inline int
1127 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) ;
1128 
1134 static inline hwloc_obj_t
1135 hwloc_get_root_obj (hwloc_topology_t topology) ;
1136 
1138  hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, unsigned depth, unsigned idx) ;
1139 
1146 static inline hwloc_obj_t
1147 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) ;
1148 
1153 static inline hwloc_obj_t
1154 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev);
1155 
1162 static inline hwloc_obj_t
1163 hwloc_get_next_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type,
1164  hwloc_obj_t prev);
1165 
1175  const char * hwloc_obj_type_string (hwloc_obj_type_t type) ;
1176 
1181  hwloc_obj_type_t hwloc_obj_type_of_string (const char * string) ;
1182 
1193  int hwloc_obj_type_snprintf(char * restrict string, size_t size, hwloc_obj_t obj,
1194  int verbose);
1195 
1207  int hwloc_obj_attr_snprintf(char * restrict string, size_t size, hwloc_obj_t obj, const char * restrict separator,
1208  int verbose);
1209 
1217  int hwloc_obj_cpuset_snprintf(char * restrict str, size_t size, size_t nobj, const hwloc_obj_t * restrict objs);
1218 
1225 static inline const char *
1226 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) ;
1227 
1242  void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1243 
1301 typedef enum {
1305 
1309 
1334 
1352 
1358  int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1359 
1365  int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1366 
1378  int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1379 
1391  int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1392 
1393 #ifdef hwloc_thread_t
1394 
1401  int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1402 #endif
1403 
1404 #ifdef hwloc_thread_t
1405 
1412  int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1413 #endif
1414 
1428  int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1429 
1446  int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1447 
1515 typedef enum {
1519 
1529 
1533 
1542 
1555 
1562 
1569 
1581 typedef enum {
1587 
1592 
1600 
1606 
1620 
1633  int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags);
1634 
1648  int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags);
1649 
1690  int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t * policy, int flags);
1691 
1737  int hwloc_get_membind(hwloc_topology_t topology, hwloc_cpuset_t cpuset, hwloc_membind_policy_t * policy, int flags);
1738 
1748  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);
1749 
1759  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);
1760 
1797  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);
1798 
1838  int hwloc_get_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t cpuset, hwloc_membind_policy_t * policy, int flags);
1839 
1846  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);
1847 
1854  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);
1855 
1878  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);
1879 
1904  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);
1905 
1913  void *hwloc_alloc(hwloc_topology_t topology, size_t len);
1914 
1924  void *hwloc_alloc_membind_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags) ;
1925 
1935  void *hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags) ;
1936 
1943 static inline void *
1944 hwloc_alloc_membind_policy_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags) ;
1945 
1950 static inline void *
1951 hwloc_alloc_membind_policy(hwloc_topology_t topology, size_t len, hwloc_const_cpuset_t set, hwloc_membind_policy_t policy, int flags) ;
1952 
1956  int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
1957 
1980  hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, const char *name);
1981 
1997  hwloc_obj_t hwloc_topology_insert_misc_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
1998 
2006 
2012 
2018 };
2019 
2041  int hwloc_topology_restrict(hwloc_topology_t restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags);
2042 
2050  int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
2051 
2085  int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2086 
2108  hwloc_obj_t hwloc_custom_insert_group_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, int groupdepth);
2109 
2131  int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath);
2132 
2149  int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen);
2150 
2152  void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer);
2153 
2170  void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology,
2171  void (*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2172 
2198  int hwloc_export_obj_userdata(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length);
2199 
2213  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);
2214 
2235  void hwloc_topology_set_userdata_import_callback(hwloc_topology_t topology,
2236  void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length));
2237 
2242 #ifdef __cplusplus
2243 } /* extern "C" */
2244 #endif
2245 
2246 
2247 /* high-level helpers */
2248 #include <hwloc/helper.h>
2249 
2250 /* inline code of some functions above */
2251 #include <hwloc/inlines.h>
2252 
2253 /* topology diffs */
2254 #include <hwloc/diff.h>
2255 
2256 /* deprecated headers */
2257 #include <hwloc/deprecated.h>
2258 
2259 #endif /* HWLOC_H */
unsigned short class_id
Definition: hwloc.h:499
hwloc_obj_osdev_type_t type
Definition: hwloc.h:521
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...
int hwloc_free(hwloc_topology_t topology, void *addr, size_t len)
Free memory that was previously allocated by hwloc_alloc() or hwloc_alloc_membind().
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:979
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@0 upstream
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:245
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
Avoid any effect on CPU binding.
Definition: hwloc.h:1618
Detect the whole PCI hierarchy.
Definition: hwloc.h:744
Detect instruction caches.
Definition: hwloc.h:752
unsigned char get_proc_membind
Definition: hwloc.h:995
signed os_level
OS-provided physical level, -1 if unknown or meaningless.
Definition: hwloc.h:351
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:358
unsigned char get_thisproc_membind
Definition: hwloc.h:991
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
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.
Replicate memory on the given nodes; reads from this memory will attempt to be serviced from the NUMA...
Definition: hwloc.h:1554
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:153
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1301
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:486
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:253
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:322
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.
Detect PCI bridges.
Definition: hwloc.h:735
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:134
unsigned char firsttouch_membind
Definition: hwloc.h:1007
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:324
unsigned arity
Number of children.
Definition: hwloc.h:364
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.
Definition: hwloc.h:232
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:323
struct hwloc_distances_s ** distances
Distances between all objects at same depth below this object.
Definition: hwloc.h:463
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2011
unsigned char secondary_bus
Definition: hwloc.h:513
void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer)
Free a buffer allocated by hwloc_topology_export_xmlbuffer()
struct hwloc_obj_memory_s::hwloc_obj_memory_page_type_s * page_types
unsigned char interleave_membind
Definition: hwloc.h:1011
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1304
PCI Device specific Object Attributes.
Definition: hwloc.h:496
Bridge specific Object Attribues.
Definition: hwloc.h:505
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:983
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:259
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 depth
Vertical index in the hierarchy. If the topology is symmetric, this is equal to the parent depth plus...
Definition: hwloc.h:344
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:686
int hwloc_obj_type_snprintf(char *restrict string, size_t size, hwloc_obj_t obj, int verbose)
Stringify the type of a given topology object into a human-readable form.
unsigned short subdevice_id
Definition: hwloc.h:500
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
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...
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:714
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1028
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:489
char * name
Object description if any.
Definition: hwloc.h:336
float latency_base
The multiplier that should be applied to latency matrix to retrieve the original OS-provided latencie...
Definition: hwloc.h:553
Group-specific Object Attributes.
Definition: hwloc.h:492
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:485
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR'ed flags to non-yet-loaded topology.
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
unsigned short vendor_id
Definition: hwloc.h:500
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:516
unsigned char get_area_membind
Definition: hwloc.h:1003
int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type.
hwloc_compare_types_e
Definition: hwloc.h:296
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
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.
Adapt distance matrices according to objects being removed during restriction. If this flag is not se...
Definition: hwloc.h:2005
unsigned char set_area_membind
Definition: hwloc.h:1001
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.
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 bus
Definition: hwloc.h:498
Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allo...
Definition: hwloc.h:1528
int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags)
Bind a thread thread on cpus given in physical bitmap set.
int hwloc_get_membind(hwloc_topology_t topology, hwloc_cpuset_t cpuset, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the current process or thread (the l...
int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath)
Export the topology into an XML file.
unsigned relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:540
Reset the memory allocation policy to the system default.
Definition: hwloc.h:1518
struct hwloc_obj_attr_u::hwloc_bridge_attr_s bridge
unsigned depth
Definition: hwloc.h:517
struct hwloc_obj_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:466
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, unsigned depth)
Returns the type of objects at depth depth.
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...
PCI-side of a bridge.
Definition: hwloc.h:255
Virtual depth for bridge object level.
Definition: hwloc.h:1082
char * value
Info value.
Definition: hwloc.h:562
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:197
static 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_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:484
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 ...
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:961
unsigned char get_thisproc_cpubind
Definition: hwloc.h:965
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
Allocate memory on the specified nodes.
Definition: hwloc.h:1532
unsigned char get_thread_cpubind
Definition: hwloc.h:977
OS Device specific Object Attributes.
Definition: hwloc.h:520
float linkspeed
Definition: hwloc.h:502
struct hwloc_obj * prev_sibling
Previous object below the same parent.
Definition: hwloc.h:361
hwloc_nodeset_t allowed_nodeset
The set of allowed NUMA memory nodes.
Definition: hwloc.h:450
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:316
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA device on Linux...
Definition: hwloc.h:267
unsigned char func
Definition: hwloc.h:498
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:957
hwloc_obj_t hwloc_get_obj_by_depth(hwloc_topology_t topology, unsigned depth, unsigned idx)
Returns the topology object at logical index idx from depth depth.
unsigned char replicate_membind
Definition: hwloc.h:1013
unsigned nbobjs
Number of objects considered in the matrix. It is the number of descendant objects at relative_depth ...
Definition: hwloc.h:542
Detect PCI devices.
Definition: hwloc.h:726
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1030
int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
unsigned char set_thisthread_membind
Definition: hwloc.h:997
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.
unsigned char get_proc_cpubind
Definition: hwloc.h:969
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:367
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:1561
Object info.
Definition: hwloc.h:560
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.
unsigned char set_thread_cpubind
Definition: hwloc.h:975
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR'ed flags of a topology.
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:340
struct hwloc_obj * first_child
First child.
Definition: hwloc.h:366
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2000
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:376
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.
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:509
unsigned char dev
Definition: hwloc.h:498
NUMA node. A set of processors around memory which the processors can directly access.
Definition: hwloc.h:173
float * latency
Matrix of latencies between objects, stored as a one-dimension array. May be NULL if the distances co...
Definition: hwloc.h:547
Avoid any effect on memory binding.
Definition: hwloc.h:1350
Operating system co-processor device. For instance "mic0" for a Xeon Phi (MIC) on Linux...
Definition: hwloc.h:271
unsigned short domain
Definition: hwloc.h:497
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:221
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.
Whole system (may be a cluster of machines). The whole system that is accessible to hwloc...
Definition: hwloc.h:163
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:188
unsigned char subordinate_bus
Definition: hwloc.h:513
static inline 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.
Machine. The typical root object type. A set of processors and memory with cache coherency.
Definition: hwloc.h:168
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:408
char * name
Info name.
Definition: hwloc.h:561
unsigned char set_proc_membind
Definition: hwloc.h:993
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.
int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology)
Ignore all objects that do not bring any structure.
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
Detect the whole system, ignore reservations and offline settings.
Definition: hwloc.h:694
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.
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
unsigned hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
Distances between objects.
Definition: hwloc.h:539
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:370
unsigned char bind_membind
Definition: hwloc.h:1009
hwloc_get_type_depth_e
Definition: hwloc.h:1079
Definition: hwloc.h:1599
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
Virtual depth for software device object level.
Definition: hwloc.h:1084
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:981
unsigned char nexttouch_membind
Definition: hwloc.h:1015
unsigned char migrate_membind
Definition: hwloc.h:1018
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1081
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, unsigned depth)
Returns the width of level at depth depth.
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1515
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1541
unsigned char get_thisthread_membind
Definition: hwloc.h:999
struct hwloc_obj_attr_u::hwloc_group_attr_s group
unsigned char set_proc_cpubind
Definition: hwloc.h:967
Unified cache.
Definition: hwloc.h:246
unsigned logical_index
Horizontal index in the whole list of similar objects, could be a "cousin_rank" since it's the rank...
Definition: hwloc.h:349
Object type-specific Attributes.
Definition: hwloc.h:481
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.
Data cache.
Definition: hwloc.h:247
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:262
hwloc_obj_type_t hwloc_obj_type_of_string(const char *string)
Return an object type from the string.
static inline int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a stringified topology object type.
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
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.
Set of flags describing actual support for this topology.
Definition: hwloc.h:1027
unsigned sibling_rank
Index in parent's children[] array.
Definition: hwloc.h:359
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...
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
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...
Flags describing actual discovery support for this topology.
Definition: hwloc.h:955
static 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)
Allocate some memory on the memory nodes near given cpuset cpuset.
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:419
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:478
static inline 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.
int hwloc_topology_set_distance_matrix(hwloc_topology_t restrict topology, hwloc_obj_type_t type, unsigned nbobjs, unsigned *os_index, float *distances)
Provide a distance matrix.
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:365
Operating system device. These objects have neither CPU sets nor node sets. They are not added to the...
Definition: hwloc.h:226
Object memory.
Definition: hwloc.h:311
int symmetric_subtree
Set if the subtree of objects below this object is symmetric, which means all children and their chil...
Definition: hwloc.h:469
int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the current process or thread...
unsigned depth
Depth of group object.
Definition: hwloc.h:493
Bridge. Any bridge that connects the host or an I/O bus, to another I/O bus. Bridge objects have neit...
Definition: hwloc.h:214
static inline hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
unsigned char set_thisproc_membind
Definition: hwloc.h:989
int hwloc_get_area_membind_nodeset(hwloc_topology_t topology, const void *addr, size_t len, hwloc_nodeset_t nodeset, hwloc_membind_policy_t *policy, int flags)
Query the physical NUMA node(s) and binding policy of the memory identified by (addr, len ).
int hwloc_topology_restrict(hwloc_topology_t restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags)
Restrict the topology to the given CPU set.
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1591
int hwloc_topology_set_custom(hwloc_topology_t topology)
Prepare the topology for custom assembly.
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:254
struct hwloc_obj * next_sibling
Next object below the same parent.
Definition: hwloc.h:360
int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen)
Export the topology into a newly-allocated XML memory buffer.
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:119
static inline 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.
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1586
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:354
unsigned short subvendor_id
Definition: hwloc.h:500
unsigned infos_count
Size of infos array.
Definition: hwloc.h:467
int hwloc_set_area_membind_nodeset(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) in physical nodeset...
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:389
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:137
Socket, physical package, or chip. In the physical meaning, i.e. that you can add or remove physicall...
Definition: hwloc.h:177
Request for strict binding from the OS.
Definition: hwloc.h:1333
struct hwloc_obj_attr_u::hwloc_cache_attr_s cache
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2017
unsigned short domain
Definition: hwloc.h:512
void * hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_cpuset_t cpuset, hwloc_membind_policy_t policy, int flags)
Allocate some memory on memory nodes near the given physical cpuset cpuset.
Operating system block device. For instance "sda" on Linux.
Definition: hwloc.h:260
Cache-specific Object Attributes.
Definition: hwloc.h:483
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:400
unsigned char alloc_membind
Definition: hwloc.h:1005
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:487
void * hwloc_alloc_membind_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Allocate some memory on the given physical nodeset nodeset.
unsigned char set_thisthread_cpubind
Definition: hwloc.h:971
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.
int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the current process or thread to prefer the NUMA node(s) spe...
struct hwloc_pcidev_attr_s pci
Definition: hwloc.h:507
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1581
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.
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:265
unsigned char revision
Definition: hwloc.h:501
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:1029
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
Miscellaneous objects. Objects without particular meaning, that can e.g. be added by the application ...
Definition: hwloc.h:209
unsigned distances_count
Definition: hwloc.h:464
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:313
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:47
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.
No object of given type exists in the topology.
Definition: hwloc.h:1080
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:987
unsigned char set_thisproc_cpubind
Definition: hwloc.h:963
Cache. Can be L1i, L1d, L2, L3, ...
Definition: hwloc.h:181
Instruction cache. Only used when the HWLOC_TOPOLOGY_FLAG_ICACHES topology flag is set...
Definition: hwloc.h:248
unsigned os_index
OS-provided physical index number.
Definition: hwloc.h:335
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:117
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:269
struct hwloc_obj_memory_s memory
Memory attributes.
Definition: hwloc.h:338
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:355
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:436
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:578
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:184
static 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)
Allocate some memory on the given nodeset nodeset.
static inline 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.
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1605
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.
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.
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.
Bind current thread of current process.
Definition: hwloc.h:1308
unsigned char get_thisthread_cpubind
Definition: hwloc.h:973
Value returned by hwloc_compare_types when types can not be compared.
Definition: hwloc.h:297
unsigned short device_id
Definition: hwloc.h:500
Returned by hwloc_get_membind*() functions when multiple threads or parts of a memory area have diffe...
Definition: hwloc.h:1567
static 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.
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:334
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
Virtual depth for PCI device object level.
Definition: hwloc.h:1083
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which pid the topology is viewed from.
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())...
float latency_max
The maximal value in the latency matrix.
Definition: hwloc.h:552
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
Structure of a topology object.
Definition: hwloc.h:332
hwloc_uint64_t total_memory
Total memory (in bytes) in this object and its children.
Definition: hwloc.h:312