Adds a pcpu tracer for spinlocks
[akaros.git] / kern / src / atomic.c
1 #ifdef __SHARC__
2 #pragma nosharc
3 #endif
4
5 #include <arch/arch.h>
6 #include <arch/kdebug.h>
7
8 #include <bitmask.h>
9 #include <atomic.h>
10 #include <error.h>
11 #include <string.h>
12 #include <assert.h>
13 #include <hashtable.h>
14 #include <smp.h>
15 #include <kmalloc.h>
16 #include <kdebug.h>
17
18 static void increase_lock_depth(uint32_t coreid)
19 {
20         per_cpu_info[coreid].lock_depth++;
21 }
22
23 static void decrease_lock_depth(uint32_t coreid)
24 {
25         per_cpu_info[coreid].lock_depth--;
26 }
27
28 #ifdef CONFIG_SPINLOCK_DEBUG
29 void spin_lock(spinlock_t *lock)
30 {
31         uint32_t coreid = core_id_early();
32         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
33         /* Short circuit our lock checking, so we can print or do other things to
34          * announce the failure that require locks.  Also avoids anything else
35          * requiring pcpui initialization. */
36         if (pcpui->__lock_checking_enabled != 1)
37                 goto lock;
38         if (lock->irq_okay) {
39                 if (!can_spinwait_irq(pcpui)) {
40                         pcpui->__lock_checking_enabled--;
41                         print_kctx_depths("IRQOK");
42                         panic("Lock %p tried to spin when it shouldn't\n", lock);
43                         pcpui->__lock_checking_enabled++;
44                 }
45         } else {
46                 if (!can_spinwait_noirq(pcpui)) {
47                         pcpui->__lock_checking_enabled--;
48                         print_kctx_depths("NOIRQ");
49                         panic("Lock %p tried to spin when it shouldn't\n", lock);
50                         pcpui->__lock_checking_enabled++;
51                 }
52         }
53         pcpui_trace_locks(pcpui, lock);
54 lock:
55         __spin_lock(lock);
56         lock->call_site = get_caller_pc();
57         lock->calling_core = coreid;
58         /* TODO consider merging this with __ctx_depth (unused field) */
59         increase_lock_depth(lock->calling_core);
60         /* Memory barriers are handled by the particular arches */
61 }
62
63 void spin_unlock(spinlock_t *lock)
64 {
65         decrease_lock_depth(lock->calling_core);
66         /* Memory barriers are handled by the particular arches */
67         __spin_unlock(lock);
68 }
69
70 void spinlock_debug(spinlock_t *lock)
71 {
72         uintptr_t pc = lock->call_site;
73         char *func_name;
74
75         if (!pc) {
76                 printk("Lock %p: never locked\n", lock);
77                 return;
78         }
79         func_name = get_fn_name(pc);
80         printk("Lock %p: last locked at [<%p>] in %s on core %d\n", lock, pc,
81                func_name, lock->calling_core);
82         kfree(func_name);
83 }
84
85 #endif /* CONFIG_SPINLOCK_DEBUG */
86
87 /* Inits a hashlock. */
88 void hashlock_init(struct hashlock *hl, unsigned int nr_entries)
89 {
90         hl->nr_entries = nr_entries;
91         /* this is the right way to do it, though memset is faster.  If we ever
92          * find that this is taking a lot of time, we can change it. */
93         for (int i = 0; i < hl->nr_entries; i++) {
94                 spinlock_init(&hl->locks[i]);
95         }
96 }
97
98 void hashlock_init_irqsave(struct hashlock *hl, unsigned int nr_entries)
99 {
100         hl->nr_entries = nr_entries;
101         /* this is the right way to do it, though memset is faster.  If we ever
102          * find that this is taking a lot of time, we can change it. */
103         for (int i = 0; i < hl->nr_entries; i++) {
104                 spinlock_init_irqsave(&hl->locks[i]);
105         }
106 }
107
108 /* Helper, gets the specific spinlock for a hl/key combo. */
109 static spinlock_t *get_spinlock(struct hashlock *hl, long key)
110 {
111         /* using the hashtable's generic hash function */
112         return &hl->locks[__generic_hash((void*)key) % hl->nr_entries];
113 }
114
115 void hash_lock(struct hashlock *hl, long key)
116 {
117         spin_lock(get_spinlock(hl, key));
118 }
119
120 void hash_unlock(struct hashlock *hl, long key)
121 {
122         spin_unlock(get_spinlock(hl, key));
123 }
124
125 void hash_lock_irqsave(struct hashlock *hl, long key)
126 {
127         spin_lock_irqsave(get_spinlock(hl, key));
128 }
129
130 void hash_unlock_irqsave(struct hashlock *hl, long key)
131 {
132         spin_unlock_irqsave(get_spinlock(hl, key));
133 }
134
135 /* This is the 'post (work) and poke' style of sync.  We make sure the poke
136  * tracker's function runs.  Once this returns, the func either has run or is
137  * currently running (in case someone else is running now).  We won't wait or
138  * spin or anything, and it is safe to call this recursively (deeper in the
139  * call-graph).
140  *
141  * It's up to the caller to somehow post its work.  We'll also pass arg to the
142  * func, ONLY IF the caller is the one to execute it - so there's no guarantee
143  * the func(specific_arg) combo will actually run.  It's more for info
144  * purposes/optimizations/etc.  If no one uses it, I'll get rid of it. */
145 void poke(struct poke_tracker *tracker, void *arg)
146 {
147         atomic_set(&tracker->need_to_run, TRUE);
148         /* will need to repeatedly do it if someone keeps posting work */
149         do {
150                 /* want an wrmb() btw posting work/need_to_run and in_progress.  the
151                  * swap provides the HW mb. just need a cmb, which we do in the loop to
152                  * cover the iterations (even though i can't imagine the compiler
153                  * reordering the check it needed to do for the branch).. */
154                 cmb();
155                 /* poke / make sure someone does it.  if we get a TRUE (1) back, someone
156                  * is already running and will deal with the posted work.  (probably on
157                  * their next loop).  if we got a 0 back, we won the race and have the
158                  * 'lock'. */
159                 if (atomic_swap(&tracker->run_in_progress, TRUE))
160                         return;
161                 /* if we're here, then we're the one who needs to run the func. */
162                 /* clear the 'need to run', since we're running it now.  new users will
163                  * set it again.  this write needs to be wmb()'d after in_progress.  the
164                  * swap provided the HW mb(). */
165                 cmb();
166                 atomic_set(&tracker->need_to_run, FALSE);       /* no internal HW mb */
167                 /* run the actual function.  the poke sync makes sure only one caller is
168                  * in that func at a time. */
169                 assert(tracker->func);
170                 tracker->func(arg);
171                 wmb();  /* ensure the in_prog write comes after the run_again. */
172                 atomic_set(&tracker->run_in_progress, FALSE);   /* no internal HW mb */
173                 /* in_prog write must come before run_again read */
174                 wrmb();
175         } while (atomic_read(&tracker->need_to_run));   /* while there's more work*/
176 }
177
178 // Must be called in a pair with waiton_checklist
179 int commit_checklist_wait(checklist_t* list, checklist_mask_t* mask)
180 {
181         assert(list->mask.size == mask->size);
182         // abort if the list is locked.  this will protect us from trying to commit
183         // and thus spin on a checklist that we are already waiting on.  it is
184         // still possible to not get the lock, but the holder is on another core.
185         // Or, bail out if we can see the list is already in use.  This check is
186         // just an optimization before we try to use the list for real.
187         if ((checklist_is_locked(list)) || !checklist_is_clear(list))
188                 return -EBUSY;
189
190         // possession of this lock means you can wait on it and set it
191         spin_lock_irqsave(&list->lock);
192         // wait til the list is available.  could have some adaptive thing here
193         // where it fails after X tries (like 500), gives up the lock, and returns
194         // an error code
195         while (!checklist_is_clear(list))
196                 cpu_relax();
197
198         // list is ours and clear, set it to the settings of our list
199         COPY_BITMASK(list->mask.bits, mask->bits, mask->size); 
200         return 0;
201 }
202
203 int commit_checklist_nowait(checklist_t* list, checklist_mask_t* mask)
204 {
205         int e = 0;
206         if ((e = commit_checklist_wait(list, mask)))
207                 return e;
208         // give up the lock, since we won't wait for completion
209         spin_unlock_irqsave(&list->lock);
210         return e;
211 }
212 // The deal with the lock:
213 // what if two different actors are waiting on the list, but for different reasons?
214 // part of the problem is we are doing both set and check via the same path
215 //
216 // aside: we made this a lot more difficult than the usual barriers or even 
217 // the RCU grace-period checkers, since we have to worry about this construct
218 // being used by others before we are done with it.
219 //
220 // how about this: if we want to wait on this later, we just don't release the
221 // lock.  if we release it, then we don't care who comes in and grabs and starts
222 // checking the list.  
223 //      - regardless, there are going to be issues with people looking for a free 
224 //      item.  even if they grab the lock, they may end up waiting a while and 
225 //      wantint to bail (like test for a while, give up, move on, etc).  
226 //      - still limited in that only the setter can check, and only one person
227 //      can spinwait / check for completion.  if someone else tries to wait (wanting
228 //      completion), they may miss it if someone else comes in and grabs the lock
229 //      to use it for a new checklist
230 //              - if we had the ability to sleep and get woken up, we could have a 
231 //              queue.  actually, we could do a queue anyway, but they all spin
232 //              and it's the bosses responsibility to *wake* them
233
234 // Must be called after commit_checklist
235 // Assumed we held the lock if we ever call this
236 int waiton_checklist(checklist_t* list)
237 {
238         extern atomic_t outstanding_calls;
239         // can consider breakout out early, like above, and erroring out
240         while (!checklist_is_clear(list))
241                 cpu_relax();
242         spin_unlock_irqsave(&list->lock);
243         // global counter of wrappers either waited on or being contended for.
244         atomic_dec(&outstanding_calls);
245         return 0;
246 }
247
248 // like waiton, but don't bother waiting either
249 int release_checklist(checklist_t* list)
250 {
251         spin_unlock_irqsave(&list->lock);
252         return 0;
253 }
254
255 // peaks in and sees if the list is locked with it's spinlock
256 int checklist_is_locked(checklist_t* list)
257 {
258         return spin_locked(&list->lock);
259 }
260
261 // no synch guarantees - just looks at the list
262 int checklist_is_clear(checklist_t* list)
263 {
264         return BITMASK_IS_CLEAR(list->mask.bits, list->mask.size);
265 }
266
267 // no synch guarantees - just resets the list to empty
268 void reset_checklist(checklist_t* list)
269 {
270         CLR_BITMASK(list->mask.bits, list->mask.size);
271 }
272
273 // CPU mask specific - this is how cores report in
274 void down_checklist(checklist_t* list)
275 {
276         CLR_BITMASK_BIT_ATOMIC(list->mask.bits, core_id());
277 }
278
279 /* Barriers */
280 void init_barrier(barrier_t* barrier, uint32_t count)
281 {
282         spinlock_init_irqsave(&barrier->lock);
283         barrier->init_count = count;
284         barrier->current_count = count;
285         barrier->ready = 0;
286 }
287
288 void reset_barrier(barrier_t* barrier)
289 {
290         barrier->current_count = barrier->init_count;
291 }
292
293 // primitive barrier function.  all cores call this.
294 void waiton_barrier(barrier_t* barrier)
295 {
296         uint8_t local_ready = barrier->ready;
297
298         spin_lock_irqsave(&barrier->lock);
299         barrier->current_count--;
300         if (barrier->current_count) {
301                 spin_unlock_irqsave(&barrier->lock);
302                 while (barrier->ready == local_ready)
303                         cpu_relax();
304         } else {
305                 spin_unlock_irqsave(&barrier->lock);
306                 reset_barrier(barrier);
307                 wmb();
308                 barrier->ready++;
309         }
310 }