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