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