Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add default method for constructing full graph
[simgrid.git] / src / mc / explo / UdporChecker.cpp
index e11a6d5..c5d596d 100644 (file)
@@ -4,43 +4,50 @@
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "src/mc/explo/UdporChecker.hpp"
+#include "src/mc/api/State.hpp"
+#include "src/mc/explo/udpor/CompatibilityGraph.hpp"
+#include <xbt/asserts.h>
 #include <xbt/log.h>
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_udpor, mc, "Logging specific to MC safety verification ");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_udpor, mc, "Logging specific to verification using UDPOR");
 
 namespace simgrid::mc::udpor {
 
 UdporChecker::UdporChecker(const std::vector<char*>& args) : Exploration(args)
 {
-  /* Create initial data structures, if any ...*/
-  XBT_INFO("Starting a UDPOR exploration");
-
-  // TODO: Initialize state structures for the search
+  // Initialize the map
 }
 
 void UdporChecker::run()
 {
+  XBT_INFO("Starting a UDPOR exploration");
   // NOTE: `A`, `D`, and `C` are derived from the
-  // original UDPOR paper [1], while
-  // `prev_exC` arises from the incremental computation
-  // of ex(C) from the former paper described in [3]
-  EventSet A, D;
-  Configuration C;
-  EventSet prev_exC;
-
-  auto initial_state          = get_current_state();
-  const auto initial_state_id = state_manager_.record_state(std::move(initial_state));
-  const auto root_event       = std::make_unique<UnfoldingEvent>(-1, "", EventSet(), initial_state_id);
-  explore(std::move(C), std::move(A), std::move(D), {EventSet()}, root_event.get(), std::move(prev_exC));
+  // original UDPOR paper [1], while `prev_exC` arises
+  // from the incremental computation of ex(C) from [3]
+  Configuration C_root;
+
+  // TODO: Move computing the root configuration into a method on the Unfolding
+  auto initial_state      = get_current_state();
+  auto root_event         = std::make_unique<UnfoldingEvent>(EventSet(), std::make_shared<Transition>());
+  auto* root_event_handle = root_event.get();
+  unfolding.insert(std::move(root_event));
+  C_root.add_event(root_event_handle);
+
+  explore(C_root, EventSet(), EventSet(), std::move(initial_state), EventSet());
 
   XBT_INFO("UDPOR exploration terminated -- model checking completed");
 }
 
-void UdporChecker::explore(Configuration C, EventSet D, EventSet A, std::list<EventSet> max_evt_history,
-                           UnfoldingEvent* cur_evt, EventSet prev_exC)
+void UdporChecker::explore(const Configuration& C, EventSet D, EventSet A, std::unique_ptr<State> stateC,
+                           EventSet prev_exC)
 {
   // Perform the incremental computation of exC
-  auto [exC, enC] = compute_extension(C, max_evt_history, *cur_evt, prev_exC);
+  //
+  // TODO: This method will have side effects on
+  // the unfolding, but the naming of the method
+  // suggests it is doesn't have side effects. We should
+  // reconcile this in the future
+  auto [exC, enC] = compute_extension(C, *stateC, prev_exC);
 
   // If enC is a subset of D, intuitively
   // there aren't any enabled transitions
@@ -49,14 +56,9 @@ void UdporChecker::explore(Configuration C, EventSet D, EventSet A, std::list<Ev
   // "sleep-set blocked" trace.
   if (enC.is_subset_of(D)) {
 
-    if (C.get_events().size() > 0) {
+    if (not C.get_events().empty()) {
 
       // g_var::nb_traces++;
-
-      // TODO: Log here correctly
-      // XBT_DEBUG("\n Exploring executions: %d : \n", g_var::nb_traces);
-      // ...
-      // ...
     }
 
     // When `en(C)` is empty, intuitively this means that there
@@ -73,41 +75,42 @@ void UdporChecker::explore(Configuration C, EventSet D, EventSet A, std::list<Ev
 
   // TODO: Add verbose logging about which event is being explored
 
-  observe_unfolding_event(*cur_evt);
-  const auto next_state_id = record_newly_visited_state();
-
   UnfoldingEvent* e = select_next_unfolding_event(A, enC);
-  xbt_assert(e != nullptr, "UDPOR guarantees that an event will be chosen at each point in"
-                           "the search, yet no events were actually chosen");
-  e->set_state_id(next_state_id);
+  xbt_assert(e != nullptr, "\n\n****** INVARIANT VIOLATION ******\n"
+                           "UDPOR guarantees that an event will be chosen at each point in\n"
+                           "the search, yet no events were actually chosen\n"
+                           "*********************************\n\n");
 
-  // TODO: Clean up configuration code before moving into the actual
-  // implementations of everything
+  // Move the application into stateCe and actually make note of that state
+  move_to_stateCe(*stateC, *e);
+  auto stateCe = record_current_state();
 
-  // Configuration is the same + event e
-  // Ce = C + {e}
+  // Ce := C + {e}
   Configuration Ce = C;
   Ce.add_event(e);
 
-  max_evt_history.push_back(Ce.get_maxmimal_events());
   A.remove(e);
   exC.remove(e);
 
   // Explore(C + {e}, D, A \ {e})
-  explore(Ce, D, std::move(A), max_evt_history, e, std::move(exC));
+  explore(Ce, D, std::move(A), std::move(stateCe), std::move(exC));
 
   // D <-- D + {e}
   D.insert(e);
 
   // TODO: Determine a value of K to use or don't use it at all
   constexpr unsigned K = 10;
-  auto J               = compute_partial_alternative(D, C, K);
-  if (!J.empty()) {
+  if (auto J = compute_partial_alternative(D, C, K); !J.empty()) {
     J.subtract(C.get_events());
-    max_evt_history.pop_back();
+
+    // Before searching the "right half", we need to make
+    // sure the program actually reflects the fact
+    // that we are searching again from `stateC` (the recursive
+    // search moved the program into `stateCe`)
+    restore_program_state_to(*stateC);
 
     // Explore(C, D + {e}, J \ C)
-    explore(C, D, std::move(J), std::move(max_evt_history), cur_evt, std::move(prev_exC));
+    explore(C, D, std::move(J), std::move(stateC), std::move(prev_exC));
   }
 
   // D <-- D - {e}
@@ -117,51 +120,93 @@ void UdporChecker::explore(Configuration C, EventSet D, EventSet A, std::list<Ev
   clean_up_explore(e, C, D);
 }
 
-std::tuple<EventSet, EventSet> UdporChecker::compute_extension(const Configuration& C,
-                                                               const std::list<EventSet>& max_evt_history,
-                                                               const UnfoldingEvent& cur_event,
+std::tuple<EventSet, EventSet> UdporChecker::compute_extension(const Configuration& C, const State& stateC,
                                                                const EventSet& prev_exC) const
 {
-  // exC.remove(cur_event);
+  // See eqs. 5.7 of section 5.2 of [3]
+  // C = C' + {e_cur}, i.e. C' = C - {e_cur}
+  //
+  // Then
+  //
+  // ex(C) = ex(C' + {e_cur}) = ex(C') / {e_cur} +
+  //    U{<a, K> : K is maximal, `a` depends on all of K, `a` enabled at K }
+  UnfoldingEvent* e_cur = C.get_latest_event();
+  EventSet exC          = prev_exC;
+  exC.remove(e_cur);
+
+  for (const auto& [aid, actor_state] : stateC.get_actors_list()) {
+    for (const auto& transition : actor_state.get_enabled_transitions()) {
+      // First check for a specialized function that can compute the extension
+      // set "quickly" based on its type. Otherwise, fall back to computing
+      // the set "by hand"
+      const auto specialized_extension_function = incremental_extension_functions.find(transition->type_);
+      if (specialized_extension_function != incremental_extension_functions.end()) {
+        exC.form_union((specialized_extension_function->second)(C, *transition));
+      } else {
+        exC.form_union(this->compute_extension_by_enumeration(C, *transition));
+      }
+    }
+  }
 
-  // TODO: Compute extend() as it exists in tiny_simgrid
+  EventSet enC;
+  // TODO: Compute enC based on conflict relations
 
-  // exC.subtract(C);
-  return std::tuple<EventSet, EventSet>();
+  return std::tuple<EventSet, EventSet>(exC, enC);
 }
 
-State& UdporChecker::get_state_referenced_by(const UnfoldingEvent& event)
+EventSet UdporChecker::compute_extension_by_enumeration(const Configuration& C, const Transition& action) const
 {
-  const auto state_id      = event.get_state_id();
-  const auto wrapped_state = this->state_manager_.get_state(state_id);
-  xbt_assert(wrapped_state != std::nullopt,
-             "\n\n****** FATAL ERROR ******\n"
-             "To each UDPOR event corresponds a state,"
-             "but state %lu does not exist\n"
-             "******************\n\n",
-             state_id);
-  return wrapped_state.value().get();
+  // Here we're computing the following:
+  //
+  // U{<a, K> : K is maximal, `a` depends on all of K, `a` enabled at K }
+  //
+  // where `a` is the `action` given to us.
+  EventSet incremental_exC;
+
+  // We only consider those combinations of events for which `action` is dependent with
+  // the action associated with any given event ("`a` depends on all of K")
+  const std::unique_ptr<CompatibilityGraph> G = C.make_compatibility_graph_filtered_on([=](const UnfoldingEvent* e) {
+    const auto e_transition = e->get_transition();
+    return action.depends(e_transition);
+  });
+
+  // TODO: Now that the graph has been constructed, enumerate
+  // all possible k-cliques of the complement of G
+
+  // TODO: For each enumeration, check all possible
+  // combinations of selecting a single event from
+  // each set associated with the graph nodes
+
+  return incremental_exC;
 }
 
-void UdporChecker::observe_unfolding_event(const UnfoldingEvent& event)
+void UdporChecker::move_to_stateCe(State& state, const UnfoldingEvent& e)
 {
-  auto& state            = this->get_state_referenced_by(event);
-  const aid_t next_actor = state.next_transition();
-  xbt_assert(next_actor >= 0, "\n\n****** FATAL ERROR ******\n"
+  const aid_t next_actor = e.get_transition()->aid_;
+
+  // TODO: Add the trace if possible for reporting a bug
+  xbt_assert(next_actor >= 0, "\n\n****** INVARIANT VIOLATION ******\n"
                               "In reaching this execution path, UDPOR ensures that at least one\n"
                               "one transition of the state of an visited event is enabled, yet no\n"
-                              "state was actually enabled");
+                              "state was actually enabled. Please report this as a bug.\n"
+                              "*********************************\n\n");
   state.execute_next(next_actor);
 }
 
-StateHandle UdporChecker::record_newly_visited_state()
+void UdporChecker::restore_program_state_to(const State& stateC)
 {
-  auto next_state          = this->get_current_state();
-  const auto next_state_id = this->state_manager_.record_state(std::move(next_state));
+  // TODO: Perform state regeneration in the same manner as is done
+  // in the DFSChecker.cpp
+}
+
+std::unique_ptr<State> UdporChecker::record_current_state()
+{
+  auto next_state = this->get_current_state();
 
   // In UDPOR, we care about all enabled transitions in a given state
   next_state->mark_all_enabled_todo();
-  return next_state_id;
+
+  return next_state;
 }
 
 UnfoldingEvent* UdporChecker::select_next_unfolding_event(const EventSet& A, const EventSet& enC)
@@ -197,6 +242,8 @@ RecordTrace UdporChecker::get_record_trace()
 
 std::vector<std::string> UdporChecker::get_textual_trace()
 {
+  // TODO: Topologically sort the events of the latest configuration
+  // and iterate through that topological sorting
   std::vector<std::string> trace;
   return trace;
 }