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 <boost/unordered_map.hpp>
  10
  11 #include <xbt/base.h>
  12 #include <xbt/string.hpp>
  13 #include <xbt/signal.hpp>
  14 #include <xbt/Extendable.hpp>
  15
  16 #include <simgrid/simix.h>
  17 #include <simgrid/datatypes.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  * @link{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 :
  41   public simgrid::xbt::Extendable<Host> {
  42
  43 private:
  44   explicit Host(const char *name);
  45 public: // TODO, make me private
  46   ~Host();
  47   /** Do not use this function, it should be private */
  48   static Host* by_name_or_create(const char* name);
  49
  50   /** Retrieves an host from its name, or return nullptr */
  51   static Host* by_name_or_null(const char* name);
  52   /** Retrieves an host from its name, or die */
  53   static s4u::Host *by_name(std::string name);
  54   /** Retrieves the host on which the current actor is running */
  55   static s4u::Host *current();
  56
  57   simgrid::xbt::string const& name() const { return name_; }
  58
  59   /** Turns that host on if it was previously off
  60    *
  61    * All actors on that host which were marked autorestart will be restarted automatically.
  62    * This call does nothing if the host is already on.
  63    */
  64   void turnOn();
  65   /** Turns that host off. All actors are forcefully stopped. */
  66   void turnOff();
  67   /** Returns if that host is currently up and running */
  68   bool isOn();
  69   bool isOff() { return !isOn(); }
  70
  71   double speed();
  72   int coresCount();
  73   xbt_dict_t properties();
  74   const char*property(const char*key);
  75   void setProperty(const char*key, const char *value);
  76   xbt_swag_t processes();
  77   double getPstateSpeedCurrent();
  78   double getPstateSpeed(int pstate_index);
  79   int pstatesCount() const;
  80   void setPstate(int pstate_index);
  81   int pstate();
  82   void parameters(vm_params_t params);
  83   void setParameters(vm_params_t params);
  84   xbt_dict_t mountedStoragesAsDict(); // HACK
  85   xbt_dynar_t attachedStorages();
  86
  87   /** Get an associative list [mount point]->[Storage] of all local mount points.
  88    *
  89    *  This is defined in the platform file, and cannot be modified programatically (yet).
  90    */
  91   boost::unordered_map<std::string, Storage*> const &mountedStorages();
  92
  93 private:
  94   simgrid::xbt::string name_ = "noname";
  95   boost::unordered_map<std::string, Storage*> *mounts = nullptr; // caching
  96
  97 public:
  98   // TODO, this could be a unique_ptr
  99   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
 100   surf::Cpu     *pimpl_cpu = nullptr;
 101   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
 102   routing::NetCard *pimpl_netcard = nullptr;
 103
 104 public:
 105   /*** Called on each newly created object */
 106   static simgrid::xbt::signal<void(Host&)> onCreation;
 107   /*** Called just before destructing an object */
 108   static simgrid::xbt::signal<void(Host&)> onDestruction;
 109   /*** Called when the machine is turned on or off */
 110   static simgrid::xbt::signal<void(Host&)> onStateChange;
 111 };
 112
 113 }} // namespace simgrid::s4u
 114
 115 extern int MSG_HOST_LEVEL;
 116 extern int SIMIX_HOST_LEVEL;
 117 extern int USER_HOST_LEVEL;
 118
 119 #endif /* SIMGRID_S4U_HOST_HPP */
 120
 121 #if 0
 122 /* Bindings to the MSG hosts */
 123
 124 /* Copyright (c) 2006-2014. The SimGrid Team.
 125  * All rights reserved.                                                     */
 126
 127 /* This program is free software; you can redistribute it and/or modify it
 128  * under the terms of the license (GNU LGPL) which comes with this package. */
 129
 130 package org.simgrid.msg;
 131
 132 public class Host {
 133   /**
 134    * This static method returns all of the hosts of the installed platform.
 135    *
 136    * @return      An array containing all the hosts installed.
 137    *
 138    */
 139   public native static Host[] all();
 140
 141   /**
 142    * This static method sets a mailbox to receive in asynchronous mode.
 143    *
 144    * All messages sent to this mailbox will be transferred to
 145    * the receiver without waiting for the receive call.
 146    * The receive call will still be necessary to use the received data.
 147    * If there is a need to receive some messages asynchronously, and some not,
 148    * two different mailboxes should be used.
 149    *
 150    * @param mailboxName The name of the mailbox
 151    */
 152   public static native void setAsyncMailbox(String mailboxName);
 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   /** This methods returns the list of storages attached to an host
 164    * @return An array containing all storages (name) attached to the host
 165    */
 166   public native String[] getAttachedStorage();
 167
 168
 169 }
 170 #endif