action: remove clockvector flag from print() method
[model-checker.git] / action.cc
index 8793337448dda45a86ade51d63e6eba2b8960c0c..08fe10677c5d1e7e518c15fc27a4638c7f4494f4 100644 (file)
--- a/action.cc
+++ b/action.cc
@@ -1,11 +1,15 @@
 #include <stdio.h>
 #define __STDC_FORMAT_MACROS
 #include <inttypes.h>
+#include <vector>
 
 #include "model.h"
 #include "action.h"
 #include "clockvector.h"
 #include "common.h"
+#include "threads.h"
+
+#define ACTION_INITIAL_CLOCK 0
 
 ModelAction::ModelAction(action_type_t type, memory_order order, void *loc, uint64_t value) :
        type(type),
@@ -13,22 +17,72 @@ ModelAction::ModelAction(action_type_t type, memory_order order, void *loc, uint
        location(loc),
        value(value),
        reads_from(NULL),
+       seq_number(ACTION_INITIAL_CLOCK),
        cv(NULL)
 {
        Thread *t = thread_current();
        this->tid = t->get_id();
-       this->seq_number = model->get_next_seq_num();
 }
 
+/** @brief ModelAction destructor */
 ModelAction::~ModelAction()
 {
-       if (cv)
-               delete cv;
+       /**
+        * We can't free the clock vector:
+        * Clock vectors are snapshotting state. When we delete model actions,
+        * they are at the end of the node list and have invalid old clock
+        * vectors which have already been rolled back to an unallocated state.
+        */
+
+       /*
+        if (cv)
+               delete cv; */
+}
+
+void ModelAction::copy_from_new(ModelAction *newaction)
+{
+       seq_number = newaction->seq_number;
+}
+
+void ModelAction::set_seq_number(modelclock_t num)
+{
+       ASSERT(seq_number == ACTION_INITIAL_CLOCK);
+       seq_number = num;
+}
+
+bool ModelAction::is_mutex_op() const
+{
+       return type == ATOMIC_LOCK || type == ATOMIC_TRYLOCK || type == ATOMIC_UNLOCK;
+}
+
+bool ModelAction::is_lock() const
+{
+       return type == ATOMIC_LOCK;
+}
+
+bool ModelAction::is_unlock() const
+{
+       return type == ATOMIC_UNLOCK;
+}
+
+bool ModelAction::is_trylock() const
+{
+       return type == ATOMIC_TRYLOCK;
+}
+
+bool ModelAction::is_success_lock() const
+{
+       return type == ATOMIC_LOCK || (type == ATOMIC_TRYLOCK && value == VALUE_TRYSUCCESS);
+}
+
+bool ModelAction::is_failed_trylock() const
+{
+       return (type == ATOMIC_TRYLOCK && value == VALUE_TRYFAILED);
 }
 
 bool ModelAction::is_read() const
 {
-       return type == ATOMIC_READ || type == ATOMIC_RMW;
+       return type == ATOMIC_READ || type == ATOMIC_RMWR || type == ATOMIC_RMW;
 }
 
 bool ModelAction::is_write() const
@@ -36,11 +90,26 @@ bool ModelAction::is_write() const
        return type == ATOMIC_WRITE || type == ATOMIC_RMW || type == ATOMIC_INIT;
 }
 
+bool ModelAction::is_rmwr() const
+{
+       return type == ATOMIC_RMWR;
+}
+
 bool ModelAction::is_rmw() const
 {
        return type == ATOMIC_RMW;
 }
 
+bool ModelAction::is_rmwc() const
+{
+       return type == ATOMIC_RMWC;
+}
+
+bool ModelAction::is_fence() const 
+{
+       return type == ATOMIC_FENCE;
+}
+
 bool ModelAction::is_initialization() const
 {
        return type == ATOMIC_INIT;
@@ -85,13 +154,25 @@ bool ModelAction::same_thread(const ModelAction *act) const
        return tid == act->tid;
 }
 
-void ModelAction::upgrade_rmw(ModelAction * act) {
-       ASSERT(is_read());
-       ASSERT(act->is_rmw());
-       //Upgrade our type to the act's type
-       this->type=act->type;
+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.
+ * @todo  If the memory_order changes, we may potentially need to update our
+ * clock vector.
+ */
+void ModelAction::process_rmw(ModelAction * act) {
        this->order=act->order;
-       this->value=act->value;
+       if (act->is_rmwc())
+               this->type=ATOMIC_READ;
+       else if (act->is_rmw()) {
+               this->type=ATOMIC_RMW;
+               this->value=act->value;
+       }
 }
 
 /** The is_synchronizing method should only explore interleavings if:
@@ -103,7 +184,6 @@ void ModelAction::upgrade_rmw(ModelAction * act) {
  *  @param act is the action to consider exploring a reordering.
  *  @return tells whether we have to explore a reordering.
  */
-
 bool ModelAction::is_synchronizing(const ModelAction *act) const
 {
        //Same thread can't be reordered
@@ -129,22 +209,77 @@ bool ModelAction::is_synchronizing(const ModelAction *act) const
        return false;
 }
 
-void ModelAction::create_cv(const ModelAction *parent)
+bool ModelAction::is_conflicting_lock(const ModelAction *act) const
 {
-       ASSERT(cv == NULL);
+       //Must be different threads to reorder
+       if (same_thread(act))
+               return false;
+       
+       //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
+       if (act->is_unlock() && is_trylock() && value == VALUE_TRYSUCCESS)
+               return true;
+
+       return false;
+}
 
+/**
+ * Create a new clock vector for this action. Note that this function allows a
+ * user to clobber (and leak) a ModelAction's existing clock vector. A user
+ * should ensure that the vector has already either been rolled back
+ * (effectively "freed") or freed.
+ *
+ * @param parent A ModelAction from which to inherit a ClockVector
+ */
+void ModelAction::create_cv(const ModelAction *parent)
+{
        if (parent)
                cv = new ClockVector(parent->cv, this);
        else
                cv = new ClockVector(NULL, this);
 }
 
+void ModelAction::set_try_lock(bool obtainedlock) {
+       if (obtainedlock)
+               value=VALUE_TRYSUCCESS;
+       else
+               value=VALUE_TRYFAILED;
+}
+
+/** Update the model action's read_from action */
 void ModelAction::read_from(const ModelAction *act)
 {
        ASSERT(cv);
-       if (act->is_release() && this->is_acquire())
-               cv->merge(act->cv);
        reads_from = act;
+       if (act != NULL && this->is_acquire()) {
+               rel_heads_list_t release_heads;
+               model->get_release_seq_heads(this, &release_heads);
+               for (unsigned int i = 0; i < release_heads.size(); i++)
+                       if (!synchronize_with(release_heads[i]))
+                               model->set_bad_synchronization();
+       }
+}
+
+/**
+ * Synchronize the current thread with the thread corresponding to the
+ * ModelAction parameter.
+ * @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)
+               return false;
+       model->check_promises(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);
 }
 
 /**
@@ -158,9 +293,10 @@ bool ModelAction::happens_before(const ModelAction *act) const
        return act->cv->synchronized_since(this);
 }
 
-void ModelAction::print(void) const
+/** @brief Print nicely-formatted info about this ModelAction */
+void ModelAction::print() const
 {
-       const char *type_str;
+       const char *type_str, *mo_str;
        switch (this->type) {
        case THREAD_CREATE:
                type_str = "thread create";
@@ -174,6 +310,9 @@ void ModelAction::print(void) const
        case THREAD_JOIN:
                type_str = "thread join";
                break;
+       case THREAD_FINISH:
+               type_str = "thread finish";
+               break;
        case ATOMIC_READ:
                type_str = "atomic read";
                break;
@@ -183,19 +322,62 @@ void ModelAction::print(void) const
        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->value:value;
+       uint64_t valuetoprint=type==ATOMIC_READ?(reads_from!=NULL?reads_from->value:VALUE_NONE):value;
 
-       printf("(%3d) Thread: %-2d    Action: %-13s    MO: %d    Loc: %14p    Value: %-12" PRIu64,
-                       seq_number, id_to_int(tid), type_str, order, location, valuetoprint);
-       if (reads_from)
-               printf(" Rf: %d", reads_from->get_seq_number());
+       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;
+       }
+
+       printf("(%3d) Thread: %-2d   Action: %-13s   MO: %7s  Loc: %14p  Value: %-12" PRIu64,
+                       seq_number, id_to_int(tid), type_str, mo_str, location, valuetoprint);
+       if (is_read()) {
+               if (reads_from)
+                       printf(" Rf: %d", reads_from->get_seq_number());
+               else
+                       printf(" Rf: ?");
+       }
        if (cv) {
                printf("\t");
                cv->print();