include/simgrid/s4u/Host.hpp

   1 /* Copyright (c) 2006-2018. 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<simgrid::s4u::Host>;
  21 }
  22 namespace s4u {
  23
  24 /** @ingroup s4u_api
  25  *
  26  * @tableofcontents
  27  *
  28  * An host represents some physical resource with computing and networking capabilities.
  29  *
  30  * All hosts are automatically created during the call of the method
  31  * @ref simgrid::s4u::Engine::loadPlatform().
  32  * You cannot create a host yourself.
  33  *
  34  * You can retrieve a particular host using simgrid::s4u::Host::byName()
  35  * and actors can retrieve the host on which they run using simgrid::s4u::Host::current().
  36  */
  37 class XBT_PUBLIC Host : public simgrid::xbt::Extendable<Host> {
  38 #ifndef DOXYGEN
  39   friend simgrid::vm::VMModel;            // Use the pimpl_cpu to compute the VM sharing
  40   friend simgrid::vm::VirtualMachineImpl; // creates the the pimpl_cpu
  41 #endif
  42
  43 public:
  44   explicit Host(std::string name);
  45
  46   /** Host destruction logic */
  47 protected:
  48   virtual ~Host();
  49
  50 private:
  51   bool currentlyDestroying_ = false;
  52
  53 public:
  54   /*** Called on each newly created host */
  55   static simgrid::xbt::signal<void(Host&)> on_creation;
  56   /*** Called just before destructing an host */
  57   static simgrid::xbt::signal<void(Host&)> on_destruction;
  58   /*** Called when the machine is turned on or off (called AFTER the change) */
  59   static simgrid::xbt::signal<void(Host&)> on_state_change;
  60   /*** Called when the speed of the machine is changed (called AFTER the change)
  61    * (either because of a pstate switch or because of an external load event coming from the profile) */
  62   static simgrid::xbt::signal<void(Host&)> on_speed_change;
  63
  64   virtual void destroy();
  65   // No copy/move
  66   Host(Host const&) = delete;
  67   Host& operator=(Host const&) = delete;
  68
  69   /** Retrieves an host from its name, or return nullptr */
  70   static Host* by_name_or_null(std::string name);
  71   /** Retrieves an host from its name, or die */
  72   static s4u::Host* by_name(std::string name);
  73   /** Retrieves the host on which the current actor is running */
  74   static s4u::Host* current();
  75
  76   /** Retrieves the name of that host as a C++ string */
  77   simgrid::xbt::string const& get_name() const { return name_; }
  78   /** Retrieves the name of that host as a C string */
  79   const char* get_cname() const { return name_.c_str(); }
  80
  81   int get_actor_count();
  82   std::vector<ActorPtr> get_all_actors();
  83
  84   /** Turns that host on if it was previously off
  85    *
  86    * All actors on that host which were marked autorestart will be restarted automatically.
  87    * This call does nothing if the host is already on.
  88    */
  89   void turn_on();
  90   /** Turns that host off. All actors are forcefully stopped. */
  91   void turn_off();
  92   /** Returns if that host is currently up and running */
  93   bool is_on() const;
  94   /** Returns if that host is currently down and offline */
  95   bool is_off() const { return not is_on(); }
  96
  97   const char* get_property(std::string key) const;
  98   void set_property(std::string key, std::string value);
  99   std::unordered_map<std::string, std::string>* get_properties();
 100
 101 #ifndef DOXYGEN
 102   /** @deprecated See Host::get_properties() */
 103   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_properties()") std::map<std::string, std::string>* getProperties()
 104   {
 105     std::map<std::string, std::string>* res             = new std::map<std::string, std::string>();
 106     std::unordered_map<std::string, std::string>* props = get_properties();
 107     for (auto const& kv : *props)
 108       res->insert(kv);
 109     return res;
 110   }
 111 #endif
 112
 113   double get_speed() const;
 114   double get_available_speed() const;
 115   int get_core_count() const;
 116   double get_load() const;
 117
 118   double get_pstate_speed(int pstate_index) const;
 119   int get_pstate_count() const;
 120   void set_pstate(int pstate_index);
 121   int get_pstate() const;
 122
 123 #ifndef DOXYGEN
 124   /** @deprecated See Host::get_speed() */
 125   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_speed() instead.") double getSpeed() { return get_speed(); }
 126   /** @deprecated See Host::get_pstate_speed() */
 127   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate_speed() instead.") double getPstateSpeed(int pstate_index)
 128   {
 129     return get_pstate_speed(pstate_index);
 130   }
 131 #endif
 132
 133   std::vector<const char*> get_attached_storages() const;
 134   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages(
 135       std::vector<const char*>* storages);
 136
 137   /** Get an associative list [mount point]->[Storage] of all local mount points.
 138    *
 139    *  This is defined in the platform file, and cannot be modified programatically (yet).
 140    */
 141   std::unordered_map<std::string, Storage*> const& get_mounted_storages();
 142   /** @deprecated See Host::get_mounted_storages() */
 143   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_mounted_storages() instead.") std::unordered_map<std::string, Storage*> const& getMountedStorages()
 144   {
 145     return get_mounted_storages();
 146   }
 147
 148   void route_to(Host* dest, std::vector<Link*>& links, double* latency);
 149   void route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency);
 150
 151   /** Block the calling actor on an execution located on the called host
 152    *
 153    * It is not a problem if the actor is not located on the called host.
 154    * The actor will not be migrated in this case. Such remote execution are easy in simulation.
 155    */
 156   void execute(double flops);
 157   /** Block the calling actor on an execution located on the called host (with explicit priority) */
 158   void execute(double flops, double priority);
 159
 160   // Deprecated functions
 161 #ifndef DOXYGEN
 162   /** @deprecated See Host::get_name() */
 163   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_name()") simgrid::xbt::string const& getName() const
 164   {
 165     return name_;
 166   }
 167   /** @deprecated See Host::get_cname() */
 168   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_cname()") const char* getCname() const { return name_.c_str(); }
 169   /** @deprecated See Host::get_all_actors() */
 170   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void actorList(std::vector<ActorPtr>* whereto);
 171   /** @deprecated See Host::get_all_actors() */
 172   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void getProcesses(std::vector<ActorPtr>* list);
 173   /** @deprecated See Host::turn_on() */
 174   XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_on()") void turnOn() { turn_on(); }
 175   /** @deprecated See Host::turn_off() */
 176   XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_off()") void turnOff() { turn_off(); }
 177   /** @deprecated See Host::is_on() */
 178   XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_on()") bool isOn() { return is_on(); }
 179   /** @deprecated See Host::is_off() */
 180   XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_off()") bool isOff() { return is_off(); }
 181   /** @deprecated See Host::get_property() */
 182   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_property()") const char* getProperty(const char* key)
 183   {
 184     return get_property(key);
 185   }
 186   /** @deprecated See Host::set_property() */
 187   XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_property()") void setProperty(std::string key, std::string value)
 188   {
 189     set_property(key, value);
 190   }
 191   /** @deprecated See Host::set_pstate() */
 192   XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_pstate()") void setPstate(int idx) { set_pstate(idx); }
 193   /** @deprecated See Host::get_pstate() */
 194   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate()") int getPstate() { return get_pstate(); }
 195   /** @deprecated See Host::route_to() */
 196   XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(Host* dest, std::vector<Link*>& links,
 197                                                                          double* latency)
 198   {
 199     route_to(dest, links, latency);
 200   }
 201   /** @deprecated See Host::route_to() */
 202   XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(
 203       Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
 204   {
 205     route_to(dest, links, latency);
 206   }
 207   /** @deprecated See Host::get_core_count() */
 208   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_core_count()") int getCoreCount() { return get_core_count(); }
 209   /** @deprecated See Host::get_pstate_count() */
 210   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate_count()") int getPstatesCount() const
 211   {
 212     return get_pstate_count();
 213   }
 214 #endif /* !DOXYGEN */
 215
 216 private:
 217   simgrid::xbt::string name_ {"noname"};
 218   std::unordered_map<std::string, Storage*>* mounts_ = nullptr; // caching
 219
 220 public:
 221   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
 222   surf::Cpu* pimpl_cpu = nullptr;
 223   // TODO, this could be a unique_ptr
 224   surf::HostImpl* pimpl_ = nullptr;
 225   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
 226   kernel::routing::NetPoint* pimpl_netpoint = nullptr;
 227 };
 228 }
 229 } // namespace simgrid::s4u
 230
 231 extern int USER_HOST_LEVEL;
 232
 233 #endif /* SIMGRID_S4U_HOST_HPP */