You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
85 lines
2.5 KiB
85 lines
2.5 KiB
.\"
|
|
.\" Copyright 2012-2013 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_INIT 3
|
|
.Sh NAME
|
|
.Nm ck_bitmap_init
|
|
.Nd initialize a bitmap
|
|
.Sh LIBRARY
|
|
Concurrency Kit (libck, \-lck)
|
|
.Sh SYNOPSIS
|
|
.In ck_bitmap.h
|
|
.Ft void
|
|
.Fn ck_bitmap_init "ck_bitmap_t *bitmap" "unsigned int n_bits" "bool set"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn ck_bitmap_init
|
|
function initializes the bitmap pointed to by the
|
|
.Fa bitmap
|
|
pointer. The argument
|
|
.Fa n_bits
|
|
specifies the number of bits that are to be stored in the bitmap.
|
|
The argument
|
|
.Fa set
|
|
determines whether the values of the bits in
|
|
.Fa bitmap
|
|
are to be initialized to
|
|
.Dv 1
|
|
or
|
|
.Dv 0 .
|
|
.Pp
|
|
It is expected that
|
|
.Fa bitmap
|
|
points to a contiguous region of memory containing at least
|
|
the number of bytes specified by
|
|
.Xr ck_bitmap_size 3 .
|
|
.Sh RETURN VALUES
|
|
This function has no return value.
|
|
.Sh ERRORS
|
|
.Bl -tag -width Er
|
|
.Pp
|
|
The behavior of
|
|
.Fn ck_bitmap_init
|
|
is undefined if
|
|
.Fa bitmap
|
|
is not a pointer to a region of bytes
|
|
of at least
|
|
.Xr ck_bitmap_size 3
|
|
length.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr ck_bitmap_base 3 ,
|
|
.Xr ck_bitmap_size 3 ,
|
|
.Xr ck_bitmap_set_mpmc 3 ,
|
|
.Xr ck_bitmap_reset_mpmc 3 ,
|
|
.Xr ck_bitmap_clear 3 ,
|
|
.Xr ck_bitmap_test 3 ,
|
|
.Xr ck_bitmap_bits 3 ,
|
|
.Xr ck_bitmap_buffer 3
|
|
.Pp
|
|
Additional information available at http://concurrencykit.org/
|