Logo AND Algorithmique Numérique Distribuée

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