5126cc66a90b1a819fdc47edae094ce4866574ae
[c11tester.git] / cmodelint.cc
1 #include <stdio.h>
2 #include "model.h"
3 #include "execution.h"
4 #include "action.h"
5 #include "cmodelint.h"
6 #include "snapshot-interface.h"
7 #include "threads-model.h"
8
9 memory_order orders[6] = {
10         memory_order_relaxed, memory_order_consume, memory_order_acquire,
11         memory_order_release, memory_order_acq_rel, memory_order_seq_cst
12 };
13
14 static void ensureModel(ModelAction * action) {
15         if (!modelchecker_started) {
16                 if (!model) {
17                         snapshot_system_init(10000, 1024, 1024, 40000);
18                         model = new ModelChecker();
19                 }
20                 model->get_execution()->check_current_action(action);
21         } else {
22                 model->switch_to_master(action);
23         }
24 }
25
26 static uint64_t ensureModelValue(ModelAction * action) {
27         if (!modelchecker_started) {
28                 if (!model) {
29                         snapshot_system_init(10000, 1024, 1024, 40000);
30                         model = new ModelChecker();
31                 }
32                 model->get_execution()->check_current_action(action);
33                 return thread_current()->get_return_value();
34         } else {
35                 return model->switch_to_master(action);
36         }
37 }
38
39 /** Performs a read action.*/
40 uint64_t model_read_action(void * obj, memory_order ord) {
41         return model->switch_to_master(new ModelAction(ATOMIC_READ, ord, obj));
42 }
43
44 /** Performs a write action.*/
45 void model_write_action(void * obj, memory_order ord, uint64_t val) {
46         model->switch_to_master(new ModelAction(ATOMIC_WRITE, ord, obj, val));
47 }
48
49 /** Performs an init action. */
50 void model_init_action(void * obj, uint64_t val) {
51         model->switch_to_master(new ModelAction(ATOMIC_INIT, memory_order_relaxed, obj, val));
52 }
53
54 /**
55  * Performs the read part of a RMW action. The next action must either be the
56  * write part of the RMW action or an explicit close out of the RMW action w/o
57  * a write.
58  */
59 uint64_t model_rmwr_action(void *obj, memory_order ord) {
60         return model->switch_to_master(new ModelAction(ATOMIC_RMWR, ord, obj));
61 }
62
63 /**
64  * Performs the read part of a RMW CAS action. The next action must
65  * either be the write part of the RMW action or an explicit close out
66  * of the RMW action w/o a write.
67  */
68 uint64_t model_rmwrcas_action(void *obj, memory_order ord, uint64_t oldval, int size) {
69         return model->switch_to_master(new ModelAction(ATOMIC_RMWRCAS, ord, obj, oldval, size));
70 }
71
72
73 /** Performs the write part of a RMW action. */
74 void model_rmw_action(void *obj, memory_order ord, uint64_t val) {
75         model->switch_to_master(new ModelAction(ATOMIC_RMW, ord, obj, val));
76 }
77
78 /** Closes out a RMW action without doing a write. */
79 void model_rmwc_action(void *obj, memory_order ord) {
80         model->switch_to_master(new ModelAction(ATOMIC_RMWC, ord, obj));
81 }
82
83 /** Issues a fence operation. */
84 void model_fence_action(memory_order ord) {
85         model->switch_to_master(new ModelAction(ATOMIC_FENCE, ord, FENCE_LOCATION));
86 }
87
88 /* ---  helper functions --- */
89 uint64_t model_rmwrcas_action_helper(void *obj, int atomic_index, uint64_t oldval, int size, const char *position) {
90         return model->switch_to_master(
91                 new ModelAction(ATOMIC_RMWRCAS, position, orders[atomic_index], obj)
92                 );
93 }
94
95 uint64_t model_rmwr_action_helper(void *obj, int atomic_index, const char *position) {
96         return model->switch_to_master(
97                 new ModelAction(ATOMIC_RMWR, position, orders[atomic_index], obj)
98                 );
99 }
100
101 void model_rmw_action_helper(void *obj, uint64_t val, int atomic_index, const char * position) {
102         model->switch_to_master(
103                 new ModelAction(ATOMIC_RMW, position, orders[atomic_index], obj, val)
104                 );
105 }
106
107 void model_rmwc_action_helper(void *obj, int atomic_index, const char *position) {
108         model->switch_to_master(
109                 new ModelAction(ATOMIC_RMWC, position, orders[atomic_index], obj)
110                 );
111 }
112
113 // cds atomic inits
114 void cds_atomic_init8(void * obj, uint8_t val, const char * position) {
115         ensureModel(
116                 new ModelAction(ATOMIC_INIT, position, memory_order_relaxed, obj, (uint64_t) val)
117                 );
118 }
119 void cds_atomic_init16(void * obj, uint16_t val, const char * position) {
120         ensureModel(
121                 new ModelAction(ATOMIC_INIT, position, memory_order_relaxed, obj, (uint64_t) val)
122                 );
123 }
124 void cds_atomic_init32(void * obj, uint32_t val, const char * position) {
125         ensureModel(
126                 new ModelAction(ATOMIC_INIT, position, memory_order_relaxed, obj, (uint64_t) val)
127                 );
128 }
129 void cds_atomic_init64(void * obj, uint64_t val, const char * position) {
130         ensureModel(
131                 new ModelAction(ATOMIC_INIT, position, memory_order_relaxed, obj, val)
132                 );
133 }
134
135
136 // cds atomic loads
137 uint8_t cds_atomic_load8(void * obj, int atomic_index, const char * position) {
138         return (uint8_t) ensureModelValue(
139                 new ModelAction(ATOMIC_READ, position, orders[atomic_index], obj));
140 }
141 uint16_t cds_atomic_load16(void * obj, int atomic_index, const char * position) {
142         return (uint16_t) ensureModelValue(
143                 new ModelAction(ATOMIC_READ, position, orders[atomic_index], obj));
144 }
145 uint32_t cds_atomic_load32(void * obj, int atomic_index, const char * position) {
146         return (uint32_t) ensureModelValue(
147                 new ModelAction(ATOMIC_READ, position, orders[atomic_index], obj)
148                 );
149 }
150 uint64_t cds_atomic_load64(void * obj, int atomic_index, const char * position) {
151         return ensureModelValue(
152                 new ModelAction(ATOMIC_READ, position, orders[atomic_index], obj));
153 }
154
155 // cds atomic stores
156 void cds_atomic_store8(void * obj, uint8_t val, int atomic_index, const char * position) {
157         ensureModel(
158                 new ModelAction(ATOMIC_WRITE, position, orders[atomic_index], obj, (uint64_t) val)
159                 );
160 }
161 void cds_atomic_store16(void * obj, uint16_t val, int atomic_index, const char * position) {
162         ensureModel(
163                 new ModelAction(ATOMIC_WRITE, position, orders[atomic_index], obj, (uint64_t) val)
164                 );
165 }
166 void cds_atomic_store32(void * obj, uint32_t val, int atomic_index, const char * position) {
167         ensureModel(
168                 new ModelAction(ATOMIC_WRITE, position, orders[atomic_index], obj, (uint64_t) val)
169                 );
170 }
171 void cds_atomic_store64(void * obj, uint64_t val, int atomic_index, const char * position) {
172         ensureModel(
173                 new ModelAction(ATOMIC_WRITE, position, orders[atomic_index], obj, val)
174                 );
175 }
176
177 #define _ATOMIC_RMW_(__op__, size, addr, val, atomic_index, position)            \
178         ({                                                                      \
179                 uint ## size ## _t _old = model_rmwr_action_helper(addr, atomic_index, position);   \
180                 uint ## size ## _t _copy = _old;                                          \
181                 uint ## size ## _t _val = val;                                            \
182                 _copy __op__ _val;                                                    \
183                 model_rmw_action_helper(addr, (uint64_t) _copy, atomic_index, position);        \
184                 return _old;                                                          \
185         })
186
187 // cds atomic exchange
188 uint8_t cds_atomic_exchange8(void* addr, uint8_t val, int atomic_index, const char * position) {
189         _ATOMIC_RMW_( =, 8, addr, val, atomic_index, position);
190 }
191 uint16_t cds_atomic_exchange16(void* addr, uint16_t val, int atomic_index, const char * position) {
192         _ATOMIC_RMW_( =, 16, addr, val, atomic_index, position);
193 }
194 uint32_t cds_atomic_exchange32(void* addr, uint32_t val, int atomic_index, const char * position) {
195         _ATOMIC_RMW_( =, 32, addr, val, atomic_index, position);
196 }
197 uint64_t cds_atomic_exchange64(void* addr, uint64_t val, int atomic_index, const char * position) {
198         _ATOMIC_RMW_( =, 64, addr, val, atomic_index, position);
199 }
200
201 // cds atomic fetch add
202 uint8_t cds_atomic_fetch_add8(void* addr, uint8_t val, int atomic_index, const char * position) {
203         _ATOMIC_RMW_( +=, 8, addr, val, atomic_index, position);
204 }
205 uint16_t cds_atomic_fetch_add16(void* addr, uint16_t val, int atomic_index, const char * position) {
206         _ATOMIC_RMW_( +=, 16, addr, val, atomic_index, position);
207 }
208 uint32_t cds_atomic_fetch_add32(void* addr, uint32_t val, int atomic_index, const char * position) {
209         _ATOMIC_RMW_( +=, 32, addr, val, atomic_index, position);
210 }
211 uint64_t cds_atomic_fetch_add64(void* addr, uint64_t val, int atomic_index, const char * position) {
212         _ATOMIC_RMW_( +=, 64, addr, val, atomic_index, position);
213 }
214
215 // cds atomic fetch sub
216 uint8_t cds_atomic_fetch_sub8(void* addr, uint8_t val, int atomic_index, const char * position) {
217         _ATOMIC_RMW_( -=, 8, addr, val, atomic_index, position);
218 }
219 uint16_t cds_atomic_fetch_sub16(void* addr, uint16_t val, int atomic_index, const char * position) {
220         _ATOMIC_RMW_( -=, 16, addr, val, atomic_index, position);
221 }
222 uint32_t cds_atomic_fetch_sub32(void* addr, uint32_t val, int atomic_index, const char * position) {
223         _ATOMIC_RMW_( -=, 32, addr, val, atomic_index, position);
224 }
225 uint64_t cds_atomic_fetch_sub64(void* addr, uint64_t val, int atomic_index, const char * position) {
226         _ATOMIC_RMW_( -=, 64, addr, val, atomic_index, position);
227 }
228
229 // cds atomic fetch and
230 uint8_t cds_atomic_fetch_and8(void* addr, uint8_t val, int atomic_index, const char * position) {
231         _ATOMIC_RMW_( &=, 8, addr, val, atomic_index, position);
232 }
233 uint16_t cds_atomic_fetch_and16(void* addr, uint16_t val, int atomic_index, const char * position) {
234         _ATOMIC_RMW_( &=, 16, addr, val, atomic_index, position);
235 }
236 uint32_t cds_atomic_fetch_and32(void* addr, uint32_t val, int atomic_index, const char * position) {
237         _ATOMIC_RMW_( &=, 32, addr, val, atomic_index, position);
238 }
239 uint64_t cds_atomic_fetch_and64(void* addr, uint64_t val, int atomic_index, const char * position) {
240         _ATOMIC_RMW_( &=, 64, addr, val, atomic_index, position);
241 }
242
243 // cds atomic fetch or
244 uint8_t cds_atomic_fetch_or8(void* addr, uint8_t val, int atomic_index, const char * position) {
245         _ATOMIC_RMW_( |=, 8, addr, val, atomic_index, position);
246 }
247 uint16_t cds_atomic_fetch_or16(void* addr, uint16_t val, int atomic_index, const char * position) {
248         _ATOMIC_RMW_( |=, 16, addr, val, atomic_index, position);
249 }
250 uint32_t cds_atomic_fetch_or32(void* addr, uint32_t val, int atomic_index, const char * position) {
251         _ATOMIC_RMW_( |=, 32, addr, val, atomic_index, position);
252 }
253 uint64_t cds_atomic_fetch_or64(void* addr, uint64_t val, int atomic_index, const char * position) {
254         _ATOMIC_RMW_( |=, 64, addr, val, atomic_index, position);
255 }
256
257 // cds atomic fetch xor
258 uint8_t cds_atomic_fetch_xor8(void* addr, uint8_t val, int atomic_index, const char * position) {
259         _ATOMIC_RMW_( ^=, 8, addr, val, atomic_index, position);
260 }
261 uint16_t cds_atomic_fetch_xor16(void* addr, uint16_t val, int atomic_index, const char * position) {
262         _ATOMIC_RMW_( ^=, 16, addr, val, atomic_index, position);
263 }
264 uint32_t cds_atomic_fetch_xor32(void* addr, uint32_t val, int atomic_index, const char * position) {
265         _ATOMIC_RMW_( ^=, 32, addr, val, atomic_index, position);
266 }
267 uint64_t cds_atomic_fetch_xor64(void* addr, uint64_t val, int atomic_index, const char * position) {
268         _ATOMIC_RMW_( ^=, 64, addr, val, atomic_index, position);
269 }
270
271 // cds atomic compare and exchange
272 // In order to accomodate the LLVM PASS, the return values are not true or false.
273
274 #define _ATOMIC_CMPSWP_WEAK_ _ATOMIC_CMPSWP_
275 #define _ATOMIC_CMPSWP_(size, addr, expected, desired, atomic_index, position)                            \
276         ({                                                                                              \
277                 uint ## size ## _t _desired = desired;                                                            \
278                 uint ## size ## _t _expected = expected;                                                          \
279                 uint ## size ## _t _old = model_rmwrcas_action_helper(addr, atomic_index, _expected, sizeof(_expected), position); \
280                 if (_old == _expected) {                                                                    \
281                         model_rmw_action_helper(addr, (uint64_t) _desired, atomic_index, position); return _expected; }      \
282                 else {                                                                                        \
283                         model_rmwc_action_helper(addr, atomic_index, position); _expected = _old; return _old; }              \
284         })
285
286 // atomic_compare_exchange version 1: the CmpOperand (corresponds to expected)
287 // extracted from LLVM IR is an integer type.
288
289 uint8_t cds_atomic_compare_exchange8_v1(void* addr, uint8_t expected, uint8_t desired,
290                                                                                                                                                                 int atomic_index_succ, int atomic_index_fail, const char *position )
291 {
292         _ATOMIC_CMPSWP_(8, addr, expected, desired,
293                                                                         atomic_index_succ, position);
294 }
295 uint16_t cds_atomic_compare_exchange16_v1(void* addr, uint16_t expected, uint16_t desired,
296                                                                                                                                                                         int atomic_index_succ, int atomic_index_fail, const char *position)
297 {
298         _ATOMIC_CMPSWP_(16, addr, expected, desired,
299                                                                         atomic_index_succ, position);
300 }
301 uint32_t cds_atomic_compare_exchange32_v1(void* addr, uint32_t expected, uint32_t desired,
302                                                                                                                                                                         int atomic_index_succ, int atomic_index_fail, const char *position)
303 {
304         _ATOMIC_CMPSWP_(32, addr, expected, desired,
305                                                                         atomic_index_succ, position);
306 }
307 uint64_t cds_atomic_compare_exchange64_v1(void* addr, uint64_t expected, uint64_t desired,
308                                                                                                                                                                         int atomic_index_succ, int atomic_index_fail, const char *position)
309 {
310         _ATOMIC_CMPSWP_(64, addr, expected, desired,
311                                                                         atomic_index_succ, position);
312 }
313
314 // atomic_compare_exchange version 2
315 bool cds_atomic_compare_exchange8_v2(void* addr, uint8_t* expected, uint8_t desired,
316                                                                                                                                                  int atomic_index_succ, int atomic_index_fail, const char *position )
317 {
318         uint8_t ret = cds_atomic_compare_exchange8_v1(addr, *expected,
319                                                                                                                                                                                                 desired, atomic_index_succ, atomic_index_fail, position);
320         if (ret == *expected) return true;
321         else return false;
322 }
323 bool cds_atomic_compare_exchange16_v2(void* addr, uint16_t* expected, uint16_t desired,
324                                                                                                                                                         int atomic_index_succ, int atomic_index_fail, const char *position)
325 {
326         uint16_t ret = cds_atomic_compare_exchange16_v1(addr, *expected,
327                                                                                                                                                                                                         desired, atomic_index_succ, atomic_index_fail, position);
328         if (ret == *expected) return true;
329         else return false;
330 }
331 bool cds_atomic_compare_exchange32_v2(void* addr, uint32_t* expected, uint32_t desired,
332                                                                                                                                                         int atomic_index_succ, int atomic_index_fail, const char *position)
333 {
334         uint32_t ret = cds_atomic_compare_exchange32_v1(addr, *expected,
335                                                                                                                                                                                                         desired, atomic_index_succ, atomic_index_fail, position);
336         if (ret == *expected) return true;
337         else return false;
338 }
339 bool cds_atomic_compare_exchange64_v2(void* addr, uint64_t* expected, uint64_t desired,
340                                                                                                                                                         int atomic_index_succ, int atomic_index_fail, const char *position)
341 {
342         uint64_t ret = cds_atomic_compare_exchange64_v1(addr, *expected,
343                                                                                                                                                                                                         desired, atomic_index_succ, atomic_index_fail, position);
344         if (ret == *expected) return true;
345         else return false;
346 }
347
348
349 // cds atomic thread fence
350
351 void cds_atomic_thread_fence(int atomic_index, const char * position) {
352         model->switch_to_master(
353                 new ModelAction(ATOMIC_FENCE, position, orders[atomic_index], FENCE_LOCATION)
354                 );
355 }
356
357 /*
358  #define _ATOMIC_CMPSWP_( __a__, __e__, __m__, __x__ )                         \
359         ({ volatile __typeof__((__a__)->__f__)* __p__ = & ((__a__)->__f__);   \
360                 __typeof__(__e__) __q__ = (__e__);                            \
361                 __typeof__(__m__) __v__ = (__m__);                            \
362                 bool __r__;                                                   \
363                 __typeof__((__a__)->__f__) __t__=(__typeof__((__a__)->__f__)) model_rmwr_action((void *)__p__, __x__); \
364                 if (__t__ == * __q__ ) {                                      \
365                         model_rmw_action((void *)__p__, __x__, (uint64_t) __v__); __r__ = true; } \
366                 else {  model_rmwc_action((void *)__p__, __x__); *__q__ = __t__;  __r__ = false;} \
367                 __r__; })
368
369  #define _ATOMIC_FENCE_( __x__ ) \
370         ({ model_fence_action(__x__);})
371  */
372
373 /*
374
375  #define _ATOMIC_MODIFY_( __a__, __o__, __m__, __x__ )                         \
376         ({ volatile __typeof__((__a__)->__f__)* __p__ = & ((__a__)->__f__);   \
377         __typeof__((__a__)->__f__) __old__=(__typeof__((__a__)->__f__)) model_rmwr_action((void *)__p__, __x__); \
378         __typeof__(__m__) __v__ = (__m__);                                    \
379         __typeof__((__a__)->__f__) __copy__= __old__;                         \
380         __copy__ __o__ __v__;                                                 \
381         model_rmw_action((void *)__p__, __x__, (uint64_t) __copy__);          \
382         __old__ = __old__;  Silence clang (-Wunused-value)                    \
383          })
384  */