[][src]Struct hwloc2::TopologyObject

#[repr(C)]pub struct TopologyObject { /* fields omitted */ }

Implementations

impl TopologyObject[src]

pub fn object_type(&self) -> ObjectType[src]

The type of the object.

pub fn total_memory(&self) -> u64[src]

The memory attributes of the object.

pub fn os_index(&self) -> u32[src]

The OS-provided physical index number.

It is not guaranteed unique across the entire machine, except for PUs and NUMA nodes.

pub fn name(&self) -> String[src]

The name of the object, if set.

pub fn depth(&self) -> u32[src]

Vertical index in the hierarchy.

If the topology is symmetric, this is equal to the parent depth plus one, and also equal to the number of parent/child links from the root object to here.

pub fn logical_index(&self) -> u32[src]

Horizontal index in the whole list of similar objects, hence guaranteed unique across the entire machine.

Could be a "cousin_rank" since it's the rank within the "cousin" list below.

pub fn sibling_rank(&self) -> u32[src]

This objects index in the parents children list.

pub fn arity(&self) -> u32[src]

The number of direct children.

pub fn children(&self) -> Vec<&TopologyObject>[src]

All direct children of this object.

pub fn next_cousin(&self) -> Option<&TopologyObject>[src]

Next object of same type and depth.

pub fn prev_cousin(&self) -> Option<&TopologyObject>[src]

Previous object of same type and depth.

pub fn first_child(&self) -> Option<&TopologyObject>[src]

First child of the next depth.

pub fn last_child(&self) -> Option<&TopologyObject>[src]

Last child of the next depth.

pub fn parent(&self) -> Option<&TopologyObject>[src]

Last child of the next depth.

pub fn prev_sibling(&self) -> Option<&TopologyObject>[src]

Previous object below the same parent.

pub fn next_sibling(&self) -> Option<&TopologyObject>[src]

Next object below the same parent.

pub fn cpuset(&self) -> Option<CpuSet>[src]

CPUs covered by this object.

This is the set of CPUs for which there are PU objects in the topology under this object, i.e. which are known to be physically contained in this object and known how (the children path between this object and the PU objects).

pub fn complete_cpuset(&self) -> Option<CpuSet>[src]

The complete CPU set of logical processors of this object.

This includes not only the same as the cpuset field, but also the CPUs for which topology information is unknown or incomplete, and the CPUs that are ignored when the HWLOC_TOPOLOGY_FLAG_WHOLE_SYSTEM flag is not set. Thus no corresponding PU object may be found in the topology, because the precise position is undefined. It is however known that it would be somewhere under this object.

pub fn nodeset(&self) -> Option<NodeSet>[src]

NUMA nodes covered by this object or containing this object.

This is the set of NUMA nodes for which there are NODE objects in the topology under or containing it and known how (the children path between this object and the NODE objects).

In the end, these nodes are those that are close to the current object. If the HWLOC_TOPOLOGY_FLAG_WHOLE_SYSTEM configuration flag is set, some of these nodes may not be allowed for allocation, see allowed_nodeset.

If there are no NUMA nodes in the machine, all the memory is close to this object, so the nodeset is full.

pub fn complete_nodeset(&self) -> Option<NodeSet>[src]

The complete NUMA node set of this object,.

This includes not only the same as the nodeset field, but also the NUMA nodes for which topology information is unknown or incomplete, and the nodes that are ignored when the HWLOC_TOPOLOGY_FLAG_WHOLE_SYSTEM flag is not set. Thus no corresponding NODE object may be found in the topology, because the precise position is undefined. It is however known that it would be somewhere under this object.

If there are no NUMA nodes in the machine, all the memory is close to this object, so complete_nodeset is full.

pub fn cache_attributes(&self) -> Option<&TopologyObjectCacheAttributes>[src]

Trait Implementations

impl Display for TopologyObject[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.