Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Hosts and VMs internal refactor.
[simgrid.git] / src / s4u / s4u_Host.cpp
1 /* Copyright (c) 2006-2022. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #include <simgrid/Exception.hpp>
7 #include <simgrid/host.h>
8 #include <simgrid/kernel/routing/NetPoint.hpp>
9 #include <simgrid/s4u/Comm.hpp>
10 #include <simgrid/s4u/Engine.hpp>
11 #include <simgrid/s4u/Exec.hpp>
12 #include <simgrid/s4u/Host.hpp>
13 #include <simgrid/s4u/VirtualMachine.hpp>
14 #include <xbt/parse_units.hpp>
15
16 #include "src/kernel/resource/StandardLinkImpl.hpp"
17 #include "src/kernel/resource/VirtualMachineImpl.hpp"
18 #include "src/surf/HostImpl.hpp"
19
20 #include <string>
21
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_host, s4u, "Logging specific to the S4U hosts");
23 XBT_LOG_EXTERNAL_CATEGORY(ker_routing);
24
25 namespace simgrid {
26
27 template class xbt::Extendable<s4u::Host>;
28
29 namespace s4u {
30
31 #ifndef DOXYGEN
32 xbt::signal<void(Host&)> Host::on_creation;
33 xbt::signal<void(Host const&)> Host::on_destruction;
34 xbt::signal<void(Host const&)> Host::on_state_change;
35 xbt::signal<void(Host const&)> Host::on_speed_change;
36 #endif
37
38 Host* Host::set_cpu(kernel::resource::CpuImpl* cpu)
39 {
40   pimpl_cpu_ = cpu;
41   return this;
42 }
43
44 #ifndef DOXYGEN
45 Host* Host::set_netpoint(kernel::routing::NetPoint* netpoint)
46 {
47   pimpl_netpoint_ = netpoint;
48   return this;
49 }
50
51 Host::~Host()
52 {
53   if (pimpl_netpoint_ != nullptr) // not removed yet by a children class
54     Engine::get_instance()->netpoint_unregister(pimpl_netpoint_);
55   delete pimpl_cpu_;
56 }
57 #endif
58
59 /** @brief Fire the required callbacks and destroy the object
60  *
61  * Don't delete directly a host, call h->destroy() instead.
62  *
63  * This is cumbersome but this is the simplest solution to ensure that the on_destruction() callback receives a valid
64  * object (because of the destructor order in a class hierarchy).
65  */
66 void Host::destroy()
67 {
68   kernel::actor::simcall_answered([this] { this->pimpl_->destroy(); });
69 }
70
71 Host* Host::by_name(const std::string& name)
72 {
73   return Engine::get_instance()->host_by_name(name);
74 }
75 Host* Host::by_name_or_null(const std::string& name)
76 {
77   return Engine::get_instance()->host_by_name_or_null(name);
78 }
79
80 Host* Host::current()
81 {
82   const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
83   xbt_assert(self != nullptr, "Cannot call Host::current() from the maestro context");
84   return self->get_host();
85 }
86
87 xbt::string const& Host::get_name() const
88 {
89   return this->pimpl_->get_name();
90 }
91
92 const char* Host::get_cname() const
93 {
94   return this->pimpl_->get_cname();
95 }
96
97 void Host::turn_on()
98 {
99   if (not is_on()) {
100     kernel::actor::simcall_answered([this] {
101       this->pimpl_cpu_->turn_on();
102       this->pimpl_->turn_on();
103       on_state_change(*this);
104     });
105   }
106 }
107
108 /** @brief Stop the host if it is on */
109 void Host::turn_off()
110 {
111   if (is_on()) {
112     const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
113     kernel::actor::simcall_answered([this, self] {
114       this->pimpl_cpu_->turn_off();
115       this->pimpl_->turn_off(self);
116
117       on_state_change(*this);
118     });
119   }
120 }
121
122 bool Host::is_on() const
123 {
124   return this->pimpl_cpu_->is_on();
125 }
126
127 unsigned long Host::get_pstate_count() const
128 {
129   return this->pimpl_cpu_->get_pstate_count();
130 }
131
132 /**
133  * @brief Return a copy of the list of actors that are executing on this host.
134  *
135  * Daemons and regular actors are all mixed in this list.
136  */
137 std::vector<ActorPtr> Host::get_all_actors() const
138 {
139   return pimpl_->get_all_actors();
140 }
141
142 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
143 size_t Host::get_actor_count() const
144 {
145   return pimpl_->get_actor_count();
146 }
147
148 /**
149  * @brief Find a route toward another host
150  *
151  * @param dest [IN] where to
152  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
153  * @param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
154  *                It is the caller responsibility to initialize latency to 0 (we add to provided route)
155  *
156  * walk through the routing components tree and find a route between hosts
157  * by calling each "get_route" function in each routing component.
158  */
159 void Host::route_to(const Host* dest, std::vector<Link*>& links, double* latency) const
160 {
161   std::vector<kernel::resource::StandardLinkImpl*> linkImpls;
162   this->route_to(dest, linkImpls, latency);
163   for (auto* l : linkImpls)
164     links.push_back(l->get_iface());
165 }
166
167 /** @brief Just like Host::routeTo, but filling an array of link implementations */
168 void Host::route_to(const Host* dest, std::vector<kernel::resource::StandardLinkImpl*>& links, double* latency) const
169 {
170   kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint_, dest->get_netpoint(), links, latency);
171   if (XBT_LOG_ISENABLED(ker_routing, xbt_log_priority_debug)) {
172     XBT_CDEBUG(ker_routing, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
173                (latency == nullptr ? -1 : *latency));
174     for (auto const* link : links)
175       XBT_CDEBUG(ker_routing, "  Link '%s'", link->get_cname());
176   }
177 }
178
179 /** @brief Returns the networking zone englobing that host */
180 NetZone* Host::get_englobing_zone() const
181 {
182   return pimpl_netpoint_->get_englobing_zone()->get_iface();
183 }
184
185 /** Get the properties assigned to a host */
186 const std::unordered_map<std::string, std::string>* Host::get_properties() const
187 {
188   return this->pimpl_->get_properties();
189 }
190
191 /** Retrieve the property value (or nullptr if not set) */
192 const char* Host::get_property(const std::string& key) const
193 {
194   return this->pimpl_->get_property(key);
195 }
196
197 Host* Host::set_property(const std::string& key, const std::string& value)
198 {
199   kernel::actor::simcall_answered([this, &key, &value] { this->pimpl_->set_property(key, value); });
200   return this;
201 }
202
203 Host* Host::set_properties(const std::unordered_map<std::string, std::string>& properties)
204 {
205   kernel::actor::simcall_answered([this, &properties] { this->pimpl_->set_properties(properties); });
206   return this;
207 }
208
209 /** Specify a profile turning the host on and off according to an exhaustive list or a stochastic law.
210  * The profile must contain boolean values. */
211 Host* Host::set_state_profile(kernel::profile::Profile* p)
212 {
213   kernel::actor::simcall_answered([this, p] { pimpl_cpu_->set_state_profile(p); });
214   return this;
215 }
216 /** Specify a profile modeling the external load according to an exhaustive list or a stochastic law.
217  *
218  * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
219  * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
220  * at this pstate level) by the rate coming from the profile.
221  */
222 Host* Host::set_speed_profile(kernel::profile::Profile* p)
223 {
224   kernel::actor::simcall_answered([this, p] { pimpl_cpu_->set_speed_profile(p); });
225   return this;
226 }
227
228 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
229 double Host::get_pstate_speed(unsigned long pstate_index) const
230 {
231   return this->pimpl_cpu_->get_pstate_peak_speed(pstate_index);
232 }
233
234 double Host::get_speed() const
235 {
236   return this->pimpl_cpu_->get_speed(1.0);
237 }
238 double Host::get_load() const
239 {
240   return this->pimpl_cpu_->get_load();
241 }
242 double Host::get_available_speed() const
243 {
244   return this->pimpl_cpu_->get_speed_ratio();
245 }
246
247 Host* Host::set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb)
248 {
249   kernel::actor::simcall_answered([this, policy, &cb] { pimpl_cpu_->set_sharing_policy(policy, cb); });
250   return this;
251 }
252
253 Host::SharingPolicy Host::get_sharing_policy() const
254 {
255   return this->pimpl_cpu_->get_sharing_policy();
256 }
257
258 int Host::get_core_count() const
259 {
260   return this->pimpl_cpu_->get_core_count();
261 }
262
263 Host* Host::set_core_count(int core_count)
264 {
265   kernel::actor::simcall_answered([this, core_count] { this->pimpl_cpu_->set_core_count(core_count); });
266   return this;
267 }
268
269 Host* Host::set_pstate_speed(const std::vector<double>& speed_per_state)
270 {
271   kernel::actor::simcall_answered([this, &speed_per_state] { pimpl_cpu_->set_pstate_speed(speed_per_state); });
272   return this;
273 }
274
275 std::vector<double> Host::convert_pstate_speed_vector(const std::vector<std::string>& speed_per_state)
276 {
277   std::vector<double> speed_list;
278   speed_list.reserve(speed_per_state.size());
279   for (const auto& speed_str : speed_per_state) {
280     try {
281       double speed = xbt_parse_get_speed("", 0, speed_str, "");
282       speed_list.push_back(speed);
283     } catch (const simgrid::ParseError&) {
284       throw std::invalid_argument(std::string("Invalid speed value: ") + speed_str);
285     }
286   }
287   return speed_list;
288 }
289
290 Host* Host::set_pstate_speed(const std::vector<std::string>& speed_per_state)
291 {
292   set_pstate_speed(Host::convert_pstate_speed_vector(speed_per_state));
293   return this;
294 }
295
296 /** @brief Set the pstate at which the host should run */
297 Host* Host::set_pstate(unsigned long pstate_index)
298 {
299   kernel::actor::simcall_answered([this, pstate_index] { this->pimpl_cpu_->set_pstate(pstate_index); });
300   return this;
301 }
302
303 /** @brief Retrieve the pstate at which the host is currently running */
304 unsigned long Host::get_pstate() const
305 {
306   return this->pimpl_cpu_->get_pstate();
307 }
308
309 Host* Host::set_factor_cb(const std::function<CpuFactorCb>& cb)
310 {
311   kernel::actor::simcall_answered([this, &cb] { pimpl_cpu_->set_factor_cb(cb); });
312   return this;
313 }
314
315 Host* Host::set_coordinates(const std::string& coords)
316 {
317   if (not coords.empty())
318     kernel::actor::simcall_answered([this, coords] { this->pimpl_netpoint_->set_coordinates(coords); });
319   return this;
320 }
321 std::vector<Disk*> Host::get_disks() const
322 {
323   return this->pimpl_->get_disks();
324 }
325
326 Disk* Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
327 {
328   return kernel::actor::simcall_answered([this, &name, read_bandwidth, write_bandwidth] {
329     auto* disk = pimpl_->create_disk(name, read_bandwidth, write_bandwidth);
330     pimpl_->add_disk(disk);
331     return disk;
332   });
333 }
334
335 Disk* Host::create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth)
336 {
337   double d_read;
338   try {
339     d_read = xbt_parse_get_bandwidth("", 0, read_bandwidth, "");
340   } catch (const simgrid::ParseError&) {
341     throw std::invalid_argument(std::string("Impossible to create disk: ") + name +
342                                 std::string(". Invalid read bandwidth: ") + read_bandwidth);
343   }
344   double d_write;
345   try {
346     d_write = xbt_parse_get_bandwidth("", 0, write_bandwidth, "");
347   } catch (const simgrid::ParseError&) {
348     throw std::invalid_argument(std::string("Impossible to create disk: ") + name +
349                                 std::string(". Invalid write bandwidth: ") + write_bandwidth);
350   }
351   return create_disk(name, d_read, d_write);
352 }
353
354 void Host::add_disk(const Disk* disk)
355 {
356   kernel::actor::simcall_answered([this, disk] { this->pimpl_->add_disk(disk); });
357 }
358
359 void Host::remove_disk(const std::string& disk_name)
360 {
361   kernel::actor::simcall_answered([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
362 }
363
364 VirtualMachine* Host::create_vm(const std::string& name, int core_amount)
365 {
366   return kernel::actor::simcall_answered(
367       [this, &name, core_amount] { return this->pimpl_->create_vm(name, core_amount); });
368 }
369
370 VirtualMachine* Host::create_vm(const std::string& name, int core_amount, size_t ramsize)
371 {
372   return kernel::actor::simcall_answered(
373       [this, &name, core_amount, ramsize] { return this->pimpl_->create_vm(name, core_amount, ramsize); });
374 }
375
376 ExecPtr Host::exec_init(double flops) const
377 {
378   return this_actor::exec_init(flops);
379 }
380
381 ExecPtr Host::exec_async(double flops) const
382 {
383   return this_actor::exec_async(flops);
384 }
385
386 void Host::execute(double flops) const
387 {
388   execute(flops, 1.0 /* priority */);
389 }
390
391 void Host::execute(double flops, double priority) const
392 {
393   this_actor::exec_init(flops)->set_priority(1 / priority)->vetoable_start()->wait();
394 }
395
396 Host* Host::seal()
397 {
398   kernel::actor::simcall_answered([this]() { this->pimpl_->seal(); });
399   simgrid::s4u::Host::on_creation(*this); // notify the signal
400   return this;
401 }
402
403 } // namespace s4u
404 } // namespace simgrid
405
406 /* **************************** Public C interface *************************** */
407 size_t sg_host_count()
408 {
409   return simgrid::s4u::Engine::get_instance()->get_host_count();
410 }
411 sg_host_t* sg_host_list()
412 {
413   const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
414   size_t host_count             = e->get_host_count();
415
416   xbt_assert(host_count > 0, "There is no host!");
417   std::vector<simgrid::s4u::Host*> hosts = e->get_all_hosts();
418
419   auto* res = xbt_new(sg_host_t, hosts.size());
420   std::copy(begin(hosts), end(hosts), res);
421
422   return res;
423 }
424
425 const char* sg_host_get_name(const_sg_host_t host)
426 {
427   return host->get_cname();
428 }
429
430 void* sg_host_extension_get(const_sg_host_t host, size_t ext)
431 {
432   return host->extension(ext);
433 }
434
435 size_t sg_host_extension_create(void (*deleter)(void*))
436 {
437   return simgrid::s4u::Host::extension_create(deleter);
438 }
439
440 sg_host_t sg_host_by_name(const char* name)
441 {
442   return simgrid::s4u::Host::by_name_or_null(name);
443 }
444
445 // ========= Layering madness ==============*
446
447 // ========== User data Layer ==========
448 void* sg_host_get_data(const_sg_host_t host)
449 {
450   return host->get_data<void>();
451 }
452 void sg_host_set_data(sg_host_t host, void* userdata)
453 {
454   host->set_data(userdata);
455 }
456
457 // ========= Disk related functions ============
458 void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks)
459 {
460   std::vector<sg_disk_t> list = host->get_disks();
461   *disk_count                 = list.size();
462   *disks                      = xbt_new(sg_disk_t, list.size());
463   std::copy(begin(list), end(list), *disks);
464 }
465
466 // =========== user-level functions ===============
467 // ================================================
468 /** @brief Returns the total speed of a host */
469 double sg_host_get_speed(const_sg_host_t host)
470 {
471   return host->get_speed();
472 }
473
474 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_host_energy.
475  *
476  * @param  host host to test
477  * @param pstate_index pstate to test
478  * @return Returns the processor speed associated with pstate_index
479  */
480 double sg_host_get_pstate_speed(const_sg_host_t host, unsigned long pstate_index)
481 {
482   return host->get_pstate_speed(pstate_index);
483 }
484
485 /** @ingroup m_host_management
486  * @brief Return the number of cores.
487  *
488  * @param host a host
489  * @return the number of cores
490  */
491 int sg_host_core_count(const_sg_host_t host)
492 {
493   return host->get_core_count();
494 }
495
496 double sg_host_get_available_speed(const_sg_host_t host)
497 {
498   return host->get_available_speed();
499 }
500
501 /** @brief Returns the number of power states for a host.
502  *
503  *  See also @ref plugin_host_energy.
504  */
505 unsigned long sg_host_get_nb_pstates(const_sg_host_t host)
506 {
507   return host->get_pstate_count();
508 }
509
510 /** @brief Gets the pstate at which that host currently runs.
511  *
512  *  See also @ref plugin_host_energy.
513  */
514 unsigned long sg_host_get_pstate(const_sg_host_t host)
515 {
516   return host->get_pstate();
517 }
518 /** @brief Sets the pstate at which that host should run.
519  *
520  *  See also @ref plugin_host_energy.
521  */
522 void sg_host_set_pstate(sg_host_t host, unsigned long pstate)
523 {
524   host->set_pstate(pstate);
525 }
526
527 /** @ingroup m_host_management
528  *
529  * @brief Start the host if it is off
530  *
531  * See also #sg_host_is_on() to test the current state of the host and @ref plugin_host_energy
532  * for more info on DVFS.
533  */
534 void sg_host_turn_on(sg_host_t host)
535 {
536   host->turn_on();
537 }
538
539 /** @ingroup m_host_management
540  *
541  * @brief Stop the host if it is on
542  *
543  * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_host_energy
544  * for more info on DVFS.
545  */
546 void sg_host_turn_off(sg_host_t host)
547 {
548   host->turn_off();
549 }
550
551 /** @ingroup m_host_management
552  * @brief Determine if a host is up and running.
553  *
554  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_host_energy for
555  * more info on DVFS.
556  *
557  * @param host host to test
558  * @return Returns true if the host is up and running, and false if it's currently down
559  */
560 int sg_host_is_on(const_sg_host_t host)
561 {
562   return host->is_on();
563 }
564
565 /** @brief Get the properties of a host */
566 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
567 {
568   const std::unordered_map<std::string, std::string>* props = host->get_properties();
569   xbt_dict_t as_dict                                        = xbt_dict_new_homogeneous(xbt_free_f);
570
571   if (props == nullptr)
572     return nullptr;
573   for (auto const& elm : *props) {
574     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()));
575   }
576   return as_dict;
577 }
578
579 /** @ingroup m_host_management
580  * @brief Returns the value of a given host property
581  *
582  * @param host a host
583  * @param name a property name
584  * @return value of a property (or nullptr if property not set)
585  */
586 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
587 {
588   return host->get_property(name);
589 }
590
591 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
592 {
593   host->set_property(name, value);
594 }
595
596 /**
597  * @brief Find a route between two hosts
598  *
599  * @param from where from
600  * @param to where to
601  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
602  */
603 void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
604 {
605   std::vector<simgrid::s4u::Link*> vlinks;
606   from->route_to(to, vlinks, nullptr);
607   for (auto const& link : vlinks)
608     xbt_dynar_push(links, &link);
609 }
610 /**
611  * @brief Find the latency of the route between two hosts
612  *
613  * @param from where from
614  * @param to where to
615  */
616 double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
617 {
618   std::vector<simgrid::s4u::Link*> vlinks;
619   double res = 0;
620   from->route_to(to, vlinks, &res);
621   return res;
622 }
623 /**
624  * @brief Find the bandwidth of the route between two hosts
625  *
626  * @param from where from
627  * @param to where to
628  */
629 double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
630 {
631   double min_bandwidth = -1.0;
632
633   std::vector<simgrid::s4u::Link*> vlinks;
634   from->route_to(to, vlinks, nullptr);
635   for (auto const& link : vlinks) {
636     double bandwidth = link->get_bandwidth();
637     if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
638       min_bandwidth = bandwidth;
639   }
640   return min_bandwidth;
641 }
642
643 void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
644 {
645   simgrid::s4u::Comm::sendto(from, to, byte_amount);
646 }
647
648 /** @brief Displays debugging information about a host */
649 void sg_host_dump(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v335
650 {
651   XBT_INFO("Displaying host %s", host->get_cname());
652   XBT_INFO("  - speed: %.0f", host->get_speed());
653   XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
654   const std::unordered_map<std::string, std::string>* props = host->get_properties();
655
656   if (not props->empty()) {
657     XBT_INFO("  - properties:");
658     for (auto const& elm : *props) {
659       XBT_INFO("    %s->%s", elm.first.c_str(), elm.second.c_str());
660     }
661   }
662 }
663
664 /** @brief Return the list of actors attached to a host.
665  *
666  * @param host a host
667  * @param whereto a dynar in which we should push actors living on that host
668  */
669 void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
670 {
671   auto const actors = host->get_all_actors();
672   for (auto const& actor : actors)
673     xbt_dynar_push(whereto, &actor);
674 }
675
676 sg_host_t sg_host_self()
677 {
678   return simgrid::s4u::Actor::is_maestro() ? nullptr : simgrid::kernel::actor::ActorImpl::self()->get_host();
679 }
680
681 /* needs to be public and without simcall for exceptions and logging events */
682 const char* sg_host_self_get_name()
683 {
684   const char* res = "";
685   if (not simgrid::s4u::Actor::is_maestro()) {
686     const simgrid::s4u::Host* host = simgrid::kernel::actor::ActorImpl::self()->get_host();
687     if (host != nullptr)
688       res = host->get_cname();
689   }
690   return res;
691 }
692
693 double sg_host_get_load(const_sg_host_t host)
694 {
695   return host->get_load();
696 }