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 <simgrid/s4u/forward.hpp>
  11 #include <xbt/Extendable.hpp>
  12 #include <xbt/signal.hpp>
  13 #include <xbt/string.hpp>
  14
  15 #include <map>
  16 #include <string>
  17 #include <unordered_map>
  18
  19 namespace simgrid {
  20
  21 namespace xbt {
  22 extern template class XBT_PUBLIC Extendable<simgrid::s4u::Host>;
  23 }
  24 namespace s4u {
  25
  26 /** @ingroup s4u_api
  27  *
  28  * @tableofcontents
  29  *
  30  * An host represents some physical resource with computing and networking capabilities.
  31  *
  32  * All hosts are automatically created during the call of the method
  33  * @ref simgrid::s4u::Engine::loadPlatform().
  34  * You cannot create a host yourself.
  35  *
  36  * You can retrieve a particular host using simgrid::s4u::Host::byName()
  37  * and actors can retrieve the host on which they run using simgrid::s4u::Host::current().
  38  */
  39 class XBT_PUBLIC Host : public simgrid::xbt::Extendable<Host> {
  40
  41 public:
  42   explicit Host(const char* name);
  43
  44   /** Host destruction logic */
  45 protected:
  46   virtual ~Host();
  47
  48 private:
  49   bool currentlyDestroying_ = false;
  50
  51 public:
  52   virtual void destroy();
  53   // No copy/move
  54   Host(Host const&) = delete;
  55   Host& operator=(Host const&) = delete;
  56
  57   /** Retrieves an host from its name, or return nullptr */
  58   static Host* by_name_or_null(const char* name);
  59   /** Retrieves an host from its name, or return nullptr */
  60   static Host* by_name_or_null(std::string name);
  61   /** Retrieves an host from its name, or die */
  62   static s4u::Host* by_name(const char* name);
  63   /** Retrieves an host from its name, or die */
  64   static s4u::Host* by_name(std::string name);
  65   /** Retrieves the host on which the current actor is running */
  66   static s4u::Host* current();
  67
  68   /** Retrieves the name of that host as a C++ string */
  69   simgrid::xbt::string const& getName() const { return name_; }
  70   /** Retrieves the name of that host as a C string */
  71   const char* getCname() const { return name_.c_str(); }
  72
  73   void actorList(std::vector<ActorPtr> * whereto);
  74
  75   /** Turns that host on if it was previously off
  76    *
  77    * All actors on that host which were marked autorestart will be restarted automatically.
  78    * This call does nothing if the host is already on.
  79    */
  80   void turnOn();
  81   /** Turns that host off. All actors are forcefully stopped. */
  82   void turnOff();
  83   /** Returns if that host is currently up and running */
  84   bool isOn();
  85   /** Returns if that host is currently down and offline */
  86   bool isOff() { return not isOn(); }
  87
  88   double getSpeed();
  89   int getCoreCount();
  90   std::map<std::string, std::string>* getProperties();
  91   const char* getProperty(const char* key);
  92   void setProperty(std::string key, std::string value);
  93   void getProcesses(std::vector<ActorPtr> * list);
  94   double getPstateSpeed(int pstate_index);
  95   int getPstatesCount() const;
  96   void setPstate(int pstate_index);
  97   int getPstate();
  98   void getAttachedStorages(std::vector<const char*> * storages);
  99
 100   /** Get an associative list [mount point]->[Storage] of all local mount points.
 101    *
 102    *  This is defined in the platform file, and cannot be modified programatically (yet).
 103    */
 104   std::unordered_map<std::string, Storage*> const& getMountedStorages();
 105
 106   void routeTo(Host* dest, std::vector<Link*>& links, double* latency);
 107   void routeTo(Host* dest, std::vector<surf::LinkImpl*>& links, double* latency);
 108
 109   /** Block the calling actor on an execution located on the called host
 110    *
 111    * It is not a problem if the actor is not located on the called host.
 112    * The actor will not be migrated in this case. Such remote execution are easy in simulation.
 113    */
 114   void execute(double flops);
 115
 116   /** @brief Returns the current computation load (in flops per second) */
 117   double getLoad();
 118
 119 private:
 120   simgrid::xbt::string name_{"noname"};
 121   std::unordered_map<std::string, Storage*>* mounts = nullptr; // caching
 122
 123 public:
 124   // TODO, this could be a unique_ptr
 125   surf::HostImpl* pimpl_ = nullptr;
 126   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
 127   surf::Cpu* pimpl_cpu = nullptr;
 128   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
 129   kernel::routing::NetPoint* pimpl_netpoint = nullptr;
 130
 131   /*** Called on each newly created host */
 132   static simgrid::xbt::signal<void(Host&)> onCreation;
 133   /*** Called just before destructing an host */
 134   static simgrid::xbt::signal<void(Host&)> onDestruction;
 135   /*** Called when the machine is turned on or off (called AFTER the change) */
 136   static simgrid::xbt::signal<void(Host&)> onStateChange;
 137   /*** Called when the speed of the machine is changed (called AFTER the change)
 138    * (either because of a pstate switch or because of an external load event coming from the profile) */
 139   static simgrid::xbt::signal<void(Host&)> onSpeedChange;
 140 };
 141 }
 142 } // namespace simgrid::s4u
 143
 144 extern int USER_HOST_LEVEL;
 145
 146 #endif /* SIMGRID_S4U_HOST_HPP */
 147
 148 #if 0
 149
 150 public class Host {
 151
 152   /**
 153    * This method returns the number of tasks currently running on a host.
 154    * The external load (coming from an availability trace) is not taken in account.
 155    *
 156    * @return      The number of tasks currently running on a host.
 157    */
 158   public native int getLoad();
 159
 160 }
 161 #endif