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