Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
this is still unimplemented, but please sonar
[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 "simgrid/plugins/live_migration.h"
15 #include "src/instr/instr_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 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_vm, msg, "Cloud-oriented parts of the MSG API");
26
27 const char* MSG_vm_get_name(msg_vm_t vm)
28 {
29   return vm->getCname();
30 }
31
32 /** \ingroup m_vm_management
33  * \brief Set the parameters of a given host
34  *
35  * \param vm a vm
36  * \param params a parameter object
37  */
38 void MSG_vm_set_params(msg_vm_t vm, vm_params_t params)
39 {
40   vm->setParameters(params);
41 }
42
43 /** \ingroup m_vm_management
44  * \brief Get the parameters of a given host
45  *
46  * \param vm the vm you are interested into
47  * \param params a prameter object
48  */
49 void MSG_vm_get_params(msg_vm_t vm, vm_params_t params)
50 {
51   vm->getParameters(params);
52 }
53
54 void MSG_vm_set_ramsize(msg_vm_t vm, size_t size)
55 {
56   vm->setRamsize(size);
57 }
58 size_t MSG_vm_get_ramsize(msg_vm_t vm)
59 {
60   return vm->getRamsize();
61 }
62
63 /* **** Check state of a VM **** */
64 static inline int __MSG_vm_is_state(msg_vm_t vm, e_surf_vm_state_t state)
65 {
66   return vm->pimpl_vm_ != nullptr && vm->getState() == state;
67 }
68
69 /** @brief Returns whether the given VM has just created, not running.
70  *  @ingroup msg_VMs
71  */
72 int MSG_vm_is_created(msg_vm_t vm)
73 {
74   return __MSG_vm_is_state(vm, SURF_VM_STATE_CREATED);
75 }
76
77 /** @brief Returns whether the given VM is currently running
78  *  @ingroup msg_VMs
79  */
80 int MSG_vm_is_running(msg_vm_t vm)
81 {
82   return __MSG_vm_is_state(vm, SURF_VM_STATE_RUNNING);
83 }
84
85 /** @brief Returns whether the given VM is currently migrating
86  *  @ingroup msg_VMs
87  */
88 int MSG_vm_is_migrating(msg_vm_t vm)
89 {
90   return vm->isMigrating();
91 }
92
93 /** @brief Returns whether the given VM is currently suspended, not running.
94  *  @ingroup msg_VMs
95  */
96 int MSG_vm_is_suspended(msg_vm_t vm)
97 {
98   return __MSG_vm_is_state(vm, SURF_VM_STATE_SUSPENDED);
99 }
100
101 /* **** ******** MSG vm actions ********* **** */
102 /** @brief Create a new VM with specified parameters.
103  *  @ingroup msg_VMs*
104  *  @param pm        Physical machine that will host the VM
105  *  @param name      Must be unique
106  *  @param coreAmount Must be >= 1
107  *  @param ramsize   [TODO]
108  *  @param mig_netspeed Amount of Mbyte/s allocated to the migration (cannot be larger than net_cap). Use 0 if unsure.
109  *  @param dp_intensity Dirty page percentage according to migNetSpeed, [0-100]. Use 0 if unsure.
110  */
111 msg_vm_t MSG_vm_create(msg_host_t pm, const char* name, int coreAmount, int ramsize, int mig_netspeed, int dp_intensity)
112 {
113   simgrid::vm::VmHostExt::ensureVmExtInstalled();
114
115   /* For the moment, intensity_rate is the percentage against the migration bandwidth */
116
117   msg_vm_t vm = new simgrid::s4u::VirtualMachine(name, pm, coreAmount, static_cast<sg_size_t>(ramsize) * 1024 * 1024);
118   s_vm_params_t params;
119   params.max_downtime = 0.03;
120   params.mig_speed    = static_cast<double>(mig_netspeed) * 1024 * 1024; // mig_speed
121   params.dp_intensity = static_cast<double>(dp_intensity) / 100;
122   params.dp_cap       = vm->getRamsize() * 0.9; // assume working set memory is 90% of ramsize
123
124   XBT_DEBUG("migspeed : %f intensity mem : %d", params.mig_speed, dp_intensity);
125   vm->setParameters(&params);
126
127   return vm;
128 }
129
130 /** @brief Create a new VM object with the default parameters
131  *  @ingroup msg_VMs*
132  *
133  * A VM is treated as a host. The name of the VM must be unique among all hosts.
134  */
135 msg_vm_t MSG_vm_create_core(msg_host_t pm, const char* name)
136 {
137   xbt_assert(sg_host_by_name(name) == nullptr,
138              "Cannot create a VM named %s: this name is already used by an host or a VM", name);
139
140   msg_vm_t vm = new simgrid::s4u::VirtualMachine(name, pm, 1);
141   s_vm_params_t params;
142   memset(&params, 0, sizeof(params));
143   vm->setParameters(&params);
144   return vm;
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   msg_vm_t vm = new simgrid::s4u::VirtualMachine(name, pm, coreAmount);
157   s_vm_params_t params;
158   memset(&params, 0, sizeof(params));
159   vm->setParameters(&params);
160   return vm;
161 }
162
163 /** @brief Destroy a VM. Destroy the VM object from the simulation.
164  *  @ingroup msg_VMs
165  */
166 void MSG_vm_destroy(msg_vm_t vm)
167 {
168   if (vm->isMigrating())
169     THROWF(vm_error, 0, "Cannot destroy VM '%s', which is migrating.", vm->getCname());
170
171   /* First, terminate all processes on the VM if necessary */
172   vm->shutdown();
173
174   /* Then, destroy the VM object */
175   vm->destroy();
176
177   if (TRACE_msg_vm_is_enabled()) {
178     container_t container = simgrid::instr::Container::byName(vm->getName());
179     container->removeFromParent();
180     delete container;
181   }
182 }
183
184 /** @brief Start a vm (i.e., boot the guest operating system)
185  *  @ingroup msg_VMs
186  *
187  *  If the VM cannot be started (because of memory over-provisioning), an exception is generated.
188  */
189 void MSG_vm_start(msg_vm_t vm)
190 {
191   vm->start();
192   if (TRACE_msg_vm_is_enabled()) {
193     simgrid::instr::StateType* state = simgrid::instr::Container::byName(vm->getName())->getState("MSG_VM_STATE");
194     state->addEntityValue("start", "0 0 1"); // start is blue
195     state->pushEvent("start");
196   }
197 }
198
199 /** @brief Immediately kills all processes within the given VM.
200  *  @ingroup msg_VMs
201  *
202  * Any memory that they allocated will be leaked, unless you used #MSG_process_on_exit().
203  *
204  * No extra delay occurs. If you want to simulate this too, you want to use a #MSG_process_sleep().
205  */
206 void MSG_vm_shutdown(msg_vm_t vm)
207 {
208   vm->shutdown();
209 }
210
211 static std::string get_mig_process_tx_name(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
212 {
213   return std::string("__pr_mig_tx:") + vm->getCname() + "(" + src_pm->getCname() + "-" + dst_pm->getCname() + ")";
214 }
215
216 static std::string get_mig_process_rx_name(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
217 {
218   return std::string("__pr_mig_rx:") + vm->getCname() + "(" + src_pm->getCname() + "-" + dst_pm->getCname() + ")";
219 }
220
221 static std::string get_mig_task_name(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm, int stage)
222 {
223   return std::string("__task_mig_stage") + std::to_string(stage) + ":" + vm->getCname() + "(" + src_pm->getCname() +
224          "-" + dst_pm->getCname() + ")";
225 }
226
227 struct migration_session {
228   msg_vm_t vm;
229   msg_host_t src_pm;
230   msg_host_t dst_pm;
231
232   /* The miration_rx process uses mbox_ctl to let the caller of do_migration()
233    * know the completion of the migration. */
234   std::string mbox_ctl;
235   /* The migration_rx and migration_tx processes use mbox to transfer migration data. */
236   std::string mbox;
237 };
238
239 static int migration_rx_fun(int argc, char *argv[])
240 {
241   XBT_DEBUG("mig: rx_start");
242
243   // The structure has been created in the do_migration function and should only be freed in the same place ;)
244   migration_session* ms = static_cast<migration_session*>(MSG_process_get_data(MSG_process_self()));
245
246   bool received_finalize = false;
247
248   std::string finalize_task_name = get_mig_task_name(ms->vm, ms->src_pm, ms->dst_pm, 3);
249   while (not received_finalize) {
250     msg_task_t task = nullptr;
251     int ret         = MSG_task_recv(&task, ms->mbox.c_str());
252
253     if (ret != MSG_OK) {
254       // An error occurred, clean the code and return
255       // The owner did not change, hence the task should be only destroyed on the other side
256       return 0;
257     }
258
259     if (finalize_task_name == task->name)
260       received_finalize = 1;
261
262     MSG_task_destroy(task);
263   }
264
265   // Here Stage 1, 2  and 3 have been performed.
266   // Hence complete the migration
267
268   // Copy the reference to the vm (if SRC crashes now, do_migration will free ms)
269   // This is clearly ugly but I (Adrien) need more time to do something cleaner (actually we should copy the whole ms
270   // structure at the beginning and free it at the end of each function)
271   simgrid::s4u::VirtualMachine* vm = ms->vm;
272   msg_host_t dst_pm                = ms->dst_pm;
273
274   // Make sure that we cannot get interrupted between the migrate and the resume to not end in an inconsistent state
275   simgrid::simix::kernelImmediate([vm, dst_pm]() {
276     /* Update the vm location */
277     /* precopy migration makes the VM temporally paused */
278     xbt_assert(vm->getState() == SURF_VM_STATE_SUSPENDED);
279
280     /* Update the vm location and resume it */
281     vm->pimpl_vm_->setPm(dst_pm);
282     vm->resume();
283   });
284
285
286   // Now the VM is running on the new host (the migration is completed) (even if the SRC crash)
287   vm->pimpl_vm_->isMigrating = false;
288   XBT_DEBUG("VM(%s) moved from PM(%s) to PM(%s)", ms->vm->getCname(), ms->src_pm->getCname(), ms->dst_pm->getCname());
289
290   if (TRACE_msg_vm_is_enabled()) {
291     static long long int counter = 0;
292     std::string key              = std::to_string(counter);
293     counter++;
294
295     // start link
296     container_t msg = simgrid::instr::Container::byName(vm->getName());
297     simgrid::instr::Container::getRoot()->getLink("MSG_VM_LINK")->startEvent(msg, "M", key);
298
299     // destroy existing container of this vm
300     container_t existing_container = simgrid::instr::Container::byName(vm->getName());
301     existing_container->removeFromParent();
302     delete existing_container;
303
304     // create new container on the new_host location
305     new simgrid::instr::Container(vm->getCname(), "MSG_VM", simgrid::instr::Container::byName(ms->dst_pm->getName()));
306
307     // end link
308     msg  = simgrid::instr::Container::byName(vm->getName());
309     simgrid::instr::Container::getRoot()->getLink("MSG_VM_LINK")->endEvent(msg, "M", key);
310   }
311
312   // Inform the SRC that the migration has been correctly performed
313   std::string task_name = get_mig_task_name(ms->vm, ms->src_pm, ms->dst_pm, 4);
314   msg_task_t task       = MSG_task_create(task_name.c_str(), 0, 0, nullptr);
315   msg_error_t ret       = MSG_task_send(task, ms->mbox_ctl.c_str());
316   if(ret == MSG_HOST_FAILURE){
317     // The DST has crashed, this is a problem has the VM since we are not sure whether SRC is considering that the VM
318     // has been correctly migrated on the DST node
319     // TODO What does it mean ? What should we do ?
320     MSG_task_destroy(task);
321   } else if(ret == MSG_TRANSFER_FAILURE){
322     // The SRC has crashed, this is not a problem has the VM has been correctly migrated on the DST node
323     MSG_task_destroy(task);
324   }
325
326   XBT_DEBUG("mig: rx_done");
327   return 0;
328 }
329
330 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,
331                                      const std::string& mbox, int stage, int stage2_round, double mig_speed,
332                                      double timeout)
333 {
334   sg_size_t sent = 0;
335   std::string task_name = get_mig_task_name(vm, src_pm, dst_pm, stage);
336   msg_task_t task       = MSG_task_create(task_name.c_str(), 0, static_cast<double>(size), nullptr);
337
338   double clock_sta = MSG_get_clock();
339
340   msg_error_t ret;
341   if (mig_speed > 0)
342     ret = MSG_task_send_with_timeout_bounded(task, mbox.c_str(), timeout, mig_speed);
343   else
344     ret = MSG_task_send(task, mbox.c_str());
345
346   if (ret == MSG_OK) {
347     sent = size;
348   } else if (ret == MSG_TIMEOUT) {
349     sg_size_t remaining = static_cast<sg_size_t>(MSG_task_get_remaining_communication(task));
350     sent = size - remaining;
351     XBT_VERB("timeout (%lf s) in sending_migration_data, remaining %llu bytes of %llu", timeout, remaining, size);
352   }
353
354   /* FIXME: why try-and-catch is used here? */
355   if(ret == MSG_HOST_FAILURE){
356     XBT_DEBUG("SRC host failed during migration of %s (stage %d)", vm->getCname(), stage);
357     MSG_task_destroy(task);
358     THROWF(host_error, 0, "SRC host failed during migration of %s (stage %d)", vm->getCname(), stage);
359   }else if(ret == MSG_TRANSFER_FAILURE){
360     XBT_DEBUG("DST host failed during migration of %s (stage %d)", vm->getCname(), stage);
361     MSG_task_destroy(task);
362     THROWF(host_error, 0, "DST host failed during migration of %s (stage %d)", vm->getCname(), stage);
363   }
364
365   double clock_end = MSG_get_clock();
366   double duration = clock_end - clock_sta;
367   double actual_speed = size / duration;
368
369   if (stage == 2)
370     XBT_DEBUG("mig-stage%d.%d: sent %llu duration %f actual_speed %f (target %f)", stage, stage2_round, size, duration,
371               actual_speed, mig_speed);
372   else
373     XBT_DEBUG("mig-stage%d: sent %llu duration %f actual_speed %f (target %f)", stage, size, duration, actual_speed,
374               mig_speed);
375
376   return sent;
377 }
378
379 static sg_size_t get_updated_size(double computed, double dp_rate, double dp_cap)
380 {
381   double updated_size = computed * dp_rate;
382   XBT_DEBUG("updated_size %f dp_rate %f", updated_size, dp_rate);
383   if (updated_size > dp_cap) {
384     updated_size = dp_cap;
385   }
386
387   return static_cast<sg_size_t>(updated_size);
388 }
389
390 static int migration_tx_fun(int argc, char *argv[])
391 {
392   XBT_DEBUG("mig: tx_start");
393
394   // Note that the ms structure has been allocated in do_migration and hence should be freed in the same function ;)
395   migration_session* ms = static_cast<migration_session*>(MSG_process_get_data(MSG_process_self()));
396
397   double host_speed = ms->vm->getPm()->getSpeed();
398   s_vm_params_t params;
399   ms->vm->getParameters(&params);
400   const sg_size_t ramsize   = ms->vm->getRamsize();
401   const double dp_rate      = host_speed ? (params.mig_speed * params.dp_intensity) / host_speed : 1;
402   const double dp_cap       = params.dp_cap;
403   const double mig_speed    = params.mig_speed;
404   double max_downtime       = params.max_downtime;
405
406   double mig_timeout = 10000000.0;
407   bool skip_stage2   = false;
408
409   size_t remaining_size = ramsize;
410   size_t threshold      = 0.0;
411
412   /* check parameters */
413   if (ramsize == 0)
414     XBT_WARN("migrate a VM, but ramsize is zero");
415
416   if (max_downtime <= 0) {
417     XBT_WARN("use the default max_downtime value 30ms");
418     max_downtime = 0.03;
419   }
420
421   /* Stage1: send all memory pages to the destination. */
422   XBT_DEBUG("mig-stage1: remaining_size %zu", remaining_size);
423   sg_vm_start_dirty_page_tracking(ms->vm);
424
425   double computed_during_stage1 = 0;
426   double clock_prev_send        = MSG_get_clock();
427
428   try {
429     /* At stage 1, we do not need timeout. We have to send all the memory pages even though the duration of this
430      * transfer exceeds the timeout value. */
431     XBT_VERB("Stage 1: Gonna send %llu bytes", ramsize);
432     sg_size_t sent = send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, ramsize, ms->mbox, 1, 0, mig_speed, -1);
433     remaining_size -= sent;
434     computed_during_stage1 = sg_vm_lookup_computed_flops(ms->vm);
435
436     if (sent < ramsize) {
437       XBT_VERB("mig-stage1: timeout, force moving to stage 3");
438       skip_stage2 = true;
439     } else if (sent > ramsize)
440       XBT_CRITICAL("bug");
441
442   } catch (xbt_ex& e) {
443     // hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
444     // Stop the dirty page tracking an return (there is no memory space to release)
445     sg_vm_stop_dirty_page_tracking(ms->vm);
446     return 0;
447   }
448
449   double clock_post_send = MSG_get_clock();
450   mig_timeout -= (clock_post_send - clock_prev_send);
451   if (mig_timeout < 0) {
452     XBT_VERB("The duration of stage 1 exceeds the timeout value, skip stage 2");
453     skip_stage2 = true;
454   }
455
456   /* estimate bandwidth */
457   double bandwidth = ramsize / (clock_post_send - clock_prev_send);
458   threshold        = bandwidth * max_downtime;
459   XBT_DEBUG("actual bandwidth %f (MB/s), threshold %zu", bandwidth / 1024 / 1024, threshold);
460
461   /* Stage2: send update pages iteratively until the size of remaining states becomes smaller than threshold value. */
462   if (not skip_stage2) {
463
464     int stage2_round = 0;
465     for (;;) {
466
467       sg_size_t updated_size = 0;
468       if (stage2_round == 0) {
469         /* just after stage1, nothing has been updated. But, we have to send the data updated during stage1 */
470         updated_size = get_updated_size(computed_during_stage1, dp_rate, dp_cap);
471       } else {
472         double computed = sg_vm_lookup_computed_flops(ms->vm);
473         updated_size    = get_updated_size(computed, dp_rate, dp_cap);
474       }
475
476       XBT_DEBUG("mig-stage 2:%d updated_size %llu computed_during_stage1 %f dp_rate %f dp_cap %f", stage2_round,
477                 updated_size, computed_during_stage1, dp_rate, dp_cap);
478
479       /* Check whether the remaining size is below the threshold value. If so, move to stage 3. */
480       remaining_size += updated_size;
481       XBT_DEBUG("mig-stage2.%d: remaining_size %zu (%s threshold %zu)", stage2_round, remaining_size,
482                 (remaining_size < threshold) ? "<" : ">", threshold);
483       if (remaining_size < threshold)
484         break;
485
486       sg_size_t sent         = 0;
487       double clock_prev_send = MSG_get_clock();
488       try {
489         XBT_DEBUG("Stage 2, gonna send %llu", updated_size);
490         sent = send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, updated_size, ms->mbox, 2, stage2_round, mig_speed,
491                                    mig_timeout);
492       } catch (xbt_ex& e) {
493         // hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data
494         // code)
495         // Stop the dirty page tracking an return (there is no memory space to release)
496         sg_vm_stop_dirty_page_tracking(ms->vm);
497         return 0;
498       }
499       double clock_post_send = MSG_get_clock();
500
501       if (sent == updated_size) {
502         /* timeout did not happen */
503         double bandwidth = updated_size / (clock_post_send - clock_prev_send);
504         threshold        = bandwidth * max_downtime;
505         XBT_DEBUG("actual bandwidth %f, threshold %zu", bandwidth / 1024 / 1024, threshold);
506         remaining_size -= sent;
507         stage2_round += 1;
508         mig_timeout -= (clock_post_send - clock_prev_send);
509         xbt_assert(mig_timeout > 0);
510
511       } else if (sent < updated_size) {
512         /* When timeout happens, we move to stage 3. The size of memory pages
513          * updated before timeout must be added to the remaining size. */
514         XBT_VERB("mig-stage2.%d: timeout, force moving to stage 3. sent %llu / %llu, eta %lf", stage2_round, sent,
515                  updated_size, (clock_post_send - clock_prev_send));
516         remaining_size -= sent;
517
518         double computed = sg_vm_lookup_computed_flops(ms->vm);
519         updated_size    = get_updated_size(computed, dp_rate, dp_cap);
520         remaining_size += updated_size;
521         break;
522       } else
523         XBT_CRITICAL("bug");
524     }
525   }
526
527   /* Stage3: stop the VM and copy the rest of states. */
528   XBT_DEBUG("mig-stage3: remaining_size %zu", remaining_size);
529   simgrid::vm::VirtualMachineImpl* pimpl = ms->vm->pimpl_vm_;
530   pimpl->setState(SURF_VM_STATE_RUNNING); // FIXME: this bypass of the checks in suspend() is not nice
531   pimpl->isMigrating = false;             // FIXME: this bypass of the checks in suspend() is not nice
532   pimpl->suspend(SIMIX_process_self());
533   sg_vm_stop_dirty_page_tracking(ms->vm);
534
535   try {
536     XBT_DEBUG("Stage 3: Gonna send %zu bytes", remaining_size);
537     send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, remaining_size, ms->mbox, 3, 0, mig_speed, -1);
538   }
539   catch(xbt_ex& e) {
540     //hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
541     // Stop the dirty page tracking an return (there is no memory space to release)
542     ms->vm->resume();
543     return 0;
544   }
545
546   // At that point the Migration is considered valid for the SRC node but remind that the DST side should relocate
547   // effectively the VM on the DST node.
548   XBT_DEBUG("mig: tx_done");
549
550   return 0;
551 }
552
553 /** @brief Migrate the VM to the given host.
554  *  @ingroup msg_VMs
555  */
556 void MSG_vm_migrate(msg_vm_t vm, msg_host_t dst_pm)
557 {
558   /* some thoughts:
559    * - One approach is ...
560    *   We first create a new VM (i.e., destination VM) on the destination   physical host. The destination VM will
561    *   receive the state of the source
562    *   VM over network. We will finally destroy the source VM.
563    *   - This behavior is similar to the way of migration in the real world.
564    *     Even before a migration is completed, we will see a destination VM, consuming resources.
565    *   - We have to relocate all processes. The existing process migration code will work for this?
566    *   - The name of the VM is a somewhat unique ID in the code. It is tricky for the destination VM?
567    *
568    * - Another one is ...
569    *   We update the information of the given VM to place it to the destination physical host.
570    *
571    * The second one would be easier.
572    */
573
574   msg_host_t src_pm = vm->getPm();
575
576   if (src_pm->isOff())
577     THROWF(vm_error, 0, "Cannot migrate VM '%s' from host '%s', which is offline.", vm->getCname(), src_pm->getCname());
578   if (dst_pm->isOff())
579     THROWF(vm_error, 0, "Cannot migrate VM '%s' to host '%s', which is offline.", vm->getCname(), dst_pm->getCname());
580   if (not MSG_vm_is_running(vm))
581     THROWF(vm_error, 0, "Cannot migrate VM '%s' that is not running yet.", vm->getCname());
582   if (vm->isMigrating())
583     THROWF(vm_error, 0, "Cannot migrate VM '%s' that is already migrating.", vm->getCname());
584
585   vm->pimpl_vm_->isMigrating = true;
586
587   migration_session ms;
588   ms.vm     = vm;
589   ms.src_pm = src_pm;
590   ms.dst_pm = dst_pm;
591
592   /* We have two mailboxes. mbox is used to transfer migration data between source and destination PMs. mbox_ctl is used
593    * to detect the completion of a migration. The names of these mailboxes must not conflict with others. */
594   ms.mbox_ctl =
595       simgrid::xbt::string_printf("__mbox_mig_ctl:%s(%s-%s)", vm->getCname(), src_pm->getCname(), dst_pm->getCname());
596   ms.mbox = simgrid::xbt::string_printf("__mbox_mig_src_dst:%s(%s-%s)", vm->getCname(), src_pm->getCname(),
597                                         dst_pm->getCname());
598
599   std::string pr_rx_name = get_mig_process_rx_name(vm, src_pm, dst_pm);
600   std::string pr_tx_name = get_mig_process_tx_name(vm, src_pm, dst_pm);
601
602   MSG_process_create(pr_rx_name.c_str(), migration_rx_fun, &ms, dst_pm);
603
604   MSG_process_create(pr_tx_name.c_str(), migration_tx_fun, &ms, src_pm);
605
606   /* wait until the migration have finished or on error has occurred */
607   XBT_DEBUG("wait for reception of the final ACK (i.e. migration has been correctly performed");
608   msg_task_t task = nullptr;
609   msg_error_t ret = MSG_task_receive(&task, ms.mbox_ctl.c_str());
610
611   vm->pimpl_vm_->isMigrating = false;
612
613   if (ret == MSG_HOST_FAILURE) {
614     // Note that since the communication failed, the owner did not change and the task should be destroyed on the
615     // other side. Hence, just throw the execption
616     XBT_ERROR("SRC crashes, throw an exception (m-control)");
617     // MSG_process_kill(tx_process); // Adrien, I made a merge on Nov 28th 2014, I'm not sure whether this line is
618     // required or not
619     THROWF(host_error, 0, "Source host '%s' failed during the migration of VM '%s'.", src_pm->getCname(),
620            vm->getCname());
621   } else if ((ret == MSG_TRANSFER_FAILURE) || (ret == MSG_TIMEOUT)) {
622     // MSG_TIMEOUT here means that MSG_host_is_avail() returned false.
623     XBT_ERROR("DST crashes, throw an exception (m-control)");
624     THROWF(host_error, 0, "Destination host '%s' failed during the migration of VM '%s'.", dst_pm->getCname(),
625            vm->getCname());
626   }
627
628   xbt_assert(get_mig_task_name(vm, src_pm, dst_pm, 4) == task->name);
629   MSG_task_destroy(task);
630 }
631
632 /** @brief Immediately suspend the execution of all processes within the given VM.
633  *  @ingroup msg_VMs
634  *
635  * This function stops the execution of the VM. All the processes on this VM
636  * will pause. The state of the VM is preserved. We can later resume it again.
637  *
638  * No suspension cost occurs.
639  */
640 void MSG_vm_suspend(msg_vm_t vm)
641 {
642   vm->suspend();
643   if (TRACE_msg_vm_is_enabled()) {
644     simgrid::instr::StateType* state = simgrid::instr::Container::byName(vm->getName())->getState("MSG_VM_STATE");
645     state->addEntityValue("suspend", "1 0 0"); // suspend is red
646     state->pushEvent("suspend");
647   }
648 }
649
650 /** @brief Resume the execution of the VM. All processes on the VM run again.
651  *  @ingroup msg_VMs
652  *
653  * No resume cost occurs.
654  */
655 void MSG_vm_resume(msg_vm_t vm)
656 {
657   vm->resume();
658   if (TRACE_msg_vm_is_enabled())
659     simgrid::instr::Container::byName(vm->getName())->getState("MSG_VM_STATE")->popEvent();
660 }
661
662 /** @brief Get the physical host of a given VM.
663  *  @ingroup msg_VMs
664  */
665 msg_host_t MSG_vm_get_pm(msg_vm_t vm)
666 {
667   return vm->getPm();
668 }
669
670 void MSG_vm_set_bound(msg_vm_t vm, double bound)
671 {
672   vm->setBound(bound);
673 }
674 }