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   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_name()") simgrid::xbt::string const& getName() const
  69   {
  70     return name_;
  71   }
  72   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_cname()") const char* getCname() const { return name_.c_str(); }
  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   void actorList(std::vector<ActorPtr> * whereto);
  80
  81   /** Turns that host on if it was previously off
  82    *
  83    * All actors on that host which were marked autorestart will be restarted automatically.
  84    * This call does nothing if the host is already on.
  85    */
  86   void turnOn();
  87   /** Turns that host off. All actors are forcefully stopped. */
  88   void turnOff();
  89   /** Returns if that host is currently up and running */
  90   bool isOn();
  91   /** Returns if that host is currently down and offline */
  92   bool isOff() { return not isOn(); }
  93
  94   double getSpeed();
  95   int getCoreCount();
  96   std::map<std::string, std::string>* getProperties();
  97   const char* getProperty(const char* key);
  98   void setProperty(std::string key, std::string value);
  99   void getProcesses(std::vector<ActorPtr> * list);
 100   int get_actor_count() const;
 101   double getPstateSpeed(int pstate_index);
 102   int getPstatesCount() const;
 103   void setPstate(int pstate_index);
 104   int getPstate();
 105   std::vector<const char*> get_attached_storages();
 106   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages(
 107       std::vector<const char*>* storages);
 108
 109   /** Get an associative list [mount point]->[Storage] of all local mount points.
 110    *
 111    *  This is defined in the platform file, and cannot be modified programatically (yet).
 112    */
 113   std::unordered_map<std::string, Storage*> const& getMountedStorages();
 114
 115   void routeTo(Host* dest, std::vector<Link*>& links, double* latency);
 116   void routeTo(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency);
 117
 118   /** Block the calling actor on an execution located on the called host
 119    *
 120    * It is not a problem if the actor is not located on the called host.
 121    * The actor will not be migrated in this case. Such remote execution are easy in simulation.
 122    */
 123   void execute(double flops);
 124
 125   /** @brief Returns the current computation load (in flops per second) */
 126   double getLoad();
 127
 128 private:
 129   simgrid::xbt::string name_{"noname"};
 130   std::unordered_map<std::string, Storage*>* mounts = nullptr; // caching
 131
 132 public:
 133   // TODO, this could be a unique_ptr
 134   surf::HostImpl* pimpl_ = nullptr;
 135   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
 136   surf::Cpu* pimpl_cpu = nullptr;
 137   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
 138   kernel::routing::NetPoint* pimpl_netpoint = nullptr;
 139
 140   /*** Called on each newly created host */
 141   static simgrid::xbt::signal<void(Host&)> onCreation;
 142   /*** Called just before destructing an host */
 143   static simgrid::xbt::signal<void(Host&)> onDestruction;
 144   /*** Called when the machine is turned on or off (called AFTER the change) */
 145   static simgrid::xbt::signal<void(Host&)> onStateChange;
 146   /*** Called when the speed of the machine is changed (called AFTER the change)
 147    * (either because of a pstate switch or because of an external load event coming from the profile) */
 148   static simgrid::xbt::signal<void(Host&)> onSpeedChange;
 149 };
 150 }
 151 } // namespace simgrid::s4u
 152
 153 extern int USER_HOST_LEVEL;
 154
 155 #endif /* SIMGRID_S4U_HOST_HPP */
 156
 157 #if 0
 158
 159 public class Host {
 160
 161   /**
 162    * This method returns the number of tasks currently running on a host.
 163    * The external load (coming from an availability trace) is not taken in account.
 164    *
 165    * @return      The number of tasks currently running on a host.
 166    */
 167   public native int getLoad();
 168
 169 }
 170 #endif