.\"
.\" Copyright 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 11, 2013
.Dt ck_pr_btr 3
.Sh NAME
.Nm ck_pr_btr_ptr ,
.Nm ck_pr_btr_uint ,
.Nm ck_pr_btr_int ,
.Nm ck_pr_btr_64 ,
.Nm ck_pr_btr_32 ,
.Nm ck_pr_btr_16
.Nd atomic bit test-and-reset operations
.Sh LIBRARY
Concurrency Kit (libck, \-lck)
.Sh SYNOPSIS
.In ck_pr.h
.Ft bool
.Fn ck_pr_btr_ptr "void *target" "unsigned int bit_index"
.Ft bool
.Fn ck_pr_btr_uint "uint *target" "unsigned int bit_index"
.Ft bool
.Fn ck_pr_btr_int "int *target" "unsigned int bit_index"
.Ft bool
.Fn ck_pr_btr_64 "uint64_t *target" "unsigned int bit_index"
.Ft bool
.Fn ck_pr_btr_32 "uint32_t *target" "unsigned int bit_index"
.Ft bool
.Fn ck_pr_btr_16 "uint16_t *target" "unsigned int bit_index"
.Sh DESCRIPTION
The
.Fn ck_pr_btr 3
family of functions atomically fetch the value
of the bit in
.Fa target
at index
.Fa bit_index
and set that bit to 0.
.Sh RETURN VALUES
This family of functions returns the original value of
the bit at offset
.Fa bit_index
that is in the value pointed to by
.Fa target .
.Sh SEE ALSO
.Xr ck_pr_fence_load 3 ,
.Xr ck_pr_fence_load_depends 3 ,
.Xr ck_pr_fence_store 3 ,
.Xr ck_pr_fence_memory 3 ,
.Xr ck_pr_load 3 ,
.Xr ck_pr_store 3 ,
.Xr ck_pr_fas 3 ,
.Xr ck_pr_faa 3 ,
.Xr ck_pr_inc 3 ,
.Xr ck_pr_dec 3 ,
.Xr ck_pr_neg 3 ,
.Xr ck_pr_not 3 ,
.Xr ck_pr_sub 3 ,
.Xr ck_pr_and 3 ,
.Xr ck_pr_or 3 ,
.Xr ck_pr_xor 3 ,
.Xr ck_pr_add 3 ,
.Xr ck_pr_btc 3 ,
.Xr ck_pr_bts 3 ,
.Xr ck_pr_cas 3
.Pp
Additional information available at http://concurrencykit.org/
