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