Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
a51febd7ddb37e2f4c62aa8a5b251e3f69c14fea
[simgrid.git] / src / simix / smx_host.cpp
1 /* Copyright (c) 2007-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 "mc/mc.h"
7 #include "smx_private.hpp"
8 #include "src/kernel/activity/CommImpl.hpp"
9 #include "src/mc/mc_replay.hpp"
10 #include "src/plugins/vm/VirtualMachineImpl.hpp"
11 #include "src/surf/surf_interface.hpp"
12 #include "xbt/ex.hpp"
13 #include <algorithm>
14
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_host, simix, "SIMIX hosts");
16
17 namespace simgrid {
18   namespace simix {
19     simgrid::xbt::Extension<simgrid::s4u::Host, Host> Host::EXTENSION_ID;
20
21     Host::Host()
22     {
23       if (not Host::EXTENSION_ID.valid())
24         Host::EXTENSION_ID = s4u::Host::extension_create<simix::Host>();
25     }
26
27     Host::~Host()
28     {
29       /* All processes should be gone when the host is turned off (by the end of the simulation). */
30       if (not process_list.empty()) {
31         std::string msg     = std::string("Shutting down host, but it's not empty:");
32         for (auto const& process : process_list)
33           msg += "\n\t" + std::string(process.getName());
34
35         SIMIX_display_process_status();
36         THROWF(arg_error, 0, "%s", msg.c_str());
37       }
38       for (auto const& arg : auto_restart_processes)
39         delete arg;
40       auto_restart_processes.clear();
41       for (auto const& arg : boot_processes)
42         delete arg;
43       boot_processes.clear();
44     }
45
46     /** Re-starts all the actors that are marked as restartable.
47      *
48      * Weird things will happen if you turn on an host that is already on. S4U is fool-proof, not this.
49      */
50     void Host::turnOn()
51     {
52       for (auto const& arg : boot_processes) {
53         XBT_DEBUG("Booting Process %s(%s) right now", arg->name.c_str(), arg->host->getCname());
54         smx_actor_t actor = simix_global->create_process_function(arg->name.c_str(), arg->code, nullptr, arg->host,
55                                                                   arg->properties.get(), nullptr);
56         if (arg->kill_time >= 0)
57           simcall_process_set_kill_time(actor, arg->kill_time);
58         if (arg->auto_restart)
59           actor->auto_restart = arg->auto_restart;
60       }
61     }
62
63 }} // namespaces
64
65 /** @brief Stop the host if it is on */
66 void SIMIX_host_off(sg_host_t h, smx_actor_t issuer)
67 {
68   simgrid::simix::Host* host = h->extension<simgrid::simix::Host>();
69
70   xbt_assert((host != nullptr), "Invalid parameters");
71
72   if (h->isOn()) {
73     h->pimpl_cpu->turnOff();
74
75     /* Clean Simulator data */
76     if (not host->process_list.empty()) {
77       for (auto& process : host->process_list) {
78         SIMIX_process_kill(&process, issuer);
79         XBT_DEBUG("Killing %s@%s on behalf of %s which turned off that host.", process.getCname(),
80                   process.host->getCname(), issuer->getCname());
81       }
82     }
83   } else {
84     XBT_INFO("Host %s is already off", h->getCname());
85   }
86 }
87
88 /* needs to be public and without simcall for exceptions and logging events */
89 const char* sg_host_self_get_name()
90 {
91   sg_host_t host = sg_host_self();
92   if (host == nullptr || SIMIX_process_self() == simix_global->maestro_process)
93     return "";
94
95   return host->getCname();
96 }
97
98 /**
99  * \brief Add a process to the list of the processes that the host will restart when it comes back
100  * This function add a process to the list of the processes that will be restarted when the host comes
101  * back. It is expected that this function is called when the host is down.
102  * The processes will only be restarted once, meaning that you will have to register the process
103  * again to restart the process again.
104  */
105 void SIMIX_host_add_auto_restart_process(sg_host_t host, const char* name, std::function<void()> code, void* data,
106                                          double kill_time, std::map<std::string, std::string>* properties,
107                                          int auto_restart)
108 {
109   simgrid::simix::ProcessArg* arg =
110       new simgrid::simix::ProcessArg(name, code, data, host, kill_time, nullptr, auto_restart);
111   arg->properties.reset(properties, [](decltype(properties)) {});
112
113   if (host->isOff() && watched_hosts.find(host->getCname()) == watched_hosts.end()) {
114     watched_hosts.insert(host->getCname());
115     XBT_DEBUG("Push host %s to watched_hosts because state == SURF_RESOURCE_OFF", host->getCname());
116   }
117   XBT_DEBUG("Adding Process %s to the auto-restart list of Host %s", arg->name.c_str(), arg->host->getCname());
118   host->extension<simgrid::simix::Host>()->auto_restart_processes.push_back(arg);
119 }
120
121 /** @brief Restart the list of processes that have been registered to the host */
122 void SIMIX_host_autorestart(sg_host_t host)
123 {
124   std::vector<simgrid::simix::ProcessArg*> process_list =
125       host->extension<simgrid::simix::Host>()->auto_restart_processes;
126
127   for (auto const& arg : process_list) {
128     XBT_DEBUG("Restarting Process %s@%s right now", arg->name.c_str(), arg->host->getCname());
129     smx_actor_t actor = simix_global->create_process_function(arg->name.c_str(), arg->code, nullptr, arg->host,
130                                                               arg->properties.get(), nullptr);
131     if (arg->kill_time >= 0)
132       simcall_process_set_kill_time(actor, arg->kill_time);
133     if (arg->auto_restart)
134       actor->auto_restart = arg->auto_restart;
135   }
136   process_list.clear();
137 }
138
139 boost::intrusive_ptr<simgrid::kernel::activity::ExecImpl>
140 SIMIX_execution_start(const char* name, double flops_amount, double priority, double bound, sg_host_t host)
141 {
142   /* alloc structures and initialize */
143   simgrid::kernel::activity::ExecImplPtr exec =
144       simgrid::kernel::activity::ExecImplPtr(new simgrid::kernel::activity::ExecImpl(name, host));
145
146   /* set surf's action */
147   if (not MC_is_active() && not MC_record_replay_is_active()) {
148
149     exec->surfAction_ = host->pimpl_cpu->execution_start(flops_amount);
150     exec->surfAction_->setData(exec.get());
151     exec->surfAction_->setSharingWeight(priority);
152
153     if (bound > 0)
154       static_cast<simgrid::surf::CpuAction*>(exec->surfAction_)->setBound(bound);
155   }
156
157   XBT_DEBUG("Create execute synchro %p: %s", exec.get(), exec->name.c_str());
158   simgrid::kernel::activity::ExecImpl::onCreation(exec);
159
160   return exec;
161 }
162
163 boost::intrusive_ptr<simgrid::kernel::activity::ExecImpl>
164 SIMIX_execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list, double* flops_amount,
165                                double* bytes_amount, double rate, double timeout)
166 {
167
168   /* alloc structures and initialize */
169   simgrid::kernel::activity::ExecImplPtr exec =
170       simgrid::kernel::activity::ExecImplPtr(new simgrid::kernel::activity::ExecImpl(name, nullptr));
171
172   /* Check that we are not mixing VMs and PMs in the parallel task */
173   bool is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(host_list[0]));
174   for (int i = 1; i < host_nb; i++) {
175     bool tmp_is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(host_list[i]));
176     xbt_assert(is_a_vm == tmp_is_a_vm, "parallel_execute: mixing VMs and PMs is not supported (yet).");
177   }
178
179   /* set surf's synchro */
180   if (not MC_is_active() && not MC_record_replay_is_active()) {
181     /* set surf's synchro */
182     sg_host_t* host_list_cpy = new sg_host_t[host_nb];
183     std::copy_n(host_list, host_nb, host_list_cpy);
184     exec->surfAction_ = surf_host_model->executeParallelTask(host_nb, host_list_cpy, flops_amount, bytes_amount, rate);
185     exec->surfAction_->setData(exec.get());
186     if (timeout > 0) {
187       exec->timeoutDetector = host_list[0]->pimpl_cpu->sleep(timeout);
188       exec->timeoutDetector->setData(exec.get());
189     }
190   }
191   XBT_DEBUG("Create parallel execute synchro %p", exec.get());
192
193   return exec;
194 }
195
196 void simcall_HANDLER_execution_wait(smx_simcall_t simcall, smx_activity_t synchro)
197 {
198   XBT_DEBUG("Wait for execution of synchro %p, state %d", synchro.get(), (int)synchro->state);
199
200   /* Associate this simcall to the synchro */
201   synchro->simcalls.push_back(simcall);
202   simcall->issuer->waiting_synchro = synchro;
203
204   /* set surf's synchro */
205   if (MC_is_active() || MC_record_replay_is_active()) {
206     synchro->state = SIMIX_DONE;
207     SIMIX_execution_finish(synchro);
208     return;
209   }
210
211   /* If the synchro is already finished then perform the error handling */
212   if (synchro->state != SIMIX_RUNNING)
213     SIMIX_execution_finish(synchro);
214 }
215
216 void simcall_HANDLER_execution_test(smx_simcall_t simcall, smx_activity_t synchro)
217 {
218   simcall_execution_test__set__result(simcall, (synchro->state != SIMIX_WAITING && synchro->state != SIMIX_RUNNING));
219   if (simcall_execution_test__get__result(simcall)) {
220     synchro->simcalls.push_back(simcall);
221     SIMIX_execution_finish(synchro);
222   } else {
223     SIMIX_simcall_answer(simcall);
224   }
225   /* If the synchro is already finished then perform the error handling */
226   if (synchro->state != SIMIX_RUNNING)
227     SIMIX_execution_finish(synchro);
228 }
229
230 void SIMIX_execution_finish(smx_activity_t synchro)
231 {
232   simgrid::kernel::activity::ExecImplPtr exec =
233       boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(synchro);
234
235   while (not synchro->simcalls.empty()) {
236     smx_simcall_t simcall = synchro->simcalls.front();
237     synchro->simcalls.pop_front();
238     switch (exec->state) {
239
240       case SIMIX_DONE:
241         /* do nothing, synchro done */
242         XBT_DEBUG("SIMIX_execution_finished: execution successful");
243         break;
244
245       case SIMIX_FAILED:
246         XBT_DEBUG("SIMIX_execution_finished: host '%s' failed", simcall->issuer->host->getCname());
247         simcall->issuer->context->iwannadie = 1;
248         SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
249         break;
250
251       case SIMIX_CANCELED:
252         XBT_DEBUG("SIMIX_execution_finished: execution canceled");
253         SMX_EXCEPTION(simcall->issuer, cancel_error, 0, "Canceled");
254         break;
255
256       case SIMIX_TIMEOUT:
257         XBT_DEBUG("SIMIX_execution_finished: execution timeouted");
258         SMX_EXCEPTION(simcall->issuer, timeout_error, 0, "Timeouted");
259         break;
260
261       default:
262         xbt_die("Internal error in SIMIX_execution_finish: unexpected synchro state %d",
263             (int)exec->state);
264     }
265     /* Fail the process if the host is down */
266     if (simcall->issuer->host->isOff())
267       simcall->issuer->context->iwannadie = 1;
268
269     simcall->issuer->waiting_synchro = nullptr;
270     simcall_execution_wait__set__result(simcall, exec->state);
271     SIMIX_simcall_answer(simcall);
272   }
273 }
274
275 void SIMIX_set_category(smx_activity_t synchro, const char *category)
276 {
277   if (synchro->state != SIMIX_RUNNING)
278     return;
279
280   simgrid::kernel::activity::ExecImplPtr exec =
281       boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(synchro);
282   if (exec != nullptr) {
283     exec->surfAction_->setCategory(category);
284     return;
285   }
286
287   simgrid::kernel::activity::CommImplPtr comm =
288       boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
289   if (comm != nullptr) {
290     comm->surfAction_->setCategory(category);
291   }
292 }