Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
hwlocality...nd_covering(3) Library Functions Manual hwlocality...nd_covering(3)

NAME
     hwlocality_helper_find_covering - Finding Objects covering at least CPU set

SYNOPSIS
   Functions
     hwloc_obj_t   hwloc_get_child_covering_cpuset  (hwloc_topology_t  topology,
	 hwloc_const_cpuset_t set, hwloc_obj_t parent)
     hwloc_obj_t   hwloc_get_obj_covering_cpuset   (hwloc_topology_t   topology,
	 hwloc_const_cpuset_t set)
     hwloc_obj_t  hwloc_get_next_obj_covering_cpuset_by_depth  (hwloc_topology_t
	 topology, hwloc_const_cpuset_t set, int depth, hwloc_obj_t prev)
     hwloc_obj_t  hwloc_get_next_obj_covering_cpuset_by_type   (hwloc_topology_t
	 topology,  hwloc_const_cpuset_t set, hwloc_obj_type_t type, hwloc_obj_t
	 prev)

Detailed Description
Function Documentation
   hwloc_obj_t	 hwloc_get_child_covering_cpuset   (hwloc_topology_t   topology,
     hwloc_const_cpuset_t set, hwloc_obj_t parent) [inline]
     Get the child covering at least CPU set set.

     Returns
	 the child that covers the set entirely.

	 NULL if no child matches or if set is empty.

     Note
	 This  function  cannot  work  if parent does not have a CPU set (I/O or
	 Misc objects).

   hwloc_obj_t	 hwloc_get_next_obj_covering_cpuset_by_depth   (hwloc_topology_t
     topology, hwloc_const_cpuset_t set, int depth, hwloc_obj_t prev) [inline]
     Iterate  through same-depth objects covering at least CPU set set. The next
     invokation should pass the previous return value in prev so  as  to  obtain
     the next object covering at least another part of set.

     Returns
	 the  first  object at depth depth covering at least part of CPU set set
	 if object prev is NULL.

	 the next one if prev is not NULL.

	 NULL if there is no next object.

     Note
	 This function cannot work if objects at the given depth do not have CPU
	 sets (I/O or Misc objects).

   hwloc_obj_t	 hwloc_get_next_obj_covering_cpuset_by_type    (hwloc_topology_t
     topology,	hwloc_const_cpuset_t  set,  hwloc_obj_type_t  type,  hwloc_obj_t
     prev) [inline]
     Iterate through same-type objects covering at least CPU set set.  The  next
     invokation  should  pass  the previous return value in prev so as to obtain
     the next object of type type covering at least another part of set.

     Returns
	 the first object of type type covering at least part of CPU set set  if
	 object prev is NULL.

	 the next one if prev is not NULL.

	 NULL if there is no next object.

	 NULL if there is no depth for the given type.

	 NULL if there are multiple depths for the given type, the caller should
	 fallback to hwloc_get_next_obj_covering_cpuset_by_depth().

     Note
	 This  function cannot work if objects of the given type do not have CPU
	 sets (I/O or Misc objects).

   hwloc_obj_t	 hwloc_get_obj_covering_cpuset	  (hwloc_topology_t    topology,
     hwloc_const_cpuset_t set) [inline]
     Get the lowest object covering at least CPU set set.

     Returns
	 the lowest object covering the set entirely.

	 NULL if no object matches or if set is empty.

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

Hardware Locality (hwloc)	 Version 2.12.1      hwlocality...nd_covering(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=hwloc_get_obj_covering_cpuset&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help