src/plugins/vm/VmLiveMigration.cpp

   1 /* Copyright (c) 2013-2019. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "src/plugins/vm/VmLiveMigration.hpp"
   7 #include "simgrid/Exception.hpp"
   8 #include "src/instr/instr_private.hpp"
   9 #include "src/plugins/vm/VirtualMachineImpl.hpp"
  10 #include "src/plugins/vm/VmHostExt.hpp"
  11
  12 XBT_LOG_NEW_DEFAULT_CATEGORY(vm_live_migration, "S4U virtual machines live migration");
  13
  14 namespace simgrid {
  15 namespace vm {
  16 simgrid::xbt::Extension<s4u::Host, VmMigrationExt> VmMigrationExt::EXTENSION_ID;
  17
  18 void VmMigrationExt::ensureVmMigrationExtInstalled()
  19 {
  20   if (not EXTENSION_ID.valid())
  21     EXTENSION_ID = simgrid::s4u::Host::extension_create<VmMigrationExt>();
  22 }
  23
  24 void MigrationRx::operator()()
  25 {
  26   XBT_DEBUG("mig: rx_start");
  27   bool received_finalize = false;
  28
  29   std::string finalize_task_name =
  30       std::string("__mig_stage3:") + vm_->get_cname() + "(" + src_pm_->get_cname() + "-" + dst_pm_->get_cname() + ")";
  31
  32   while (not received_finalize) {
  33     std::string* payload = static_cast<std::string*>(mbox->get());
  34
  35     if (finalize_task_name == *payload)
  36       received_finalize = true;
  37
  38     delete payload;
  39   }
  40
  41   // Here Stage 1, 2  and 3 have been performed.
  42   // Hence complete the migration
  43
  44   /* Update the vm location */
  45   /* precopy migration makes the VM temporally paused */
  46   xbt_assert(vm_->get_state() == s4u::VirtualMachine::state::SUSPENDED);
  47
  48   /* Update the vm location and resume it */
  49   vm_->set_pm(dst_pm_);
  50   vm_->resume();
  51
  52   // Now the VM is running on the new host (the migration is completed) (even if the SRC crash)
  53   vm_->get_impl()->is_migrating_ = false;
  54   XBT_DEBUG("VM(%s) moved from PM(%s) to PM(%s)", vm_->get_cname(), src_pm_->get_cname(), dst_pm_->get_cname());
  55
  56   if (TRACE_vm_is_enabled()) {
  57     static long long int counter = 0;
  58     std::string key              = std::to_string(counter);
  59     counter++;
  60
  61     // start link
  62     container_t msg = simgrid::instr::Container::by_name(vm_->get_name());
  63     simgrid::instr::Container::get_root()->get_link("VM_LINK")->start_event(msg, "M", key);
  64
  65     // destroy existing container of this vm
  66     simgrid::instr::Container::by_name(vm_->get_name())->remove_from_parent();
  67
  68     // create new container on the new_host location
  69     new simgrid::instr::Container(vm_->get_name(), "VM", simgrid::instr::Container::by_name(dst_pm_->get_name()));
  70
  71     // end link
  72     msg = simgrid::instr::Container::by_name(vm_->get_name());
  73     simgrid::instr::Container::get_root()->get_link("VM_LINK")->end_event(msg, "M", key);
  74   }
  75   // Inform the SRC that the migration has been correctly performed
  76   std::string* payload = new std::string("__mig_stage4:");
  77   *payload             = *payload + vm_->get_cname() + "(" + src_pm_->get_cname() + "-" + dst_pm_->get_cname() + ")";
  78
  79   mbox_ctl->put(payload, 0);
  80
  81   XBT_DEBUG("mig: rx_done");
  82 }
  83
  84 static sg_size_t get_updated_size(double computed, double dp_rate, sg_size_t dp_cap)
  85 {
  86   sg_size_t updated_size = static_cast<sg_size_t>(computed * dp_rate);
  87   XBT_DEBUG("updated_size %llu dp_rate %f", updated_size, dp_rate);
  88   if (updated_size > dp_cap) {
  89     updated_size = dp_cap;
  90   }
  91
  92   return updated_size;
  93 }
  94
  95 sg_size_t MigrationTx::sendMigrationData(sg_size_t size, int stage, int stage2_round, double mig_speed, double timeout)
  96 {
  97   sg_size_t sent   = size;
  98   std::string* msg = new std::string("__mig_stage");
  99   *msg             = *msg + std::to_string(stage) + ":" + vm_->get_cname() + "(" + src_pm_->get_cname() + "-" +
 100          dst_pm_->get_cname() + ")";
 101
 102   double clock_sta = s4u::Engine::get_clock();
 103
 104   s4u::Activity* comm = nullptr;
 105   try {
 106     if (mig_speed > 0)
 107       comm = mbox->put_init(msg, size)->set_rate(mig_speed)->wait_for(timeout);
 108     else
 109       comm = mbox->put_async(msg, size)->wait_for(timeout);
 110   } catch (xbt_ex& e) {
 111     if (comm) {
 112       sg_size_t remaining = static_cast<sg_size_t>(comm->get_remaining());
 113       XBT_VERB("timeout (%lf s) in sending_migration_data, remaining %llu bytes of %llu", timeout, remaining, size);
 114       sent -= remaining;
 115     }
 116     delete msg;
 117   }
 118
 119   double clock_end    = s4u::Engine::get_clock();
 120   double duration     = clock_end - clock_sta;
 121   double actual_speed = size / duration;
 122
 123   if (stage == 2)
 124     XBT_DEBUG("mig-stage%d.%d: sent %llu duration %f actual_speed %f (target %f)", stage, stage2_round, size, duration,
 125               actual_speed, mig_speed);
 126   else
 127     XBT_DEBUG("mig-stage%d: sent %llu duration %f actual_speed %f (target %f)", stage, size, duration, actual_speed,
 128               mig_speed);
 129
 130   return sent;
 131 }
 132
 133 void MigrationTx::operator()()
 134 {
 135   XBT_DEBUG("mig: tx_start");
 136
 137   double host_speed       = vm_->get_pm()->get_speed();
 138   const sg_size_t ramsize = vm_->get_ramsize();
 139   const double dp_rate =
 140       host_speed ? (sg_vm_get_migration_speed(vm_) * sg_vm_get_dirty_page_intensity(vm_)) / host_speed : 1;
 141   const sg_size_t dp_cap = sg_vm_get_working_set_memory(vm_);
 142   const double mig_speed = sg_vm_get_migration_speed(vm_);
 143   double max_downtime    = sg_vm_get_max_downtime(vm_);
 144
 145   double mig_timeout = 10000000.0;
 146   bool skip_stage2   = false;
 147
 148   size_t remaining_size = ramsize;
 149
 150   double clock_prev_send;
 151   double clock_post_send;
 152   double bandwidth;
 153   size_t threshold;
 154
 155   /* check parameters */
 156   if (ramsize == 0)
 157     XBT_WARN("migrate a VM, but ramsize is zero");
 158
 159   if (max_downtime <= 0) {
 160     XBT_WARN("use the default max_downtime value 30ms");
 161     max_downtime = 0.03;
 162   }
 163
 164   /* Stage1: send all memory pages to the destination. */
 165   XBT_DEBUG("mig-stage1: remaining_size %zu", remaining_size);
 166   sg_vm_start_dirty_page_tracking(vm_);
 167
 168   double computed_during_stage1 = 0;
 169   clock_prev_send               = s4u::Engine::get_clock();
 170
 171   try {
 172     /* At stage 1, we do not need timeout. We have to send all the memory pages even though the duration of this
 173      * transfer exceeds the timeout value. */
 174     XBT_VERB("Stage 1: Gonna send %llu bytes", ramsize);
 175     sg_size_t sent = sendMigrationData(ramsize, 1, 0, mig_speed, -1);
 176     remaining_size -= sent;
 177     computed_during_stage1 = sg_vm_lookup_computed_flops(vm_);
 178
 179     if (sent < ramsize) {
 180       XBT_VERB("mig-stage1: timeout, force moving to stage 3");
 181       skip_stage2 = true;
 182     } else if (sent > ramsize)
 183       XBT_CRITICAL("bug");
 184
 185   } catch (xbt_ex& e) {
 186     // hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
 187     // Stop the dirty page tracking an return (there is no memory space to release)
 188     sg_vm_stop_dirty_page_tracking(vm_);
 189     return;
 190   }
 191
 192   clock_post_send = s4u::Engine::get_clock();
 193   mig_timeout -= (clock_post_send - clock_prev_send);
 194   if (mig_timeout < 0) {
 195     XBT_VERB("The duration of stage 1 exceeds the timeout value, skip stage 2");
 196     skip_stage2 = true;
 197   }
 198
 199   /* estimate bandwidth */
 200   bandwidth = ramsize / (clock_post_send - clock_prev_send);
 201   threshold = bandwidth * max_downtime;
 202   XBT_DEBUG("actual bandwidth %f (MB/s), threshold %zu", bandwidth / 1024 / 1024, threshold);
 203
 204   /* Stage2: send update pages iteratively until the size of remaining states becomes smaller than threshold value. */
 205   if (not skip_stage2) {
 206
 207     int stage2_round = 0;
 208     for (;;) {
 209       sg_size_t updated_size = 0;
 210       if (stage2_round == 0) {
 211         /* just after stage1, nothing has been updated. But, we have to send the data updated during stage1 */
 212         updated_size = get_updated_size(computed_during_stage1, dp_rate, dp_cap);
 213       } else {
 214         double computed = sg_vm_lookup_computed_flops(vm_);
 215         updated_size    = get_updated_size(computed, dp_rate, dp_cap);
 216       }
 217
 218       XBT_DEBUG("mig-stage 2:%d updated_size %llu computed_during_stage1 %f dp_rate %f dp_cap %llu", stage2_round,
 219                 updated_size, computed_during_stage1, dp_rate, dp_cap);
 220
 221       /* Check whether the remaining size is below the threshold value. If so, move to stage 3. */
 222       remaining_size += updated_size;
 223       XBT_DEBUG("mig-stage2.%d: remaining_size %zu (%s threshold %zu)", stage2_round, remaining_size,
 224                 (remaining_size < threshold) ? "<" : ">", threshold);
 225       if (remaining_size < threshold)
 226         break;
 227
 228       sg_size_t sent  = 0;
 229       clock_prev_send = s4u::Engine::get_clock();
 230       try {
 231         XBT_DEBUG("Stage 2, gonna send %llu", updated_size);
 232         sent = sendMigrationData(updated_size, 2, stage2_round, mig_speed, mig_timeout);
 233       } catch (xbt_ex& e) {
 234         // hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data
 235         // code)
 236         // Stop the dirty page tracking an return (there is no memory space to release)
 237         sg_vm_stop_dirty_page_tracking(vm_);
 238         return;
 239       }
 240       clock_post_send = s4u::Engine::get_clock();
 241
 242       if (sent == updated_size) {
 243         /* timeout did not happen */
 244         bandwidth = updated_size / (clock_post_send - clock_prev_send);
 245         threshold = bandwidth * max_downtime;
 246         XBT_DEBUG("actual bandwidth %f, threshold %zu", bandwidth / 1024 / 1024, threshold);
 247         remaining_size -= sent;
 248         stage2_round += 1;
 249         mig_timeout -= (clock_post_send - clock_prev_send);
 250         xbt_assert(mig_timeout > 0);
 251
 252       } else if (sent < updated_size) {
 253         /* When timeout happens, we move to stage 3. The size of memory pages
 254          * updated before timeout must be added to the remaining size. */
 255         XBT_VERB("mig-stage2.%d: timeout, force moving to stage 3. sent %llu / %llu, eta %lf", stage2_round, sent,
 256                  updated_size, (clock_post_send - clock_prev_send));
 257         remaining_size -= sent;
 258
 259         double computed = sg_vm_lookup_computed_flops(vm_);
 260         updated_size    = get_updated_size(computed, dp_rate, dp_cap);
 261         remaining_size += updated_size;
 262         break;
 263       } else
 264         XBT_CRITICAL("bug");
 265     }
 266   }
 267
 268   /* Stage3: stop the VM and copy the rest of states. */
 269   XBT_DEBUG("mig-stage3: remaining_size %zu", remaining_size);
 270   vm_->suspend();
 271   sg_vm_stop_dirty_page_tracking(vm_);
 272
 273   try {
 274     XBT_DEBUG("Stage 3: Gonna send %zu bytes", remaining_size);
 275     sendMigrationData(remaining_size, 3, 0, mig_speed, -1);
 276   } catch (xbt_ex& e) {
 277     // hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
 278     // Stop the dirty page tracking an return (there is no memory space to release)
 279     vm_->resume();
 280     return;
 281   }
 282
 283   // At that point the Migration is considered valid for the SRC node but remind that the DST side should relocate
 284   // effectively the VM on the DST node.
 285   XBT_DEBUG("mig: tx_done");
 286 }
 287 }
 288 }
 289
 290 static void onVirtualMachineShutdown(simgrid::s4u::VirtualMachine& vm)
 291 {
 292   if (vm.get_impl()->is_migrating_) {
 293     vm.extension<simgrid::vm::VmMigrationExt>()->rx_->kill();
 294     vm.extension<simgrid::vm::VmMigrationExt>()->tx_->kill();
 295     vm.extension<simgrid::vm::VmMigrationExt>()->issuer_->kill();
 296     vm.get_impl()->is_migrating_ = false;
 297   }
 298 }
 299
 300 void sg_vm_live_migration_plugin_init()
 301 {
 302   sg_vm_dirty_page_tracking_init();
 303   simgrid::vm::VmMigrationExt::ensureVmMigrationExtInstalled();
 304   simgrid::s4u::VirtualMachine::on_shutdown.connect(&onVirtualMachineShutdown);
 305 }
 306
 307 simgrid::s4u::VirtualMachine* sg_vm_create_migratable(simgrid::s4u::Host* pm, const char* name, int coreAmount,
 308                                                       int ramsize, int mig_netspeed, int dp_intensity)
 309 {
 310   simgrid::vm::VmHostExt::ensureVmExtInstalled();
 311
 312   /* For the moment, intensity_rate is the percentage against the migration bandwidth */
 313
 314   sg_vm_t vm = new simgrid::s4u::VirtualMachine(name, pm, coreAmount, static_cast<sg_size_t>(ramsize) * 1024 * 1024);
 315   sg_vm_set_dirty_page_intensity(vm, dp_intensity / 100.0);
 316   sg_vm_set_working_set_memory(vm, vm->get_ramsize() * 0.9); // assume working set memory is 90% of ramsize
 317   sg_vm_set_migration_speed(vm, mig_netspeed * 1024 * 1024.0);
 318
 319   XBT_DEBUG("migspeed : %f intensity mem : %d", mig_netspeed * 1024 * 1024.0, dp_intensity);
 320
 321   return vm;
 322 }
 323
 324 int sg_vm_is_migrating(simgrid::s4u::VirtualMachine* vm)
 325 {
 326   return vm->get_impl()->is_migrating_;
 327 }
 328
 329 void sg_vm_migrate(simgrid::s4u::VirtualMachine* vm, simgrid::s4u::Host* dst_pm)
 330 {
 331   simgrid::s4u::Host* src_pm = vm->get_pm();
 332
 333   if (not src_pm->is_on())
 334     THROWF(vm_error, 0, "Cannot migrate VM '%s' from host '%s', which is offline.", vm->get_cname(),
 335            src_pm->get_cname());
 336   if (not dst_pm->is_on())
 337     THROWF(vm_error, 0, "Cannot migrate VM '%s' to host '%s', which is offline.", vm->get_cname(), dst_pm->get_cname());
 338   if (vm->get_state() != simgrid::s4u::VirtualMachine::state::RUNNING)
 339     THROWF(vm_error, 0, "Cannot migrate VM '%s' that is not running yet.", vm->get_cname());
 340   if (vm->get_impl()->is_migrating_)
 341     THROWF(vm_error, 0, "Cannot migrate VM '%s' that is already migrating.", vm->get_cname());
 342
 343   vm->get_impl()->is_migrating_ = true;
 344   simgrid::s4u::VirtualMachine::on_migration_start(*vm);
 345
 346   std::string rx_name =
 347       std::string("__pr_mig_rx:") + vm->get_cname() + "(" + src_pm->get_cname() + "-" + dst_pm->get_cname() + ")";
 348   std::string tx_name =
 349       std::string("__pr_mig_tx:") + vm->get_cname() + "(" + src_pm->get_cname() + "-" + dst_pm->get_cname() + ")";
 350
 351   simgrid::s4u::ActorPtr rx =
 352       simgrid::s4u::Actor::create(rx_name.c_str(), dst_pm, simgrid::vm::MigrationRx(vm, dst_pm));
 353   simgrid::s4u::ActorPtr tx =
 354       simgrid::s4u::Actor::create(tx_name.c_str(), src_pm, simgrid::vm::MigrationTx(vm, dst_pm));
 355
 356   vm->extension_set<simgrid::vm::VmMigrationExt>(new simgrid::vm::VmMigrationExt(simgrid::s4u::Actor::self(), rx, tx));
 357
 358   /* wait until the migration have finished or on error has occurred */
 359   XBT_DEBUG("wait for reception of the final ACK (i.e. migration has been correctly performed");
 360   simgrid::s4u::MailboxPtr mbox_ctl = simgrid::s4u::Mailbox::by_name(
 361       std::string("__mbox_mig_ctl:") + vm->get_cname() + "(" + src_pm->get_cname() + "-" + dst_pm->get_cname() + ")");
 362   delete static_cast<std::string*>(mbox_ctl->get());
 363   tx->join();
 364   rx->join();
 365
 366   vm->get_impl()->is_migrating_ = false;
 367   simgrid::s4u::VirtualMachine::on_migration_end(*vm);
 368 }