src/kernel/resource/profile/Profile.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_PROFILE_HPP
   7 #define SIMGRID_KERNEL_PROFILE_HPP
   8
   9 #include "simgrid/forward.h"
  10 #include "simgrid/kernel/ProfileBuilder.hpp"
  11 #include "src/kernel/resource/profile/FutureEvtSet.hpp"
  12 #include "src/kernel/resource/profile/StochasticDatedValue.hpp"
  13
  14 #include <queue>
  15 #include <vector>
  16 #include <string>
  17
  18 namespace simgrid::kernel::profile {
  19
  20 /** @brief A profile is a set of timed values, encoding the value that a variable takes at what time
  21  *
  22  * It is useful to model dynamic platforms, where an external load that makes the resource availability change over
  23  * time. To model that, you have to set several profiles per resource: one for the on/off state and one for each
  24  * numerical value (computational speed, bandwidth and/or latency).
  25  *
  26  * There are two behaviours. Either a callback is used to populate the profile when the set has been exhausted,
  27  * or the callback is called only during construction and the initial set is repeated over and over, after a fixed
  28  * repeating delay.
  29  */
  30 class XBT_PUBLIC Profile {
  31 public:
  32   /** @brief Create a profile. There are two behaviours. Either the callback is
  33    *
  34    * @param name The name of the profile (checked for uniqueness)
  35    * @param cb A callback object/function that populates the profile.
  36    * @param repeat_delay If strictly negative, it is ignored and the callback is called when an event reached the end of
  37    * the event_list. If zero or positive, the initial set repeats after the provided delay.
  38    */
  39   explicit Profile(const std::string& name, const std::function<ProfileBuilder::UpdateCb>& cb, double repeat_delay);
  40   virtual ~Profile()=default;
  41   Event* schedule(FutureEvtSet* fes, resource::Resource* resource);
  42   DatedValue next(Event* event);
  43
  44   const std::vector<DatedValue>& get_event_list() const { return event_list; }
  45   const std::string& get_name() const { return name; }
  46   bool is_repeating() const { return repeat_delay>=0;}
  47   double get_repeat_delay() const { return repeat_delay;}
  48
  49 private:
  50   std::string name;
  51   std::function<ProfileBuilder::UpdateCb> cb;
  52   std::vector<DatedValue> event_list;
  53   FutureEvtSet* fes_  = nullptr;
  54   double repeat_delay;
  55
  56   bool get_enough_events(size_t index)
  57   {
  58     if (index >= event_list.size() && cb)
  59       cb(event_list);
  60     return index < event_list.size();
  61   }
  62 };
  63
  64 } // namespace simgrid::kernel::profile
  65
  66 /** Module finalizer: frees all profiles */
  67 XBT_PUBLIC void tmgr_finalize();
  68
  69 #endif