Enum hwloc2::ObjectType

#[repr(u32)]pub enum ObjectType {
    Machine,
    Package,
    Core,
    PU,
    L1Cache,
    L2Cache,
    L3Cache,
    L4Cache,
    L5Cache,
    L1iCache,
    L2iCache,
    L3iCache,
    Group,
    NUMANode,
    Bridge,
    PCIDevice,
    OSDevice,
    Misc,
    Memcache,
    Die,
    TypeMax,
}

Represents the type of a topology object.

Note that (partial) ordering for object types is implemented as a call into the hwloc library which defines ordering as follows:

• A == B if ObjectType::A and ObjectType::B are the same.
• A < B if ObjectType::A includes objects of type ObjectType::B.
• A > B if objects of ObjectType::A are included in type ObjectType::B.

It can also help to think of it as comparing the relative depths of each type, so a ObjectType::System will be smaller than a ObjectType::PU since the system contains processing units.

Variants

Machine

The typical root object type. A set of processors and memory with cache coherency.

Package

Physical package, what goes into a socket. In the physical meaning, i.e. that you can add or remove physically.

Core

A computation unit (may be shared by several logical processors).

PU

Processing Unit, or (Logical) Processor.

An execution unit (may share a core with some other logical processors, e.g. in the case of an SMT core). Objects of this kind are always reported and can thus be used as fallback when others are not.

L1Cache

Data cache

Level 1 Data (or Unified) Cache.

L2Cache

Data cache

Level 2 Data (or Unified) Cache.

L3Cache

Data cache

Level 3 Data (or Unified) Cache.

L4Cache

Data cache

Level 4 Data (or Unified) Cache.

L5Cache

Data cache

Level 5 Data (or Unified) Cache.

L1iCache

Instruction cache

Level 1 Instruction cache (filtered out by default)

L2iCache

Instruction cache

Level 2 Instruction cache (filtered out by default)

L3iCache

Instruction cache

Level 3 Instruction cache (filtered out by default)

Group

Group objects.

Objects which do not fit in the above but are detected by hwloc and are useful to take into account for affinity. For instance, some operating systems expose their arbitrary processors aggregation this way. And hwloc may insert such objects to group NUMA nodes according to their distances.

These objects are ignored when they do not bring any structure.

NUMANode

A set of processors around memory which the processors can directly access.

Bridge

Any bridge that connects the host or an I/O bus, to another I/O bus.

Bridge objects have neither CPU sets nor node sets. They are not added to the topology unless I/O discovery is enabled through the custom flags.

PCIDevice

PCI device.

These objects have neither CPU sets nor node sets. They are not added to the topology unless I/O discovery is enabled through the custom flags.

OSDevice

Operating system device.

These objects have neither CPU sets nor node sets. They are not added to the topology unless I/O discovery is enabled through the custom flags.

Misc

Miscellaneous objects.

Objects without particular meaning, that can e.g. be added by the application for its own use, or by hwloc for miscellaneous objects such as MemoryModule (DIMMs).

Memcache

Memory-side cache

Memory-side cache (filtered out by default).

A cache in front of a specific NUMA node.

Memory objects are not listed in the main children list, but rather in the dedicated Memory children list.

Memory-side cache have a special depth ::HWLOC_TYPE_DEPTH_MEMCACHE instead of a normal depth just like other objects in the main tree.

Die

Die within a physical package.

A subpart of the physical package, that contains multiple cores.

TypeMax

An internal sentinel value.

Trait Implementations

impl Clone for ObjectType

fn clone(&self) -> ObjectType

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ObjectType

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq<ObjectType> for ObjectType

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<ObjectType> for ObjectType

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.