Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
moving dynar up in the stack
[simgrid.git] / include / simgrid / s4u / host.hpp
index 8eab63d..7c48221 100644 (file)
 #ifndef SIMGRID_S4U_HOST_HPP
 #define SIMGRID_S4U_HOST_HPP
 
+#include <string>
+
 #include <boost/unordered_map.hpp>
-#include <vector>
 
-#include "xbt/base.h"
-#include "simgrid/simix.h"
+#include "xbt/Extendable.hpp"
+#include "xbt/dict.h"
+#include "xbt/signal.hpp"
+#include "xbt/string.hpp"
+#include "xbt/swag.h"
+
+#include "simgrid/forward.h"
+#include "simgrid/s4u/forward.hpp"
 
 namespace simgrid {
-namespace s4u {
 
-class Actor;
-class Storage;
-class File;
+namespace xbt {
+  extern template class XBT_PUBLIC() Extendable<simgrid::s4u::Host>;
+}
+namespace s4u {
 
-/** @brief Simulated machine that can host some actors
+/** @ingroup s4u_api
+ *
+ * @tableofcontents 
  *
- * It represents some physical resource with computing and networking capabilities.
+ * An host represents some physical resource with computing and networking capabilities.
  *
  * All hosts are automatically created during the call of the method
- * @link{simgrid::s4u::Engine::loadPlatform()}.
+ * @ref simgrid::s4u::Engine::loadPlatform().
  * You cannot create a host yourself.
  *
- * You can retrieve a particular host using @link{simgrid::s4u::Host.byName()},
- * and actors can retrieve the host on which they run using @link{simgrid::s4u::Host.current()}.
+ * You can retrieve a particular host using simgrid::s4u::Host::byName()
+ * and actors can retrieve the host on which they run using simgrid::s4u::Host::current().
  */
-XBT_PUBLIC_CLASS Host {
-       friend Actor;
-       friend File;
-private:
-       Host(const char *name);
-protected:
-       ~Host();
+XBT_PUBLIC_CLASS Host :
+  public simgrid::xbt::Extendable<Host> {
+
 public:
-       /** Retrieves an host from its name. */
-       static s4u::Host *byName(std::string name);
-       /** Retrieves the host on which the current actor is running */
-       static s4u::Host *current();
-
-       const char* name();
-
-       /** Turns that host on if it was previously off
-        *
-        * All actors on that host which were marked autorestart will be restarted automatically.
-        * This call does nothing if the host is already on.
-        */
-       void turnOn();
-       /** Turns that host off. All actors are forcefully stopped. */
-       void turnOff();
-       /** Returns if that host is currently up and running */
-       bool isOn();
-
-
-       /** Allows to store user data on that host */
-       void set_userdata(void *data) {p_userdata = data;}
-       /** Retrieves the previously stored data */
-       void* userdata() {return p_userdata;}
-
-       /** Get an associative list [mount point]->[Storage] off all local mount points.
-        *
-        *      This is defined in the platform file, and cannot be modified programatically (yet).
-        *
-        *      Do not change the returned value in any way.
-        */
-       boost::unordered_map<std::string, Storage&> &mountedStorages();
-private:
-       boost::unordered_map<std::string, Storage&> *mounts = NULL; // caching
+  explicit Host(const char *name);
 
+  /** Host destruction logic */
 protected:
-       sg_host_t inferior() {return p_inferior;}
+  virtual ~Host();
+
 private:
-       void*p_userdata=NULL;
-       sg_host_t p_inferior;
-       static boost::unordered_map<std::string, s4u::Host *> *hosts;
+  bool currentlyDestroying_ = false;
+public:
+  void destroy();
+  // No copy/move
+  Host(Host const&) = delete;
+  Host& operator=(Host const&) = delete;
+
+  /** Retrieves an host from its name, or return nullptr */
+  static Host* by_name_or_null(const char* name);
+  /** Retrieves an host from its name, or return nullptr */
+  static Host* by_name_or_null(std::string name);
+  /** Retrieves an host from its name, or die */
+  static s4u::Host *by_name(std::string name);
+  /** Retrieves the host on which the current actor is running */
+  static s4u::Host *current();
+
+  simgrid::xbt::string const& name() const { return name_; }
+  const char* cname() { return name_.c_str(); }
+
+  /** Turns that host on if it was previously off
+   *
+   * All actors on that host which were marked autorestart will be restarted automatically.
+   * This call does nothing if the host is already on.
+   */
+  void turnOn();
+  /** Turns that host off. All actors are forcefully stopped. */
+  void turnOff();
+  /** Returns if that host is currently up and running */
+  bool isOn();
+  /** Returns if that host is currently down and offline */
+  bool isOff() { return !isOn(); }
+
+  double speed();
+  int coreCount();
+  xbt_dict_t properties();
+  const char*property(const char*key);
+  void setProperty(const char*key, const char *value);
+  xbt_swag_t processes();
+  double getPstateSpeedCurrent();
+  double getPstateSpeed(int pstate_index);
+  int pstatesCount() const;
+  void setPstate(int pstate_index);
+  int pstate();
+  xbt_dict_t mountedStoragesAsDict(); // HACK
+  std::vector<const char*> attachedStorages();
+
+  /** Get an associative list [mount point]->[Storage] of all local mount points.
+   *
+   *  This is defined in the platform file, and cannot be modified programatically (yet).
+   */
+  boost::unordered_map<std::string, Storage*> const &mountedStorages();
+
+  void routeTo(Host * dest, std::vector<Link*> * links, double* latency);
+  void routeTo(Host * dest, std::vector<surf::LinkImpl*> * links, double* latency);
+
+private:
+  simgrid::xbt::string name_ = "noname";
+  boost::unordered_map<std::string, Storage*> *mounts = nullptr; // caching
+
+public:
+  // TODO, this could be a unique_ptr
+  surf::HostImpl* pimpl_ = nullptr;
+  /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
+  surf::Cpu     *pimpl_cpu = nullptr;
+  /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
+  kernel::routing::NetPoint* pimpl_netpoint = nullptr;
+
+  /*** Called on each newly created object */
+  static simgrid::xbt::signal<void(Host&)> onCreation;
+  /*** Called just before destructing an object */
+  static simgrid::xbt::signal<void(Host&)> onDestruction;
+  /*** Called when the machine is turned on or off */
+  static simgrid::xbt::signal<void(Host&)> onStateChange;
+  /*** Called when the speed of the machine is changed
+   * (either because of a pstate switch or because of an external load event coming from the profile) */
+  static simgrid::xbt::signal<void(Host&)> onSpeedChange;
 };
 
 }} // namespace simgrid::s4u
 
+extern int USER_HOST_LEVEL;
+
 #endif /* SIMGRID_S4U_HOST_HPP */
 
 #if 0
@@ -95,81 +145,41 @@ private:
 
 package org.simgrid.msg;
 
-import org.simgrid.msg.Storage;
-
-/*
-Host jacquelin;
-
-try { 
-       jacquelin = Host.getByName("Jacquelin");
-} catch(HostNotFoundException e) {
-       System.err.println(e.toString());
-}
-...
-\endverbatim
- *
- */ 
 public class Host {
-       /**
-        * This static method returns all of the hosts of the installed platform.
-        *
-        * @return                      An array containing all the hosts installed.
-        *
-        */ 
-       public native static Host[] all();
-
-       /** 
-        * This static method sets a mailbox to receive in asynchronous mode.
-        * 
-        * All messages sent to this mailbox will be transferred to 
-        * the receiver without waiting for the receive call. 
-        * The receive call will still be necessary to use the received data.
-        * If there is a need to receive some messages asynchronously, and some not, 
-        * two different mailboxes should be used.
-        *
-        * @param mailboxName The name of the mailbox
-        */
-       public static native void setAsyncMailbox(String mailboxName);
-
-       /**
-        * This method returns the number of tasks currently running on a host.
-        * The external load (comming from an availability trace) is not taken in account.
-        *
-        * @return                      The number of tasks currently running on a host.
-        */ 
-       public native int getLoad();
-
-       /**
-        * This method returns the speed of the processor of a host,
-        * regardless of the current load of the machine.
-        *
-        * @return                      The speed of the processor of the host in flops.
-        *
-        */ 
-       public native double getSpeed();
-
-       /**
-        * This method returns the number of core of a host.
-        *
-        * @return                      The speed of the processor of the host in flops.
-        *
-        */ 
-       public native double getCoreNumber();
-
-       /**
-        * Returns the value of a given host property (set from the platform file).
-        */
-       public native String getProperty(String name);
-
-       /**
-        * Change the value of a given host property. 
-        */
-       public native void setProperty(String name, String value);
-
-       /** This methods returns the list of storages attached to an host
-        * @return An array containing all storages (name) attached to the host
-        */
-       public native String[] getAttachedStorage();
+  /**
+   * This static method returns all of the hosts of the installed platform.
+   *
+   * @return      An array containing all the hosts installed.
+   *
+   */ 
+  public native static Host[] all();
+
+  /** 
+   * This static method sets a mailbox to receive in asynchronous mode.
+   * 
+   * All messages sent to this mailbox will be transferred to 
+   * the receiver without waiting for the receive call. 
+   * The receive call will still be necessary to use the received data.
+   * If there is a need to receive some messages asynchronously, and some not, 
+   * two different mailboxes should be used.
+   *
+   * @param mailboxName The name of the mailbox
+   */
+  public static native void setAsyncMailbox(String mailboxName);
+
+  /**
+   * This method returns the number of tasks currently running on a host.
+   * The external load (coming from an availability trace) is not taken in account.
+   *
+   * @return      The number of tasks currently running on a host.
+   */ 
+  public native int getLoad();
+
+
+  /** This methods returns the list of storages attached to an host
+   * @return An array containing all storages (name) attached to the host
+   */
+  public native String[] getAttachedStorage();
 
 
 }