Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
a99e6a8680518c42bec31ab5f30f928f2ad9a502
[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     simix::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     simix::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 /** Get the properties assigned to a host */
175 const std::unordered_map<std::string, std::string>* Host::get_properties() const
176 {
177   return this->pimpl_->get_properties();
178 }
179
180 /** Retrieve the property value (or nullptr if not set) */
181 const char* Host::get_property(const std::string& key) const
182 {
183   return this->pimpl_->get_property(key);
184 }
185
186 void Host::set_property(const std::string& key, const std::string& value)
187 {
188   simix::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
189 }
190
191 void Host::set_properties(const std::map<std::string, std::string>& properties)
192 {
193   simix::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
194 }
195
196 /** Specify a profile turning the host on and off according to a exhaustive list or a stochastic law.
197  * The profile must contain boolean values. */
198 void Host::set_state_profile(kernel::profile::Profile* p)
199 {
200   return simix::simcall([this, p] { pimpl_cpu->set_state_profile(p); });
201 }
202 /** Specify a profile modeling the external load according to a exhaustive list or a stochastic law.
203  *
204  * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
205  * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
206  * at this pstate level) by the rate coming from the profile.
207  */
208 void Host::set_speed_profile(kernel::profile::Profile* p)
209 {
210   return simix::simcall([this, p] { pimpl_cpu->set_speed_profile(p); });
211 }
212
213 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
214 double Host::get_pstate_speed(int pstate_index) const
215 {
216   return this->pimpl_cpu->get_pstate_peak_speed(pstate_index);
217 }
218
219 /** @brief Get the peak computing speed in flops/s at the current pstate, NOT taking the external load into account.
220  *
221  *  The amount of flops per second available for computing depends on several things:
222  *    - The current pstate determines the maximal peak computing speed (use @ref get_pstate_speed() to retrieve the
223  *      computing speed you would get at another pstate)
224  *    - If you declared an external load (with @ref simgrid::surf::Cpu::set_speed_profile()), you must multiply the
225  * result of get_speed() by get_available_speed() to retrieve what a new computation would get.
226  *
227  *  The remaining speed is then shared between the executions located on this host.
228  *  You can retrieve the amount of tasks currently running on this host with @ref get_load().
229  *
230  *  The host may have multiple cores, and your executions may be able to use more than a single core.
231  *
232  *  Finally, executions of priority 2 get twice the amount of flops than executions of priority 1.
233  */
234 double Host::get_speed() const
235 {
236   return this->pimpl_cpu->get_speed(1.0);
237 }
238 /** @brief Returns the current computation load (in flops per second)
239  *
240  * The external load (coming from an availability trace) is not taken in account.
241  * You may also be interested in the load plugin.
242  */
243 double Host::get_load() const
244 {
245   return this->pimpl_cpu->get_load();
246 }
247 /** @brief Get the available speed ratio, between 0 and 1.
248  *
249  * This accounts for external load (see @ref simgrid::surf::Cpu::set_speed_profile()).
250  */
251 double Host::get_available_speed() const
252 {
253   return this->pimpl_cpu->get_speed_ratio();
254 }
255
256 /** @brief Returns the number of core of the processor. */
257 int Host::get_core_count() const
258 {
259   return this->pimpl_cpu->get_core_count();
260 }
261
262 /** @brief Set the pstate at which the host should run */
263 void Host::set_pstate(int pstate_index)
264 {
265   simix::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
266 }
267 /** @brief Retrieve the pstate at which the host is currently running */
268 int Host::get_pstate() const
269 {
270   return this->pimpl_cpu->get_pstate();
271 }
272
273 /**
274  * @ingroup simix_storage_management
275  * @brief Returns the list of storages attached to a host.
276  * @return a vector containing all storages attached to the host
277  */
278 std::vector<const char*> Host::get_attached_storages() const
279 {
280   return simix::simcall([this] { return this->pimpl_->get_attached_storages(); });
281 }
282
283 std::unordered_map<std::string, Storage*> const& Host::get_mounted_storages()
284 {
285   if (mounts_ == nullptr) {
286     mounts_ = new std::unordered_map<std::string, Storage*>();
287     for (auto const& m : this->pimpl_->storage_) {
288       mounts_->insert({m.first, &m.second->piface_});
289     }
290   }
291   return *mounts_;
292 }
293
294 ExecPtr Host::exec_async(double flops)
295 {
296   return this_actor::exec_init(flops);
297 }
298
299 void Host::execute(double flops)
300 {
301   execute(flops, 1.0 /* priority */);
302 }
303
304 void Host::execute(double flops, double priority)
305 {
306   this_actor::exec_init(flops)->set_priority(1 / priority)->start()->wait();
307 }
308
309 } // namespace s4u
310 } // namespace simgrid
311
312 /* **************************** Public C interface *************************** */
313 size_t sg_host_count()
314 {
315   return simgrid::s4u::Engine::get_instance()->get_host_count();
316 }
317 /** @brief Returns the host list
318  *
319  * Uses sg_host_count() to know the array size.
320  *
321  * @return an array of @ref sg_host_t containing all the hosts in the platform.
322  * @remark The host order in this array is generally different from the
323  * creation/declaration order in the XML platform (we use a hash table
324  * internally).
325  * @see sg_host_count()
326  */
327 sg_host_t* sg_host_list()
328 {
329   xbt_assert(sg_host_count() > 0, "There is no host!");
330   std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
331
332   sg_host_t* res = xbt_new(sg_host_t, hosts.size());
333   memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
334
335   return res;
336 }
337
338 const char* sg_host_get_name(sg_host_t host)
339 {
340   return host->get_cname();
341 }
342
343 void* sg_host_extension_get(sg_host_t host, size_t ext)
344 {
345   return host->extension(ext);
346 }
347
348 size_t sg_host_extension_create(void (*deleter)(void*))
349 {
350   return simgrid::s4u::Host::extension_create(deleter);
351 }
352
353 sg_host_t sg_host_by_name(const char* name)
354 {
355   return simgrid::s4u::Host::by_name_or_null(name);
356 }
357
358 xbt_dynar_t sg_hosts_as_dynar()
359 {
360   std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
361
362   auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
363     return not host || not host->pimpl_netpoint || not host->pimpl_netpoint->is_host();
364   });
365   std::sort(begin(list), last,
366             [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
367
368   xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
369   std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
370   return res;
371 }
372
373 // ========= Layering madness ==============*
374
375 // ========== User data Layer ==========
376 void* sg_host_user(sg_host_t host)
377 {
378   return host->extension(USER_HOST_LEVEL);
379 }
380 void sg_host_user_set(sg_host_t host, void* userdata)
381 {
382   host->extension_set(USER_HOST_LEVEL, userdata);
383 }
384 void sg_host_user_destroy(sg_host_t host)
385 {
386   host->extension_set(USER_HOST_LEVEL, nullptr);
387 }
388
389 // ========= storage related functions ============
390 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host)
391 {
392   xbt_assert((host != nullptr), "Invalid parameters");
393   xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
394   for (auto const& elm : host->get_mounted_storages()) {
395     const char* mount_name = elm.first.c_str();
396     sg_storage_t storage   = elm.second;
397     xbt_dict_set(res, mount_name, (void*)storage->get_cname(), nullptr);
398   }
399
400   return res;
401 }
402
403 xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host)
404 {
405   xbt_dynar_t storage_dynar               = xbt_dynar_new(sizeof(const char*), nullptr);
406   std::vector<const char*> storage_vector = host->get_attached_storages();
407   for (auto const& name : storage_vector)
408     xbt_dynar_push(storage_dynar, &name);
409   return storage_dynar;
410 }
411
412 // =========== user-level functions ===============
413 // ================================================
414 /** @brief Returns the total speed of a host */
415 double sg_host_speed(sg_host_t host)
416 {
417   return host->get_speed();
418 }
419
420 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
421  *
422  * @param  host host to test
423  * @param pstate_index pstate to test
424  * @return Returns the processor speed associated with pstate_index
425  */
426 double sg_host_get_pstate_speed(sg_host_t host, int pstate_index)
427 {
428   return host->get_pstate_speed(pstate_index);
429 }
430
431 /** @ingroup m_host_management
432  * @brief Return the number of cores.
433  *
434  * @param host a host
435  * @return the number of cores
436  */
437 int sg_host_core_count(sg_host_t host)
438 {
439   return host->get_core_count();
440 }
441
442 double sg_host_get_available_speed(sg_host_t host)
443 {
444   return host->get_available_speed();
445 }
446
447 /** @brief Returns the number of power states for a host.
448  *
449  *  See also @ref plugin_energy.
450  */
451 int sg_host_get_nb_pstates(sg_host_t host)
452 {
453   return host->get_pstate_count();
454 }
455
456 /** @brief Gets the pstate at which that host currently runs.
457  *
458  *  See also @ref plugin_energy.
459  */
460 int sg_host_get_pstate(sg_host_t host)
461 {
462   return host->get_pstate();
463 }
464 /** @brief Sets the pstate at which that host should run.
465  *
466  *  See also @ref plugin_energy.
467  */
468 void sg_host_set_pstate(sg_host_t host, int pstate)
469 {
470   host->set_pstate(pstate);
471 }
472
473 /** @ingroup m_host_management
474  *
475  * @brief Start the host if it is off
476  *
477  * See also #sg_host_is_on() to test the current state of the host and @ref plugin_energy
478  * for more info on DVFS.
479  */
480 void sg_host_turn_on(sg_host_t host)
481 {
482   host->turn_on();
483 }
484
485 /** @ingroup m_host_management
486  *
487  * @brief Stop the host if it is on
488  *
489  * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
490  * for more info on DVFS.
491  */
492 void sg_host_turn_off(sg_host_t host)
493 {
494   host->turn_off();
495 }
496
497 /** @ingroup m_host_management
498  * @brief Determine if a host is up and running.
499  *
500  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
501  * info on DVFS.
502  *
503  * @param host host to test
504  * @return Returns true if the host is up and running, and false if it's currently down
505  */
506 int sg_host_is_on(sg_host_t host)
507 {
508   return host->is_on();
509 }
510
511 /** @deprecated */
512 int sg_host_is_off(sg_host_t host)
513 {
514   return not host->is_on();
515 }
516
517 /** @brief Get the properties of a host */
518 xbt_dict_t sg_host_get_properties(sg_host_t host)
519 {
520   xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
521   const std::unordered_map<std::string, std::string>* props = host->get_properties();
522   if (props == nullptr)
523     return nullptr;
524   for (auto const& elm : *props) {
525     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
526   }
527   return as_dict;
528 }
529
530 /** @ingroup m_host_management
531  * @brief Returns the value of a given host property
532  *
533  * @param host a host
534  * @param name a property name
535  * @return value of a property (or nullptr if property not set)
536  */
537 const char* sg_host_get_property_value(sg_host_t host, const char* name)
538 {
539   return host->get_property(name);
540 }
541
542 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
543 {
544   host->set_property(name, value);
545 }
546
547 /**
548  * @brief Find a route between two hosts
549  *
550  * @param from where from
551  * @param to where to
552  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
553  */
554 void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links)
555 {
556   std::vector<simgrid::s4u::Link*> vlinks;
557   from->route_to(to, vlinks, nullptr);
558   for (auto const& link : vlinks)
559     xbt_dynar_push(links, &link);
560 }
561 /**
562  * @brief Find the latency of the route between two hosts
563  *
564  * @param from where from
565  * @param to where to
566  */
567 double sg_host_route_latency(sg_host_t from, sg_host_t to)
568 {
569   std::vector<simgrid::s4u::Link*> vlinks;
570   double res = 0;
571   from->route_to(to, vlinks, &res);
572   return res;
573 }
574 /**
575  * @brief Find the bandwitdh of the route between two hosts
576  *
577  * @param from where from
578  * @param to where to
579  */
580 double sg_host_route_bandwidth(sg_host_t from, sg_host_t to)
581 {
582   double min_bandwidth = -1.0;
583
584   std::vector<simgrid::s4u::Link*> vlinks;
585   from->route_to(to, vlinks, nullptr);
586   for (auto const& link : vlinks) {
587     double bandwidth = link->get_bandwidth();
588     if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
589       min_bandwidth = bandwidth;
590   }
591   return min_bandwidth;
592 }
593
594 /** @brief Displays debugging information about a host */
595 void sg_host_dump(sg_host_t host)
596 {
597   XBT_INFO("Displaying host %s", host->get_cname());
598   XBT_INFO("  - speed: %.0f", host->get_speed());
599   XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
600   const std::unordered_map<std::string, std::string>* props = host->get_properties();
601
602   if (not props->empty()) {
603     XBT_INFO("  - properties:");
604     for (auto const& elm : *props) {
605       XBT_INFO("    %s->%s", elm.first.c_str(), elm.second.c_str());
606     }
607   }
608 }
609
610 /** @brief Return the list of actors attached to a host.
611  *
612  * @param host a host
613  * @param whereto a dynar in which we should push actors living on that host
614  */
615 void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto)
616 {
617   auto actors = host->get_all_actors();
618   for (auto& actor : actors)
619     xbt_dynar_push(whereto, &actor);
620 }
621
622 sg_host_t sg_host_self()
623 {
624   smx_actor_t process = SIMIX_process_self();
625   return (process == nullptr) ? nullptr : process->get_host();
626 }
627
628 /* needs to be public and without simcall for exceptions and logging events */
629 const char* sg_host_self_get_name()
630 {
631   sg_host_t host = sg_host_self();
632   if (host == nullptr || SIMIX_process_self() == simix_global->maestro_process)
633     return "";
634
635   return host->get_cname();
636 }
637
638 double sg_host_load(sg_host_t host)
639 {
640   return host->get_load();
641 }