---
name: "hwlocality_helper_cpuset"
section: "3"
platform: "linux"
package: "libhwloc-doc"
version: "1.4.1-4"
release: "Debian 7 (Wheezy)"
platforms: ["linux"]
url: "https://new.carta.tech/hwlocality_helper_cpuset"
---

# hwlocality\_helper\_cpuset(3)

## NAME

Cpuset Helpers -

### Functions

static inline \
 **hwloc\_const\_cpuset\_t** **hwloc\_topology\_get\_complete\_cpuset** (**hwloc\_topology\_t** topology) "\
 static inline \
 **hwloc\_const\_cpuset\_t** **hwloc\_topology\_get\_topology\_cpuset** (**hwloc\_topology\_t** topology) "\
 static inline \
 **hwloc\_const\_cpuset\_t** **hwloc\_topology\_get\_online\_cpuset** (**hwloc\_topology\_t** topology) "\
 static inline \
 **hwloc\_const\_cpuset\_t** **hwloc\_topology\_get\_allowed\_cpuset** (**hwloc\_topology\_t** topology) "\

## Function Documentation

### static inline hwloc\_const\_cpuset\_t hwloc\_topology\_get\_allowed\_cpuset (hwloc\_topology\_ttopology)` [static]`

Get allowed CPU set. **Returns:**

the CPU set of allowed logical processors of the system. If the topology is the result of a combination of several systems, NULL is returned.

**Note:**

The returned cpuset is not newly allocated and should thus not be changed or freed, hwloc\_cpuset\_dup must be used to obtain a local copy.

### static inline hwloc\_const\_cpuset\_t hwloc\_topology\_get\_complete\_cpuset (hwloc\_topology\_ttopology)` [static]`

Get complete CPU set. **Returns:**

the complete CPU set of logical processors of the system. If the topology is the result of a combination of several systems, NULL is returned.

**Note:**

The returned cpuset is not newly allocated and should thus not be changed or freed; hwloc\_cpuset\_dup must be used to obtain a local copy.

### static inline hwloc\_const\_cpuset\_t hwloc\_topology\_get\_online\_cpuset (hwloc\_topology\_ttopology)` [static]`

Get online CPU set. **Returns:**

the CPU set of online logical processors of the system. If the topology is the result of a combination of several systems, NULL is returned.

**Note:**

The returned cpuset is not newly allocated and should thus not be changed or freed; hwloc\_cpuset\_dup must be used to obtain a local copy.

### static inline hwloc\_const\_cpuset\_t hwloc\_topology\_get\_topology\_cpuset (hwloc\_topology\_ttopology)` [static]`

Get topology CPU set. **Returns:**

the CPU set of logical processors of the system for which hwloc provides topology information. This is equivalent to the cpuset of the system object. If the topology is the result of a combination of several systems, NULL is returned.

**Note:**

The returned cpuset is not newly allocated and should thus not be changed or freed; hwloc\_cpuset\_dup must be used to obtain a local copy.

## Author

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