src/simix/smx_host.cpp

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