haiwan
/
ck
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc/ck_pr: Add ck_pr_bt{c,r,s} manual pages.

Browse Source
ck_pring
Samy Al Bahra 12 years ago
parent 187d67f4c9
commit 235a57ebef
4 changed files with 259 additions and 1 deletions
Show Stats Download Patch File Download Diff File

5
doc/Makefile.in
Unescape View File

@ -103,7 +103,10 @@ OBJECTS=ck_ht_count \
ck_pr_and \
ck_pr_xor \
ck_pr_or \
ck_pr_cas
ck_pr_cas \
ck_pr_bts \
ck_pr_btc \
ck_pr_btr
all:
for target in $(OBJECTS); do \

85
doc/ck_pr_btc
Unescape View File

@ -0,0 +1,85 @@
.\"
.\" 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_btc 3
.Sh NAME
.Nm ck_pr_btc
.Nd atomic bit test-and-complement operation
.Sh LIBRARY
Concurrency Kit (libck, \-lck)
.Sh SYNOPSIS
.In ck_pr.h
.Ft bool
.Fn ck_pr_btc_ptr "void *target" "unsigned int bit_index"
.Ft bool
.Fn ck_pr_btc_uint "uint *target" "unsigned int bit_index"
.Ft bool
.Fn ck_pr_btc_int "int *target" "unsigned int bit_index"
.Ft bool
.Fn ck_pr_btc_64 "uint64_t *target" "unsigned int bit_index"
.Ft bool
.Fn ck_pr_btc_32 "uint32_t *target" "unsigned int bit_index"
.Ft bool
.Fn ck_pr_btc_16 "uint16_t *target" "unsigned int bit_index"
.Sh DESCRIPTION
The
.Fn ck_pr_btc 3
family of functions will atomically fetch the value
of the bit in
.Fa target
at index
.Fa bit_index
and set that bit to its complement.
.Sh RETURN VALUES
These family of functions will return 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_btr 3 ,
.Xr ck_pr_cas 3
.Pp
Additional information available at http://concurrencykit.org/

85
doc/ck_pr_btr
Unescape View File

@ -0,0 +1,85 @@
.\"
.\" 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
.Nd atomic bit test-and-reset operation
.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 will atomically fetch the value
of the bit in
.Fa target
at index
.Fa bit_index
and set that bit to 0.
.Sh RETURN VALUES
These family of functions will return 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/

85
doc/ck_pr_bts
Unescape View File

@ -0,0 +1,85 @@
.\"
.\" 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_bts 3
.Sh NAME
.Nm ck_pr_bts
.Nd atomic bit test-and-set operation
.Sh LIBRARY
Concurrency Kit (libck, \-lck)
.Sh SYNOPSIS
.In ck_pr.h
.Ft bool
.Fn ck_pr_bts_ptr "void *target" "unsigned int bit_index"
.Ft bool
.Fn ck_pr_bts_uint "uint *target" "unsigned int bit_index"
.Ft bool
.Fn ck_pr_bts_int "int *target" "unsigned int bit_index"
.Ft bool
.Fn ck_pr_bts_64 "uint64_t *target" "unsigned int bit_index"
.Ft bool
.Fn ck_pr_bts_32 "uint32_t *target" "unsigned int bit_index"
.Ft bool
.Fn ck_pr_bts_16 "uint16_t *target" "unsigned int bit_index"
.Sh DESCRIPTION
The
.Fn ck_pr_bts 3
family of functions will atomically fetch the value
of the bit in
.Fa target
at index
.Fa bit_index
and set that bit to 1.
.Sh RETURN VALUES
These family of functions will return 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_btr 3 ,
.Xr ck_pr_cas 3
.Pp
Additional information available at http://concurrencykit.org/
Write Preview
Loading…
Cancel
Save