fix my todo comments so they appear in documentation

[model-checker.git] / action.h

diff --git a/action.h b/action.h
index 30c8a35b80ed7681ce74bc5388c0667b9b4e4fec..da22882c3870ae361758ae97a7700a728203ea7b 100644 (file)
--- a/action.h
+++ b/action.h
@@ -9,11 +9,21 @@
 #include <cstddef>
 
 #include "threads.h"
-#include "libatomic.h"
 #include "mymemory.h"
 #include "clockvector.h"
+#include "memoryorder.h"
 
-#define VALUE_NONE -1
+using std::memory_order;
+using std::memory_order_relaxed;
+using std::memory_order_acquire;
+using std::memory_order_release;
+using std::memory_order_acq_rel;
+using std::memory_order_seq_cst;
+
+/** Note that this value can be legitimately used by a program, and
+               hence by iteself does not indicate no value. */
+
+#define VALUE_NONE 1234567890
 
 /** @brief Represents an action type, identifying one of several types of
  * ModelAction */
@@ -24,7 +34,9 @@ typedef enum action_type {
        THREAD_JOIN,          /**< A thread join action */
        ATOMIC_READ,          /**< An atomic read action */
        ATOMIC_WRITE,         /**< An atomic write action */
-       ATOMIC_RMW,           /**< An atomic read-modify-write action */
+       ATOMIC_RMWR,          /**< The read part of an atomic RMW action */
+       ATOMIC_RMW,           /**< The write part of an atomic RMW action */
+       ATOMIC_RMWC,          /**< Convert an atomic RMW action into a READ */
        ATOMIC_INIT           /**< Initialization of an atomic object (e.g.,
                               *   atomic_init()) */
 } action_type_t;
@@ -38,7 +50,7 @@ class ClockVector;
  */
 class ModelAction {
 public:
-       ModelAction(action_type_t type, memory_order order, void *loc, int value = VALUE_NONE);
+       ModelAction(action_type_t type, memory_order order, void *loc, uint64_t value = VALUE_NONE);
        ~ModelAction();
        void print(void) const;
 
@@ -47,7 +59,7 @@ public:
        memory_order get_mo() const { return order; }
        void * get_location() const { return location; }
        modelclock_t get_seq_number() const { return seq_number; }
-       int get_value() const { return value; }
+       uint64_t get_value() const { return value; }
        const ModelAction * get_reads_from() const { return reads_from; }
 
        Node * get_node() const { return node; }
@@ -55,6 +67,8 @@ public:
 
        bool is_read() const;
        bool is_write() const;
+       bool is_rmwr() const;
+       bool is_rmwc() const;
        bool is_rmw() const;
        bool is_initialization() const;
        bool is_acquire() const;
@@ -77,6 +91,9 @@ public:
                return get_seq_number() > act.get_seq_number();
        }
 
+       void process_rmw(ModelAction * act);
+       void copy_typeandorder(ModelAction * act);
+
        MEMALLOC
 private:
 
@@ -92,9 +109,8 @@ private:
        /** The thread id that performed this action. */
        thread_id_t tid;
 
-       /** The value read or written (if RMW, then the value written). This
-        * should probably be something longer. */
-       int value;
+       /** The value written (for write or RMW; undefined for read) */
+       uint64_t value;
 
        /** The action that this action reads from. Only valid for reads */
        const ModelAction *reads_from;