include/simgrid/s4u/Host.hpp

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