Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add virtual destructor.
[simgrid.git] / src / surf / plugins / host_dvfs.cpp
1 /* Copyright (c) 2010, 2012-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/plugins/dvfs.h"
7 #include "simgrid/plugins/load.h"
8 #include "simgrid/simix.hpp"
9 #include "src/plugins/vm/VirtualMachineImpl.hpp"
10 #include "src/surf/cpu_interface.hpp"
11
12 #include <boost/algorithm/string.hpp>
13 #include <boost/algorithm/string/classification.hpp>
14 #include <boost/algorithm/string/split.hpp>
15 #include <simgrid/msg.h>
16 #include <simgrid/s4u/Engine.hpp>
17 #include <string>
18 #include <utility>
19 #include <vector>
20 #include <xbt/config.hpp>
21
22 /** @addtogroup SURF_plugin_load
23
24   This plugin makes it very simple for users to obtain the current load for each host.
25
26 */
27
28 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_plugin_dvfs, surf, "Logging specific to the SURF HostDvfs plugin");
29
30 namespace simgrid {
31 namespace plugin {
32
33 namespace dvfs {
34 class Governor {
35
36 protected:
37   simgrid::s4u::Host* host;
38
39 public:
40   double sampling_rate;
41
42   explicit Governor(simgrid::s4u::Host* ptr) : host(ptr) { init(); }
43   virtual ~Governor() = default;
44
45   void init()
46   {
47     const char* local_sampling_rate_config = host->getProperty("plugin/dvfs/sampling_rate");
48     double global_sampling_rate_config     = xbt_cfg_get_double("plugin/dvfs/sampling_rate");
49     if (local_sampling_rate_config != nullptr) {
50       sampling_rate = std::stod(local_sampling_rate_config);
51     } else {
52       sampling_rate = global_sampling_rate_config;
53     }
54   }
55
56   virtual void update() {}
57   double samplingRate() { return sampling_rate; }
58 };
59
60 class Performance : public Governor {
61 public:
62   explicit Performance(simgrid::s4u::Host* ptr) : Governor(ptr) {}
63
64   void update() { host->setPstate(0); }
65 };
66
67 class Powersave : public Governor {
68 public:
69   explicit Powersave(simgrid::s4u::Host* ptr) : Governor(ptr) {}
70
71   void update() { host->setPstate(host->getPstatesCount() - 1); }
72 };
73
74 class OnDemand : public Governor {
75   double freq_up_threshold = 0.95;
76
77 public:
78   explicit OnDemand(simgrid::s4u::Host* ptr) : Governor(ptr) {}
79
80   void update()
81   {
82     double load = sg_host_get_current_load(host);
83
84     if (load > freq_up_threshold) {
85       host->setPstate(0); /* Run at max. performance! */
86       XBT_INFO("Changed to pstate %f", 0.0);
87     } else {
88       /* The actual implementation uses a formula here: (See Kernel file cpufreq_ondemand.c:158)
89        *
90        *    freq_next = min_f + load * (max_f - min_f) / 100
91        *
92        * So they assume that frequency increases by 100 MHz. We will just use
93        * lowest_pstate - load*pstatesCount()
94        */
95       int max_pstate = host->getPstatesCount() - 1;
96
97       host->setPstate(max_pstate - load * max_pstate);
98       XBT_INFO("Changed to pstate %f -- check: %i", max_pstate - load * max_pstate, host->getPstate());
99     }
100   }
101 };
102
103 class Conservative : public Governor {
104   double freq_up_threshold   = .8;
105   double freq_down_threshold = .2;
106
107 public:
108   explicit Conservative(simgrid::s4u::Host* ptr) : Governor(ptr) {}
109
110   void update()
111   {
112     double load = sg_host_get_current_load(host);
113     int pstate  = host->getPstate();
114
115     if (load > freq_up_threshold) {
116       if (pstate != 0) {
117         host->setPstate(pstate - 1);
118         XBT_INFO("Increasing performance to pstate %d", pstate - 1);
119       }
120       else {
121         XBT_DEBUG("Cannot speed up even more, already in slowest pstate %d", pstate);
122       }
123     }
124
125     if (load < freq_down_threshold) {
126       int max_pstate = host->getPstatesCount() - 1;
127       if (pstate != max_pstate) { // Are we in the slowest pstate already?
128         host->setPstate(pstate + 1);
129         XBT_INFO("Slowing down to pstate %d", pstate + 1);
130       }
131       else {
132         XBT_DEBUG("Cannot slow down even more, already in slowest pstate %d", pstate);
133       }
134     }
135   }
136 };
137 }
138
139 class HostDvfs {
140 public:
141   static simgrid::xbt::Extension<simgrid::s4u::Host, HostDvfs> EXTENSION_ID;
142
143   explicit HostDvfs(simgrid::s4u::Host*);
144   ~HostDvfs();
145 };
146
147 simgrid::xbt::Extension<simgrid::s4u::Host, HostDvfs> HostDvfs::EXTENSION_ID;
148
149 HostDvfs::HostDvfs(simgrid::s4u::Host* ptr) {}
150
151 HostDvfs::~HostDvfs() = default;
152 }
153 }
154
155 using simgrid::plugin::HostDvfs;
156
157 /* **************************** events  callback *************************** */
158 static void on_host_added(simgrid::s4u::Host& host)
159 {
160   if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
161     return;
162
163   std::string name              = std::string("dvfs-daemon-") + host.getCname();
164   simgrid::s4u::ActorPtr daemon = simgrid::s4u::Actor::createActor(name.c_str(), &host, []() {
165     /**
166      * This lambda function is the function the actor (daemon) will execute
167      * all the time - in the case of the dvfs plugin, this controls when to
168      * lower/raise the frequency.
169      */
170     simgrid::s4u::ActorPtr daemonProc = simgrid::s4u::Actor::self();
171
172     XBT_DEBUG("DVFS process on %s is a daemon: %d", daemonProc->getHost()->getName().c_str(), daemonProc->isDaemon());
173
174     std::string dvfs_governor;
175     const char* host_conf = daemonProc->getHost()->getProperty("plugin/dvfs/governor");
176     if (host_conf != nullptr) {
177       dvfs_governor = std::string(daemonProc->getHost()->getProperty("plugin/dvfs/governor"));
178       boost::algorithm::to_lower(dvfs_governor);
179     } else {
180       dvfs_governor = xbt_cfg_get_string("plugin/dvfs/governor");
181       boost::algorithm::to_lower(dvfs_governor);
182     }
183
184     simgrid::plugin::dvfs::Governor governor(daemonProc->getHost());
185     if (dvfs_governor == "conservative") {
186       governor = simgrid::plugin::dvfs::Conservative(daemonProc->getHost());
187     }
188
189     while (1) {
190       // Sleep *before* updating; important for startup (i.e., t = 0).
191       // In the beginning, we want to go with the pstates specified in the platform file
192       // (so we sleep first)
193       simgrid::s4u::this_actor::sleep_for(governor.samplingRate());
194       governor.update();
195       XBT_INFO("Governor just updated!");
196     }
197
198     XBT_WARN("I should have never reached this point: daemons should be killed when all regular processes are done");
199     return 0;
200   });
201
202   // This call must be placed in this function. Otherweise, the daemonize() call comes too late and
203   // SMPI will take this process as an MPI process!
204   daemon->daemonize();
205 }
206
207 /* **************************** Public interface *************************** */
208 extern "C" {
209
210 /** \ingroup SURF_plugin_load
211  * \brief Initializes the HostDvfs plugin
212  * \details The HostDvfs plugin provides an API to get the current load of each host.
213  */
214 void sg_host_dvfs_plugin_init()
215 {
216   if (HostDvfs::EXTENSION_ID.valid())
217     return;
218
219   HostDvfs::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostDvfs>();
220
221   sg_host_load_plugin_init();
222
223   simgrid::s4u::Host::onCreation.connect(&on_host_added);
224   xbt_cfg_register_double("plugin/dvfs/sampling_rate", 0.1, nullptr,
225                           "How often should the dvfs plugin check whether the frequency needs to be changed?");
226   xbt_cfg_register_string("plugin/dvfs/governor", "performance", nullptr,
227                           "Which Governor should be used that adapts the CPU frequency?");
228 }
229 }