Basic Traversal Helpers

Functions
static __inline hwloc_obj_t	hwloc_get_system_obj (hwloc_topology_t topology)
	Returns the top-object of the topology-tree. Its type is HWLOC_OBJ_SYSTEM.
static __inline 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.
static __inline 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.
static __inline hwloc_obj_t	hwloc_get_next_child (hwloc_topology_t topology, hwloc_obj_t father, hwloc_obj_t prev)
	Return the next child.
static __inline hwloc_obj_t	hwloc_get_common_ancestor_obj (hwloc_topology_t topology, hwloc_obj_t obj1, hwloc_obj_t obj2)
	Returns the common father object to objects lvl1 and lvl2.
static __inline int	hwloc_obj_is_in_subtree (hwloc_topology_t topology, hwloc_obj_t obj, hwloc_obj_t subtree_root)
	Returns true if _obj_ is inside the subtree beginning with subtree_root.

---

Function Documentation

static __inline hwloc_obj_t hwloc_get_common_ancestor_obj	(	hwloc_topology_t	topology,
		hwloc_obj_t	obj1,
		hwloc_obj_t	obj2
	)			[static]

Returns the common father object to objects lvl1 and lvl2.

static __inline hwloc_obj_t hwloc_get_next_child	(	hwloc_topology_t	topology,
		hwloc_obj_t	father,
		hwloc_obj_t	prev
	)			[static]

Return the next child.

If prev is NULL, return the first child.

static __inline hwloc_obj_t hwloc_get_next_obj_by_depth	(	hwloc_topology_t	topology,
		unsigned	depth,
		hwloc_obj_t	prev
	)			[static]

Returns the next object at depth depth.

If prev is NULL, return the first object at depth depth.

static __inline hwloc_obj_t hwloc_get_next_obj_by_type	(	hwloc_topology_t	topology,
		hwloc_obj_type_t	type,
		hwloc_obj_t	prev
	)			[static]

Returns the next object of type type.

If prev is NULL, return the first object at type type. If there are multiple or no depth for given type, return NULL and let the caller fallback to hwloc_get_next_obj_by_depth().

static __inline hwloc_obj_t hwloc_get_system_obj

(

hwloc_topology_t

topology

)

[static]

Returns the top-object of the topology-tree. Its type is HWLOC_OBJ_SYSTEM.

static __inline int hwloc_obj_is_in_subtree	(	hwloc_topology_t	topology,
		hwloc_obj_t	obj,
		hwloc_obj_t	subtree_root
	)			[static]

Returns true if _obj_ is inside the subtree beginning with subtree_root.