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 #include <vector>
  11
  12 #include <xbt/base.h>
  13 #include <xbt/string.hpp>
  14 #include <xbt/signal.hpp>
  15 #include <xbt/Extendable.hpp>
  16
  17 #include <simgrid/simix.h>
  18 #include <simgrid/datatypes.h>
  19
  20 namespace simgrid {
  21 namespace s4u {
  22
  23 class Actor;
  24 class Storage;
  25 class File;
  26
  27 /** @brief Simulated machine that can host some actors
  28  *
  29  * It represents some physical resource with computing and networking capabilities.
  30  *
  31  * All hosts are automatically created during the call of the method
  32  * @link{simgrid::s4u::Engine::loadPlatform()}.
  33  * You cannot create a host yourself.
  34  *
  35  * You can retrieve a particular host using @link{simgrid::s4u::Host.byName()},
  36  * and actors can retrieve the host on which they run using @link{simgrid::s4u::Host.current()}.
  37  */
  38 XBT_PUBLIC_CLASS Host :
  39   public simgrid::xbt::Extendable<Host> {
  40
  41         // friend Actor;
  42         // friend File;
  43 private:
  44         Host(const char *name);
  45 public: // TODO, make me private
  46         ~Host();
  47 public:
  48
  49   static Host* by_name_or_null(const char* name);
  50   static Host* by_name_or_create(const char* name);
  51         /** Retrieves an host from its name. */
  52         static s4u::Host *by_name(std::string name);
  53         /** Retrieves the host on which the current actor is running */
  54         static s4u::Host *current();
  55
  56         simgrid::xbt::string const& name() const { return name_; }
  57
  58         /** Turns that host on if it was previously off
  59          *
  60          * All actors on that host which were marked autorestart will be restarted automatically.
  61          * This call does nothing if the host is already on.
  62          */
  63         void turnOn();
  64         /** Turns that host off. All actors are forcefully stopped. */
  65         void turnOff();
  66         /** Returns if that host is currently up and running */
  67         bool isOn();
  68         bool isOff() { return !isOn(); }
  69
  70         double getSpeed();
  71         int getCoreAmount();
  72   xbt_dict_t getProperties();
  73   xbt_swag_t getProcessList();
  74   double getCurrentPowerPeak();
  75   double getPowerPeakAt(int pstate_index);
  76   void setPState(int pstate_index);
  77         int getNbPStates() const;
  78   int getPState();
  79   void getParams(vm_params_t params);
  80   void setParams(vm_params_t params);
  81   xbt_dict_t getMountedStorageList();
  82   xbt_dynar_t getAttachedStorageList();
  83
  84         /** Get an associative list [mount point]->[Storage] off all local mount points.
  85          *
  86          *      This is defined in the platform file, and cannot be modified programatically (yet).
  87          *
  88          *      Do not change the returned value in any way.
  89          */
  90         boost::unordered_map<std::string, Storage*> &mountedStorages();
  91
  92 private:
  93         simgrid::xbt::string name_ = "noname";
  94         boost::unordered_map<std::string, Storage*> *mounts = NULL; // caching
  95
  96 public:
  97         // FIXME: these should be protected, but it leads to many errors
  98         // Use the extensions stuff for this? Go through simgrid::surf::Host?
  99         surf::Cpu     *pimpl_cpu = nullptr;
 100         surf::NetCard *pimpl_netcard = nullptr;
 101
 102 public:
 103         /*** Called on each newly created object */
 104         static simgrid::xbt::signal<void(Host&)> onCreation;
 105         /*** Called just before destructing an object */
 106         static simgrid::xbt::signal<void(Host&)> onDestruction;
 107         /*** Called when the machine is turned on or off */
 108         static simgrid::xbt::signal<void(Host&)> onStateChange;
 109 };
 110
 111 }} // namespace simgrid::s4u
 112
 113 extern int MSG_HOST_LEVEL;
 114 extern int SD_HOST_LEVEL;
 115 extern int SIMIX_HOST_LEVEL;
 116 extern int ROUTING_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 import org.simgrid.msg.Storage;
 133
 134 /*
 135 Host jacquelin;
 136
 137 try {
 138         jacquelin = Host.getByName("Jacquelin");
 139 } catch(HostNotFoundException e) {
 140         System.err.println(e.toString());
 141 }
 142 ...
 143 \endverbatim
 144  *
 145  */
 146 public class Host {
 147         /**
 148          * This static method returns all of the hosts of the installed platform.
 149          *
 150          * @return                      An array containing all the hosts installed.
 151          *
 152          */
 153         public native static Host[] all();
 154
 155         /**
 156          * This static method sets a mailbox to receive in asynchronous mode.
 157          *
 158          * All messages sent to this mailbox will be transferred to
 159          * the receiver without waiting for the receive call.
 160          * The receive call will still be necessary to use the received data.
 161          * If there is a need to receive some messages asynchronously, and some not,
 162          * two different mailboxes should be used.
 163          *
 164          * @param mailboxName The name of the mailbox
 165          */
 166         public static native void setAsyncMailbox(String mailboxName);
 167
 168         /**
 169          * This method returns the number of tasks currently running on a host.
 170          * The external load (comming from an availability trace) is not taken in account.
 171          *
 172          * @return                      The number of tasks currently running on a host.
 173          */
 174         public native int getLoad();
 175
 176         /**
 177          * This method returns the speed of the processor of a host,
 178          * regardless of the current load of the machine.
 179          *
 180          * @return                      The speed of the processor of the host in flops.
 181          *
 182          */
 183         public native double getSpeed();
 184
 185         /**
 186          * This method returns the number of core of a host.
 187          *
 188          * @return                      The speed of the processor of the host in flops.
 189          *
 190          */
 191         public native double getCoreNumber();
 192
 193         /**
 194          * Returns the value of a given host property (set from the platform file).
 195          */
 196         public native String getProperty(String name);
 197
 198         /**
 199          * Change the value of a given host property.
 200          */
 201         public native void setProperty(String name, String value);
 202
 203         /** This methods returns the list of storages attached to an host
 204          * @return An array containing all storages (name) attached to the host
 205          */
 206         public native String[] getAttachedStorage();
 207
 208
 209 }
 210 #endif