Looking at Ancestor and Child Objects(3)

NAME
Looking at Ancestor and Child Objects -

  Functions
static inline hwloc_obj_t hwloc_get_ancestor_obj_by_depth (hwloc_topology_t topology , unsigned depth, hwloc_obj_t obj)
static inline hwloc_obj_t hwloc_get_ancestor_obj_by_type (hwloc_topology_t topology , hwloc_obj_type_t type, hwloc_obj_t obj)
static inline hwloc_obj_t hwloc_get_common_ancestor_obj (hwloc_topology_t topology , hwloc_obj_t obj1, hwloc_obj_t obj2)
static inline int hwloc_obj_is_in_subtree (hwloc_topology_t topology , hwloc_obj_t obj, hwloc_obj_t subtree_root)
static inline hwloc_obj_t hwloc_get_next_child (hwloc_topology_t topology , hwloc_obj_t parent, hwloc_obj_t prev)

Detailed Description

Be sure to see the figure in Terms and Definitions that shows a complete topology tree, including depths, child/sibling/cousin relationships, and an example of an asymmetric topology where one socket has fewer caches than its peers.

Function Documentation

  static inline hwloc_obj_t hwloc_get_ancestor_obj_by_depth (hwloc_topology_t topology, unsigneddepth, hwloc_obj_tobj) [static]

Returns the ancestor object of obj at depth depth.

  static inline hwloc_obj_t hwloc_get_ancestor_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_ttype, hwloc_obj_tobj) [static]

Returns the ancestor object of obj with type type.

  static inline hwloc_obj_t hwloc_get_common_ancestor_obj (hwloc_topology_t topology, hwloc_obj_tobj1, hwloc_obj_tobj2) [static]

Returns the common parent object to objects lvl1 and lvl2.

  static inline hwloc_obj_t hwloc_get_next_child (hwloc_topology_t topology, hwloc_obj_tparent, hwloc_obj_tprev) [static]

Return the next child. If prev is NULL, return the first child.

  static inline int hwloc_obj_is_in_subtree (hwloc_topology_t topology, hwloc_obj_tobj, hwloc_obj_tsubtree_root) [static]

Returns true if obj is inside the subtree beginning with ancestor object subtree_root.

Note:
    This function assumes that both obj and subtree_root have a cpuset.

Author

Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code.