hwloc.h File Reference

The hwloc API. More...

#include <hwloc/config.h>
#include <sys/types.h>
#include <stdio.h>
#include <limits.h>
#include <hwloc/rename.h>
#include <hwloc/cpuset.h>
#include <hwloc/helper.h>

Go to the source code of this file.

Data Structures
struct	hwloc_obj_memory_s
	Object memory. More...
struct	hwloc_obj_memory_s::hwloc_obj_memory_page_type_s
	Array of local memory page types, NULL if no local memory and page_types is 0. More...
struct	hwloc_obj
	Structure of a topology object. More...
union	hwloc_obj_attr_u
	Object type-specific Attributes. More...
struct	hwloc_obj_attr_u::hwloc_cache_attr_s
	Cache-specific Object Attributes. More...
struct	hwloc_obj_attr_u::hwloc_machine_attr_s
	Machine-specific Object Attributes. More...
struct	hwloc_obj_attr_u::hwloc_group_attr_s
	Group-specific Object Attributes. More...
struct	hwloc_topology_discovery_support
	Flags describing actual discovery support for this topology. More...
struct	hwloc_topology_cpubind_support
	Flags describing actual binding support for this topology. More...
struct	hwloc_topology_support
	Set of flags describing actual support for this topology. More...
Defines
#define	HWLOC_API_VERSION   0x00010000
	Indicate at build time which hwloc API version is being used.
Typedefs
typedef struct hwloc_topology *	hwloc_topology_t
	Topology context.
typedef struct hwloc_obj *	hwloc_obj_t
	Convenience typedef; a pointer to a struct hwloc_obj.
Enumerations
enum	hwloc_obj_type_t {   HWLOC_OBJ_SYSTEM, HWLOC_OBJ_MACHINE, HWLOC_OBJ_NODE, HWLOC_OBJ_SOCKET,   HWLOC_OBJ_CACHE, HWLOC_OBJ_CORE, HWLOC_OBJ_PU, HWLOC_OBJ_GROUP,   HWLOC_OBJ_MISC }
	Type of topology object. More...
enum	hwloc_compare_types_e { HWLOC_TYPE_UNORDERED }
enum	hwloc_topology_flags_e { HWLOC_TOPOLOGY_FLAG_WHOLE_SYSTEM, HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM }
	Flags to be set onto a topology context before load. More...
enum	hwloc_get_type_depth_e { HWLOC_TYPE_DEPTH_UNKNOWN, HWLOC_TYPE_DEPTH_MULTIPLE }
enum	hwloc_cpubind_policy_t { HWLOC_CPUBIND_PROCESS, HWLOC_CPUBIND_THREAD, HWLOC_CPUBIND_STRICT }
	Process/Thread binding policy. More...
Functions
HWLOC_DECLSPEC int	hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t type2) __hwloc_attribute_const
	Compare the depth of two object types.
HWLOC_DECLSPEC int	hwloc_topology_init (hwloc_topology_t *topologyp)
	Allocate a topology context.
HWLOC_DECLSPEC int	hwloc_topology_load (hwloc_topology_t topology)
	Build the actual topology.
HWLOC_DECLSPEC void	hwloc_topology_destroy (hwloc_topology_t topology)
	Terminate and free a topology context.
HWLOC_DECLSPEC void	hwloc_topology_check (hwloc_topology_t topology)
	Run internal checks on a topology structure.
HWLOC_DECLSPEC int	hwloc_topology_ignore_type (hwloc_topology_t topology, hwloc_obj_type_t type)
	Ignore an object type.
HWLOC_DECLSPEC 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.
HWLOC_DECLSPEC int	hwloc_topology_ignore_all_keep_structure (hwloc_topology_t topology)
	Ignore all objects that do not bring any structure.
HWLOC_DECLSPEC int	hwloc_topology_set_flags (hwloc_topology_t topology, unsigned long flags)
	Set OR'ed flags to non-yet-loaded topology.
HWLOC_DECLSPEC int	hwloc_topology_set_fsroot (hwloc_topology_t __hwloc_restrict topology, const char *__hwloc_restrict fsroot_path)
	Change the file-system root path when building the topology from sysfs/procfs.
HWLOC_DECLSPEC int	hwloc_topology_set_pid (hwloc_topology_t __hwloc_restrict topology, hwloc_pid_t pid)
	Change which pid the topology is viewed from.
HWLOC_DECLSPEC int	hwloc_topology_set_synthetic (hwloc_topology_t __hwloc_restrict topology, const char *__hwloc_restrict description)
	Enable synthetic topology.
HWLOC_DECLSPEC int	hwloc_topology_set_xml (hwloc_topology_t __hwloc_restrict topology, const char *__hwloc_restrict xmlpath)
	Enable XML-file based topology.
HWLOC_DECLSPEC struct hwloc_topology_support *	hwloc_topology_get_support (hwloc_topology_t __hwloc_restrict topology)
	Retrieve the topology support.
HWLOC_DECLSPEC void	hwloc_topology_export_xml (hwloc_topology_t topology, const char *xmlpath)
	Export the topology into an XML file.
HWLOC_DECLSPEC 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_DECLSPEC 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 to the topology.
HWLOC_DECLSPEC unsigned	hwloc_topology_get_depth (hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure
	Get the depth of the hierachical tree of objects.
HWLOC_DECLSPEC int	hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type)
	Returns the depth of objects of type type.
HWLOC_DECLSPEC hwloc_obj_type_t	hwloc_get_depth_type (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure
	Returns the type of objects at depth depth.
HWLOC_DECLSPEC unsigned	hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure
	Returns the width of level at depth depth.
static __hwloc_inline int __hwloc_attribute_pure	hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type)
	Returns the width of level type type.
HWLOC_DECLSPEC int	hwloc_topology_is_thissystem (hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure
	Does the topology context come from this system?
HWLOC_DECLSPEC hwloc_obj_t	hwloc_get_obj_by_depth (hwloc_topology_t topology, unsigned depth, unsigned idx) __hwloc_attribute_pure
	Returns the topology object at index index from depth depth.
static __hwloc_inline hwloc_obj_t __hwloc_attribute_pure	hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx)
	Returns the topology object at index index with type type.
HWLOC_DECLSPEC const char *	hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const
	Return a stringified topology object type.
HWLOC_DECLSPEC hwloc_obj_type_t	hwloc_obj_type_of_string (const char *string) __hwloc_attribute_pure
	Return an object type from the string.
HWLOC_DECLSPEC int	hwloc_obj_type_snprintf (char *__hwloc_restrict string, size_t size, hwloc_obj_t obj, int verbose)
	Stringify the type of a given topology object into a human-readable form.
HWLOC_DECLSPEC int	hwloc_obj_attr_snprintf (char *__hwloc_restrict string, size_t size, hwloc_obj_t obj, const char *__hwloc_restrict separator, int verbose)
	Stringify the attributes of a given topology object into a human-readable form.
HWLOC_DECLSPEC int	hwloc_obj_snprintf (char *__hwloc_restrict string, size_t size, hwloc_topology_t topology, hwloc_obj_t obj, const char *__hwloc_restrict indexprefix, int verbose)
	Stringify a given topology object into a human-readable form.
HWLOC_DECLSPEC int	hwloc_obj_cpuset_snprintf (char *__hwloc_restrict str, size_t size, size_t nobj, const hwloc_obj_t *__hwloc_restrict objs)
	Stringify the cpuset containing a set of objects.
HWLOC_DECLSPEC int	hwloc_set_cpubind (hwloc_topology_t topology, hwloc_const_cpuset_t set, int policy)
	Bind current process or thread on cpus given in cpuset set.
HWLOC_DECLSPEC int	hwloc_get_cpubind (hwloc_topology_t topology, hwloc_cpuset_t set, int policy)
	Get current process or thread binding.
HWLOC_DECLSPEC int	hwloc_set_proc_cpubind (hwloc_topology_t topology, hwloc_pid_t pid, hwloc_const_cpuset_t set, int policy)
	Bind a process pid on cpus given in cpuset set.
HWLOC_DECLSPEC int	hwloc_get_proc_cpubind (hwloc_topology_t topology, hwloc_pid_t pid, hwloc_cpuset_t set, int policy)
	Get the current binding of process pid.

---

Detailed Description

The hwloc API.

See hwloc/cpuset.h for CPU set specific macros. See hwloc/helper.h for high-level topology traversal helpers.