Logo AND Algorithmique Numérique Distribuée

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