Logo AND Algorithmique Numérique Distribuée

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