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