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