1 /* Copyright (c) 2006-2021. 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>
19 extern template class XBT_PUBLIC xbt::Extendable<s4u::Host>;
26 * Some physical resource with computing and networking capabilities on which Actors execute.
29 * All hosts are automatically created during the call of the method
30 * :cpp:func:`simgrid::s4u::Engine::load_platform()`.
31 * You cannot create a host yourself.
33 * You can retrieve a particular host using :cpp:func:`simgrid::s4u::Host::by_name()`
34 * and actors can retrieve the host on which they run using :cpp:func:`simgrid::s4u::Host::current()` or
35 * :cpp:func:`simgrid::s4u::this_actor::get_host()`
38 class XBT_PUBLIC Host : public xbt::Extendable<Host> {
40 friend vm::VMModel; // Use the pimpl_cpu to compute the VM sharing
41 friend vm::VirtualMachineImpl; // creates the the pimpl_cpu
42 friend kernel::routing::NetZoneImpl;
43 friend surf::HostImpl; // call destructor from private implementation
45 // The private implementation, that never changes
46 surf::HostImpl* const pimpl_;
48 kernel::resource::CpuImpl* pimpl_cpu_ = nullptr;
49 kernel::routing::NetPoint* pimpl_netpoint_ = nullptr;
52 explicit Host(surf::HostImpl* pimpl) : pimpl_(pimpl) {}
55 virtual ~Host(); // Call destroy() instead of manually deleting it.
56 Host* set_netpoint(kernel::routing::NetPoint* netpoint);
60 /** Called on each newly created host */
61 static xbt::signal<void(Host&)> on_creation;
62 /** Called just before destructing a host */
63 static xbt::signal<void(Host const&)> on_destruction;
64 /** Called when the machine is turned on or off (called AFTER the change) */
65 static xbt::signal<void(Host const&)> on_state_change;
66 /** Called when the speed of the machine is changed (called AFTER the change)
67 * (either because of a pstate switch or because of an external load event coming from the profile) */
68 static xbt::signal<void(Host const&)> on_speed_change;
70 virtual void destroy();
73 Host(Host const&) = delete;
74 Host& operator=(Host const&) = delete;
77 /** Retrieve a host from its name, or return nullptr */
78 static Host* by_name_or_null(const std::string& name);
79 /** Retrieve a host from its name, or die */
80 static Host* by_name(const std::string& name);
81 /** Retrieves the host on which the running actor is located */
82 static Host* current();
84 /** Retrieves the name of that host as a C++ string */
85 xbt::string const& get_name() const;
86 /** Retrieves the name of that host as a C string */
87 const char* get_cname() const;
89 Host* set_cpu(kernel::resource::CpuImpl* cpu);
90 kernel::resource::CpuImpl* get_cpu() const { return pimpl_cpu_; }
91 kernel::routing::NetPoint* get_netpoint() const { return pimpl_netpoint_; }
93 * @brief Callback to set CPU factor
95 * This callback offers a flexible way to create variability in CPU executions
97 * @param flops Execution size in flops
98 * @return Multiply factor
100 using CpuFactorCb = double(double flops);
102 * @brief Configure the factor callback to the CPU associated to this host
104 Host* set_factor_cb(const std::function<CpuFactorCb>& cb);
106 size_t get_actor_count() const;
107 std::vector<ActorPtr> get_all_actors() const;
109 /** Turns that host on if it was previously off
111 * This call does nothing if the host is already on. If it was off, all actors which were marked 'autorestart' on that
112 * host will be restarted automatically (note that this may differ from the actors that were initially running on the
115 * All other Host's properties are left unchanged; in particular, the pstate is left unchanged and not reset to its
119 /** Turns that host off. All actors are forcefully stopped. */
121 /** Returns if that host is currently up and running */
124 const char* get_property(const std::string& key) const;
125 Host* set_property(const std::string& key, const std::string& value);
126 const std::unordered_map<std::string, std::string>* get_properties() const;
127 Host* set_properties(const std::unordered_map<std::string, std::string>& properties);
129 Host* set_state_profile(kernel::profile::Profile* p);
130 Host* set_speed_profile(kernel::profile::Profile* p);
132 /** @brief Convert the CPU's speed from string to double */
133 static std::vector<double> convert_pstate_speed_vector(const std::vector<std::string>& speed_per_state);
135 * @brief Set the CPU's speed
137 * @param speed_per_state list of powers for this processor (default power is at index 0)
139 Host* set_pstate_speed(const std::vector<double>& speed_per_state);
141 * @brief Set the CPU's speed (string version)
143 * @throw std::invalid_argument if speed format is incorrect.
145 Host* set_pstate_speed(const std::vector<std::string>& speed_per_state);
147 /** @brief Get the peak computing speed in flops/s at the current pstate, NOT taking the external load into account.
149 * The amount of flops per second available for computing depends on several things:
150 * - The current pstate determines the maximal peak computing speed (use @ref get_pstate_speed() to retrieve the
151 * computing speed you would get at another pstate)
152 * - If you declared an external load (with @ref set_speed_profile()), you must multiply the
153 * result of get_speed() by get_available_speed() to retrieve what a new computation would get.
155 * The remaining speed is then shared between the executions located on this host.
156 * You can retrieve the amount of tasks currently running on this host with @ref get_load().
158 * The host may have multiple cores, and your executions may be able to use more than a single core.
160 * Finally, executions of priority 2 get twice the amount of flops than executions of priority 1.
162 double get_speed() const;
163 /** @brief Get the available speed ratio, between 0 and 1.
165 * This accounts for external load (see @ref set_speed_profile()).
167 double get_available_speed() const;
169 /** Returns the number of core of the processor. */
170 int get_core_count() const;
171 Host* set_core_count(int core_count);
173 enum class SharingPolicy { NONLINEAR = 1, LINEAR = 0 };
175 * @brief Describes how the CPU is shared between concurrent tasks
177 * @param policy Sharing policy
178 * @param cb Callback for NONLINEAR policies
180 Host* set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {});
181 SharingPolicy get_sharing_policy() const;
183 /** Returns the current computation load (in flops per second)
185 * The external load (coming from an availability trace) is not taken in account.
186 * You may also be interested in the load plugin.
188 double get_load() const;
190 int get_pstate_count() const;
191 int get_pstate() const;
192 double get_pstate_speed(int pstate_index) const;
193 Host* set_pstate(int pstate_index);
194 Host* set_coordinates(const std::string& coords);
196 std::vector<Disk*> get_disks() const;
198 * @brief Create and add disk in the host
200 * @param name Disk name
201 * @param read_bandwidth Reading speed of the disk
202 * @param write_bandwidth Writing speed of the disk
204 Disk* create_disk(const std::string& name, double read_bandwidth, double write_bandwidth);
206 * @brief Human-friendly version of create_disk function.
208 * @throw std::invalid_argument if read/write speeds are incorrect
210 Disk* create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth);
211 void add_disk(const Disk* disk);
212 void remove_disk(const std::string& disk_name);
214 void route_to(const Host* dest, std::vector<Link*>& links, double* latency) const;
215 void route_to(const Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency) const;
218 * @brief Seal this host
219 * No more configuration is allowed after the seal
224 XBT_ATTRIB_DEPRECATED_v331("Please use Comm::sendto()") void sendto(Host* dest, double byte_amount);
225 XBT_ATTRIB_DEPRECATED_v331("Please use Comm::sendto_async()") CommPtr sendto_async(Host* dest, double byte_amount);
226 XBT_ATTRIB_DEPRECATED_v330("Please use Host::sendto()") void send_to(Host* dest, double byte_amount);
229 NetZone* get_englobing_zone() const;
230 /** Block the calling actor on an execution located on the called host
232 * It is not a problem if the actor is not located on the called host.
233 * The actor will not be migrated in this case. Such remote execution are easy in simulation.
235 void execute(double flops) const;
236 /** Start an asynchronous computation on that host (possibly remote) */
237 ExecPtr exec_init(double flops_amounts) const;
238 ExecPtr exec_async(double flops_amounts) const;
240 /** Block the calling actor on an execution located on the called host (with explicit priority) */
241 void execute(double flops, double priority) const;
242 surf::HostImpl* get_impl() const { return pimpl_; }
245 } // namespace simgrid
247 #endif /* SIMGRID_S4U_HOST_HPP */