include/simgrid/s4u/Host.hpp

   1 /* Copyright (c) 2006-2020. 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 namespace xbt {
  20 extern template class XBT_PUBLIC Extendable<s4u::Host>;
  21 } // namespace xbt
  22
  23 namespace s4u {
  24 /** @ingroup s4u_api
  25  *
  26  * @tableofcontents
  27  *
  28  * Some physical resource with computing and networking capabilities on which Actors execute.
  29  *
  30  * @beginrst
  31  * All hosts are automatically created during the call of the method
  32  * :cpp:func:`simgrid::s4u::Engine::load_platform()`.
  33  * You cannot create a host yourself.
  34  *
  35  * You can retrieve a particular host using :cpp:func:`simgrid::s4u::Host::by_name()`
  36  * and actors can retrieve the host on which they run using :cpp:func:`simgrid::s4u::Host::current()` or
  37  * :cpp:func:`simgrid::s4u::this_actor::get_host()`
  38  * @endrst
  39  */
  40 class XBT_PUBLIC Host : public xbt::Extendable<Host> {
  41   friend vm::VMModel;            // Use the pimpl_cpu to compute the VM sharing
  42   friend vm::VirtualMachineImpl; // creates the the pimpl_cpu
  43   friend kernel::routing::NetZoneImpl;
  44
  45 public:
  46   explicit Host(const std::string& name);
  47
  48   /** Host destruction logic */
  49 protected:
  50   virtual ~Host();
  51   void set_netpoint(kernel::routing::NetPoint* netpoint) { pimpl_netpoint_ = netpoint; }
  52
  53 private:
  54   bool currently_destroying_ = false;
  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   // No copy/move
  69   Host(Host const&) = delete;
  70   Host& operator=(Host const&) = delete;
  71
  72   /** Retrieve a host from its name, or return nullptr */
  73   static Host* by_name_or_null(const std::string& name);
  74   /** Retrieve a host from its name, or die */
  75   static Host* by_name(const std::string& name);
  76   /** Retrieves the host on which the running actor is located */
  77   static Host* current();
  78
  79   /** Retrieves the name of that host as a C++ string */
  80   xbt::string const& get_name() const { return name_; }
  81   /** Retrieves the name of that host as a C string */
  82   const char* get_cname() const { return name_.c_str(); }
  83
  84   kernel::routing::NetPoint* get_netpoint() const { return pimpl_netpoint_; }
  85
  86   int get_actor_count() const;
  87   std::vector<ActorPtr> get_all_actors() const;
  88
  89   /** Turns that host on if it was previously off
  90    *
  91    * This call does nothing if the host is already on. If it was off, all actors which were marked 'autorestart' on that
  92    * host will be restarted automatically (note that this may differ from the actors that were initially running on the
  93    * host).
  94    *
  95    * All other Host's properties are left unchanged; in particular, the pstate is left unchanged and not reset to its
  96    * initial value.
  97    */
  98   void turn_on();
  99   /** Turns that host off. All actors are forcefully stopped. */
 100   void turn_off();
 101   /** Returns if that host is currently up and running */
 102   bool is_on() const;
 103
 104   const char* get_property(const std::string& key) const;
 105   void set_property(const std::string& key, const std::string& value);
 106   const std::unordered_map<std::string, std::string>* get_properties() const;
 107   void set_properties(const std::map<std::string, std::string>& properties);
 108
 109   void set_state_profile(kernel::profile::Profile* p);
 110   void set_speed_profile(kernel::profile::Profile* p);
 111
 112   double get_speed() const;
 113   double get_available_speed() const;
 114   int get_core_count() const;
 115   double get_load() const;
 116
 117   double get_pstate_speed(int pstate_index) const;
 118   int get_pstate_count() const;
 119   void set_pstate(int pstate_index);
 120   int get_pstate() const;
 121
 122   std::vector<Disk*> get_disks() const;
 123   void add_disk(Disk* disk);
 124   void remove_disk(const std::string& disk_name);
 125
 126   std::vector<const char*> get_attached_storages() const;
 127
 128   /** Get an associative list [mount point]->[Storage] of all local mount points.
 129    *
 130    *  This is defined in the platform file, and cannot be modified programmatically (yet).
 131    */
 132   std::unordered_map<std::string, Storage*> const& get_mounted_storages();
 133
 134   void route_to(const Host* dest, std::vector<Link*>& links, double* latency) const;
 135   void route_to(const Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency) const;
 136   void send_to(Host* dest, double byte_amount);
 137
 138   NetZone* get_englobing_zone();
 139   /** Block the calling actor on an execution located on the called host
 140    *
 141    * It is not a problem if the actor is not located on the called host.
 142    * The actor will not be migrated in this case. Such remote execution are easy in simulation.
 143    */
 144   void execute(double flops);
 145   /** Start an asynchronous computation on that host (possibly remote) */
 146   ExecPtr exec_async(double flops_amounts);
 147
 148   /** Block the calling actor on an execution located on the called host (with explicit priority) */
 149   void execute(double flops, double priority);
 150
 151 private:
 152   xbt::string name_{"noname"};
 153   std::unordered_map<std::string, Storage*>* mounts_ = nullptr; // caching
 154   kernel::routing::NetPoint* pimpl_netpoint_         = nullptr;
 155
 156 public:
 157 #ifndef DOXYGEN
 158   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
 159   kernel::resource::Cpu* pimpl_cpu = nullptr;
 160   // TODO, this could be a unique_ptr
 161   surf::HostImpl* pimpl_ = nullptr;
 162 #endif
 163 };
 164 } // namespace s4u
 165 } // namespace simgrid
 166
 167 #endif /* SIMGRID_S4U_HOST_HPP */