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 #include <simgrid/s4u/forward.hpp>
  20
  21 namespace simgrid {
  22
  23 namespace xbt {
  24 extern template class XBT_PUBLIC() Extendable<simgrid::s4u::Host>;
  25 }
  26
  27 namespace s4u {
  28
  29 /** @brief Simulated machine that can host some actors
  30  *
  31  * It 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 @link{simgrid::s4u::Host.byName()},
  38  * and actors can retrieve the host on which they run using @link{simgrid::s4u::Host.current()}.
  39  */
  40 XBT_PUBLIC_CLASS Host :
  41   public simgrid::xbt::Extendable<Host> {
  42
  43         // friend Actor;
  44         // friend File;
  45 private:
  46         Host(const char *name);
  47 public: // TODO, make me private
  48         ~Host();
  49 public:
  50
  51   static Host* by_name_or_null(const char* name);
  52   static Host* by_name_or_create(const char* name);
  53         /** Retrieves an host from its name. */
  54         static s4u::Host *by_name(std::string name);
  55         /** Retrieves the host on which the current actor is running */
  56         static s4u::Host *current();
  57
  58         simgrid::xbt::string const& name() const { return name_; }
  59
  60         /** Turns that host on if it was previously off
  61          *
  62          * All actors on that host which were marked autorestart will be restarted automatically.
  63          * This call does nothing if the host is already on.
  64          */
  65         void turn_on();
  66         /** Turns that host off. All actors are forcefully stopped. */
  67         void turn_off();
  68         /** Returns if that host is currently up and running */
  69         bool is_on();
  70         bool is_off() { return !is_on(); }
  71
  72         double speed();
  73         int core_count();
  74         xbt_dict_t properties();
  75         xbt_swag_t processes();
  76         double current_power_peak();
  77         double power_peak_at(int pstate_index);
  78         void set_pstate(int pstate_index);
  79         int pstates_count() const;
  80         int pstate();
  81         void get_parameters(vm_params_t params);
  82         void set_parameters(vm_params_t params);
  83         xbt_dict_t mounted_storages_as_dict(); // HACK
  84         xbt_dynar_t attached_storages();
  85
  86         /** Get an associative list [mount point]->[Storage] off all local mount points.
  87          *
  88          *      This is defined in the platform file, and cannot be modified programatically (yet).
  89          */
  90         boost::unordered_map<std::string, Storage*> const &mounted_storages();
  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   // TODO, this could be a unique_ptr
 100         surf::Cpu     *pimpl_cpu = nullptr;
 101         surf::NetCard *pimpl_netcard = nullptr;
 102
 103 public:
 104         /*** Called on each newly created object */
 105         static simgrid::xbt::signal<void(Host&)> onCreation;
 106         /*** Called just before destructing an object */
 107         static simgrid::xbt::signal<void(Host&)> onDestruction;
 108         /*** Called when the machine is turned on or off */
 109         static simgrid::xbt::signal<void(Host&)> onStateChange;
 110 };
 111
 112 }} // namespace simgrid::s4u
 113
 114 extern int MSG_HOST_LEVEL;
 115 extern int SD_HOST_LEVEL;
 116 extern int SIMIX_HOST_LEVEL;
 117 extern int ROUTING_HOST_LEVEL;
 118 extern int USER_HOST_LEVEL;
 119
 120 #endif /* SIMGRID_S4U_HOST_HPP */
 121
 122 #if 0
 123 /* Bindings to the MSG hosts */
 124
 125 /* Copyright (c) 2006-2014. The SimGrid Team.
 126  * All rights reserved.                                                     */
 127
 128 /* This program is free software; you can redistribute it and/or modify it
 129  * under the terms of the license (GNU LGPL) which comes with this package. */
 130
 131 package org.simgrid.msg;
 132
 133 import org.simgrid.msg.Storage;
 134
 135 /*
 136 Host jacquelin;
 137
 138 try {
 139         jacquelin = Host.getByName("Jacquelin");
 140 } catch(HostNotFoundException e) {
 141         System.err.println(e.toString());
 142 }
 143 ...
 144 \endverbatim
 145  *
 146  */
 147 public class Host {
 148         /**
 149          * This static method returns all of the hosts of the installed platform.
 150          *
 151          * @return                      An array containing all the hosts installed.
 152          *
 153          */
 154         public native static Host[] all();
 155
 156         /**
 157          * This static method sets a mailbox to receive in asynchronous mode.
 158          *
 159          * All messages sent to this mailbox will be transferred to
 160          * the receiver without waiting for the receive call.
 161          * The receive call will still be necessary to use the received data.
 162          * If there is a need to receive some messages asynchronously, and some not,
 163          * two different mailboxes should be used.
 164          *
 165          * @param mailboxName The name of the mailbox
 166          */
 167         public static native void setAsyncMailbox(String mailboxName);
 168
 169         /**
 170          * This method returns the number of tasks currently running on a host.
 171          * The external load (comming from an availability trace) is not taken in account.
 172          *
 173          * @return                      The number of tasks currently running on a host.
 174          */
 175         public native int getLoad();
 176
 177         /**
 178          * This method returns the speed of the processor of a host,
 179          * regardless of the current load of the machine.
 180          *
 181          * @return                      The speed of the processor of the host in flops.
 182          *
 183          */
 184         public native double getSpeed();
 185
 186         /**
 187          * This method returns the number of core of a host.
 188          *
 189          * @return                      The speed of the processor of the host in flops.
 190          *
 191          */
 192         public native double getCoreNumber();
 193
 194         /**
 195          * Returns the value of a given host property (set from the platform file).
 196          */
 197         public native String getProperty(String name);
 198
 199         /**
 200          * Change the value of a given host property.
 201          */
 202         public native void setProperty(String name, String value);
 203
 204         /** This methods returns the list of storages attached to an host
 205          * @return An array containing all storages (name) attached to the host
 206          */
 207         public native String[] getAttachedStorage();
 208
 209
 210 }
 211 #endif