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