src/msg/msg_vm.cpp

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