1 /* Copyright (c) 2007-2018. The SimGrid Team. All rights reserved. */
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. */
7 #include "smx_private.hpp"
8 #include "src/mc/mc_replay.hpp"
9 #include "src/plugins/vm/VirtualMachineImpl.hpp"
10 #include "src/simix/smx_host_private.hpp"
11 #include "src/surf/surf_interface.hpp"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_host, simix, "SIMIX hosts");
18 simgrid::xbt::Extension<simgrid::s4u::Host, Host> Host::EXTENSION_ID;
22 if (not Host::EXTENSION_ID.valid())
23 Host::EXTENSION_ID = s4u::Host::extension_create<simix::Host>();
28 /* All processes should be gone when the host is turned off (by the end of the simulation). */
29 if (not process_list.empty()) {
30 std::string msg = std::string("Shutting down host, but it's not empty:");
31 for (auto const& process : process_list)
32 msg += "\n\t" + std::string(process.get_name());
34 SIMIX_display_process_status();
35 THROWF(arg_error, 0, "%s", msg.c_str());
37 for (auto const& arg : auto_restart_processes)
39 auto_restart_processes.clear();
40 for (auto const& arg : boot_processes)
42 boot_processes.clear();
45 /** Re-starts all the actors that are marked as restartable.
47 * Weird things will happen if you turn on an host that is already on. S4U is fool-proof, not this.
51 for (auto const& arg : boot_processes) {
52 XBT_DEBUG("Booting Process %s(%s) right now", arg->name.c_str(), arg->host->get_cname());
53 smx_actor_t actor = simix_global->create_process_function(arg->name.c_str(), arg->code, nullptr, arg->host,
54 arg->properties.get(), nullptr);
55 if (arg->kill_time >= 0)
56 simcall_process_set_kill_time(actor, arg->kill_time);
57 if (arg->auto_restart)
58 actor->auto_restart = arg->auto_restart;
64 /** @brief Stop the host if it is on */
65 void SIMIX_host_off(sg_host_t h, smx_actor_t issuer)
67 simgrid::simix::Host* host = h->extension<simgrid::simix::Host>();
69 xbt_assert((host != nullptr), "Invalid parameters");
72 h->pimpl_cpu->turn_off();
74 /* Clean Simulator data */
75 if (not host->process_list.empty()) {
76 for (auto& process : host->process_list) {
77 SIMIX_process_kill(&process, issuer);
78 XBT_DEBUG("Killing %s@%s on behalf of %s which turned off that host.", process.get_cname(),
79 process.host->get_cname(), issuer->get_cname());
83 XBT_INFO("Host %s is already off", h->get_cname());
87 /* needs to be public and without simcall for exceptions and logging events */
88 const char* sg_host_self_get_name()
90 sg_host_t host = sg_host_self();
91 if (host == nullptr || SIMIX_process_self() == simix_global->maestro_process)
94 return host->get_cname();
98 * \brief Add a process to the list of the processes that the host will restart when it comes back
99 * This function add a process to the list of the processes that will be restarted when the host comes
100 * back. It is expected that this function is called when the host is down.
101 * The processes will only be restarted once, meaning that you will have to register the process
102 * again to restart the process again.
104 void SIMIX_host_add_auto_restart_process(sg_host_t host, const char* name, std::function<void()> code, void* data,
105 double kill_time, std::map<std::string, std::string>* properties,
108 simgrid::kernel::actor::ProcessArg* arg =
109 new simgrid::kernel::actor::ProcessArg(name, code, data, host, kill_time, nullptr, auto_restart);
110 arg->properties.reset(properties, [](decltype(properties)) {});
112 if (host->isOff() && watched_hosts.find(host->get_cname()) == watched_hosts.end()) {
113 watched_hosts.insert(host->get_cname());
114 XBT_DEBUG("Push host %s to watched_hosts because state == SURF_RESOURCE_OFF", host->get_cname());
116 XBT_DEBUG("Adding Process %s to the auto-restart list of Host %s", arg->name.c_str(), arg->host->get_cname());
117 host->extension<simgrid::simix::Host>()->auto_restart_processes.push_back(arg);
120 /** @brief Restart the list of processes that have been registered to the host */
121 void SIMIX_host_autorestart(sg_host_t host)
123 std::vector<simgrid::kernel::actor::ProcessArg*> process_list =
124 host->extension<simgrid::simix::Host>()->auto_restart_processes;
126 for (auto const& arg : process_list) {
127 XBT_DEBUG("Restarting Process %s@%s right now", arg->name.c_str(), arg->host->get_cname());
128 smx_actor_t actor = simix_global->create_process_function(arg->name.c_str(), arg->code, nullptr, arg->host,
129 arg->properties.get(), nullptr);
130 if (arg->kill_time >= 0)
131 simcall_process_set_kill_time(actor, arg->kill_time);
132 if (arg->auto_restart)
133 actor->auto_restart = arg->auto_restart;
135 process_list.clear();
138 boost::intrusive_ptr<simgrid::kernel::activity::ExecImpl>
139 SIMIX_execution_start(const char* name, double flops_amount, double priority, double bound, sg_host_t host)
141 /* set surf's action */
142 simgrid::kernel::resource::Action* surf_action = nullptr;
143 if (not MC_is_active() && not MC_record_replay_is_active()) {
144 surf_action = host->pimpl_cpu->execution_start(flops_amount);
145 surf_action->set_priority(priority);
147 static_cast<simgrid::surf::CpuAction*>(surf_action)->set_bound(bound);
150 simgrid::kernel::activity::ExecImplPtr exec = simgrid::kernel::activity::ExecImplPtr(
151 new simgrid::kernel::activity::ExecImpl(name, surf_action, /*timeout_detector*/ nullptr, host));
153 XBT_DEBUG("Create execute synchro %p: %s", exec.get(), exec->name.c_str());
154 simgrid::kernel::activity::ExecImpl::onCreation(exec);
159 boost::intrusive_ptr<simgrid::kernel::activity::ExecImpl>
160 SIMIX_execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list, double* flops_amount,
161 double* bytes_amount, double rate, double timeout)
164 /* Check that we are not mixing VMs and PMs in the parallel task */
165 bool is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(host_list[0]));
166 for (int i = 1; i < host_nb; i++) {
167 bool tmp_is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(host_list[i]));
168 xbt_assert(is_a_vm == tmp_is_a_vm, "parallel_execute: mixing VMs and PMs is not supported (yet).");
171 /* set surf's synchro */
172 simgrid::kernel::resource::Action* surf_action = nullptr;
173 simgrid::kernel::resource::Action* timeout_detector = nullptr;
174 if (not MC_is_active() && not MC_record_replay_is_active()) {
175 sg_host_t* host_list_cpy = new sg_host_t[host_nb];
176 std::copy_n(host_list, host_nb, host_list_cpy);
177 surf_action = surf_host_model->execute_parallel(host_nb, host_list_cpy, flops_amount, bytes_amount, rate);
179 timeout_detector = host_list[0]->pimpl_cpu->sleep(timeout);
183 simgrid::kernel::activity::ExecImplPtr exec = simgrid::kernel::activity::ExecImplPtr(
184 new simgrid::kernel::activity::ExecImpl(name, surf_action, timeout_detector, nullptr));
186 XBT_DEBUG("Create parallel execute synchro %p", exec.get());
191 void simcall_HANDLER_execution_wait(smx_simcall_t simcall, smx_activity_t synchro)
193 XBT_DEBUG("Wait for execution of synchro %p, state %d", synchro.get(), (int)synchro->state);
195 /* Associate this simcall to the synchro */
196 synchro->simcalls.push_back(simcall);
197 simcall->issuer->waiting_synchro = synchro;
199 /* set surf's synchro */
200 if (MC_is_active() || MC_record_replay_is_active()) {
201 synchro->state = SIMIX_DONE;
202 SIMIX_execution_finish(synchro);
206 /* If the synchro is already finished then perform the error handling */
207 if (synchro->state != SIMIX_RUNNING)
208 SIMIX_execution_finish(synchro);
211 void simcall_HANDLER_execution_test(smx_simcall_t simcall, smx_activity_t synchro)
213 simcall_execution_test__set__result(simcall, (synchro->state != SIMIX_WAITING && synchro->state != SIMIX_RUNNING));
214 if (simcall_execution_test__get__result(simcall)) {
215 synchro->simcalls.push_back(simcall);
216 SIMIX_execution_finish(synchro);
218 SIMIX_simcall_answer(simcall);
220 /* If the synchro is already finished then perform the error handling */
221 if (synchro->state != SIMIX_RUNNING)
222 SIMIX_execution_finish(synchro);
225 void SIMIX_execution_finish(smx_activity_t synchro)
227 simgrid::kernel::activity::ExecImplPtr exec =
228 boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(synchro);
230 while (not synchro->simcalls.empty()) {
231 smx_simcall_t simcall = synchro->simcalls.front();
232 synchro->simcalls.pop_front();
233 switch (exec->state) {
236 /* do nothing, synchro done */
237 XBT_DEBUG("SIMIX_execution_finished: execution successful");
241 XBT_DEBUG("SIMIX_execution_finished: host '%s' failed", simcall->issuer->host->get_cname());
242 simcall->issuer->context->iwannadie = 1;
243 SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
247 XBT_DEBUG("SIMIX_execution_finished: execution canceled");
248 SMX_EXCEPTION(simcall->issuer, cancel_error, 0, "Canceled");
252 XBT_DEBUG("SIMIX_execution_finished: execution timeouted");
253 SMX_EXCEPTION(simcall->issuer, timeout_error, 0, "Timeouted");
257 xbt_die("Internal error in SIMIX_execution_finish: unexpected synchro state %d",
260 /* Fail the process if the host is down */
261 if (simcall->issuer->host->isOff())
262 simcall->issuer->context->iwannadie = 1;
264 simcall->issuer->waiting_synchro = nullptr;
265 simcall_execution_wait__set__result(simcall, exec->state);
266 SIMIX_simcall_answer(simcall);
270 void SIMIX_set_category(smx_activity_t synchro, const char *category)
272 if (synchro->state != SIMIX_RUNNING)
275 simgrid::kernel::activity::ExecImplPtr exec =
276 boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(synchro);
277 if (exec != nullptr) {
278 exec->surf_action_->set_category(category);
282 simgrid::kernel::activity::CommImplPtr comm =
283 boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
284 if (comm != nullptr) {
285 comm->surfAction_->set_category(category);