Spinlock depth checking
[akaros.git] / kern / src / atomic.c
1 #ifdef __SHARC__
2 #pragma nosharc
3 #endif
4
5 #include <arch/arch.h>
6
7 #include <bitmask.h>
8 #include <atomic.h>
9 #include <error.h>
10 #include <string.h>
11 #include <assert.h>
12 #include <hashtable.h>
13 #include <smp.h>
14
15 void increase_lock_depth(uint32_t coreid)
16 {
17         per_cpu_info[coreid].lock_depth++;
18 }
19
20 void decrease_lock_depth(uint32_t coreid)
21 {
22         per_cpu_info[coreid].lock_depth--;
23 }
24
25 /* Inits a hashlock. */
26 void hashlock_init(struct hashlock *hl, unsigned int nr_entries)
27 {
28         hl->nr_entries = nr_entries;
29         /* this is the right way to do it, though memset is faster.  If we ever
30          * find that this is taking a lot of time, we can change it. */
31         for (int i = 0; i < hl->nr_entries; i++) {
32                 spinlock_init(&hl->locks[i]);
33         }
34 }
35
36 /* Helper, gets the specific spinlock for a hl/key combo. */
37 static spinlock_t *get_spinlock(struct hashlock *hl, long key)
38 {
39         /* using the hashtable's generic hash function */
40         return &hl->locks[__generic_hash((void*)key) % hl->nr_entries];
41 }
42
43 void hash_lock(struct hashlock *hl, long key)
44 {
45         spin_lock(get_spinlock(hl, key));
46 }
47
48 void hash_unlock(struct hashlock *hl, long key)
49 {
50         spin_unlock(get_spinlock(hl, key));
51 }
52
53 void hash_lock_irqsave(struct hashlock *hl, long key)
54 {
55         spin_lock_irqsave(get_spinlock(hl, key));
56 }
57
58 void hash_unlock_irqsave(struct hashlock *hl, long key)
59 {
60         spin_unlock_irqsave(get_spinlock(hl, key));
61 }
62
63 // Must be called in a pair with waiton_checklist
64 int commit_checklist_wait(checklist_t* list, checklist_mask_t* mask)
65 {
66         assert(list->mask.size == mask->size);
67         // abort if the list is locked.  this will protect us from trying to commit
68         // and thus spin on a checklist that we are already waiting on.  it is
69         // still possible to not get the lock, but the holder is on another core.
70         // Or, bail out if we can see the list is already in use.  This check is
71         // just an optimization before we try to use the list for real.
72         if ((checklist_is_locked(list)) || !checklist_is_clear(list))
73                 return -EBUSY;
74
75         // possession of this lock means you can wait on it and set it
76         spin_lock_irqsave(&list->lock);
77         // wait til the list is available.  could have some adaptive thing here
78         // where it fails after X tries (like 500), gives up the lock, and returns
79         // an error code
80         while (!checklist_is_clear(list))
81                 cpu_relax();
82
83         // list is ours and clear, set it to the settings of our list
84         COPY_BITMASK(list->mask.bits, mask->bits, mask->size); 
85         return 0;
86 }
87
88 int commit_checklist_nowait(checklist_t* list, checklist_mask_t* mask)
89 {
90         int e = 0;
91         if ((e = commit_checklist_wait(list, mask)))
92                 return e;
93         // give up the lock, since we won't wait for completion
94         spin_unlock_irqsave(&list->lock);
95         return e;
96 }
97 // The deal with the lock:
98 // what if two different actors are waiting on the list, but for different reasons?
99 // part of the problem is we are doing both set and check via the same path
100 //
101 // aside: we made this a lot more difficult than the usual barriers or even 
102 // the RCU grace-period checkers, since we have to worry about this construct
103 // being used by others before we are done with it.
104 //
105 // how about this: if we want to wait on this later, we just don't release the
106 // lock.  if we release it, then we don't care who comes in and grabs and starts
107 // checking the list.  
108 //      - regardless, there are going to be issues with people looking for a free 
109 //      item.  even if they grab the lock, they may end up waiting a while and 
110 //      wantint to bail (like test for a while, give up, move on, etc).  
111 //      - still limited in that only the setter can check, and only one person
112 //      can spinwait / check for completion.  if someone else tries to wait (wanting
113 //      completion), they may miss it if someone else comes in and grabs the lock
114 //      to use it for a new checklist
115 //              - if we had the ability to sleep and get woken up, we could have a 
116 //              queue.  actually, we could do a queue anyway, but they all spin
117 //              and it's the bosses responsibility to *wake* them
118
119 // Must be called after commit_checklist
120 // Assumed we held the lock if we ever call this
121 int waiton_checklist(checklist_t* list)
122 {
123         extern atomic_t outstanding_calls;
124         // can consider breakout out early, like above, and erroring out
125         while (!checklist_is_clear(list))
126                 cpu_relax();
127         spin_unlock_irqsave(&list->lock);
128         // global counter of wrappers either waited on or being contended for.
129         atomic_dec(&outstanding_calls);
130         return 0;
131 }
132
133 // like waiton, but don't bother waiting either
134 int release_checklist(checklist_t* list)
135 {
136         spin_unlock_irqsave(&list->lock);
137         return 0;
138 }
139
140 // peaks in and sees if the list is locked with it's spinlock
141 int checklist_is_locked(checklist_t* list)
142 {
143         return spin_locked(&list->lock);
144 }
145
146 // no synch guarantees - just looks at the list
147 int checklist_is_clear(checklist_t* list)
148 {
149         return BITMASK_IS_CLEAR(list->mask.bits, list->mask.size);
150 }
151
152 // no synch guarantees - just resets the list to empty
153 void reset_checklist(checklist_t* list)
154 {
155         CLR_BITMASK(list->mask.bits, list->mask.size);
156 }
157
158 // CPU mask specific - this is how cores report in
159 void down_checklist(checklist_t* list)
160 {
161         CLR_BITMASK_BIT_ATOMIC(list->mask.bits, core_id());
162 }
163
164 /* Barriers */
165 void init_barrier(barrier_t* barrier, uint32_t count)
166 {
167         spinlock_init(&barrier->lock);
168         barrier->init_count = count;
169         barrier->current_count = count;
170         barrier->ready = 0;
171 }
172
173 void reset_barrier(barrier_t* barrier)
174 {
175         barrier->current_count = barrier->init_count;
176 }
177
178 // primitive barrier function.  all cores call this.
179 void waiton_barrier(barrier_t* barrier)
180 {
181         uint8_t local_ready = barrier->ready;
182
183         spin_lock_irqsave(&barrier->lock);
184         barrier->current_count--;
185         if (barrier->current_count) {
186                 spin_unlock_irqsave(&barrier->lock);
187                 while (barrier->ready == local_ready)
188                         cpu_relax();
189         } else {
190                 spin_unlock_irqsave(&barrier->lock);
191                 reset_barrier(barrier);
192                 wmb();
193                 barrier->ready++;
194         }
195 }