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
  39 public:
  40   explicit Host(const char* name);
  41
  42   /** Host destruction logic */
  43 protected:
  44   virtual ~Host();
  45
  46 private:
  47   bool currentlyDestroying_ = false;
  48
  49 public:
  50   virtual void destroy();
  51   // No copy/move
  52   Host(Host const&) = delete;
  53   Host& operator=(Host const&) = delete;
  54
  55   /** Retrieves an host from its name, or return nullptr */
  56   static Host* by_name_or_null(const char* name);
  57   /** Retrieves an host from its name, or return nullptr */
  58   static Host* by_name_or_null(std::string name);
  59   /** Retrieves an host from its name, or die */
  60   static s4u::Host* by_name(const char* name);
  61   /** Retrieves an host from its name, or die */
  62   static s4u::Host* by_name(std::string name);
  63   /** Retrieves the host on which the current actor is running */
  64   static s4u::Host* current();
  65
  66   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_name()") simgrid::xbt::string const& getName() const
  67   {
  68     return name_;
  69   }
  70   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_cname()") const char* getCname() const { return name_.c_str(); }
  71
  72   /** Retrieves the name of that host as a C++ string */
  73   simgrid::xbt::string const& get_name() const { return name_; }
  74   /** Retrieves the name of that host as a C string */
  75   const char* get_cname() const { return name_.c_str(); }
  76
  77   void actorList(std::vector<ActorPtr> * whereto);
  78
  79   /** Turns that host on if it was previously off
  80    *
  81    * All actors on that host which were marked autorestart will be restarted automatically.
  82    * This call does nothing if the host is already on.
  83    */
  84   void turnOn();
  85   /** Turns that host off. All actors are forcefully stopped. */
  86   void turnOff();
  87   /** Returns if that host is currently up and running */
  88   bool isOn();
  89   /** Returns if that host is currently down and offline */
  90   bool isOff() { return not isOn(); }
  91
  92   double getSpeed();
  93   int getCoreCount();
  94   std::map<std::string, std::string>* getProperties();
  95   const char* getProperty(const char* key);
  96   void setProperty(std::string key, std::string value);
  97   void getProcesses(std::vector<ActorPtr> * list);
  98   int get_actor_count();
  99   double getPstateSpeed(int pstate_index);
 100   int getPstatesCount() const;
 101   void setPstate(int pstate_index);
 102   int getPstate();
 103   std::vector<const char*> get_attached_storages();
 104   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages(
 105       std::vector<const char*>* storages);
 106
 107   /** Get an associative list [mount point]->[Storage] of all local mount points.
 108    *
 109    *  This is defined in the platform file, and cannot be modified programatically (yet).
 110    */
 111   std::unordered_map<std::string, Storage*> const& getMountedStorages();
 112
 113   void routeTo(Host* dest, std::vector<Link*>& links, double* latency);
 114   void routeTo(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency);
 115
 116   /** Block the calling actor on an execution located on the called host
 117    *
 118    * It is not a problem if the actor is not located on the called host.
 119    * The actor will not be migrated in this case. Such remote execution are easy in simulation.
 120    */
 121   void execute(double flops);
 122   /** Block the calling actor on an execution located on the called host (with explicit priority) */
 123   void execute(double flops, double priority);
 124
 125   /** @brief Returns the current computation load (in flops per second)
 126    * The external load (coming from an availability trace) is not taken in account.
 127    *
 128    * @return      The number of activities currently running on a host (an activity at priority 2 is counted twice).
 129    */
 130   double getLoad();
 131
 132 private:
 133   simgrid::xbt::string name_{"noname"};
 134   std::unordered_map<std::string, Storage*>* mounts_ = nullptr; // caching
 135
 136 public:
 137   // TODO, this could be a unique_ptr
 138   surf::HostImpl* pimpl_ = nullptr;
 139   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
 140   surf::Cpu* pimpl_cpu = nullptr;
 141   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
 142   kernel::routing::NetPoint* pimpl_netpoint = nullptr;
 143
 144   /*** Called on each newly created host */
 145   static simgrid::xbt::signal<void(Host&)> on_creation;
 146   /*** Called just before destructing an host */
 147   static simgrid::xbt::signal<void(Host&)> on_destruction;
 148   /*** Called when the machine is turned on or off (called AFTER the change) */
 149   static simgrid::xbt::signal<void(Host&)> on_state_change;
 150   /*** Called when the speed of the machine is changed (called AFTER the change)
 151    * (either because of a pstate switch or because of an external load event coming from the profile) */
 152   static simgrid::xbt::signal<void(Host&)> on_speed_change;
 153 };
 154 }
 155 } // namespace simgrid::s4u
 156
 157 extern int USER_HOST_LEVEL;
 158
 159 #endif /* SIMGRID_S4U_HOST_HPP */