include/simgrid/kernel/resource/Model.hpp

   1 /* Copyright (c) 2004-2020. 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_MODEL_HPP
   7 #define SIMGRID_KERNEL_RESOURCE_MODEL_HPP
   8
   9 #include <memory>
  10 #include <simgrid/kernel/resource/Action.hpp>
  11
  12 namespace simgrid {
  13 namespace kernel {
  14 namespace resource {
  15
  16 /** @ingroup SURF_interface
  17  * @brief SURF model interface class
  18  * @details A model is an object which handle the interactions between its Resources and its Actions
  19  */
  20 class XBT_PUBLIC Model {
  21 public:
  22   /** @brief Possible update mechanisms */
  23   enum class UpdateAlgo {
  24     FULL, /**< Full update mechanism: the remaining time of every action is recomputed at each step */
  25     LAZY  /**< Lazy update mechanism: only the modified actions get recomputed.
  26                    It may be slower than full if your system is tightly coupled to the point where every action
  27                    gets recomputed anyway. In that case, you'd better not try to be cleaver with lazy and go for
  28                    a simple full update.  */
  29   };
  30
  31   explicit Model(Model::UpdateAlgo algo);
  32   Model(const Model&) = delete;
  33   Model& operator=(const Model&) = delete;
  34
  35   virtual ~Model();
  36
  37   bool is_update_lazy() { return update_algorithm_ == UpdateAlgo::LAZY; }
  38
  39   /** @brief Get the set of [actions](@ref Action) in *inited* state */
  40   Action::StateSet* get_inited_action_set() { return &inited_action_set_; }
  41
  42   /** @brief Get the set of [actions](@ref Action) in *started* state */
  43   Action::StateSet* get_started_action_set() { return &started_action_set_; }
  44
  45   /** @brief Get the set of [actions](@ref Action) in *failed* state */
  46   Action::StateSet* get_failed_action_set() { return &failed_action_set_; }
  47
  48   /** @brief Get the set of [actions](@ref Action) in *finished* state */
  49   Action::StateSet* get_finished_action_set() { return &finished_action_set_; }
  50
  51   /** @brief Get the set of [actions](@ref Action) in *ignored* state */
  52   Action::StateSet* get_ignored_action_set() { return &ignored_action_set_; }
  53
  54   /** @brief Get the set of modified [actions](@ref Action) */
  55   Action::ModifiedSet* get_modified_set() const;
  56
  57   /** @brief Get the maxmin system of the current Model */
  58   lmm::System* get_maxmin_system() const { return maxmin_system_.get(); }
  59
  60   /** @brief Set the maxmin system of the current Model */
  61   void set_maxmin_system(lmm::System* system);
  62
  63   /** @brief Get the update algorithm of the current Model */
  64   XBT_ATTRIB_DEPRECATED_v329("Please use is_update_lazy()") UpdateAlgo get_update_algorithm() const
  65   {
  66     return update_algorithm_;
  67   }
  68
  69   /** @brief Get Action heap */
  70   ActionHeap& get_action_heap() { return action_heap_; }
  71
  72   /**
  73    * @brief Share the resources between the actions
  74    *
  75    * @param now The current time of the simulation
  76    * @return The delta of time till the next action will finish
  77    */
  78   virtual double next_occurring_event(double now);
  79   virtual double next_occurring_event_lazy(double now);
  80   virtual double next_occurring_event_full(double now);
  81
  82   XBT_ATTRIB_DEPRECATED_v329("Please use next_occurring_event()") virtual double next_occuring_event(double now) final
  83   {
  84     return next_occurring_event(now);
  85   }
  86   XBT_ATTRIB_DEPRECATED_v329("Please use next_occurring_event_lazy()") virtual double next_occuring_event_lazy(
  87       double now) final
  88   {
  89     return next_occurring_event_lazy(now);
  90   }
  91   XBT_ATTRIB_DEPRECATED_v329("Please use next_occurring_event_full()") virtual double next_occuring_event_full(
  92       double now) final
  93   {
  94     return next_occurring_event_full(now);
  95   }
  96
  97 private:
  98   Action* extract_action(Action::StateSet* list);
  99
 100 public:
 101   Action* extract_done_action();
 102   Action* extract_failed_action();
 103
 104   /**
 105    * @brief Update action to the current time
 106    *
 107    * @param now The current time of the simulation
 108    * @param delta The delta of time since the last update
 109    */
 110   virtual void update_actions_state(double now, double delta);
 111   virtual void update_actions_state_lazy(double now, double delta);
 112   virtual void update_actions_state_full(double now, double delta);
 113
 114   /** @brief Returns whether this model have an idempotent share_resource()
 115    *
 116    * The only model that is not is ns-3: computing the next timestamp moves the model up to that point,
 117    * so we need to call it only when the next timestamp of other sources is computed.
 118    */
 119   virtual bool next_occurring_event_is_idempotent() { return true; }
 120
 121   XBT_ATTRIB_DEPRECATED_v329(
 122       "Please use next_occurring_event_is_idempotent()") virtual bool next_occuring_event_is_idempotent() final
 123   {
 124     return next_occurring_event_is_idempotent();
 125   }
 126
 127 private:
 128   std::unique_ptr<lmm::System> maxmin_system_;
 129   const UpdateAlgo update_algorithm_;
 130   Action::StateSet inited_action_set_;   /**< Created not started */
 131   Action::StateSet started_action_set_;  /**< Started not done */
 132   Action::StateSet failed_action_set_;   /**< Done with failure */
 133   Action::StateSet finished_action_set_; /**< Done successful */
 134   Action::StateSet ignored_action_set_;  /**< not considered (failure detectors?) */
 135
 136   ActionHeap action_heap_;
 137 };
 138
 139 } // namespace resource
 140 } // namespace kernel
 141 } // namespace simgrid
 142
 143 /** @ingroup SURF_models
 144  *  @brief List of initialized models
 145  */
 146 XBT_PUBLIC_DATA std::vector<simgrid::kernel::resource::Model*> all_existing_models;
 147
 148 #endif