.\"
.\" Copyright 2012 Samy Al Bahra.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"
.Dd April 22, 2012
.Dt CK_BITMAP_BUFFER 3
.Sh NAME
.Nm ck_bitmap_buffer
.Nd returns pointer to bit array
.Sh LIBRARY
Concurrency Kit (libck, \-lck)
.Sh SYNOPSIS
.In ck_bitmap.h
.Ft void *
.Fn ck_bitmap_buffer "ck_bitmap_t *bitmap"
.Sh DESCRIPTION
The
.Fn ck_bitmap_buffer
functions returns a pointer to the actual bit array.
For ck_bitmap pointers, the bit array is of type
CK_BITMAP_WORD[] and consists of
ck_bitmap_base(bitmap) / sizeof(CK_BITMAP_WORD) elements.
On currently supported 64-bit platforms
.Dv CK_BITMAP_WORD
is
.Dv uint64_t .
On currently supported 32-bit platforms
.Dv CK_BITMAP_WORD
is
.Dv uint32_t .
.Sh RETURN VALUES
This function returns a non-NULL value.
.Sh SEE ALSO
.Xr ck_bitmap_base 3 ,
.Xr ck_bitmap_size 3 ,
.Xr ck_bitmap_init 3 ,
.Xr ck_bitmap_set_mpmc 3 ,
.Xr ck_bitmap_reset_mpmc 3 ,
.Xr ck_bitmap_test 3 ,
.Xr ck_bitmap_clear 3 ,
.Xr ck_bitmap_bits 3
.Pp
Additional information available at http://concurrencykit.org/