1 /* Copyright (c) 2004-2022. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_KERNEL_RESOURCE_RESOURCE_HPP
7 #define SIMGRID_KERNEL_RESOURCE_RESOURCE_HPP
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"
16 #include "xbt/utility.hpp"
24 /** @ingroup SURF_interface
25 * @brief SURF resource interface class
26 * @details This is the ancestor class of every resources in SimGrid, such as links, CPU or disk
28 class XBT_PUBLIC Resource {
29 std::string name_ = "unnamed";
32 profile::Event* state_event_ = nullptr;
36 double peak; /**< The peak of the metric, ie its max value */
37 double scale; /**< Current availability of the metric according to the profiles, in [0,1] */
38 profile::Event* event; /**< The associated profile event associated to the metric */
41 virtual profile::Event* get_state_event() const { return state_event_; }
42 virtual void set_state_event(profile::Event* evt) { state_event_ = evt; }
43 virtual void unref_state_event() { tmgr_trace_event_unref(&state_event_); }
46 explicit Resource(const std::string& name) : name_(name){};
47 virtual ~Resource() = default;
48 virtual void seal() { sealed_ = true; }
50 /** @brief Get the name of the current Resource */
51 const std::string& get_name() const { return name_; }
52 /** @brief Get the name of the current Resource */
53 const char* get_cname() const { return name_.c_str(); }
55 bool operator==(const Resource& other) const { return name_ == other.name_; }
57 /** @brief Apply an event of external load event to that resource */
58 virtual void apply_event(profile::Event* event, double value) = 0;
60 /** @brief Check if the current Resource is active */
61 virtual bool is_on() const { return is_on_; }
62 virtual bool is_sealed() const { return sealed_; }
64 /** @brief Check if the current Resource is used (if it currently serves an action) */
65 virtual bool is_used() const = 0;
66 /** @brief Turn on the current Resource */
67 virtual void turn_on() { is_on_ = true; }
68 /** @brief Turn off the current Resource */
69 virtual void turn_off() { is_on_ = false; }
72 template <class AnyResource> class Resource_T : public Resource {
73 Model* model_ = nullptr;
74 lmm::Constraint* constraint_ = nullptr;
77 using Resource::Resource;
78 /** @brief setup the profile file with states events (ON or OFF). The profile must contain boolean values. */
79 AnyResource* set_state_profile(profile::Profile* profile)
82 xbt_assert(get_state_event() == nullptr, "Cannot set a second state profile to %s", get_cname());
83 set_state_event(profile->schedule(&profile::future_evt_set, this));
86 return static_cast<AnyResource*>(this);
89 AnyResource* set_model(Model* model)
92 return static_cast<AnyResource*>(this);
95 Model* get_model() const { return model_; }
97 AnyResource* set_constraint(lmm::Constraint* constraint)
99 constraint_ = constraint;
100 return static_cast<AnyResource*>(this);
103 lmm::Constraint* get_constraint() const { return constraint_; }
105 /** @brief returns the current load due to activities (in flops per second, byte per second or similar)
107 * The load due to external usages modeled by profile files is ignored.*/
108 virtual double get_load() const { return constraint_->get_usage(); }
110 bool is_used() const override { return model_->get_maxmin_system()->constraint_used(constraint_); }
113 } // namespace resource
114 } // namespace kernel
115 } // namespace simgrid
118 template <> class hash<simgrid::kernel::resource::Resource> {
120 std::size_t operator()(const simgrid::kernel::resource::Resource& r) const
122 return (std::size_t)xbt_str_hash(r.get_cname());