summaryrefslogtreecommitdiffstats
path: root/doc/ck_pr_faa
blob: fbeff01af128bb17af05e480f1a8961a2b6c6d5d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
.\"
.\" 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_faa 3
.Sh NAME
.Nm ck_pr_faa_ptr ,
.Nm ck_pr_faa_double ,
.Nm ck_pr_faa_char ,
.Nm ck_pr_faa_uint ,
.Nm ck_pr_faa_int ,
.Nm ck_pr_faa_64 ,
.Nm ck_pr_faa_32 ,
.Nm ck_pr_faa_16 ,
.Nm ck_pr_faa_8
.Nd atomic fetch-and-add operations
.Sh LIBRARY
Concurrency Kit (libck, \-lck)
.Sh SYNOPSIS
.In ck_pr.h
.Ft uintptr_t
.Fn ck_pr_faa_ptr "void *target" "uintptr_t delta"
.Ft double
.Fn ck_pr_faa_double "double *target" "double delta"
.Ft char
.Fn ck_pr_faa_char "char *target" "char delta"
.Ft unsigned int
.Fn ck_pr_faa_uint "unsigned int *target" "unsigned int delta"
.Ft int
.Fn ck_pr_faa_int "int *target" "int delta"
.Ft uint64_t
.Fn ck_pr_faa_64 "uint64_t *target" "uint64_t delta"
.Ft uint32_t
.Fn ck_pr_faa_32 "uint32_t *target" "uint32_t delta"
.Ft uint16_t
.Fn ck_pr_faa_16 "uint16_t *target" "uint16_t delta"
.Ft uint8_t
.Fn ck_pr_faa_8 "uint8_t *target" "uint8_t delta"
.Sh DESCRIPTION
The
.Fn ck_pr_faa 3
family of functions atomically fetch the value pointed to
by
.Fa target
and add the value specified by
.Fa delta
to the value pointed to by
.Fa target .
.Sh RETURN VALUES
This function returns the value pointed to by
.Fa target
at the time of operation invocation before the
addition operation is applied.
.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_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_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/