src/mc/explo/udpor/UnfoldingEvent.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_UNFOLDING_EVENT_HPP
   7 #define SIMGRID_MC_UDPOR_UNFOLDING_EVENT_HPP
   8
   9 #include "src/mc/explo/udpor/EventSet.hpp"
  10 #include "src/mc/explo/udpor/udpor_forward.hpp"
  11 #include "src/mc/transition/Transition.hpp"
  12
  13 #include <initializer_list>
  14 #include <memory>
  15 #include <string>
  16
  17 namespace simgrid::mc::udpor {
  18
  19 class UnfoldingEvent {
  20 public:
  21   explicit UnfoldingEvent(std::initializer_list<const UnfoldingEvent*> init_list);
  22   UnfoldingEvent(EventSet immediate_causes              = EventSet(),
  23                  std::shared_ptr<Transition> transition = std::make_unique<Transition>());
  24
  25   UnfoldingEvent(const UnfoldingEvent&)            = default;
  26   UnfoldingEvent& operator=(UnfoldingEvent const&) = default;
  27   UnfoldingEvent(UnfoldingEvent&&)                 = default;
  28
  29   EventSet get_history() const;
  30   bool in_history_of(const UnfoldingEvent* other) const;
  31
  32   /**
  33    * @brief Whether or not the given event is a decendant
  34    * of or an ancestor of the given event
  35    */
  36   bool related_to(const UnfoldingEvent* other) const;
  37
  38   /// @brief Whether or not this event is in conflict with
  39   /// the given one (i.e. whether `this # other`)
  40   bool conflicts_with(const UnfoldingEvent* other) const;
  41
  42   /// @brief Whether or not this event is in conflict with
  43   /// any event in the given configuration
  44   bool conflicts_with(const Configuration& config) const;
  45
  46   /// @brief Computes "this #ⁱ other"
  47   bool immediately_conflicts_with(const UnfoldingEvent* other) const;
  48   bool is_dependent_with(const Transition*) const;
  49   bool is_dependent_with(const UnfoldingEvent* other) const;
  50
  51   const EventSet& get_immediate_causes() const { return this->immediate_causes; }
  52   Transition* get_transition() const { return this->associated_transition.get(); }
  53   aid_t get_actor() const { return get_transition()->aid_; }
  54
  55   std::string to_string() const;
  56
  57   bool operator==(const UnfoldingEvent&) const;
  58   bool operator!=(const UnfoldingEvent& other) const { return not(*this == other); }
  59
  60 private:
  61   /**
  62    * @brief The transition that UDPOR "attaches" to this
  63    * specific event for later use while computing e.g. extension
  64    * sets
  65    *
  66    * The transition points to that of a particular actor
  67    * in the state reached by the configuration C (recall
  68    * this is denoted `state(C)`) that excludes this event.
  69    * In other words, this transition was the "next" event
  70    * of the actor that executes it in `state(C)`.
  71    */
  72   std::shared_ptr<Transition> associated_transition;
  73
  74   /**
  75    * @brief The "immediate" causes of this event.
  76    *
  77    * An event `e` is an immediate cause of an event `e'` if
  78    *
  79    * 1. e < e'
  80    * 2. There is no event `e''` in E such that
  81    * `e < e''` and `e'' < e'`
  82    *
  83    * Intuitively, an immediate cause "happened right before"
  84    * this event was executed. It is sufficient to store
  85    * only the immediate causes of any event `e`, as any indirect
  86    * causes of that event would either be an indirect cause
  87    * or an immediate cause of the immediate causes of `e`, and
  88    * so on.
  89    */
  90   EventSet immediate_causes;
  91 };
  92
  93 } // namespace simgrid::mc::udpor
  94 #endif