Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
New: s4u::Host.execute() for remote executions
[simgrid.git] / src / s4u / s4u_host.cpp
1 /* Copyright (c) 2006-2017. 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 <string>
7 #include <functional>
8 #include <stdexcept>
9
10 #include <map>
11
12 #include "simgrid/s4u/Engine.hpp"
13 #include "simgrid/s4u/Host.hpp"
14 #include "simgrid/s4u/Storage.hpp"
15 #include "simgrid/simix.hpp"
16 #include "src/kernel/routing/NetPoint.hpp"
17 #include "src/msg/msg_private.h"
18 #include "src/simix/ActorImpl.hpp"
19 #include "src/simix/smx_private.h"
20 #include "src/surf/HostImpl.hpp"
21 #include "src/surf/cpu_interface.hpp"
22 #include "xbt/log.h"
23
24 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
25
26 int USER_HOST_LEVEL = -1;
27
28 namespace simgrid {
29
30 namespace xbt {
31 template class Extendable<simgrid::s4u::Host>;
32 }
33
34 namespace s4u {
35
36 std::map<std::string, simgrid::s4u::Host*> host_list; // FIXME: move it to Engine
37
38 simgrid::xbt::signal<void(Host&)> Host::onCreation;
39 simgrid::xbt::signal<void(Host&)> Host::onDestruction;
40 simgrid::xbt::signal<void(Host&)> Host::onStateChange;
41 simgrid::xbt::signal<void(Host&)> Host::onSpeedChange;
42
43 Host::Host(const char* name)
44   : name_(name)
45 {
46   xbt_assert(Host::by_name_or_null(name) == nullptr, "Refusing to create a second host named '%s'.", name);
47   host_list[name_] = this;
48   new simgrid::surf::HostImpl(this);
49 }
50
51 Host::~Host()
52 {
53   xbt_assert(currentlyDestroying_, "Please call h->destroy() instead of manually deleting it.");
54
55   delete pimpl_;
56   if (pimpl_netpoint != nullptr) // not removed yet by a children class
57     simgrid::s4u::Engine::getInstance()->netpointUnregister(pimpl_netpoint);
58   delete pimpl_cpu;
59   delete mounts;
60 }
61
62 /** @brief Fire the required callbacks and destroy the object
63  *
64  * Don't delete directly an Host, call h->destroy() instead.
65  *
66  * This is cumbersome but this is the simplest solution to ensure that the
67  * onDestruction() callback receives a valid object (because of the destructor
68  * order in a class hierarchy).
69  */
70 void Host::destroy()
71 {
72   if (not currentlyDestroying_) {
73     currentlyDestroying_ = true;
74     onDestruction(*this);
75     host_list.erase(name_);
76     delete this;
77   }
78 }
79
80 Host* Host::by_name(std::string name)
81 {
82   return host_list.at(name); // Will raise a std::out_of_range if the host does not exist
83 }
84 Host* Host::by_name_or_null(const char* name)
85 {
86   return by_name_or_null(std::string(name));
87 }
88 Host* Host::by_name_or_null(std::string name)
89 {
90   auto host = host_list.find(name);
91   return host == host_list.end() ? nullptr : host->second;
92 }
93
94 Host *Host::current(){
95   smx_actor_t smx_proc = SIMIX_process_self();
96   if (smx_proc == nullptr)
97     xbt_die("Cannot call Host::current() from the maestro context");
98   return smx_proc->host;
99 }
100
101 void Host::turnOn() {
102   if (isOff()) {
103     simgrid::simix::kernelImmediate([this] {
104       this->extension<simgrid::simix::Host>()->turnOn();
105       this->pimpl_cpu->turnOn();
106       onStateChange(*this);
107     });
108   }
109 }
110
111 void Host::turnOff() {
112   if (isOn()) {
113     smx_actor_t self = SIMIX_process_self();
114     simgrid::simix::kernelImmediate([this, self] {
115       SIMIX_host_off(this, self);
116       onStateChange(*this);
117     });
118   }
119 }
120
121 bool Host::isOn() {
122   return this->pimpl_cpu->isOn();
123 }
124
125 int Host::getPstatesCount() const
126 {
127   return this->pimpl_cpu->getNbPStates();
128 }
129
130 /**
131  * \brief Return the list of actors attached to an host.
132  *
133  * \param whereto a vector in which we should push actors living on that host
134  */
135 void Host::actorList(std::vector<ActorPtr>* whereto)
136 {
137   smx_actor_t actor = NULL;
138   xbt_swag_foreach(actor, this->extension<simgrid::simix::Host>()->process_list)
139   {
140     whereto->push_back(actor->ciface());
141   }
142 }
143
144 /**
145  * \brief Find a route toward another host
146  *
147  * \param dest [IN] where to
148  * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
149  * \param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
150  *                It is the caller responsibility to initialize latency to 0 (we add to provided route)
151  * \pre links!=nullptr
152  *
153  * walk through the routing components tree and find a route between hosts
154  * by calling each "get_route" function in each routing component.
155  */
156 void Host::routeTo(Host* dest, std::vector<Link*>* links, double* latency)
157 {
158   std::vector<surf::LinkImpl*> linkImpls;
159   this->routeTo(dest, &linkImpls, latency);
160   for (surf::LinkImpl* const& l : linkImpls)
161     links->push_back(&l->piface_);
162 }
163
164 /** @brief Just like Host::routeTo, but filling an array of link implementations */
165 void Host::routeTo(Host* dest, std::vector<surf::LinkImpl*>* links, double* latency)
166 {
167   simgrid::kernel::routing::NetZoneImpl::getGlobalRoute(pimpl_netpoint, dest->pimpl_netpoint, links, latency);
168   if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
169     XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", getCname(), dest->getCname(),
170                (latency == nullptr ? -1 : *latency));
171     for (auto const& link : *links)
172       XBT_CDEBUG(surf_route, "Link %s", link->cname());
173   }
174 }
175
176 /** Get the properties assigned to a host */
177 std::map<std::string, std::string>* Host::getProperties()
178 {
179   return simgrid::simix::kernelImmediate([this] { return this->pimpl_->getProperties(); });
180 }
181
182 /** Retrieve the property value (or nullptr if not set) */
183 const char* Host::getProperty(const char* key)
184 {
185   return this->pimpl_->getProperty(key);
186 }
187
188 void Host::setProperty(std::string key, std::string value)
189 {
190   simgrid::simix::kernelImmediate([this, key, value] { this->pimpl_->setProperty(key, value); });
191 }
192
193 /** Get the processes attached to the host */
194 void Host::getProcesses(std::vector<ActorPtr>* list)
195 {
196   smx_actor_t actor = NULL;
197   xbt_swag_foreach(actor, this->extension<simgrid::simix::Host>()->process_list) {
198     list->push_back(actor->iface());
199   }
200 }
201
202 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
203 double Host::getPstateSpeed(int pstate_index)
204 {
205   return simgrid::simix::kernelImmediate([this, pstate_index] {
206     return this->pimpl_cpu->getPstateSpeed(pstate_index);
207   });
208 }
209
210 /** @brief Get the peak processor speed (in flops/s), at the current pstate */
211 double Host::getSpeed()
212 {
213   return pimpl_cpu->getSpeed(1.0);
214 }
215
216 /** @brief Returns the number of core of the processor. */
217 int Host::getCoreCount()
218 {
219   return pimpl_cpu->coreCount();
220 }
221
222 /** @brief Set the pstate at which the host should run */
223 void Host::setPstate(int pstate_index)
224 {
225   simgrid::simix::kernelImmediate([this, pstate_index] {
226       this->pimpl_cpu->setPState(pstate_index);
227   });
228 }
229 /** @brief Retrieve the pstate at which the host is currently running */
230 int Host::getPstate()
231 {
232   return this->pimpl_cpu->getPState();
233 }
234
235 /**
236  * \ingroup simix_storage_management
237  * \brief Returns the list of storages attached to an host.
238  * \return a vector containing all storages attached to the host
239  */
240 void Host::getAttachedStorages(std::vector<const char*>* storages)
241 {
242   simgrid::simix::kernelImmediate([this, storages] {
243      this->pimpl_->getAttachedStorageList(storages);
244   });
245 }
246
247 std::unordered_map<std::string, Storage*> const& Host::getMountedStorages()
248 {
249   if (mounts == nullptr) {
250     mounts = new std::unordered_map<std::string, Storage*>();
251     for (auto const& m : this->pimpl_->storage_) {
252       mounts->insert({m.first, &m.second->piface_});
253     }
254   }
255   return *mounts;
256 }
257
258 void Host::execute(double flops)
259 {
260   Host* host_list[1]   = {this};
261   double flops_list[1] = {flops};
262   smx_activity_t s     = simcall_execution_parallel_start(nullptr /*name*/, 1, host_list, flops_list,
263                                                       nullptr /*comm_sizes */, -1.0, -1 /*timeout*/);
264   simcall_execution_wait(s);
265 }
266
267 } // namespace simgrid
268 } // namespace s4u