src/simix/smx_host.cpp

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