Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
setter function only need a simcall in MC or with parallel execs
[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 "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(std::string("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(std::string("Impossible to create disk: ") + name +
344                                 std::string(". Invalid read bandwidth: ") + read_bandwidth);
345   }
346   double d_write;
347   try {
348     d_write = xbt_parse_get_bandwidth("", 0, write_bandwidth, "");
349   } catch (const simgrid::ParseError&) {
350     throw std::invalid_argument(std::string("Impossible to create disk: ") + name +
351                                 std::string(". Invalid write bandwidth: ") + write_bandwidth);
352   }
353   return create_disk(name, d_read, d_write);
354 }
355
356 void Host::add_disk(const Disk* disk)
357 {
358   kernel::actor::simcall_answered([this, disk] { this->pimpl_->add_disk(disk); });
359 }
360
361 void Host::remove_disk(const std::string& disk_name)
362 {
363   kernel::actor::simcall_answered([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
364 }
365
366 VirtualMachine* Host::create_vm(const std::string& name, int core_amount)
367 {
368   return kernel::actor::simcall_answered(
369       [this, &name, core_amount] { return this->pimpl_->create_vm(name, core_amount); });
370 }
371
372 VirtualMachine* Host::create_vm(const std::string& name, int core_amount, size_t ramsize)
373 {
374   return kernel::actor::simcall_answered(
375       [this, &name, core_amount, ramsize] { return this->pimpl_->create_vm(name, core_amount, ramsize); });
376 }
377
378 VirtualMachine* Host::vm_by_name_or_null(const std::string& name)
379 {
380   simgrid::kernel::resource::VirtualMachineImpl* vm = this->pimpl_->get_vm_by_name_or_null(name);
381   return vm ? vm->get_iface() : nullptr;
382 }
383
384 ExecPtr Host::exec_init(double flops) const
385 {
386   return this_actor::exec_init(flops);
387 }
388
389 ExecPtr Host::exec_async(double flops) const
390 {
391   return this_actor::exec_async(flops);
392 }
393
394 void Host::execute(double flops) const
395 {
396   execute(flops, 1.0 /* priority */);
397 }
398
399 void Host::execute(double flops, double priority) const
400 {
401   this_actor::exec_init(flops)->set_priority(1 / priority)->vetoable_start()->wait();
402 }
403
404 Host* Host::seal()
405 {
406   kernel::actor::simcall_answered([this]() { this->pimpl_->seal(); });
407   simgrid::s4u::Host::on_creation(*this); // notify the signal
408   return this;
409 }
410
411 } // namespace s4u
412 } // namespace simgrid
413
414 /* **************************** Public C interface *************************** */
415 size_t sg_host_count()
416 {
417   return simgrid::s4u::Engine::get_instance()->get_host_count();
418 }
419 sg_host_t* sg_host_list()
420 {
421   const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
422   size_t host_count             = e->get_host_count();
423
424   xbt_assert(host_count > 0, "There is no host!");
425   std::vector<simgrid::s4u::Host*> hosts = e->get_all_hosts();
426
427   auto* res = xbt_new(sg_host_t, hosts.size());
428   std::copy(begin(hosts), end(hosts), res);
429
430   return res;
431 }
432
433 const char* sg_host_get_name(const_sg_host_t host)
434 {
435   return host->get_cname();
436 }
437
438 void* sg_host_extension_get(const_sg_host_t host, size_t ext)
439 {
440   return host->extension(ext);
441 }
442
443 size_t sg_host_extension_create(void (*deleter)(void*))
444 {
445   return simgrid::s4u::Host::extension_create(deleter);
446 }
447
448 sg_host_t sg_host_by_name(const char* name)
449 {
450   return simgrid::s4u::Host::by_name_or_null(name);
451 }
452
453 /** @brief Retrieve a VM running on a given host from its name, or return NULL if no VM matches*/
454 sg_vm_t sg_vm_by_name(sg_host_t host, const char* name)
455 {
456   return host->vm_by_name_or_null(name);
457 }
458
459 // ========= Layering madness ==============*
460
461 // ========== User data Layer ==========
462 void* sg_host_get_data(const_sg_host_t host)
463 {
464   return host->get_data<void>();
465 }
466 void sg_host_set_data(sg_host_t host, void* userdata)
467 {
468   host->set_data(userdata);
469 }
470
471 // ========= Disk related functions ============
472 void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks)
473 {
474   std::vector<sg_disk_t> list = host->get_disks();
475   *disk_count                 = list.size();
476   *disks                      = xbt_new(sg_disk_t, list.size());
477   std::copy(begin(list), end(list), *disks);
478 }
479
480 // =========== user-level functions ===============
481 // ================================================
482 /** @brief Returns the total speed of a host */
483 double sg_host_get_speed(const_sg_host_t host)
484 {
485   return host->get_speed();
486 }
487
488 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_host_energy.
489  *
490  * @param  host host to test
491  * @param pstate_index pstate to test
492  * @return Returns the processor speed associated with pstate_index
493  */
494 double sg_host_get_pstate_speed(const_sg_host_t host, unsigned long pstate_index)
495 {
496   return host->get_pstate_speed(pstate_index);
497 }
498
499 /** @ingroup m_host_management
500  * @brief Return the number of cores.
501  *
502  * @param host a host
503  * @return the number of cores
504  */
505 int sg_host_core_count(const_sg_host_t host)
506 {
507   return host->get_core_count();
508 }
509
510 double sg_host_get_available_speed(const_sg_host_t host)
511 {
512   return host->get_available_speed();
513 }
514
515 /** @brief Returns the number of power states for a host.
516  *
517  *  See also @ref plugin_host_energy.
518  */
519 unsigned long sg_host_get_nb_pstates(const_sg_host_t host)
520 {
521   return host->get_pstate_count();
522 }
523
524 /** @brief Gets the pstate at which that host currently runs.
525  *
526  *  See also @ref plugin_host_energy.
527  */
528 unsigned long sg_host_get_pstate(const_sg_host_t host)
529 {
530   return host->get_pstate();
531 }
532 /** @brief Sets the pstate at which that host should run.
533  *
534  *  See also @ref plugin_host_energy.
535  */
536 void sg_host_set_pstate(sg_host_t host, unsigned long pstate)
537 {
538   host->set_pstate(pstate);
539 }
540
541 /** @ingroup m_host_management
542  *
543  * @brief Start the host if it is off
544  *
545  * See also #sg_host_is_on() to test the current state of the host and @ref plugin_host_energy
546  * for more info on DVFS.
547  */
548 void sg_host_turn_on(sg_host_t host)
549 {
550   host->turn_on();
551 }
552
553 /** @ingroup m_host_management
554  *
555  * @brief Stop the host if it is on
556  *
557  * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_host_energy
558  * for more info on DVFS.
559  */
560 void sg_host_turn_off(sg_host_t host)
561 {
562   host->turn_off();
563 }
564
565 /** @ingroup m_host_management
566  * @brief Determine if a host is up and running.
567  *
568  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_host_energy for
569  * more info on DVFS.
570  *
571  * @param host host to test
572  * @return Returns true if the host is up and running, and false if it's currently down
573  */
574 int sg_host_is_on(const_sg_host_t host)
575 {
576   return host->is_on();
577 }
578
579 /** @brief Get the properties of a host */
580 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
581 {
582   const std::unordered_map<std::string, std::string>* props = host->get_properties();
583   xbt_dict_t as_dict                                        = xbt_dict_new_homogeneous(xbt_free_f);
584
585   if (props == nullptr)
586     return nullptr;
587   for (auto const& [key, value] : *props) {
588     xbt_dict_set(as_dict, key.c_str(), xbt_strdup(value.c_str()));
589   }
590   return as_dict;
591 }
592
593 /** @ingroup m_host_management
594  * @brief Returns the value of a given host property
595  *
596  * @param host a host
597  * @param name a property name
598  * @return value of a property (or nullptr if property not set)
599  */
600 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
601 {
602   return host->get_property(name);
603 }
604
605 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
606 {
607   host->set_property(name, value);
608 }
609
610 /**
611  * @brief Find a route between two hosts
612  *
613  * @param from where from
614  * @param to where to
615  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
616  */
617 void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
618 {
619   std::vector<simgrid::s4u::Link*> vlinks;
620   from->route_to(to, vlinks, nullptr);
621   for (auto const& link : vlinks)
622     xbt_dynar_push(links, &link);
623 }
624 /**
625  * @brief Find the latency of the route between two hosts
626  *
627  * @param from where from
628  * @param to where to
629  */
630 double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
631 {
632   std::vector<simgrid::s4u::Link*> vlinks;
633   double res = 0;
634   from->route_to(to, vlinks, &res);
635   return res;
636 }
637 /**
638  * @brief Find the bandwidth of the route between two hosts
639  *
640  * @param from where from
641  * @param to where to
642  */
643 double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
644 {
645   double min_bandwidth = -1.0;
646
647   std::vector<simgrid::s4u::Link*> vlinks;
648   from->route_to(to, vlinks, nullptr);
649   for (auto const& link : vlinks) {
650     double bandwidth = link->get_bandwidth();
651     if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
652       min_bandwidth = bandwidth;
653   }
654   return min_bandwidth;
655 }
656
657 void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
658 {
659   simgrid::s4u::Comm::sendto(from, to, byte_amount);
660 }
661
662 /** @brief Displays debugging information about a host */
663 void sg_host_dump(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v335
664 {
665   XBT_INFO("Displaying host %s", host->get_cname());
666   XBT_INFO("  - speed: %.0f", host->get_speed());
667   XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
668   const std::unordered_map<std::string, std::string>* props = host->get_properties();
669
670   if (not props->empty()) {
671     XBT_INFO("  - properties:");
672     for (auto const& [key, value] : *props) {
673       XBT_INFO("    %s->%s", key.c_str(), value.c_str());
674     }
675   }
676 }
677
678 /** @brief Return the list of actors attached to a host.
679  *
680  * @param host a host
681  * @param whereto a dynar in which we should push actors living on that host
682  */
683 void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
684 {
685   auto const actors = host->get_all_actors();
686   for (auto const& actor : actors)
687     xbt_dynar_push(whereto, &actor);
688 }
689
690 sg_host_t sg_host_self()
691 {
692   return simgrid::s4u::Actor::is_maestro() ? nullptr : simgrid::kernel::actor::ActorImpl::self()->get_host();
693 }
694
695 /* needs to be public and without simcall for exceptions and logging events */
696 const char* sg_host_self_get_name()
697 {
698   const char* res = "";
699   if (not simgrid::s4u::Actor::is_maestro()) {
700     const simgrid::s4u::Host* host = simgrid::kernel::actor::ActorImpl::self()->get_host();
701     if (host != nullptr)
702       res = host->get_cname();
703   }
704   return res;
705 }
706
707 double sg_host_get_load(const_sg_host_t host)
708 {
709   return host->get_load();
710 }