Logo AND Algorithmique Numérique Distribuée

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