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

doc/ck_pr: Additional manual pages.

Browse Source
ck_pring
Samy Al Bahra 12 years ago
parent ae688d1f09
commit c22dcdb04b
6 changed files with 434 additions and 1 deletions
Show Stats Download Patch File Download Diff File

7
doc/Makefile.in
Unescape View File

@ -97,7 +97,12 @@ OBJECTS=ck_ht_count \
ck_pr_inc \
ck_pr_dec \
ck_pr_not \
ck_pr_neg
ck_pr_neg \
ck_pr_add \
ck_pr_sub \
ck_pr_and \
ck_pr_xor \
ck_pr_or
all:
for target in $(OBJECTS); do \

85
doc/ck_pr_add
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_add 3
.Sh NAME
.Nm ck_pr_add
.Nd atomic addition operation
.Sh LIBRARY
Concurrency Kit (libck, \-lck)
.Sh SYNOPSIS
.In ck_pr.h
.Ft void
.Fn ck_pr_add_ptr "void *target" "uintptr_t delta"
.Ft void
.Fn ck_pr_add_double "double *target" "double delta"
.Ft void
.Fn ck_pr_add_char "char *target" "char delta"
.Ft void
.Fn ck_pr_add_uint "unsigned int *target" "unsigned int delta"
.Ft void
.Fn ck_pr_add_int "int *target" "int delta"
.Ft void
.Fn ck_pr_add_64 "uint64_t *target" "uint64_t delta"
.Ft void
.Fn ck_pr_add_32 "uint32_t *target" "uint32_t delta"
.Ft void
.Fn ck_pr_add_16 "uint16_t *target" "uint16_t delta"
.Ft void
.Fn ck_pr_add_8 "uint8_t *target" "uint8_t delta"
.Sh DESCRIPTION
The
.Fn ck_pr_add 3
family of functions will atomically add the value specified by
.Fa delta
to the value pointed to by
.Fa target .
.Sh RETURN VALUES
This family of functions does not have a 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_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_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/

86
doc/ck_pr_and
Unescape View File

@ -0,0 +1,86 @@
.\"
.\" 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_and 3
.Sh NAME
.Nm ck_pr_and
.Nd atomic bitwise-and operation
.Sh LIBRARY
Concurrency Kit (libck, \-lck)
.Sh SYNOPSIS
.In ck_pr.h
.Ft void
.Fn ck_pr_and_ptr "void *target" "uintptr_t delta"
.Ft void
.Fn ck_pr_and_char "char *target" "char delta"
.Ft void
.Fn ck_pr_and_uint "unsigned int *target" "unsigned int delta"
.Ft void
.Fn ck_pr_and_int "int *target" "int delta"
.Ft void
.Fn ck_pr_and_64 "uint64_t *target" "uint64_t delta"
.Ft void
.Fn ck_pr_and_32 "uint32_t *target" "uint32_t delta"
.Ft void
.Fn ck_pr_and_16 "uint16_t *target" "uint16_t delta"
.Ft void
.Fn ck_pr_and_8 "uint8_t *target" "uint8_t delta"
.Sh DESCRIPTION
The
.Fn ck_pr_and 3
family of functions will atomically compute and store the
result of a bitwise-and of the value pointed to by
.Fa target
and
.Fa delta
into the value pointed to by
.Fa target .
.Sh RETURN VALUES
This family of functions does not have a 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_dec 3 ,
.Xr ck_pr_neg 3 ,
.Xr ck_pr_not 3 ,
.Xr ck_pr_add 3 ,
.Xr ck_pr_sub 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/

86
doc/ck_pr_or
Unescape View File

@ -0,0 +1,86 @@
.\"
.\" 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_or 3
.Sh NAME
.Nm ck_pr_or
.Nd atomic bitwise-or operation
.Sh LIBRARY
Concurrency Kit (libck, \-lck)
.Sh SYNOPSIS
.In ck_pr.h
.Ft void
.Fn ck_pr_or_ptr "void *target" "uintptr_t delta"
.Ft void
.Fn ck_pr_or_char "char *target" "char delta"
.Ft void
.Fn ck_pr_or_uint "unsigned int *target" "unsigned int delta"
.Ft void
.Fn ck_pr_or_int "int *target" "int delta"
.Ft void
.Fn ck_pr_or_64 "uint64_t *target" "uint64_t delta"
.Ft void
.Fn ck_pr_or_32 "uint32_t *target" "uint32_t delta"
.Ft void
.Fn ck_pr_or_16 "uint16_t *target" "uint16_t delta"
.Ft void
.Fn ck_pr_or_8 "uint8_t *target" "uint8_t delta"
.Sh DESCRIPTION
The
.Fn ck_pr_or 3
family of functions will atomically compute and store the
result of a bitwise-or of the value pointed to by
.Fa target
and
.Fa delta
into the value pointed to by
.Fa target .
.Sh RETURN VALUES
This family of functions does not have a 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_dec 3 ,
.Xr ck_pr_neg 3 ,
.Xr ck_pr_not 3 ,
.Xr ck_pr_add 3 ,
.Xr ck_pr_sub 3 ,
.Xr ck_pr_xor 3 ,
.Xr ck_pr_and 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/

85
doc/ck_pr_sub
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_sub 3
.Sh NAME
.Nm ck_pr_sub
.Nd atomic subtraction operation
.Sh LIBRARY
Concurrency Kit (libck, \-lck)
.Sh SYNOPSIS
.In ck_pr.h
.Ft void
.Fn ck_pr_sub_ptr "void *target" "uintptr_t delta"
.Ft void
.Fn ck_pr_sub_double "double *target" "double delta"
.Ft void
.Fn ck_pr_sub_char "char *target" "char delta"
.Ft void
.Fn ck_pr_sub_uint "unsigned int *target" "unsigned int delta"
.Ft void
.Fn ck_pr_sub_int "int *target" "int delta"
.Ft void
.Fn ck_pr_sub_64 "uint64_t *target" "uint64_t delta"
.Ft void
.Fn ck_pr_sub_32 "uint32_t *target" "uint32_t delta"
.Ft void
.Fn ck_pr_sub_16 "uint16_t *target" "uint16_t delta"
.Ft void
.Fn ck_pr_sub_8 "uint8_t *target" "uint8_t delta"
.Sh DESCRIPTION
The
.Fn ck_pr_sub 3
family of functions will atomically subtract the value specified by
.Fa delta
from the value pointed to by
.Fa target .
.Sh RETURN VALUES
This family of functions does not have a 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_dec 3 ,
.Xr ck_pr_neg 3 ,
.Xr ck_pr_not 3 ,
.Xr ck_pr_add 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/

86
doc/ck_pr_xor
Unescape View File

@ -0,0 +1,86 @@
.\"
.\" 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_xor 3
.Sh NAME
.Nm ck_pr_xor
.Nd atomic bitwise-xor operation
.Sh LIBRARY
Concurrency Kit (libck, \-lck)
.Sh SYNOPSIS
.In ck_pr.h
.Ft void
.Fn ck_pr_xor_ptr "void *target" "uintptr_t delta"
.Ft void
.Fn ck_pr_xor_char "char *target" "char delta"
.Ft void
.Fn ck_pr_xor_uint "unsigned int *target" "unsigned int delta"
.Ft void
.Fn ck_pr_xor_int "int *target" "int delta"
.Ft void
.Fn ck_pr_xor_64 "uint64_t *target" "uint64_t delta"
.Ft void
.Fn ck_pr_xor_32 "uint32_t *target" "uint32_t delta"
.Ft void
.Fn ck_pr_xor_16 "uint16_t *target" "uint16_t delta"
.Ft void
.Fn ck_pr_xor_8 "uint8_t *target" "uint8_t delta"
.Sh DESCRIPTION
The
.Fn ck_pr_xor 3
family of functions will atomically compute and store the
result of a bitwise-xor of the value pointed to by
.Fa target
and
.Fa delta
into the value pointed to by
.Fa target .
.Sh RETURN VALUES
This family of functions does not have a 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_dec 3 ,
.Xr ck_pr_neg 3 ,
.Xr ck_pr_not 3 ,
.Xr ck_pr_add 3 ,
.Xr ck_pr_sub 3 ,
.Xr ck_pr_or 3 ,
.Xr ck_pr_and 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