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