Atomic or for ints (flag variables)
[akaros.git] / kern / arch / i686 / atomic.h
1 #ifndef ROS_INCLUDE_ATOMIC_H
2 #define ROS_INCLUDE_ATOMIC_H
3
4 #include <ros/common.h>
5 #include <ros/arch/membar.h>
6 #include <arch/x86.h>
7 #include <arch/arch.h>
8
9 typedef void * RACY atomic_t;
10 struct spinlock {
11         volatile uint32_t RACY rlock;
12 #ifdef __CONFIG_SPINLOCK_DEBUG__
13         void *call_site;        
14         uint32_t calling_core;
15 #endif
16 };
17 typedef struct spinlock RACY spinlock_t;
18 #define SPINLOCK_INITIALIZER {0}
19
20 static inline void atomic_init(atomic_t *number, int32_t val);
21 static inline int32_t atomic_read(atomic_t *number);
22 static inline void atomic_set(atomic_t *number, int32_t val);
23 static inline void atomic_add(atomic_t* number, long val);
24 static inline void atomic_inc(atomic_t *number);
25 static inline void atomic_dec(atomic_t *number);
26 static inline long atomic_fetch_and_add(atomic_t *number, long val);
27 static inline bool atomic_add_not_zero(atomic_t *number, long val);
28 static inline bool atomic_sub_and_test(atomic_t *number, long val);
29 static inline uint32_t atomic_swap(uint32_t *addr, uint32_t val);
30 static inline bool atomic_comp_swap(uint32_t *addr, uint32_t exp_val,
31                                     uint32_t new_val);
32 static inline void atomic_andb(volatile uint8_t RACY* number, uint8_t mask);
33 static inline void atomic_orb(volatile uint8_t RACY* number, uint8_t mask);
34 static inline void atomic_or_int(volatile int *number, int mask);
35 static inline uint32_t spin_locked(spinlock_t *SAFE lock);
36 static inline void __spin_lock(volatile uint32_t SRACY*CT(1) rlock);
37 static inline void spin_lock(spinlock_t *lock);
38 static inline void spin_unlock(spinlock_t *lock);
39 static inline void spinlock_init(spinlock_t *lock);
40 void spinlock_debug(spinlock_t *lock);
41
42 /* Inlined functions declared above */
43 static inline void atomic_init(atomic_t *number, int32_t val)
44 {
45         asm volatile("movl %1,%0" : "=m"(*number) : "r"(val));
46 }
47
48 static inline int32_t atomic_read(atomic_t *number)
49 {
50         int32_t val;
51         asm volatile("movl %1,%0" : "=r"(val) : "m"(*number));
52         return val;
53 }
54
55 static inline void atomic_set(atomic_t *number, int32_t val)
56 {
57         asm volatile("movl %1,%0" : "=m"(*number) : "r"(val));
58 }
59
60 static inline void atomic_add(atomic_t* number, long val)
61 {
62         asm volatile("lock addl %1,%0" : "=m"(*number) : "r"(val));
63 }
64
65 // need to do this with pointers and deref.  %0 needs to be the memory address
66 static inline void atomic_inc(atomic_t *number)
67 {
68         asm volatile("lock incl %0" : "=m"(*number) : : "cc");
69 }
70
71 static inline void atomic_dec(atomic_t *number)
72 {
73         // for instance, this doesn't work:
74         //asm volatile("lock decl (%0)" : "=r"(number) : : "cc");
75         asm volatile("lock decl %0" : "=m"(*number) : : "cc");
76 }
77
78 /* Adds val to number, returning number's original value */
79 static inline long atomic_fetch_and_add(atomic_t *number, long val)
80 {
81         asm volatile("lock xadd %0,%1" : "=r"(val), "=m"(*number)
82                                        : "0"(val), "m"(*number)
83                                        : "cc" );
84         return val;
85 }
86
87 /* Adds val to number, so long as number was not zero.  Returns TRUE if the
88  * operation succeeded (added, not zero), returns FALSE if number is zero. */
89 static inline bool atomic_add_not_zero(atomic_t *number, long val)
90 {
91         long old_num, new_num;
92         do {
93                 old_num = atomic_read(number);
94                 if (!old_num)
95                         return FALSE;
96                 new_num = old_num + val;
97         } while (!atomic_comp_swap((uint32_t*)number, old_num, new_num));
98         return TRUE;
99 }
100
101 /* Subtraces val from number, returning True if the new value is 0. */
102 static inline bool atomic_sub_and_test(atomic_t *number, long val)
103 {
104         bool b;
105         asm volatile("lock sub %2,%1; setz %0" : "=r"(b), "=m"(*number)
106                                                : "r"(val), "m"(*number)
107                                                : "cc" );
108         return b;
109 }
110
111 static inline uint32_t atomic_swap(uint32_t *addr, uint32_t val)
112 {
113         // this would work, but its code is bigger, and it's not like the others
114         //asm volatile("xchgl %0,(%2)" : "=r"(val) : "0"(val), "r"(addr) : "memory");
115         asm volatile("xchgl %0,%1" : "=r"(val), "=m"(*addr) : "0"(val), "m"(*addr));
116         return val;
117 }
118
119 /* reusing exp_val for the bool return.  1 (TRUE) for success (like test). */
120 static inline bool atomic_comp_swap(uint32_t *addr, uint32_t exp_val,
121                                     uint32_t new_val)
122 {
123         asm volatile("lock cmpxchgl %4,%1; sete %%al"
124                      : "=a"(exp_val), "=m"(*addr)
125                      : "m"(*addr), "a"(exp_val), "r"(new_val)
126                      : "cc");
127         return exp_val;
128 }
129
130 /* Be sure to use "q" for byte operations (compared to longs), since this
131  * constrains the asm to use e{a,b,c,d}x instead of esi and edi.  32 bit x86
132  * cannot access the lower parts of esi or edi (will get warnings like "no such
133  * register %sil or %dil." */
134 static inline void atomic_andb(volatile uint8_t RACY*number, uint8_t mask)
135 {
136         asm volatile("lock andb %1,%0" : "=m"(*number) : "q"(mask) : "cc");
137 }
138
139 static inline void atomic_orb(volatile uint8_t RACY*number, uint8_t mask)
140 {
141         asm volatile("lock orb %1,%0" : "=m"(*number) : "q"(mask) : "cc");
142 }
143
144 static inline void atomic_or_int(volatile int *number, int mask)
145 {
146         asm volatile("lock orl %1,%0" : "=m"(*number) : "q"(mask) : "cc");
147 }
148
149 static inline uint32_t spin_locked(spinlock_t *SAFE lock)
150 {
151         // the lock status is the lowest byte of the lock
152         return lock->rlock & 0xff;
153 }
154
155 static inline void __spin_lock(volatile uint32_t *rlock)
156 {
157         asm volatile(
158                         "1:                       "
159                         "       cmpb $0, %0;          "
160                         "       je 2f;                "
161                         "       pause;                "
162                         "       jmp 1b;               "
163                         "2:                       " 
164                         "       movb $1, %%al;        "
165                         "       xchgb %%al, %0;       "
166                         "       cmpb $0, %%al;        "
167                         "       jne 1b;               "
168                 : : "m"(*rlock) : "eax", "cc");
169 }
170
171 static inline void spin_lock(spinlock_t *lock)
172 {
173         __spin_lock(&lock->rlock);
174 #ifdef __CONFIG_SPINLOCK_DEBUG__
175         lock->call_site = (void RACY*CT(1))TC(read_eip());
176         lock->calling_core = core_id();
177 #endif
178 }
179
180 static inline void spin_unlock(spinlock_t *lock)
181 {
182         /* Need to prevent the compiler (and some arches) from reordering older
183          * stores */
184         wmb();
185         lock->rlock = 0;
186 }
187
188 static inline void spinlock_init(spinlock_t *lock)
189 #ifdef __CONFIG_SPINLOCK_DEBUG__
190 WRITES(lock->rlock,lock->call_site,lock->calling_core)
191 #else
192 WRITES(lock->rlock)
193 #endif
194 {
195         lock->rlock = 0;
196 #ifdef __CONFIG_SPINLOCK_DEBUG__
197         lock->call_site = 0;
198         lock->calling_core = 0;
199 #endif
200 }
201
202 #endif /* !ROS_INCLUDE_ATOMIC_H */