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->name.c_str(), sg_host_get_name(process->host),
  95                   issuer->name.c_str());
  96       }
  97     }
  98   } else {
  99     XBT_INFO("Host %s is already off", h->name().c_str());
 100   }
 101 }
 102
 103 sg_host_t SIMIX_host_self()
 104 {
 105   smx_actor_t process = SIMIX_process_self();
 106   return (process == nullptr) ? nullptr : process->host;
 107 }
 108
 109 /* needs to be public and without simcall for exceptions and logging events */
 110 const char* SIMIX_host_self_get_name()
 111 {
 112   sg_host_t host = SIMIX_host_self();
 113   if (host == nullptr || SIMIX_process_self() == simix_global->maestro_process)
 114     return "";
 115
 116   return sg_host_get_name(host);
 117 }
 118
 119 void _SIMIX_host_free_process_arg(void *data)
 120 {
 121   smx_process_arg_t arg = *(static_cast<smx_process_arg_t*>(data));
 122   delete arg;
 123 }
 124 /**
 125  * \brief Add a process to the list of the processes that the host will restart when it comes back
 126  * This function add a process to the list of the processes that will be restarted when the host comes
 127  * back. It is expected that this function is called when the host is down.
 128  * The processes will only be restarted once, meaning that you will have to register the process
 129  * again to restart the process again.
 130  */
 131 void SIMIX_host_add_auto_restart_process(
 132   sg_host_t host, const char *name, std::function<void()> code,
 133   void* data, double kill_time, xbt_dict_t properties, int auto_restart)
 134 {
 135   smx_process_arg_t arg = new simgrid::simix::ProcessArg();
 136   arg->name = name;
 137   arg->code = std::move(code);
 138   arg->data = data;
 139   arg->host = host;
 140   arg->kill_time = kill_time;
 141   arg->properties = properties;
 142   arg->auto_restart = auto_restart;
 143
 144   if( host->isOff() && !xbt_dict_get_or_null(watched_hosts_lib,sg_host_get_name(host))){
 145     xbt_dict_set(watched_hosts_lib,sg_host_get_name(host),host,nullptr);
 146     XBT_DEBUG("Push host %s to watched_hosts_lib because state == SURF_RESOURCE_OFF",sg_host_get_name(host));
 147   }
 148   sg_host_simix(host)->auto_restart_processes.push_back(arg);
 149 }
 150 /** @brief Restart the list of processes that have been registered to the host */
 151 void SIMIX_host_autorestart(sg_host_t host)
 152 {
 153   std::vector<simgrid::simix::ProcessArg*> process_list = sg_host_simix(host)->auto_restart_processes;
 154   if (process_list.empty())
 155     return;
 156
 157   for (auto arg : process_list) {
 158
 159     XBT_DEBUG("Restarting Process %s@%s right now", arg->name.c_str(), arg->host->name().c_str());
 160     simix_global->create_process_function(arg->name.c_str(), arg->code, nullptr, arg->host, arg->kill_time,
 161         arg->properties, arg->auto_restart, nullptr);
 162   }
 163   process_list.clear();
 164 }
 165
 166 smx_activity_t simcall_HANDLER_execution_start(smx_simcall_t simcall, const char* name, double flops_amount,
 167                                               double priority, double bound) {
 168   return SIMIX_execution_start(simcall->issuer, name,flops_amount,priority,bound);
 169 }
 170
 171 smx_activity_t SIMIX_execution_start(smx_actor_t issuer, const char *name, double flops_amount, double priority,
 172                                     double bound){
 173
 174   /* alloc structures and initialize */
 175   simgrid::kernel::activity::Exec *exec = new simgrid::kernel::activity::Exec(name, issuer->host);
 176
 177   /* set surf's action */
 178   if (!MC_is_active() && !MC_record_replay_is_active()) {
 179
 180     exec->surf_exec = issuer->host->pimpl_cpu->execution_start(flops_amount);
 181     exec->surf_exec->setData(exec);
 182     exec->surf_exec->setPriority(priority);
 183
 184     if (bound > 0)
 185       static_cast<simgrid::surf::CpuAction*>(exec->surf_exec)->setBound(bound);
 186   }
 187
 188   XBT_DEBUG("Create execute synchro %p: %s", exec, exec->name.c_str());
 189
 190   return exec;
 191 }
 192
 193 smx_activity_t SIMIX_execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list, double* flops_amount,
 194                                               double* bytes_amount, double amount, double rate, double timeout)
 195 {
 196
 197   /* alloc structures and initialize */
 198   simgrid::kernel::activity::Exec *exec = new simgrid::kernel::activity::Exec(name, nullptr);
 199
 200   /* set surf's synchro */
 201   sg_host_t *host_list_cpy = xbt_new0(sg_host_t, host_nb);
 202   for (int i = 0; i < host_nb; i++)
 203     host_list_cpy[i] = host_list[i];
 204
 205   /* Check that we are not mixing VMs and PMs in the parallel task */
 206   bool is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(host_list[0]));
 207   for (int i = 1; i < host_nb; i++) {
 208     bool tmp_is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(host_list[i]));
 209     xbt_assert(is_a_vm == tmp_is_a_vm, "parallel_execute: mixing VMs and PMs is not supported (yet).");
 210   }
 211
 212   /* set surf's synchro */
 213   if (!MC_is_active() && !MC_record_replay_is_active()) {
 214     exec->surf_exec = surf_host_model->executeParallelTask(host_nb, host_list_cpy, flops_amount, bytes_amount, rate);
 215     exec->surf_exec->setData(exec);
 216     if (timeout > 0) {
 217       exec->timeoutDetector = host_list[0]->pimpl_cpu->sleep(timeout);
 218       exec->timeoutDetector->setData(exec);
 219     }
 220   }
 221   XBT_DEBUG("Create parallel execute synchro %p", exec);
 222
 223   return exec;
 224 }
 225
 226 void SIMIX_execution_cancel(smx_activity_t synchro)
 227 {
 228   XBT_DEBUG("Cancel synchro %p", synchro);
 229   simgrid::kernel::activity::Exec *exec = static_cast<simgrid::kernel::activity::Exec *>(synchro);
 230
 231   if (exec->surf_exec)
 232     exec->surf_exec->cancel();
 233 }
 234
 235 void SIMIX_execution_set_priority(smx_activity_t synchro, double priority)
 236 {
 237   simgrid::kernel::activity::Exec *exec = static_cast<simgrid::kernel::activity::Exec *>(synchro);
 238   if(exec->surf_exec)
 239     exec->surf_exec->setPriority(priority);
 240 }
 241
 242 void SIMIX_execution_set_bound(smx_activity_t synchro, double bound)
 243 {
 244   simgrid::kernel::activity::Exec *exec = static_cast<simgrid::kernel::activity::Exec *>(synchro);
 245   if(exec->surf_exec)
 246     static_cast<simgrid::surf::CpuAction*>(exec->surf_exec)->setBound(bound);
 247 }
 248
 249 void simcall_HANDLER_execution_wait(smx_simcall_t simcall, smx_activity_t synchro)
 250 {
 251   simgrid::kernel::activity::Exec *exec = static_cast<simgrid::kernel::activity::Exec *>(synchro);
 252   XBT_DEBUG("Wait for execution of synchro %p, state %d", synchro, (int)synchro->state);
 253
 254   /* Associate this simcall to the synchro */
 255   synchro->simcalls.push_back(simcall);
 256   simcall->issuer->waiting_synchro = synchro;
 257
 258   /* set surf's synchro */
 259   if (MC_is_active() || MC_record_replay_is_active()) {
 260     synchro->state = SIMIX_DONE;
 261     SIMIX_execution_finish(exec);
 262     return;
 263   }
 264
 265   /* If the synchro is already finished then perform the error handling */
 266   if (synchro->state != SIMIX_RUNNING)
 267     SIMIX_execution_finish(exec);
 268 }
 269
 270 void SIMIX_execution_finish(simgrid::kernel::activity::Exec *exec)
 271 {
 272   for (smx_simcall_t simcall : exec->simcalls) {
 273     switch (exec->state) {
 274
 275       case SIMIX_DONE:
 276         /* do nothing, synchro done */
 277         XBT_DEBUG("SIMIX_execution_finished: execution successful");
 278         break;
 279
 280       case SIMIX_FAILED:
 281         XBT_DEBUG("SIMIX_execution_finished: host '%s' failed", sg_host_get_name(simcall->issuer->host));
 282         simcall->issuer->context->iwannadie = 1;
 283         SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
 284         break;
 285
 286       case SIMIX_CANCELED:
 287         XBT_DEBUG("SIMIX_execution_finished: execution canceled");
 288         SMX_EXCEPTION(simcall->issuer, cancel_error, 0, "Canceled");
 289         break;
 290
 291       case SIMIX_TIMEOUT:
 292         XBT_DEBUG("SIMIX_execution_finished: execution timeouted");
 293         SMX_EXCEPTION(simcall->issuer, timeout_error, 0, "Timeouted");
 294         break;
 295
 296       default:
 297         xbt_die("Internal error in SIMIX_execution_finish: unexpected synchro state %d",
 298             (int)exec->state);
 299     }
 300     /* Fail the process if the host is down */
 301     if (simcall->issuer->host->isOff())
 302       simcall->issuer->context->iwannadie = 1;
 303
 304     simcall->issuer->waiting_synchro = nullptr;
 305     simcall_execution_wait__set__result(simcall, exec->state);
 306     SIMIX_simcall_answer(simcall);
 307   }
 308
 309   /* We no longer need it */
 310   exec->unref();
 311 }
 312
 313 void SIMIX_set_category(smx_activity_t synchro, const char *category)
 314 {
 315   if (synchro->state != SIMIX_RUNNING)
 316     return;
 317
 318   simgrid::kernel::activity::Exec *exec = dynamic_cast<simgrid::kernel::activity::Exec *>(synchro);
 319   if (exec != nullptr) {
 320     exec->surf_exec->setCategory(category);
 321     return;
 322   }
 323
 324   simgrid::kernel::activity::Comm *comm = dynamic_cast<simgrid::kernel::activity::Comm *>(synchro);
 325   if (comm != nullptr) {
 326     comm->surf_comm->setCategory(category);
 327     return;
 328   }
 329 }