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