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