include/simgrid/s4u/host.hpp

   1 /* Copyright (c) 2006-2015. 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 <string>
  10
  11 #include <boost/unordered_map.hpp>
  12
  13 #include <xbt/base.h>
  14 #include <xbt/string.hpp>
  15 #include <xbt/signal.hpp>
  16 #include <xbt/Extendable.hpp>
  17
  18 #include <simgrid/simix.h>
  19 #include <simgrid/datatypes.h>
  20 #include <simgrid/s4u/forward.hpp>
  21
  22 namespace simgrid {
  23
  24 namespace xbt {
  25   extern template class XBT_PUBLIC() Extendable<simgrid::s4u::Host>;
  26 }
  27 namespace s4u {
  28
  29 /** @ingroup s4u_api
  30  *
  31  * @tableofcontents
  32  *
  33  * An host represents some physical resource with computing and networking capabilities.
  34  *
  35  * All hosts are automatically created during the call of the method
  36  * @link{simgrid::s4u::Engine::loadPlatform()}.
  37  * You cannot create a host yourself.
  38  *
  39  * You can retrieve a particular host using simgrid::s4u::Host::byName()
  40  * and actors can retrieve the host on which they run using simgrid::s4u::Host::current().
  41  */
  42 XBT_PUBLIC_CLASS Host :
  43   public simgrid::xbt::Extendable<Host> {
  44
  45 public:
  46   explicit Host(const char *name);
  47
  48   /** Host destruction logic */
  49 protected:
  50   virtual ~Host();
  51
  52 private:
  53   bool currentlyDestroying_ = false;
  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   simgrid::xbt::string const& name() const { return name_; }
  70   const char* cname() { return name_.c_str(); }
  71
  72   /** Turns that host on if it was previously off
  73    *
  74    * All actors on that host which were marked autorestart will be restarted automatically.
  75    * This call does nothing if the host is already on.
  76    */
  77   void turnOn();
  78   /** Turns that host off. All actors are forcefully stopped. */
  79   void turnOff();
  80   /** Returns if that host is currently up and running */
  81   bool isOn();
  82   /** Returns if that host is currently down and offline */
  83   bool isOff() { return !isOn(); }
  84
  85   double speed();
  86   int coreCount();
  87   xbt_dict_t properties();
  88   const char*property(const char*key);
  89   void setProperty(const char*key, const char *value);
  90   xbt_swag_t processes();
  91   double getPstateSpeedCurrent();
  92   double getPstateSpeed(int pstate_index);
  93   int pstatesCount() const;
  94   void setPstate(int pstate_index);
  95   int pstate();
  96   xbt_dict_t mountedStoragesAsDict(); // HACK
  97   xbt_dynar_t attachedStorages();
  98
  99   /** Get an associative list [mount point]->[Storage] of all local mount points.
 100    *
 101    *  This is defined in the platform file, and cannot be modified programatically (yet).
 102    */
 103   boost::unordered_map<std::string, Storage*> const &mountedStorages();
 104
 105 private:
 106   simgrid::xbt::string name_ = "noname";
 107   boost::unordered_map<std::string, Storage*> *mounts = nullptr; // caching
 108
 109 public:
 110   // TODO, this could be a unique_ptr
 111   surf::HostImpl* pimpl_ = nullptr;
 112   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
 113   surf::Cpu     *pimpl_cpu = nullptr;
 114   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
 115   kernel::routing::NetCard *pimpl_netcard = nullptr;
 116
 117 public:
 118   /*** Called on each newly created object */
 119   static simgrid::xbt::signal<void(Host&)> onCreation;
 120   /*** Called just before destructing an object */
 121   static simgrid::xbt::signal<void(Host&)> onDestruction;
 122   /*** Called when the machine is turned on or off */
 123   static simgrid::xbt::signal<void(Host&)> onStateChange;
 124 };
 125
 126 }} // namespace simgrid::s4u
 127
 128 extern int MSG_HOST_LEVEL;
 129 extern int USER_HOST_LEVEL;
 130
 131 #endif /* SIMGRID_S4U_HOST_HPP */
 132
 133 #if 0
 134 /* Bindings to the MSG hosts */
 135
 136 /* Copyright (c) 2006-2014. The SimGrid Team.
 137  * All rights reserved.                                                     */
 138
 139 /* This program is free software; you can redistribute it and/or modify it
 140  * under the terms of the license (GNU LGPL) which comes with this package. */
 141
 142 package org.simgrid.msg;
 143
 144 public class Host {
 145   /**
 146    * This static method returns all of the hosts of the installed platform.
 147    *
 148    * @return      An array containing all the hosts installed.
 149    *
 150    */
 151   public native static Host[] all();
 152
 153   /**
 154    * This static method sets a mailbox to receive in asynchronous mode.
 155    *
 156    * All messages sent to this mailbox will be transferred to
 157    * the receiver without waiting for the receive call.
 158    * The receive call will still be necessary to use the received data.
 159    * If there is a need to receive some messages asynchronously, and some not,
 160    * two different mailboxes should be used.
 161    *
 162    * @param mailboxName The name of the mailbox
 163    */
 164   public static native void setAsyncMailbox(String mailboxName);
 165
 166   /**
 167    * This method returns the number of tasks currently running on a host.
 168    * The external load (coming from an availability trace) is not taken in account.
 169    *
 170    * @return      The number of tasks currently running on a host.
 171    */
 172   public native int getLoad();
 173
 174
 175   /** This methods returns the list of storages attached to an host
 176    * @return An array containing all storages (name) attached to the host
 177    */
 178   public native String[] getAttachedStorage();
 179
 180
 181 }
 182 #endif