src/mc/explo/udpor/Configuration.hpp

   1 /* Copyright (c) 2007-2023. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_MC_UDPOR_CONFIGURATION_HPP
   7 #define SIMGRID_MC_UDPOR_CONFIGURATION_HPP
   8
   9 #include "src/mc/explo/udpor/EventSet.hpp"
  10 #include "src/mc/explo/udpor/udpor_forward.hpp"
  11
  12 #include <boost/iterator/iterator_facade.hpp>
  13 #include <functional>
  14 #include <initializer_list>
  15 #include <optional>
  16 #include <vector>
  17
  18 namespace simgrid::mc::udpor {
  19
  20 class Configuration {
  21 public:
  22   Configuration()                                = default;
  23   Configuration(const Configuration&)            = default;
  24   Configuration& operator=(Configuration const&) = default;
  25   Configuration(Configuration&&)                 = default;
  26
  27   explicit Configuration(const EventSet& events);
  28   explicit Configuration(std::initializer_list<const UnfoldingEvent*> events);
  29
  30   auto begin() const { return this->events_.begin(); }
  31   auto end() const { return this->events_.end(); }
  32
  33   bool contains(const UnfoldingEvent* e) const { return this->events_.contains(e); }
  34   const EventSet& get_events() const { return this->events_; }
  35   const UnfoldingEvent* get_latest_event() const { return this->newest_event; }
  36
  37   /**
  38    * @brief Insert a new event into the configuration
  39    *
  40    * When the newly added event is inserted into the configuration,
  41    * an assertion is made to ensure that the configuration remains
  42    * valid, i.e. that the newly added event's dependencies are contained
  43    * within the configuration.
  44    *
  45    * @param e the event to add to the configuration. If the event is
  46    * already a part of the configuration, calling this method has no
  47    * effect.
  48    *
  49    * @throws an invalid argument exception is raised should the event
  50    * be missing one of its dependencies
  51    *
  52    * @note: UDPOR technically enforces the invariant that all newly-added events
  53    * will ensure that the configuration is valid. We perform extra checks to ensure
  54    * that UDPOR is implemented as expected. There is a performance penalty that
  55    * should be noted: checking for maximality requires ensuring that all events in the
  56    * configuration have their dependencies containes within the configuration, which
  57    * essentially means performing a BFS/DFS over the configuration using a History object.
  58    * However, since the slowest part of UDPOR involves enumerating all
  59    * subsets of maximal events and computing k-partial alternatives (the
  60    * latter definitively an NP-hard problem when optimal), Amdahl's law suggests
  61    * we shouldn't focus so much on this (let alone the additional benefit of the
  62    * assertions)
  63    */
  64   void add_event(const UnfoldingEvent* e);
  65
  66   /**
  67    * @brief Orders the events of the configuration such that
  68    * "more recent" events (i.e. those that are farther down in
  69    * the event structure's dependency chain) come after those
  70    * that appeared "farther in the past"
  71    *
  72    * @returns a vector `V` with the following property:
  73    *
  74    * 1. Let i(e) := C -> I map events to their indices in `V`.
  75    * For every pair of events e, e' in C, if e < e' then i(e) < i(e')
  76    *
  77    * Intuitively, events that are closer to the "bottom" of the event
  78    * structure appear farther along in the list than those that appear
  79    * closer to the "top"
  80    */
  81   std::vector<const UnfoldingEvent*> get_topologically_sorted_events() const;
  82
  83   /**
  84    * @brief Orders the events of the configuration such that
  85    * "more recent" events (i.e. those that are farther down in
  86    * the event structure's dependency chain) come before those
  87    * that appear "farther in the past"
  88    *
  89    * @note The events of the event structure are arranged such that
  90    * e < e' implies a directed edge from e to e'. However, it is
  91    * also useful to be able to traverse the *reverse* graph (for
  92    * example when computing the compatibility graph of a configuration),
  93    * hence the distinction between "reversed" and the method
  94    * "Configuration::get_topologically_sorted_events()"
  95    *
  96    * @returns a vector `V` with the following property:
  97    *
  98    * 1. Let i(e) := C -> I map events to their indices in `V`.
  99    * For every pair of events e, e' in C, if e < e' then i(e) > i(e')
 100    *
 101    * Intuitively, events that are closer to the "top" of the event
 102    * structure appear farther along in the list than those that appear
 103    * closer to the "bottom"
 104    */
 105   std::vector<const UnfoldingEvent*> get_topologically_sorted_events_of_reverse_graph() const;
 106
 107 private:
 108   /**
 109    * @brief The most recent event added to the configuration
 110    */
 111   const UnfoldingEvent* newest_event = nullptr;
 112
 113   /**
 114    * @brief The events which make up this configuration
 115    *
 116    * @invariant For each event `e` in `events_`, the set of
 117    * dependencies of `e` is also contained in `events_`
 118    */
 119   EventSet events_;
 120 };
 121
 122 } // namespace simgrid::mc::udpor
 123 #endif