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