src/mc/explo/udpor/EventSet.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_EVENT_SET_HPP
   7 #define SIMGRID_MC_UDPOR_EVENT_SET_HPP
   8
   9 #include "src/mc/explo/udpor/udpor_forward.hpp"
  10
  11 #include <cstddef>
  12 #include <initializer_list>
  13 #include <unordered_set>
  14 #include <vector>
  15
  16 namespace simgrid::mc::udpor {
  17
  18 class EventSet {
  19 private:
  20   std::unordered_set<const UnfoldingEvent*> events_;
  21
  22 public:
  23   EventSet()                           = default;
  24   EventSet(const EventSet&)            = default;
  25   EventSet& operator=(const EventSet&) = default;
  26   EventSet& operator=(EventSet&&)      = default;
  27   EventSet(EventSet&&)                 = default;
  28   explicit EventSet(Configuration&& config);
  29   explicit EventSet(std::vector<const UnfoldingEvent*>&& raw_events) : events_(raw_events.begin(), raw_events.end()) {}
  30   explicit EventSet(std::unordered_set<const UnfoldingEvent*>&& raw_events) : events_(raw_events) {}
  31   explicit EventSet(std::initializer_list<const UnfoldingEvent*> event_list) : events_(std::move(event_list)) {}
  32
  33   auto begin() const { return this->events_.begin(); }
  34   auto end() const { return this->events_.end(); }
  35   auto cbegin() const { return this->events_.cbegin(); }
  36   auto cend() const { return this->events_.cend(); }
  37
  38   void remove(const UnfoldingEvent*);
  39   void subtract(const EventSet&);
  40   void subtract(const Configuration&);
  41   EventSet subtracting(const UnfoldingEvent*) const;
  42   EventSet subtracting(const EventSet&) const;
  43   EventSet subtracting(const Configuration&) const;
  44
  45   void insert(const UnfoldingEvent*);
  46   void form_union(const EventSet&);
  47   void form_union(const Configuration&);
  48   EventSet make_union(const UnfoldingEvent*) const;
  49   EventSet make_union(const EventSet&) const;
  50   EventSet make_union(const Configuration&) const;
  51
  52   size_t size() const;
  53   bool empty() const;
  54   bool contains(const UnfoldingEvent*) const;
  55   bool contains(const History&) const;
  56   bool is_subset_of(const EventSet&) const;
  57
  58   bool operator==(const EventSet& other) const { return this->events_ == other.events_; }
  59   bool operator!=(const EventSet& other) const { return this->events_ != other.events_; }
  60
  61   /**
  62    * @brief Whether or not this set of events could
  63    * represent a configuration
  64    */
  65   bool is_valid_configuration() const;
  66
  67   /**
  68    * @brief Whether or not this set of events is
  69    * a *maximal event set*, i.e. whether each element
  70    * of the set causes none of the others
  71    *
  72    * A set of events `E` is said to be _maximal_ if
  73    * it is causally-free. Formally,
  74    *
  75    * 1. For each event `e` in `E`, there is no event
  76    * `e'` in `E` such that `e < e'`
  77    */
  78   bool is_maximal() const;
  79
  80   /**
  81    * @brief Whether or not this set of events is
  82    * free of conflicts
  83    *
  84    * A set of events `E` is said to be _conflict free_
  85    * if
  86    *
  87    * 1. For each event `e` in `E`, there is no event
  88    * `e'` in `E` such that `e # e'` where `#` is the
  89    * conflict relation over the unfolding from
  90    * which the events `E` are derived
  91    *
  92    * @note: This method makes use only of the causality
  93    * tree of the events in the set; i.e. it determines conflicts
  94    * based solely on the unfolding and the definition of
  95    * conflict in an unfolding. Some clever techniques
  96    * exist for computing conflicts with specialized transition
  97    * types (only mutexes if I remember correctly) that was
  98    * referenced in The Anh Pham's thesis. This would require
  99    * keeping track of information *outside* of any given
 100    * set and probably doesn't work for all types of transitions
 101    * anyway.
 102    */
 103   bool is_conflict_free() const;
 104
 105   /**
 106    * @brief Orders the events of the set such that
 107    * "more recent" events (i.e. those that are farther down in
 108    * the event structure's dependency chain) come after those
 109    * that appeared "farther in the past"
 110    *
 111    * @returns a vector `V` with the following property:
 112    *
 113    * 1. Let i(e) := C -> I map events to their indices in `V`.
 114    * For every pair of events e, e' in C, if e < e' then i(e) < i(e')
 115    *
 116    * Intuitively, events that are closer to the "bottom" of the event
 117    * structure appear farther along in the list than those that appear
 118    * closer to the "top"
 119    */
 120   std::vector<const UnfoldingEvent*> get_topological_ordering() const;
 121
 122   /**
 123    * @brief Orders the events of set such that
 124    * "more recent" events (i.e. those that are farther down in
 125    * the event structure's dependency chain) come before those
 126    * that appear "farther in the past"
 127    *
 128    * @note The events of the event structure are arranged such that
 129    * e < e' implies a directed edge from e to e'. However, it is
 130    * also useful to be able to traverse the *reverse* graph (for
 131    * example when computing the compatibility graph of a configuration),
 132    * hence the distinction between "reversed" and the method
 133    * "EventSet::get_topological_ordering()"
 134    *
 135    * @returns a vector `V` with the following property:
 136    *
 137    * 1. Let i(e) := C -> I map events to their indices in `V`.
 138    * For every pair of events e, e' in C, if e < e' then i(e) > i(e')
 139    *
 140    * Intuitively, events that are closer to the "top" of the event
 141    * structure appear farther along in the list than those that appear
 142    * closer to the "bottom"
 143    */
 144   std::vector<const UnfoldingEvent*> get_topological_ordering_of_reverse_graph() const;
 145
 146   /**
 147    * @brief Moves the event set into a list
 148    */
 149   std::vector<const UnfoldingEvent*> move_into_vector() const&&;
 150
 151   using iterator       = decltype(events_)::iterator;
 152   using const_iterator = decltype(events_)::const_iterator;
 153   using value_type     = decltype(events_)::value_type;
 154 };
 155
 156 } // namespace simgrid::mc::udpor
 157 #endif