include/simgrid/s4u/Host.hpp

   1 /* Copyright (c) 2006-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_S4U_HOST_HPP
   7 #define SIMGRID_S4U_HOST_HPP
   8
   9 #include <simgrid/forward.h>
  10 #include <xbt/Extendable.hpp>
  11 #include <xbt/signal.hpp>
  12 #include <xbt/string.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 vm::VMModel;            // Use the pimpl_cpu to compute the VM sharing
  41   friend vm::VirtualMachineImpl; // creates the the pimpl_cpu
  42   friend kernel::routing::NetZoneImpl;
  43   friend surf::HostImpl; // call destructor from private implementation
  44
  45   // The private implementation, that never changes
  46   surf::HostImpl* const pimpl_;
  47
  48 public:
  49   explicit Host(surf::HostImpl* pimpl) : pimpl_(pimpl) {}
  50
  51 protected:
  52   virtual ~Host(); // Call destroy() instead of manually deleting it.
  53   Host* set_netpoint(kernel::routing::NetPoint* netpoint);
  54 #endif
  55
  56 public:
  57   /** Called on each newly created host */
  58   static xbt::signal<void(Host&)> on_creation;
  59   /** Called just before destructing a host */
  60   static xbt::signal<void(Host const&)> on_destruction;
  61   /** Called when the machine is turned on or off (called AFTER the change) */
  62   static xbt::signal<void(Host const&)> on_state_change;
  63   /** Called when the speed of the machine is changed (called AFTER the change)
  64    * (either because of a pstate switch or because of an external load event coming from the profile) */
  65   static xbt::signal<void(Host const&)> on_speed_change;
  66
  67   virtual void destroy();
  68 #ifndef DOXYGEN
  69   // No copy/move
  70   Host(Host const&) = delete;
  71   Host& operator=(Host const&) = delete;
  72 #endif
  73
  74   /** Retrieve a host from its name, or return nullptr */
  75   static Host* by_name_or_null(const std::string& name);
  76   /** Retrieve a host from its name, or die */
  77   static Host* by_name(const std::string& name);
  78   /** Retrieves the host on which the running actor is located */
  79   static Host* current();
  80
  81   /** Retrieves the name of that host as a C++ string */
  82   xbt::string const& get_name() const;
  83   /** Retrieves the name of that host as a C string */
  84   const char* get_cname() const;
  85
  86   kernel::routing::NetPoint* get_netpoint() const { return pimpl_netpoint_; }
  87
  88   int get_actor_count() const;
  89   std::vector<ActorPtr> get_all_actors() const;
  90
  91   /** Turns that host on if it was previously off
  92    *
  93    * This call does nothing if the host is already on. If it was off, all actors which were marked 'autorestart' on that
  94    * host will be restarted automatically (note that this may differ from the actors that were initially running on the
  95    * host).
  96    *
  97    * All other Host's properties are left unchanged; in particular, the pstate is left unchanged and not reset to its
  98    * initial value.
  99    */
 100   void turn_on();
 101   /** Turns that host off. All actors are forcefully stopped. */
 102   void turn_off();
 103   /** Returns if that host is currently up and running */
 104   bool is_on() const;
 105
 106   const char* get_property(const std::string& key) const;
 107   Host* set_property(const std::string& key, const std::string& value);
 108   const std::unordered_map<std::string, std::string>* get_properties() const;
 109   Host* set_properties(const std::unordered_map<std::string, std::string>& properties);
 110
 111   Host* set_state_profile(kernel::profile::Profile* p);
 112   Host* set_speed_profile(kernel::profile::Profile* p);
 113
 114   /** @brief Convert the CPU's speed from string to double */
 115   static std::vector<double> convert_pstate_speed_vector(const std::vector<std::string>& speed_per_state);
 116   /**
 117    * @brief Set the CPU's speed
 118    *
 119    * @param speed_per_state list of powers for this processor (default power is at index 0)
 120    */
 121   Host* set_pstate_speed(const std::vector<double>& speed_per_state);
 122   /**
 123    * @brief Set the CPU's speed (string version)
 124    *
 125    * @throw std::invalid_argument if speed format is incorrect.
 126    */
 127   Host* set_pstate_speed(const std::vector<std::string>& speed_per_state);
 128
 129   /** @brief Get the peak computing speed in flops/s at the current pstate, NOT taking the external load into account.
 130    *
 131    *  The amount of flops per second available for computing depends on several things:
 132    *    - The current pstate determines the maximal peak computing speed (use @ref get_pstate_speed() to retrieve the
 133    *      computing speed you would get at another pstate)
 134    *    - If you declared an external load (with @ref simgrid::surf::Cpu::set_speed_profile()), you must multiply the
 135    * result of get_speed() by get_available_speed() to retrieve what a new computation would get.
 136    *
 137    *  The remaining speed is then shared between the executions located on this host.
 138    *  You can retrieve the amount of tasks currently running on this host with @ref get_load().
 139    *
 140    *  The host may have multiple cores, and your executions may be able to use more than a single core.
 141    *
 142    *  Finally, executions of priority 2 get twice the amount of flops than executions of priority 1.
 143    */
 144   double get_speed() const;
 145   /** @brief Get the available speed ratio, between 0 and 1.
 146    *
 147    * This accounts for external load (see @ref simgrid::surf::Cpu::set_speed_profile()).
 148    */
 149   double get_available_speed() const;
 150
 151   /** Returns the number of core of the processor. */
 152   int get_core_count() const;
 153   Host* set_core_count(int core_count);
 154
 155   /** Returns the current computation load (in flops per second)
 156    *
 157    * The external load (coming from an availability trace) is not taken in account.
 158    * You may also be interested in the load plugin.
 159    */
 160   double get_load() const;
 161
 162   int get_pstate_count() const;
 163   int get_pstate() const;
 164   double get_pstate_speed(int pstate_index) const;
 165   Host* set_pstate(int pstate_index);
 166   Host* set_coordinates(const std::string& coords);
 167
 168   std::vector<Disk*> get_disks() const;
 169   /**
 170    * @brief Create and add disk in the host
 171    *
 172    * @param name Disk name
 173    * @param read_bandwidth Reading speed of the disk
 174    * @param write_bandwidth Writing speed of the disk
 175    */
 176   Disk* create_disk(const std::string& name, double read_bandwidth, double write_bandwidth);
 177   /**
 178    * @brief Human-friendly version of create_disk function.
 179    *
 180    * @throw std::invalid_argument if read/write speeds are incorrect
 181    */
 182   Disk* create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth);
 183   void add_disk(const Disk* disk);
 184   void remove_disk(const std::string& disk_name);
 185
 186   void route_to(const Host* dest, std::vector<Link*>& links, double* latency) const;
 187   void route_to(const Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency) const;
 188
 189   /**
 190    * @brief Seal this host
 191    * No more configuration is allowed after the seal
 192    */
 193   Host* seal();
 194
 195 #ifndef DOXYGEN
 196   XBT_ATTRIB_DEPRECATED_v331("Please use Comm::sendto()") void sendto(Host* dest, double byte_amount);
 197
 198   XBT_ATTRIB_DEPRECATED_v331("Please use Comm::sendto_async()") CommPtr sendto_async(Host* dest, double byte_amount);
 199
 200   XBT_ATTRIB_DEPRECATED_v330("Please use Host::sendto()") void send_to(Host* dest, double byte_amount);
 201 #endif
 202
 203   NetZone* get_englobing_zone();
 204   /** Block the calling actor on an execution located on the called host
 205    *
 206    * It is not a problem if the actor is not located on the called host.
 207    * The actor will not be migrated in this case. Such remote execution are easy in simulation.
 208    */
 209   void execute(double flops) const;
 210   /** Start an asynchronous computation on that host (possibly remote) */
 211   ExecPtr exec_init(double flops_amounts) const;
 212   ExecPtr exec_async(double flops_amounts) const;
 213
 214   /** Block the calling actor on an execution located on the called host (with explicit priority) */
 215   void execute(double flops, double priority) const;
 216   surf::HostImpl* get_impl() const { return pimpl_; }
 217
 218 private:
 219   kernel::routing::NetPoint* pimpl_netpoint_ = nullptr;
 220
 221 public:
 222 #ifndef DOXYGEN
 223   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
 224   kernel::resource::Cpu* pimpl_cpu = nullptr;
 225 #endif
 226 };
 227 } // namespace s4u
 228 } // namespace simgrid
 229
 230 #endif /* SIMGRID_S4U_HOST_HPP */