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