include/simgrid/s4u/Host.hpp

   1 /* Copyright (c) 2006-2023. 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_S4U_HOST_HPP
   7 #define SIMGRID_S4U_HOST_HPP
   8
   9 #include <simgrid/forward.h>
  10 #include <simgrid/kernel/resource/Action.hpp>
  11 #include <xbt/Extendable.hpp>
  12 #include <xbt/signal.hpp>
  13
  14 #include <map>
  15 #include <unordered_map>
  16
  17 namespace simgrid {
  18
  19 extern template class XBT_PUBLIC xbt::Extendable<s4u::Host>;
  20
  21 namespace s4u {
  22 /** @ingroup s4u_api
  23  *
  24  * @tableofcontents
  25  *
  26  * Some physical resource with computing and networking capabilities on which Actors execute.
  27  *
  28  * @beginrst
  29  * All hosts are automatically created during the call of the method
  30  * :cpp:func:`simgrid::s4u::Engine::load_platform()`.
  31  * You cannot create a host yourself.
  32  *
  33  * You can retrieve a particular host using :cpp:func:`simgrid::s4u::Host::by_name()`
  34  * and actors can retrieve the host on which they run using :cpp:func:`simgrid::s4u::Host::current()` or
  35  * :cpp:func:`simgrid::s4u::this_actor::get_host()`
  36  * @endrst
  37  */
  38 class XBT_PUBLIC Host : public xbt::Extendable<Host> {
  39 #ifndef DOXYGEN
  40   friend kernel::resource::VMModel;            // Use the pimpl_cpu to compute the VM sharing
  41   friend kernel::resource::VirtualMachineImpl; // creates the the pimpl_cpu
  42   friend kernel::routing::NetZoneImpl;
  43   friend kernel::resource::HostImpl; // call destructor from private implementation
  44
  45   // The private implementation, that never changes
  46   kernel::resource::HostImpl* const pimpl_;
  47
  48   kernel::resource::CpuImpl* pimpl_cpu_      = nullptr;
  49   kernel::routing::NetPoint* pimpl_netpoint_ = nullptr;
  50 #ifndef DOXYGEN
  51   friend kernel::resource::CpuAction; // signal exec_state_changed
  52 #endif
  53
  54 public:
  55   explicit Host(kernel::resource::HostImpl* pimpl) : pimpl_(pimpl) {}
  56
  57 protected:
  58   virtual ~Host(); // Call destroy() instead of manually deleting it.
  59   Host* set_netpoint(kernel::routing::NetPoint* netpoint);
  60
  61   static xbt::signal<void(Host&)> on_creation;
  62   static xbt::signal<void(Host const&)> on_destruction;
  63   xbt::signal<void(Host const&)> on_this_destruction;
  64   static xbt::signal<void(kernel::resource::CpuAction&, kernel::resource::Action::State)> on_exec_state_change;
  65
  66 public:
  67   static xbt::signal<void(Host const&)> on_speed_change;
  68   xbt::signal<void(Host const&)> on_this_speed_change;
  69   static xbt::signal<void(Host const&)> on_state_change;
  70   xbt::signal<void(Host const&)> on_this_state_change;
  71
  72 #endif
  73   /** Add a callback fired on each newly created host */
  74   static void on_creation_cb(const std::function<void(Host&)>& cb) { on_creation.connect(cb); }
  75   /** Add a callback fired when any machine is turned on or off (called AFTER the change) */
  76   static void on_state_change_cb(const std::function<void(Host const&)>& cb) { on_state_change.connect(cb); }
  77   /** Add a callback fired when this specific machine is turned on or off (called AFTER the change) */
  78   void on_this_state_change_cb(const std::function<void(Host const&)>& cb)
  79   {
  80     on_this_state_change.connect(cb);
  81   }
  82   /** Add a callback fired when the speed of any machine is changed (called AFTER the change)
  83    * (either because of a pstate switch or because of an external load event coming from the profile) */
  84   static void on_speed_change_cb(const std::function<void(Host const&)>& cb) { on_speed_change.connect(cb); }
  85   /** Add a callback fired when the speed of this specific machine is changed (called AFTER the change)
  86    * (either because of a pstate switch or because of an external load event coming from the profile) */
  87   void on_this_speed_change_cb(const std::function<void(Host const&)>& cb)
  88   {
  89     on_this_speed_change.connect(cb);
  90   }
  91   /** Add a callback fired just before destructing any host */
  92   static void on_destruction_cb(const std::function<void(Host const&)>& cb) { on_destruction.connect(cb); }
  93   /** Add a callback fired just before destructing this specific host */
  94   void on_this_destruction_cb(const std::function<void(Host const&)>& cb)
  95   {
  96     on_this_destruction.connect(cb);
  97   }
  98   /** Add a callback fired when the state of any exec activity changes */
  99   static void on_exec_state_change_cb(
 100       const std::function<void(kernel::resource::CpuAction&, kernel::resource::Action::State previous)>& cb)
 101   {
 102     on_exec_state_change.connect(cb);
 103   }
 104
 105   virtual void destroy();
 106 #ifndef DOXYGEN
 107   // No copy/move
 108   Host(Host const&) = delete;
 109   Host& operator=(Host const&) = delete;
 110 #endif
 111
 112   /** Retrieve a host from its name, or return nullptr */
 113   static Host* by_name_or_null(const std::string& name);
 114   /** Retrieve a host from its name, or die */
 115   static Host* by_name(const std::string& name);
 116   /** Retrieves the host on which the running actor is located */
 117   static Host* current();
 118
 119   /** Retrieves the name of that host as a C++ string */
 120   std::string const& get_name() const;
 121   /** Retrieves the name of that host as a C string */
 122   const char* get_cname() const;
 123
 124   Host* set_cpu(kernel::resource::CpuImpl* cpu);
 125   kernel::resource::CpuImpl* get_cpu() const { return pimpl_cpu_; }
 126   kernel::routing::NetPoint* get_netpoint() const { return pimpl_netpoint_; }
 127   /**
 128    * @brief Callback to set CPU factor
 129    *
 130    * This callback offers a flexible way to create variability in CPU executions
 131    *
 132    * @param flops Execution size in flops
 133    * @return Multiply factor
 134    */
 135   using CpuFactorCb = double(double flops);
 136   /**
 137    * @brief Configure the factor callback to the CPU associated to this host
 138    */
 139   Host* set_factor_cb(const std::function<CpuFactorCb>& cb);
 140
 141   size_t get_actor_count() const;
 142   std::vector<ActorPtr> get_all_actors() const;
 143
 144   /** Turns that host on if it was previously off
 145    *
 146    * This call does nothing if the host is already on. If it was off, all actors which were marked 'autorestart' on that
 147    * host will be restarted automatically (note that this may differ from the actors that were initially running on the
 148    * host).
 149    *
 150    * All other Host's properties are left unchanged; in particular, the pstate is left unchanged and not reset to its
 151    * initial value.
 152    */
 153   void turn_on();
 154   /** Turns that host off. All actors are forcefully stopped. */
 155   void turn_off();
 156   /** Returns if that host is currently up and running */
 157   bool is_on() const;
 158
 159   const char* get_property(const std::string& key) const;
 160   Host* set_property(const std::string& key, const std::string& value);
 161   const std::unordered_map<std::string, std::string>* get_properties() const;
 162   Host* set_properties(const std::unordered_map<std::string, std::string>& properties);
 163
 164   Host* set_state_profile(kernel::profile::Profile* p);
 165   Host* set_speed_profile(kernel::profile::Profile* p);
 166
 167   /**
 168    * @brief Set the max amount of executions that can take place on this host at the same time
 169    *
 170    * Use -1 to set no limit.
 171    */
 172   Host* set_concurrency_limit(int limit);
 173   int get_concurrency_limit() const;
 174
 175   /** @brief Convert the CPU's speed from string to double */
 176   static std::vector<double> convert_pstate_speed_vector(const std::vector<std::string>& speed_per_state);
 177   /**
 178    * @brief Set the CPU's speed
 179    *
 180    * @param speed_per_state list of powers for this processor (default power is at index 0)
 181    */
 182   Host* set_pstate_speed(const std::vector<double>& speed_per_state);
 183   /**
 184    * @brief Set the CPU's speed (string version)
 185    *
 186    * @throw std::invalid_argument if speed format is incorrect.
 187    */
 188   Host* set_pstate_speed(const std::vector<std::string>& speed_per_state);
 189
 190   /** @brief Get the peak computing speed in flops/s at the current pstate, NOT taking the external load into account.
 191    *
 192    *  The amount of flops per second available for computing depends on several things:
 193    *    - The current pstate determines the maximal peak computing speed (use
 194    *      @verbatim embed:rst:inline :cpp:func:`get_pstate_speed() <simgrid::s4u::Host::get_pstate_speed>` @endverbatim
 195    *      to retrieve the computing speed you would get at another pstate)
 196    *    - If you declared an external load (with
 197    *      @verbatim embed:rst:inline :cpp:func:`set_speed_profile() <simgrid::s4u::Host::set_speed_profile>` @endverbatim ),
 198    *      you must multiply the result of
 199    *      @verbatim embed:rst:inline :cpp:func:`get_speed() <simgrid::s4u::Host::get_speed>` @endverbatim by
 200    *      @verbatim embed:rst:inline :cpp:func:`get_available_speed() <simgrid::s4u::Host::get_available_speed>` @endverbatim
 201    *      to retrieve what a new computation would get.
 202    *
 203    *  The remaining speed is then shared between the executions located on this host.
 204    *  You can retrieve the amount of tasks currently running on this host with
 205    *  @verbatim embed:rst:inline :cpp:func:`get_load() <simgrid::s4u::Host::get_load>` @endverbatim .
 206    *
 207    *  The host may have multiple cores, and your executions may be able to use more than a single core.
 208    *
 209    *  Finally, executions of priority 2 get twice the amount of flops than executions of priority 1.
 210    */
 211   double get_speed() const;
 212   /** @brief Get the available speed ratio, between 0 and 1.
 213    *
 214    * This accounts for external load (see
 215    * @verbatim embed:rst:inline :cpp:func:`set_speed_profile() <simgrid::s4u::Host::set_speed_profile>` @endverbatim ).
 216    */
 217   double get_available_speed() const;
 218
 219   /** Returns the number of core of the processor. */
 220   int get_core_count() const;
 221   Host* set_core_count(int core_count);
 222
 223   enum class SharingPolicy { NONLINEAR = 1, LINEAR = 0 };
 224   /**
 225    * @brief Describes how the CPU is shared between concurrent tasks
 226    *
 227    * Note that the NONLINEAR callback is in the critical path of the solver, so it should be fast.
 228    *
 229    * @param policy Sharing policy
 230    * @param cb Callback for NONLINEAR policies
 231    */
 232   Host* set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {});
 233   SharingPolicy get_sharing_policy() const;
 234
 235   /** Returns the current computation load (in flops per second)
 236    *
 237    * The external load (coming from an availability trace) is not taken in account.
 238    * You may also be interested in the load plugin.
 239    */
 240   double get_load() const;
 241
 242   unsigned long get_pstate_count() const;
 243   unsigned long get_pstate() const;
 244   double get_pstate_speed(unsigned long pstate_index) const;
 245   Host* set_pstate(unsigned long pstate_index);
 246   Host* set_coordinates(const std::string& coords);
 247
 248   std::vector<Disk*> get_disks() const;
 249   /**
 250    * @brief Create and add disk in the host
 251    *
 252    * @param name Disk name
 253    * @param read_bandwidth Reading speed of the disk
 254    * @param write_bandwidth Writing speed of the disk
 255    */
 256   Disk* create_disk(const std::string& name, double read_bandwidth, double write_bandwidth);
 257   /**
 258    * @brief Human-friendly version of create_disk function.
 259    *
 260    * @throw std::invalid_argument if read/write speeds are incorrect
 261    */
 262   Disk* create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth);
 263   void add_disk(const Disk* disk);
 264   void remove_disk(const std::string& disk_name);
 265
 266   VirtualMachine* create_vm(const std::string& name, int core_amount);
 267   VirtualMachine* create_vm(const std::string& name, int core_amount, size_t ramsize);
 268   /** Retrieve a VM running on this host from its name, or return nullptr */
 269   VirtualMachine* vm_by_name_or_null(const std::string& name);
 270
 271   void route_to(const Host* dest, std::vector<Link*>& links, double* latency) const;
 272   void route_to(const Host* dest, std::vector<kernel::resource::StandardLinkImpl*>& links, double* latency) const;
 273   std::pair<std::vector<Link*>, double> route_to(const Host* dest) const;
 274
 275   /**
 276    * @brief Seal this host
 277    * No more configuration is allowed after the seal
 278    */
 279   Host* seal();
 280
 281   NetZone* get_englobing_zone() const;
 282   /** Block the calling actor on an execution located on the called host
 283    *
 284    * It is not a problem if the actor is not located on the called host.
 285    * The actor will not be migrated in this case. Such remote execution are easy in simulation.
 286    */
 287   void execute(double flops) const;
 288   /** Start an asynchronous computation on that host (possibly remote) */
 289   ExecPtr exec_init(double flops_amounts) const;
 290   ExecPtr exec_async(double flops_amounts) const;
 291
 292   /** Block the calling actor on an execution located on the called host (with explicit priority) */
 293   void execute(double flops, double priority) const;
 294   kernel::resource::HostImpl* get_impl() const { return pimpl_; }
 295 };
 296 } // namespace s4u
 297 } // namespace simgrid
 298
 299 #endif /* SIMGRID_S4U_HOST_HPP */