summaryrefslogtreecommitdiff
path: root/kern/latomic.h
blob: 8e93028e998d2d5c18cac19d2ee652f7df434f24 (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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/*
 * Copyright (c) 2018 Agustina Arzille.
 * Copyright (c) 2018 Richard Braun.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *
 * CPU-local atomic operations.
 *
 * The latomic module provides operations that are "atomic on the local
 * processor", i.e. interrupt-safe. Its interface is similar in spirit
 * and purpose to that of the atomic module, and it can transparently
 * replace it on single-processor configurations.
 *
 * Note that the only operations guaranteed to be truely atomic, i.e.
 * to completely execute in a single atomic instruction, are loads and
 * stores. All other operations may be implemented with multiple
 * instructions, possibly disabling interrupts. The rationale is that
 * atomic loads and stores are required for some types of access, such
 * as memory-mapped device registers, while other operations only require
 * interrupt safety.
 *
 * Also note that interrupts are considered to strictly match the definition
 * of signals as described in the specification of program execution in
 * the C language. This defines the forms of communication allowed with
 * interrupts handlers.
 *
 * This header provides a generic implementation. Architectures can
 * individually override any of the operations provided by this module.
 */

#ifndef KERN_LATOMIC_H
#define KERN_LATOMIC_H

#include <assert.h>

#include <kern/macros.h>

/*
 * Memory orders for local atomic operations.
 *
 * These work like those in the atomic module, but are implemented
 * with simple compiler barriers instead of full memory fences.
 */
#define LATOMIC_RELAXED __ATOMIC_RELAXED
#define LATOMIC_ACQUIRE __ATOMIC_ACQUIRE
#define LATOMIC_RELEASE __ATOMIC_RELEASE
#define LATOMIC_ACQ_REL __ATOMIC_ACQ_REL
#define LATOMIC_SEQ_CST __ATOMIC_SEQ_CST

#include <kern/latomic_i.h>

#define latomic_load(ptr, memorder)                                         \
MACRO_BEGIN                                                                 \
    assert(latomic_ptr_aligned(ptr));                                       \
    ((typeof(*(ptr)))latomic_select(ptr, load)(ptr, memorder));             \
MACRO_END

#define latomic_store(ptr, val, memorder)                                   \
MACRO_BEGIN                                                                 \
    assert(latomic_ptr_aligned(ptr));                                       \
    latomic_select(ptr, store)(ptr, val, memorder);                         \
MACRO_END

#define latomic_swap(ptr, val, memorder)                                    \
MACRO_BEGIN                                                                 \
    assert(latomic_ptr_aligned(ptr));                                       \
    ((typeof(*(ptr)))latomic_select(ptr, swap)(ptr, val, memorder));        \
MACRO_END

#define latomic_cas(ptr, oval, nval, memorder)                              \
MACRO_BEGIN                                                                 \
    assert(latomic_ptr_aligned(ptr));                                       \
    ((typeof(*(ptr)))latomic_select(ptr, cas)(ptr, oval, nval, memorder));  \
MACRO_END

#define latomic_fetch_add(ptr, val, memorder)                               \
MACRO_BEGIN                                                                 \
    assert(latomic_ptr_aligned(ptr));                                       \
    ((typeof(*(ptr)))latomic_select(ptr, fetch_add)(ptr, val, memorder));   \
MACRO_END

#define latomic_fetch_sub(ptr, val, memorder)                               \
MACRO_BEGIN                                                                 \
    assert(latomic_ptr_aligned(ptr));                                       \
    ((typeof(*(ptr)))latomic_select(ptr, fetch_sub)(ptr, val, memorder));   \
MACRO_END

#define latomic_fetch_and(ptr, val, memorder)                               \
MACRO_BEGIN                                                                 \
    assert(latomic_ptr_aligned(ptr));                                       \
    ((typeof(*(ptr)))latomic_select(ptr, fetch_and)(ptr, val, memorder));   \
MACRO_END

#define latomic_fetch_or(ptr, val, memorder)                                \
MACRO_BEGIN                                                                 \
    assert(latomic_ptr_aligned(ptr));                                       \
    ((typeof(*(ptr)))latomic_select(ptr, fetch_or)(ptr, val, memorder));    \
MACRO_END

#define latomic_fetch_xor(ptr, val, memorder)                               \
MACRO_BEGIN                                                                 \
    assert(latomic_ptr_aligned(ptr));                                       \
    ((typeof(*(ptr)))latomic_select(ptr, fetch_xor)(ptr, val, memorder));   \
MACRO_END

#define latomic_add(ptr, val, memorder)                                     \
MACRO_BEGIN                                                                 \
    assert(latomic_ptr_aligned(ptr));                                       \
    latomic_select(ptr, add)(ptr, val, memorder);                           \
MACRO_END

#define latomic_sub(ptr, val, memorder)                                     \
MACRO_BEGIN                                                                 \
    assert(latomic_ptr_aligned(ptr));                                       \
    latomic_select(ptr, sub)(ptr, val, memorder);                           \
MACRO_END

#define latomic_and(ptr, val, memorder)                                     \
MACRO_BEGIN                                                                 \
    assert(latomic_ptr_aligned(ptr));                                       \
    latomic_select(ptr, and)(ptr, val, memorder);                           \
MACRO_END

#define latomic_or(ptr, val, memorder)                                      \
MACRO_BEGIN                                                                 \
    assert(latomic_ptr_aligned(ptr));                                       \
    latomic_select(ptr, or)(ptr, val, memorder);                            \
MACRO_END

#define latomic_xor(ptr, val, memorder)                                     \
MACRO_BEGIN                                                                 \
    assert(latomic_ptr_aligned(ptr));                                       \
    latomic_select(ptr, xor)(ptr, val, memorder);                           \
MACRO_END

#define latomic_fence(memorder) __atomic_signal_fence(memorder)

#endif /* KERN_LATOMIC_H */