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