include/simgrid/kernel/resource/Action.hpp

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