Hardware Locality (hwloc)  1.11.3
hwloc.h
1 /*
2  * Copyright © 2009 CNRS
3  * Copyright © 2009-2016 Inria. All rights reserved.
4  * Copyright © 2009-2012 Université Bordeaux
5  * Copyright © 2009-2011 Cisco Systems, Inc. All rights reserved.
6  * See COPYING in top-level directory.
7  */
8 
9 /*=====================================================================
10  * PLEASE GO READ THE DOCUMENTATION!
11  * ------------------------------------------------
12  * $tarball_directory/doc/doxygen-doc/
13  * or
14  * http://www.open-mpi.org/projects/hwloc/doc/
15  *=====================================================================
16  *
17  * FAIR WARNING: Do NOT expect to be able to figure out all the
18  * subtleties of hwloc by simply reading function prototypes and
19  * constant descrptions here in this file.
20  *
21  * Hwloc has wonderful documentation in both PDF and HTML formats for
22  * your reading pleasure. The formal documentation explains a LOT of
23  * hwloc-specific concepts, provides definitions, and discusses the
24  * "big picture" for many of the things that you'll find here in this
25  * header file.
26  *
27  * The PDF/HTML documentation was generated via Doxygen; much of what
28  * you'll see in there is also here in this file. BUT THERE IS A LOT
29  * THAT IS IN THE PDF/HTML THAT IS ***NOT*** IN hwloc.h!
30  *
31  * There are entire paragraph-length descriptions, discussions, and
32  * pretty prictures to explain subtle corner cases, provide concrete
33  * examples, etc.
34  *
35  * Please, go read the documentation. :-)
36  *
37  * Moreover there are several examples of hwloc use under doc/examples
38  * in the source tree.
39  *
40  *=====================================================================*/
41 
50 #ifndef HWLOC_H
51 #define HWLOC_H
52 
53 #include <hwloc/autogen/config.h>
54 #include <sys/types.h>
55 #include <stdio.h>
56 #include <string.h>
57 #include <limits.h>
58 
59 /*
60  * Symbol transforms
61  */
62 #include <hwloc/rename.h>
63 
64 /*
65  * Bitmap definitions
66  */
67 
68 #include <hwloc/bitmap.h>
69 #include <hwloc/cpuset.h>
70 
71 
72 #ifdef __cplusplus
73 extern "C" {
74 #endif
75 
76 
82 #define HWLOC_API_VERSION 0x00010b00
83 
88 HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);
89 
91 #define HWLOC_COMPONENT_ABI 4
92 
129 
149 
164 typedef enum {
165  /* ***************************************************************
166  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
167 
168  If new enum values are added here, you MUST also go update the
169  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
170 
171  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
172  *************************************************************** */
173 
245  HWLOC_OBJ_TYPE_MAX
247  /* ***************************************************************
248  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
249 
250  If new enum values are added here, you MUST also go update the
251  obj_type_order[] and obj_order_type[] arrays in src/topology.c.
252 
253  WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
254  *************************************************************** */
256 
264 
270 
290 
308 HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const;
309 
312 };
313 
322 union hwloc_obj_attr_u;
323 
326  hwloc_uint64_t total_memory;
327  hwloc_uint64_t local_memory;
330  unsigned page_types_len;
337  hwloc_uint64_t size;
338  hwloc_uint64_t count;
339  } * page_types;
340 };
341 
346 struct hwloc_obj {
347  /* physical information */
348  hwloc_obj_type_t type;
350  unsigned os_index;
354  char *name;
359  struct hwloc_obj_memory_s memory;
364  /* global position */
365  unsigned depth;
370  unsigned logical_index;
374  signed os_level;
376  /* cousins are all objects of the same type (and depth) across the entire topology */
380  /* children of the same parent are siblings, even if they may have different type and depth */
381  struct hwloc_obj *parent;
382  unsigned sibling_rank;
386  /* children array below this object */
387  unsigned arity;
388  struct hwloc_obj **children;
392  /* misc */
393  void *userdata;
398  /* cpusets and nodesets */
399  hwloc_cpuset_t cpuset;
412  hwloc_cpuset_t complete_cpuset;
423  hwloc_cpuset_t online_cpuset;
431  hwloc_cpuset_t allowed_cpuset;
442  hwloc_nodeset_t nodeset;
459  hwloc_nodeset_t complete_nodeset;
473  hwloc_nodeset_t allowed_nodeset;
487  unsigned distances_count;
488 
490  unsigned infos_count;
497 };
501 typedef struct hwloc_obj * hwloc_obj_t;
502 
507  hwloc_uint64_t size;
508  unsigned depth;
509  unsigned linesize;
512  hwloc_obj_cache_type_t type;
513  } cache;
516  unsigned depth;
517  } group;
520  unsigned short domain;
521  unsigned char bus, dev, func;
522  unsigned short class_id;
523  unsigned short vendor_id, device_id, subvendor_id, subdevice_id;
524  unsigned char revision;
525  float linkspeed; /* in GB/s */
526  } pcidev;
529  union {
531  } upstream;
532  hwloc_obj_bridge_type_t upstream_type;
533  union {
534  struct {
535  unsigned short domain;
536  unsigned char secondary_bus, subordinate_bus;
537  } pci;
538  } downstream;
539  hwloc_obj_bridge_type_t downstream_type;
540  unsigned depth;
541  } bridge;
544  hwloc_obj_osdev_type_t type;
545  } osdev;
546 };
547 
562  unsigned relative_depth;
564  unsigned nbobjs;
569  float *latency;
581  float latency_max;
582  float latency_base;
586 };
587 
593  char *name;
594  char *value;
595 };
596 
605 struct hwloc_topology;
610 typedef struct hwloc_topology * hwloc_topology_t;
611 
618 HWLOC_DECLSPEC int hwloc_topology_init (hwloc_topology_t *topologyp);
619 
637 HWLOC_DECLSPEC int hwloc_topology_load(hwloc_topology_t topology);
638 
643 HWLOC_DECLSPEC void hwloc_topology_destroy (hwloc_topology_t topology);
644 
655 HWLOC_DECLSPEC int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology);
656 
668 HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
669 
706 HWLOC_DECLSPEC int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type);
707 
716 HWLOC_DECLSPEC int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type);
717 
724 HWLOC_DECLSPEC int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology);
725 
744 
764 
777 
786 
796 
804 };
805 
815 HWLOC_DECLSPEC int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags);
816 
823 HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology);
824 
839 HWLOC_DECLSPEC int hwloc_topology_set_pid(hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid);
840 
867 HWLOC_DECLSPEC int hwloc_topology_set_fsroot(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict fsroot_path);
868 
896 HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict description);
897 
924 HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
925 
952 HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
953 
973 HWLOC_DECLSPEC int hwloc_topology_set_custom(hwloc_topology_t topology);
974 
993 HWLOC_DECLSPEC int hwloc_topology_set_distance_matrix(hwloc_topology_t __hwloc_restrict topology,
994  hwloc_obj_type_t type, unsigned nbobjs,
995  unsigned *os_index, float *distances);
996 
1004 HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1005 
1009  unsigned char pu;
1010 };
1011 
1019  unsigned char set_thisproc_cpubind;
1021  unsigned char get_thisproc_cpubind;
1023  unsigned char set_proc_cpubind;
1025  unsigned char get_proc_cpubind;
1027  unsigned char set_thisthread_cpubind;
1029  unsigned char get_thisthread_cpubind;
1031  unsigned char set_thread_cpubind;
1033  unsigned char get_thread_cpubind;
1040 };
1041 
1049  unsigned char set_thisproc_membind;
1051  unsigned char get_thisproc_membind;
1053  unsigned char set_proc_membind;
1055  unsigned char get_proc_membind;
1057  unsigned char set_thisthread_membind;
1059  unsigned char get_thisthread_membind;
1061  unsigned char set_area_membind;
1063  unsigned char get_area_membind;
1065  unsigned char alloc_membind;
1067  unsigned char firsttouch_membind;
1069  unsigned char bind_membind;
1071  unsigned char interleave_membind;
1073  unsigned char replicate_membind;
1075  unsigned char nexttouch_membind;
1077  unsigned char migrate_membind;
1079  unsigned char get_area_memlocation;
1080 };
1081 
1092 };
1093 
1103 HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(hwloc_topology_t __hwloc_restrict topology);
1104 
1115 HWLOC_DECLSPEC void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata);
1116 
1122 HWLOC_DECLSPEC void * hwloc_topology_get_userdata(hwloc_topology_t topology);
1123 
1141 HWLOC_DECLSPEC unsigned hwloc_topology_get_depth(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure;
1142 
1165 HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type);
1166 
1173 };
1174 
1184 static __hwloc_inline int
1185 hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1186 
1196 static __hwloc_inline int
1197 hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1198 
1205 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1206 
1209 HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure;
1210 
1216 static __hwloc_inline int
1217 hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure;
1218 
1224 static __hwloc_inline hwloc_obj_t
1225 hwloc_get_root_obj (hwloc_topology_t topology) __hwloc_attribute_pure;
1226 
1228 HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, unsigned depth, unsigned idx) __hwloc_attribute_pure;
1229 
1236 static __hwloc_inline hwloc_obj_t
1237 hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
1238 
1243 static __hwloc_inline hwloc_obj_t
1244 hwloc_get_next_obj_by_depth (hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev);
1245 
1252 static __hwloc_inline hwloc_obj_t
1253 hwloc_get_next_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type,
1254  hwloc_obj_t prev);
1255 
1271 HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const;
1272 
1286 HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj,
1287  int verbose);
1288 
1300 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj, const char * __hwloc_restrict separator,
1301  int verbose);
1302 
1310 HWLOC_DECLSPEC int hwloc_obj_cpuset_snprintf(char * __hwloc_restrict str, size_t size, size_t nobj, const hwloc_obj_t * __hwloc_restrict objs);
1311 
1341 HWLOC_DECLSPEC int hwloc_obj_type_sscanf(const char *string,
1342  hwloc_obj_type_t *typep,
1343  int *depthattrp,
1344  void *typeattrp, size_t typeattrsize);
1345 
1361 static __hwloc_inline const char *
1362 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_pure;
1363 
1378 HWLOC_DECLSPEC void hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
1379 
1448 typedef enum {
1452 
1456 
1481 
1499 
1505 HWLOC_DECLSPEC int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags);
1506 
1512 HWLOC_DECLSPEC int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1513 
1525 HWLOC_DECLSPEC int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int flags);
1526 
1538 HWLOC_DECLSPEC int hwloc_get_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1539 
1540 #ifdef hwloc_thread_t
1541 
1548 HWLOC_DECLSPEC int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags);
1549 #endif
1550 
1551 #ifdef hwloc_thread_t
1552 
1559 HWLOC_DECLSPEC int hwloc_get_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_cpuset_t set, int flags);
1560 #endif
1561 
1575 HWLOC_DECLSPEC int hwloc_get_last_cpu_location(hwloc_topology_t topology, hwloc_cpuset_t set, int flags);
1576 
1593 HWLOC_DECLSPEC int hwloc_get_proc_last_cpu_location(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int flags);
1594 
1676 typedef enum {
1687 
1697 
1701 
1710 
1723 
1730 
1737 
1751 typedef enum {
1757 
1762 
1770 
1776 
1789 
1801 
1814 HWLOC_DECLSPEC int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags);
1815 
1831 HWLOC_DECLSPEC int hwloc_set_membind(hwloc_topology_t topology, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags);
1832 
1874 HWLOC_DECLSPEC int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t * policy, int flags);
1875 
1920 HWLOC_DECLSPEC int hwloc_get_membind(hwloc_topology_t topology, hwloc_bitmap_t set, hwloc_membind_policy_t * policy, int flags);
1921 
1931 HWLOC_DECLSPEC int hwloc_set_proc_membind_nodeset(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags);
1932 
1945 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);
1946 
1983 HWLOC_DECLSPEC int hwloc_get_proc_membind_nodeset(hwloc_topology_t topology, hwloc_pid_t pid, hwloc_nodeset_t nodeset, hwloc_membind_policy_t * policy, int flags);
1984 
2024 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);
2025 
2033 HWLOC_DECLSPEC int hwloc_set_area_membind_nodeset(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags);
2034 
2045 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);
2046 
2071 HWLOC_DECLSPEC int hwloc_get_area_membind_nodeset(hwloc_topology_t topology, const void *addr, size_t len, hwloc_nodeset_t nodeset, hwloc_membind_policy_t * policy, int flags);
2072 
2100 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);
2101 
2123 HWLOC_DECLSPEC int hwloc_get_area_memlocation(hwloc_topology_t topology, const void *addr, size_t len, hwloc_bitmap_t set, int flags);
2124 
2132 HWLOC_DECLSPEC void *hwloc_alloc(hwloc_topology_t topology, size_t len);
2133 
2145 HWLOC_DECLSPEC void *hwloc_alloc_membind_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags) __hwloc_attribute_malloc;
2146 
2161 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;
2162 
2169 static __hwloc_inline void *
2170 hwloc_alloc_membind_policy_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags) __hwloc_attribute_malloc;
2171 
2181 static __hwloc_inline void *
2182 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;
2183 
2187 HWLOC_DECLSPEC int hwloc_free(hwloc_topology_t topology, void *addr, size_t len);
2188 
2211 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, const char *name);
2212 
2228 HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_insert_misc_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, const char *name);
2229 
2237 
2243 
2249 };
2250 
2272 HWLOC_DECLSPEC int hwloc_topology_restrict(hwloc_topology_t __hwloc_restrict topology, hwloc_const_cpuset_t cpuset, unsigned long flags);
2273 
2307 HWLOC_DECLSPEC int hwloc_custom_insert_topology(hwloc_topology_t newtopology, hwloc_obj_t newparent, hwloc_topology_t oldtopology, hwloc_obj_t oldroot);
2308 
2330 HWLOC_DECLSPEC hwloc_obj_t hwloc_custom_insert_group_object_by_parent(hwloc_topology_t topology, hwloc_obj_t parent, int groupdepth);
2331 
2357 HWLOC_DECLSPEC int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath);
2358 
2377 HWLOC_DECLSPEC int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen);
2378 
2380 HWLOC_DECLSPEC void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer);
2381 
2400 HWLOC_DECLSPEC void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology,
2401  void (*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj));
2402 
2428 HWLOC_DECLSPEC int hwloc_export_obj_userdata(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length);
2429 
2443 HWLOC_DECLSPEC int hwloc_export_obj_userdata_base64(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length);
2444 
2467 HWLOC_DECLSPEC void hwloc_topology_set_userdata_import_callback(hwloc_topology_t topology,
2468  void (*import_cb)(hwloc_topology_t topology, hwloc_obj_t obj, const char *name, const void *buffer, size_t length));
2469 
2488 
2496 };
2497 
2516  HWLOC_DECLSPEC int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags);
2517 
2522 #ifdef __cplusplus
2523 } /* extern "C" */
2524 #endif
2525 
2526 
2527 /* high-level helpers */
2528 #include <hwloc/helper.h>
2529 
2530 /* inline code of some functions above */
2531 #include <hwloc/inlines.h>
2532 
2533 /* topology diffs */
2534 #include <hwloc/diff.h>
2535 
2536 /* deprecated headers */
2537 #include <hwloc/deprecated.h>
2538 
2539 #endif /* HWLOC_H */
struct hwloc_distances_s ** distances
Distances between all objects at same depth below this object.
Definition: hwloc.h:486
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:539
Structure of a topology object.
Definition: hwloc.h:346
Assume that the selected backend provides the topology for the system on which we are running...
Definition: hwloc.h:763
const char * hwloc_obj_type_string(hwloc_obj_type_t type)
Return a constant stringified object type.
Bind all threads of the current (possibly) multithreaded process.
Definition: hwloc.h:1451
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.
Avoid any effect on CPU binding.
Definition: hwloc.h:1788
Distances between objects.
Definition: hwloc.h:561
Request for strict binding from the OS.
Definition: hwloc.h:1480
unsigned char get_thisproc_last_cpu_location
Definition: hwloc.h:1035
unsigned char migrate_membind
Definition: hwloc.h:1077
void hwloc_topology_check(hwloc_topology_t topology)
Run internal checks on a topology structure.
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.
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.
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.
Virtual depth for PCI device object level.
Definition: hwloc.h:1171
Detect PCI bridges.
Definition: hwloc.h:785
PCI-side of a bridge.
Definition: hwloc.h:268
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...
Array of local memory page types, NULL if no local memory and page_types is 0.
Definition: hwloc.h:336
unsigned char get_thisthread_membind
Definition: hwloc.h:1059
char * name
Info name.
Definition: hwloc.h:593
unsigned char set_proc_membind
Definition: hwloc.h:1053
hwloc_get_type_depth_e
Definition: hwloc.h:1167
float latency_base
The multiplier that should be applied to latency matrix to retrieve the original OS-provided latencie...
Definition: hwloc.h:582
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.
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:283
Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the ...
Definition: hwloc.h:1709
unsigned depth
Definition: hwloc.h:540
Set of flags describing actual support for this topology.
Definition: hwloc.h:1088
Detect instruction caches.
Definition: hwloc.h:803
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:348
void hwloc_topology_set_userdata_export_callback(hwloc_topology_t topology, void(*export_cb)(void *reserved, hwloc_topology_t topology, hwloc_obj_t obj))
Set the application-specific callback for exporting object userdata.
int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char *restrict description)
Enable synthetic topology.
PCI Device specific Object Attributes.
Definition: hwloc.h:519
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 char get_thisthread_last_cpu_location
Definition: hwloc.h:1039
void * hwloc_alloc_membind(hwloc_topology_t topology, size_t len, hwloc_const_bitmap_t set, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by set.
int hwloc_compare_types(hwloc_obj_type_t type1, hwloc_obj_type_t type2)
Compare the depth of two object types.
int hwloc_topology_dup(hwloc_topology_t *newtopology, hwloc_topology_t oldtopology)
Duplicate a topology.
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:512
unsigned short class_id
Definition: hwloc.h:522
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.
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:399
hwloc_uint64_t total_memory
Total memory (in bytes) in this object and its children.
Definition: hwloc.h:326
unsigned page_types_len
Size of array page_types.
Definition: hwloc.h:330
unsigned logical_index
Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire mach...
Definition: hwloc.h:370
unsigned char get_area_membind
Definition: hwloc.h:1063
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:50
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.
unsigned short domain
Definition: hwloc.h:535
float linkspeed
Definition: hwloc.h:525
unsigned sibling_rank
Index in parent&#39;s children[] array.
Definition: hwloc.h:382
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:1729
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:610
unsigned char set_area_membind
Definition: hwloc.h:1061
Group-specific Object Attributes.
Definition: hwloc.h:515
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:381
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.
Detect the whole PCI hierarchy.
Definition: hwloc.h:795
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
hwloc_cpubind_flags_t
Process/Thread binding flags.
Definition: hwloc.h:1448
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.
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:423
unsigned char get_thread_cpubind
Definition: hwloc.h:1033
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:361
Replicate memory on the given nodes; reads from this memory will attempt to be serviced from the NUMA...
Definition: hwloc.h:1722
Whole system (may be a cluster of machines). The whole system that is accessible to hwloc...
Definition: hwloc.h:174
NUMA node. A set of processors around memory which the processors can directly access.
Definition: hwloc.h:184
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.
unsigned linesize
Cache-line size in bytes. 0 if unknown.
Definition: hwloc.h:509
Adapt distance matrices according to objects being removed during restriction. If this flag is not se...
Definition: hwloc.h:2236
Reset the memory allocation policy to the system default. Depending on the operating system...
Definition: hwloc.h:1686
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:532
Set policy for all threads of the specified (possibly multithreaded) process. This flag is mutually e...
Definition: hwloc.h:1756
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:354
int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char *restrict xmlpath)
Enable XML-file based topology.
hwloc_membind_flags_t
Memory binding flags.
Definition: hwloc.h:1751
Detect PCI devices.
Definition: hwloc.h:776
int hwloc_topology_set_custom(hwloc_topology_t topology)
Prepare the topology for custom assembly.
unsigned char subordinate_bus
Definition: hwloc.h:536
unsigned long hwloc_topology_get_flags(hwloc_topology_t topology)
Get OR&#39;ed flags of a topology.
hwloc_obj_type_t hwloc_get_depth_type(hwloc_topology_t topology, unsigned depth)
Returns the type of objects at depth depth.
Bridge specific Object Attribues.
Definition: hwloc.h:528
unsigned char get_proc_last_cpu_location
Definition: hwloc.h:1037
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.
hwloc_uint64_t size
Size of cache in bytes.
Definition: hwloc.h:507
Flags describing actual memory binding support for this topology.
Definition: hwloc.h:1047
Allocate memory on the specified nodes.
Definition: hwloc.h:1700
unsigned char nexttouch_membind
Definition: hwloc.h:1075
void hwloc_topology_destroy(hwloc_topology_t topology)
Terminate and free a topology context.
hwloc_topology_export_synthetic_flags_e
Flags for exporting synthetic topologies.
Definition: hwloc.h:2481
int hwloc_set_area_membind_nodeset(hwloc_topology_t topology, const void *addr, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Bind the already-allocated memory identified by (addr, len) to the NUMA node(s) specified by nodeset...
enum hwloc_obj_bridge_type_e hwloc_obj_bridge_type_t
Type of one side (upstream or downstream) of an I/O bridge.
void * userdata
Application-given private data pointer, initialized to NULL, use it as you wish. See hwloc_topology_s...
Definition: hwloc.h:393
unsigned char interleave_membind
Definition: hwloc.h:1071
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
unsigned char alloc_membind
Definition: hwloc.h:1065
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.
unsigned distances_count
Definition: hwloc.h:487
Machine. The typical root object type. A set of processors and memory with cache coherency.
Definition: hwloc.h:179
int hwloc_topology_set_pid(hwloc_topology_t restrict topology, hwloc_pid_t pid)
Change which process the topology is viewed from.
float * latency
Matrix of latencies between objects, stored as a one-dimension array. May be NULL if the distances co...
Definition: hwloc.h:569
void * hwloc_alloc(hwloc_topology_t topology, size_t len)
Allocate some memory.
unsigned char bind_membind
Definition: hwloc.h:1069
unsigned char set_thisthread_cpubind
Definition: hwloc.h:1027
Migrate existing allocated memory. If the memory cannot be migrated and the HWLOC_MEMBIND_STRICT flag...
Definition: hwloc.h:1775
unsigned char set_thisthread_membind
Definition: hwloc.h:1057
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.
Move Misc objects to ancestors if their parents are removed during restriction. If this flag is not s...
Definition: hwloc.h:2242
Object info.
Definition: hwloc.h:592
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:378
int hwloc_obj_type_sscanf(const char *string, hwloc_obj_type_t *typep, int *depthattrp, void *typeattrp, size_t typeattrsize)
Return an object type and attributes from a type string.
int hwloc_set_cpubind(hwloc_topology_t topology, hwloc_const_cpuset_t set, int flags)
Bind current process or thread on cpus given in physical bitmap set.
unsigned char get_proc_cpubind
Definition: hwloc.h:1025
hwloc_membind_policy_t
Memory binding policy.
Definition: hwloc.h:1676
Bind current thread of current process.
Definition: hwloc.h:1455
hwloc_uint64_t local_memory
Local memory (in bytes)
Definition: hwloc.h:327
struct hwloc_obj_info_s * infos
Array of stringified info type=name.
Definition: hwloc.h:489
int hwloc_topology_load(hwloc_topology_t topology)
Build the actual topology.
unsigned infos_count
Size of infos array.
Definition: hwloc.h:490
void hwloc_topology_set_userdata(hwloc_topology_t topology, const void *userdata)
Set the topology-specific userdata pointer.
hwloc_obj_osdev_type_e
Type of a OS device.
Definition: hwloc.h:272
hwloc_obj_cache_type_e
Cache type.
Definition: hwloc.h:258
unsigned char set_proc_cpubind
Definition: hwloc.h:1023
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...
signed os_level
OS-provided physical level, -1 if unknown or meaningless.
Definition: hwloc.h:374
Data cache.
Definition: hwloc.h:260
int symmetric_subtree
Set if the subtree of objects below this object is symmetric, which means all children and their chil...
Definition: hwloc.h:492
OS Device specific Object Attributes.
Definition: hwloc.h:543
hwloc_uint64_t count
Number of pages of this size.
Definition: hwloc.h:338
unsigned char replicate_membind
Definition: hwloc.h:1073
hwloc_obj_bridge_type_e
Type of one side (upstream or downstream) of an I/O bridge.
Definition: hwloc.h:266
unsigned char get_proc_membind
Definition: hwloc.h:1055
Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...
Definition: hwloc.h:208
Do not export level attributes.
Definition: hwloc.h:2495
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 relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:562
int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Ignore an object type.
Export extended types such as L2dcache as basic types such as Cache.
Definition: hwloc.h:2487
unsigned char get_thisthread_cpubind
Definition: hwloc.h:1029
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:164
Returned by get_membind() functions when multiple threads or parts of a memory area have differing me...
Definition: hwloc.h:1735
unsigned char set_thread_cpubind
Definition: hwloc.h:1031
Operating system openfabrics device. For instance the "mlx4_0" InfiniBand HCA, or "hfi1_0" Omni-Path ...
Definition: hwloc.h:280
Virtual depth for bridge object level.
Definition: hwloc.h:1170
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:148
hwloc_restrict_flags_e
Flags to be given to hwloc_topology_restrict().
Definition: hwloc.h:2231
int hwloc_topology_set_flags(hwloc_topology_t topology, unsigned long flags)
Set OR&#39;ed flags to non-yet-loaded topology.
Set policy for a specific thread of the current process. This flag is mutually exclusive with HWLOC_M...
Definition: hwloc.h:1761
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().
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:234
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.
Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allo...
Definition: hwloc.h:1696
unsigned arity
Number of children.
Definition: hwloc.h:387
void * hwloc_alloc_membind_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by nodeset.
unsigned char firsttouch_membind
Definition: hwloc.h:1067
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:508
Instruction cache. Only used when the HWLOC_TOPOLOGY_FLAG_ICACHES topology flag is set...
Definition: hwloc.h:261
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:199
unsigned nbobjs
Number of objects considered in the matrix. It is the number of descendant objects at relative_depth ...
Definition: hwloc.h:564
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...
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.
Object type-specific Attributes.
Definition: hwloc.h:504
unsigned depth
Depth of group object.
Definition: hwloc.h:516
unsigned char func
Definition: hwloc.h:521
unsigned char set_thisproc_membind
Definition: hwloc.h:1049
unsigned char get_area_memlocation
Definition: hwloc.h:1079
void hwloc_free_xmlbuffer(hwloc_topology_t topology, char *xmlbuffer)
Free a buffer allocated by hwloc_topology_export_xmlbuffer()
No object of given type exists in the topology.
Definition: hwloc.h:1168
struct hwloc_obj * last_child
Last child.
Definition: hwloc.h:390
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.
Flags describing actual discovery support for this topology.
Definition: hwloc.h:1007
float latency_max
The maximal value in the latency matrix.
Definition: hwloc.h:581
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition: hwloc.h:501
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 os_index
OS-provided physical index number. It is not guaranteed unique across the entire machine, except for PUs and NUMA nodes.
Definition: hwloc.h:350
Operating system network device. For instance the "eth0" interface on Linux.
Definition: hwloc.h:278
unsigned short vendor_id
Definition: hwloc.h:523
Move I/O objects to ancestors if their parents are removed during restriction. If this flag is not se...
Definition: hwloc.h:2248
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:431
unsigned char get_thisproc_cpubind
Definition: hwloc.h:1021
struct hwloc_topology_cpubind_support * cpubind
Definition: hwloc.h:1090
Operating system co-processor device. For instance "mic0" for a Xeon Phi (MIC) on Linux...
Definition: hwloc.h:285
unsigned hwloc_topology_get_depth(hwloc_topology_t restrict topology)
Get the depth of the hierarchical tree of objects.
int hwloc_topology_export_xml(hwloc_topology_t topology, const char *xmlpath)
Export the topology into an XML file.
Miscellaneous objects. Objects without particular meaning, that can e.g. be added by the application ...
Definition: hwloc.h:221
hwloc_topology_flags_e
Flags to be set onto a topology context before load.
Definition: hwloc.h:731
struct hwloc_topology_membind_support * membind
Definition: hwloc.h:1091
struct hwloc_obj_memory_s::hwloc_obj_memory_page_type_s * page_types
unsigned char set_thisproc_cpubind
Definition: hwloc.h:1019
Cache. Can be L1i, L1d, L2, L3, ...
Definition: hwloc.h:192
int hwloc_get_cpubind(hwloc_topology_t topology, hwloc_cpuset_t set, int flags)
Get current process or thread binding.
Virtual depth for software device object level.
Definition: hwloc.h:1172
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_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_compare_types_e
Definition: hwloc.h:310
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:128
int hwloc_topology_export_xmlbuffer(hwloc_topology_t topology, char **xmlbuffer, int *buflen)
Export the topology into a newly-allocated XML memory buffer.
const struct hwloc_bitmap_s * hwloc_const_bitmap_t
a non-modifiable hwloc_bitmap_t
Definition: bitmap.h:52
Definition: hwloc.h:1769
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.
static int hwloc_get_nbobjs_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the width of level type type.
Core. A computation unit (may be shared by several logical processors).
Definition: hwloc.h:195
Avoid any effect on memory binding.
Definition: hwloc.h:1497
int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t thread, hwloc_const_cpuset_t set, int flags)
Bind a thread thread on cpus given in physical bitmap set.
Flags describing actual PU binding support for this topology.
Definition: hwloc.h:1017
struct hwloc_obj * prev_sibling
Previous object below the same parent.
Definition: hwloc.h:384
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...
hwloc_nodeset_t allowed_nodeset
The set of allowed NUMA memory nodes.
Definition: hwloc.h:473
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_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:459
Value returned by hwloc_compare_types() when types can not be compared.
Definition: hwloc.h:311
static hwloc_obj_t hwloc_get_next_obj_by_depth(hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev)
Returns the next object at depth depth.
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.
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.
int hwloc_get_membind_nodeset(hwloc_topology_t topology, hwloc_nodeset_t nodeset, hwloc_membind_policy_t *policy, int flags)
Query the default memory binding policy and physical locality of the current process or thread...
hwloc_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.
hwloc_obj_osdev_type_t type
Definition: hwloc.h:544
unsigned char pu
Detecting the number of PU objects is supported.
Definition: hwloc.h:1009
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.
Bridge. Any bridge that connects the host or an I/O bus, to another I/O bus. Bridge objects have neit...
Definition: hwloc.h:227
int associativity
Ways of associativity, -1 if fully associative, 0 if unknown.
Definition: hwloc.h:510
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.
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:412
int hwloc_set_membind_nodeset(hwloc_topology_t topology, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Set the default memory binding policy of the current process or thread to prefer the NUMA node(s) spe...
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:442
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.
Unified cache.
Definition: hwloc.h:259
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:267
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:388
Object memory.
Definition: hwloc.h:325
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1169
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:275
void * hwloc_topology_get_userdata(hwloc_topology_t topology)
Retrieve the topology-specific userdata pointer.
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
struct hwloc_topology_discovery_support * discovery
Definition: hwloc.h:1089
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 depth
Vertical index in the hierarchy. If the topology is symmetric, this is equal to the parent depth plus...
Definition: hwloc.h:365
Operating system block device. For instance "sda" on Linux.
Definition: hwloc.h:273
unsigned hwloc_get_api_version(void)
Indicate at runtime which hwloc API version was used at build time.
static void * hwloc_alloc_membind_policy_nodeset(hwloc_topology_t topology, size_t len, hwloc_const_nodeset_t nodeset, hwloc_membind_policy_t policy, int flags)
Allocate some memory on NUMA memory nodes specified by nodeset.
Operating system device. These objects have neither CPU sets nor node sets. They are not added to the...
Definition: hwloc.h:239
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:126
struct hwloc_obj * next_sibling
Next object below the same parent.
Definition: hwloc.h:383
Detect the whole system, ignore reservations and offline settings.
Definition: hwloc.h:743
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:377
int hwloc_topology_init(hwloc_topology_t *topologyp)
Allocate a topology context.
int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology)
Ignore all objects that do not bring any structure.
Physical package, what goes into a socket. In the physical meaning, i.e. that you can add or remove p...
Definition: hwloc.h:188
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.
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:145
unsigned char get_thisproc_membind
Definition: hwloc.h:1051
int hwloc_topology_export_synthetic(hwloc_topology_t topology, char *buffer, size_t buflen, unsigned long flags)
Export the topology as a synthetic string.
hwloc_uint64_t size
Size of pages.
Definition: hwloc.h:337
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...
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.
const struct hwloc_topology_support * hwloc_topology_get_support(hwloc_topology_t restrict topology)
Retrieve the topology support.
Consider the bitmap argument as a nodeset.
Definition: hwloc.h:1799
Cache-specific Object Attributes.
Definition: hwloc.h:506
unsigned hwloc_get_nbobjs_by_depth(hwloc_topology_t topology, unsigned depth)
Returns the width of level at depth depth.
unsigned char revision
Definition: hwloc.h:524
unsigned short domain
Definition: hwloc.h:520
struct hwloc_obj * first_child
First child.
Definition: hwloc.h:389
char * value
Info value.
Definition: hwloc.h:594
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
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.