Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add minor clean ups
authorMaxwell Pirtle <maxwellpirtle@gmail.com>
Tue, 14 Feb 2023 12:21:43 +0000 (13:21 +0100)
committerMaxwell Pirtle <maxwellpirtle@gmail.com>
Mon, 20 Feb 2023 09:43:52 +0000 (10:43 +0100)
src/mc/explo/UdporChecker.cpp
src/mc/explo/UdporChecker.hpp
src/mc/udpor_global.hpp

index e11a6d5..6d6afb9 100644 (file)
@@ -4,6 +4,7 @@
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "src/mc/explo/UdporChecker.hpp"
+#include <xbt/asserts.h>
 #include <xbt/log.h>
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_udpor, mc, "Logging specific to MC safety verification ");
@@ -13,17 +14,16 @@ 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
 }
 
 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]
+  // original UDPOR paper [1], while `prev_exC` arises
+  // from the incremental computation of ex(C) from [3]
   EventSet A, D;
   Configuration C;
   EventSet prev_exC;
@@ -31,7 +31,7 @@ void UdporChecker::run()
   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));
+  explore(std::move(C), std::move(A), std::move(D), {}, root_event.get(), std::move(prev_exC));
 
   XBT_INFO("UDPOR exploration terminated -- model checking completed");
 }
@@ -40,7 +40,7 @@ void UdporChecker::explore(Configuration C, EventSet D, EventSet A, std::list<Ev
                            UnfoldingEvent* cur_evt, EventSet prev_exC)
 {
   // Perform the incremental computation of exC
-  auto [exC, enC] = compute_extension(C, max_evt_history, *cur_evt, prev_exC);
+  auto [exC, enC] = compute_extension(C, max_evt_history, cur_evt, prev_exC);
 
   // If enC is a subset of D, intuitively
   // there aren't any enabled transitions
@@ -73,18 +73,15 @@ 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();
+  const auto next_state_id = observe_unfolding_event(*cur_evt);
 
   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");
+  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");
   e->set_state_id(next_state_id);
 
-  // TODO: Clean up configuration code before moving into the actual
-  // implementations of everything
-
-  // Configuration is the same + event e
   // Ce = C + {e}
   Configuration Ce = C;
   Ce.add_event(e);
@@ -119,15 +116,15 @@ void UdporChecker::explore(Configuration C, EventSet D, EventSet A, std::list<Ev
 
 std::tuple<EventSet, EventSet> UdporChecker::compute_extension(const Configuration& C,
                                                                const std::list<EventSet>& max_evt_history,
-                                                               const UnfoldingEvent& cur_event,
+                                                               UnfoldingEvent* cur_event,
                                                                const EventSet& prev_exC) const
 {
-  // exC.remove(cur_event);
+  EventSet exC = prev_exC;
 
-  // TODO: Compute extend() as it exists in tiny_simgrid
+  exC.remove(cur_event);
 
-  // exC.subtract(C);
-  return std::tuple<EventSet, EventSet>();
+  EventSet enC;
+  return std::tuple<EventSet, EventSet>(exC, enC);
 }
 
 State& UdporChecker::get_state_referenced_by(const UnfoldingEvent& event)
@@ -135,26 +132,30 @@ State& UdporChecker::get_state_referenced_by(const UnfoldingEvent& event)
   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",
+             "\n\n****** INVARIANT VIOLATION ******\n"
+             "To each UDPOR event corresponds a state, but state %lu does not exist. "
+             "Please report this as a bug.\n"
+             "*********************************\n\n",
              state_id);
   return wrapped_state.value().get();
 }
 
-void UdporChecker::observe_unfolding_event(const UnfoldingEvent& event)
+StateHandle UdporChecker::observe_unfolding_event(const UnfoldingEvent& event)
 {
   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"
+
+  // 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);
+  return this->record_current_state();
 }
 
-StateHandle UdporChecker::record_newly_visited_state()
+StateHandle UdporChecker::record_current_state()
 {
   auto next_state          = this->get_current_state();
   const auto next_state_id = this->state_manager_.record_state(std::move(next_state));
index ff51990..ddeda91 100644 (file)
@@ -113,14 +113,28 @@ private:
    * @returns a tuple containing the pair of sets `ex(C)` and `en(C)` respectively
    */
   std::tuple<EventSet, EventSet> compute_extension(const Configuration& C, const std::list<EventSet>& max_evt_history,
-                                                   const UnfoldingEvent& cur_event, const EventSet& prev_exC) const;
+                                                   UnfoldingEvent* cur_event, const EventSet& prev_exC) const;
 
   /**
    *
    */
-  void observe_unfolding_event(const UnfoldingEvent& event);
+  StateHandle observe_unfolding_event(const UnfoldingEvent& event);
+
+  /**
+   * @brief Resolves the state handle maintained by an event
+   * into a concrete reference to a state
+   */
   State& get_state_referenced_by(const UnfoldingEvent& event);
-  StateHandle record_newly_visited_state();
+
+  /**
+   * @brief Creates a new snapshot of the state of the progam undergoing
+   * model checking
+   *
+   * @returns the handle used to uniquely identify this state later in the
+   * exploration of the unfolding. You provide this handle to an event in the
+   * unfolding to regenerate past states
+   */
+  StateHandle record_current_state();
 
   /**
    * @brief Identifies the next event from the unfolding of the concurrent system
index 2abc1e7..bfcec9c 100644 (file)
@@ -83,6 +83,8 @@ public:
   // EventSet actorMaxEvent;    // maximal events of the actors in current configuration
   // UnfoldingEvent* lastEvent; // The last added event
 
+  inline auto begin() const { return this->events_.begin(); }
+  inline auto end() const { return this->events_.end(); }
   inline const EventSet& get_events() const { return this->events_; }
   inline const EventSet& get_maxmimal_events() const { return this->max_events_; }