include/cmodelint.h

   1 /** @file cmodelint.h
   2  *  @brief C interface to the model checker.
   3  */
   4
   5 #ifndef CMODELINT_H
   6 #define CMODELINT_H
   7 #include <inttypes.h>
   8 #include "memoryorder.h"
   9
  10 #if __cplusplus
  11 using std::memory_order;
  12 extern "C" {
  13 #endif
  14
  15 uint64_t model_read_action(void * obj, memory_order ord);
  16 void model_write_action(void * obj, memory_order ord, uint64_t val);
  17 void model_init_action(void * obj, uint64_t val);
  18 uint64_t model_rmwr_action(void *obj, memory_order ord);
  19 void model_rmw_action(void *obj, memory_order ord, uint64_t val);
  20 void model_rmwc_action(void *obj, memory_order ord);
  21 void model_fence_action(memory_order ord);
  22
  23 // void model_init_action_helper(void * obj, uint64_t val);
  24 uint64_t model_rmwr_action_helper(void *obj, int atomic_index);
  25 void model_rmw_action_helper(void *obj, int atomic_index, uint64_t val);
  26 void model_rmwc_action_helper(void *obj, int atomic_index);
  27 void model_fence_action_helper(int atomic_index);
  28
  29 /* the following functions are used by llvm pass */
  30
  31 void cds_atomic_init8(void * obj, uint8_t val);
  32 void cds_atomic_init16(void * obj, uint16_t val);
  33 void cds_atomic_init32(void * obj, uint32_t val);
  34 void cds_atomic_init64(void * obj, uint64_t val);
  35
  36 uint8_t  cds_atomic_load8(void * obj, int atomic_index);
  37 uint16_t cds_atomic_load16(void * obj, int atomic_index);
  38 uint32_t cds_atomic_load32(void * obj, int atomic_index);
  39 uint64_t cds_atomic_load64(void * obj, int atomic_index);
  40
  41 void cds_atomic_store8(void * obj, uint8_t val, int atomic_index);
  42 void cds_atomic_store16(void * obj, uint16_t val, int atomic_index);
  43 void cds_atomic_store32(void * obj, uint32_t val, int atomic_index);
  44 void cds_atomic_store64(void * obj, uint64_t val, int atomic_index);
  45
  46
  47 // cds atomic exchange
  48 uint8_t cds_atomic_exchange8(void* addr, uint8_t val, int atomic_index);
  49 uint16_t cds_atomic_exchange16(void* addr, uint16_t val, int atomic_index);
  50 uint32_t cds_atomic_exchange32(void* addr, uint32_t val, int atomic_index);
  51 uint64_t cds_atomic_exchange64(void* addr, uint64_t val, int atomic_index);
  52 // cds atomic fetch add
  53 uint8_t  cds_atomic_fetch_add8(void* addr, uint8_t val, int atomic_index);
  54 uint16_t cds_atomic_fetch_add16(void* addr, uint16_t val, int atomic_index);
  55 uint32_t cds_atomic_fetch_add32(void* addr, uint32_t val, int atomic_index);
  56 uint64_t cds_atomic_fetch_add64(void* addr, uint64_t val, int atomic_index);
  57 // cds atomic fetch sub
  58 uint8_t  cds_atomic_fetch_sub8(void* addr, uint8_t val, int atomic_index);
  59 uint16_t cds_atomic_fetch_sub16(void* addr, uint16_t val, int atomic_index);
  60 uint32_t cds_atomic_fetch_sub32(void* addr, uint32_t val, int atomic_index);
  61 uint64_t cds_atomic_fetch_sub64(void* addr, uint64_t val, int atomic_index);
  62 // cds atomic fetch and
  63 uint8_t cds_atomic_fetch_and8(void* addr, uint8_t val, int atomic_index);
  64 uint16_t cds_atomic_fetch_and16(void* addr, uint16_t val, int atomic_index);
  65 uint32_t cds_atomic_fetch_and32(void* addr, uint32_t val, int atomic_index);
  66 uint64_t cds_atomic_fetch_and64(void* addr, uint64_t val, int atomic_index);
  67 // cds atomic fetch or
  68 uint8_t cds_atomic_fetch_or8(void* addr, uint8_t val, int atomic_index);
  69 uint16_t cds_atomic_fetch_or16(void* addr, uint16_t val, int atomic_index);
  70 uint32_t cds_atomic_fetch_or32(void* addr, uint32_t val, int atomic_index);
  71 uint64_t cds_atomic_fetch_or64(void* addr, uint64_t val, int atomic_index);
  72 // cds atomic fetch xor
  73 uint8_t cds_atomic_fetch_xor8(void* addr, uint8_t val, int atomic_index);
  74 uint16_t cds_atomic_fetch_xor16(void* addr, uint16_t val, int atomic_index);
  75 uint32_t cds_atomic_fetch_xor32(void* addr, uint32_t val, int atomic_index);
  76 uint64_t cds_atomic_fetch_xor64(void* addr, uint64_t val, int atomic_index);
  77
  78 // cds atomic compare and exchange (strong)
  79 uint8_t cds_atomic_compare_exchange8_v1(void* addr, uint8_t expected,
  80                   uint8_t desire, int atomic_index_succ, int atomic_index_fail );
  81 uint16_t cds_atomic_compare_exchange16_v1(void* addr, uint16_t expected,
  82                   uint16_t desire, int atomic_index_succ, int atomic_index_fail );
  83 uint32_t cds_atomic_compare_exchange32_v1(void* addr, uint32_t expected,
  84                   uint32_t desire, int atomic_index_succ, int atomic_index_fail );
  85 uint64_t cds_atomic_compare_exchange64_v1(void* addr, uint64_t expected,
  86                   uint64_t desire, int atomic_index_succ, int atomic_index_fail );
  87
  88 bool cds_atomic_compare_exchange8_v2(void* addr, uint8_t* expected,
  89                 uint8_t desired, int atomic_index_succ, int atomic_index_fail );
  90 bool cds_atomic_compare_exchange16_v2(void* addr, uint16_t* expected,
  91                 uint16_t desired, int atomic_index_succ, int atomic_index_fail );
  92 bool cds_atomic_compare_exchange32_v2(void* addr, uint32_t* expected,
  93                 uint32_t desired, int atomic_index_succ, int atomic_index_fail );
  94 bool cds_atomic_compare_exchange64_v2(void* addr, uint64_t* expected,
  95                 uint64_t desired, int atomic_index_succ, int atomic_index_fail );
  96
  97 // cds atomic thread fence
  98 void cds_atomic_thread_fence(int atomic_index);
  99
 100 #if __cplusplus
 101 }
 102 #endif
 103
 104 #endif