Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Rename some activity/SynchroBlah into activity/BlahImpl (+clang-format)
[simgrid.git] / src / mc / mc_state.h
index 5534a57..d807e28 100644 (file)
@@ -1,5 +1,4 @@
-/* Copyright (c) 2007-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2007-2017. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 #include <list>
 #include <memory>
 
-#include <xbt/base.h>
-#include <xbt/dynar.h>
-
-#include <simgrid_config.h>
-#include "src/simix/smx_private.h"
 #include "src/mc/mc_snapshot.h"
+#include "src/mc/mc_record.h"
+#include "src/mc/Transition.hpp"
 
 namespace simgrid {
 namespace mc {
 
-extern XBT_PRIVATE std::unique_ptr<s_mc_global_t> initial_global_state;
-
-/* Possible exploration status of a process in a state */
-enum class ProcessInterleaveState {
-  no_interleave=0, /* Do not interleave (do not execute) */
-  interleave,      /* Interleave the process (one or more request) */
-  more_interleave, /* Interleave twice the process (for mc_random simcall) */
-  done             /* Already interleaved */
+enum class PatternCommunicationType {
+  none = 0,
+  send = 1,
+  receive = 2,
 };
 
-/* On every state, each process has an entry of the following type */
-struct ProcessState {
-  /** Exploration control information */
-  ProcessInterleaveState state = ProcessInterleaveState::no_interleave;
-  /** Number of times that the process was interleaved */
-  unsigned int interleave_count;
+struct PatternCommunication {
+  int num = 0;
+  smx_activity_t comm_addr;
+  PatternCommunicationType type = PatternCommunicationType::send;
+  unsigned long src_proc = 0;
+  unsigned long dst_proc = 0;
+  const char *src_host = nullptr;
+  const char *dst_host = nullptr;
+  std::string rdv;
+  std::vector<char> data;
+  int tag = 0;
+  int index = 0;
+
+  PatternCommunication()
+  {
+    std::memset(&comm_addr, 0, sizeof(comm_addr));
+  }
 
-  bool done() const
+  PatternCommunication dup() const
   {
-    return this->state == ProcessInterleaveState::done;
+    simgrid::mc::PatternCommunication res;
+    // num?
+    res.comm_addr = this->comm_addr;
+    res.type = this->type;
+    // src_proc?
+    // dst_proc?
+    res.dst_proc = this->dst_proc;
+    res.dst_host = this->dst_host;
+    res.rdv = this->rdv;
+    res.data = this->data;
+    // tag?
+    res.index = this->index;
+    return res;
+  }
+
+};
+
+/* 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 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 {
+    /** This process transition is not considered by the checker (yet?) */
+    disabled = 0,
+    /** 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 considered to be executed */
+  // TODO, make this private
+  unsigned int times_considered = 0;
+
+  bool isDisabled() const {
+    return this->state == InterleavingType::disabled;
+  }
+  bool isDone() const {
+    return this->state == InterleavingType::done;
   }
-  bool interleave() const {
-    return this->state == ProcessInterleaveState::interleave
-      || this->state == ProcessInterleaveState::more_interleave;
+  bool isTodo() const {
+    return this->state == InterleavingType::todo;
+  }
+  /** 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() {
+    this->state = InterleavingType::done;
   }
 };
 
-/* An exploration state.
- *
- *  The `executed_state` is sometimes transformed into another `internal_req`.
- *  For example WAITANY is transformes into a WAIT and TESTANY into TEST.
- *  See `MC_state_set_executed_request()`.
+/* A node in the exploration graph (kind-of)
  */
 struct XBT_PRIVATE State {
-  /** State's exploration status by process */
-  std::vector<ProcessState> processStates;
-  s_smx_synchro_t internal_comm;        /* To be referenced by the internal_req */
-  s_smx_simcall_t internal_req;         /* Internal translation of request */
-  s_smx_simcall_t executed_req;         /* The executed request of the state */
-  int req_num = 0;                      /* The request number (in the case of a
-                                       multi-request like waitany ) */
-  std::shared_ptr<simgrid::mc::Snapshot> system_state = nullptr;      /* Snapshot of system state */
+
+  /** Sequential state number (used for debugging) */
   int num = 0;
-  int in_visited_states = 0;
 
-  // comm determinism verification (xbt_dynar_t<xbt_dynar_t<simgrid::mc::PatternCommunication*>):
-  xbt_dynar_t incomplete_comm_pattern = nullptr;
+  /** State's exploration status by process */
+  std::vector<ProcessState> actorStates;
 
-  // For communication determinism verification:
-  std::vector<unsigned> communicationIndices;
+  Transition transition;
+
+  /** The simcall which was executed, going out of that state */
+  s_smx_simcall_t executed_req;
 
-  State();
-  ~State();
+  /* 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.
+   */
+  s_smx_simcall_t internal_req;
 
-  State(State const&) = delete;
-  State operator=(State const&) = delete;
-  State(State const&&) = delete;
-  State operator=(State const&&) = delete;
+  /* Can be used as a copy of the remote synchro object */
+  simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> internal_comm;
+
+  /** Snapshot of system state (if needed) */
+  std::shared_ptr<simgrid::mc::Snapshot> system_state;
+
+  // For CommunicationDeterminismChecker
+  std::vector<std::vector<simgrid::mc::PatternCommunication>> incomplete_comm_pattern;
+  std::vector<unsigned> communicationIndices;
+
+  State(unsigned long state_number);
 
   std::size_t interleaveSize() const;
+  void interleave(smx_actor_t actor) {
+    this->actorStates[actor->pid].consider();
+  }
+  Transition getTransition() const;
 };
 
-XBT_PRIVATE void replay(std::list<std::unique_ptr<simgrid::mc::State>> const& stack);
-
 }
 }
 
-XBT_PRIVATE simgrid::mc::State* MC_state_new(void);
-XBT_PRIVATE void MC_state_interleave_process(simgrid::mc::State* state, smx_process_t process);
-XBT_PRIVATE void MC_state_set_executed_request(simgrid::mc::State* state, smx_simcall_t req, int value);
-XBT_PRIVATE smx_simcall_t MC_state_get_executed_request(simgrid::mc::State* state, int *value);
-XBT_PRIVATE smx_simcall_t MC_state_get_internal_request(simgrid::mc::State* state);
-XBT_PRIVATE smx_simcall_t MC_state_get_request(simgrid::mc::State* state, int *value);
-XBT_PRIVATE void MC_state_remove_interleave_process(simgrid::mc::State* state, smx_process_t process);
+XBT_PRIVATE smx_simcall_t MC_state_get_request(simgrid::mc::State* state);
 
 #endif