cmodelint.cc

   1 #include <stdio.h>
   2 #include <string>
   3
   4 #include "model.h"
   5 #include "execution.h"
   6 #include "action.h"
   7 #include "history.h"
   8 #include "cmodelint.h"
   9 #include "snapshot-interface.h"
  10 #include "threads-model.h"
  11 #include "datarace.h"
  12
  13 memory_order orders[6] = {
  14         memory_order_relaxed, memory_order_consume, memory_order_acquire,
  15         memory_order_release, memory_order_acq_rel, memory_order_seq_cst,
  16 };
  17
  18 static void ensureModel() {
  19         if (!model) {
  20                 snapshot_system_init(10000, 1024, 1024, 40000);
  21                 model = new ModelChecker();
  22                 model->startChecker();
  23         }
  24 }
  25
  26 /* ---  helper functions --- */
  27 uint64_t model_rmwrcas_action_helper(void *obj, int atomic_index, uint64_t oldval, int size, const char *position) {
  28         ensureModel();
  29         return model->switch_thread(new ModelAction(ATOMIC_RMWRCAS, position, orders[atomic_index], obj, oldval, size));
  30 }
  31
  32 uint64_t model_rmwr_action_helper(void *obj, int atomic_index, const char *position) {
  33         ensureModel();
  34         return model->switch_thread(new ModelAction(ATOMIC_RMWR, position, orders[atomic_index], obj));
  35 }
  36
  37 void model_rmw_action_helper(void *obj, uint64_t val, int atomic_index, const char * position) {
  38         ensureModel();
  39         model->switch_thread(new ModelAction(ATOMIC_RMW, position, orders[atomic_index], obj, val));
  40 }
  41
  42 void model_rmwc_action_helper(void *obj, int atomic_index, const char *position) {
  43         ensureModel();
  44         model->switch_thread(new ModelAction(ATOMIC_RMWC, position, orders[atomic_index], obj));
  45 }
  46
  47 // cds volatile loads
  48 #define VOLATILELOAD(size) \
  49         uint ## size ## _t cds_volatile_load ## size(void * obj, const char * position) { \
  50                 ensureModel();                                                      \
  51                 return (uint ## size ## _t)model->switch_thread(new ModelAction(ATOMIC_READ, position, memory_order_volatile_load, obj)); \
  52         }
  53
  54 VOLATILELOAD(8)
  55 VOLATILELOAD(16)
  56 VOLATILELOAD(32)
  57 VOLATILELOAD(64)
  58
  59 // cds volatile stores
  60 #define VOLATILESTORE(size) \
  61         void cds_volatile_store ## size (void * obj, uint ## size ## _t val, const char * position) { \
  62                 ensureModel();                                                      \
  63                 model->switch_thread(new ModelAction(ATOMIC_WRITE, position, memory_order_volatile_store, obj, (uint64_t) val)); \
  64                 *((volatile uint ## size ## _t *)obj) = val;            \
  65                 thread_id_t tid = thread_current()->get_id();           \
  66                 for(int i=0;i < size / 8;i++) {                         \
  67                         atomraceCheckWrite(tid, (void *)(((char *)obj)+i));          \
  68                 }                                                       \
  69         }
  70
  71 VOLATILESTORE(8)
  72 VOLATILESTORE(16)
  73 VOLATILESTORE(32)
  74 VOLATILESTORE(64)
  75
  76 // cds atomic inits
  77 #define CDSATOMICINT(size)                                              \
  78         void cds_atomic_init ## size (void * obj, uint ## size ## _t val, const char * position) { \
  79                 ensureModel();                                                      \
  80                 model->switch_thread(new ModelAction(ATOMIC_INIT, position, memory_order_relaxed, obj, (uint64_t) val)); \
  81                 *((volatile uint ## size ## _t *)obj) = val;                                 \
  82                 thread_id_t tid = thread_current()->get_id();           \
  83                 for(int i=0;i < size / 8;i++) {                       \
  84                         atomraceCheckWrite(tid, (void *)(((char *)obj)+i));          \
  85                 }                                                       \
  86         }
  87
  88 CDSATOMICINT(8)
  89 CDSATOMICINT(16)
  90 CDSATOMICINT(32)
  91 CDSATOMICINT(64)
  92
  93 // cds atomic loads
  94 #define CDSATOMICLOAD(size)                                             \
  95         uint ## size ## _t cds_atomic_load ## size(void * obj, int atomic_index, const char * position) { \
  96                 ensureModel();                                                      \
  97                 uint ## size ## _t val = (uint ## size ## _t)model->switch_thread( \
  98                         new ModelAction(ATOMIC_READ, position, orders[atomic_index], obj)); \
  99                 thread_id_t tid = thread_current()->get_id();           \
 100                 for(int i=0;i < size / 8;i++) {                         \
 101                         atomraceCheckRead(tid, (void *)(((char *)obj)+i));    \
 102                 }                                                       \
 103                 return val; \
 104         }
 105
 106 CDSATOMICLOAD(8)
 107 CDSATOMICLOAD(16)
 108 CDSATOMICLOAD(32)
 109 CDSATOMICLOAD(64)
 110
 111 // cds atomic stores
 112 #define CDSATOMICSTORE(size)                                            \
 113         void cds_atomic_store ## size(void * obj, uint ## size ## _t val, int atomic_index, const char * position) { \
 114                 ensureModel();                                                        \
 115                 model->switch_thread(new ModelAction(ATOMIC_WRITE, position, orders[atomic_index], obj, (uint64_t) val)); \
 116                 *((volatile uint ## size ## _t *)obj) = val;                     \
 117                 thread_id_t tid = thread_current()->get_id();           \
 118                 for(int i=0;i < size / 8;i++) {                       \
 119                         atomraceCheckWrite(tid, (void *)(((char *)obj)+i));          \
 120                 }                                                       \
 121         }
 122
 123 CDSATOMICSTORE(8)
 124 CDSATOMICSTORE(16)
 125 CDSATOMICSTORE(32)
 126 CDSATOMICSTORE(64)
 127
 128
 129 #define _ATOMIC_RMW_(__op__, size, addr, val, atomic_index, position)            \
 130         ({                                                                      \
 131                 uint ## size ## _t _old = model_rmwr_action_helper(addr, atomic_index, position);   \
 132                 uint ## size ## _t _copy = _old;                                          \
 133                 uint ## size ## _t _val = val;                                            \
 134                 _copy __op__ _val;                                                    \
 135                 model_rmw_action_helper(addr, (uint64_t) _copy, atomic_index, position);        \
 136                 *((volatile uint ## size ## _t *)addr) = _copy;                  \
 137                 thread_id_t tid = thread_current()->get_id();           \
 138                 for(int i=0;i < size / 8;i++) {                       \
 139                         atomraceCheckRead(tid,  (void *)(((char *)addr)+i));  \
 140                         recordWrite(tid, (void *)(((char *)addr)+i));         \
 141                 }                                                       \
 142                 return _old;                                            \
 143         })
 144
 145 // cds atomic exchange
 146 #define CDSATOMICEXCHANGE(size)                                         \
 147         uint ## size ## _t cds_atomic_exchange ## size(void* addr, uint ## size ## _t val, int atomic_index, const char * position) { \
 148                 _ATOMIC_RMW_( =, size, addr, val, atomic_index, position);          \
 149         }
 150
 151 CDSATOMICEXCHANGE(8)
 152 CDSATOMICEXCHANGE(16)
 153 CDSATOMICEXCHANGE(32)
 154 CDSATOMICEXCHANGE(64)
 155
 156 // cds atomic fetch add
 157 #define CDSATOMICADD(size)                                              \
 158         uint ## size ## _t cds_atomic_fetch_add ## size(void* addr, uint ## size ## _t val, int atomic_index, const char * position) { \
 159                 _ATOMIC_RMW_( +=, size, addr, val, atomic_index, position);         \
 160         }
 161
 162 CDSATOMICADD(8)
 163 CDSATOMICADD(16)
 164 CDSATOMICADD(32)
 165 CDSATOMICADD(64)
 166
 167 // cds atomic fetch sub
 168 #define CDSATOMICSUB(size)                                              \
 169         uint ## size ## _t cds_atomic_fetch_sub ## size(void* addr, uint ## size ## _t val, int atomic_index, const char * position) { \
 170                 _ATOMIC_RMW_( -=, size, addr, val, atomic_index, position);         \
 171         }
 172
 173 CDSATOMICSUB(8)
 174 CDSATOMICSUB(16)
 175 CDSATOMICSUB(32)
 176 CDSATOMICSUB(64)
 177
 178 // cds atomic fetch and
 179 #define CDSATOMICAND(size)                                              \
 180         uint ## size ## _t cds_atomic_fetch_and ## size(void* addr, uint ## size ## _t val, int atomic_index, const char * position) { \
 181                 _ATOMIC_RMW_( &=, size, addr, val, atomic_index, position);         \
 182         }
 183
 184 CDSATOMICAND(8)
 185 CDSATOMICAND(16)
 186 CDSATOMICAND(32)
 187 CDSATOMICAND(64)
 188
 189 // cds atomic fetch or
 190 #define CDSATOMICOR(size)                                               \
 191         uint ## size ## _t cds_atomic_fetch_or ## size(void* addr, uint ## size ## _t val, int atomic_index, const char * position) { \
 192                 _ATOMIC_RMW_( |=, size, addr, val, atomic_index, position);         \
 193         }
 194
 195 CDSATOMICOR(8)
 196 CDSATOMICOR(16)
 197 CDSATOMICOR(32)
 198 CDSATOMICOR(64)
 199
 200 // cds atomic fetch xor
 201 #define CDSATOMICXOR(size)                                              \
 202         uint ## size ## _t cds_atomic_fetch_xor ## size(void* addr, uint ## size ## _t val, int atomic_index, const char * position) { \
 203                 _ATOMIC_RMW_( ^=, size, addr, val, atomic_index, position);         \
 204         }
 205
 206 CDSATOMICXOR(8)
 207 CDSATOMICXOR(16)
 208 CDSATOMICXOR(32)
 209 CDSATOMICXOR(64)
 210
 211 // cds atomic compare and exchange
 212 // In order to accomodate the LLVM PASS, the return values are not true or false.
 213
 214 #define _ATOMIC_CMPSWP_WEAK_ _ATOMIC_CMPSWP_
 215 #define _ATOMIC_CMPSWP_(size, addr, expected, desired, atomic_index, position)                            \
 216         ({                                                                                              \
 217                 uint ## size ## _t _desired = desired;                                                            \
 218                 uint ## size ## _t _expected = expected;                                                          \
 219                 uint ## size ## _t _old = model_rmwrcas_action_helper(addr, atomic_index, _expected, sizeof(_expected), position); \
 220                 if (_old == _expected) {                                                                    \
 221                         model_rmw_action_helper(addr, (uint64_t) _desired, atomic_index, position); \
 222                         *((volatile uint ## size ## _t *)addr) = desired;                        \
 223                         thread_id_t tid = thread_current()->get_id();           \
 224                         for(int i=0;i < size / 8;i++) {                       \
 225                                 recordWrite(tid, (void *)(((char *)addr)+i));         \
 226                         }                                                       \
 227                         return _expected; }                                     \
 228                 else {                                                                                        \
 229                         model_rmwc_action_helper(addr, atomic_index, position); _expected = _old; return _old; }              \
 230         })
 231
 232 // atomic_compare_exchange version 1: the CmpOperand (corresponds to expected)
 233 // extracted from LLVM IR is an integer type.
 234 #define CDSATOMICCASV1(size)                                            \
 235         uint ## size ## _t cds_atomic_compare_exchange ## size ## _v1(void* addr, uint ## size ## _t expected, uint ## size ## _t desired, int atomic_index_succ, int atomic_index_fail, const char *position) { \
 236                 _ATOMIC_CMPSWP_(size, addr, expected, desired, atomic_index_succ, position); \
 237         }
 238
 239 CDSATOMICCASV1(8)
 240 CDSATOMICCASV1(16)
 241 CDSATOMICCASV1(32)
 242 CDSATOMICCASV1(64)
 243
 244 // atomic_compare_exchange version 2
 245 #define CDSATOMICCASV2(size)                                            \
 246         bool cds_atomic_compare_exchange ## size ## _v2(void* addr, uint ## size ## _t* expected, uint ## size ## _t desired, int atomic_index_succ, int atomic_index_fail, const char *position) { \
 247                 uint ## size ## _t ret = cds_atomic_compare_exchange ## size ## _v1(addr, *expected, desired, atomic_index_succ, atomic_index_fail, position); \
 248                 if (ret == *expected) {return true;} else {return false;}               \
 249         }
 250
 251 CDSATOMICCASV2(8)
 252 CDSATOMICCASV2(16)
 253 CDSATOMICCASV2(32)
 254 CDSATOMICCASV2(64)
 255
 256 // cds atomic thread fence
 257
 258 void cds_atomic_thread_fence(int atomic_index, const char * position) {
 259         model->switch_thread(
 260                 new ModelAction(ATOMIC_FENCE, position, orders[atomic_index], FENCE_LOCATION)
 261                 );
 262 }
 263
 264 /*
 265  #define _ATOMIC_CMPSWP_( __a__, __e__, __m__, __x__ )                         \
 266         ({ volatile __typeof__((__a__)->__f__)* __p__ = & ((__a__)->__f__);   \
 267                 __typeof__(__e__) __q__ = (__e__);                            \
 268                 __typeof__(__m__) __v__ = (__m__);                            \
 269                 bool __r__;                                                   \
 270                 __typeof__((__a__)->__f__) __t__=(__typeof__((__a__)->__f__)) model_rmwr_action((void *)__p__, __x__); \
 271                 if (__t__ == * __q__ ) {                                      \
 272                         model_rmw_action((void *)__p__, __x__, (uint64_t) __v__); __r__ = true; } \
 273                 else {  model_rmwc_action((void *)__p__, __x__); *__q__ = __t__;  __r__ = false;} \
 274                 __r__; })
 275
 276  #define _ATOMIC_FENCE_( __x__ ) \
 277         ({ model_fence_action(__x__);})
 278  */
 279
 280 /*
 281
 282  #define _ATOMIC_MODIFY_( __a__, __o__, __m__, __x__ )                         \
 283         ({ volatile __typeof__((__a__)->__f__)* __p__ = & ((__a__)->__f__);   \
 284         __typeof__((__a__)->__f__) __old__=(__typeof__((__a__)->__f__)) model_rmwr_action((void *)__p__, __x__); \
 285         __typeof__(__m__) __v__ = (__m__);                                    \
 286         __typeof__((__a__)->__f__) __copy__= __old__;                         \
 287         __copy__ __o__ __v__;                                                 \
 288         model_rmw_action((void *)__p__, __x__, (uint64_t) __copy__);          \
 289         __old__ = __old__;  Silence clang (-Wunused-value)                    \
 290          })
 291  */
 292
 293 void cds_func_entry(const char * funcName) {
 294 #ifdef NEWFUZZER
 295         ensureModel();
 296         Thread * th = thread_current();
 297         uint32_t func_id;
 298
 299         ModelHistory *history = model->get_history();
 300         if ( !history->getFuncMap()->contains(funcName) ) {
 301                 // add func id to func map
 302                 func_id = history->get_func_counter();
 303                 history->incr_func_counter();
 304                 history->getFuncMap()->put(funcName, func_id);
 305
 306                 // add func id to reverse func map
 307                 ModelVector<const char *> * func_map_rev = history->getFuncMapRev();
 308                 if ( func_map_rev->size() <= func_id )
 309                         func_map_rev->resize( func_id + 1 );
 310
 311                 func_map_rev->at(func_id) = funcName;
 312         } else {
 313                 func_id = history->getFuncMap()->get(funcName);
 314         }
 315
 316         history->enter_function(func_id, th->get_id());
 317 #endif
 318 }
 319
 320 void cds_func_exit(const char * funcName) {
 321 #ifdef NEWFUZZER
 322         ensureModel();
 323
 324         Thread * th = thread_current();
 325         uint32_t func_id;
 326
 327         ModelHistory *history = model->get_history();
 328         func_id = history->getFuncMap()->get(funcName);
 329 /*
 330  * func_id not found; this could happen in the case where a function calls cds_func_entry
 331  * when the model has been defined yet, but then an atomic inside the function initializes
 332  * the model. And then cds_func_exit is called upon the function exiting.
 333  *
 334  */
 335         if (func_id == 0)
 336                 return;
 337
 338         history->exit_function(func_id, th->get_id());
 339 #endif
 340 }