1 /* Copyright (c) 2004-2018. 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 "src/surf/surf_interface.hpp"
15 /** @ingroup SURF_interface
16 * @brief SURF resource interface class
17 * @details This is the ancestor class of every resources in SimGrid, such as links, CPU or storage
19 XBT_PUBLIC_CLASS Resource
23 * @brief Constructor of LMM Resources
25 * @param model Model associated to this Resource
26 * @param name The name of the Resource
27 * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
29 Resource(Model * model, const std::string& name, lmm::Constraint* constraint);
33 /** @brief Get the Model of the current Resource */
36 /** @brief Get the name of the current Resource */
37 const std::string& getName() const;
38 /** @brief Get the name of the current Resource */
39 const char* getCname() const;
41 bool operator==(const Resource& other) const;
44 * @brief Apply an event of external load event to that resource
46 * @param event What happened
49 virtual void apply_event(tmgr_trace_event_t event, double value) = 0;
51 /** @brief Check if the current Resource is used (if it currently serves an action) */
52 virtual bool isUsed() = 0;
54 /** @brief returns the current load (in flops per second, byte per second or similar) */
55 virtual double getLoad();
57 /** @brief Check if the current Resource is active */
58 virtual bool isOn() const;
59 /** @brief Check if the current Resource is shut down */
60 virtual bool isOff() const;
61 /** @brief Turn on the current Resource */
62 virtual void turnOn();
63 /** @brief Turn off the current Resource */
64 virtual void turnOff();
72 /** @brief Get the lmm constraint associated to this Resource if it is part of a LMM component (or null if none) */
73 kernel::lmm::Constraint* constraint() const;
76 kernel::lmm::Constraint* const constraint_ = nullptr;
80 double peak; /**< The peak of the metric, ie its max value */
81 double scale; /**< Current availability of the metric according to the traces, in [0,1] */
82 tmgr_trace_event_t event; /**< The associated trace event associated to the metric */
85 } // namespace resource
87 } // namespace simgrid
90 template <> class hash<simgrid::kernel::resource::Resource> {
92 std::size_t operator()(const simgrid::kernel::resource::Resource& r) const
94 return (std::size_t)xbt_str_hash(r.getCname());