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_u *	attr
	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_obj *	next_cousin
	Next object of same type.
struct hwloc_obj *	prev_cousin
	Previous object of same type.
struct hwloc_obj *	father
	Father, NULL if root (system object).
unsigned	sibling_rank
	Index in father's children[] array.
struct hwloc_obj *	next_sibling
	Next object below the same father.
struct hwloc_obj *	prev_sibling
	Previous object below the same father.
unsigned	arity
	Number of children.
struct hwloc_obj **	children
	Children, children[0 .. arity -1].
struct hwloc_obj *	first_child
	First child.
struct hwloc_obj *	last_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.

union hwloc_obj_attr_u* hwloc_obj::attr [write]

Object type-specific Attributes.

struct hwloc_obj** hwloc_obj::children [read]

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

hwloc_cpuset_t hwloc_obj::cpuset

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).

struct hwloc_obj* hwloc_obj::first_child [read]

First child.

struct hwloc_obj* hwloc_obj::last_child [read]

Last child.

unsigned hwloc_obj::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.

char* hwloc_obj::name

Object description if any.

struct hwloc_obj* hwloc_obj::next_cousin [read]

Next object of same type.

struct hwloc_obj* hwloc_obj::next_sibling [read]

Next object below the same father.

signed hwloc_obj::os_index

OS-provided physical index number.

signed hwloc_obj::os_level

OS-provided physical level.

struct hwloc_obj* hwloc_obj::prev_cousin [read]

Previous object of same type.

struct hwloc_obj* hwloc_obj::prev_sibling [read]

Previous object below the same father.

unsigned hwloc_obj::sibling_rank

Index in father's children[] array.

hwloc_obj_type_t hwloc_obj::type

Type of object.

void* hwloc_obj::userdata

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

---

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

• hwloc.h