Logo AND Algorithmique Numérique Distribuée

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