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>
13 #include "xbt/Extendable.hpp"
15 #include "xbt/signal.hpp"
16 #include "xbt/string.hpp"
19 #include "simgrid/forward.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 * @ref 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 return nullptr */
63 static Host* by_name_or_null(std::string name);
64 /** Retrieves an host from its name, or die */
65 static s4u::Host *by_name(std::string name);
66 /** Retrieves the host on which the current actor is running */
67 static s4u::Host *current();
69 simgrid::xbt::string const& name() const { return name_; }
70 const char* cname() { return name_.c_str(); }
72 /** Turns that host on if it was previously off
74 * All actors on that host which were marked autorestart will be restarted automatically.
75 * This call does nothing if the host is already on.
78 /** Turns that host off. All actors are forcefully stopped. */
80 /** Returns if that host is currently up and running */
82 /** Returns if that host is currently down and offline */
83 bool isOff() { return !isOn(); }
87 xbt_dict_t properties();
88 const char*property(const char*key);
89 void setProperty(const char*key, const char *value);
90 xbt_swag_t processes();
91 double getPstateSpeedCurrent();
92 double getPstateSpeed(int pstate_index);
93 int pstatesCount() const;
94 void setPstate(int pstate_index);
96 xbt_dict_t mountedStoragesAsDict(); // HACK
97 xbt_dynar_t attachedStorages();
99 /** Get an associative list [mount point]->[Storage] of all local mount points.
101 * This is defined in the platform file, and cannot be modified programatically (yet).
103 boost::unordered_map<std::string, Storage*> const &mountedStorages();
105 void routeTo(Host * dest, std::vector<Link*> * links, double* latency);
108 simgrid::xbt::string name_ = "noname";
109 boost::unordered_map<std::string, Storage*> *mounts = nullptr; // caching
112 // TODO, this could be a unique_ptr
113 surf::HostImpl* pimpl_ = nullptr;
114 /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
115 surf::Cpu *pimpl_cpu = nullptr;
116 /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
117 kernel::routing::NetPoint* pimpl_netpoint = nullptr;
120 /*** Called on each newly created object */
121 static simgrid::xbt::signal<void(Host&)> onCreation;
122 /*** Called just before destructing an object */
123 static simgrid::xbt::signal<void(Host&)> onDestruction;
124 /*** Called when the machine is turned on or off */
125 static simgrid::xbt::signal<void(Host&)> onStateChange;
128 }} // namespace simgrid::s4u
130 extern int MSG_HOST_LEVEL;
131 extern int USER_HOST_LEVEL;
133 #endif /* SIMGRID_S4U_HOST_HPP */
136 /* Bindings to the MSG hosts */
138 /* Copyright (c) 2006-2014. The SimGrid Team.
139 * All rights reserved. */
141 /* This program is free software; you can redistribute it and/or modify it
142 * under the terms of the license (GNU LGPL) which comes with this package. */
144 package org.simgrid.msg;
148 * This static method returns all of the hosts of the installed platform.
150 * @return An array containing all the hosts installed.
153 public native static Host[] all();
156 * This static method sets a mailbox to receive in asynchronous mode.
158 * All messages sent to this mailbox will be transferred to
159 * the receiver without waiting for the receive call.
160 * The receive call will still be necessary to use the received data.
161 * If there is a need to receive some messages asynchronously, and some not,
162 * two different mailboxes should be used.
164 * @param mailboxName The name of the mailbox
166 public static native void setAsyncMailbox(String mailboxName);
169 * This method returns the number of tasks currently running on a host.
170 * The external load (coming from an availability trace) is not taken in account.
172 * @return The number of tasks currently running on a host.
174 public native int getLoad();
177 /** This methods returns the list of storages attached to an host
178 * @return An array containing all storages (name) attached to the host
180 public native String[] getAttachedStorage();