.gitignore: ignore .dot graph files

[model-checker.git] / clockvector.cc

diff --git a/clockvector.cc b/clockvector.cc
index 2ef8b03d9e36e22ce4ee6989ec31d20633717ed2..594daa8a75d968f500d3248085045a559c3e13fa 100644 (file)
--- a/clockvector.cc
+++ b/clockvector.cc
@@ -7,33 +7,47 @@
 #include "clockvector.h"
 #include "common.h"
 
+/**
+ * Constructs a new ClockVector, given a parent ClockVector and a first
+ * ModelAction. This constructor can assign appropriate default settings if no
+ * parent and/or action is supplied.
+ * @param parent is the previous ClockVector to inherit (i.e., clock from the
+ * same thread or the parent that created this thread)
+ * @param act is an action with which to update the ClockVector
+ */
 ClockVector::ClockVector(ClockVector *parent, ModelAction *act)
 {
        num_threads = model->get_num_threads();
-       clock = (int *)MYMALLOC(num_threads * sizeof(int));
+       clock = (modelclock_t *)MYMALLOC(num_threads * sizeof(int));
        memset(clock, 0, num_threads * sizeof(int));
        if (parent)
-               std::memcpy(clock, parent->clock, parent->num_threads * sizeof(int));
+               std::memcpy(clock, parent->clock, parent->num_threads * sizeof(modelclock_t));
 
        if (act)
                clock[id_to_int(act->get_tid())] = act->get_seq_number();
 }
 
+/** @brief Destructor */
 ClockVector::~ClockVector()
 {
        MYFREE(clock);
 }
 
-void ClockVector::merge(ClockVector *cv)
+/**
+ * Merge a clock vector into this vector, using a pairwise comparison. The
+ * resulting vector length will be the maximum length of the two being merged.
+ * @param cv is the ClockVector being merged into this vector.
+ */
+void ClockVector::merge(const ClockVector *cv)
 {
-       int *clk = clock;
+       modelclock_t *clk = clock;
        bool resize = false;
 
        ASSERT(cv != NULL);
 
        if (cv->num_threads > num_threads) {
                resize = true;
-               clk = (int *)MYMALLOC(cv->num_threads * sizeof(int));
+               clk = (modelclock_t *)MYMALLOC(cv->num_threads * sizeof(modelclock_t));
        }
 
        /* Element-wise maximum */
@@ -50,12 +64,18 @@ void ClockVector::merge(ClockVector *cv)
 }
 
 /**
+ * Check whether this vector's thread has synchronized with another action's
+ * thread. This effectively checks the happens-before relation (or actually,
+ * happens after), but it's easier to compare two ModelAction events directly,
+ * using ModelAction::happens_before.
+ *
+ * @see ModelAction::happens_before
  *
  * @return true if this ClockVector's thread has synchronized with act's
  * thread, false otherwise. That is, this function returns:
  * <BR><CODE>act <= cv[act->tid]</CODE>
  */
-bool ClockVector::synchronized_since(ModelAction *act)
+bool ClockVector::synchronized_since(const ModelAction *act) const
 {
        int i = id_to_int(act->get_tid());
 
@@ -64,10 +84,32 @@ bool ClockVector::synchronized_since(ModelAction *act)
        return false;
 }
 
-void ClockVector::print()
+bool ClockVector::has_synchronized_with(const ClockVector *cv) const
+{
+       ASSERT(cv);
+       if (cv->num_threads > num_threads)
+               return false;
+       for (int i = 0; i < cv->num_threads; i++)
+               if (cv->clock[i] > clock[i])
+                       return false;
+       return true;
+}
+
+/** Gets the clock corresponding to a given thread id from the clock vector. */
+modelclock_t ClockVector::getClock(thread_id_t thread) {
+       int threadid = id_to_int(thread);
+
+       if (threadid < num_threads)
+               return clock[threadid];
+       else
+               return 0;
+}
+
+/** @brief Formats and prints this ClockVector's data. */
+void ClockVector::print() const
 {
        int i;
        printf("CV: (");
        for (i = 0; i < num_threads; i++)
-               printf("%2d%s", clock[i], (i == num_threads - 1) ? ")\n" : ", ");
+               printf("%2u%s", clock[i], (i == num_threads - 1) ? ")\n" : ", ");
 }