cpuset.h

Go to the documentation of this file.

/*
 * Copyright © 2009 CNRS, INRIA, Université Bordeaux 1
 * Copyright © 2009-2010 Cisco Systems, Inc.  All rights reserved.
 * See COPYING in top-level directory.
 */

#ifndef HWLOC_CPUSET_H
#define HWLOC_CPUSET_H

#include <hwloc/config.h>


#ifdef __cplusplus
extern "C" {
#endif


typedef struct hwloc_cpuset_s * hwloc_cpuset_t;
typedef const struct hwloc_cpuset_s * hwloc_const_cpuset_t;


/*
 * CPU set allocation, freeing and copying.
 */

 hwloc_cpuset_t hwloc_cpuset_alloc(void) ;

 void hwloc_cpuset_free(hwloc_cpuset_t set);

 hwloc_cpuset_t hwloc_cpuset_dup(hwloc_const_cpuset_t set) ;

 void hwloc_cpuset_copy(hwloc_cpuset_t dst, hwloc_const_cpuset_t src);


/*
 * Cpuset/String Conversion
 */

 int hwloc_cpuset_snprintf(char * restrict buf, size_t buflen, hwloc_const_cpuset_t set);

 int hwloc_cpuset_asprintf(char ** strp, hwloc_const_cpuset_t set);

 int hwloc_cpuset_from_string(hwloc_cpuset_t set, const char * restrict string);


/*
 *  Primitives & macros for building, modifying and consulting "sets" of cpus.
 */

 void hwloc_cpuset_zero(hwloc_cpuset_t set);

 void hwloc_cpuset_fill(hwloc_cpuset_t set);

 void hwloc_cpuset_from_ulong(hwloc_cpuset_t set, unsigned long mask);

 void hwloc_cpuset_from_ith_ulong(hwloc_cpuset_t set, unsigned i, unsigned long mask);

 unsigned long hwloc_cpuset_to_ulong(hwloc_const_cpuset_t set) ;

 unsigned long hwloc_cpuset_to_ith_ulong(hwloc_const_cpuset_t set, unsigned i) ;

 void hwloc_cpuset_cpu(hwloc_cpuset_t set, unsigned cpu);

 void hwloc_cpuset_all_but_cpu(hwloc_cpuset_t set, unsigned cpu);

 void hwloc_cpuset_set(hwloc_cpuset_t set, unsigned cpu);

 void hwloc_cpuset_set_range(hwloc_cpuset_t set, unsigned begincpu, unsigned endcpu);

 void hwloc_cpuset_clr(hwloc_cpuset_t set, unsigned cpu);

 void hwloc_cpuset_clr_range(hwloc_cpuset_t set, unsigned begincpu, unsigned endcpu);

 int hwloc_cpuset_isset(hwloc_const_cpuset_t set, unsigned cpu) ;

 int hwloc_cpuset_iszero(hwloc_const_cpuset_t set) ;

 int hwloc_cpuset_isfull(hwloc_const_cpuset_t set) ;

 int hwloc_cpuset_isequal (hwloc_const_cpuset_t set1, hwloc_const_cpuset_t set2) ;

 int hwloc_cpuset_intersects (hwloc_const_cpuset_t set1, hwloc_const_cpuset_t set2) ;

 int hwloc_cpuset_isincluded (hwloc_const_cpuset_t sub_set, hwloc_const_cpuset_t super_set) ;

 void hwloc_cpuset_or (hwloc_cpuset_t res, hwloc_const_cpuset_t set1, hwloc_const_cpuset_t set2);

 void hwloc_cpuset_and (hwloc_cpuset_t res, hwloc_const_cpuset_t set1, hwloc_const_cpuset_t set2);

 void hwloc_cpuset_andnot (hwloc_cpuset_t res, hwloc_const_cpuset_t set1, hwloc_const_cpuset_t set2);

 void hwloc_cpuset_xor (hwloc_cpuset_t res, hwloc_const_cpuset_t set1, hwloc_const_cpuset_t set2);

 void hwloc_cpuset_not (hwloc_cpuset_t res, hwloc_const_cpuset_t set);

 int hwloc_cpuset_first(hwloc_const_cpuset_t set) ;

 int hwloc_cpuset_last(hwloc_const_cpuset_t set) ;

 int hwloc_cpuset_next(hwloc_const_cpuset_t set, unsigned prev_cpu) ;

 void hwloc_cpuset_singlify(hwloc_cpuset_t set);

 int hwloc_cpuset_compare_first(hwloc_const_cpuset_t set1, hwloc_const_cpuset_t set2) ;

 int hwloc_cpuset_compare(hwloc_const_cpuset_t set1, hwloc_const_cpuset_t set2) ;

 int hwloc_cpuset_weight(hwloc_const_cpuset_t set) ;

#define hwloc_cpuset_foreach_begin(cpu, set) \
do { \
        for (cpu = hwloc_cpuset_first(set); \
             (unsigned) cpu != (unsigned) -1; \
             cpu = hwloc_cpuset_next(set, cpu)) { \

#define hwloc_cpuset_foreach_end() \
        } \
} while (0)

#ifdef __cplusplus
} /* extern "C" */
#endif


#endif /* HWLOC_CPUSET_H */