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