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