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