29c09dc5807a4da27000684a9012f84b178da4f0
[akaros.git] / kern / include / atomic.h
1 /* Copyright (c) 2009-2011 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Kernel atomics and locking functions.
6  *
7  * The extern inline declarations are arch-dependent functions.  We do this
8  * so that each arch can either static inline or just have a regular function,
9  * whichever is appropriate. The actual implementation usually will be in
10  * arch/atomic.h (for inlines).
11  *
12  * The static inlines are defined farther down in the file (as always). */
13
14 #ifndef ROS_KERN_ATOMIC_H
15 #define ROS_KERN_ATOMIC_H
16
17 #include <ros/common.h>
18 #include <ros/atomic.h>
19 #include <arch/mmu.h>
20 #include <arch/arch.h>
21 #include <assert.h>
22
23 /* Atomics */
24 extern inline void atomic_init(atomic_t *number, long val);
25 extern inline long atomic_read(atomic_t *number);
26 extern inline void atomic_set(atomic_t *number, long val);
27 extern inline void atomic_add(atomic_t *number, long val);
28 extern inline void atomic_inc(atomic_t *number);
29 extern inline void atomic_dec(atomic_t *number);
30 extern inline long atomic_fetch_and_add(atomic_t *number, long val);
31 extern inline void atomic_and(atomic_t *number, long mask);
32 extern inline void atomic_or(atomic_t *number, long mask);
33 extern inline long atomic_swap(atomic_t *addr, long val);
34 extern inline bool atomic_cas(atomic_t *addr, long exp_val, long new_val);
35 extern inline bool atomic_cas_ptr(void **addr, void *exp_val, void *new_val);
36 extern inline bool atomic_cas_u32(uint32_t *addr, uint32_t exp_val,
37                                   uint32_t new_val);
38 extern inline bool atomic_add_not_zero(atomic_t *number, long val);
39 extern inline bool atomic_sub_and_test(atomic_t *number, long val);
40
41 /* Spin locks */
42 struct spinlock {
43         volatile uint32_t RACY rlock;
44 #ifdef __CONFIG_SPINLOCK_DEBUG__
45         uintptr_t call_site;
46         uint32_t calling_core;
47         bool irq_okay;
48 #endif
49 };
50 typedef struct spinlock spinlock_t;
51 #define SPINLOCK_INITIALIZER {0}
52
53 #ifdef __CONFIG_SPINLOCK_DEBUG__
54 #define SPINLOCK_INITIALIZER_IRQSAVE {0, .irq_okay = TRUE}
55 #else
56 #define SPINLOCK_INITIALIZER_IRQSAVE SPINLOCK_INITIALIZER
57 #endif
58
59 /* Arch dependent helpers/funcs: */
60 extern inline void __spinlock_init(spinlock_t *lock);
61 extern inline bool spin_locked(spinlock_t *lock);
62 extern inline void __spin_lock(spinlock_t *lock);
63 extern inline void __spin_unlock(spinlock_t *lock);
64 extern inline void spinlock_debug(spinlock_t *lock);
65
66 /* So we can inline a __spin_lock if we want.  Even though we don't need this
67  * if we're debugging, its helpful to keep the include at the same place for
68  * all builds. */
69 #include <arch/atomic.h>
70
71 #ifdef __CONFIG_SPINLOCK_DEBUG__
72 /* Arch indep, in k/s/atomic.c */
73 void spin_lock(spinlock_t *lock);
74 void spin_unlock(spinlock_t *lock);
75
76 #else
77 /* Just inline the arch-specific __ versions */
78 static inline void spin_lock(spinlock_t *lock)
79 {
80         __spin_lock(lock);
81 }
82
83 static inline void spin_unlock(spinlock_t *lock)
84 {
85         __spin_unlock(lock);
86 }
87
88 #endif /* __CONFIG_SPINLOCK_DEBUG__ */
89
90 /* Inlines, defined below */
91 static inline void spinlock_init(spinlock_t *lock);
92 static inline void spinlock_init_irqsave(spinlock_t *lock);
93 static inline void spin_lock_irqsave(spinlock_t *lock);
94 static inline void spin_unlock_irqsave(spinlock_t *lock);
95 static inline bool spin_lock_irq_enabled(spinlock_t *lock);
96
97 /* Hash locks (array of spinlocks).  Most all users will want the default one,
98  * so point your pointer to one of them, though you could always kmalloc a
99  * bigger one.  In the future, they might be growable, etc, which init code may
100  * care about. */
101 struct hashlock {
102         unsigned int            nr_entries;
103         struct spinlock         locks[];
104 };
105 #define HASHLOCK_DEFAULT_SZ 53          /* nice prime, might be a bit large */
106 struct small_hashlock {
107         unsigned int            nr_entries;
108         struct spinlock         locks[HASHLOCK_DEFAULT_SZ];
109 };
110
111 void hashlock_init(struct hashlock *hl, unsigned int nr_entries);
112 void hashlock_init_irqsave(struct hashlock *hl, unsigned int nr_entries);
113 void hash_lock(struct hashlock *hl, long key);
114 void hash_unlock(struct hashlock *hl, long key);
115 void hash_lock_irqsave(struct hashlock *hl, long key);
116 void hash_unlock_irqsave(struct hashlock *hl, long key);
117
118 /* Seq locks */
119 /* An example seq lock, built from the counter.  I don't particularly like this,
120  * since it forces you to use a specific locking type.  */
121 typedef struct seq_lock {
122         spinlock_t                      w_lock;
123         seq_ctr_t                       r_ctr;
124 } seqlock_t;
125
126 static inline void __seq_start_write(seq_ctr_t *seq_ctr);
127 static inline void __seq_end_write(seq_ctr_t *seq_ctr);
128 static inline void write_seqlock(seqlock_t *lock);
129 static inline void write_sequnlock(seqlock_t *lock);
130 static inline seq_ctr_t read_seqbegin(seqlock_t *lock);
131 static inline bool read_seqretry(seqlock_t *lock, seq_ctr_t ctr);
132
133 /* Post work and poke synchronization.  This is a wait-free way to make sure
134  * some code is run, usually by the calling core, but potentially by any core.
135  * Under contention, everyone just posts work, and one core will carry out the
136  * work.  Callers post work (the meaning of which is particular to their
137  * subsystem), then call this function.  The function is not run concurrently
138  * with itself.
139  *
140  * In the future, this may send RKMs to LL cores to ensure the work is done
141  * somewhere, but not necessarily on the calling core.  Will reserve 'flags'
142  * for that. */
143 struct poke_tracker {
144         atomic_t                        need_to_run;
145         atomic_t                        run_in_progress;
146         void                            (*func)(void *);
147 };
148 void poke(struct poke_tracker *tracker, void *arg);
149
150 /* Arch-specific implementations / declarations go here */
151 #include <arch/atomic.h>
152
153 #define MAX_SPINS 1000000000
154
155 /* Will spin for a little while, but not deadlock if it never happens */
156 #define spin_on(x)                                                             \
157         for (int i = 0; (x); i++) {                                                \
158                 cpu_relax();                                                           \
159                 if (i == MAX_SPINS) {                                                  \
160                         printk("Probably timed out/failed.\n");                            \
161                         break;                                                             \
162                 }                                                                      \
163         }
164
165 /*********************** Checklist stuff **********************/
166 typedef struct checklist_mask {
167         // only need an uint8_t, but we need the bits[] to be word aligned
168         uint32_t size;
169         volatile uint8_t (COUNT(BYTES_FOR_BITMASK(size)) bits)[MAX_NUM_CPUS];
170 } checklist_mask_t;
171
172 // mask contains an unspecified array, so it needs to be at the bottom
173 struct checklist {
174         spinlock_t lock;
175         checklist_mask_t mask;
176         // eagle-eyed readers may know why this might have been needed. 2009-09-04
177         //volatile uint8_t (COUNT(BYTES_FOR_BITMASK(size)) bits)[];
178 };
179 typedef struct checklist RACY checklist_t;
180
181 #define ZEROS_ARRAY(size) {[0 ... ((size)-1)] 0}
182
183 #define DEFAULT_CHECKLIST_MASK(sz) {(sz), ZEROS_ARRAY(BYTES_FOR_BITMASK(sz))}
184 #define DEFAULT_CHECKLIST(sz) {SPINLOCK_INITIALIZER_IRQSAVE,                   \
185                                DEFAULT_CHECKLIST_MASK(sz)}
186 #define INIT_CHECKLIST(nm, sz)  \
187         checklist_t nm = DEFAULT_CHECKLIST(sz);
188 #define INIT_CHECKLIST_MASK(nm, sz)     \
189         checklist_mask_t nm = DEFAULT_CHECKLIST_MASK(sz);
190
191 int commit_checklist_wait(checklist_t* list, checklist_mask_t* mask);
192 int commit_checklist_nowait(checklist_t* list, checklist_mask_t* mask);
193 int waiton_checklist(checklist_t* list);
194 int release_checklist(checklist_t* list);
195 int checklist_is_locked(checklist_t* list);
196 int checklist_is_clear(checklist_t* list);
197 void reset_checklist(checklist_t* list);
198 void down_checklist(checklist_t* list);
199 // TODO - do we want to adjust the size?  (YES, don't want to check it all)
200 // TODO - do we want to be able to call waiton without having called commit?
201 //      - in the case of protected checklists
202 // TODO - want a destroy checklist (when we have kmalloc, or whatever)
203 // TODO - some sort of dynamic allocation of them in the future
204 // TODO - think about deadlock issues with one core spinning on a lock for
205 // something that it is the hold out for...
206 //      - probably should have interrupts enabled, and never grab these locks
207 //      from interrupt context (and not use irq_save)
208 /**************************************************************/
209
210 /* Barrier: currently made for everyone barriering.  Change to use checklist */
211 struct barrier {
212         spinlock_t lock;
213         uint32_t init_count;
214         uint32_t current_count;
215         volatile uint8_t ready;
216 };
217
218 typedef struct barrier RACY barrier_t;
219
220 void init_barrier(barrier_t*COUNT(1) barrier, uint32_t count);
221 void reset_barrier(barrier_t* barrier);
222 void waiton_barrier(barrier_t* barrier);
223
224 /* Spinlock bit flags */
225 #define SPINLOCK_IRQ_EN                 0x80000000
226
227 static inline void spinlock_init(spinlock_t *lock)
228 {
229         __spinlock_init(lock);
230 #ifdef __CONFIG_SPINLOCK_DEBUG__
231         lock->call_site = 0;
232         lock->calling_core = 0;
233         lock->irq_okay = FALSE;
234 #endif
235 }
236
237 static inline void spinlock_init_irqsave(spinlock_t *lock)
238 {
239         __spinlock_init(lock);
240 #ifdef __CONFIG_SPINLOCK_DEBUG__
241         lock->call_site = 0;
242         lock->calling_core = 0;
243         lock->irq_okay = TRUE;
244 #endif
245 }
246
247 // If ints are enabled, disable them and note it in the top bit of the lock
248 // There is an assumption about releasing locks in order here...
249 static inline void spin_lock_irqsave(spinlock_t *SAFE lock)
250 {
251         uint32_t irq_en;
252         irq_en = irq_is_enabled();
253         disable_irq();
254         spin_lock(lock);
255         if (irq_en)
256                 lock->rlock |= SPINLOCK_IRQ_EN;
257 }
258
259 // if the high bit of the lock is set, then re-enable interrupts
260 // (note from asw: you're lucky this works, you little-endian jerks)
261 static inline void spin_unlock_irqsave(spinlock_t *SAFE lock)
262 {
263         if (spin_lock_irq_enabled(lock)) {
264                 spin_unlock(lock);
265                 enable_irq();
266         } else
267                 spin_unlock(lock);
268 }
269
270 /* Returns whether or not unlocking this lock should enable interrupts or not.
271  * Is meaningless on locks that weren't locked with irqsave. */
272 static inline bool spin_lock_irq_enabled(spinlock_t *SAFE lock)
273 {
274         return lock->rlock & SPINLOCK_IRQ_EN;
275 }
276
277 /* Note, the seq_ctr is not a full seq lock - just the counter guts.  Write
278  * access can be controlled by another lock (like the proc-lock).  start_ and
279  * end_write are the writer's responsibility to signal the readers of a
280  * concurrent write. */
281 static inline void __seq_start_write(seq_ctr_t *seq_ctr)
282 {
283 #ifdef _CONFIG_SEQLOCK_DEBUG_
284         assert(*seq_ctr % 2 == 0);
285 #endif
286         (*seq_ctr)++;
287         /* We're the only writer, so we need to prevent the compiler (and some
288          * arches) from reordering writes before this point. */
289         wmb();
290 }
291
292 static inline void __seq_end_write(seq_ctr_t *seq_ctr)
293 {
294 #ifdef _CONFIG_SEQLOCK_DEBUG_
295         assert(*seq_ctr % 2 == 1);
296 #endif
297         /* Need to prevent the compiler (and some arches) from reordering older
298          * stores */
299         wmb();
300         (*seq_ctr)++;
301 }
302
303 /* Untested reference implementation of a seq lock.  As mentioned above, we
304  * might need a variety of these (for instance, this doesn't do an irqsave).  Or
305  * there may be other invariants that we need the lock to protect. */
306 static inline void write_seqlock(seqlock_t *lock)
307 {
308         spin_lock(&lock->w_lock);
309         __seq_start_write(&lock->r_ctr);
310 }
311
312 static inline void write_sequnlock(seqlock_t *lock)
313 {
314         __seq_end_write(&lock->r_ctr);
315         spin_unlock(&lock->w_lock);
316 }
317
318 static inline seq_ctr_t read_seqbegin(seqlock_t *lock)
319 {
320         seq_ctr_t retval = lock->r_ctr;
321         rmb();  /* don't want future reads to come before our ctr read */
322         return retval;
323 }
324
325 static inline bool read_seqretry(seqlock_t *lock, seq_ctr_t ctr)
326 {
327         return seqctr_retry(lock->r_ctr, ctr);
328 }
329
330 #endif /* ROS_KERN_ATOMIC_H */