1 /* Copyright (c) 2006-2019. 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 <simgrid/forward.h>
10 #include <xbt/Extendable.hpp>
11 #include <xbt/signal.hpp>
12 #include <xbt/string.hpp>
15 #include <unordered_map>
20 extern template class XBT_PUBLIC Extendable<s4u::Host>;
28 * Some physical resource with computing and networking capabilities on which Actors execute.
30 * All hosts are automatically created during the call of the method
31 * @ref simgrid::s4u::Engine::load_platform().
32 * You cannot create a host yourself.
34 * You can retrieve a particular host using @ref simgrid::s4u::Host::by_name()
35 * and actors can retrieve the host on which they run using @ref simgrid::s4u::Host::current() or
36 * @ref simgrid::s4u::this_actor::get_host().
38 class XBT_PUBLIC Host : public xbt::Extendable<Host> {
39 friend vm::VMModel; // Use the pimpl_cpu to compute the VM sharing
40 friend vm::VirtualMachineImpl; // creates the the pimpl_cpu
43 explicit Host(const std::string& name);
45 /** Host destruction logic */
50 bool currently_destroying_ = false;
53 /*** Called on each newly created host */
54 static xbt::signal<void(Host&)> on_creation;
55 /*** Called just before destructing a host */
56 static xbt::signal<void(Host&)> on_destruction;
57 /*** Called when the machine is turned on or off (called AFTER the change) */
58 static xbt::signal<void(Host&)> on_state_change;
59 /*** Called when the speed of the machine is changed (called AFTER the change)
60 * (either because of a pstate switch or because of an external load event coming from the profile) */
61 static xbt::signal<void(Host&)> on_speed_change;
63 virtual void destroy();
65 Host(Host const&) = delete;
66 Host& operator=(Host const&) = delete;
68 /** Retrieve a host from its name, or return nullptr */
69 static Host* by_name_or_null(const std::string& name);
70 /** Retrieve a host from its name, or die */
71 static Host* by_name(const std::string& name);
72 /** Retrieves the host on which the running actor is located */
73 static Host* current();
75 /** Retrieves the name of that host as a C++ string */
76 xbt::string const& get_name() const { return name_; }
77 /** Retrieves the name of that host as a C string */
78 const char* get_cname() const { return name_.c_str(); }
80 int get_actor_count();
81 std::vector<ActorPtr> get_all_actors();
83 /** Turns that host on if it was previously off
85 * This call does nothing if the host is already on. If it was off, all actors which were marked 'autorestart' on that
86 * host will be restarted automatically (note that this may differ from the actors that were initially running on the
89 * All other Host's properties are left unchanged; in particular, the pstate is left unchanged and not reset to its
93 /** Turns that host off. All actors are forcefully stopped. */
95 /** Returns if that host is currently up and running */
97 /** Returns if that host is currently down and offline */
98 XBT_ATTRIB_DEPRECATED_v325("Please use !is_on()") bool is_off() const { return not is_on(); }
100 const char* get_property(const std::string& key) const;
101 void set_property(const std::string& key, const std::string& value);
102 std::unordered_map<std::string, std::string>* get_properties();
104 void set_state_profile(kernel::profile::Profile* p);
105 void set_speed_profile(kernel::profile::Profile* p);
108 /** @deprecated See Host::get_properties() */
109 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_properties()") std::map<std::string, std::string>* getProperties()
111 std::map<std::string, std::string>* res = new std::map<std::string, std::string>();
112 std::unordered_map<std::string, std::string>* props = get_properties();
113 for (auto const& kv : *props)
119 double get_speed() const;
120 double get_available_speed() const;
121 int get_core_count() const;
122 double get_load() const;
124 double get_pstate_speed(int pstate_index) const;
125 int get_pstate_count() const;
126 void set_pstate(int pstate_index);
127 int get_pstate() const;
129 std::vector<const char*> get_attached_storages() const;
132 /** @deprecated See Host::get_speed() */
133 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_speed() instead.") double getSpeed() { return get_speed(); }
134 /** @deprecated See Host::get_pstate_speed() */
135 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate_speed() instead.") double getPstateSpeed(int pstate_index)
137 return get_pstate_speed(pstate_index);
139 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages(
140 std::vector<const char*>* storages);
143 /** Get an associative list [mount point]->[Storage] of all local mount points.
145 * This is defined in the platform file, and cannot be modified programatically (yet).
147 std::unordered_map<std::string, Storage*> const& get_mounted_storages();
149 /** @deprecated See Host::get_mounted_storages() */
150 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_mounted_storages() instead.") std::unordered_map<std::string, Storage*> const& getMountedStorages()
152 return get_mounted_storages();
156 void route_to(Host* dest, std::vector<Link*>& links, double* latency);
157 void route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency);
159 /** Block the calling actor on an execution located on the called host
161 * It is not a problem if the actor is not located on the called host.
162 * The actor will not be migrated in this case. Such remote execution are easy in simulation.
164 void execute(double flops);
165 /** Start an asynchronous computation on that host (possibly remote) */
166 ExecPtr exec_async(double flops_amounts);
168 /** Block the calling actor on an execution located on the called host (with explicit priority) */
169 void execute(double flops, double priority);
171 // Deprecated functions
173 /** @deprecated See Host::get_name() */
174 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_name()") simgrid::xbt::string const& getName() const
178 /** @deprecated See Host::get_cname() */
179 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_cname()") const char* getCname() const { return name_.c_str(); }
180 /** @deprecated See Host::get_all_actors() */
181 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void actorList(std::vector<ActorPtr>* whereto);
182 /** @deprecated See Host::get_all_actors() */
183 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void getProcesses(std::vector<ActorPtr>* list);
184 /** @deprecated See Host::turn_on() */
185 XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_on()") void turnOn() { turn_on(); }
186 /** @deprecated See Host::turn_off() */
187 XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_off()") void turnOff() { turn_off(); }
188 /** @deprecated See Host::is_on() */
189 XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_on()") bool isOn() { return is_on(); }
190 /** @deprecated See Host::is_off() */
191 XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_off()") bool isOff() { return not is_on(); }
192 /** @deprecated See Host::get_property() */
193 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_property()") const char* getProperty(const char* key)
195 return get_property(key);
197 /** @deprecated See Host::set_property() */
198 XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_property()") void setProperty(const std::string& key,
199 const std::string& value)
201 set_property(key, value);
203 /** @deprecated See Host::set_pstate() */
204 XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_pstate()") void setPstate(int idx) { set_pstate(idx); }
205 /** @deprecated See Host::get_pstate() */
206 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate()") int getPstate() { return get_pstate(); }
207 /** @deprecated See Host::route_to() */
208 XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(Host* dest, std::vector<Link*>& links,
211 route_to(dest, links, latency);
213 /** @deprecated See Host::route_to() */
214 XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(
215 Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
217 route_to(dest, links, latency);
219 /** @deprecated See Host::get_core_count() */
220 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_core_count()") int getCoreCount() { return get_core_count(); }
221 /** @deprecated See Host::get_pstate_count() */
222 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate_count()") int getPstatesCount() const
224 return get_pstate_count();
226 #endif /* !DOXYGEN */
229 xbt::string name_{"noname"};
230 std::unordered_map<std::string, Storage*>* mounts_ = nullptr; // caching
234 /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
235 surf::Cpu* pimpl_cpu = nullptr;
236 // TODO, this could be a unique_ptr
237 surf::HostImpl* pimpl_ = nullptr;
238 /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
239 kernel::routing::NetPoint* pimpl_netpoint = nullptr;
243 } // namespace simgrid
245 extern int USER_HOST_LEVEL;
247 #endif /* SIMGRID_S4U_HOST_HPP */