x86: interrupt return path checks kmsgs
[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 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 uint32_t atomic_swap(uint32_t *addr, uint32_t val)
111 {
112         // this would work, but its code is bigger, and it's not like the others
113         //asm volatile("xchgl %0,(%2)" : "=r"(val) : "0"(val), "r"(addr) : "memory");
114         asm volatile("xchgl %0,%1" : "=r"(val), "=m"(*addr) : "0"(val), "m"(*addr));
115         return val;
116 }
117
118 /* reusing exp_val for the bool return.  1 (TRUE) for success (like test). */
119 static inline bool atomic_comp_swap(uint32_t *addr, uint32_t exp_val,
120                                     uint32_t new_val)
121 {
122         asm volatile("lock cmpxchgl %4,%1; sete %%al"
123                      : "=a"(exp_val), "=m"(*addr)
124                      : "m"(*addr), "a"(exp_val), "r"(new_val)
125                      : "cc");
126         return exp_val;
127 }
128
129 /* Be sure to use "q" for byte operations (compared to longs), since this
130  * constrains the asm to use e{a,b,c,d}x instead of esi and edi.  32 bit x86
131  * cannot access the lower parts of esi or edi (will get warnings like "no such
132  * register %sil or %dil." */
133 static inline void atomic_andb(volatile uint8_t RACY*number, uint8_t mask)
134 {
135         asm volatile("lock andb %1,%0" : "=m"(*number) : "q"(mask) : "cc");
136 }
137
138 static inline void atomic_orb(volatile uint8_t RACY*number, uint8_t mask)
139 {
140         asm volatile("lock orb %1,%0" : "=m"(*number) : "q"(mask) : "cc");
141 }
142
143 static inline uint32_t spin_locked(spinlock_t *SAFE lock)
144 {
145         // the lock status is the lowest byte of the lock
146         return lock->rlock & 0xff;
147 }
148
149 static inline void __spin_lock(volatile uint32_t *rlock)
150 {
151         asm volatile(
152                         "1:                       "
153                         "       cmpb $0, %0;          "
154                         "       je 2f;                "
155                         "       pause;                "
156                         "       jmp 1b;               "
157                         "2:                       " 
158                         "       movb $1, %%al;        "
159                         "       xchgb %%al, %0;       "
160                         "       cmpb $0, %%al;        "
161                         "       jne 1b;               "
162                 : : "m"(*rlock) : "eax", "cc");
163 }
164
165 static inline void spin_lock(spinlock_t *lock)
166 {
167         __spin_lock(&lock->rlock);
168 #ifdef __CONFIG_SPINLOCK_DEBUG__
169         lock->call_site = (void RACY*CT(1))TC(read_eip());
170         lock->calling_core = core_id();
171 #endif
172 }
173
174 static inline void spin_unlock(spinlock_t *lock)
175 {
176         /* Need to prevent the compiler (and some arches) from reordering older
177          * stores */
178         wmb();
179         lock->rlock = 0;
180 }
181
182 static inline void spinlock_init(spinlock_t *lock)
183 #ifdef __CONFIG_SPINLOCK_DEBUG__
184 WRITES(lock->rlock,lock->call_site,lock->calling_core)
185 #else
186 WRITES(lock->rlock)
187 #endif
188 {
189         lock->rlock = 0;
190 #ifdef __CONFIG_SPINLOCK_DEBUG__
191         lock->call_site = 0;
192         lock->calling_core = 0;
193 #endif
194 }
195
196 #endif /* !ROS_INCLUDE_ATOMIC_H */