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