1 /* Copyright (c) 2006-2018. 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<simgrid::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 simgrid::xbt::Extendable<Host> {
39 friend simgrid::vm::VMModel; // Use the pimpl_cpu to compute the VM sharing
40 friend simgrid::vm::VirtualMachineImpl; // creates the the pimpl_cpu
43 explicit Host(std::string name);
45 /** Host destruction logic */
50 bool currentlyDestroying_ = false;
53 /*** Called on each newly created host */
54 static simgrid::xbt::signal<void(Host&)> on_creation;
55 /*** Called just before destructing an host */
56 static simgrid::xbt::signal<void(Host&)> on_destruction;
57 /*** Called when the machine is turned on or off (called AFTER the change) */
58 static simgrid::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 simgrid::xbt::signal<void(Host&)> on_speed_change;
63 virtual void destroy();
65 Host(Host const&) = delete;
66 Host& operator=(Host const&) = delete;
68 /** Retrieves an host from its name, or return nullptr */
69 static Host* by_name_or_null(std::string name);
70 /** Retrieves an host from its name, or die */
71 static s4u::Host* by_name(std::string name);
72 /** Retrieves the host on which the current actor is running */
73 static s4u::Host* current();
75 /** Retrieves the name of that host as a C++ string */
76 simgrid::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 * All actors on that host which were marked autorestart will be restarted automatically.
86 * This call does nothing if the host is already on.
89 /** Turns that host off. All actors are forcefully stopped. */
91 /** Returns if that host is currently up and running */
93 /** Returns if that host is currently down and offline */
94 bool is_off() const { return not is_on(); }
96 const char* get_property(std::string key) const;
97 void set_property(std::string key, std::string value);
98 std::unordered_map<std::string, std::string>* get_properties();
101 /** @deprecated See Host::get_properties() */
102 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_properties()") std::map<std::string, std::string>* getProperties()
104 std::map<std::string, std::string>* res = new std::map<std::string, std::string>();
105 std::unordered_map<std::string, std::string>* props = get_properties();
106 for (auto const& kv : *props)
112 double get_speed() const;
113 double get_available_speed() const;
114 int get_core_count() const;
115 double get_load() const;
117 double get_pstate_speed(int pstate_index) const;
118 int get_pstate_count() const;
119 void set_pstate(int pstate_index);
120 int get_pstate() const;
123 /** @deprecated See Host::get_speed() */
124 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_speed() instead.") double getSpeed() { return get_speed(); }
125 /** @deprecated See Host::get_pstate_speed() */
126 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate_speed() instead.") double getPstateSpeed(int pstate_index)
128 return get_pstate_speed(pstate_index);
132 std::vector<const char*> get_attached_storages() const;
133 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages(
134 std::vector<const char*>* storages);
136 /** Get an associative list [mount point]->[Storage] of all local mount points.
138 * This is defined in the platform file, and cannot be modified programatically (yet).
140 std::unordered_map<std::string, Storage*> const& get_mounted_storages();
141 /** @deprecated See Host::get_mounted_storages() */
142 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_mounted_storages() instead.") std::unordered_map<std::string, Storage*> const& getMountedStorages()
144 return get_mounted_storages();
147 void route_to(Host* dest, std::vector<Link*>& links, double* latency);
148 void route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency);
150 /** Block the calling actor on an execution located on the called host
152 * It is not a problem if the actor is not located on the called host.
153 * The actor will not be migrated in this case. Such remote execution are easy in simulation.
155 void execute(double flops);
156 /** Start an asynchronous computation on that host (possibly remote) */
157 ExecPtr exec_async(double flops_amounts);
159 /** Block the calling actor on an execution located on the called host (with explicit priority) */
160 void execute(double flops, double priority);
162 // Deprecated functions
164 /** @deprecated See Host::get_name() */
165 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_name()") simgrid::xbt::string const& getName() const
169 /** @deprecated See Host::get_cname() */
170 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_cname()") const char* getCname() const { return name_.c_str(); }
171 /** @deprecated See Host::get_all_actors() */
172 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void actorList(std::vector<ActorPtr>* whereto);
173 /** @deprecated See Host::get_all_actors() */
174 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void getProcesses(std::vector<ActorPtr>* list);
175 /** @deprecated See Host::turn_on() */
176 XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_on()") void turnOn() { turn_on(); }
177 /** @deprecated See Host::turn_off() */
178 XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_off()") void turnOff() { turn_off(); }
179 /** @deprecated See Host::is_on() */
180 XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_on()") bool isOn() { return is_on(); }
181 /** @deprecated See Host::is_off() */
182 XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_off()") bool isOff() { return is_off(); }
183 /** @deprecated See Host::get_property() */
184 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_property()") const char* getProperty(const char* key)
186 return get_property(key);
188 /** @deprecated See Host::set_property() */
189 XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_property()") void setProperty(std::string key, std::string value)
191 set_property(key, value);
193 /** @deprecated See Host::set_pstate() */
194 XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_pstate()") void setPstate(int idx) { set_pstate(idx); }
195 /** @deprecated See Host::get_pstate() */
196 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate()") int getPstate() { return get_pstate(); }
197 /** @deprecated See Host::route_to() */
198 XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(Host* dest, std::vector<Link*>& links,
201 route_to(dest, links, latency);
203 /** @deprecated See Host::route_to() */
204 XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(
205 Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
207 route_to(dest, links, latency);
209 /** @deprecated See Host::get_core_count() */
210 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_core_count()") int getCoreCount() { return get_core_count(); }
211 /** @deprecated See Host::get_pstate_count() */
212 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate_count()") int getPstatesCount() const
214 return get_pstate_count();
216 #endif /* !DOXYGEN */
219 simgrid::xbt::string name_ {"noname"};
220 std::unordered_map<std::string, Storage*>* mounts_ = nullptr; // caching
223 /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
224 surf::Cpu* pimpl_cpu = nullptr;
225 // TODO, this could be a unique_ptr
226 surf::HostImpl* pimpl_ = nullptr;
227 /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
228 kernel::routing::NetPoint* pimpl_netpoint = nullptr;
231 } // namespace simgrid::s4u
233 extern int USER_HOST_LEVEL;
235 #endif /* SIMGRID_S4U_HOST_HPP */