Spinlock depth checking
[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         void *call_site;        
46         uint32_t calling_core;
47 #endif
48 };
49 typedef struct spinlock spinlock_t;
50 #define SPINLOCK_INITIALIZER {0}
51
52 extern inline void spinlock_init(spinlock_t *lock);
53 extern inline bool spin_locked(spinlock_t *lock);
54 extern inline void spin_lock(spinlock_t *lock);
55 extern inline void spin_unlock(spinlock_t *lock);
56 extern inline void spinlock_debug(spinlock_t *lock);
57
58 static inline void spin_lock_irqsave(spinlock_t *lock);
59 static inline void spin_unlock_irqsave(spinlock_t *lock);
60 static inline bool spin_lock_irq_enabled(spinlock_t *lock);
61
62 /* Used for spinlock debugging.  When we move spinlocks into .c, we can move
63  * these too */
64 void increase_lock_depth(uint32_t coreid);
65 void decrease_lock_depth(uint32_t coreid);
66
67 /* Hash locks (array of spinlocks).  Most all users will want the default one,
68  * so point your pointer to one of them, though you could always kmalloc a
69  * bigger one.  In the future, they might be growable, etc, which init code may
70  * care about. */
71 struct hashlock {
72         unsigned int            nr_entries;
73         struct spinlock         locks[];
74 };
75 #define HASHLOCK_DEFAULT_SZ 53          /* nice prime, might be a bit large */
76 struct small_hashlock {
77         unsigned int            nr_entries;
78         struct spinlock         locks[HASHLOCK_DEFAULT_SZ];
79 };
80
81 void hashlock_init(struct hashlock *hl, unsigned int nr_entries);
82 void hash_lock(struct hashlock *hl, long key);
83 void hash_unlock(struct hashlock *hl, long key);
84 void hash_lock_irqsave(struct hashlock *hl, long key);
85 void hash_unlock_irqsave(struct hashlock *hl, long key);
86
87 /* Seq locks */
88 /* An example seq lock, built from the counter.  I don't particularly like this,
89  * since it forces you to use a specific locking type.  */
90 typedef struct seq_lock {
91         spinlock_t                      w_lock;
92         seq_ctr_t                       r_ctr;
93 } seqlock_t;
94
95 static inline void __seq_start_write(seq_ctr_t *seq_ctr);
96 static inline void __seq_end_write(seq_ctr_t *seq_ctr);
97 static inline void write_seqlock(seqlock_t *lock);
98 static inline void write_sequnlock(seqlock_t *lock);
99 static inline seq_ctr_t read_seqbegin(seqlock_t *lock);
100 static inline bool read_seqretry(seqlock_t *lock, seq_ctr_t ctr);
101
102 /* Arch-specific implementations / declarations go here */
103 #include <arch/atomic.h>
104
105 #define MAX_SPINS 1000000000
106
107 /* Will spin for a little while, but not deadlock if it never happens */
108 #define spin_on(x)                                                             \
109         for (int i = 0; (x); i++) {                                                \
110                 cpu_relax();                                                           \
111                 if (i == MAX_SPINS) {                                                  \
112                         printk("Probably timed out/failed.\n");                            \
113                         break;                                                             \
114                 }                                                                      \
115         }
116
117 /*********************** Checklist stuff **********************/
118 typedef struct checklist_mask {
119         // only need an uint8_t, but we need the bits[] to be word aligned
120         uint32_t size;
121         volatile uint8_t (COUNT(BYTES_FOR_BITMASK(size)) bits)[MAX_NUM_CPUS];
122 } checklist_mask_t;
123
124 // mask contains an unspecified array, so it needs to be at the bottom
125 struct checklist {
126         spinlock_t lock;
127         checklist_mask_t mask;
128         // eagle-eyed readers may know why this might have been needed. 2009-09-04
129         //volatile uint8_t (COUNT(BYTES_FOR_BITMASK(size)) bits)[];
130 };
131 typedef struct checklist RACY checklist_t;
132
133 #define ZEROS_ARRAY(size) {[0 ... ((size)-1)] 0}
134
135 #define DEFAULT_CHECKLIST_MASK(sz) {(sz), ZEROS_ARRAY(BYTES_FOR_BITMASK(sz))}
136 #define DEFAULT_CHECKLIST(sz) {SPINLOCK_INITIALIZER, DEFAULT_CHECKLIST_MASK(sz)}
137 #define INIT_CHECKLIST(nm, sz)  \
138         checklist_t nm = DEFAULT_CHECKLIST(sz);
139 #define INIT_CHECKLIST_MASK(nm, sz)     \
140         checklist_mask_t nm = DEFAULT_CHECKLIST_MASK(sz);
141
142 int commit_checklist_wait(checklist_t* list, checklist_mask_t* mask);
143 int commit_checklist_nowait(checklist_t* list, checklist_mask_t* mask);
144 int waiton_checklist(checklist_t* list);
145 int release_checklist(checklist_t* list);
146 int checklist_is_locked(checklist_t* list);
147 int checklist_is_clear(checklist_t* list);
148 void reset_checklist(checklist_t* list);
149 void down_checklist(checklist_t* list);
150 // TODO - do we want to adjust the size?  (YES, don't want to check it all)
151 // TODO - do we want to be able to call waiton without having called commit?
152 //      - in the case of protected checklists
153 // TODO - want a destroy checklist (when we have kmalloc, or whatever)
154 // TODO - some sort of dynamic allocation of them in the future
155 // TODO - think about deadlock issues with one core spinning on a lock for
156 // something that it is the hold out for...
157 //      - probably should have interrupts enabled, and never grab these locks
158 //      from interrupt context (and not use irq_save)
159 /**************************************************************/
160
161 /* Barrier: currently made for everyone barriering.  Change to use checklist */
162 struct barrier {
163         spinlock_t lock;
164         uint32_t init_count;
165         uint32_t current_count;
166         volatile uint8_t ready;
167 };
168
169 typedef struct barrier RACY barrier_t;
170
171 void init_barrier(barrier_t*COUNT(1) barrier, uint32_t count);
172 void reset_barrier(barrier_t* barrier);
173 void waiton_barrier(barrier_t* barrier);
174
175 /* Spinlock bit flags */
176 #define SPINLOCK_IRQ_EN                 0x80000000
177
178 // If ints are enabled, disable them and note it in the top bit of the lock
179 // There is an assumption about releasing locks in order here...
180 static inline void spin_lock_irqsave(spinlock_t *SAFE lock)
181 {
182         uint32_t irq_en;
183         irq_en = irq_is_enabled();
184         disable_irq();
185         spin_lock(lock);
186         if (irq_en)
187                 lock->rlock |= SPINLOCK_IRQ_EN;
188 }
189
190 // if the high bit of the lock is set, then re-enable interrupts
191 // (note from asw: you're lucky this works, you little-endian jerks)
192 static inline void spin_unlock_irqsave(spinlock_t *SAFE lock)
193 {
194         if (spin_lock_irq_enabled(lock)) {
195                 spin_unlock(lock);
196                 enable_irq();
197         } else
198                 spin_unlock(lock);
199 }
200
201 /* Returns whether or not unlocking this lock should enable interrupts or not.
202  * Is meaningless on locks that weren't locked with irqsave. */
203 static inline bool spin_lock_irq_enabled(spinlock_t *SAFE lock)
204 {
205         return lock->rlock & SPINLOCK_IRQ_EN;
206 }
207
208 /* Note, the seq_ctr is not a full seq lock - just the counter guts.  Write
209  * access can be controlled by another lock (like the proc-lock).  start_ and
210  * end_write are the writer's responsibility to signal the readers of a
211  * concurrent write. */
212 static inline void __seq_start_write(seq_ctr_t *seq_ctr)
213 {
214 #ifdef _CONFIG_SEQLOCK_DEBUG_
215         assert(*seq_ctr % 2 == 0);
216 #endif
217         (*seq_ctr)++;
218         /* We're the only writer, so we need to prevent the compiler (and some
219          * arches) from reordering writes before this point. */
220         wmb();
221 }
222
223 static inline void __seq_end_write(seq_ctr_t *seq_ctr)
224 {
225 #ifdef _CONFIG_SEQLOCK_DEBUG_
226         assert(*seq_ctr % 2 == 1);
227 #endif
228         /* Need to prevent the compiler (and some arches) from reordering older
229          * stores */
230         wmb();
231         (*seq_ctr)++;
232 }
233
234 /* Untested reference implementation of a seq lock.  As mentioned above, we
235  * might need a variety of these (for instance, this doesn't do an irqsave).  Or
236  * there may be other invariants that we need the lock to protect. */
237 static inline void write_seqlock(seqlock_t *lock)
238 {
239         spin_lock(&lock->w_lock);
240         __seq_start_write(&lock->r_ctr);
241 }
242
243 static inline void write_sequnlock(seqlock_t *lock)
244 {
245         __seq_end_write(&lock->r_ctr);
246         spin_unlock(&lock->w_lock);
247 }
248
249 static inline seq_ctr_t read_seqbegin(seqlock_t *lock)
250 {
251         seq_ctr_t retval = lock->r_ctr;
252         rmb();  /* don't want future reads to come before our ctr read */
253         return retval;
254 }
255
256 static inline bool read_seqretry(seqlock_t *lock, seq_ctr_t ctr)
257 {
258         return seqctr_retry(lock->r_ctr, ctr);
259 }
260
261 #endif /* ROS_KERN_ATOMIC_H */