src/kernel/resource/Resource.hpp

   1 /* Copyright (c) 2004-2022. 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_RESOURCE_HPP
   7 #define SIMGRID_KERNEL_RESOURCE_RESOURCE_HPP
   8
   9 #include "simgrid/forward.h"
  10 #include "src/kernel/lmm/maxmin.hpp" // Constraint
  11 #include "src/kernel/resource/profile/Event.hpp"
  12 #include "src/kernel/resource/profile/FutureEvtSet.hpp"
  13 #include "src/kernel/resource/profile/Profile.hpp"
  14 #include "xbt/signal.hpp"
  15 #include "xbt/str.h"
  16 #include "xbt/utility.hpp"
  17
  18 #include <string>
  19
  20 namespace simgrid::kernel::resource {
  21
  22 /** @ingroup SURF_interface
  23  * @brief SURF resource interface class
  24  * @details This is the ancestor class of every resources in SimGrid, such as links, CPU or disk
  25  */
  26 class XBT_PUBLIC Resource {
  27   std::string name_            = "unnamed";
  28   bool is_on_                  = true;
  29   bool sealed_                 = false;
  30   profile::Event* state_event_ = nullptr;
  31
  32 protected:
  33   struct Metric {
  34     double peak;           /**< The peak of the metric, ie its max value */
  35     double scale;          /**< Current availability of the metric according to the profiles, in [0,1] */
  36     profile::Event* event; /**< The associated profile event associated to the metric */
  37   };
  38
  39   virtual profile::Event* get_state_event() const { return state_event_; }
  40   virtual void set_state_event(profile::Event* evt) { state_event_ = evt; }
  41   virtual void unref_state_event() { tmgr_trace_event_unref(&state_event_); }
  42
  43 public:
  44   explicit Resource(const std::string& name) : name_(name){};
  45   virtual ~Resource() = default;
  46   virtual void seal() { sealed_ = true; }
  47
  48   /** @brief Get the name of the current Resource */
  49   const std::string& get_name() const { return name_; }
  50   /** @brief Get the name of the current Resource */
  51   const char* get_cname() const { return name_.c_str(); }
  52
  53   bool operator==(const Resource& other) const { return name_ == other.name_; }
  54
  55   /** @brief Apply an event of external load event to that resource */
  56   virtual void apply_event(profile::Event* event, double value) = 0;
  57
  58   /** @brief Check if the current Resource is active */
  59   virtual bool is_on() const { return is_on_; }
  60   virtual bool is_sealed() const { return sealed_; }
  61
  62   /** @brief Check if the current Resource is used (if it currently serves an action) */
  63   virtual bool is_used() const = 0;
  64   /** @brief Turn on the current Resource */
  65   virtual void turn_on() { is_on_ = true; }
  66   /** @brief Turn off the current Resource */
  67   virtual void turn_off() { is_on_ = false; }
  68 };
  69
  70 template <class AnyResource> class Resource_T : public Resource {
  71   Model* model_                = nullptr;
  72   lmm::Constraint* constraint_ = nullptr;
  73
  74 public:
  75   using Resource::Resource;
  76   /** @brief setup the profile file with states events (ON or OFF). The profile must contain boolean values. */
  77   AnyResource* set_state_profile(profile::Profile* profile)
  78   {
  79     if (profile) {
  80       xbt_assert(get_state_event() == nullptr, "Cannot set a second state profile to %s", get_cname());
  81       set_state_event(profile->schedule(&profile::future_evt_set, this));
  82     }
  83
  84     return static_cast<AnyResource*>(this);
  85   }
  86
  87   AnyResource* set_model(Model* model)
  88   {
  89     model_ = model;
  90     return static_cast<AnyResource*>(this);
  91   }
  92
  93   Model* get_model() const { return model_; }
  94
  95   AnyResource* set_constraint(lmm::Constraint* constraint)
  96   {
  97     constraint_ = constraint;
  98     return static_cast<AnyResource*>(this);
  99   }
 100
 101   lmm::Constraint* get_constraint() const { return constraint_; }
 102
 103   /** @brief returns the current load due to activities (in flops per second, byte per second or similar)
 104    *
 105    * The load due to external usages modeled by profile files is ignored.*/
 106   virtual double get_load() const { return constraint_->get_usage(); }
 107
 108   bool is_used() const override { return model_->get_maxmin_system()->constraint_used(constraint_); }
 109 };
 110
 111 } // namespace simgrid::kernel::resource
 112
 113 namespace std {
 114 template <> class hash<simgrid::kernel::resource::Resource> {
 115 public:
 116   std::size_t operator()(const simgrid::kernel::resource::Resource& r) const
 117   {
 118     return (std::size_t)xbt_str_hash(r.get_cname());
 119   }
 120 };
 121 } // namespace std
 122
 123 #endif