src/msg/msg_vm.cpp

   1 /* Copyright (c) 2012-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 /* TODO:
   8  * 1. add the support of trace
   9  * 2. use parallel tasks to simulate CPU overhead and remove the experimental code generating micro computation tasks
  10  */
  11
  12 #include <xbt/ex.hpp>
  13
  14 #include "src/instr/instr_private.h"
  15 #include "src/msg/msg_private.h"
  16 #include "src/plugins/vm/VirtualMachineImpl.hpp"
  17 #include "src/plugins/vm/VmHostExt.hpp"
  18
  19 #include "simgrid/host.h"
  20 #include "simgrid/simix.hpp"
  21
  22 SG_BEGIN_DECL()
  23
  24 struct dirty_page {
  25   double prev_clock;
  26   double prev_remaining;
  27   msg_task_t task;
  28 };
  29 typedef struct dirty_page s_dirty_page;
  30 typedef struct dirty_page* dirty_page_t;
  31
  32 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_vm, msg, "Cloud-oriented parts of the MSG API");
  33
  34 /* **** ******** GENERAL ********* **** */
  35
  36 /** \ingroup m_vm_management
  37  * \brief Set the parameters of a given host
  38  *
  39  * \param vm a vm
  40  * \param params a parameter object
  41  */
  42 void MSG_vm_set_params(msg_vm_t vm, vm_params_t params)
  43 {
  44   static_cast<simgrid::s4u::VirtualMachine*>(vm)->setParameters(params);
  45 }
  46
  47 /** \ingroup m_vm_management
  48  * \brief Get the parameters of a given host
  49  *
  50  * \param vm the vm you are interested into
  51  * \param params a prameter object
  52  */
  53 void MSG_vm_get_params(msg_vm_t vm, vm_params_t params)
  54 {
  55   static_cast<simgrid::s4u::VirtualMachine*>(vm)->parameters(params);
  56 }
  57
  58 /* **** Check state of a VM **** */
  59 static inline int __MSG_vm_is_state(msg_vm_t vm, e_surf_vm_state_t state)
  60 {
  61   simgrid::s4u::VirtualMachine* castedVm = static_cast<simgrid::s4u::VirtualMachine*>(vm);
  62   return castedVm->pimpl_vm_ != nullptr && castedVm->pimpl_vm_->getState() == state;
  63 }
  64
  65 /** @brief Returns whether the given VM has just created, not running.
  66  *  @ingroup msg_VMs
  67  */
  68 int MSG_vm_is_created(msg_vm_t vm)
  69 {
  70   return __MSG_vm_is_state(vm, SURF_VM_STATE_CREATED);
  71 }
  72
  73 /** @brief Returns whether the given VM is currently running
  74  *  @ingroup msg_VMs
  75  */
  76 int MSG_vm_is_running(msg_vm_t vm)
  77 {
  78   return __MSG_vm_is_state(vm, SURF_VM_STATE_RUNNING);
  79 }
  80
  81 /** @brief Returns whether the given VM is currently migrating
  82  *  @ingroup msg_VMs
  83  */
  84 int MSG_vm_is_migrating(msg_vm_t vm)
  85 {
  86   return static_cast<simgrid::s4u::VirtualMachine*>(vm)->isMigrating();
  87 }
  88
  89 /** @brief Returns whether the given VM is currently suspended, not running.
  90  *  @ingroup msg_VMs
  91  */
  92 int MSG_vm_is_suspended(msg_vm_t vm)
  93 {
  94   return __MSG_vm_is_state(vm, SURF_VM_STATE_SUSPENDED);
  95 }
  96
  97 /* **** ******** MSG vm actions ********* **** */
  98 /** @brief Create a new VM with specified parameters.
  99  *  @ingroup msg_VMs*
 100  *  @param pm        Physical machine that will host the VM
 101  *  @param name      Must be unique
 102  *  @param coreAmount Must be >= 1
 103  *  @param ramsize   [TODO]
 104  *  @param mig_netspeed Amount of Mbyte/s allocated to the migration (cannot be larger than net_cap). Use 0 if unsure.
 105  *  @param dp_intensity Dirty page percentage according to migNetSpeed, [0-100]. Use 0 if unsure.
 106  */
 107 msg_vm_t MSG_vm_create(msg_host_t pm, const char* name, int coreAmount, int ramsize, int mig_netspeed, int dp_intensity)
 108 {
 109   simgrid::vm::VmHostExt::ensureVmExtInstalled();
 110
 111   /* For the moment, intensity_rate is the percentage against the migration bandwidth */
 112   double host_speed = MSG_host_get_speed(pm);
 113   double update_speed = (static_cast<double>(dp_intensity)/100) * mig_netspeed;
 114
 115   msg_vm_t vm = MSG_vm_create_multicore(pm, name, coreAmount);
 116   s_vm_params_t params;
 117   memset(&params, 0, sizeof(params));
 118   params.ramsize = static_cast<sg_size_t>(ramsize) * 1024 * 1024;
 119   params.devsize = 0;
 120   params.skip_stage2 = 0;
 121   params.max_downtime = 0.03;
 122   params.dp_rate = (update_speed * 1024 * 1024) / host_speed;
 123   params.dp_cap = params.ramsize * 0.9; // assume working set memory is 90% of ramsize
 124   params.mig_speed = static_cast<double>(mig_netspeed) * 1024 * 1024; // mig_speed
 125
 126   XBT_DEBUG("dp rate %f migspeed : %f intensity mem : %d, updatespeed %f, hostspeed %f", params.dp_rate,
 127             params.mig_speed, dp_intensity, update_speed, host_speed);
 128   static_cast<simgrid::s4u::VirtualMachine*>(vm)->setParameters(&params);
 129
 130   return vm;
 131 }
 132
 133 /** @brief Create a new VM object with the default parameters
 134  *  @ingroup msg_VMs*
 135  *
 136  * A VM is treated as a host. The name of the VM must be unique among all hosts.
 137  */
 138 msg_vm_t MSG_vm_create_core(msg_host_t pm, const char* name)
 139 {
 140   xbt_assert(sg_host_by_name(name) == nullptr,
 141              "Cannot create a VM named %s: this name is already used by an host or a VM", name);
 142
 143   return new simgrid::s4u::VirtualMachine(name, pm, 1);
 144 }
 145 /** @brief Create a new VM object with the default parameters, but with a specified amount of cores
 146  *  @ingroup msg_VMs*
 147  *
 148  * A VM is treated as a host. The name of the VM must be unique among all hosts.
 149  */
 150 msg_vm_t MSG_vm_create_multicore(msg_host_t pm, const char* name, int coreAmount)
 151 {
 152   xbt_assert(sg_host_by_name(name) == nullptr,
 153              "Cannot create a VM named %s: this name is already used by an host or a VM", name);
 154
 155   return new simgrid::s4u::VirtualMachine(name, pm, coreAmount);
 156 }
 157
 158 /** @brief Destroy a VM. Destroy the VM object from the simulation.
 159  *  @ingroup msg_VMs
 160  */
 161 void MSG_vm_destroy(msg_vm_t vm)
 162 {
 163   if (MSG_vm_is_migrating(vm))
 164     THROWF(vm_error, 0, "Cannot destroy VM '%s', which is migrating.", vm->cname());
 165
 166   /* First, terminate all processes on the VM if necessary */
 167   if (MSG_vm_is_running(vm))
 168     MSG_vm_shutdown(vm);
 169
 170   /* Then, destroy the VM object */
 171   simgrid::simix::kernelImmediate([vm]() {
 172     vm->destroy();
 173   });
 174
 175   if (TRACE_msg_vm_is_enabled()) {
 176     container_t container = PJ_container_get(vm->cname());
 177     PJ_container_remove_from_parent(container);
 178     PJ_container_free(container);
 179   }
 180 }
 181
 182 /** @brief Start a vm (i.e., boot the guest operating system)
 183  *  @ingroup msg_VMs
 184  *
 185  *  If the VM cannot be started (because of memory over-provisioning), an exception is generated.
 186  */
 187 void MSG_vm_start(msg_vm_t vm)
 188 {
 189   simgrid::simix::kernelImmediate([vm]() {
 190     simgrid::vm::VmHostExt::ensureVmExtInstalled();
 191
 192     simgrid::s4u::VirtualMachine* typedVM = static_cast<simgrid::s4u::VirtualMachine*>(vm);
 193     simgrid::s4u::Host* pm                = typedVM->pimpl_vm_->getPm();
 194     if (pm->extension<simgrid::vm::VmHostExt>() == nullptr)
 195       pm->extension_set(new simgrid::vm::VmHostExt());
 196
 197     long pm_ramsize   = pm->extension<simgrid::vm::VmHostExt>()->ramsize;
 198     int pm_overcommit = pm->extension<simgrid::vm::VmHostExt>()->overcommit;
 199     long vm_ramsize   = typedVM->getRamsize();
 200
 201     if (pm_ramsize && not pm_overcommit) { /* Only verify that we don't overcommit on need */
 202       /* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
 203       long total_ramsize_of_vms = 0;
 204       for (simgrid::s4u::VirtualMachine* ws_vm : simgrid::vm::VirtualMachineImpl::allVms_)
 205         if (pm == ws_vm->pimpl_vm_->getPm())
 206           total_ramsize_of_vms += ws_vm->pimpl_vm_->getRamsize();
 207
 208       if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
 209         XBT_WARN("cannnot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
 210                  vm->cname(), pm->cname(), vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
 211         THROWF(vm_error, 0, "Memory shortage on host '%s', VM '%s' cannot be started", pm->cname(), vm->cname());
 212       }
 213     }
 214
 215     typedVM->pimpl_vm_->setState(SURF_VM_STATE_RUNNING);
 216   });
 217
 218   if (TRACE_msg_vm_is_enabled()) {
 219     container_t vm_container = PJ_container_get(vm->cname());
 220     type_t type              = PJ_type_get("MSG_VM_STATE", vm_container->type);
 221     val_t value              = PJ_value_get_or_new("start", "0 0 1", type); // start is blue
 222     new PushStateEvent(MSG_get_clock(), vm_container, type, value);
 223   }
 224 }
 225
 226 /** @brief Immediately kills all processes within the given VM.
 227  *  @ingroup msg_VMs
 228  *
 229  * Any memory that they allocated will be leaked, unless you used #MSG_process_on_exit().
 230  *
 231  * No extra delay occurs. If you want to simulate this too, you want to use a #MSG_process_sleep().
 232  */
 233 void MSG_vm_shutdown(msg_vm_t vm)
 234 {
 235   smx_actor_t issuer=SIMIX_process_self();
 236   simgrid::simix::kernelImmediate([vm,issuer]() {
 237     static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->shutdown(issuer);
 238   });
 239
 240   // Make sure that the processes in the VM are killed in this scheduling round before processing
 241   // (eg with the VM destroy)
 242   MSG_process_sleep(0.);
 243 }
 244
 245 static inline char *get_mig_process_tx_name(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
 246 {
 247   return bprintf("__pr_mig_tx:%s(%s-%s)", vm->cname(), src_pm->cname(), dst_pm->cname());
 248 }
 249
 250 static inline char *get_mig_process_rx_name(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
 251 {
 252   return bprintf("__pr_mig_rx:%s(%s-%s)", vm->cname(), src_pm->cname(), dst_pm->cname());
 253 }
 254
 255 static inline char *get_mig_task_name(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm, int stage)
 256 {
 257   return bprintf("__task_mig_stage%d:%s(%s-%s)", stage, vm->cname(), src_pm->cname(), dst_pm->cname());
 258 }
 259
 260 struct migration_session {
 261   msg_vm_t vm;
 262   msg_host_t src_pm;
 263   msg_host_t dst_pm;
 264
 265   /* The miration_rx process uses mbox_ctl to let the caller of do_migration()
 266    * know the completion of the migration. */
 267   char *mbox_ctl;
 268   /* The migration_rx and migration_tx processes use mbox to transfer migration data. */
 269   char *mbox;
 270 };
 271
 272 static int migration_rx_fun(int argc, char *argv[])
 273 {
 274   XBT_DEBUG("mig: rx_start");
 275
 276   // The structure has been created in the do_migration function and should only be freed in the same place ;)
 277   struct migration_session *ms = (migration_session *) MSG_process_get_data(MSG_process_self());
 278
 279   bool received_finalize = false;
 280
 281   char *finalize_task_name = get_mig_task_name(ms->vm, ms->src_pm, ms->dst_pm, 3);
 282   while (not received_finalize) {
 283     msg_task_t task = nullptr;
 284     int ret         = MSG_task_recv(&task, ms->mbox);
 285
 286     if (ret != MSG_OK) {
 287       // An error occurred, clean the code and return
 288       // The owner did not change, hence the task should be only destroyed on the other side
 289       xbt_free(finalize_task_name);
 290       return 0;
 291     }
 292
 293     if (strcmp(task->name, finalize_task_name) == 0)
 294       received_finalize = 1;
 295
 296     MSG_task_destroy(task);
 297   }
 298   xbt_free(finalize_task_name);
 299
 300   // Here Stage 1, 2  and 3 have been performed.
 301   // Hence complete the migration
 302
 303   // Copy the reference to the vm (if SRC crashes now, do_migration will free ms)
 304   // This is clearly ugly but I (Adrien) need more time to do something cleaner (actually we should copy the whole ms
 305   // structure at the beginning and free it at the end of each function)
 306   simgrid::s4u::VirtualMachine* vm = static_cast<simgrid::s4u::VirtualMachine*>(ms->vm);
 307   msg_host_t dst_pm                = ms->dst_pm;
 308
 309   // Make sure that we cannot get interrupted between the migrate and the resume to not end in an inconsistent state
 310   simgrid::simix::kernelImmediate([vm, dst_pm]() {
 311     /* Update the vm location */
 312     /* precopy migration makes the VM temporally paused */
 313     xbt_assert(vm->pimpl_vm_->getState() == SURF_VM_STATE_SUSPENDED);
 314
 315     /* Update the vm location and resume it */
 316     vm->pimpl_vm_->setPm(dst_pm);
 317     vm->pimpl_vm_->resume();
 318   });
 319
 320
 321   // Now the VM is running on the new host (the migration is completed) (even if the SRC crash)
 322   vm->pimpl_vm_->isMigrating = false;
 323   XBT_DEBUG("VM(%s) moved from PM(%s) to PM(%s)", ms->vm->cname(), ms->src_pm->cname(), ms->dst_pm->cname());
 324
 325   if (TRACE_msg_vm_is_enabled()) {
 326     static long long int counter = 0;
 327     char key[INSTR_DEFAULT_STR_SIZE];
 328     snprintf(key, INSTR_DEFAULT_STR_SIZE, "%lld", counter);
 329     counter++;
 330
 331     // start link
 332     container_t msg = PJ_container_get(vm->cname());
 333     type_t type     = PJ_type_get("MSG_VM_LINK", PJ_type_get_root());
 334     new StartLinkEvent(MSG_get_clock(), PJ_container_get_root(), type, msg, "M", key);
 335
 336     // destroy existing container of this vm
 337     container_t existing_container = PJ_container_get(vm->cname());
 338     PJ_container_remove_from_parent(existing_container);
 339     PJ_container_free(existing_container);
 340
 341     // create new container on the new_host location
 342     PJ_container_new(vm->cname(), INSTR_MSG_VM, PJ_container_get(ms->dst_pm->cname()));
 343
 344     // end link
 345     msg  = PJ_container_get(vm->cname());
 346     type = PJ_type_get("MSG_VM_LINK", PJ_type_get_root());
 347     new EndLinkEvent(MSG_get_clock(), PJ_container_get_root(), type, msg, "M", key);
 348   }
 349
 350   // Inform the SRC that the migration has been correctly performed
 351   char *task_name = get_mig_task_name(ms->vm, ms->src_pm, ms->dst_pm, 4);
 352   msg_task_t task = MSG_task_create(task_name, 0, 0, nullptr);
 353   msg_error_t ret = MSG_task_send(task, ms->mbox_ctl);
 354   // xbt_assert(ret == MSG_OK);
 355   if(ret == MSG_HOST_FAILURE){
 356     // The DST has crashed, this is a problem has the VM since we are not sure whether SRC is considering that the VM
 357     // has been correctly migrated on the DST node
 358     // TODO What does it mean ? What should we do ?
 359     MSG_task_destroy(task);
 360   } else if(ret == MSG_TRANSFER_FAILURE){
 361     // The SRC has crashed, this is not a problem has the VM has been correctly migrated on the DST node
 362     MSG_task_destroy(task);
 363   }
 364   xbt_free(task_name);
 365
 366   XBT_DEBUG("mig: rx_done");
 367   return 0;
 368 }
 369
 370 static void start_dirty_page_tracking(msg_vm_t vm)
 371 {
 372   simgrid::vm::VirtualMachineImpl* pimpl = static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_;
 373
 374   pimpl->dp_enabled = 1;
 375   if (not pimpl->dp_objs)
 376     return;
 377
 378   char *key = nullptr;
 379   xbt_dict_cursor_t cursor = nullptr;
 380   dirty_page_t dp = nullptr;
 381   xbt_dict_foreach (pimpl->dp_objs, cursor, key, dp) {
 382     double remaining = MSG_task_get_flops_amount(dp->task);
 383     dp->prev_clock = MSG_get_clock();
 384     dp->prev_remaining = remaining;
 385
 386     // XBT_INFO("%s@%s remaining %f", key, sg_host_name(vm), remaining);
 387   }
 388 }
 389
 390 static void stop_dirty_page_tracking(msg_vm_t vm)
 391 {
 392   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->dp_enabled = 0;
 393 }
 394
 395 static double get_computed(char *key, msg_vm_t vm, dirty_page_t dp, double remaining, double clock)
 396 {
 397   double computed = dp->prev_remaining - remaining;
 398   double duration = clock - dp->prev_clock;
 399
 400   XBT_DEBUG("%s@%s: computed %f ops (remaining %f -> %f) in %f secs (%f -> %f)", key, vm->cname(), computed,
 401             dp->prev_remaining, remaining, duration, dp->prev_clock, clock);
 402
 403   return computed;
 404 }
 405
 406 static double lookup_computed_flop_counts(msg_vm_t vm, int stage_for_fancy_debug, int stage2_round_for_fancy_debug)
 407 {
 408   simgrid::vm::VirtualMachineImpl* pimpl = static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_;
 409   double total = 0;
 410
 411   char *key = nullptr;
 412   xbt_dict_cursor_t cursor = nullptr;
 413   dirty_page_t dp = nullptr;
 414   xbt_dict_foreach (pimpl->dp_objs, cursor, key, dp) {
 415     double remaining = MSG_task_get_flops_amount(dp->task);
 416
 417     double clock = MSG_get_clock();
 418
 419     // total += calc_updated_pages(key, vm, dp, remaining, clock);
 420     total += get_computed(key, vm, dp, remaining, clock);
 421
 422     dp->prev_remaining = remaining;
 423     dp->prev_clock = clock;
 424   }
 425
 426   total += pimpl->dp_updated_by_deleted_tasks;
 427
 428   XBT_DEBUG("mig-stage%d.%d: computed %f flop_counts (including %f by deleted tasks)", stage_for_fancy_debug,
 429             stage2_round_for_fancy_debug, total, pimpl->dp_updated_by_deleted_tasks);
 430
 431   pimpl->dp_updated_by_deleted_tasks = 0;
 432
 433   return total;
 434 }
 435
 436 // TODO Is this code redundant with the information provided by
 437 // msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
 438 /** @brief take care of the dirty page tracking, in case we're adding a task to a migrating VM */
 439 void MSG_host_add_task(msg_host_t host, msg_task_t task)
 440 {
 441   simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host);
 442   if (vm == nullptr)
 443     return;
 444   simgrid::vm::VirtualMachineImpl* pimpl = static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_;
 445
 446   double remaining = MSG_task_get_flops_amount(task);
 447   char *key = bprintf("%s-%p", task->name, task);
 448
 449   dirty_page_t dp = xbt_new0(s_dirty_page, 1);
 450   dp->task = task;
 451   if (pimpl->dp_enabled) {
 452     dp->prev_clock = MSG_get_clock();
 453     dp->prev_remaining = remaining;
 454   }
 455   if (not pimpl->dp_objs)
 456     pimpl->dp_objs = xbt_dict_new_homogeneous(nullptr);
 457   xbt_assert(xbt_dict_get_or_null(pimpl->dp_objs, key) == nullptr);
 458   xbt_dict_set(pimpl->dp_objs, key, dp, nullptr);
 459   XBT_DEBUG("add %s on %s (remaining %f, dp_enabled %d)", key, host->cname(), remaining, pimpl->dp_enabled);
 460
 461   xbt_free(key);
 462 }
 463
 464 void MSG_host_del_task(msg_host_t host, msg_task_t task)
 465 {
 466   simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host);
 467   if (vm == nullptr)
 468     return;
 469   simgrid::vm::VirtualMachineImpl* pimpl = static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_;
 470
 471   char *key = bprintf("%s-%p", task->name, task);
 472   dirty_page_t dp = (dirty_page_t)(pimpl->dp_objs ? xbt_dict_get_or_null(pimpl->dp_objs, key) : NULL);
 473   xbt_assert(dp->task == task);
 474
 475   /* If we are in the middle of dirty page tracking, we record how much computation has been done until now, and keep
 476    * the information for the lookup_() function that will called soon. */
 477   if (pimpl->dp_enabled) {
 478     double remaining = MSG_task_get_flops_amount(task);
 479     double clock = MSG_get_clock();
 480     // double updated = calc_updated_pages(key, host, dp, remaining, clock);
 481     double updated = get_computed(key, host, dp, remaining, clock);
 482
 483     pimpl->dp_updated_by_deleted_tasks += updated;
 484   }
 485   if (pimpl->dp_objs)
 486     xbt_dict_remove(pimpl->dp_objs, key);
 487   xbt_free(dp);
 488
 489   XBT_DEBUG("del %s on %s", key, host->cname());
 490   xbt_free(key);
 491 }
 492
 493 static sg_size_t send_migration_data(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm, sg_size_t size, char* mbox,
 494                                      int stage, int stage2_round, double mig_speed, double timeout)
 495 {
 496   sg_size_t sent = 0;
 497   char *task_name = get_mig_task_name(vm, src_pm, dst_pm, stage);
 498   msg_task_t task = MSG_task_create(task_name, 0, static_cast<double>(size), nullptr);
 499
 500   /* TODO: clean up */
 501
 502   double clock_sta = MSG_get_clock();
 503
 504   msg_error_t ret;
 505   if (mig_speed > 0)
 506     ret = MSG_task_send_with_timeout_bounded(task, mbox, timeout, mig_speed);
 507   else
 508     ret = MSG_task_send(task, mbox);
 509
 510   xbt_free(task_name);
 511
 512   if (ret == MSG_OK) {
 513     sent = size;
 514   } else if (ret == MSG_TIMEOUT) {
 515     sg_size_t remaining = static_cast<sg_size_t>(MSG_task_get_remaining_communication(task));
 516     sent = size - remaining;
 517     XBT_VERB("timeout (%lf s) in sending_migration_data, remaining %llu bytes of %llu", timeout, remaining, size);
 518   }
 519
 520   /* FIXME: why try-and-catch is used here? */
 521   if(ret == MSG_HOST_FAILURE){
 522     XBT_DEBUG("SRC host failed during migration of %s (stage %d)", vm->cname(), stage);
 523     MSG_task_destroy(task);
 524     THROWF(host_error, 0, "SRC host failed during migration of %s (stage %d)", vm->cname(), stage);
 525   }else if(ret == MSG_TRANSFER_FAILURE){
 526     XBT_DEBUG("DST host failed during migration of %s (stage %d)", vm->cname(), stage);
 527     MSG_task_destroy(task);
 528     THROWF(host_error, 0, "DST host failed during migration of %s (stage %d)", vm->cname(), stage);
 529   }
 530
 531   double clock_end = MSG_get_clock();
 532   double duration = clock_end - clock_sta;
 533   double actual_speed = size / duration;
 534
 535   if (stage == 2)
 536     XBT_DEBUG("mig-stage%d.%d: sent %llu duration %f actual_speed %f (target %f)", stage, stage2_round, size, duration,
 537               actual_speed, mig_speed);
 538   else
 539     XBT_DEBUG("mig-stage%d: sent %llu duration %f actual_speed %f (target %f)", stage, size, duration, actual_speed,
 540               mig_speed);
 541
 542   return sent;
 543 }
 544
 545 static sg_size_t get_updated_size(double computed, double dp_rate, double dp_cap)
 546 {
 547   double updated_size = computed * dp_rate;
 548   XBT_DEBUG("updated_size %f dp_rate %f", updated_size, dp_rate);
 549   if (updated_size > dp_cap) {
 550     // XBT_INFO("mig-stage2.%d: %f bytes updated, but cap it with the working set size %f", stage2_round, updated_size,
 551     //          dp_cap);
 552     updated_size = dp_cap;
 553   }
 554
 555   return static_cast<sg_size_t>(updated_size);
 556 }
 557
 558 static int migration_tx_fun(int argc, char *argv[])
 559 {
 560   XBT_DEBUG("mig: tx_start");
 561
 562   // Note that the ms structure has been allocated in do_migration and hence should be freed in the same function ;)
 563   migration_session *ms = static_cast<migration_session *>(MSG_process_get_data(MSG_process_self()));
 564
 565   s_vm_params_t params;
 566   static_cast<simgrid::s4u::VirtualMachine*>(ms->vm)->parameters(&params);
 567   const sg_size_t ramsize   = params.ramsize;
 568   const sg_size_t devsize   = params.devsize;
 569   const int skip_stage1     = params.skip_stage1;
 570   int skip_stage2           = params.skip_stage2;
 571   const double dp_rate      = params.dp_rate;
 572   const double dp_cap       = params.dp_cap;
 573   const double mig_speed    = params.mig_speed;
 574   double max_downtime       = params.max_downtime;
 575
 576   double mig_timeout = 10000000.0;
 577
 578   double remaining_size = static_cast<double>(ramsize + devsize);
 579   double threshold = 0.0;
 580
 581   /* check parameters */
 582   if (ramsize == 0)
 583     XBT_WARN("migrate a VM, but ramsize is zero");
 584
 585   if (max_downtime <= 0) {
 586     XBT_WARN("use the default max_downtime value 30ms");
 587     max_downtime = 0.03;
 588   }
 589
 590   /* Stage1: send all memory pages to the destination. */
 591   XBT_DEBUG("mig-stage1: remaining_size %f", remaining_size);
 592   start_dirty_page_tracking(ms->vm);
 593
 594   double computed_during_stage1 = 0;
 595   if (not skip_stage1) {
 596     double clock_prev_send = MSG_get_clock();
 597
 598     try {
 599       /* At stage 1, we do not need timeout. We have to send all the memory pages even though the duration of this
 600        * transfer exceeds the timeout value. */
 601       XBT_VERB("Stage 1: Gonna send %llu", ramsize);
 602       sg_size_t sent = send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, ramsize, ms->mbox, 1, 0, mig_speed, -1);
 603       remaining_size -= sent;
 604       computed_during_stage1 = lookup_computed_flop_counts(ms->vm, 1, 0);
 605
 606       if (sent < ramsize) {
 607         XBT_VERB("mig-stage1: timeout, force moving to stage 3");
 608         skip_stage2 = 1;
 609       } else if (sent > ramsize)
 610         XBT_CRITICAL("bug");
 611
 612     }
 613     catch (xbt_ex& e) {
 614       //hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
 615       // Stop the dirty page tracking an return (there is no memory space to release)
 616       stop_dirty_page_tracking(ms->vm);
 617       return 0;
 618     }
 619
 620     double clock_post_send = MSG_get_clock();
 621     mig_timeout -= (clock_post_send - clock_prev_send);
 622     if (mig_timeout < 0) {
 623       XBT_VERB("The duration of stage 1 exceeds the timeout value, skip stage 2");
 624       skip_stage2 = 1;
 625     }
 626
 627     /* estimate bandwidth */
 628     double bandwidth = ramsize / (clock_post_send - clock_prev_send);
 629     threshold        = bandwidth * max_downtime;
 630     XBT_DEBUG("actual bandwidth %f (MB/s), threshold %f", bandwidth / 1024 / 1024, threshold);
 631   }
 632
 633
 634   /* Stage2: send update pages iteratively until the size of remaining states becomes smaller than threshold value. */
 635   if (not skip_stage2) {
 636
 637     int stage2_round = 0;
 638     for (;;) {
 639
 640       sg_size_t updated_size = 0;
 641       if (stage2_round == 0) {
 642         /* just after stage1, nothing has been updated. But, we have to send the data updated during stage1 */
 643         updated_size = get_updated_size(computed_during_stage1, dp_rate, dp_cap);
 644       } else {
 645         double computed = lookup_computed_flop_counts(ms->vm, 2, stage2_round);
 646         updated_size    = get_updated_size(computed, dp_rate, dp_cap);
 647       }
 648
 649       XBT_DEBUG("mig-stage 2:%d updated_size %llu computed_during_stage1 %f dp_rate %f dp_cap %f", stage2_round,
 650                 updated_size, computed_during_stage1, dp_rate, dp_cap);
 651
 652       /* Check whether the remaining size is below the threshold value. If so, move to stage 3. */
 653       remaining_size += updated_size;
 654       XBT_DEBUG("mig-stage2.%d: remaining_size %f (%s threshold %f)", stage2_round, remaining_size,
 655                 (remaining_size < threshold) ? "<" : ">", threshold);
 656       if (remaining_size < threshold)
 657         break;
 658
 659       sg_size_t sent         = 0;
 660       double clock_prev_send = MSG_get_clock();
 661       try {
 662         XBT_DEBUG("Stage 2, gonna send %llu", updated_size);
 663         sent = send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, updated_size, ms->mbox, 2, stage2_round, mig_speed,
 664                                    mig_timeout);
 665       } catch (xbt_ex& e) {
 666         // hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data
 667         // code)
 668         // Stop the dirty page tracking an return (there is no memory space to release)
 669         stop_dirty_page_tracking(ms->vm);
 670         return 0;
 671       }
 672       double clock_post_send = MSG_get_clock();
 673
 674       if (sent == updated_size) {
 675         /* timeout did not happen */
 676         double bandwidth = updated_size / (clock_post_send - clock_prev_send);
 677         threshold        = bandwidth * max_downtime;
 678         XBT_DEBUG("actual bandwidth %f, threshold %f", bandwidth / 1024 / 1024, threshold);
 679         remaining_size -= sent;
 680         stage2_round += 1;
 681         mig_timeout -= (clock_post_send - clock_prev_send);
 682         xbt_assert(mig_timeout > 0);
 683
 684       } else if (sent < updated_size) {
 685         /* When timeout happens, we move to stage 3. The size of memory pages
 686          * updated before timeout must be added to the remaining size. */
 687         XBT_VERB("mig-stage2.%d: timeout, force moving to stage 3. sent %llu / %llu, eta %lf", stage2_round, sent,
 688                  updated_size, (clock_post_send - clock_prev_send));
 689         remaining_size -= sent;
 690
 691         double computed = lookup_computed_flop_counts(ms->vm, 2, stage2_round);
 692         updated_size    = get_updated_size(computed, dp_rate, dp_cap);
 693         remaining_size += updated_size;
 694         break;
 695       } else
 696         XBT_CRITICAL("bug");
 697     }
 698   }
 699
 700   /* Stage3: stop the VM and copy the rest of states. */
 701   XBT_DEBUG("mig-stage3: remaining_size %f", remaining_size);
 702   simgrid::vm::VirtualMachineImpl* pimpl = static_cast<simgrid::s4u::VirtualMachine*>(ms->vm)->pimpl_vm_;
 703   pimpl->setState(SURF_VM_STATE_RUNNING); // FIXME: this bypass of the checks in suspend() is not nice
 704   pimpl->isMigrating = false;             // FIXME: this bypass of the checks in suspend() is not nice
 705   pimpl->suspend(SIMIX_process_self());
 706   stop_dirty_page_tracking(ms->vm);
 707
 708   try {
 709     XBT_DEBUG("Stage 3: Gonna send %f", remaining_size);
 710     send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, static_cast<sg_size_t>(remaining_size), ms->mbox, 3, 0,
 711                         mig_speed, -1);
 712   }
 713   catch(xbt_ex& e) {
 714     //hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
 715     // Stop the dirty page tracking an return (there is no memory space to release)
 716     static_cast<simgrid::s4u::VirtualMachine*>(ms->vm)->pimpl_vm_->resume();
 717     return 0;
 718   }
 719
 720   // At that point the Migration is considered valid for the SRC node but remind that the DST side should relocate
 721   // effectively the VM on the DST node.
 722   XBT_DEBUG("mig: tx_done");
 723
 724   return 0;
 725 }
 726
 727 /** @brief Migrate the VM to the given host.
 728  *  @ingroup msg_VMs
 729  */
 730 void MSG_vm_migrate(msg_vm_t vm, msg_host_t dst_pm)
 731 {
 732   /* some thoughts:
 733    * - One approach is ...
 734    *   We first create a new VM (i.e., destination VM) on the destination   physical host. The destination VM will
 735    *   receive the state of the source
 736    *   VM over network. We will finally destroy the source VM.
 737    *   - This behavior is similar to the way of migration in the real world.
 738    *     Even before a migration is completed, we will see a destination VM, consuming resources.
 739    *   - We have to relocate all processes. The existing process migration code will work for this?
 740    *   - The name of the VM is a somewhat unique ID in the code. It is tricky for the destination VM?
 741    *
 742    * - Another one is ...
 743    *   We update the information of the given VM to place it to the destination physical host.
 744    *
 745    * The second one would be easier.
 746    */
 747
 748   simgrid::s4u::VirtualMachine* typedVm  = static_cast<simgrid::s4u::VirtualMachine*>(vm);
 749   simgrid::vm::VirtualMachineImpl* pimpl = typedVm->pimpl_vm_;
 750   msg_host_t src_pm                      = pimpl->getPm();
 751
 752   if (src_pm->isOff())
 753     THROWF(vm_error, 0, "Cannot migrate VM '%s' from host '%s', which is offline.", vm->cname(), src_pm->cname());
 754   if (dst_pm->isOff())
 755     THROWF(vm_error, 0, "Cannot migrate VM '%s' to host '%s', which is offline.", vm->cname(), dst_pm->cname());
 756   if (not MSG_vm_is_running(vm))
 757     THROWF(vm_error, 0, "Cannot migrate VM '%s' that is not running yet.", vm->cname());
 758   if (typedVm->isMigrating())
 759     THROWF(vm_error, 0, "Cannot migrate VM '%s' that is already migrating.", vm->cname());
 760
 761   pimpl->isMigrating = true;
 762
 763   struct migration_session *ms = xbt_new(struct migration_session, 1);
 764   ms->vm = vm;
 765   ms->src_pm = src_pm;
 766   ms->dst_pm = dst_pm;
 767
 768   /* We have two mailboxes. mbox is used to transfer migration data between source and destination PMs. mbox_ctl is used
 769    * to detect the completion of a migration. The names of these mailboxes must not conflict with others. */
 770   ms->mbox_ctl = bprintf("__mbox_mig_ctl:%s(%s-%s)", vm->cname(), src_pm->cname(), dst_pm->cname());
 771   ms->mbox     = bprintf("__mbox_mig_src_dst:%s(%s-%s)", vm->cname(), src_pm->cname(), dst_pm->cname());
 772
 773   char *pr_rx_name = get_mig_process_rx_name(vm, src_pm, dst_pm);
 774   char *pr_tx_name = get_mig_process_tx_name(vm, src_pm, dst_pm);
 775
 776   char** argv = xbt_new(char*, 2);
 777   argv[0]     = pr_rx_name;
 778   argv[1]     = nullptr;
 779   MSG_process_create_with_arguments(pr_rx_name, migration_rx_fun, ms, dst_pm, 1, argv);
 780
 781   argv        = xbt_new(char*, 2);
 782   argv[0]     = pr_tx_name;
 783   argv[1]     = nullptr;
 784   MSG_process_create_with_arguments(pr_tx_name, migration_tx_fun, ms, src_pm, 1, argv);
 785
 786   /* wait until the migration have finished or on error has occurred */
 787   XBT_DEBUG("wait for reception of the final ACK (i.e. migration has been correctly performed");
 788   msg_task_t task = nullptr;
 789   msg_error_t ret = MSG_task_receive(&task, ms->mbox_ctl);
 790
 791   pimpl->isMigrating = false;
 792
 793   xbt_free(ms->mbox_ctl);
 794   xbt_free(ms->mbox);
 795   xbt_free(ms);
 796
 797   if (ret == MSG_HOST_FAILURE) {
 798     // Note that since the communication failed, the owner did not change and the task should be destroyed on the
 799     // other side. Hence, just throw the execption
 800     XBT_ERROR("SRC crashes, throw an exception (m-control)");
 801     // MSG_process_kill(tx_process); // Adrien, I made a merge on Nov 28th 2014, I'm not sure whether this line is
 802     // required or not
 803     THROWF(host_error, 0, "Source host '%s' failed during the migration of VM '%s'.", src_pm->cname(), vm->cname());
 804   } else if ((ret == MSG_TRANSFER_FAILURE) || (ret == MSG_TIMEOUT)) {
 805     // MSG_TIMEOUT here means that MSG_host_is_avail() returned false.
 806     XBT_ERROR("DST crashes, throw an exception (m-control)");
 807     THROWF(host_error, 0, "Destination host '%s' failed during the migration of VM '%s'.", dst_pm->cname(),
 808            vm->cname());
 809   }
 810
 811   char* expected_task_name = get_mig_task_name(vm, src_pm, dst_pm, 4);
 812   xbt_assert(strcmp(task->name, expected_task_name) == 0);
 813   xbt_free(expected_task_name);
 814   MSG_task_destroy(task);
 815 }
 816
 817 /** @brief Immediately suspend the execution of all processes within the given VM.
 818  *  @ingroup msg_VMs
 819  *
 820  * This function stops the execution of the VM. All the processes on this VM
 821  * will pause. The state of the VM is preserved. We can later resume it again.
 822  *
 823  * No suspension cost occurs.
 824  */
 825 void MSG_vm_suspend(msg_vm_t vm)
 826 {
 827   smx_actor_t issuer = SIMIX_process_self();
 828   simgrid::simix::kernelImmediate([vm,issuer]() {
 829     static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->suspend(issuer);
 830   });
 831
 832   XBT_DEBUG("vm_suspend done");
 833
 834   if (TRACE_msg_vm_is_enabled()) {
 835     container_t vm_container = PJ_container_get(vm->cname());
 836     type_t type              = PJ_type_get("MSG_VM_STATE", vm_container->type);
 837     val_t value              = PJ_value_get_or_new("suspend", "1 0 0", type); // suspend is red
 838     new PushStateEvent(MSG_get_clock(), vm_container, type, value);
 839   }
 840 }
 841
 842 /** @brief Resume the execution of the VM. All processes on the VM run again.
 843  *  @ingroup msg_VMs
 844  *
 845  * No resume cost occurs.
 846  */
 847 void MSG_vm_resume(msg_vm_t vm)
 848 {
 849   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->resume();
 850
 851   if (TRACE_msg_vm_is_enabled()) {
 852     container_t vm_container = PJ_container_get(vm->cname());
 853     type_t type              = PJ_type_get("MSG_VM_STATE", vm_container->type);
 854     new PopStateEvent(MSG_get_clock(), vm_container, type);
 855   }
 856 }
 857
 858 /** @brief Get the physical host of a given VM.
 859  *  @ingroup msg_VMs
 860  */
 861 msg_host_t MSG_vm_get_pm(msg_vm_t vm)
 862 {
 863   return static_cast<simgrid::s4u::VirtualMachine*>(vm)->pm();
 864 }
 865
 866 /** @brief Set a CPU bound for a given VM.
 867  *  @ingroup msg_VMs
 868  *
 869  * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
 870  *
 871  * For example,
 872  *  On PM0, there are Task1 and VM0.
 873  *  On VM0, there is Task2.
 874  * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
 875  * Then,
 876  *  Task1\@PM0 gets 50%.
 877  *  Task2\@VM0 gets 25%.
 878  * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
 879  *
 880  * This is because a VM has the dummy CPU action in the PM layer. Putting a task on the VM does not affect the bound of
 881  * the dummy CPU action. The bound of the dummy CPU action is unlimited.
 882  *
 883  * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
 884  * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
 885  * on the VM in share_resource() or we have to trap both the start and end of task execution.
 886  *
 887  * The current solution is to use MSG_vm_set_bound(), which allows us to directly set the bound of the dummy CPU action.
 888  *
 889  * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
 890  *    computation task (or a VM) never exceeds the capacity of a CPU core.
 891  */
 892 void MSG_vm_set_bound(msg_vm_t vm, double bound)
 893 {
 894   simgrid::simix::kernelImmediate(
 895       [vm, bound]() { static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->setBound(bound); });
 896 }
 897
 898 SG_END_DECL()