382523609c73f37f23de227a5baedc42a7e14434
[akaros.git] / kern / include / atomic.h
1 #ifndef ROS_KERN_ATOMIC_H
2 #define ROS_KERN_ATOMIC_H
3
4 #include <ros/common.h>
5 #include <ros/atomic.h>
6 #include <arch/mmu.h>
7 #include <arch/atomic.h>
8 #include <arch/arch.h>
9 #include <assert.h>
10
11 static inline void
12 (SLOCK(0) spin_lock_irqsave)(spinlock_t RACY*SAFE lock);
13 static inline void
14 (SUNLOCK(0) spin_unlock_irqsave)(spinlock_t RACY*SAFE lock);
15 static inline bool spin_lock_irq_enabled(spinlock_t *SAFE lock);
16
17 /* An example seq lock, built from the counter.  I don't particularly like this,
18  * since it forces you to use a specific locking type.  */
19 typedef struct seq_lock {
20         spinlock_t                      w_lock;
21         seq_ctr_t                       r_ctr;
22 } seqlock_t;
23
24 static inline void __seq_start_write(seq_ctr_t *seq_ctr);
25 static inline void __seq_end_write(seq_ctr_t *seq_ctr);
26 static inline void write_seqlock(seqlock_t *lock);
27 static inline void write_sequnlock(seqlock_t *lock);
28 static inline seq_ctr_t read_seqbegin(seqlock_t *lock);
29 static inline bool read_seqretry(seqlock_t *lock, seq_ctr_t ctr);
30
31 /*********************** Checklist stuff **********************/
32 typedef struct checklist_mask {
33         // only need an uint8_t, but we need the bits[] to be word aligned
34         uint32_t size;
35         volatile uint8_t (COUNT(BYTES_FOR_BITMASK(size)) bits)[MAX_NUM_CPUS];
36 } checklist_mask_t;
37
38 // mask contains an unspecified array, so it needs to be at the bottom
39 struct checklist {
40         spinlock_t lock;
41         checklist_mask_t mask;
42         // eagle-eyed readers may know why this might have been needed. 2009-09-04
43         //volatile uint8_t (COUNT(BYTES_FOR_BITMASK(size)) bits)[];
44 };
45 typedef struct checklist RACY checklist_t;
46
47 #define ZEROS_ARRAY(size) {[0 ... ((size)-1)] 0}
48
49 #define DEFAULT_CHECKLIST_MASK(sz) {(sz), ZEROS_ARRAY(BYTES_FOR_BITMASK(sz))}
50 #define DEFAULT_CHECKLIST(sz) {SPINLOCK_INITIALIZER, DEFAULT_CHECKLIST_MASK(sz)}
51 #define INIT_CHECKLIST(nm, sz)  \
52         checklist_t nm = DEFAULT_CHECKLIST(sz);
53 #define INIT_CHECKLIST_MASK(nm, sz)     \
54         checklist_mask_t nm = DEFAULT_CHECKLIST_MASK(sz);
55
56 int commit_checklist_wait(checklist_t* list, checklist_mask_t* mask);
57 int commit_checklist_nowait(checklist_t* list, checklist_mask_t* mask);
58 int waiton_checklist(checklist_t* list);
59 int release_checklist(checklist_t* list);
60 int checklist_is_locked(checklist_t* list);
61 int checklist_is_clear(checklist_t* list);
62 void reset_checklist(checklist_t* list);
63 void down_checklist(checklist_t* list);
64 // TODO - do we want to adjust the size?  (YES, don't want to check it all)
65 // TODO - do we want to be able to call waiton without having called commit?
66 //      - in the case of protected checklists
67 // TODO - want a destroy checklist (when we have kmalloc, or whatever)
68 // TODO - some sort of dynamic allocation of them in the future
69 // TODO - think about deadlock issues with one core spinning on a lock for
70 // something that it is the hold out for...
71 //      - probably should have interrupts enabled, and never grab these locks
72 //      from interrupt context (and not use irq_save)
73 /**************************************************************/
74
75 /* Barrier: currently made for everyone barriering.  Change to use checklist */
76 struct barrier {
77         spinlock_t lock;
78         uint32_t init_count;
79         uint32_t current_count;
80         volatile uint8_t ready;
81 };
82
83 typedef struct barrier RACY barrier_t;
84
85 void init_barrier(barrier_t*COUNT(1) barrier, uint32_t count);
86 void reset_barrier(barrier_t* barrier);
87 void waiton_barrier(barrier_t* barrier);
88
89 /* Spinlock bit flags */
90 #define SPINLOCK_IRQ_EN                 0x80000000
91
92 // If ints are enabled, disable them and note it in the top bit of the lock
93 // There is an assumption about releasing locks in order here...
94 static inline void spin_lock_irqsave(spinlock_t *SAFE lock)
95 {
96         uint32_t irq_en;
97         irq_en = irq_is_enabled();
98         disable_irq();
99         spin_lock(lock);
100         if (irq_en)
101                 lock->rlock |= SPINLOCK_IRQ_EN;
102 }
103
104 // if the high bit of the lock is set, then re-enable interrupts
105 // (note from asw: you're lucky this works, you little-endian jerks)
106 static inline void spin_unlock_irqsave(spinlock_t *SAFE lock)
107 {
108         if (spin_lock_irq_enabled(lock)) {
109                 spin_unlock(lock);
110                 enable_irq();
111         } else
112                 spin_unlock(lock);
113 }
114
115 /* Returns whether or not unlocking this lock should enable interrupts or not.
116  * Is meaningless on locks that weren't locked with irqsave. */
117 static inline bool spin_lock_irq_enabled(spinlock_t *SAFE lock)
118 {
119         return lock->rlock & SPINLOCK_IRQ_EN;
120 }
121
122 /* Note, the seq_ctr is not a full seq lock - just the counter guts.  Write
123  * access can be controlled by another lock (like the proc-lock).  start_ and
124  * end_write are the writer's responsibility to signal the readers of a
125  * concurrent write. */
126 static inline void __seq_start_write(seq_ctr_t *seq_ctr)
127 {
128 #ifdef _CONFIG_SEQLOCK_DEBUG_
129         assert(*seq_ctr % 2 == 0);
130 #endif
131         (*seq_ctr)++;
132 }
133
134 static inline void __seq_end_write(seq_ctr_t *seq_ctr)
135 {
136 #ifdef _CONFIG_SEQLOCK_DEBUG_
137         assert(*seq_ctr % 2 == 1);
138 #endif
139         (*seq_ctr)++;
140 }
141
142 /* Untested reference implementation of a seq lock.  As mentioned above, we
143  * might need a variety of these (for instance, this doesn't do an irqsave).  Or
144  * there may be other invariants that we need the lock to protect. */
145 static inline void write_seqlock(seqlock_t *lock)
146 {
147         spin_lock(&lock->w_lock);
148         __seq_start_write(&lock->r_ctr);
149 }
150
151 static inline void write_sequnlock(seqlock_t *lock)
152 {
153         __seq_end_write(&lock->r_ctr);
154         spin_unlock(&lock->w_lock);
155 }
156
157 static inline seq_ctr_t read_seqbegin(seqlock_t *lock)
158 {
159         return lock->r_ctr;
160 }
161
162 static inline bool read_seqretry(seqlock_t *lock, seq_ctr_t ctr)
163 {
164         return seqctr_retry(lock->r_ctr, ctr);
165 }
166
167 #endif /* !ROS_KERN_ATOMIC_H */