Fix RMW bug
[c11tester.git] / action.cc
index 44a6d9ad6948c116e3305bd955e204825f01bc96..8c29c533ac6e66fb9e924590f64d49c4ad4635c5 100644 (file)
--- a/action.cc
+++ b/action.cc
@@ -1,7 +1,7 @@
 #include <stdio.h>
 #define __STDC_FORMAT_MACROS
 #include <inttypes.h>
-#include <vector>
+#include <stdlib.h>
 
 #include "model.h"
 #include "action.h"
@@ -9,9 +9,16 @@
 #include "common.h"
 #include "threads-model.h"
 #include "nodestack.h"
+#include "wildcard.h"
 
 #define ACTION_INITIAL_CLOCK 0
 
+/** @brief A special value to represent a successful trylock */
+#define VALUE_TRYSUCCESS 1
+
+/** @brief A special value to represent a failed trylock */
+#define VALUE_TRYFAILED 0
+
 /**
  * @brief Construct a new ModelAction
  *
@@ -28,21 +35,55 @@ ModelAction::ModelAction(action_type_t type, memory_order order, void *loc,
                uint64_t value, Thread *thread) :
        type(type),
        order(order),
+       original_order(order),
        location(loc),
        value(value),
        reads_from(NULL),
+       last_fence_release(NULL),
        node(NULL),
        seq_number(ACTION_INITIAL_CLOCK),
-       cv(NULL),
-       sleep_flag(false)
+       cv(NULL)
 {
        /* References to NULL atomic variables can end up here */
-       ASSERT(loc || type == MODEL_FIXUP_RELSEQ);
+       ASSERT(loc || type == ATOMIC_FENCE);
 
        Thread *t = thread ? thread : thread_current();
        this->tid = t->get_id();
 }
 
+
+/**
+ * @brief Construct a new ModelAction
+ *
+ * @param type The type of action
+ * @param order The memory order of this action. A "don't care" for non-ATOMIC
+ * actions (e.g., THREAD_* or MODEL_* actions).
+ * @param loc The location that this action acts upon
+ * @param value (optional) A value associated with the action (e.g., the value
+ * read or written). Defaults to a given macro constant, for debugging purposes.
+ * @param size (optional) The Thread in which this action occurred. If NULL
+ * (default), then a Thread is assigned according to the scheduler.
+ */
+ModelAction::ModelAction(action_type_t type, memory_order order, void *loc,
+               uint64_t value, int size) :
+       type(type),
+       order(order),
+       original_order(order),
+       location(loc),
+       value(value),
+       reads_from(NULL),
+       last_fence_release(NULL),
+       node(NULL),
+       seq_number(ACTION_INITIAL_CLOCK),
+       cv(NULL)
+{
+       /* References to NULL atomic variables can end up here */
+       ASSERT(loc);
+       this->size = size;
+       Thread *t = thread_current();
+       this->tid = t->get_id();
+}
+
 /** @brief ModelAction destructor */
 ModelAction::~ModelAction()
 {
@@ -58,6 +99,10 @@ ModelAction::~ModelAction()
                delete cv; */
 }
 
+int ModelAction::getSize() const {
+  return size;
+}
+
 void ModelAction::copy_from_new(ModelAction *newaction)
 {
        seq_number = newaction->seq_number;
@@ -65,18 +110,25 @@ void ModelAction::copy_from_new(ModelAction *newaction)
 
 void ModelAction::set_seq_number(modelclock_t num)
 {
+       /* ATOMIC_UNINIT actions should never have non-zero clock */
+       ASSERT(!is_uninitialized());
        ASSERT(seq_number == ACTION_INITIAL_CLOCK);
        seq_number = num;
 }
 
-bool ModelAction::is_relseq_fixup() const
+bool ModelAction::is_thread_start() const
 {
-       return type == MODEL_FIXUP_RELSEQ;
+       return type == THREAD_START;
+}
+
+bool ModelAction::is_thread_join() const
+{
+       return type == THREAD_JOIN || type == PTHREAD_JOIN;
 }
 
 bool ModelAction::is_mutex_op() const
 {
-       return type == ATOMIC_LOCK || type == ATOMIC_TRYLOCK || type == ATOMIC_UNLOCK;
+       return type == ATOMIC_LOCK || type == ATOMIC_TRYLOCK || type == ATOMIC_UNLOCK || type == ATOMIC_WAIT || type == ATOMIC_NOTIFY_ONE || type == ATOMIC_NOTIFY_ALL;
 }
 
 bool ModelAction::is_lock() const
@@ -84,6 +136,18 @@ bool ModelAction::is_lock() const
        return type == ATOMIC_LOCK;
 }
 
+bool ModelAction::is_wait() const {
+       return type == ATOMIC_WAIT;
+}
+
+bool ModelAction::is_notify() const {
+       return type == ATOMIC_NOTIFY_ONE || type == ATOMIC_NOTIFY_ALL;
+}
+
+bool ModelAction::is_notify_one() const {
+       return type == ATOMIC_NOTIFY_ONE;
+}
+
 bool ModelAction::is_unlock() const
 {
        return type == ATOMIC_UNLOCK;
@@ -104,14 +168,25 @@ bool ModelAction::is_failed_trylock() const
        return (type == ATOMIC_TRYLOCK && value == VALUE_TRYFAILED);
 }
 
+/** @return True if this operation is performed on a C/C++ atomic variable */
+bool ModelAction::is_atomic_var() const
+{
+       return is_read() || could_be_write();
+}
+
+bool ModelAction::is_uninitialized() const
+{
+       return type == ATOMIC_UNINIT;
+}
+
 bool ModelAction::is_read() const
 {
-       return type == ATOMIC_READ || type == ATOMIC_RMWR || type == ATOMIC_RMW;
+       return type == ATOMIC_READ || type == ATOMIC_RMWR || type == ATOMIC_RMWRCAS || type == ATOMIC_RMW;
 }
 
 bool ModelAction::is_write() const
 {
-       return type == ATOMIC_WRITE || type == ATOMIC_RMW || type == ATOMIC_INIT;
+       return type == ATOMIC_WRITE || type == ATOMIC_RMW || type == ATOMIC_INIT || type == ATOMIC_UNINIT;
 }
 
 bool ModelAction::could_be_write() const
@@ -119,9 +194,19 @@ bool ModelAction::could_be_write() const
        return is_write() || is_rmwr();
 }
 
+bool ModelAction::is_yield() const
+{
+       return type == THREAD_YIELD;
+}
+
 bool ModelAction::is_rmwr() const
 {
-       return type == ATOMIC_RMWR;
+       return type == ATOMIC_RMWR || type == ATOMIC_RMWRCAS;
+}
+
+bool ModelAction::is_rmwrcas() const
+{
+       return type == ATOMIC_RMWRCAS;
 }
 
 bool ModelAction::is_rmw() const
@@ -134,7 +219,7 @@ bool ModelAction::is_rmwc() const
        return type == ATOMIC_RMWC;
 }
 
-bool ModelAction::is_fence() const 
+bool ModelAction::is_fence() const
 {
        return type == ATOMIC_FENCE;
 }
@@ -144,6 +229,16 @@ bool ModelAction::is_initialization() const
        return type == ATOMIC_INIT;
 }
 
+bool ModelAction::is_annotation() const
+{
+       return type == ATOMIC_ANNOTATION;
+}
+
+bool ModelAction::is_relaxed() const
+{
+       return order == std::memory_order_relaxed;
+}
+
 bool ModelAction::is_acquire() const
 {
        switch (order) {
@@ -170,11 +265,24 @@ bool ModelAction::is_release() const
 
 bool ModelAction::is_seqcst() const
 {
-       return order==std::memory_order_seq_cst;
+       return order == std::memory_order_seq_cst;
 }
 
 bool ModelAction::same_var(const ModelAction *act) const
 {
+       if (act->is_wait() || is_wait()) {
+               if (act->is_wait() && is_wait()) {
+                       if (((void *)value) == ((void *)act->value))
+                               return true;
+               } else if (is_wait()) {
+                       if (((void *)value) == act->location)
+                               return true;
+               } else if (act->is_wait()) {
+                       if (location == ((void *)act->value))
+                               return true;
+               }
+       }
+
        return location == act->location;
 }
 
@@ -183,53 +291,116 @@ bool ModelAction::same_thread(const ModelAction *act) const
        return tid == act->tid;
 }
 
-void ModelAction::copy_typeandorder(ModelAction * act) {
+void ModelAction::copy_typeandorder(ModelAction * act)
+{
        this->type = act->type;
        this->order = act->order;
 }
 
-/** This method changes an existing read part of an RMW action into either:
- *  (1) a full RMW action in case of the completed write or
- *  (2) a READ action in case a failed action.
+/**
+ * Get the Thread which is the operand of this action. This is only valid for
+ * THREAD_* operations (currently only for THREAD_CREATE and THREAD_JOIN). Note
+ * that this provides a central place for determining the conventions of Thread
+ * storage in ModelAction, where we generally aren't very type-safe (e.g., we
+ * store object references in a (void *) address.
+ *
+ * For THREAD_CREATE, this yields the Thread which is created.
+ * For THREAD_JOIN, this yields the Thread we are joining with.
+ *
+ * @return The Thread which this action acts on, if exists; otherwise NULL
+ */
+Thread * ModelAction::get_thread_operand() const
+{
+       if (type == THREAD_CREATE) {
+               /* thread_operand is set in execution.cc */
+               return thread_operand;
+       } else if (type == PTHREAD_CREATE) {
+               return thread_operand;
+       } else if (type == THREAD_JOIN) {
+               /* THREAD_JOIN uses (Thread *) for location */
+               return (Thread *)get_location();
+       } else if (type == PTHREAD_JOIN) {
+               // return NULL;
+               // thread_operand is stored in execution::pthread_map;
+               return (Thread *)get_location();
+       } else
+               return NULL;
+}
+
+/**
+ * @brief Convert the read portion of an RMW
+ *
+ * Changes an existing read part of an RMW action into either:
+ *  -# a full RMW action in case of the completed write or
+ *  -# a READ action in case a failed action.
+ *
  * @todo  If the memory_order changes, we may potentially need to update our
  * clock vector.
+ *
+ * @param act The second half of the RMW (either RMWC or RMW)
  */
-void ModelAction::process_rmw(ModelAction * act) {
-       this->order=act->order;
+void ModelAction::process_rmw(ModelAction *act)
+{
+       this->order = act->order;
        if (act->is_rmwc())
-               this->type=ATOMIC_READ;
+               this->type = ATOMIC_READ;
        else if (act->is_rmw()) {
-               this->type=ATOMIC_RMW;
-               this->value=act->value;
+               this->type = ATOMIC_RMW;
+               this->value = act->value;
        }
 }
 
-/** The is_synchronizing method should only explore interleavings if:
- *  (1) the operations are seq_cst and don't commute or
- *  (2) the reordering may establish or break a synchronization relation.
- *  Other memory operations will be dealt with by using the reads_from
- *  relation.
+/**
+ * @brief Check if this action should be backtracked with another, due to
+ * potential synchronization
+ *
+ * The is_synchronizing method should only explore interleavings if:
+ *  -# the operations are seq_cst and don't commute or
+ *  -# the reordering may establish or break a synchronization relation.
  *
- *  @param act is the action to consider exploring a reordering.
- *  @return tells whether we have to explore a reordering.
+ * Other memory operations will be dealt with by using the reads_from relation.
+ *
+ * @param act The action to consider exploring a reordering
+ * @return True, if we have to explore a reordering; otherwise false
  */
 bool ModelAction::could_synchronize_with(const ModelAction *act) const
 {
-       //Same thread can't be reordered
+       // Same thread can't be reordered
        if (same_thread(act))
                return false;
 
        // Different locations commute
-       if (!same_var(act))
+       if (!same_var(act) && !is_fence() && !act->is_fence())
                return false;
 
-       // Explore interleavings of seqcst writes to guarantee total order
-       // of seq_cst operations that don't commute
-       if ((could_be_write() || act->could_be_write()) && is_seqcst() && act->is_seqcst())
+       // Explore interleavings of seqcst writes/fences to guarantee total
+       // order of seq_cst operations that don't commute
+       if ((could_be_write() || act->could_be_write() || is_fence() || act->is_fence()) && is_seqcst() && act->is_seqcst())
                return true;
 
        // Explore synchronizing read/write pairs
-       if (is_read() && is_acquire() && act->could_be_write() && act->is_release())
+       if (is_acquire() && act->is_release() && is_read() && act->could_be_write())
+               return true;
+
+       // lock just released...we can grab lock
+       if ((is_lock() || is_trylock()) && (act->is_unlock() || act->is_wait()))
+               return true;
+
+       // lock just acquired...we can fail to grab lock
+       if (is_trylock() && act->is_success_lock())
+               return true;
+
+       // other thread stalling on lock...we can release lock
+       if (is_unlock() && (act->is_trylock() || act->is_lock()))
+               return true;
+
+       if (is_trylock() && (act->is_unlock() || act->is_wait()))
+               return true;
+
+       if (is_notify() && act->is_wait())
+               return true;
+
+       if (is_wait() && act->is_notify())
                return true;
 
        // Otherwise handle by reads_from relation
@@ -238,18 +409,22 @@ bool ModelAction::could_synchronize_with(const ModelAction *act) const
 
 bool ModelAction::is_conflicting_lock(const ModelAction *act) const
 {
-       //Must be different threads to reorder
+       // Must be different threads to reorder
        if (same_thread(act))
                return false;
-       
-       //Try to reorder a lock past a successful lock
+
+       // Try to reorder a lock past a successful lock
        if (act->is_success_lock())
                return true;
-       
-       //Try to push a successful trylock past an unlock
+
+       // Try to push a successful trylock past an unlock
        if (act->is_unlock() && is_trylock() && value == VALUE_TRYSUCCESS)
                return true;
 
+       // Try to push a successful trylock past a wait
+       if (act->is_wait() && is_trylock() && value == VALUE_TRYSUCCESS)
+               return true;
+
        return false;
 }
 
@@ -269,34 +444,98 @@ void ModelAction::create_cv(const ModelAction *parent)
                cv = new ClockVector(NULL, this);
 }
 
-void ModelAction::set_try_lock(bool obtainedlock) {
-       if (obtainedlock)
-               value=VALUE_TRYSUCCESS;
+void ModelAction::set_try_lock(bool obtainedlock)
+{
+       value = obtainedlock ? VALUE_TRYSUCCESS : VALUE_TRYFAILED;
+}
+
+/**
+ * @brief Get the value read by this load
+ *
+ * We differentiate this function from ModelAction::get_write_value and
+ * ModelAction::get_value for the purpose of RMW's, which may have both a
+ * 'read' and a 'write' value.
+ *
+ * Note: 'this' must be a load.
+ *
+ * @return The value read by this load
+ */
+uint64_t ModelAction::get_reads_from_value() const
+{
+       ASSERT(is_read());
+       if (reads_from)
+               return reads_from->get_write_value();
+       return VALUE_NONE; /* Only for new actions with no reads-from */
+}
+
+/**
+ * @brief Get the value written by this store
+ *
+ * We differentiate this function from ModelAction::get_reads_from_value and
+ * ModelAction::get_value for the purpose of RMW's, which may have both a
+ * 'read' and a 'write' value.
+ *
+ * Note: 'this' must be a store.
+ *
+ * @return The value written by this store
+ */
+uint64_t ModelAction::get_write_value() const
+{
+       ASSERT(is_write());
+       return value;
+}
+
+/**
+ * @brief Get the value returned by this action
+ *
+ * For atomic reads (including RMW), an operation returns the value it read.
+ * For atomic writes, an operation returns the value it wrote. For other
+ * operations, the return value varies (sometimes is a "don't care"), but the
+ * value is simply stored in the "value" field.
+ *
+ * @return This action's return value
+ */
+uint64_t ModelAction::get_return_value() const
+{
+       if (is_read())
+               return get_reads_from_value();
+       else if (is_write())
+               return get_write_value();
        else
-               value=VALUE_TRYFAILED;
+               return value;
+}
+
+/** @return The Node associated with this ModelAction */
+Node * ModelAction::get_node() const
+{
+       /* UNINIT actions do not have a Node */
+       ASSERT(!is_uninitialized());
+       return node;
 }
 
 /**
  * Update the model action's read_from action
  * @param act The action to read from; should be a write
- * @return True if this read established synchronization
  */
-bool ModelAction::read_from(const ModelAction *act)
+void ModelAction::set_read_from(const ModelAction *act)
 {
-       ASSERT(cv);
+       ASSERT(act);
+
        reads_from = act;
-       if (act != NULL && this->is_acquire()) {
-               rel_heads_list_t release_heads;
-               model->get_release_seq_heads(this, &release_heads);
-               int num_heads = release_heads.size();
-               for (unsigned int i = 0; i < release_heads.size(); i++)
-                       if (!synchronize_with(release_heads[i])) {
-                               model->set_bad_synchronization();
-                               num_heads--;
-                       }
-               return num_heads > 0;
+
+       if (act->is_uninitialized()) { // WL
+               uint64_t val = *((uint64_t *) location);
+               ModelAction * act_initialized = (ModelAction *)act;
+               act_initialized->set_value(val);
+               reads_from = (const ModelAction *)act_initialized;
+
+// disabled by WL, because LLVM IR is unable to detect atomic init
+/*             model->assert_bug("May read from uninitialized atomic:\n"
+                               "    action %d, thread %d, location %p (%s, %s)",
+                               seq_number, id_to_int(tid), location,
+                               get_type_str(), get_mo_str());
+*/
        }
-       return false;
 }
 
 /**
@@ -305,17 +544,17 @@ bool ModelAction::read_from(const ModelAction *act)
  * @param act The ModelAction to synchronize with
  * @return True if this is a valid synchronization; false otherwise
  */
-bool ModelAction::synchronize_with(const ModelAction *act) {
-       if (*this < *act && type != THREAD_JOIN && type != ATOMIC_LOCK)
+bool ModelAction::synchronize_with(const ModelAction *act)
+{
+       if (*this < *act)
                return false;
-       model->check_promises(act->get_tid(), cv, act->cv);
        cv->merge(act->cv);
        return true;
 }
 
 bool ModelAction::has_synchronized_with(const ModelAction *act) const
 {
-       return cv->has_synchronized_with(act->cv);
+       return cv->synchronized_since(act);
 }
 
 /**
@@ -329,115 +568,99 @@ bool ModelAction::happens_before(const ModelAction *act) const
        return act->cv->synchronized_since(this);
 }
 
-/** @brief Print nicely-formatted info about this ModelAction */
-void ModelAction::print() const
+const char * ModelAction::get_type_str() const
 {
-       const char *type_str, *mo_str;
        switch (this->type) {
-       case MODEL_FIXUP_RELSEQ:
-               type_str = "relseq fixup";
-               break;
-       case THREAD_CREATE:
-               type_str = "thread create";
-               break;
-       case THREAD_START:
-               type_str = "thread start";
-               break;
-       case THREAD_YIELD:
-               type_str = "thread yield";
-               break;
-       case THREAD_JOIN:
-               type_str = "thread join";
-               break;
-       case THREAD_FINISH:
-               type_str = "thread finish";
-               break;
-       case ATOMIC_READ:
-               type_str = "atomic read";
-               break;
-       case ATOMIC_WRITE:
-               type_str = "atomic write";
-               break;
-       case ATOMIC_RMW:
-               type_str = "atomic rmw";
-               break;
-       case ATOMIC_FENCE:
-               type_str = "fence";
-               break;
-       case ATOMIC_RMWR:
-               type_str = "atomic rmwr";
-               break;
-       case ATOMIC_RMWC:
-               type_str = "atomic rmwc";
-               break;
-       case ATOMIC_INIT:
-               type_str = "init atomic";
-               break;
-       case ATOMIC_LOCK:
-               type_str = "lock";
-               break;
-       case ATOMIC_UNLOCK:
-               type_str = "unlock";
-               break;
-       case ATOMIC_TRYLOCK:
-               type_str = "trylock";
-               break;
-       default:
-               type_str = "unknown type";
-       }
-
-       uint64_t valuetoprint=type==ATOMIC_READ?(reads_from!=NULL?reads_from->value:VALUE_NONE):value;
-
+               case THREAD_CREATE: return "thread create";
+               case THREAD_START: return "thread start";
+               case THREAD_YIELD: return "thread yield";
+               case THREAD_JOIN: return "thread join";
+               case THREAD_FINISH: return "thread finish";
+
+               case PTHREAD_CREATE: return "pthread create";
+               case PTHREAD_JOIN: return "pthread join";
+
+               case ATOMIC_UNINIT: return "uninitialized";
+               case ATOMIC_READ: return "atomic read";
+               case ATOMIC_WRITE: return "atomic write";
+               case ATOMIC_RMW: return "atomic rmw";
+               case ATOMIC_FENCE: return "fence";
+               case ATOMIC_RMWR: return "atomic rmwr";
+               case ATOMIC_RMWRCAS: return "atomic rmwrcas";
+               case ATOMIC_RMWC: return "atomic rmwc";
+               case ATOMIC_INIT: return "init atomic";
+               case ATOMIC_LOCK: return "lock";
+               case ATOMIC_UNLOCK: return "unlock";
+               case ATOMIC_TRYLOCK: return "trylock";
+               case ATOMIC_WAIT: return "wait";
+               case ATOMIC_NOTIFY_ONE: return "notify one";
+               case ATOMIC_NOTIFY_ALL: return "notify all";
+               case ATOMIC_ANNOTATION: return "annotation";
+               default: return "unknown type";
+       };
+}
+
+const char * ModelAction::get_mo_str() const
+{
        switch (this->order) {
-       case std::memory_order_relaxed:
-               mo_str = "relaxed";
-               break;
-       case std::memory_order_acquire:
-               mo_str = "acquire";
-               break;
-       case std::memory_order_release:
-               mo_str = "release";
-               break;
-       case std::memory_order_acq_rel:
-               mo_str = "acq_rel";
-               break;
-       case std::memory_order_seq_cst:
-               mo_str = "seq_cst";
-               break;
-       default:
-               mo_str = "unknown";
-               break;
+               case std::memory_order_relaxed: return "relaxed";
+               case std::memory_order_acquire: return "acquire";
+               case std::memory_order_release: return "release";
+               case std::memory_order_acq_rel: return "acq_rel";
+               case std::memory_order_seq_cst: return "seq_cst";
+               default: return "unknown";
        }
+}
+
+/** @brief Print nicely-formatted info about this ModelAction */
+void ModelAction::print() const
+{
+       const char *type_str = get_type_str(), *mo_str = get_mo_str();
 
-       printf("(%4d) Thread: %-2d   Action: %-13s   MO: %7s  Loc: %14p   Value: %-#18" PRIx64,
-                       seq_number, id_to_int(tid), type_str, mo_str, location, valuetoprint);
+       model_print("%-4d %-2d   %-14s  %7s  %14p   %-#18" PRIx64,
+                       seq_number, id_to_int(tid), type_str, mo_str, location, get_return_value());
        if (is_read()) {
                if (reads_from)
-                       printf("  Rf: %-3d", reads_from->get_seq_number());
+                       model_print("  %-3d", reads_from->get_seq_number());
                else
-                       printf("  Rf: ?  ");
+                       model_print("  ?  ");
        }
        if (cv) {
                if (is_read())
-                       printf(" ");
+                       model_print(" ");
                else
-                       printf("          ");
+                       model_print("      ");
                cv->print();
        } else
-               printf("\n");
+               model_print("\n");
 }
 
-/** @brief Print nicely-formatted info about this ModelAction */
+/** @brief Get a (likely) unique hash for this ModelAction */
 unsigned int ModelAction::hash() const
 {
-       unsigned int hash=(unsigned int) this->type;
-       hash^=((unsigned int)this->order)<<3;
-       hash^=seq_number<<5;
-       hash^=tid<<6;
+       unsigned int hash = (unsigned int)this->type;
+       hash ^= ((unsigned int)this->order) << 3;
+       hash ^= seq_number << 5;
+       hash ^= id_to_int(tid) << 6;
 
        if (is_read()) {
-               if (reads_from)
-                       hash^=reads_from->get_seq_number();
+              if (reads_from)
+                      hash ^= reads_from->get_seq_number();
+              hash ^= get_reads_from_value();
        }
        return hash;
 }
+
+/**
+ * Only valid for LOCK, TRY_LOCK, UNLOCK, and WAIT operations.
+ * @return The mutex operated on by this action, if any; otherwise NULL
+ */
+cdsc::mutex * ModelAction::get_mutex() const
+{
+       if (is_trylock() || is_lock() || is_unlock())
+               return (cdsc::mutex *)get_location();
+       else if (is_wait())
+               return (cdsc::mutex *)get_value();
+       else
+               return NULL;
+}