bitmap.h File Reference

The bitmap API, for use in hwloc itself. More...

#include <hwloc/autogen/config.h>
#include <assert.h>

Go to the source code of this file.

Defines
#define	hwloc_bitmap_foreach_begin(id, bitmap)
	Loop macro iterating on bitmap bitmap.
#define	hwloc_bitmap_foreach_end()
	End of loop. Needs a terminating ';'.
Typedefs
typedef struct hwloc_bitmap_s *	hwloc_bitmap_t
	Set of bits represented as an opaque pointer to an internal bitmap.
typedef struct hwloc_bitmap_s *	hwloc_const_bitmap_t
	a non-modifiable hwloc_bitmap_t
Functions
hwloc_bitmap_t	hwloc_bitmap_alloc (void)
	Allocate a new empty bitmap.
hwloc_bitmap_t	hwloc_bitmap_alloc_full (void)
	Allocate a new full bitmap.
void	hwloc_bitmap_free (hwloc_bitmap_t bitmap)
	Free bitmap bitmap.
hwloc_bitmap_t	hwloc_bitmap_dup (hwloc_const_bitmap_t bitmap)
	Duplicate bitmap bitmap by allocating a new bitmap and copying bitmap contents.
void	hwloc_bitmap_copy (hwloc_bitmap_t dst, hwloc_const_bitmap_t src)
	Copy the contents of bitmap src into the already allocated bitmap dst.
int	hwloc_bitmap_snprintf (char *restrict buf, size_t buflen, hwloc_const_bitmap_t bitmap)
	Stringify a bitmap.
int	hwloc_bitmap_asprintf (char **strp, hwloc_const_bitmap_t bitmap)
	Stringify a bitmap into a newly allocated string.
int	hwloc_bitmap_sscanf (hwloc_bitmap_t bitmap, const char *restrict string)
	Parse a bitmap string and stores it in bitmap bitmap.
int	hwloc_bitmap_list_snprintf (char *restrict buf, size_t buflen, hwloc_const_bitmap_t bitmap)
	Stringify a bitmap in the list format.
int	hwloc_bitmap_list_asprintf (char **strp, hwloc_const_bitmap_t bitmap)
	Stringify a bitmap into a newly allocated list string.
int	hwloc_bitmap_list_sscanf (hwloc_bitmap_t bitmap, const char *restrict string)
	Parse a list string and stores it in bitmap bitmap.
int	hwloc_bitmap_taskset_snprintf (char *restrict buf, size_t buflen, hwloc_const_bitmap_t bitmap)
	Stringify a bitmap in the taskset-specific format.
int	hwloc_bitmap_taskset_asprintf (char **strp, hwloc_const_bitmap_t bitmap)
	Stringify a bitmap into a newly allocated taskset-specific string.
int	hwloc_bitmap_taskset_sscanf (hwloc_bitmap_t bitmap, const char *restrict string)
	Parse a taskset-specific bitmap string and stores it in bitmap bitmap.
void	hwloc_bitmap_zero (hwloc_bitmap_t bitmap)
	Empty the bitmap bitmap.
void	hwloc_bitmap_fill (hwloc_bitmap_t bitmap)
	Fill bitmap bitmap with all possible indexes (even if those objects don't exist or are otherwise unavailable)
void	hwloc_bitmap_only (hwloc_bitmap_t bitmap, unsigned id)
	Empty the bitmap bitmap and add bit id.
void	hwloc_bitmap_allbut (hwloc_bitmap_t bitmap, unsigned id)
	Fill the bitmap and clear the index id.
void	hwloc_bitmap_from_ulong (hwloc_bitmap_t bitmap, unsigned long mask)
	Setup bitmap bitmap from unsigned long mask.
void	hwloc_bitmap_from_ith_ulong (hwloc_bitmap_t bitmap, unsigned i, unsigned long mask)
	Setup bitmap bitmap from unsigned long mask used as i -th subset.
void	hwloc_bitmap_set (hwloc_bitmap_t bitmap, unsigned id)
	Add index id in bitmap bitmap.
void	hwloc_bitmap_set_range (hwloc_bitmap_t bitmap, unsigned begin, int end)
	Add indexes from begin to end in bitmap bitmap.
void	hwloc_bitmap_set_ith_ulong (hwloc_bitmap_t bitmap, unsigned i, unsigned long mask)
	Replace i -th subset of bitmap bitmap with unsigned long mask.
void	hwloc_bitmap_clr (hwloc_bitmap_t bitmap, unsigned id)
	Remove index id from bitmap bitmap.
void	hwloc_bitmap_clr_range (hwloc_bitmap_t bitmap, unsigned begin, int end)
	Remove indexes from begin to end in bitmap bitmap.
void	hwloc_bitmap_singlify (hwloc_bitmap_t bitmap)
	Keep a single index among those set in bitmap bitmap.
unsigned long	hwloc_bitmap_to_ulong (hwloc_const_bitmap_t bitmap)
	Convert the beginning part of bitmap bitmap into unsigned long mask.
unsigned long	hwloc_bitmap_to_ith_ulong (hwloc_const_bitmap_t bitmap, unsigned i)
	Convert the i -th subset of bitmap bitmap into unsigned long mask.
int	hwloc_bitmap_isset (hwloc_const_bitmap_t bitmap, unsigned id)
	Test whether index id is part of bitmap bitmap.
int	hwloc_bitmap_iszero (hwloc_const_bitmap_t bitmap)
	Test whether bitmap bitmap is empty.
int	hwloc_bitmap_isfull (hwloc_const_bitmap_t bitmap)
	Test whether bitmap bitmap is completely full.
int	hwloc_bitmap_first (hwloc_const_bitmap_t bitmap)
	Compute the first index (least significant bit) in bitmap bitmap.
int	hwloc_bitmap_next (hwloc_const_bitmap_t bitmap, int prev)
	Compute the next index in bitmap bitmap which is after index prev.
int	hwloc_bitmap_last (hwloc_const_bitmap_t bitmap)
	Compute the last index (most significant bit) in bitmap bitmap.
int	hwloc_bitmap_weight (hwloc_const_bitmap_t bitmap)
	Compute the "weight" of bitmap bitmap (i.e., number of indexes that are in the bitmap).
void	hwloc_bitmap_or (hwloc_bitmap_t res, hwloc_const_bitmap_t bitmap1, hwloc_const_bitmap_t bitmap2)
	Or bitmaps bitmap1 and bitmap2 and store the result in bitmap res.
void	hwloc_bitmap_and (hwloc_bitmap_t res, hwloc_const_bitmap_t bitmap1, hwloc_const_bitmap_t bitmap2)
	And bitmaps bitmap1 and bitmap2 and store the result in bitmap res.
void	hwloc_bitmap_andnot (hwloc_bitmap_t res, hwloc_const_bitmap_t bitmap1, hwloc_const_bitmap_t bitmap2)
	And bitmap bitmap1 and the negation of bitmap2 and store the result in bitmap res.
void	hwloc_bitmap_xor (hwloc_bitmap_t res, hwloc_const_bitmap_t bitmap1, hwloc_const_bitmap_t bitmap2)
	Xor bitmaps bitmap1 and bitmap2 and store the result in bitmap res.
void	hwloc_bitmap_not (hwloc_bitmap_t res, hwloc_const_bitmap_t bitmap)
	Negate bitmap bitmap and store the result in bitmap res.
int	hwloc_bitmap_intersects (hwloc_const_bitmap_t bitmap1, hwloc_const_bitmap_t bitmap2)
	Test whether bitmaps bitmap1 and bitmap2 intersects.
int	hwloc_bitmap_isincluded (hwloc_const_bitmap_t sub_bitmap, hwloc_const_bitmap_t super_bitmap)
	Test whether bitmap sub_bitmap is part of bitmap super_bitmap.
int	hwloc_bitmap_isequal (hwloc_const_bitmap_t bitmap1, hwloc_const_bitmap_t bitmap2)
	Test whether bitmap bitmap1 is equal to bitmap bitmap2.
int	hwloc_bitmap_compare_first (hwloc_const_bitmap_t bitmap1, hwloc_const_bitmap_t bitmap2)
	Compare bitmaps bitmap1 and bitmap2 using their lowest index.
int	hwloc_bitmap_compare (hwloc_const_bitmap_t bitmap1, hwloc_const_bitmap_t bitmap2)
	Compare bitmaps bitmap1 and bitmap2 using their highest index.

---

Detailed Description

The bitmap API, for use in hwloc itself.