Logo AND Algorithmique Numérique Distribuée

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