MC: comment, rename stuff, don't change anything profund

[simgrid.git] / src / mc / mc_state.h

diff --git a/src/mc/mc_state.h b/src/mc/mc_state.h
index 371d248..a2bd0ed 100644 (file)
--- a/src/mc/mc_state.h
+++ b/src/mc/mc_state.h
@@ -70,45 +70,45 @@ struct PatternCommunication {
 
 };
 
-/* On every state, each process has an entry of the following type */
+/* On every state, each process has an entry of the following type.
+ * This represents both the process and its transition because
+ *   a process cannot have more than one enabled transition at a given time.
+ */
 class ProcessState {
-  /* Possible exploration status of a process in a state */
+  /* Possible exploration status of a process transition in a state.
+   * Either the checker did not consider the transition, or it was considered and to do, or considered and done.
+   */
   enum class InterleavingType {
-    /** We do not have to execute this process transitions */
+    /** This process transition is not considered by the checker (yet?) */
     disabled = 0,
-    /** We still have to execute (some of) this process transitions */
-    interleave,
-    /** We have already executed this process transitions */
+    /** The checker algorithm decided that this process transitions should be done at some point */
+    todo,
+    /** The checker algorithm decided that this should be done, but it was done in the meanwhile */
     done,
   };
 
   /** Exploration control information */
   InterleavingType state = InterleavingType::disabled;
 public:
-
-  /** Number of times that the process was interleaved */
+  /** Number of times that the process was considered to be executed */
   // TODO, make this private
-  unsigned int interleave_count = 0;
+  unsigned int times_considered = 0;
 
-  bool isDisabled() const
-  {
+  bool isDisabled() const {
     return this->state == InterleavingType::disabled;
   }
-  bool isDone() const
-  {
+  bool isDone() const {
     return this->state == InterleavingType::done;
   }
-  bool isToInterleave() const
-  {
-    return this->state == InterleavingType::interleave;
+  bool isTodo() const {
+    return this->state == InterleavingType::todo;
   }
-  void interleave()
-  {
-    this->state = InterleavingType::interleave;
-    this->interleave_count = 0;
+  /** Mark that we should try executing this process at some point in the future of the checker algorithm */
+  void consider() {
+    this->state            = InterleavingType::todo;
+    this->times_considered = 0;
   }
-  void setDone()
-  {
+  void setDone() {
     this->state = InterleavingType::done;
   }
 };
@@ -125,13 +125,13 @@ struct XBT_PRIVATE State {
 
   Transition transition;
 
-  /** The simcall which was executed */
+  /** The simcall which was executed, going out of that state */
   s_smx_simcall_t executed_req;
 
-  /* Internal translation of the simcall
+  /* Internal translation of the executed_req simcall
    *
    * SIMCALL_COMM_TESTANY is translated to a SIMCALL_COMM_TEST
-   * and SIMCALL_COMM_WAITANY to a SIMCALL_COMM_WAIT.  
+   * and SIMCALL_COMM_WAITANY to a SIMCALL_COMM_WAIT.
    */
   s_smx_simcall_t internal_req;
 
@@ -145,12 +145,11 @@ struct XBT_PRIVATE State {
   std::vector<std::vector<simgrid::mc::PatternCommunication>> incomplete_comm_pattern;
   std::vector<unsigned> communicationIndices;
 
-  State();
+  State(unsigned long state_number);
 
   std::size_t interleaveSize() const;
-  void interleave(smx_actor_t process)
-  {
-    this->processStates[process->pid].interleave();
+  void interleave(smx_actor_t process) {
+    this->processStates[process->pid].consider();
   }
   Transition getTransition() const;
 };
@@ -158,7 +157,6 @@ struct XBT_PRIVATE State {
 }
 }
 
-XBT_PRIVATE simgrid::mc::State* MC_state_new(unsigned long state_number);
 XBT_PRIVATE smx_simcall_t MC_state_get_request(simgrid::mc::State* state);
 
 #endif