Hardware Locality (hwloc)  2.10.0
hwloc.h
1 /*
2  * Copyright © 2009 CNRS
3  * Copyright © 2009-2023 Inria. All rights reserved.
4  * Copyright © 2009-2012 Université Bordeaux
5  * Copyright © 2009-2020 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  * https://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 pictures 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 
58 #include <sys/types.h>
59 #include <stdio.h>
60 #include <string.h>
61 #include <limits.h>
62 
63 /*
64  * Symbol transforms
65  */
66 #include "hwloc/rename.h"
67 
68 /*
69  * Bitmap definitions
70  */
71 
72 #include "hwloc/bitmap.h"
73 
74 
75 #ifdef __cplusplus
76 extern "C" {
77 #endif
78 
79 
115 #define HWLOC_API_VERSION 0x00020800
116 
123 HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);
124 
126 #define HWLOC_COMPONENT_ABI 7
127 
164 
182 
197 typedef enum {
198 
200 #define HWLOC_OBJ_TYPE_MIN HWLOC_OBJ_MACHINE /* Sentinel value */
201 
354  HWLOC_OBJ_TYPE_MAX
356 
363 
369 
389 
412 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
413 
415 #define HWLOC_TYPE_UNORDERED INT_MAX
416 
425 union hwloc_obj_attr_u;
426 
431 struct hwloc_obj {
432  /* physical information */
433  hwloc_obj_type_t type;
434  char *subtype;
436  unsigned os_index;
441 #define HWLOC_UNKNOWN_INDEX (unsigned)-1
442 
443  char *name;
448  hwloc_uint64_t total_memory;
453  /* global position */
454  int depth;
469  unsigned logical_index;
476  /* cousins are all objects of the same type (and depth) across the entire topology */
480  /* children of the same parent are siblings, even if they may have different type and depth */
481  struct hwloc_obj *parent;
482  unsigned sibling_rank;
487  unsigned arity;
491  struct hwloc_obj **children;
507  unsigned memory_arity;
525  unsigned io_arity;
537  unsigned misc_arity;
546  /* cpusets and nodesets */
547  hwloc_cpuset_t cpuset;
562  hwloc_cpuset_t complete_cpuset;
575  hwloc_nodeset_t nodeset;
597  hwloc_nodeset_t complete_nodeset;
613  struct hwloc_info_s *infos;
614  unsigned infos_count;
616  /* misc */
617  void *userdata;
622  hwloc_uint64_t gp_index;
627 };
631 typedef struct hwloc_obj * hwloc_obj_t;
632 
637  hwloc_uint64_t local_memory;
638  unsigned page_types_len;
645  hwloc_uint64_t size;
646  hwloc_uint64_t count;
647  } * page_types;
648  } numanode;
649 
652  hwloc_uint64_t size;
653  unsigned depth;
654  unsigned linesize;
657  hwloc_obj_cache_type_t type;
658  } cache;
661  unsigned depth;
663  unsigned kind;
664  unsigned subkind;
665  unsigned char dont_merge;
666  } group;
669 #ifndef HWLOC_HAVE_32BITS_PCI_DOMAIN
670  unsigned short domain;
672 #else
673  unsigned int domain;
675 #endif
676  unsigned char bus;
677  unsigned char dev;
678  unsigned char func;
679  unsigned short class_id;
680  unsigned short vendor_id;
681  unsigned short device_id;
682  unsigned short subvendor_id;
683  unsigned short subdevice_id;
684  unsigned char revision;
685  float linkspeed;
691  } pcidev;
694  union {
695  struct hwloc_pcidev_attr_s pci;
696  } upstream;
697  hwloc_obj_bridge_type_t upstream_type;
698  union {
699  struct {
700 #ifndef HWLOC_HAVE_32BITS_PCI_DOMAIN
701  unsigned short domain;
703 #else
704  unsigned int domain;
706 #endif
707  unsigned char secondary_bus;
708  unsigned char subordinate_bus;
709  } pci;
710  } downstream;
711  hwloc_obj_bridge_type_t downstream_type;
712  unsigned depth;
713  } bridge;
716  hwloc_obj_osdev_type_t type;
717  } osdev;
718 };
719 
724 struct hwloc_info_s {
725  char *name;
726  char *value;
727 };
728 
737 struct hwloc_topology;
742 typedef struct hwloc_topology * hwloc_topology_t;
743 
750 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
751 
772 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
773 
778 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
779 
792 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
793 
811 HWLOC_DECLSPEC int hwloc_topology_abi_check(hwloc_topology_t topology);
812 
824 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
825 
848 HWLOC_DECLSPEC int hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
849 
876 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
877 
887 };
888 
908 HWLOC_DECLSPEC int hwloc_get_memory_parents_depth (hwloc_topology_t topology);
909 
923 static __hwloc_inline int
924 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
925 
939 static __hwloc_inline int
940 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
941 
950 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, int depth) __hwloc_attribute_pure;
951 
957 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, int depth) __hwloc_attribute_pure;
958 
965 static __hwloc_inline int
966 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
967 
974 static __hwloc_inline hwloc_obj_t
975 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
976 
982 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, int depth, unsigned idx) __hwloc_attribute_pure;
983 
991 static __hwloc_inline hwloc_obj_t
992 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
993 
1000 static __hwloc_inline hwloc_obj_t
1001 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, int depth, hwloc_obj_t prev);
1002 
1011 static __hwloc_inline hwloc_obj_t
1012 hwloc_get_next_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type,
1013  hwloc_obj_t prev);
1014 
1033 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
1034 
1052 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size,
1053  hwloc_obj_t obj,
1054  int verbose);
1055 
1067 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size,
1068  hwloc_obj_t obj, const char * __hwloc_restrict separator,
1069  int verbose);
1070 
1094 HWLOC_DECLSPEC int hwloc_type_sscanf(const char *string,
1095  hwloc_obj_type_t *typep,
1096  union hwloc_obj_attr_u *attrp, size_t attrsize);
1097 
1119 HWLOC_DECLSPEC int hwloc_type_sscanf_as_depth(const char *string,
1120  hwloc_obj_type_t *typep,
1121  hwloc_topology_t topology, int *depthp);
1122 
1141 static __hwloc_inline const char *
1142 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1143 
1160 HWLOC_DECLSPEC int hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1161 
1233 typedef enum {
1237 
1241 
1266 
1284 
1291 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1292 
1301 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1302 
1316 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1317 
1335 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1336 
1337 #ifdef hwloc_thread_t
1338 
1347 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1348 #endif
1349 
1350 #ifdef hwloc_thread_t
1351 
1364 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1365 #endif
1366 
1386 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1387 
1410 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1411 
1491 typedef enum {
1500 
1511 
1521 
1530 
1537 
1546 
1560 typedef enum {
1566 
1571 
1579 
1585 
1598 
1610 
1627 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
1628 
1678 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
1679 
1693 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);
1694 
1739 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);
1740 
1751 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);
1752 
1784 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);
1785 
1808 HWLOC_DECLSPEC int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags);
1809 
1819 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
1820 
1836 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;
1837 
1852 static __hwloc_inline void *
1853 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;
1854 
1860 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
1861 
1907 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
1908 
1940 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
1941 
1973 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
1974 
2007 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
2008 
2016 };
2017 
2035 HWLOC_DECLSPEC int hwloc_topology_set_components(hwloc_topology_t __hwloc_restrict topology, unsigned long flags, const char * __hwloc_restrict name);
2036 
2078 
2098 
2119 
2143 
2168 
2190 
2205 
2212 
2219 
2225 };
2226 
2241 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
2242 
2254 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
2255 
2265 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
2266 
2270  unsigned char pu;
2272  unsigned char numa;
2274  unsigned char numa_memory;
2276  unsigned char disallowed_pu;
2278  unsigned char disallowed_numa;
2280  unsigned char cpukind_efficiency;
2281 };
2282 
2290  unsigned char set_thisproc_cpubind;
2292  unsigned char get_thisproc_cpubind;
2294  unsigned char set_proc_cpubind;
2296  unsigned char get_proc_cpubind;
2298  unsigned char set_thisthread_cpubind;
2300  unsigned char get_thisthread_cpubind;
2302  unsigned char set_thread_cpubind;
2304  unsigned char get_thread_cpubind;
2311 };
2312 
2320  unsigned char set_thisproc_membind;
2322  unsigned char get_thisproc_membind;
2324  unsigned char set_proc_membind;
2326  unsigned char get_proc_membind;
2328  unsigned char set_thisthread_membind;
2330  unsigned char get_thisthread_membind;
2332  unsigned char set_area_membind;
2334  unsigned char get_area_membind;
2336  unsigned char alloc_membind;
2338  unsigned char firsttouch_membind;
2340  unsigned char bind_membind;
2342  unsigned char interleave_membind;
2344  unsigned char nexttouch_membind;
2346  unsigned char migrate_membind;
2348  unsigned char get_area_memlocation;
2349 };
2350 
2355  unsigned char imported_support;
2356 };
2357 
2369 };
2370 
2400 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
2401 
2418 
2426 
2440 
2455 };
2456 
2461 HWLOC_DECLSPEC int hwloc_topology_set_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e filter);
2462 
2467 HWLOC_DECLSPEC int hwloc_topology_get_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e *filter);
2468 
2475 HWLOC_DECLSPEC int hwloc_topology_set_all_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2476 
2483 HWLOC_DECLSPEC int hwloc_topology_set_cache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2484 
2491 HWLOC_DECLSPEC int hwloc_topology_set_icache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2492 
2497 HWLOC_DECLSPEC int hwloc_topology_set_io_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter);
2498 
2509 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
2510 
2519 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
2520 
2537 
2543 
2550 
2556 
2562 };
2563 
2599 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_bitmap_t set, unsigned long flags);
2600 
2608 
2617 
2621 };
2622 
2640 HWLOC_DECLSPEC int hwloc_topology_allow(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset, hwloc_const_nodeset_t nodeset, unsigned long flags);
2641 
2663 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2664 
2682 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_alloc_group_object(hwloc_topology_t topology);
2683 
2695 HWLOC_DECLSPEC int hwloc_topology_free_group_object(hwloc_topology_t topology, hwloc_obj_t group);
2696 
2755 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_group_object(hwloc_topology_t topology, hwloc_obj_t group);
2756 
2769 HWLOC_DECLSPEC int hwloc_obj_add_other_obj_sets(hwloc_obj_t dst, hwloc_obj_t src);
2770 
2788 HWLOC_DECLSPEC int hwloc_topology_refresh(hwloc_topology_t topology);
2789 
2794 #ifdef __cplusplus
2795 } /* extern "C" */
2796 #endif
2797 
2798 
2799 /* high-level helpers */
2800 #include "hwloc/helper.h"
2801 
2802 /* inline code of some functions above */
2803 #include "hwloc/inlines.h"
2804 
2805 /* memory attributes */
2806 #include "hwloc/memattrs.h"
2807 
2808 /* kinds of CPU cores */
2809 #include "hwloc/cpukinds.h"
2810 
2811 /* exporting to XML or synthetic */
2812 #include "hwloc/export.h"
2813 
2814 /* distances */
2815 #include "hwloc/distances.h"
2816 
2817 /* topology diffs */
2818 #include "hwloc/diff.h"
2819 
2820 /* deprecated headers */
2821 #include "hwloc/deprecated.h"
2822 
2823 #endif /* HWLOC_H */
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:1536
Only keep likely-important objects of the given type.
Definition: hwloc.h:2454
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
unsigned short subdevice_id
Sub-Device ID.
Definition: hwloc.h:683
unsigned char func
Function number (t in the PCI BDF notation xxxx:yy:zz.t).
Definition: hwloc.h:678
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
unsigned char imported_support
Definition: hwloc.h:2355
int hwloc_set_area_membind(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) specified by set...
hwloc_type_filter_e
Type filtering flags.
Definition: hwloc.h:2411
unsigned char get_thisthread_membind
Definition: hwloc.h:2330
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:575
int depth
Vertical index in the hierarchy.
Definition: hwloc.h:454
Only allow objects that are available to the current process.
Definition: hwloc.h:2616
Ignore CPU Kinds.
Definition: hwloc.h:2224
No object of given type exists in the topology.
Definition: hwloc.h:879
int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
Structure of a topology object.
Definition: hwloc.h:431
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:366
unsigned kind
Internally-used kind of group.
Definition: hwloc.h:663
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:547
Level 1 instruction Cache (filtered out by default).
Definition: hwloc.h:240
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2561
Level 4 Data (or Unified) Cache.
Definition: hwloc.h:237
Virtual depth for bridge object level.
Definition: hwloc.h:882
Level 3 instruction Cache (filtered out by default).
Definition: hwloc.h:242
unsigned char numa_memory
Detecting the amount of memory in NUMA nodes is supported.
Definition: hwloc.h:2274
unsigned short vendor_id
Vendor ID (xxxx in [xxxx:yyyy]).
Definition: hwloc.h:680
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1570
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:244
hwloc_obj_bridge_type_t downstream_type
Downstream Bridge type.
Definition: hwloc.h:711
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:2055
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())...
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1560
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
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...
Objects of given type exist at different depth in the topology (only for Groups). ...
Definition: hwloc.h:880
hwloc_allow_flags_e
Flags to be given to hwloc_topology_allow().
Definition: hwloc.h:2602
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
unsigned char nexttouch_membind
Definition: hwloc.h:2344
int hwloc_topology_set_all_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all object types.
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).
Definition: hwloc.h:316
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
Operating system block device, or non-volatile memory device. For instance "sda" or "dax2...
Definition: hwloc.h:372
NUMA node-specific Object Attributes.
Definition: hwloc.h:636
unsigned char cpukind_efficiency
Detecting the efficiency of CPU kinds is supported, see Kinds of CPU cores.
Definition: hwloc.h:2280
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which process the topology is viewed from.
Data cache.
Definition: hwloc.h:360
Bind current thread of current process.
Definition: hwloc.h:1240
unsigned char get_thisthread_cpubind
Definition: hwloc.h:2300
Memory-side cache (filtered out by default). A cache in front of a specific NUMA node.
Definition: hwloc.h:331
Definition: hwloc.h:1578
int hwloc_topology_set_components(hwloc_topology_t restrict topology, unsigned long flags, const char *restrict name)
Prevent a discovery component from being used for a topology.
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.
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
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:540
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
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.
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:482
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...
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:657
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
char * value
Info value.
Definition: hwloc.h:726
unsigned char alloc_membind
Definition: hwloc.h:2336
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:638
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:654
Bridge specific Object Attributes.
Definition: hwloc.h:693
Virtual depth for software device object level.
Definition: hwloc.h:884
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:637
struct hwloc_obj * first_child
First normal child.
Definition: hwloc.h:492
Virtual depth for MemCache object.
Definition: hwloc.h:886
unsigned char bind_membind
Definition: hwloc.h:2340
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.
unsigned misc_arity
Number of Misc children. These children are listed in misc_first_child.
Definition: hwloc.h:537
PCI-side of a bridge.
Definition: hwloc.h:367
Do not consider resources outside of the process CPU binding.
Definition: hwloc.h:2167
unsigned short domain
Domain number (xxxx in the PCI BDF notation xxxx:yy:zz.t). Only 16bits PCI domains are supported by d...
Definition: hwloc.h:670
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:646
int hwloc_topology_allow(hwloc_topology_t restrict topology, hwloc_const_cpuset_t cpuset, hwloc_const_nodeset_t nodeset, unsigned long flags)
Change the sets of allowed PUs and NUMA nodes in the topology.
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
int hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value)
Add the given name and value pair to the given object info attributes.
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
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.
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1565
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:161
int hwloc_topology_refresh(hwloc_topology_t topology)
Refresh internal structures after topology modification.
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1236
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:617
Detect the whole system, ignore reservations, include disallowed objects.
Definition: hwloc.h:2077
Level 5 Data (or Unified) Cache.
Definition: hwloc.h:238
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1584
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.
Restrict by nodeset instead of CPU set. Only keep objects whose nodeset is included or partially incl...
Definition: hwloc.h:2542
Object info attribute (name and value strings)
Definition: hwloc.h:724
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2530
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:222
Remove all objects that became CPU-less. By default, only objects that contain no PU and no memory ar...
Definition: hwloc.h:2536
Remove all objects that became Memory-less. By default, only objects that contain no PU and no memory...
Definition: hwloc.h:2549
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:71
unsigned char secondary_bus
First PCI bus number below the bridge.
Definition: hwloc.h:707
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:469
static hwloc_obj_t hwloc_get_obj_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx)
Returns the topology object at logical index idx with type type.
unsigned char get_proc_cpubind
Definition: hwloc.h:2296
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, int depth)
Returns the width of level at depth depth.
Level 2 Data (or Unified) Cache.
Definition: hwloc.h:235
unsigned infos_count
Size of infos array.
Definition: hwloc.h:614
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2555
NUMA node. An object that contains memory that is directly and byte-accessible to the host processors...
Definition: hwloc.h:257
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:163
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:383
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
Import support from the imported topology.
Definition: hwloc.h:2142
unsigned char set_thisproc_membind
Definition: hwloc.h:2320
int hwloc_topology_abi_check(hwloc_topology_t topology)
Verify that the topology is compatible with the current hwloc library.
unsigned depth
Definition: hwloc.h:712
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:181
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:2097
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:631
struct hwloc_topology_misc_support * misc
Definition: hwloc.h:2368
Cache-specific Object Attributes.
Definition: hwloc.h:651
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:374
PCI device (filtered out by default).
Definition: hwloc.h:295
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:450
struct hwloc_info_s * infos
Array of info attributes (name and value strings).
Definition: hwloc.h:613
unsigned subkind
Internally-used subkind to distinguish different levels of groups with same kind. ...
Definition: hwloc.h:664
Set of flags describing actual support for this topology.
Definition: hwloc.h:2364
Bridge (filtered out by default). Any bridge (or PCI switch) that connects the host or an I/O bus...
Definition: hwloc.h:283
Operating system device (filtered out by default).
Definition: hwloc.h:305
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a constant stringified object type.
int hwloc_get_memory_parents_depth(hwloc_topology_t topology)
Return the depth of parents where memory objects are attached.
float linkspeed
Link speed in GB/s. This datarate is the currently configured speed of the entire PCI link (sum of th...
Definition: hwloc.h:685
unsigned memory_arity
Number of Memory children. These children are listed in memory_first_child.
Definition: hwloc.h:507
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:2308
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
unsigned char get_area_memlocation
Definition: hwloc.h:2348
unsigned short class_id
The class number (first two bytes, without the prog_if).
Definition: hwloc.h:679
Consider the bitmap argument as a nodeset.
Definition: hwloc.h:1608
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:197
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:371
unsigned char set_thisproc_cpubind
Definition: hwloc.h:2290
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:2365
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.
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:377
Do not ever modify the process or thread binding during discovery.
Definition: hwloc.h:2204
struct hwloc_obj ** children
Normal children, children[0 .. arity -1].
Definition: hwloc.h:491
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.
Machine. A set of processors and memory with cache coherency.
Definition: hwloc.h:203
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:436
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:2367
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:652
Virtual depth for Misc object.
Definition: hwloc.h:885
char * subtype
Subtype string to better describe the type field.
Definition: hwloc.h:434
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.
Core. A computation unit (may be shared by several PUs, aka logical processors).
Definition: hwloc.h:218
PCI Device specific Object Attributes.
Definition: hwloc.h:668
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:2366
unsigned char interleave_membind
Definition: hwloc.h:2342
unsigned char set_area_membind
Definition: hwloc.h:2332
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
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.
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.
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:644
unsigned char get_thisproc_cpubind
Definition: hwloc.h:2292
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:433
unsigned short domain
Domain number the downstream PCI buses. Only 16bits PCI domains are supported by default.
Definition: hwloc.h:701
unsigned char dev
Device number (zz in the PCI BDF notation xxxx:yy:zz.t).
Definition: hwloc.h:677
hwloc_obj_bridge_type_t upstream_type
Upstream Bridge type.
Definition: hwloc.h:697
unsigned char get_thread_cpubind
Definition: hwloc.h:2304
Blacklist the target component from being used.
Definition: hwloc.h:2015
struct hwloc_obj * parent
Parent, NULL if root (Machine object)
Definition: hwloc.h:481
Level 1 Data (or Unified) Cache.
Definition: hwloc.h:234
int hwloc_topology_restrict(hwloc_topology_t restrict topology, hwloc_const_bitmap_t set, unsigned long flags)
Restrict the topology to the given CPU set or nodeset.
unsigned char get_proc_membind
Definition: hwloc.h:2326
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, int depth)
Returns the type of objects at depth depth.
Unified cache.
Definition: hwloc.h:359
Ignore all objects of this type.
Definition: hwloc.h:2425
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.
unsigned char get_thisproc_membind
Definition: hwloc.h:2322
Allow a custom set of objects, given to hwloc_topology_allow() as cpuset and/or nodeset parameters...
Definition: hwloc.h:2620
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1233
Avoid any effect on CPU binding.
Definition: hwloc.h:1597
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:2288
static const char * hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name)
Search the given name in object infos and return the corresponding value.
char * name
Info name.
Definition: hwloc.h:725
Physical package. The physical package that usually gets inserted into a socket on the motherboard...
Definition: hwloc.h:212
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.
OS Device specific Object Attributes.
Definition: hwloc.h:715
Allocate each memory page individually on the local NUMA node of the thread that touches it...
Definition: hwloc.h:1510
static hwloc_obj_t hwloc_get_next_obj_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, hwloc_obj_t prev)
Returns the next object of type type.
unsigned char get_area_membind
Definition: hwloc.h:2334
struct hwloc_obj * last_child
Last normal child.
Definition: hwloc.h:493
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:742
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1544
Reset the memory allocation policy to the system default. Depending on the operating system...
Definition: hwloc.h:1499
Level 3 Data (or Unified) Cache.
Definition: hwloc.h:236
unsigned char revision
Revision number.
Definition: hwloc.h:684
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR&#39;ed flags of a topology.
int symmetric_subtree
Set if the subtree of normal objects below this object is symmetric, which means all normal children ...
Definition: hwloc.h:496
Virtual depth for PCI device object level.
Definition: hwloc.h:883
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.
Group-specific Object Attributes.
Definition: hwloc.h:660
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:597
Do not consider resources outside of the process memory binding.
Definition: hwloc.h:2189
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 short device_id
Device ID (yyyy in [xxxx:yyyy]).
Definition: hwloc.h:681
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.
Ignore distances.
Definition: hwloc.h:2211
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:653
unsigned char bus
Bus number (yy in the PCI BDF notation xxxx:yy:zz.t).
Definition: hwloc.h:676
int hwloc_topology_set_icache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all CPU instruction cache object types.
unsigned arity
Number of normal children. Memory, Misc and I/O children are not listed here but rather in their dedi...
Definition: hwloc.h:487
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
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_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 subordinate_bus
Highest PCI bus number below the bridge.
Definition: hwloc.h:708
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:178
hwloc_topology_components_flag_e
Flags to be passed to hwloc_topology_set_components()
Definition: hwloc.h:2011
struct hwloc_obj * prev_sibling
Previous object below the same parent (inside the same list of children).
Definition: hwloc.h:484
Flags describing miscellaneous features.
Definition: hwloc.h:2353
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:443
hwloc_uint64_t gp_index
Global persistent index. Generated by hwloc, unique across the topology (contrary to os_index) and pe...
Definition: hwloc.h:622
unsigned io_arity
Number of I/O children. These children are listed in io_first_child.
Definition: hwloc.h:525
unsigned char get_thisthread_last_cpu_location
Definition: hwloc.h:2310
Flags describing actual discovery support for this topology.
Definition: hwloc.h:2268
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_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
Virtual depth for NUMA nodes.
Definition: hwloc.h:881
unsigned depth
Depth of group object. It may change if intermediate Group objects are added.
Definition: hwloc.h:661
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:655
unsigned char firsttouch_membind
Definition: hwloc.h:2338
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:69
Operating system co-processor device. For instance "opencl0d0" for a OpenCL device, "cuda0" for a CUDA device.
Definition: hwloc.h:385
Avoid any effect on memory binding.
Definition: hwloc.h:1282
unsigned char set_proc_cpubind
Definition: hwloc.h:2294
struct hwloc_obj * next_sibling
Next object below the same parent (inside the same list of children).
Definition: hwloc.h:483
Get the set of allowed resources from the local operating system even if the topology was loaded from...
Definition: hwloc.h:2118
Only ignore objects if their entire level does not bring any structure.
Definition: hwloc.h:2439
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.
unsigned short subvendor_id
Sub-Vendor ID.
Definition: hwloc.h:682
unsigned char set_thread_cpubind
Definition: hwloc.h:2302
Level 2 instruction Cache (filtered out by default).
Definition: hwloc.h:241
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR&#39;ed flags to non-yet-loaded topology.
hwloc_get_type_depth_e
Definition: hwloc.h:878
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.
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_thisthread_membind
Definition: hwloc.h:2328
int hwloc_topology_set_cache_types_filter(hwloc_topology_t topology, enum hwloc_type_filter_e filter)
Set the filtering for all CPU cache object types.
struct hwloc_obj * memory_first_child
First Memory child. NUMA nodes and Memory-side caches are listed here (memory_arity and memory_first_...
Definition: hwloc.h:510
unsigned char numa
Detecting the number of NUMA nodes is supported.
Definition: hwloc.h:2272
int hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
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.
hwloc_uint64_t total_memory
Total memory (in bytes) in NUMA nodes below this object.
Definition: hwloc.h:448
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...
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.
Request for strict binding from the OS.
Definition: hwloc.h:1265
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:2318
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA, "hfi1_0" Omni-Path int...
Definition: hwloc.h:379
unsigned char migrate_membind
Definition: hwloc.h:2346
unsigned char disallowed_numa
Detecting and identifying NUMA nodes that are not available to the current process is supported...
Definition: hwloc.h:2278
Die within a physical package. A subpart of the physical package, that contains multiple cores...
Definition: hwloc.h:344
int hwloc_topology_free_group_object(hwloc_topology_t topology, hwloc_obj_t group)
Free a group object allocated with hwloc_topology_alloc_group_object().
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.
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().
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1491
Mark all objects as allowed in the topology.
Definition: hwloc.h:2607
Ignore memory attributes and tiers.
Definition: hwloc.h:2218
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:528
Instruction cache (filtered out by default).
Definition: hwloc.h:361
Object type-specific Attributes.
Definition: hwloc.h:634
hwloc_cpuset_t complete_cpuset
The complete CPU set of processors of this object,.
Definition: hwloc.h:562
unsigned char dont_merge
Flag preventing groups from being automatically merged with identical parent or children.
Definition: hwloc.h:665
unsigned char disallowed_pu
Detecting and identifying PU objects that are not available to the current process is supported...
Definition: hwloc.h:2276
hwloc_obj_osdev_type_t type
Definition: hwloc.h:716
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:645
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:478
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().
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
Keep all objects of this type.
Definition: hwloc.h:2417
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:358
Allocate memory on the specified nodes.
Definition: hwloc.h:1520
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:477
unsigned char set_proc_membind
Definition: hwloc.h:2324
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:365
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.
unsigned char set_thisthread_cpubind
Definition: hwloc.h:2298
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...
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1529
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:2270
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:2306