Open MPI logo

Portable Hardware Locality (hwloc) Documentation: v2.0.3

  |   Home   |   Support   |   FAQ   |  
hwloc.h
1 /*
2  * Copyright © 2009 CNRS
3  * Copyright © 2009-2018 Inria. All rights reserved.
4  * Copyright © 2009-2012 Université Bordeaux
5  * Copyright © 2009-2011 Cisco Systems, Inc. All rights reserved.
6  * See COPYING in top-level directory.
7  */
8 
9 /*=====================================================================
10  * PLEASE GO READ THE DOCUMENTATION!
11  * ------------------------------------------------
12  * $tarball_directory/doc/doxygen-doc/
13  * or
14  * http://www.open-mpi.org/projects/hwloc/doc/
15  *=====================================================================
16  *
17  * FAIR WARNING: Do NOT expect to be able to figure out all the
18  * subtleties of hwloc by simply reading function prototypes and
19  * constant descrptions here in this file.
20  *
21  * Hwloc has wonderful documentation in both PDF and HTML formats for
22  * your reading pleasure. The formal documentation explains a LOT of
23  * hwloc-specific concepts, provides definitions, and discusses the
24  * "big picture" for many of the things that you'll find here in this
25  * header file.
26  *
27  * The PDF/HTML documentation was generated via Doxygen; much of what
28  * you'll see in there is also here in this file. BUT THERE IS A LOT
29  * THAT IS IN THE PDF/HTML THAT IS ***NOT*** IN hwloc.h!
30  *
31  * There are entire paragraph-length descriptions, discussions, and
32  * pretty prictures to explain subtle corner cases, provide concrete
33  * examples, etc.
34  *
35  * Please, go read the documentation. :-)
36  *
37  * Moreover there are several examples of hwloc use under doc/examples
38  * in the source tree.
39  *
40  *=====================================================================*/
41 
53 #ifndef HWLOC_H
54 #define HWLOC_H
55 
56 #include <hwloc/autogen/config.h>
57 #include <sys/types.h>
58 #include <stdio.h>
59 #include <string.h>
60 #include <limits.h>
61 
62 /*
63  * Symbol transforms
64  */
65 #include <hwloc/rename.h>
66 
67 /*
68  * Bitmap definitions
69  */
70 
71 #include <hwloc/bitmap.h>
72 
73 
74 #ifdef __cplusplus
75 extern "C" {
76 #endif
77 
78 
95 #define HWLOC_API_VERSION 0x00020000
96 
101 HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);
102 
104 #define HWLOC_COMPONENT_ABI 5
105 
142 
160 
175 #define HWLOC_OBJ_TYPE_MIN HWLOC_OBJ_MACHINE
176 typedef enum {
282  HWLOC_OBJ_TYPE_MAX
284 
291 
297 
317 
337 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
338 
341 };
342 
351 union hwloc_obj_attr_u;
352 
357 struct hwloc_obj {
358  /* physical information */
360  char *subtype;
362  unsigned os_index;
367 #define HWLOC_UNKNOWN_INDEX (unsigned)-1
368 
369  char *name;
374  hwloc_uint64_t total_memory;
379  /* global position */
380  int depth;
395  unsigned logical_index;
402  /* cousins are all objects of the same type (and depth) across the entire topology */
406  /* children of the same parent are siblings, even if they may have different type and depth */
407  struct hwloc_obj *parent;
408  unsigned sibling_rank;
413  unsigned arity;
417  struct hwloc_obj **children;
433  unsigned memory_arity;
445  unsigned io_arity;
457  unsigned misc_arity;
466  /* cpusets and nodesets */
531  struct hwloc_info_s *infos;
532  unsigned infos_count;
534  /* misc */
535  void *userdata;
540  hwloc_uint64_t gp_index;
545 };
549 typedef struct hwloc_obj * hwloc_obj_t;
550 
555  hwloc_uint64_t local_memory;
556  unsigned page_types_len;
563  hwloc_uint64_t size;
564  hwloc_uint64_t count;
565  } * page_types;
566  } numanode;
567 
570  hwloc_uint64_t size;
571  unsigned depth;
572  unsigned linesize;
576  } cache;
579  unsigned depth;
581  unsigned kind;
582  unsigned subkind;
583  } group;
586  unsigned short domain;
587  unsigned char bus, dev, func;
588  unsigned short class_id;
589  unsigned short vendor_id, device_id, subvendor_id, subdevice_id;
590  unsigned char revision;
591  float linkspeed; /* in GB/s */
592  } pcidev;
595  union {
597  } upstream;
599  union {
600  struct {
601  unsigned short domain;
602  unsigned char secondary_bus, subordinate_bus;
603  } pci;
604  } downstream;
606  unsigned depth;
607  } bridge;
611  } osdev;
612 };
613 
618 struct hwloc_info_s {
619  char *name;
620  char *value;
621 };
622 
631 struct hwloc_topology;
636 typedef struct hwloc_topology * hwloc_topology_t;
637 
644 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
645 
666 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
667 
672 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
673 
684 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
685 
703 HWLOC_DECLSPEC int hwloc_topology_abi_check(hwloc_topology_t topology);
704 
716 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
717 
738 HWLOC_DECLSPEC int hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
739 
763 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
764 
773 };
774 
794 HWLOC_DECLSPEC int hwloc_get_memory_parents_depth (hwloc_topology_t topology);
795 
809 static __hwloc_inline int
810 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
811 
825 static __hwloc_inline int
826 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
827 
834 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, int depth) __hwloc_attribute_pure;
835 
838 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, int depth) __hwloc_attribute_pure;
839 
845 static __hwloc_inline int
846 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
847 
852 static __hwloc_inline hwloc_obj_t
853 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
854 
856 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, int depth, unsigned idx) __hwloc_attribute_pure;
857 
864 static __hwloc_inline hwloc_obj_t
865 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
866 
871 static __hwloc_inline hwloc_obj_t
872 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, int depth, hwloc_obj_t prev);
873 
880 static __hwloc_inline hwloc_obj_t
882  hwloc_obj_t prev);
883 
900 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
901 
919 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size,
920  hwloc_obj_t obj,
921  int verbose);
922 
934 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size,
935  hwloc_obj_t obj, const char * __hwloc_restrict separator,
936  int verbose);
937 
961 HWLOC_DECLSPEC int hwloc_type_sscanf(const char *string,
962  hwloc_obj_type_t *typep,
963  union hwloc_obj_attr_u *attrp, size_t attrsize);
964 
986 HWLOC_DECLSPEC int hwloc_type_sscanf_as_depth(const char *string,
987  hwloc_obj_type_t *typep,
988  hwloc_topology_t topology, int *depthp);
989 
1005 static __hwloc_inline const char *
1006 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1007 
1024 HWLOC_DECLSPEC int hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1025 
1097 typedef enum {
1101 
1105 
1130 
1148 
1154 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1155 
1161 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1162 
1174 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1175 
1187 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1188 
1189 #ifdef hwloc_thread_t
1190 
1197 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1198 #endif
1199 
1200 #ifdef hwloc_thread_t
1201 
1208 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1209 #endif
1210 
1224 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1225 
1242 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1243 
1323 typedef enum {
1332 
1343 
1347 
1356 
1363 
1372 
1386 typedef enum {
1392 
1397 
1405 
1411 
1424 
1436 
1452 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
1453 
1498 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
1499 
1512 HWLOC_DECLSPEC int hwloc_set_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
1513 
1553 HWLOC_DECLSPEC int hwloc_get_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
1554 
1565 HWLOC_DECLSPEC int hwloc_set_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
1566 
1594 HWLOC_DECLSPEC int hwloc_get_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
1595 
1615 HWLOC_DECLSPEC int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags);
1616 
1624 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
1625 
1640 HWLOC_DECLSPEC void *hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags) __hwloc_attribute_malloc;
1641 
1651 static __hwloc_inline void *
1652 hwloc_alloc_membind_policy(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags) __hwloc_attribute_malloc;
1653 
1657 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
1658 
1695 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
1696 
1725 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
1726 
1753 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
1754 
1781 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
1782 
1824 
1844 
1865 };
1866 
1876 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
1877 
1884 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
1885 
1893 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1894 
1898  unsigned char pu;
1900  unsigned char numa;
1902  unsigned char numa_memory;
1903 };
1904 
1912  unsigned char set_thisproc_cpubind;
1914  unsigned char get_thisproc_cpubind;
1916  unsigned char set_proc_cpubind;
1918  unsigned char get_proc_cpubind;
1920  unsigned char set_thisthread_cpubind;
1922  unsigned char get_thisthread_cpubind;
1924  unsigned char set_thread_cpubind;
1926  unsigned char get_thread_cpubind;
1933 };
1934 
1942  unsigned char set_thisproc_membind;
1944  unsigned char get_thisproc_membind;
1946  unsigned char set_proc_membind;
1948  unsigned char get_proc_membind;
1950  unsigned char set_thisthread_membind;
1952  unsigned char get_thisthread_membind;
1954  unsigned char set_area_membind;
1956  unsigned char get_area_membind;
1958  unsigned char alloc_membind;
1960  unsigned char firsttouch_membind;
1962  unsigned char bind_membind;
1964  unsigned char interleave_membind;
1966  unsigned char nexttouch_membind;
1968  unsigned char migrate_membind;
1970  unsigned char get_area_memlocation;
1971 };
1972 
1983 };
1984 
1994 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
1995 
2012 
2020 
2034 
2049 };
2050 
2054 
2058 
2063 HWLOC_DECLSPEC int hwloc_topology_set_all_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2064 
2067 HWLOC_DECLSPEC int hwloc_topology_set_cache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2068 
2071 HWLOC_DECLSPEC int hwloc_topology_set_icache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2072 
2075 HWLOC_DECLSPEC int hwloc_topology_set_io_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2076 
2087 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
2088 
2094 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
2095 
2111 
2117 
2123 };
2124 
2146 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags);
2147 
2169 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2170 
2191 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_alloc_group_object(hwloc_topology_t topology);
2192 
2226 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_group_object(hwloc_topology_t topology, hwloc_obj_t group);
2227 
2237 HWLOC_DECLSPEC int hwloc_obj_add_other_obj_sets(hwloc_obj_t dst, hwloc_obj_t src);
2238 
2243 #ifdef __cplusplus
2244 } /* extern "C" */
2245 #endif
2246 
2247 
2248 /* high-level helpers */
2249 #include <hwloc/helper.h>
2250 
2251 /* inline code of some functions above */
2252 #include <hwloc/inlines.h>
2253 
2254 /* exporting to XML or synthetic */
2255 #include <hwloc/export.h>
2256 
2257 /* distances */
2258 #include <hwloc/distances.h>
2259 
2260 /* topology diffs */
2261 #include <hwloc/diff.h>
2262 
2263 /* deprecated headers */
2264 #include <hwloc/deprecated.h>
2265 
2266 #endif /* HWLOC_H */
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:573
static hwloc_obj_t hwloc_get_next_obj_by_depth(hwloc_topology_t topology, int depth, hwloc_obj_t prev)
Returns the next object at depth depth.
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1097
Data cache.
Definition: hwloc.h:288
unsigned char subordinate_bus
Definition: hwloc.h:602
int hwloc_topology_get_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e *filter)
Get the current filtering for the given object type.
int hwloc_get_membind(hwloc_topology_t topology, hwloc_bitmap_t set, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the current process or thread...
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:1930
Level 5 Data (or Unified) Cache.
Definition: hwloc.h:211
int hwloc_topology_set_xmlbuffer(hwloc_topology_t restrict topology, const char *restrict buffer, int size)
Enable XML based topology using a memory buffer (instead of a file, as with hwloc_topology_set_xml())...
int hwloc_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.
Get the set of allowed resources from the local operating system even if the topology was loaded from...
Definition: hwloc.h:1864
Definition: hwloc.h:1404
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:572
unsigned char revision
Definition: hwloc.h:590
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
Avoid any effect on memory binding.
Definition: hwloc.h:1146
Allocate each memory page individually on the local NUMA node of the thread that touches it...
Definition: hwloc.h:1342
static hwloc_obj_t hwloc_get_next_obj_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, hwloc_obj_t prev)
Returns the next object of type type.
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:535
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:482
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:1981
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:293
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:310
NUMA node-specific Object Attributes.
Definition: hwloc.h:554
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1396
static hwloc_obj_t hwloc_get_obj_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx)
Returns the topology object at logical index idx with type type.
struct hwloc_obj * parent
Parent, NULL if root (Machine object)
Definition: hwloc.h:407
Virtual depth for Misc object.
Definition: hwloc.h:772
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:1910
unsigned infos_count
Size of infos array.
Definition: hwloc.h:532
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:302
int hwloc_get_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, hwloc_membind_policy_t *policy, int flags)
Query the CPUs near the physical NUMA node(s) and binding policy of the memory identified by (addr...
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1370
unsigned char nexttouch_membind
Definition: hwloc.h:1966
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:195
int hwloc_set_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) specified by set...
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:636
Level 3 instruction Cache (filtered out by default).
Definition: hwloc.h:215
int 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_obj_t hwloc_topology_insert_group_object(hwloc_topology_t topology, hwloc_obj_t group)
Add more structure to the topology by adding an intermediate Group.
struct hwloc_obj * misc_first_child
First Misc child. Misc objects are listed here (misc_arity and misc_first_child) instead of in the no...
Definition: hwloc.h:460
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 pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:1898
unsigned char get_thisthread_cpubind
Definition: hwloc.h:1922
Bind current thread of current process.
Definition: hwloc.h:1104
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
unsigned char get_thisproc_cpubind
Definition: hwloc.h:1914
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
unsigned depth
Depth of group object. It may change if intermediate Group objects are added.
Definition: hwloc.h:579
int hwloc_type_sscanf_as_depth(const char *string, hwloc_obj_type_t *typep, hwloc_topology_t topology, int *depthp)
Return an object type and its level depth from a type string.
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:141
Remove all objects that became CPU-less. By default, only objects that contain no PU and no memory ar...
Definition: hwloc.h:2110
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR&#39;ed flags to non-yet-loaded topology.
unsigned char get_thisproc_membind
Definition: hwloc.h:1944
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:404
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:556
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a constant stringified object type.
int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
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.
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:299
Object info.
Definition: hwloc.h:618
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1410
unsigned subkind
Internally-used subkind to distinguish different levels of groups with same kind. ...
Definition: hwloc.h:582
Level 2 instruction Cache (filtered out by default).
Definition: hwloc.h:214
static int hwloc_get_type_or_above_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type or above.
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:605
unsigned char get_thread_cpubind
Definition: hwloc.h:1926
Virtual depth for software device object level.
Definition: hwloc.h:771
unsigned sibling_rank
Index in parent&#39;s children[] array. Or the index in parent&#39;s Memory, I/O or Misc children list...
Definition: hwloc.h:408
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
Allocate memory on the specified nodes.
Definition: hwloc.h:1346
Object type-specific Attributes.
Definition: hwloc.h:552
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:156
Detect the whole system, ignore reservations.
Definition: hwloc.h:1823
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:369
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_compare_types_e
Definition: hwloc.h:339
Level 1 instruction Cache (filtered out by default).
Definition: hwloc.h:213
int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the current process or thread to prefer the NUMA node(s) spe...
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.
unsigned char numa_memory
Detecting the amount of memory in NUMA nodes is supported.
Definition: hwloc.h:1902
hwloc_uint64_t gp_index
Global persistent index. Generated by hwloc, unique across the topology (contrary to os_index) and pe...
Definition: hwloc.h:540
hwloc_obj_t hwloc_topology_insert_misc_object(hwloc_topology_t topology, hwloc_obj_t parent, const char *name)
Add a MISC object as a leaf of the topology.
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:286
unsigned char migrate_membind
Definition: hwloc.h:1968
static int hwloc_get_type_or_below_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type or below.
Level 4 Data (or Unified) Cache.
Definition: hwloc.h:210
struct hwloc_obj * last_child
Last normal child.
Definition: hwloc.h:419
int hwloc_topology_set_cache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all cache object types.
Instruction cache (filtered out by default).
Definition: hwloc.h:289
unsigned depth
Definition: hwloc.h:606
unsigned char get_area_membind
Definition: hwloc.h:1956
unsigned memory_arity
Number of Memory children. These children are listed in memory_first_child.
Definition: hwloc.h:433
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.
hwloc_obj_osdev_type_t type
Definition: hwloc.h:610
unsigned short class_id
Definition: hwloc.h:588
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:562
Physical package. The physical package that usually gets inserted into a socket on the motherboard...
Definition: hwloc.h:186
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:217
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:376
int hwloc_get_memory_parents_depth(hwloc_topology_t topology)
Return the depth of parents where memory objects are attached.
static const char * hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name)
Search the given key name in object infos and return the corresponding value.
Reset the memory allocation policy to the system default. Depending on the operating system...
Definition: hwloc.h:1331
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:571
Objects of given type exist at different depth in the topology (only for Groups). ...
Definition: hwloc.h:767
OS Device specific Object Attributes.
Definition: hwloc.h:609
int hwloc_set_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the specified process to prefer the NUMA node(s) specified b...
Ignore all objects of this type.
Definition: hwloc.h:2019
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:69
unsigned char set_thisthread_membind
Definition: hwloc.h:1950
int hwloc_topology_set_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e filter)
Set the filtering for the given object type.
Only keep likely-important objects of the given type.
Definition: hwloc.h:2048
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:570
Unified cache.
Definition: hwloc.h:287
int hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
unsigned char set_proc_cpubind
Definition: hwloc.h:1916
Avoid any effect on CPU binding.
Definition: hwloc.h:1423
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:359
int hwloc_topology_set_icache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all instruction cache object types.
unsigned char set_thisproc_membind
Definition: hwloc.h:1942
Bridge (filtered out by default). Any bridge that connects the host or an I/O bus, to another I/O bus. They are not added to the topology unless I/O discovery is enabled with hwloc_topology_set_flags(). I/O objects are not listed in the main children list, but rather in the dedicated io children list. I/O objects have NULL CPU and node sets.
Definition: hwloc.h:247
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1391
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
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:1362
char * value
Info value.
Definition: hwloc.h:620
unsigned char alloc_membind
Definition: hwloc.h:1958
unsigned os_index
OS-provided physical index number. It is not guaranteed unique across the entire machine, except for PUs and NUMA nodes. Set to HWLOC_UNKNOWN_INDEX if unknown or irrelevant for this object.
Definition: hwloc.h:362
hwloc_obj_t hwloc_get_obj_by_depth(hwloc_topology_t topology, int depth, unsigned idx)
Returns the topology object at logical index idx from depth depth.
unsigned short domain
Definition: hwloc.h:601
Structure of a topology object.
Definition: hwloc.h:357
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1100
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2116
Flags describing actual discovery support for this topology.
Definition: hwloc.h:1896
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1323
unsigned char bind_membind
Definition: hwloc.h:1962
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:575
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:1928
unsigned char get_thisthread_membind
Definition: hwloc.h:1952
hwloc_type_filter_e
Type filtering flags.
Definition: hwloc.h:2005
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:549
char * name
Info name.
Definition: hwloc.h:619
unsigned char set_thread_cpubind
Definition: hwloc.h:1924
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:515
hwloc_get_type_depth_e
Definition: hwloc.h:765
unsigned misc_arity
Number of Misc children. These children are listed in misc_first_child.
Definition: hwloc.h:457
void * hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by set.
unsigned char set_proc_membind
Definition: hwloc.h:1946
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:467
int hwloc_topology_set_all_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all object types.
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:1801
hwloc_uint64_t total_memory
Total memory (in bytes) in NUMA nodes below this object.
Definition: hwloc.h:374
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:139
unsigned short vendor_id
Definition: hwloc.h:589
Virtual depth for NUMA nodes.
Definition: hwloc.h:768
unsigned char get_proc_membind
Definition: hwloc.h:1948
Operating system co-processor device. For instance "mic0" for a Xeon Phi (MIC) on Linux...
Definition: hwloc.h:312
struct hwloc_obj * first_child
First normal child.
Definition: hwloc.h:418
int hwloc_get_proc_membind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_bitmap_t set, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the specified process.
int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags)
Get the NUMA nodes where memory identified by (addr, len ) is physically allocated.
struct hwloc_obj * memory_first_child
First Memory child. NUMA nodes are listed here (memory_arity and memory_first_child) instead of in th...
Definition: hwloc.h:436
unsigned char get_proc_cpubind
Definition: hwloc.h:1918
struct hwloc_obj * next_sibling
Next object below the same parent (inside the same list of children).
Definition: hwloc.h:409
Miscellaneous objects (filtered out by default). Objects without particular meaning, that can e.g. be added by the application for its own use, or by hwloc for miscellaneous objects such as MemoryModule (DIMMs). These objects are not listed in the main children list, but rather in the dedicated misc children list. Misc objects may only have Misc objects as children, and those are in the dedicated misc children list as well. Misc objects have NULL CPU and node sets.
Definition: hwloc.h:271
int depth
Vertical index in the hierarchy.
Definition: hwloc.h:380
float linkspeed
Definition: hwloc.h:591
unsigned short domain
Definition: hwloc.h:586
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA, or "hfi1_0" Omni-Path ...
Definition: hwloc.h:307
unsigned char set_thisproc_cpubind
Definition: hwloc.h:1912
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:159
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which process the topology is viewed from.
Level 2 Data (or Unified) Cache.
Definition: hwloc.h:208
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:1843
Level 3 Data (or Unified) Cache.
Definition: hwloc.h:209
hwloc_obj_t hwloc_topology_alloc_group_object(hwloc_topology_t topology)
Allocate a Group object to insert later with hwloc_topology_insert_group_object().
struct hwloc_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:531
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
Keep all objects of this type.
Definition: hwloc.h:2011
hwloc_obj_type_t
Definition: hwloc.h:176
unsigned char func
Definition: hwloc.h:587
struct hwloc_obj * io_first_child
First I/O child. Bridges, PCI and OS devices are listed here (io_arity and io_first_child) instead of...
Definition: hwloc.h:448
NUMA node. An object that contains memory that is directly and byte-accessible to the host processors...
Definition: hwloc.h:230
Bridge specific Object Attribues.
Definition: hwloc.h:594
unsigned char firsttouch_membind
Definition: hwloc.h:1960
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR&#39;ed flags of a topology.
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
Virtual depth for bridge object level.
Definition: hwloc.h:769
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1355
unsigned char set_area_membind
Definition: hwloc.h:1954
int hwloc_obj_type_snprintf(char *restrict string, size_t size, hwloc_obj_t obj, int verbose)
Stringify the type of a given topology object into a human-readable form.
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:598
No object of given type exists in the topology.
Definition: hwloc.h:766
char * subtype
Subtype string to better describe the type field.
Definition: hwloc.h:360
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
struct hwloc_obj ** children
Normal children, children[0 .. arity -1].
Definition: hwloc.h:417
unsigned char numa
Detecting the number of NUMA nodes is supported.
Definition: hwloc.h:1900
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1386
int hwloc_topology_abi_check(hwloc_topology_t topology)
Verify that the topology is compatible with the current hwloc library.
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, int depth)
Returns the type of objects at depth depth.
Consider the bitmap argument as a nodeset.
Definition: hwloc.h:1434
int hwloc_type_sscanf(const char *string, hwloc_obj_type_t *typep, union hwloc_obj_attr_u *attrp, size_t attrsize)
Return an object type and attributes from a type string.
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2105
int hwloc_obj_add_other_obj_sets(hwloc_obj_t dst, hwloc_obj_t src)
Setup object cpusets/nodesets by OR&#39;ing another object&#39;s sets.
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
unsigned io_arity
Number of I/O children. These children are listed in io_first_child.
Definition: hwloc.h:445
Level 1 Data (or Unified) Cache.
Definition: hwloc.h:207
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:564
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.
Group-specific Object Attributes.
Definition: hwloc.h:578
Operating system block device. For instance "sda" on Linux.
Definition: hwloc.h:300
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, int depth)
Returns the width of level at depth depth.
Value returned by hwloc_compare_types() when types can not be compared.
Definition: hwloc.h:340
unsigned kind
Internally-used kind of group.
Definition: hwloc.h:581
int hwloc_topology_set_io_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all I/O object types.
PCI-side of a bridge.
Definition: hwloc.h:295
Request for strict binding from the OS.
Definition: hwloc.h:1129
PCI Device specific Object Attributes.
Definition: hwloc.h:585
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1980
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:294
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1982
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
Operating system device (filtered out by default). They are not added to the topology unless I/O disc...
Definition: hwloc.h:263
PCI device (filtered out by default). They are not added to the topology unless I/O discovery is enab...
Definition: hwloc.h:256
struct hwloc_obj * prev_sibling
Previous object below the same parent (inside the same list of children).
Definition: hwloc.h:410
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:555
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:1932
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
Machine. A set of processors and memory with cache coherency.
Definition: hwloc.h:177
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:305
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:1940
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:191
int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get the last physical CPU where the current process or thread ran.
int hwloc_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_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
Virtual depth for PCI device object level.
Definition: hwloc.h:770
static void * hwloc_alloc_membind_policy(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by set.
int symmetric_subtree
Set if the subtree of normal objects below this object is symmetric, which means all normal children ...
Definition: hwloc.h:422
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:403
unsigned arity
Number of normal children. Memory, Misc and I/O children are not listed here but rather in their dedi...
Definition: hwloc.h:413
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2122
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:67
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:395
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:563
unsigned char interleave_membind
Definition: hwloc.h:1964
Cache-specific Object Attributes.
Definition: hwloc.h:569
unsigned char get_area_memlocation
Definition: hwloc.h:1970
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_thisthread_cpubind
Definition: hwloc.h:1920
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
Only ignore objects if their entire level does not bring any structure.
Definition: hwloc.h:2033
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:495
Set of flags describing actual support for this topology.
Definition: hwloc.h:1979