src/plugins/vm/VmLiveMigration.cpp

   1 /* Copyright (c) 2013-2020. 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_SUBCATEGORY(vm_live_migration, s4u, "S4U virtual machines live migration");
  13
  14 namespace simgrid {
  15 namespace vm {
  16 xbt::Extension<s4u::Host, VmMigrationExt> VmMigrationExt::EXTENSION_ID;
  17
  18 void VmMigrationExt::ensureVmMigrationExtInstalled()
  19 {
  20   if (not EXTENSION_ID.valid())
  21     EXTENSION_ID = 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     const 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()->end_migration();
  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 = instr::Container::by_name(vm_->get_name());
  63     instr::Container::get_root()->get_link("VM_LINK")->start_event(msg, "M", key);
  64
  65     // destroy existing container of this vm
  66     instr::Container::by_name(vm_->get_name())->remove_from_parent();
  67
  68     // create new container on the new_host location
  69     new instr::Container(vm_->get_name(), "VM", instr::Container::by_name(dst_pm_->get_name()));
  70
  71     // end link
  72     msg = instr::Container::by_name(vm_->get_name());
  73     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   auto* 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   auto 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   auto* 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::CommPtr comm = mbox->put_init(msg, size);
 105   if (mig_speed > 0)
 106     comm->set_rate(mig_speed);
 107   try {
 108     comm->wait_for(timeout);
 109   } catch (const Exception&) {
 110     auto remaining = static_cast<sg_size_t>(comm->get_remaining());
 111     XBT_VERB("timeout (%lf s) in sending_migration_data, remaining %llu bytes of %llu", timeout, remaining, size);
 112     sent -= remaining;
 113     delete msg;
 114   }
 115
 116   double clock_end    = s4u::Engine::get_clock();
 117   double duration     = clock_end - clock_sta;
 118   double actual_speed = static_cast<double>(size) / duration;
 119
 120   if (stage == 2)
 121     XBT_DEBUG("mig-stage%d.%d: sent %llu duration %f actual_speed %f (target %f)", stage, stage2_round, size, duration,
 122               actual_speed, mig_speed);
 123   else
 124     XBT_DEBUG("mig-stage%d: sent %llu duration %f actual_speed %f (target %f)", stage, size, duration, actual_speed,
 125               mig_speed);
 126
 127   return sent;
 128 }
 129
 130 void MigrationTx::operator()()
 131 {
 132   XBT_DEBUG("mig: tx_start");
 133
 134   double host_speed       = vm_->get_pm()->get_speed();
 135   const sg_size_t ramsize = vm_->get_ramsize();
 136   const double dp_rate =
 137       host_speed != 0.0 ? (sg_vm_get_migration_speed(vm_) * sg_vm_get_dirty_page_intensity(vm_)) / host_speed : 1;
 138   const sg_size_t dp_cap = sg_vm_get_working_set_memory(vm_);
 139   const double mig_speed = sg_vm_get_migration_speed(vm_);
 140   double max_downtime    = sg_vm_get_max_downtime(vm_);
 141
 142   double mig_timeout = 10000000.0;
 143   bool skip_stage2   = false;
 144
 145   size_t remaining_size = ramsize;
 146
 147   double clock_prev_send;
 148   double clock_post_send;
 149   double bandwidth;
 150   size_t threshold;
 151
 152   /* check parameters */
 153   if (ramsize == 0)
 154     XBT_WARN("migrate a VM, but ramsize is zero");
 155
 156   if (max_downtime <= 0) {
 157     XBT_WARN("use the default max_downtime value 30ms");
 158     max_downtime = 0.03;
 159   }
 160
 161   /* Stage1: send all memory pages to the destination. */
 162   XBT_DEBUG("mig-stage1: remaining_size %zu", remaining_size);
 163   sg_vm_start_dirty_page_tracking(vm_);
 164
 165   double computed_during_stage1 = 0;
 166   clock_prev_send               = s4u::Engine::get_clock();
 167
 168   try {
 169     /* At stage 1, we do not need timeout. We have to send all the memory pages even though the duration of this
 170      * transfer exceeds the timeout value. */
 171     XBT_VERB("Stage 1: Gonna send %llu bytes", ramsize);
 172     sg_size_t sent = sendMigrationData(ramsize, 1, 0, mig_speed, -1);
 173     remaining_size -= sent;
 174     computed_during_stage1 = sg_vm_lookup_computed_flops(vm_);
 175
 176     if (sent < ramsize) {
 177       XBT_VERB("mig-stage1: timeout, force moving to stage 3");
 178       skip_stage2 = true;
 179     } else if (sent > ramsize)
 180       XBT_CRITICAL("bug");
 181   } catch (const Exception&) {
 182     // hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
 183     // Stop the dirty page tracking an return (there is no memory space to release)
 184     sg_vm_stop_dirty_page_tracking(vm_);
 185     return;
 186   }
 187
 188   clock_post_send = s4u::Engine::get_clock();
 189   mig_timeout -= (clock_post_send - clock_prev_send);
 190   if (mig_timeout < 0) {
 191     XBT_VERB("The duration of stage 1 exceeds the timeout value, skip stage 2");
 192     skip_stage2 = true;
 193   }
 194
 195   /* estimate bandwidth */
 196   bandwidth = ramsize / (clock_post_send - clock_prev_send);
 197   threshold = bandwidth * max_downtime;
 198   XBT_DEBUG("actual bandwidth %f (MB/s), threshold %zu", bandwidth / 1024 / 1024, threshold);
 199
 200   /* Stage2: send update pages iteratively until the size of remaining states becomes smaller than threshold value. */
 201   if (not skip_stage2) {
 202     int stage2_round = 0;
 203     /* just after stage1, nothing has been updated. But, we have to send the data updated during stage1 */
 204     sg_size_t updated_size = get_updated_size(computed_during_stage1, dp_rate, dp_cap);
 205     remaining_size += updated_size;
 206     XBT_DEBUG("mig-stage2.%d: remaining_size %zu (%s threshold %zu)", stage2_round, remaining_size,
 207               (remaining_size < threshold) ? "<" : ">", threshold);
 208
 209     /* When the remaining size is below the threshold value, move to stage 3. */
 210     while (threshold < remaining_size) {
 211       XBT_DEBUG("mig-stage 2:%d updated_size %llu computed_during_stage1 %f dp_rate %f dp_cap %llu", stage2_round,
 212                 updated_size, computed_during_stage1, dp_rate, dp_cap);
 213
 214       sg_size_t sent  = 0;
 215       clock_prev_send = s4u::Engine::get_clock();
 216       try {
 217         XBT_DEBUG("Stage 2, gonna send %llu", updated_size);
 218         sent = sendMigrationData(updated_size, 2, stage2_round, mig_speed, mig_timeout);
 219       } catch (const Exception&) {
 220         // hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data
 221         // code)
 222         // Stop the dirty page tracking an return (there is no memory space to release)
 223         sg_vm_stop_dirty_page_tracking(vm_);
 224         return;
 225       }
 226
 227       remaining_size -= sent;
 228       double computed = sg_vm_lookup_computed_flops(vm_);
 229
 230       clock_post_send = s4u::Engine::get_clock();
 231
 232       if (sent == updated_size) {
 233         bandwidth = updated_size / (clock_post_send - clock_prev_send);
 234         threshold = bandwidth * max_downtime;
 235         XBT_DEBUG("actual bandwidth %f, threshold %zu", bandwidth / 1024 / 1024, threshold);
 236         stage2_round += 1;
 237         mig_timeout -= (clock_post_send - clock_prev_send);
 238         xbt_assert(mig_timeout > 0);
 239         XBT_DEBUG("mig-stage2.%d: remaining_size %zu (%s threshold %zu)", stage2_round, remaining_size,
 240                   (remaining_size < threshold) ? "<" : ">", threshold);
 241         updated_size = get_updated_size(computed, dp_rate, dp_cap);
 242         remaining_size += updated_size;
 243       } else {
 244         /* When timeout happens, we move to stage 3. The size of memory pages
 245          * updated before timeout must be added to the remaining size. */
 246         XBT_VERB("mig-stage2.%d: timeout, force moving to stage 3. sent %llu / %llu, eta %lf", stage2_round, sent,
 247                  updated_size, (clock_post_send - clock_prev_send));
 248         updated_size    = get_updated_size(computed, dp_rate, dp_cap);
 249         remaining_size += updated_size;
 250         break;
 251       }
 252     }
 253   }
 254
 255   /* Stage3: stop the VM and copy the rest of states. */
 256   XBT_DEBUG("mig-stage3: remaining_size %zu", remaining_size);
 257   vm_->suspend();
 258   sg_vm_stop_dirty_page_tracking(vm_);
 259
 260   try {
 261     XBT_DEBUG("Stage 3: Gonna send %zu bytes", remaining_size);
 262     sendMigrationData(remaining_size, 3, 0, mig_speed, -1);
 263   } catch (const Exception&) {
 264     // hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
 265     // Stop the dirty page tracking an return (there is no memory space to release)
 266     vm_->resume();
 267     return;
 268   }
 269
 270   // At that point the Migration is considered valid for the SRC node but remind that the DST side should relocate
 271   // effectively the VM on the DST node.
 272   XBT_DEBUG("mig: tx_done");
 273 }
 274 } // namespace vm
 275 } // namespace simgrid
 276
 277 static void onVirtualMachineShutdown(simgrid::s4u::VirtualMachine const& vm)
 278 {
 279   if (vm.get_impl()->is_migrating()) {
 280     vm.extension<simgrid::vm::VmMigrationExt>()->rx_->kill();
 281     vm.extension<simgrid::vm::VmMigrationExt>()->tx_->kill();
 282     vm.extension<simgrid::vm::VmMigrationExt>()->issuer_->kill();
 283     vm.get_impl()->end_migration();
 284   }
 285 }
 286
 287 void sg_vm_live_migration_plugin_init()
 288 {
 289   sg_vm_dirty_page_tracking_init();
 290   simgrid::vm::VmMigrationExt::ensureVmMigrationExtInstalled();
 291   simgrid::s4u::VirtualMachine::on_shutdown.connect(&onVirtualMachineShutdown);
 292 }
 293
 294 simgrid::s4u::VirtualMachine* sg_vm_create_migratable(simgrid::s4u::Host* pm, const char* name, int coreAmount,
 295                                                       int ramsize, int mig_netspeed, int dp_intensity)
 296 {
 297   simgrid::vm::VmHostExt::ensureVmExtInstalled();
 298
 299   /* For the moment, intensity_rate is the percentage against the migration bandwidth */
 300
 301   auto* vm = new simgrid::s4u::VirtualMachine(name, pm, coreAmount, static_cast<sg_size_t>(ramsize) * 1024 * 1024);
 302   sg_vm_set_dirty_page_intensity(vm, dp_intensity / 100.0);
 303   sg_vm_set_working_set_memory(vm, vm->get_ramsize() * 0.9); // assume working set memory is 90% of ramsize
 304   sg_vm_set_migration_speed(vm, mig_netspeed * 1024 * 1024.0);
 305
 306   XBT_DEBUG("migspeed : %f intensity mem : %d", mig_netspeed * 1024 * 1024.0, dp_intensity);
 307
 308   return vm;
 309 }
 310
 311 int sg_vm_is_migrating(const simgrid::s4u::VirtualMachine* vm)
 312 {
 313   return vm->get_impl()->is_migrating();
 314 }
 315
 316 void sg_vm_migrate(simgrid::s4u::VirtualMachine* vm, simgrid::s4u::Host* dst_pm)
 317 {
 318   simgrid::s4u::Host* src_pm = vm->get_pm();
 319
 320   if (not src_pm->is_on())
 321     throw simgrid::VmFailureException(
 322         XBT_THROW_POINT, simgrid::xbt::string_printf("Cannot migrate VM '%s' from host '%s', which is offline.",
 323                                                      vm->get_cname(), src_pm->get_cname()));
 324   if (not dst_pm->is_on())
 325     throw simgrid::VmFailureException(
 326         XBT_THROW_POINT, simgrid::xbt::string_printf("Cannot migrate VM '%s' to host '%s', which is offline.",
 327                                                      vm->get_cname(), dst_pm->get_cname()));
 328   if (vm->get_state() != simgrid::s4u::VirtualMachine::state::RUNNING)
 329     throw simgrid::VmFailureException(
 330         XBT_THROW_POINT,
 331         simgrid::xbt::string_printf("Cannot migrate VM '%s' that is not running yet.", vm->get_cname()));
 332   if (vm->get_impl()->is_migrating())
 333     throw simgrid::VmFailureException(
 334         XBT_THROW_POINT,
 335         simgrid::xbt::string_printf("Cannot migrate VM '%s' that is already migrating.", vm->get_cname()));
 336
 337   vm->get_impl()->start_migration();
 338   simgrid::s4u::VirtualMachine::on_migration_start(*vm);
 339
 340   std::string rx_name =
 341       std::string("__pr_mig_rx:") + vm->get_cname() + "(" + src_pm->get_cname() + "-" + dst_pm->get_cname() + ")";
 342   std::string tx_name =
 343       std::string("__pr_mig_tx:") + vm->get_cname() + "(" + src_pm->get_cname() + "-" + dst_pm->get_cname() + ")";
 344
 345   simgrid::s4u::ActorPtr rx =
 346       simgrid::s4u::Actor::create(rx_name.c_str(), dst_pm, simgrid::vm::MigrationRx(vm, dst_pm));
 347   simgrid::s4u::ActorPtr tx =
 348       simgrid::s4u::Actor::create(tx_name.c_str(), src_pm, simgrid::vm::MigrationTx(vm, dst_pm));
 349
 350   vm->extension_set<simgrid::vm::VmMigrationExt>(new simgrid::vm::VmMigrationExt(simgrid::s4u::Actor::self(), rx, tx));
 351
 352   /* wait until the migration have finished or on error has occurred */
 353   XBT_DEBUG("wait for reception of the final ACK (i.e. migration has been correctly performed");
 354   simgrid::s4u::Mailbox* mbox_ctl = simgrid::s4u::Mailbox::by_name(
 355       std::string("__mbox_mig_ctl:") + vm->get_cname() + "(" + src_pm->get_cname() + "-" + dst_pm->get_cname() + ")");
 356   delete static_cast<std::string*>(mbox_ctl->get());
 357   tx->join();
 358   rx->join();
 359
 360   vm->get_impl()->end_migration();
 361   simgrid::s4u::VirtualMachine::on_migration_end(*vm);
 362 }