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

doc/ck_pr: Additional documentation and targets.

Browse Source
ck_pring
Samy Al Bahra 12 years ago
parent 25c99e806b
commit 6a42ad9bde
3 changed files with 193 additions and 1 deletions
Show Stats Download Patch File Download Diff File

4
doc/Makefile.in
Unescape View File

@ -95,7 +95,9 @@ OBJECTS=ck_ht_count \
ck_pr_stall \
ck_pr_faa \
ck_pr_inc \
ck_pr_dec
ck_pr_dec \
ck_pr_not \
ck_pr_neg
all:
for target in $(OBJECTS); do \

106
doc/ck_pr_neg
Unescape View File

@ -0,0 +1,106 @@
.\"
.\" 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 7, 2013
.Dt ck_pr_neg 3
.Sh NAME
.Nm ck_pr_neg
.Nd atomic negation operation
.Sh LIBRARY
Concurrency Kit (libck, \-lck)
.Sh SYNOPSIS
.In ck_pr.h
.Ft void
.Fn ck_pr_neg_ptr "void *target"
.Ft bool
.Fn ck_pr_neg_ptr_zero "void *target"
.Ft void
.Fn ck_pr_neg_double "double *target"
.Ft bool
.Fn ck_pr_neg_double_zero "double *target"
.Ft void
.Fn ck_pr_neg_char "char *target"
.Ft bool
.Fn ck_pr_neg_char_zero "char *target"
.Ft void
.Fn ck_pr_neg_uint "unsigned int *target"
.Ft bool
.Fn ck_pr_neg_uint_zero "unsigned int *target"
.Ft void
.Fn ck_pr_neg_int "int *target"
.Ft bool
.Fn ck_pr_neg_int_zero "int *target"
.Ft void
.Fn ck_pr_neg_64 "uint64_t *target"
.Ft bool
.Fn ck_pr_neg_64_zero "uint64_t *target"
.Ft void
.Fn ck_pr_neg_32 "uint32_t *target"
.Ft bool
.Fn ck_pr_neg_32_zero "uint32_t *target"
.Ft void
.Fn ck_pr_neg_16 "uint16_t *target"
.Ft bool
.Fn ck_pr_neg_16_zero "uint16_t *target"
.Ft void
.Fn ck_pr_neg_8 "uint8_t *target"
.Ft bool
.Fn ck_pr_neg_8_zero "uint8_t *target"
.Sh DESCRIPTION
The
.Fn ck_pr_neg 3
family of functions will atomically negation the value pointed to
by
.Fa target .
.Sh RETURN VALUES
The
.Fn ck_pr_neg_*_zero
family of functions will return true if the result
of the negation operation was 0. They will return
false otherwise.
.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_not 3 ,
.Xr ck_pr_add 3 ,
.Xr ck_pr_sub 3 ,
.Xr ck_pr_and 3 ,
.Xr ck_pr_or 3 ,
.Xr ck_pr_xor 3 ,
.Xr ck_pr_cas 3 ,
.Xr ck_pr_btc 3 ,
.Xr ck_pr_bts 3 ,
.Xr ck_pr_btr 3
.Pp
Additional information available at http://concurrencykit.org/

84
doc/ck_pr_not
Unescape View File

@ -0,0 +1,84 @@
.\"
.\" 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 7, 2013
.Dt ck_pr_not 3
.Sh NAME
.Nm ck_pr_not
.Nd atomic complement operation
.Sh LIBRARY
Concurrency Kit (libck, \-lck)
.Sh SYNOPSIS
.In ck_pr.h
.Ft void
.Fn ck_pr_not_ptr "void *target"
.Ft void
.Fn ck_pr_not_double "double *target"
.Ft void
.Fn ck_pr_not_char "char *target"
.Ft void
.Fn ck_pr_not_uint "unsigned int *target"
.Ft void
.Fn ck_pr_not_int "int *target"
.Ft void
.Fn ck_pr_not_64 "uint64_t *target"
.Ft void
.Fn ck_pr_not_32 "uint32_t *target"
.Ft void
.Fn ck_pr_not_16 "uint16_t *target"
.Ft void
.Fn ck_pr_not_8 "uint8_t *target"
.Sh DESCRIPTION
The
.Fn ck_pr_not 3
family of functions will atomically complement the value pointed to
by
.Fa target .
.Sh RETURN VALUES
These functions have no return value.
.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_not 3 ,
.Xr ck_pr_neg 3 ,
.Xr ck_pr_add 3 ,
.Xr ck_pr_sub 3 ,
.Xr ck_pr_and 3 ,
.Xr ck_pr_or 3 ,
.Xr ck_pr_xor 3 ,
.Xr ck_pr_cas 3 ,
.Xr ck_pr_btc 3 ,
.Xr ck_pr_bts 3 ,
.Xr ck_pr_btr 3
.Pp
Additional information available at http://concurrencykit.org/
Write Preview
Loading…
Cancel
Save