Xen Ring Buffers
[akaros.git] / kern / atomic.h
1 #ifndef ROS_KERN_ATOMIC_H
2 #define ROS_KERN_ATOMIC_H
3
4 #include <inc/types.h>
5 #include <inc/mmu.h>
6 #include <inc/x86.h>
7 #include <inc/atomic.h>
8
9 /* //linux style atomic ops
10 typedef struct {uint32_t real_num;} atomic_t;
11 #define atomic_read(atom) ((atom)->real_num)
12 #define atomic_set(atom, val) (((atom)->real_num) = (val))
13 #define atomic_init(i) {(i)}
14 //and the atomic incs, etc take an atomic_t ptr, deref inside
15 */
16
17 static inline void spin_lock(volatile uint32_t* lock);
18 static inline void spin_unlock(volatile uint32_t* lock);
19 static inline void spin_lock_irqsave(volatile uint32_t* lock);
20 static inline void spin_unlock_irqsave(volatile uint32_t* lock);
21 static inline void atomic_inc(volatile uint32_t* number);
22 static inline void atomic_dec(volatile uint32_t* number);
23 static inline void atomic_andb(volatile uint8_t* number, uint8_t mask);
24
25 /*********************** Checklist stuff **********************/
26 typedef struct checklist_mask {
27         // only need an uint8_t, but we need the bits[] to be word aligned
28         uint32_t size;
29         volatile uint8_t (COUNT(BYTES_FOR_BITMASK(size)) bits)[];
30 } checklist_mask_t;
31
32 // mask contains an unspecified array, so it needs to be at the bottom
33 typedef struct checklist {
34         volatile uint32_t lock;
35         checklist_mask_t mask;
36 } checklist_t;
37
38 #define ZEROS_ARRAY(size) {[0 ... ((size)-1)] 0}
39
40 #define DEFAULT_CHECKLIST_MASK(sz) {(sz), ZEROS_ARRAY(BYTES_FOR_BITMASK(sz))}
41 #define DEFAULT_CHECKLIST(sz) {0, DEFAULT_CHECKLIST_MASK(sz)}
42 #define INIT_CHECKLIST(nm, sz)  \
43         checklist_t nm = DEFAULT_CHECKLIST(sz);
44 #define INIT_CHECKLIST_MASK(nm, sz)     \
45         checklist_mask_t nm = DEFAULT_CHECKLIST_MASK(sz);
46
47 int commit_checklist_wait(checklist_t* list, checklist_mask_t* mask);
48 int commit_checklist_nowait(checklist_t* list, checklist_mask_t* mask);
49 int waiton_checklist(checklist_t* list);
50 int release_checklist(checklist_t* list);
51 int checklist_is_locked(checklist_t* list);
52 int checklist_is_clear(checklist_t* list);
53 void reset_checklist(checklist_t* list);
54 void down_checklist(checklist_t* list);
55 // TODO - do we want to adjust the size?  (YES, don't want to check it all)
56 // TODO - do we want to be able to call waiton without having called commit?
57 //      - in the case of protected checklists
58 // TODO - want a destroy checklist (when we have kmalloc, or whatever)
59 // TODO - some sort of dynamic allocation of them in the future
60 // TODO - think about deadlock issues with one core spinning on a lock for
61 // something that it is the hold out for...
62 //      - probably should have interrupts enabled, and never grab these locks
63 //      from interrupt context (and not use irq_save)
64 /**************************************************************/
65
66 /* Barrier: currently made for everyone barriering.  Change to use checklist */
67 typedef struct barrier {
68         volatile uint32_t lock;
69         uint32_t init_count;
70         uint32_t current_count;
71     volatile uint8_t ready;
72 } barrier_t;
73
74 void init_barrier(barrier_t* barrier, uint32_t count);
75 void reset_barrier(barrier_t* barrier);
76 void waiton_barrier(barrier_t* barrier);
77
78 /* Inlined functions declared above */
79 static inline void spin_lock(volatile uint32_t* lock)
80 {
81         asm volatile(
82                         "1:                       "
83                         "       cmpb $0, %0;          "
84                         "       je 2f;                "
85                         "       pause;                "
86                         "       jmp 1b;               "
87                         "2:                       " 
88                         "       movb $1, %%al;        "
89                         "       xchgb %%al, %0;       "
90                         "       cmpb $0, %%al;        "
91                         "       jne 1b;               "
92                 : : "m"(*lock) : "eax", "cc");
93 }
94
95 static inline void spin_unlock(volatile uint32_t* lock)
96 {
97         *lock = 0;
98 }
99
100 // If ints are enabled, disable them and note it in the top bit of the lock
101 // There is an assumption about releasing locks in order here...
102 static inline void spin_lock_irqsave(volatile uint32_t* lock)
103 {
104         uint32_t eflags;
105         eflags = read_eflags();
106         disable_irq();
107         spin_lock(lock);
108         if (eflags & FL_IF)
109                 *lock |= 0x80000000;
110 }
111
112 // if the top bit of the lock is set, then re-enable interrupts
113 static inline void spin_unlock_irqsave(volatile uint32_t* lock)
114 {
115         if (*lock & 0x80000000) {
116                 *lock = 0;
117                 enable_irq();
118         } else
119                 *lock = 0;
120 }
121
122 // need to do this with pointers and deref.  %0 needs to be the memory address
123 static inline void atomic_inc(volatile uint32_t* number)
124 {
125         asm volatile("lock incl %0" : "=m"(*number) : : "cc");
126 }
127
128 static inline void atomic_dec(volatile uint32_t* number)
129 {
130         asm volatile("lock decl %0" : "=m"(*number) : : "cc");
131 }
132
133 static inline void atomic_andb(volatile uint8_t* number, uint8_t mask)
134 {
135         asm volatile("lock andb %1,%0" : "=m"(*number) : "r"(mask) : "cc");
136 }
137 #endif /* !ROS_KERN_ATOMIC_H */