Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Move collective algorithms to separate folders
[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 std::map<std::string, simgrid::s4u::Host*> host_list; // FIXME: move it to Engine
27
28 int USER_HOST_LEVEL = -1;
29
30 namespace simgrid {
31
32 namespace xbt {
33 template class Extendable<simgrid::s4u::Host>;
34 }
35
36 namespace s4u {
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::instance()->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 (!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   if (host_list.find(name) == host_list.end())
91     return nullptr;
92   return host_list.at(name);
93 }
94
95 Host *Host::current(){
96   smx_actor_t smx_proc = SIMIX_process_self();
97   if (smx_proc == nullptr)
98     xbt_die("Cannot call Host::current() from the maestro context");
99   return smx_proc->host;
100 }
101
102 void Host::turnOn() {
103   if (isOff()) {
104     simgrid::simix::kernelImmediate([this] {
105       this->extension<simgrid::simix::Host>()->turnOn();
106       this->pimpl_cpu->turnOn();
107       onStateChange(*this);
108     });
109   }
110 }
111
112 void Host::turnOff() {
113   if (isOn()) {
114     smx_actor_t self = SIMIX_process_self();
115     simgrid::simix::kernelImmediate([this, self] {
116       SIMIX_host_off(this, self);
117       onStateChange(*this);
118     });
119   }
120 }
121
122 bool Host::isOn() {
123   return this->pimpl_cpu->isOn();
124 }
125
126 int Host::pstatesCount() const {
127   return this->pimpl_cpu->getNbPStates();
128 }
129
130 /**
131  * \brief Find a route toward another host
132  *
133  * \param dest [IN] where to
134  * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
135  * \param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
136  *                It is the caller responsibility to initialize latency to 0 (we add to provided route)
137  * \pre links!=nullptr
138  *
139  * walk through the routing components tree and find a route between hosts
140  * by calling each "get_route" function in each routing component.
141  */
142 void Host::routeTo(Host* dest, std::vector<Link*>* links, double* latency)
143 {
144   std::vector<surf::LinkImpl*> linkImpls;
145   this->routeTo(dest, &linkImpls, latency);
146   for (surf::LinkImpl* l : linkImpls)
147     links->push_back(&l->piface_);
148 }
149 /** @brief Just like Host::routeTo, but filling an array of link implementations */
150 void Host::routeTo(Host* dest, std::vector<surf::LinkImpl*>* links, double* latency)
151 {
152   simgrid::kernel::routing::NetZoneImpl::getGlobalRoute(pimpl_netpoint, dest->pimpl_netpoint, links, latency);
153   if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
154     XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", cname(), dest->cname(),
155                (latency == nullptr ? -1 : *latency));
156     for (auto link : *links)
157       XBT_CDEBUG(surf_route, "Link %s", link->cname());
158   }
159 }
160
161 boost::unordered_map<std::string, Storage*> const& Host::mountedStorages() {
162   if (mounts == nullptr) {
163     mounts = new boost::unordered_map<std::string, Storage*> ();
164
165     xbt_dict_t dict = this->mountedStoragesAsDict();
166
167     xbt_dict_cursor_t cursor;
168     char *mountname;
169     char *storagename;
170     xbt_dict_foreach(dict, cursor, mountname, storagename) {
171       mounts->insert({mountname, &Storage::byName(storagename)});
172     }
173     xbt_dict_free(&dict);
174   }
175
176   return *mounts;
177 }
178
179 /** Get the properties assigned to a host */
180 xbt_dict_t Host::properties() {
181   return simgrid::simix::kernelImmediate([this] {
182     return this->pimpl_->getProperties();
183   });
184 }
185
186 /** Retrieve the property value (or nullptr if not set) */
187 const char*Host::property(const char*key) {
188   return this->pimpl_->getProperty(key);
189 }
190 void Host::setProperty(const char*key, const char *value){
191   simgrid::simix::kernelImmediate([this, key, value] {
192     this->pimpl_->setProperty(key, value);
193   });
194 }
195
196 /** Get the processes attached to the host */
197 void Host::processes(std::vector<ActorPtr>* list)
198 {
199   smx_actor_t actor = NULL;
200   xbt_swag_foreach(actor, this->extension<simgrid::simix::Host>()->process_list) {
201     list->push_back(actor->iface());
202   }
203 }
204
205 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
206 double Host::getPstateSpeed(int pstate_index)
207 {
208   return simgrid::simix::kernelImmediate([this, pstate_index] {
209     return this->pimpl_cpu->getPstateSpeed(pstate_index);
210   });
211 }
212
213 /** @brief Get the peak processor speed (in flops/s), at the current pstate */
214 double Host::speed() {
215   return pimpl_cpu->getSpeed(1.0);
216 }
217
218 /** @brief Returns the number of core of the processor. */
219 int Host::coreCount() {
220   return pimpl_cpu->coreCount();
221 }
222
223 /** @brief Set the pstate at which the host should run */
224 void Host::setPstate(int pstate_index)
225 {
226   simgrid::simix::kernelImmediate([this, pstate_index] {
227       this->pimpl_cpu->setPState(pstate_index);
228   });
229 }
230 /** @brief Retrieve the pstate at which the host is currently running */
231 int Host::pstate()
232 {
233   return this->pimpl_cpu->getPState();
234 }
235
236 /**
237  * \ingroup simix_storage_management
238  * \brief Returns the list of storages mounted on an host.
239  * \return a dict containing all storages mounted on the host
240  */
241 xbt_dict_t Host::mountedStoragesAsDict()
242 {
243   return simgrid::simix::kernelImmediate([this] {
244     return this->pimpl_->getMountedStorageList();
245   });
246 }
247
248 /**
249  * \ingroup simix_storage_management
250  * \brief Returns the list of storages attached to an host.
251  * \return a dict containing all storages attached to the host
252  */
253 void Host::attachedStorages(std::vector<const char*>* storages)
254 {
255   simgrid::simix::kernelImmediate([this, storages] { 
256      this->pimpl_->getAttachedStorageList(storages); 
257   });
258 }
259
260 } // namespace simgrid
261 } // namespace s4u