src/msg/msg_vm.cpp

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