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
11 #include <boost/unordered_map.hpp>
14 #include <xbt/string.hpp>
15 #include <xbt/signal.hpp>
16 #include <xbt/Extendable.hpp>
18 #include <simgrid/simix.h>
19 #include <simgrid/datatypes.h>
20 #include <simgrid/s4u/forward.hpp>
25 extern template class XBT_PUBLIC() Extendable<simgrid::s4u::Host>;
33 * An host represents some physical resource with computing and networking capabilities.
35 * All hosts are automatically created during the call of the method
36 * @link{simgrid::s4u::Engine::loadPlatform()}.
37 * You cannot create a host yourself.
39 * You can retrieve a particular host using simgrid::s4u::Host::byName()
40 * and actors can retrieve the host on which they run using simgrid::s4u::Host::current().
42 XBT_PUBLIC_CLASS Host :
43 public simgrid::xbt::Extendable<Host> {
46 explicit Host(const char *name);
48 /** Host destruction logic */
53 bool currentlyDestroying_ = false;
57 Host(Host const&) = delete;
58 Host& operator=(Host const&) = delete;
60 /** Retrieves an host from its name, or return nullptr */
61 static Host* by_name_or_null(const char* name);
62 /** Retrieves an host from its name, or die */
63 static s4u::Host *by_name(std::string name);
64 /** Retrieves the host on which the current actor is running */
65 static s4u::Host *current();
67 simgrid::xbt::string const& name() const { return name_; }
69 /** Turns that host on if it was previously off
71 * All actors on that host which were marked autorestart will be restarted automatically.
72 * This call does nothing if the host is already on.
75 /** Turns that host off. All actors are forcefully stopped. */
77 /** Returns if that host is currently up and running */
79 /** Returns if that host is currently down and offline */
80 bool isOff() { return !isOn(); }
84 xbt_dict_t properties();
85 const char*property(const char*key);
86 void setProperty(const char*key, const char *value);
87 xbt_swag_t processes();
88 double getPstateSpeedCurrent();
89 double getPstateSpeed(int pstate_index);
90 int pstatesCount() const;
91 void setPstate(int pstate_index);
93 virtual void parameters(vm_params_t params);
94 virtual void setParameters(vm_params_t params);
95 xbt_dict_t mountedStoragesAsDict(); // HACK
96 xbt_dynar_t attachedStorages();
98 /** Get an associative list [mount point]->[Storage] of all local mount points.
100 * This is defined in the platform file, and cannot be modified programatically (yet).
102 boost::unordered_map<std::string, Storage*> const &mountedStorages();
105 simgrid::xbt::string name_ = "noname";
106 boost::unordered_map<std::string, Storage*> *mounts = nullptr; // caching
109 // TODO, this could be a unique_ptr
110 surf::HostImpl* pimpl_ = nullptr;
111 /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
112 surf::Cpu *pimpl_cpu = nullptr;
113 /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
114 kernel::routing::NetCard *pimpl_netcard = nullptr;
117 /*** Called on each newly created object */
118 static simgrid::xbt::signal<void(Host&)> onCreation;
119 /*** Called just before destructing an object */
120 static simgrid::xbt::signal<void(Host&)> onDestruction;
121 /*** Called when the machine is turned on or off */
122 static simgrid::xbt::signal<void(Host&)> onStateChange;
125 }} // namespace simgrid::s4u
127 extern int MSG_HOST_LEVEL;
128 extern int USER_HOST_LEVEL;
130 #endif /* SIMGRID_S4U_HOST_HPP */
133 /* Bindings to the MSG hosts */
135 /* Copyright (c) 2006-2014. The SimGrid Team.
136 * All rights reserved. */
138 /* This program is free software; you can redistribute it and/or modify it
139 * under the terms of the license (GNU LGPL) which comes with this package. */
141 package org.simgrid.msg;
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 (coming 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 methods returns the list of storages attached to an host
175 * @return An array containing all storages (name) attached to the host
177 public native String[] getAttachedStorage();