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 "smx_private.h"
   8 #include <xbt/ex.hpp>
   9 #include "xbt/sysdep.h"
  10 #include "mc/mc.h"
  11 #include "src/mc/mc_replay.h"
  12 #include "src/surf/virtual_machine.hpp"
  13 #include "src/surf/HostImpl.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 (!EXTENSION_ID.valid())
  27         EXTENSION_ID = simgrid::s4u::Host::extension_create<simgrid::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       xbt_dynar_free(&auto_restart_processes);
  50       xbt_dynar_free(&boot_processes);
  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       unsigned int cpt;
  61       smx_process_arg_t arg;
  62       xbt_dynar_foreach(boot_processes,cpt,arg) {
  63         XBT_DEBUG("Booting Process %s(%s) right now", arg->name.c_str(), arg->hostname);
  64         simix_global->create_process_function(arg->name.c_str(),
  65             arg->code,
  66             nullptr,
  67             arg->hostname,
  68             arg->kill_time,
  69             arg->properties,
  70             arg->auto_restart,
  71             nullptr);
  72       }
  73     }
  74
  75 }} // namespaces
  76
  77 /** @brief Stop the host if it is on */
  78 void SIMIX_host_off(sg_host_t h, smx_actor_t issuer)
  79 {
  80   smx_host_priv_t host = sg_host_simix(h);
  81
  82   xbt_assert((host != nullptr), "Invalid parameters");
  83
  84   if (h->isOn()) {
  85     simgrid::surf::HostImpl* surf_host = h->extension<simgrid::surf::HostImpl>();
  86     surf_host->turnOff();
  87
  88     /* Clean Simulator data */
  89     if (xbt_swag_size(host->process_list) != 0) {
  90       smx_actor_t process = nullptr;
  91       xbt_swag_foreach(process, host->process_list) {
  92         SIMIX_process_kill(process, issuer);
  93         XBT_DEBUG("Killing %s on %s by %s",
  94           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, const char *hostname, double kill_time,
 134   xbt_dict_t properties, int auto_restart)
 135 {
 136   if (!sg_host_simix(host)->auto_restart_processes) {
 137     sg_host_simix(host)->auto_restart_processes = xbt_dynar_new(sizeof(smx_process_arg_t),_SIMIX_host_free_process_arg);
 138   }
 139   smx_process_arg_t arg = new simgrid::simix::ProcessArg();
 140   arg->name = name;
 141   arg->code = std::move(code);
 142   arg->data = data;
 143   arg->hostname = hostname;
 144   arg->kill_time = kill_time;
 145   arg->properties = properties;
 146   arg->auto_restart = auto_restart;
 147
 148   if( host->isOff() && !xbt_dict_get_or_null(watched_hosts_lib,sg_host_get_name(host))){
 149     xbt_dict_set(watched_hosts_lib,sg_host_get_name(host),host,nullptr);
 150     XBT_DEBUG("Push host %s to watched_hosts_lib because state == SURF_RESOURCE_OFF",sg_host_get_name(host));
 151   }
 152   xbt_dynar_push_as(sg_host_simix(host)->auto_restart_processes,smx_process_arg_t,arg);
 153 }
 154 /** @brief Restart the list of processes that have been registered to the host */
 155 void SIMIX_host_autorestart(sg_host_t host)
 156 {
 157   unsigned int cpt;
 158   smx_process_arg_t arg;
 159   xbt_dynar_t process_list = sg_host_simix(host)->auto_restart_processes;
 160   if (!process_list)
 161     return;
 162
 163   xbt_dynar_foreach (process_list, cpt, arg) {
 164
 165     XBT_DEBUG("Restarting Process %s(%s) right now", arg->name.c_str(), arg->hostname);
 166     simix_global->create_process_function(arg->name.c_str(), arg->code, nullptr, arg->hostname, arg->kill_time,
 167         arg->properties, arg->auto_restart, nullptr);
 168   }
 169   xbt_dynar_reset(process_list);
 170 }
 171
 172 smx_activity_t simcall_HANDLER_execution_start(smx_simcall_t simcall, const char* name, double flops_amount,
 173                                               double priority, double bound) {
 174   return SIMIX_execution_start(simcall->issuer, name,flops_amount,priority,bound);
 175 }
 176
 177 smx_activity_t SIMIX_execution_start(smx_actor_t issuer, const char *name, double flops_amount, double priority,
 178                                     double bound){
 179
 180   /* alloc structures and initialize */
 181   simgrid::kernel::activity::Exec *exec = new simgrid::kernel::activity::Exec(name, issuer->host);
 182
 183   /* set surf's action */
 184   if (!MC_is_active() && !MC_record_replay_is_active()) {
 185
 186     exec->surf_exec = issuer->host->pimpl_cpu->execution_start(flops_amount);
 187     exec->surf_exec->setData(exec);
 188     exec->surf_exec->setPriority(priority);
 189
 190     if (bound > 0)
 191       static_cast<simgrid::surf::CpuAction*>(exec->surf_exec)->setBound(bound);
 192   }
 193
 194   XBT_DEBUG("Create execute synchro %p: %s", exec, exec->name.c_str());
 195
 196   return exec;
 197 }
 198
 199 smx_activity_t SIMIX_execution_parallel_start(const char *name, int host_nb, sg_host_t *host_list, double *flops_amount,
 200                                              double *bytes_amount, double amount, double rate){
 201
 202   /* alloc structures and initialize */
 203   simgrid::kernel::activity::Exec *exec = new simgrid::kernel::activity::Exec(name, nullptr);
 204
 205   /* set surf's synchro */
 206   sg_host_t *host_list_cpy = xbt_new0(sg_host_t, host_nb);
 207   for (int i = 0; i < host_nb; i++)
 208     host_list_cpy[i] = host_list[i];
 209
 210   /* Check that we are not mixing VMs and PMs in the parallel task */
 211   simgrid::surf::HostImpl *host = host_list[0]->extension<simgrid::surf::HostImpl>();
 212   bool is_a_vm = (nullptr != dynamic_cast<simgrid::surf::VirtualMachine*>(host));
 213   for (int i = 1; i < host_nb; i++) {
 214     bool tmp_is_a_vm = (nullptr != dynamic_cast<simgrid::surf::VirtualMachine*>(host_list[i]->extension<simgrid::surf::HostImpl>()));
 215     xbt_assert(is_a_vm == tmp_is_a_vm, "parallel_execute: mixing VMs and PMs is not supported (yet).");
 216   }
 217
 218   /* set surf's synchro */
 219   if (!MC_is_active() && !MC_record_replay_is_active()) {
 220     exec->surf_exec = surf_host_model->executeParallelTask(host_nb, host_list_cpy, flops_amount, bytes_amount, rate);
 221     exec->surf_exec->setData(exec);
 222   }
 223   XBT_DEBUG("Create parallel execute synchro %p", exec);
 224
 225   return exec;
 226 }
 227
 228 void SIMIX_execution_cancel(smx_activity_t synchro)
 229 {
 230   XBT_DEBUG("Cancel synchro %p", synchro);
 231   simgrid::kernel::activity::Exec *exec = static_cast<simgrid::kernel::activity::Exec *>(synchro);
 232
 233   if (exec->surf_exec)
 234     exec->surf_exec->cancel();
 235 }
 236
 237 void SIMIX_execution_set_priority(smx_activity_t synchro, double priority)
 238 {
 239   simgrid::kernel::activity::Exec *exec = static_cast<simgrid::kernel::activity::Exec *>(synchro);
 240   if(exec->surf_exec)
 241     exec->surf_exec->setPriority(priority);
 242 }
 243
 244 void SIMIX_execution_set_bound(smx_activity_t synchro, double bound)
 245 {
 246   simgrid::kernel::activity::Exec *exec = static_cast<simgrid::kernel::activity::Exec *>(synchro);
 247   if(exec->surf_exec)
 248     static_cast<simgrid::surf::CpuAction*>(exec->surf_exec)->setBound(bound);
 249 }
 250
 251 void simcall_HANDLER_execution_wait(smx_simcall_t simcall, smx_activity_t synchro)
 252 {
 253   simgrid::kernel::activity::Exec *exec = static_cast<simgrid::kernel::activity::Exec *>(synchro);
 254   XBT_DEBUG("Wait for execution of synchro %p, state %d", synchro, (int)synchro->state);
 255
 256   /* Associate this simcall to the synchro */
 257   synchro->simcalls.push_back(simcall);
 258   simcall->issuer->waiting_synchro = synchro;
 259
 260   /* set surf's synchro */
 261   if (MC_is_active() || MC_record_replay_is_active()) {
 262     synchro->state = SIMIX_DONE;
 263     SIMIX_execution_finish(exec);
 264     return;
 265   }
 266
 267   /* If the synchro is already finished then perform the error handling */
 268   if (synchro->state != SIMIX_RUNNING)
 269     SIMIX_execution_finish(exec);
 270 }
 271
 272 void SIMIX_execution_finish(simgrid::kernel::activity::Exec *exec)
 273 {
 274   for (smx_simcall_t simcall : exec->simcalls) {
 275     switch (exec->state) {
 276
 277       case SIMIX_DONE:
 278         /* do nothing, synchro done */
 279         XBT_DEBUG("SIMIX_execution_finished: execution successful");
 280         break;
 281
 282       case SIMIX_FAILED:
 283         XBT_DEBUG("SIMIX_execution_finished: host '%s' failed", sg_host_get_name(simcall->issuer->host));
 284         simcall->issuer->context->iwannadie = 1;
 285         SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
 286         break;
 287
 288       case SIMIX_CANCELED:
 289         XBT_DEBUG("SIMIX_execution_finished: execution canceled");
 290         SMX_EXCEPTION(simcall->issuer, cancel_error, 0, "Canceled");
 291         break;
 292
 293       default:
 294         xbt_die("Internal error in SIMIX_execution_finish: unexpected synchro state %d",
 295             (int)exec->state);
 296     }
 297     /* Fail the process if the host is down */
 298     if (simcall->issuer->host->isOff())
 299       simcall->issuer->context->iwannadie = 1;
 300
 301     simcall->issuer->waiting_synchro = nullptr;
 302     simcall_execution_wait__set__result(simcall, exec->state);
 303     SIMIX_simcall_answer(simcall);
 304   }
 305
 306   /* We no longer need it */
 307   exec->unref();
 308 }
 309
 310 void SIMIX_set_category(smx_activity_t synchro, const char *category)
 311 {
 312   if (synchro->state != SIMIX_RUNNING)
 313     return;
 314
 315   simgrid::kernel::activity::Exec *exec = dynamic_cast<simgrid::kernel::activity::Exec *>(synchro);
 316   if (exec != nullptr) {
 317     exec->surf_exec->setCategory(category);
 318     return;
 319   }
 320
 321   simgrid::kernel::activity::Comm *comm = dynamic_cast<simgrid::kernel::activity::Comm *>(synchro);
 322   if (comm != nullptr) {
 323     comm->surf_comm->setCategory(category);
 324     return;
 325   }
 326 }