Logo AND Algorithmique Numérique Distribuée

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