Logo AND Algorithmique Numérique Distribuée

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