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