1 /* Copyright (c) 2006-2015. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_S4U_HOST_HPP
7 #define SIMGRID_S4U_HOST_HPP
9 #include <boost/unordered_map.hpp>
13 #include <xbt/string.hpp>
14 #include <xbt/signal.hpp>
15 #include <xbt/Extendable.hpp>
17 #include <simgrid/simix.h>
18 #include <simgrid/datatypes.h>
19 #include <simgrid/s4u/forward.hpp>
24 extern template class XBT_PUBLIC() Extendable<simgrid::s4u::Host>;
29 /** @brief Simulated machine that can host some actors
31 * It represents some physical resource with computing and networking capabilities.
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.
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()}.
40 XBT_PUBLIC_CLASS Host :
41 public simgrid::xbt::Extendable<Host> {
44 Host(const char *name);
45 public: // TODO, make me private
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();
56 simgrid::xbt::string const& name() const { return name_; }
58 /** Turns that host on if it was previously off
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.
64 /** Turns that host off. All actors are forcefully stopped. */
66 /** Returns if that host is currently up and running */
68 bool isOff() { return !isOn(); }
72 xbt_dict_t properties();
73 xbt_swag_t processes();
74 double currentPowerPeak();
75 double powerPeakAt(int pstate_index);
76 int pstatesCount() const;
77 void setPstate(int pstate_index);
79 void parameters(vm_params_t params);
80 void setParameters(vm_params_t params);
81 xbt_dict_t mountedStoragesAsDict(); // HACK
82 xbt_dynar_t attachedStorages();
84 /** Get an associative list [mount point]->[Storage] off all local mount points.
86 * This is defined in the platform file, and cannot be modified programatically (yet).
88 boost::unordered_map<std::string, Storage*> const &mountedStorages();
91 simgrid::xbt::string name_ = "noname";
92 boost::unordered_map<std::string, Storage*> *mounts = NULL; // caching
95 // FIXME: these should be protected, but it leads to many errors
96 // Use the extensions stuff for this? Go through simgrid::surf::Host?
97 // TODO, this could be a unique_ptr
98 surf::Cpu *pimpl_cpu = nullptr;
99 surf::NetCard *pimpl_netcard = nullptr;
102 /*** Called on each newly created object */
103 static simgrid::xbt::signal<void(Host&)> onCreation;
104 /*** Called just before destructing an object */
105 static simgrid::xbt::signal<void(Host&)> onDestruction;
106 /*** Called when the machine is turned on or off */
107 static simgrid::xbt::signal<void(Host&)> onStateChange;
110 }} // namespace simgrid::s4u
112 extern int MSG_HOST_LEVEL;
113 extern int SIMIX_HOST_LEVEL;
114 extern int USER_HOST_LEVEL;
116 #endif /* SIMGRID_S4U_HOST_HPP */
119 /* Bindings to the MSG hosts */
121 /* Copyright (c) 2006-2014. The SimGrid Team.
122 * All rights reserved. */
124 /* This program is free software; you can redistribute it and/or modify it
125 * under the terms of the license (GNU LGPL) which comes with this package. */
127 package org.simgrid.msg;
129 import org.simgrid.msg.Storage;
135 jacquelin = Host.getByName("Jacquelin");
136 } catch(HostNotFoundException e) {
137 System.err.println(e.toString());
145 * This static method returns all of the hosts of the installed platform.
147 * @return An array containing all the hosts installed.
150 public native static Host[] all();
153 * This static method sets a mailbox to receive in asynchronous mode.
155 * All messages sent to this mailbox will be transferred to
156 * the receiver without waiting for the receive call.
157 * The receive call will still be necessary to use the received data.
158 * If there is a need to receive some messages asynchronously, and some not,
159 * two different mailboxes should be used.
161 * @param mailboxName The name of the mailbox
163 public static native void setAsyncMailbox(String mailboxName);
166 * This method returns the number of tasks currently running on a host.
167 * The external load (comming from an availability trace) is not taken in account.
169 * @return The number of tasks currently running on a host.
171 public native int getLoad();
174 * This method returns the speed of the processor of a host,
175 * regardless of the current load of the machine.
177 * @return The speed of the processor of the host in flops.
180 public native double getSpeed();
183 * This method returns the number of core of a host.
185 * @return The speed of the processor of the host in flops.
188 public native double getCoreNumber();
191 * Returns the value of a given host property (set from the platform file).
193 public native String getProperty(String name);
196 * Change the value of a given host property.
198 public native void setProperty(String name, String value);
200 /** This methods returns the list of storages attached to an host
201 * @return An array containing all storages (name) attached to the host
203 public native String[] getAttachedStorage();