include/simgrid/kernel/resource/Action.hpp

   1 /* Copyright (c) 2004-2021. 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_KERNEL_RESOURCE_ACTION_HPP
   7 #define SIMGRID_KERNEL_RESOURCE_ACTION_HPP
   8
   9 #include <simgrid/forward.h>
  10 #include <xbt/signal.hpp>
  11 #include <xbt/utility.hpp>
  12
  13 #include <boost/heap/pairing_heap.hpp>
  14 #include <boost/optional.hpp>
  15 #include <string>
  16
  17 static constexpr int NO_MAX_DURATION = -1.0;
  18
  19 namespace simgrid {
  20 namespace kernel {
  21 namespace resource {
  22
  23 using heap_element_type = std::pair<double, Action*>;
  24 using heap_type =
  25     boost::heap::pairing_heap<heap_element_type, boost::heap::constant_time_size<false>, boost::heap::stable<true>,
  26                               boost::heap::compare<simgrid::xbt::HeapComparator<heap_element_type>>>;
  27
  28 class XBT_PUBLIC ActionHeap : public heap_type {
  29   friend Action;
  30
  31 public:
  32   enum class Type {
  33     latency = 100, /* this is a heap entry to warn us when the latency is paid */
  34     max_duration,  /* this is a heap entry to warn us when the max_duration limit (timeout) is reached */
  35     normal,        /* this is a normal heap entry stating the date to finish transmitting */
  36     unset
  37   };
  38
  39   double top_date() const;
  40   void insert(Action* action, double date, ActionHeap::Type type);
  41   void update(Action* action, double date, ActionHeap::Type type);
  42   void remove(Action* action);
  43   Action* pop();
  44 };
  45
  46 /** @details An action is a consumption on a resource (e.g.: a communication for the network).
  47  *
  48  * It is related (but still different) from activities, that are the stuff on which an actor can be blocked.
  49  *
  50  * - A sequential execution activity encompasses 2 actions: one for the exec itself,
  51  *   and a time-limited sleep used as timeout detector.
  52  * - A point-to-point communication activity encompasses 3 actions: one for the comm itself
  53  *   (which spans on all links of the path), and one infinite sleep used as failure detector
  54  *   on both sender and receiver hosts.
  55  * - Synchronization activities may possibly be connected to no action.
  56
  57  */
  58 class XBT_PUBLIC Action {
  59   friend ActionHeap;
  60
  61 public:
  62   /* Lazy update needs this Set hook to maintain a list of the tracked actions */
  63   boost::intrusive::list_member_hook<> modified_set_hook_;
  64   bool is_within_modified_set() const { return modified_set_hook_.is_linked(); }
  65   using ModifiedSet = boost::intrusive::list<
  66       Action, boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::modified_set_hook_>>;
  67
  68   boost::intrusive::list_member_hook<> state_set_hook_;
  69   using StateSet = boost::intrusive::list<
  70       Action, boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::state_set_hook_>>;
  71
  72   enum class State {
  73     INITED,   /**< Created, but not started yet */
  74     STARTED,  /**< Currently running */
  75     FAILED,   /**< either the resource failed, or the action was canceled */
  76     FINISHED, /**< Successfully completed  */
  77     IGNORED   /**< e.g. failure detectors: infinite sleep actions that are put on resources which failure should get
  78                  noticed  */
  79   };
  80
  81   enum class SuspendStates {
  82     RUNNING = 0, /**< Action currently not suspended **/
  83     SUSPENDED,
  84     SLEEPING
  85   };
  86
  87   /**
  88    * @brief Action constructor
  89    *
  90    * @param model The Model associated to this Action
  91    * @param cost The cost of the Action
  92    * @param failed If the action is impossible (e.g.: execute something on a switched off host)
  93    */
  94   Action(Model* model, double cost, bool failed);
  95
  96   /**
  97    * @brief Action constructor
  98    *
  99    * @param model The Model associated to this Action
 100    * @param cost The cost of the Action
 101    * @param failed If the action is impossible (e.g.: execute something on a switched off host)
 102    * @param var The lmm variable associated to this Action if it is part of a LMM component
 103    */
 104   Action(Model* model, double cost, bool failed, lmm::Variable* var);
 105   Action(const Action&) = delete;
 106   Action& operator=(const Action&) = delete;
 107
 108   virtual ~Action();
 109
 110   /**
 111    * @brief Mark that the action is now finished
 112    *
 113    * @param state the new [state](@ref simgrid::kernel::resource::Action::State) of the current Action
 114    */
 115   void finish(Action::State state);
 116
 117   /** @brief Get the [state](@ref simgrid::kernel::resource::Action::State) of the current Action */
 118   Action::State get_state() const; /**< get the state*/
 119   /** @brief Set the [state](@ref simgrid::kernel::resource::Action::State) of the current Action */
 120   virtual void set_state(Action::State state);
 121
 122   /** @brief Get the bound of the current Action */
 123   double get_bound() const;
 124   /** @brief Set the bound of the current Action */
 125   void set_bound(double bound);
 126
 127   /** @brief Get the start time of the current action */
 128   double get_start_time() const { return start_time_; }
 129   /** @brief Get the finish time of the current action */
 130   double get_finish_time() const { return finish_time_; }
 131
 132   /** @brief Get the user data associated to the current action */
 133   void* get_data() const { return data_; }
 134   /** @brief Set the user data associated to the current action */
 135   void set_data(void* data) { data_ = data; }
 136
 137   /** @brief Get the user data associated to the current action */
 138   activity::ActivityImpl* get_activity() const { return activity_; }
 139   /** @brief Set the user data associated to the current action */
 140   void set_activity(activity::ActivityImpl* activity) { activity_ = activity; }
 141
 142   /** @brief Get the cost of the current action */
 143   double get_cost() const { return cost_; }
 144   /** @brief Set the cost of the current action */
 145   void set_cost(double cost) { cost_ = cost; }
 146
 147   /** @brief Update the maximum duration of the current action
 148    *  @param delta Amount to remove from the MaxDuration */
 149   void update_max_duration(double delta);
 150
 151   /** @brief Update the remaining time of the current action
 152    *  @param delta Amount to remove from the remaining time */
 153   void update_remains(double delta);
 154
 155   virtual void update_remains_lazy(double now) = 0;
 156
 157   /** @brief Set the remaining time of the current action */
 158   void set_remains(double value) { remains_ = value; }
 159
 160   /** @brief Get the remaining time of the current action after updating the resource */
 161   virtual double get_remains();
 162   /** @brief Get the remaining time of the current action without updating the resource */
 163   double get_remains_no_update() const { return remains_; }
 164
 165   /** @brief Set the finish time of the current action */
 166   void set_finish_time(double value) { finish_time_ = value; }
 167
 168   /**@brief Add a reference to the current action (refcounting) */
 169   void ref();
 170   /** @brief Unref that action (and destroy it if refcount reaches 0)
 171    *  @return true if the action was destroyed and false if someone still has references on it */
 172   bool unref();
 173
 174   /** @brief Cancel the current Action if running */
 175   virtual void cancel();
 176
 177   /** @brief Suspend the current Action */
 178   virtual void suspend();
 179
 180   /** @brief Resume the current Action */
 181   virtual void resume();
 182
 183   /** @brief Returns true if the current action is suspended */
 184   bool is_suspended() const { return suspended_ == SuspendStates::SUSPENDED; }
 185   /** @brief Returns true if the current action is running */
 186   bool is_running() const { return suspended_ == SuspendStates::RUNNING; }
 187
 188   /** @brief Get the maximum duration of the current action */
 189   double get_max_duration() const { return max_duration_; }
 190   /** @brief Set the maximum duration of the current Action */
 191   virtual void set_max_duration(double duration);
 192
 193   /** @brief Get the tracing category associated to the current action */
 194   const std::string& get_category() const { return category_; }
 195   /** @brief Set the tracing category of the current Action */
 196   void set_category(const std::string& category) { category_ = category; }
 197
 198   /** @brief Get the sharing_penalty (RTT or 1/thread_count) of the current Action */
 199   double get_sharing_penalty() const { return sharing_penalty_; };
 200   /** @brief Set the sharing_penalty (RTT or 1/thread_count) of the current Action */
 201   virtual void set_sharing_penalty(double sharing_penalty);
 202   void set_sharing_penalty_no_update(double sharing_penalty) { sharing_penalty_ = sharing_penalty; }
 203
 204   /** @brief Get the state set in which the action is */
 205   StateSet* get_state_set() const { return state_set_; };
 206
 207   Model* get_model() const { return model_; }
 208
 209 private:
 210   StateSet* state_set_;
 211   Action::SuspendStates suspended_ = Action::SuspendStates::RUNNING;
 212   int refcount_            = 1;
 213   double sharing_penalty_          = 1.0;             /**< priority (1.0 by default) */
 214   double max_duration_   = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
 215   double remains_;           /**< How much of that cost remains to be done in the currently running task */
 216   double start_time_;        /**< start time  */
 217   double finish_time_ = -1;  /**< finish time (may fluctuate until the task is completed) */
 218   std::string category_;     /**< tracing category for categorized resource utilization monitoring */
 219
 220   double cost_;
 221   Model* model_;
 222   void* data_                       = nullptr; /**< for your convenience */
 223   activity::ActivityImpl* activity_ = nullptr;
 224
 225   /* LMM */
 226   double last_update_      = 0;
 227   double last_value_       = 0;
 228   lmm::Variable* variable_ = nullptr;
 229
 230   ActionHeap::Type type_                              = ActionHeap::Type::unset;
 231   boost::optional<ActionHeap::handle_type> heap_hook_ = boost::none;
 232
 233 public:
 234   ActionHeap::Type get_type() const { return type_; }
 235
 236   lmm::Variable* get_variable() const { return variable_; }
 237   void set_variable(lmm::Variable* var) { variable_ = var; }
 238
 239   double get_last_update() const { return last_update_; }
 240   void set_last_update();
 241
 242   double get_last_value() const { return last_value_; }
 243   void set_last_value(double val) { last_value_ = val; }
 244   void set_suspend_state(Action::SuspendStates state) { suspended_ = state; }
 245 };
 246
 247 } // namespace resource
 248 } // namespace kernel
 249 } // namespace simgrid
 250 #endif