Logo AND Algorithmique Numérique Distribuée

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