Portable Hardware Locality (hwloc) Documentation: v0.9.3
	|   Home   |   Support   |   FAQ   |
About   Presentations   Open MPI Team   FAQ   Videos   Performance  Open MPI Software   Download   Documentation   Source Code Access   Bug Tracking   Regression Testing   Version Information  Sub-Projects   Hardware Locality     Download v2.10 (new)     Download v2.9 (stable)     Download v2.8 (old)     Download ancient     Documentation     Tutorials     Best of lstopo     XML topology database     License     Mailing lists     Bug tracking     Git access     Nightly snapshots   Network Locality   MPI Testing Tool   Open Tool for Parameter Optimization  Community   Mailing Lists   Getting Help/Support   Contribute   Contact   License	hwloc.h Go to the documentation of this file. /* * Copyright © 2009 CNRS, INRIA, Université Bordeaux 1 * Copyright © 2009 Cisco Systems, Inc. All rights reserved. * See COPYING in top-level directory. */ #ifndef HWLOC_H #define HWLOC_H #include <sys/types.h> #include <stdio.h> #include <limits.h> /* * Cpuset bitmask definitions */ #include <hwloc/cpuset.h> struct hwloc_topology; typedef struct hwloc_topology * hwloc_topology_t; typedef enum { HWLOC_OBJ_SYSTEM, HWLOC_OBJ_MACHINE, HWLOC_OBJ_NODE, HWLOC_OBJ_SOCKET, HWLOC_OBJ_CACHE, HWLOC_OBJ_CORE, HWLOC_OBJ_PROC, HWLOC_OBJ_MISC, } hwloc_obj_type_t; int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2); #define HWLOC_TYPE_UNORDERED INT_MAX union hwloc_obj_attr_u; struct hwloc_obj { /* physical information */ hwloc_obj_type_t type; signed os_index; char *name; union hwloc_obj_attr_u *attr; /* global position */ unsigned depth; unsigned logical_index; struct hwloc_obj *next_cousin; struct hwloc_obj *prev_cousin; /* father */ struct hwloc_obj *father; unsigned sibling_rank; struct hwloc_obj *next_sibling; struct hwloc_obj *prev_sibling; /* children */ unsigned arity; struct hwloc_obj **children; struct hwloc_obj *first_child; struct hwloc_obj *last_child; /* misc */ void *userdata; /* cpuset */ hwloc_cpuset_t cpuset; signed os_level; }; typedef struct hwloc_obj * hwloc_obj_t; union hwloc_obj_attr_u { struct hwloc_cache_attr_s { unsigned long memory_kB; unsigned depth; } cache; struct hwloc_memory_attr_s { unsigned long memory_kB; unsigned long huge_page_free; } node; struct hwloc_machine_attr_s { char *dmi_board_vendor; char *dmi_board_name; unsigned long memory_kB; unsigned long huge_page_free; unsigned long huge_page_size_kB; } machine; struct hwloc_machine_attr_s system; struct hwloc_misc_attr_s { unsigned depth; } misc; }; extern int hwloc_topology_init (hwloc_topology_t *topologyp); extern int hwloc_topology_load(hwloc_topology_t topology); extern void hwloc_topology_destroy (hwloc_topology_t topology); extern void hwloc_topology_check(hwloc_topology_t topology); extern int hwloc_topology_ignore_type(hwloc_topology_t topology, hwloc_obj_type_t type); extern int hwloc_topology_ignore_type_keep_structure(hwloc_topology_t topology, hwloc_obj_type_t type); extern int hwloc_topology_ignore_all_keep_structure(hwloc_topology_t topology); enum hwloc_topology_flags_e { /* \brief Detect the whole system, ignore reservations that may have been setup by the administrator. * * Gather all resources, even if some were disabled by the administrator. * For instance, ignore Linux Cpusets and gather all processors and memory nodes. */ HWLOC_TOPOLOGY_FLAG_WHOLE_SYSTEM = (1<<0), /* \brief Assume that the selected backend provides the topology for the * system on which we are running. * * This forces is_thissystem to 1, i.e. makes hwloc assume that the selected * backend provides the topology for the system on which we are running, even * if it is not the OS-specific backend but the XML backend for instance. * This means making the binding functions actually call the OS-specific * system calls and really do binding, while the XML backend would otherwise * provide empty hooks just returning success. * * Setting the environment variable HWLOC_THISSYSTEM may also result in the * same behavior. * * This can be used for efficiency reasons to first detect the topology once, * save it to an XML file, and quickly reload it later through the XML * backend, but still having binding functions actually do bind. */ HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM = (1<<1), }; extern int hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags); extern int hwloc_topology_set_fsroot(hwloc_topology_t restrict topology, const char * restrict fsroot_path); extern int hwloc_topology_set_synthetic(hwloc_topology_t restrict topology, const char * restrict description); extern int hwloc_topology_set_xml(hwloc_topology_t restrict topology, const char * restrict xmlpath); extern unsigned hwloc_topology_get_depth(hwloc_topology_t restrict topology); extern int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type); #define HWLOC_TYPE_DEPTH_UNKNOWN -1 #define HWLOC_TYPE_DEPTH_MULTIPLE -2 extern hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, unsigned depth); extern unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, unsigned depth); static inline int hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) { int depth = hwloc_get_type_depth(topology, type); if (depth == HWLOC_TYPE_DEPTH_UNKNOWN) return 0; if (depth == HWLOC_TYPE_DEPTH_MULTIPLE) return -1; /* FIXME: agregate nbobjs from different levels? */ return hwloc_get_nbobjs_by_depth(topology, depth); } extern int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology); extern hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, unsigned depth, unsigned idx); static inline hwloc_obj_t hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) { int depth = hwloc_get_type_depth(topology, type); if (depth == HWLOC_TYPE_DEPTH_UNKNOWN) return NULL; if (depth == HWLOC_TYPE_DEPTH_MULTIPLE) return NULL; return hwloc_get_obj_by_depth(topology, depth, idx); } extern const char * hwloc_obj_type_string (hwloc_obj_type_t type); extern hwloc_obj_type_t hwloc_obj_type_of_string (const char * string); extern int hwloc_obj_snprintf(char * restrict string, size_t size, hwloc_topology_t topology, hwloc_obj_t obj, const char * restrict indexprefix, int verbose); extern int hwloc_obj_cpuset_snprintf(char * restrict str, size_t size, size_t nobj, const hwloc_obj_t * restrict objs); typedef enum { HWLOC_CPUBIND_PROCESS = (1<<0), HWLOC_CPUBIND_THREAD = (1<<1), HWLOC_CPUBIND_STRICT = (1<<2), } hwloc_cpubind_policy_t; extern int hwloc_set_cpubind(hwloc_topology_t topology, const hwloc_cpuset_t set, int policy); extern int hwloc_set_proc_cpubind(hwloc_topology_t topology, hwloc_pid_t pid, const hwloc_cpuset_t set, int policy); #ifdef hwloc_thread_t extern int hwloc_set_thread_cpubind(hwloc_topology_t topology, hwloc_thread_t tid, const hwloc_cpuset_t set, int policy); #endif /* high-level helpers */ #include <hwloc/helper.h> #endif /* HWLOC_H */
Open MPI is an Associated Project of the Software in the Public Interest non-profit organization Page last modified: 11-Nov-2020 ©2004-2024 The Open MPI Project