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