Split atomic library
[akaros.git] / kern / src / atomic.c
1 #include <arch/apic.h>
2
3 #include <atomic.h>
4 #include <ros/error.h>
5 #include <string.h>
6 #include <assert.h>
7
8 // Must be called in a pair with waiton_checklist
9 int commit_checklist_wait(checklist_t* list, checklist_mask_t* mask)
10 {
11         assert(list->mask.size == mask->size);
12         // abort if the list is locked.  this will protect us from trying to commit
13         // and thus spin on a checklist that we are already waiting on.  it is
14         // still possible to not get the lock, but the holder is on another core.
15         // Or, bail out if we can see the list is already in use.  This check is
16         // just an optimization before we try to use the list for real.
17         if ((checklist_is_locked(list)) || !checklist_is_clear(list))
18                 return E_BUSY;
19
20         // possession of this lock means you can wait on it and set it
21         spin_lock_irqsave(&list->lock);
22         // wait til the list is available.  could have some adaptive thing here
23         // where it fails after X tries (like 500), gives up the lock, and returns
24         // an error code
25         while (!checklist_is_clear(list))
26                 cpu_relax();
27
28         // list is ours and clear, set it to the settings of our list
29         COPY_BITMASK(list->mask.bits, mask->bits, mask->size); 
30         return 0;
31 }
32
33 int commit_checklist_nowait(checklist_t* list, checklist_mask_t* mask)
34 {
35         int e = 0;
36         if (e = commit_checklist_wait(list, mask))
37                 return e;
38         // give up the lock, since we won't wait for completion
39         spin_unlock_irqsave(&list->lock);
40         return e;
41 }
42 // The deal with the lock:
43 // what if two different actors are waiting on the list, but for different reasons?
44 // part of the problem is we are doing both set and check via the same path
45 //
46 // aside: we made this a lot more difficult than the usual barriers or even 
47 // the RCU grace-period checkers, since we have to worry about this construct
48 // being used by others before we are done with it.
49 //
50 // how about this: if we want to wait on this later, we just don't release the
51 // lock.  if we release it, then we don't care who comes in and grabs and starts
52 // checking the list.  
53 //      - regardless, there are going to be issues with people looking for a free 
54 //      item.  even if they grab the lock, they may end up waiting a while and 
55 //      wantint to bail (like test for a while, give up, move on, etc).  
56 //      - still limited in that only the setter can check, and only one person
57 //      can spinwait / check for completion.  if someone else tries to wait (wanting
58 //      completion), they may miss it if someone else comes in and grabs the lock
59 //      to use it for a new checklist
60 //              - if we had the ability to sleep and get woken up, we could have a 
61 //              queue.  actually, we could do a queue anyway, but they all spin
62 //              and it's the bosses responsibility to *wake* them
63
64 // Must be called after commit_checklist
65 // Assumed we held the lock if we ever call this
66 int waiton_checklist(checklist_t* list)
67 {
68         extern uint32_t outstanding_calls;
69         // can consider breakout out early, like above, and erroring out
70         while (!checklist_is_clear(list))
71                 cpu_relax();
72         spin_unlock_irqsave(&list->lock);
73         // global counter of wrappers either waited on or being contended for.
74         atomic_dec(&outstanding_calls);
75         return 0;
76 }
77
78 // like waiton, but don't bother waiting either
79 int release_checklist(checklist_t* list)
80 {
81         spin_unlock_irqsave(&list->lock);
82         return 0;
83 }
84
85 // peaks in and sees if the list is locked with it's spinlock
86 int checklist_is_locked(checklist_t* list)
87 {
88         // remember the lock status is the lowest byte of the lock
89         return list->lock & 0xff;
90 }
91
92 // no synch guarantees - just looks at the list
93 int checklist_is_clear(checklist_t* list)
94 {
95         return BITMASK_IS_CLEAR(list->mask.bits, list->mask.size);
96 }
97
98 // no synch guarantees - just resets the list to empty
99 void reset_checklist(checklist_t* list)
100 {
101         CLR_BITMASK(list->mask.bits, list->mask.size);
102 }
103
104 // CPU mask specific - this is how cores report in
105 void down_checklist(checklist_t* list)
106 {
107         CLR_BITMASK_BIT_ATOMIC(list->mask.bits, lapic_get_id());
108 }
109
110 /* Barriers */
111 void init_barrier(barrier_t* barrier, uint32_t count)
112 {
113         barrier->lock = 0;
114         barrier->init_count = count;
115         barrier->current_count = count;
116         barrier->ready = 0;
117 }
118
119 void reset_barrier(barrier_t* barrier)
120 {
121         barrier->current_count = barrier->init_count;
122 }
123
124 // primitive barrier function.  all cores call this.
125 void waiton_barrier(barrier_t* barrier)
126 {
127         uint8_t local_ready = barrier->ready;
128
129         spin_lock_irqsave(&barrier->lock);
130         barrier->current_count--;
131         if (barrier->current_count) {
132                 spin_unlock_irqsave(&barrier->lock);
133                 while (barrier->ready == local_ready)
134                         cpu_relax();
135         } else {
136                 spin_unlock_irqsave(&barrier->lock);
137                 reset_barrier(barrier);
138                 // if we need to wmb(), it'll be here
139                 barrier->ready++;
140         }
141 }