Open MPI logo

Portable Hardware Locality (hwloc) Documentation: v0.9.1

  |   Home   |   Support   |   FAQ   |  

hwloc_obj Struct Reference
[Topology Objects]

Structure of a topology object. More...

#include <hwloc.h>

Data Fields

hwloc_obj_type_t type
 Type of object.
signed os_index
 OS-provided physical index number.
char * name
 Object description if any.
union hwloc_obj_attr_uattr
 Object type-specific Attributes.
unsigned depth
 Vertical index in the hierarchy.
unsigned logical_index
 Horizontal index in the whole list of similar objects, could be a "cousin_rank" since it's the rank within the "cousin" list below.
struct hwloc_objnext_cousin
 Next object of same type.
struct hwloc_objprev_cousin
 Previous object of same type.
struct hwloc_objfather
 Father, NULL if root (system object).
unsigned sibling_rank
 Index in father's children[] array.
struct hwloc_objnext_sibling
 Next object below the same father.
struct hwloc_objprev_sibling
 Previous object below the same father.
unsigned arity
 Number of children.
struct hwloc_obj ** children
 Children, children[0 .. arity -1].
struct hwloc_objfirst_child
 First child.
struct hwloc_objlast_child
 Last child.
void * userdata
 Application-given private data pointer, initialized to NULL, use it as you wish.
hwloc_cpuset_t cpuset
 CPUs covered by this object.
signed os_level
 OS-provided physical level.

Detailed Description

Structure of a topology object.

Applications mustn't modify any field except userdata .


Field Documentation

unsigned hwloc_obj::arity

Number of children.

Object type-specific Attributes.

struct hwloc_obj** hwloc_obj::children [read]

Children, children[0 .. arity -1].

CPUs covered by this object.

unsigned hwloc_obj::depth

Vertical index in the hierarchy.

struct hwloc_obj* hwloc_obj::father [read]

Father, NULL if root (system object).

First child.

Last child.

Horizontal index in the whole list of similar objects, could be a "cousin_rank" since it's the rank within the "cousin" list below.

Object description if any.

Next object of same type.

Next object below the same father.

OS-provided physical index number.

OS-provided physical level.

Previous object of same type.

Previous object below the same father.

Index in father's children[] array.

Application-given private data pointer, initialized to NULL, use it as you wish.


The documentation for this struct was generated from the following file: