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>
27 /** @brief Simulated machine that can host some actors
29 * It represents some physical resource with computing and networking capabilities.
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.
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()}.
38 XBT_PUBLIC_CLASS Host :
39 public simgrid::xbt::Extendable<Host> {
44 Host(const char *name);
45 public: // TODO, make me private
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();
53 static Host* by_name_or_null(const char* name);
54 static Host* by_name_or_create(const char* name);
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 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;
79 void getParams(vm_params_t params);
80 void setParams(vm_params_t params);
81 xbt_dict_t getMountedStorageList();
82 xbt_dynar_t getAttachedStorageList();
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;}
90 /** Get an associative list [mount point]->[Storage] off all local mount points.
92 * This is defined in the platform file, and cannot be modified programatically (yet).
94 * Do not change the returned value in any way.
96 // TODO, do not use Storage&, this looks dangerous!
97 boost::unordered_map<std::string, Storage*> &mountedStorages();
100 simgrid::xbt::string name_ = "noname";
101 boost::unordered_map<std::string, Storage*> *mounts = NULL; // caching
102 void* p_userdata = NULL;
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;
111 /*** Called on each newly created object */
112 static simgrid::xbt::signal<void(Host&)> onCreation;
113 /*** Called just before destructing an object */
114 static simgrid::xbt::signal<void(Host&)> onDestruction;
115 /*** Called when the machine is turned on or off */
116 static simgrid::xbt::signal<void(Host&)> onStateChange;
119 }} // namespace simgrid::s4u
121 extern int MSG_HOST_LEVEL;
122 extern int SD_HOST_LEVEL;
123 extern int SIMIX_HOST_LEVEL;
124 extern int ROUTING_HOST_LEVEL;
125 extern int USER_HOST_LEVEL;
127 #endif /* SIMGRID_S4U_HOST_HPP */
130 /* Bindings to the MSG hosts */
132 /* Copyright (c) 2006-2014. The SimGrid Team.
133 * All rights reserved. */
135 /* This program is free software; you can redistribute it and/or modify it
136 * under the terms of the license (GNU LGPL) which comes with this package. */
138 package org.simgrid.msg;
140 import org.simgrid.msg.Storage;
146 jacquelin = Host.getByName("Jacquelin");
147 } catch(HostNotFoundException e) {
148 System.err.println(e.toString());
156 * This static method returns all of the hosts of the installed platform.
158 * @return An array containing all the hosts installed.
161 public native static Host[] all();
164 * This static method sets a mailbox to receive in asynchronous mode.
166 * All messages sent to this mailbox will be transferred to
167 * the receiver without waiting for the receive call.
168 * The receive call will still be necessary to use the received data.
169 * If there is a need to receive some messages asynchronously, and some not,
170 * two different mailboxes should be used.
172 * @param mailboxName The name of the mailbox
174 public static native void setAsyncMailbox(String mailboxName);
177 * This method returns the number of tasks currently running on a host.
178 * The external load (comming from an availability trace) is not taken in account.
180 * @return The number of tasks currently running on a host.
182 public native int getLoad();
185 * This method returns the speed of the processor of a host,
186 * regardless of the current load of the machine.
188 * @return The speed of the processor of the host in flops.
191 public native double getSpeed();
194 * This method returns the number of core of a host.
196 * @return The speed of the processor of the host in flops.
199 public native double getCoreNumber();
202 * Returns the value of a given host property (set from the platform file).
204 public native String getProperty(String name);
207 * Change the value of a given host property.
209 public native void setProperty(String name, String value);
211 /** This methods returns the list of storages attached to an host
212 * @return An array containing all storages (name) attached to the host
214 public native String[] getAttachedStorage();