Logo AND Algorithmique Numérique Distribuée

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