SIMPLE SOLUTIONS

BITSTRING(3BSD) - Linux man page online | Library functions

Bit-string.

Chapter
July 19, 1993
BITSTRING(3bsd) LOCAL BITSTRING(3bsd)

NAME

bit_alloc, bit_clear, bit_decl, bit_ffs, bit_nclear, bit_nset, bit_set, bitstr_size, bit_test — bit-string manipulation macros

SYNOPSIS

#include <bitstring.h> (See libbsd(7) for include usage.) bitstr_t * bit_alloc(int nbits); void bit_decl(bitstr_t *name, int nbits); void bit_clear(bitstr_t *name, int bit); void bit_ffc(bitstr_t *name, int nbits, int *value); void bit_ffs(bitstr_t *name, int nbits, int *value); void bit_nclear(bitstr_t *name, int start, int stop); void bit_nset(bitstr_t *name, int start, int stop); void bit_set(bitstr_t *name, int bit); int bitstr_size(int nbits); int bit_test(bitstr_t *name, int bit);

DESCRIPTION

These macros operate on strings of bits. The macro bit_alloc() returns a pointer of type “bitstr_t *” to sufficient space to store nbits bits, or NULL if no space is available. The macro bit_decl() allocates sufficient space to store nbits bits on the stack. The macro bitstr_size() returns the number of elements of type bitstr_t necessary to store nbits bits. This is useful for copying bit strings. The macros bit_clear() and bit_set() clear or set the zero-based numbered bit bit, in the bit string name. The bit_nset() and bit_nclear() macros set or clear the zero-based numbered bits from start through stop in the bit string name. The bit_test() macro evaluates to non-zero if the zero-based numbered bit bit of bit string name is set, and zero otherwise. The bit_ffs() macro stores in the location referenced by value the zero-based number of the first bit set in the array of nbits bits referenced by name. If no bits are set, the loca‐ tion referenced by value is set to -1. The macro bit_ffc() stores in the location referenced by value the zero-based number of the first bit not set in the array of nbits bits referenced by name. If all bits are set, the location referenced by value is set to -1. The arguments to these macros are evaluated only once and may safely have side effects.

EXAMPLES

#include <limits.h> #include <bsd/bitstring.h> ... #define LPR_BUSY_BIT 0 #define LPR_FORMAT_BIT 1 #define LPR_DOWNLOAD_BIT 2 ... #define LPR_AVAILABLE_BIT 9 #define LPR_MAX_BITS 10 make_lpr_available() { bitstr_t bit_decl(bitlist, LPR_MAX_BITS); ... bit_nclear(bitlist, 0, LPR_MAX_BITS - 1); ... if (!bit_test(bitlist, LPR_BUSY_BIT)) { bit_clear(bitlist, LPR_FORMAT_BIT); bit_clear(bitlist, LPR_DOWNLOAD_BIT); bit_set(bitlist, LPR_AVAILABLE_BIT); } }

SEE ALSO

malloc(3)

HISTORY

The bitstring functions first appeared in 4.4BSD.
BSD July 19, 1993 BSD
This manual Reference Other manuals
bitstring(3bsd) referred by BIT_AND(9freebsd) | BIT_AND_ATOMIC(9freebsd) | BIT_CLR(9freebsd) | BIT_CLR_ATOMIC(9freebsd) | BIT_CMP(9freebsd) | BIT_COPY(9freebsd) | BIT_COPY_STORE_REL(9freebsd) | BIT_COUNT(9freebsd) | BIT_EMPTY(9freebsd) | BIT_FFS(9freebsd) | BIT_FILL(9freebsd) | BIT_ISFULLSET(9freebsd) | BIT_ISSET(9freebsd) | BIT_NAND(9freebsd) | BIT_OR(9freebsd) | BIT_OR_ATOMIC(9freebsd) | BIT_OVERLAP(9freebsd) | BIT_SET(9freebsd) | BIT_SET_ATOMIC(9freebsd) | BIT_SET_ATOMIC_ACQ(9freebsd)
refer to libbsd(7) | malloc(3)
Download raw manual
Main page LOCAL (+267) BSD (+3984) № 3 (+68044)
Go top