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         /** Retrieves an host from its name. */
  49         static s4u::Host *byName(std::string name);
  50         /** Retrieves the host on which the current actor is running */
  51         static s4u::Host *current();
  52
  53   static Host* by_name_or_null(const char* name);
  54   static Host* by_name_or_create(const char* name);
  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         /** Allows to store user data on that host */
  85         // TODO, use the extension stuff instead
  86         void set_userdata(void *data) {p_userdata = data;}
  87         /** Retrieves the previously stored data */
  88         void* userdata() {return p_userdata;}
  89
  90         /** Get an associative list [mount point]->[Storage] off all local mount points.
  91          *
  92          *      This is defined in the platform file, and cannot be modified programatically (yet).
  93          *
  94          *      Do not change the returned value in any way.
  95          */
  96         // TODO, do not use Storage&, this looks dangerous!
  97         boost::unordered_map<std::string, Storage&> &mountedStorages();
  98
  99 private:
 100         simgrid::xbt::string name_ = "noname";
 101         boost::unordered_map<std::string, Storage&> *mounts = NULL; // caching
 102         void* p_userdata = NULL;
 103
 104 public:
 105         // FIXME: these should be protected, but it leads to many errors
 106         // Use the extensions stuff for this? Go through simgrid::surf::Host?
 107         surf::Cpu     *pimpl_cpu = nullptr;
 108         surf::NetCard *pimpl_netcard = nullptr;
 109
 110 public:
 111         static boost::unordered_map<std::string, s4u::Host *> *hosts;
 112
 113         /*** Called on each newly created object */
 114         static simgrid::xbt::signal<void(Host&)> onCreation;
 115         /*** Called just before destructing an object */
 116         static simgrid::xbt::signal<void(Host&)> onDestruction;
 117         /*** Called when the machine is turned on or off */
 118         static simgrid::xbt::signal<void(Host&)> onStateChange;
 119 };
 120
 121 }} // namespace simgrid::s4u
 122
 123 extern int MSG_HOST_LEVEL;
 124 extern int SD_HOST_LEVEL;
 125 extern int SIMIX_HOST_LEVEL;
 126 extern int ROUTING_HOST_LEVEL;
 127 extern int USER_HOST_LEVEL;
 128
 129 #endif /* SIMGRID_S4U_HOST_HPP */
 130
 131 #if 0
 132 /* Bindings to the MSG hosts */
 133
 134 /* Copyright (c) 2006-2014. The SimGrid Team.
 135  * All rights reserved.                                                     */
 136
 137 /* This program is free software; you can redistribute it and/or modify it
 138  * under the terms of the license (GNU LGPL) which comes with this package. */
 139
 140 package org.simgrid.msg;
 141
 142 import org.simgrid.msg.Storage;
 143
 144 /*
 145 Host jacquelin;
 146
 147 try {
 148         jacquelin = Host.getByName("Jacquelin");
 149 } catch(HostNotFoundException e) {
 150         System.err.println(e.toString());
 151 }
 152 ...
 153 \endverbatim
 154  *
 155  */
 156 public class Host {
 157         /**
 158          * This static method returns all of the hosts of the installed platform.
 159          *
 160          * @return                      An array containing all the hosts installed.
 161          *
 162          */
 163         public native static Host[] all();
 164
 165         /**
 166          * This static method sets a mailbox to receive in asynchronous mode.
 167          *
 168          * All messages sent to this mailbox will be transferred to
 169          * the receiver without waiting for the receive call.
 170          * The receive call will still be necessary to use the received data.
 171          * If there is a need to receive some messages asynchronously, and some not,
 172          * two different mailboxes should be used.
 173          *
 174          * @param mailboxName The name of the mailbox
 175          */
 176         public static native void setAsyncMailbox(String mailboxName);
 177
 178         /**
 179          * This method returns the number of tasks currently running on a host.
 180          * The external load (comming from an availability trace) is not taken in account.
 181          *
 182          * @return                      The number of tasks currently running on a host.
 183          */
 184         public native int getLoad();
 185
 186         /**
 187          * This method returns the speed of the processor of a host,
 188          * regardless of the current load of the machine.
 189          *
 190          * @return                      The speed of the processor of the host in flops.
 191          *
 192          */
 193         public native double getSpeed();
 194
 195         /**
 196          * This method returns the number of core of a host.
 197          *
 198          * @return                      The speed of the processor of the host in flops.
 199          *
 200          */
 201         public native double getCoreNumber();
 202
 203         /**
 204          * Returns the value of a given host property (set from the platform file).
 205          */
 206         public native String getProperty(String name);
 207
 208         /**
 209          * Change the value of a given host property.
 210          */
 211         public native void setProperty(String name, String value);
 212
 213         /** This methods returns the list of storages attached to an host
 214          * @return An array containing all storages (name) attached to the host
 215          */
 216         public native String[] getAttachedStorage();
 217
 218
 219 }
 220 #endif