Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
rework State related events
[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   memset(&params, 0, sizeof(params));
118   params.ramsize = static_cast<sg_size_t>(ramsize) * 1024 * 1024;
119   params.devsize = 0;
120   params.skip_stage2 = 0;
121   params.max_downtime = 0.03;
122   params.mig_speed = static_cast<double>(mig_netspeed) * 1024 * 1024; // mig_speed
123   params.dp_intensity = static_cast<double>(dp_intensity) / 100;
124   params.dp_cap       = params.ramsize * 0.9; // assume working set memory is 90% of ramsize
125
126   XBT_DEBUG("migspeed : %f intensity mem : %d", params.mig_speed, dp_intensity);
127   vm->setParameters(&params);
128
129   return vm;
130 }
131
132 /** @brief Create a new VM object with the default parameters
133  *  @ingroup msg_VMs*
134  *
135  * A VM is treated as a host. The name of the VM must be unique among all hosts.
136  */
137 msg_vm_t MSG_vm_create_core(msg_host_t pm, const char* name)
138 {
139   xbt_assert(sg_host_by_name(name) == nullptr,
140              "Cannot create a VM named %s: this name is already used by an host or a VM", name);
141
142   return new simgrid::s4u::VirtualMachine(name, pm, 1);
143 }
144 /** @brief Create a new VM object with the default parameters, but with a specified amount of cores
145  *  @ingroup msg_VMs*
146  *
147  * A VM is treated as a host. The name of the VM must be unique among all hosts.
148  */
149 msg_vm_t MSG_vm_create_multicore(msg_host_t pm, const char* name, int coreAmount)
150 {
151   xbt_assert(sg_host_by_name(name) == nullptr,
152              "Cannot create a VM named %s: this name is already used by an host or a VM", name);
153
154   return new simgrid::s4u::VirtualMachine(name, pm, coreAmount);
155 }
156
157 /** @brief Destroy a VM. Destroy the VM object from the simulation.
158  *  @ingroup msg_VMs
159  */
160 void MSG_vm_destroy(msg_vm_t vm)
161 {
162   if (vm->isMigrating())
163     THROWF(vm_error, 0, "Cannot destroy VM '%s', which is migrating.", vm->getCname());
164
165   /* First, terminate all processes on the VM if necessary */
166   if (MSG_vm_is_running(vm))
167     MSG_vm_shutdown(vm);
168
169   /* Then, destroy the VM object */
170   simgrid::simix::kernelImmediate([vm]() { vm->destroy(); });
171
172   if (TRACE_msg_vm_is_enabled()) {
173     container_t container = simgrid::instr::Container::byName(vm->getName());
174     container->removeFromParent();
175     delete container;
176   }
177 }
178
179 /** @brief Start a vm (i.e., boot the guest operating system)
180  *  @ingroup msg_VMs
181  *
182  *  If the VM cannot be started (because of memory over-provisioning), an exception is generated.
183  */
184 void MSG_vm_start(msg_vm_t vm)
185 {
186   vm->start();
187   if (TRACE_msg_vm_is_enabled()) {
188     container_t vm_container    = simgrid::instr::Container::byName(vm->getName());
189     simgrid::instr::StateType* state =
190         static_cast<simgrid::instr::StateType*>(vm_container->type_->byName("MSG_VM_STATE"));
191     state->addEntityValue("start", "0 0 1"); // start is blue
192     state->pushEvent(MSG_get_clock(), vm_container, "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::Type* type = simgrid::instr::Type::getRootType()->byName("MSG_VM_LINK");
299     new simgrid::instr::StartLinkEvent(MSG_get_clock(), simgrid::instr::Container::getRootContainer(), type, msg, "M",
300                                        key);
301
302     // destroy existing container of this vm
303     container_t existing_container = simgrid::instr::Container::byName(vm->getName());
304     existing_container->removeFromParent();
305     delete existing_container;
306
307     // create new container on the new_host location
308     new simgrid::instr::Container(vm->getCname(), "MSG_VM", simgrid::instr::Container::byName(ms->dst_pm->getName()));
309
310     // end link
311     msg  = simgrid::instr::Container::byName(vm->getName());
312     type = simgrid::instr::Type::getRootType()->byName("MSG_VM_LINK");
313     new simgrid::instr::EndLinkEvent(MSG_get_clock(), simgrid::instr::Container::getRootContainer(), type, msg, "M",
314                                      key);
315   }
316
317   // Inform the SRC that the migration has been correctly performed
318   std::string task_name = get_mig_task_name(ms->vm, ms->src_pm, ms->dst_pm, 4);
319   msg_task_t task       = MSG_task_create(task_name.c_str(), 0, 0, nullptr);
320   msg_error_t ret = MSG_task_send(task, ms->mbox_ctl);
321   if(ret == MSG_HOST_FAILURE){
322     // The DST has crashed, this is a problem has the VM since we are not sure whether SRC is considering that the VM
323     // has been correctly migrated on the DST node
324     // TODO What does it mean ? What should we do ?
325     MSG_task_destroy(task);
326   } else if(ret == MSG_TRANSFER_FAILURE){
327     // The SRC has crashed, this is not a problem has the VM has been correctly migrated on the DST node
328     MSG_task_destroy(task);
329   }
330
331   XBT_DEBUG("mig: rx_done");
332   return 0;
333 }
334
335 static void start_dirty_page_tracking(msg_vm_t vm)
336 {
337   vm->pimpl_vm_->dp_enabled = 1;
338   if (vm->pimpl_vm_->dp_objs.empty())
339     return;
340
341   for (auto const& elm : vm->pimpl_vm_->dp_objs) {
342     dirty_page_t dp    = elm.second;
343     double remaining = MSG_task_get_flops_amount(dp->task);
344     dp->prev_clock = MSG_get_clock();
345     dp->prev_remaining = remaining;
346     XBT_DEBUG("%s@%s remaining %f", elm.first.c_str(), vm->getCname(), remaining);
347   }
348 }
349
350 static void stop_dirty_page_tracking(msg_vm_t vm)
351 {
352   vm->pimpl_vm_->dp_enabled = 0;
353 }
354
355 static double get_computed(const char* key, msg_vm_t vm, dirty_page_t dp, double remaining, double clock)
356 {
357   double computed = dp->prev_remaining - remaining;
358   double duration = clock - dp->prev_clock;
359
360   XBT_DEBUG("%s@%s: computed %f ops (remaining %f -> %f) in %f secs (%f -> %f)", key, vm->getCname(), computed,
361             dp->prev_remaining, remaining, duration, dp->prev_clock, clock);
362
363   return computed;
364 }
365
366 static double lookup_computed_flop_counts(msg_vm_t vm, int stage_for_fancy_debug, int stage2_round_for_fancy_debug)
367 {
368   double total = 0;
369
370   for (auto const& elm : vm->pimpl_vm_->dp_objs) {
371     const char* key  = elm.first.c_str();
372     dirty_page_t dp  = elm.second;
373     double remaining = MSG_task_get_flops_amount(dp->task);
374
375     double clock = MSG_get_clock();
376
377     total += get_computed(key, vm, dp, remaining, clock);
378
379     dp->prev_remaining = remaining;
380     dp->prev_clock = clock;
381   }
382
383   total += vm->pimpl_vm_->dp_updated_by_deleted_tasks;
384
385   XBT_DEBUG("mig-stage%d.%d: computed %f flop_counts (including %f by deleted tasks)", stage_for_fancy_debug,
386             stage2_round_for_fancy_debug, total, vm->pimpl_vm_->dp_updated_by_deleted_tasks);
387
388   vm->pimpl_vm_->dp_updated_by_deleted_tasks = 0;
389
390   return total;
391 }
392
393 // TODO Is this code redundant with the information provided by
394 // msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
395 /** @brief take care of the dirty page tracking, in case we're adding a task to a migrating VM */
396 void MSG_host_add_task(msg_host_t host, msg_task_t task)
397 {
398   simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host);
399   if (vm == nullptr)
400     return;
401
402   double remaining = MSG_task_get_flops_amount(task);
403   char *key = bprintf("%s-%p", task->name, task);
404
405   dirty_page_t dp = xbt_new0(s_dirty_page, 1);
406   dp->task = task;
407   if (vm->pimpl_vm_->dp_enabled) {
408     dp->prev_clock = MSG_get_clock();
409     dp->prev_remaining = remaining;
410   }
411   vm->pimpl_vm_->dp_objs.insert({key, dp});
412   XBT_DEBUG("add %s on %s (remaining %f, dp_enabled %d)", key, host->getCname(), remaining, vm->pimpl_vm_->dp_enabled);
413
414   xbt_free(key);
415 }
416
417 void MSG_host_del_task(msg_host_t host, msg_task_t task)
418 {
419   simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host);
420   if (vm == nullptr)
421     return;
422
423   char *key = bprintf("%s-%p", task->name, task);
424   dirty_page_t dp = nullptr;
425   if (vm->pimpl_vm_->dp_objs.find(key) != vm->pimpl_vm_->dp_objs.end())
426     dp = vm->pimpl_vm_->dp_objs.at(key);
427   xbt_assert(dp && dp->task == task);
428
429   /* If we are in the middle of dirty page tracking, we record how much computation has been done until now, and keep
430    * the information for the lookup_() function that will called soon. */
431   if (vm->pimpl_vm_->dp_enabled) {
432     double remaining = MSG_task_get_flops_amount(task);
433     double clock = MSG_get_clock();
434     double updated = get_computed(key, vm, dp, remaining, clock); // was host instead of vm
435
436     vm->pimpl_vm_->dp_updated_by_deleted_tasks += updated;
437   }
438
439   vm->pimpl_vm_->dp_objs.erase(key);
440   xbt_free(dp);
441
442   XBT_DEBUG("del %s on %s", key, host->getCname());
443   xbt_free(key);
444 }
445
446 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,
447                                      int stage, int stage2_round, double mig_speed, double timeout)
448 {
449   sg_size_t sent = 0;
450   std::string task_name = get_mig_task_name(vm, src_pm, dst_pm, stage);
451   msg_task_t task       = MSG_task_create(task_name.c_str(), 0, static_cast<double>(size), nullptr);
452
453   double clock_sta = MSG_get_clock();
454
455   msg_error_t ret;
456   if (mig_speed > 0)
457     ret = MSG_task_send_with_timeout_bounded(task, mbox, timeout, mig_speed);
458   else
459     ret = MSG_task_send(task, mbox);
460
461   if (ret == MSG_OK) {
462     sent = size;
463   } else if (ret == MSG_TIMEOUT) {
464     sg_size_t remaining = static_cast<sg_size_t>(MSG_task_get_remaining_communication(task));
465     sent = size - remaining;
466     XBT_VERB("timeout (%lf s) in sending_migration_data, remaining %llu bytes of %llu", timeout, remaining, size);
467   }
468
469   /* FIXME: why try-and-catch is used here? */
470   if(ret == MSG_HOST_FAILURE){
471     XBT_DEBUG("SRC host failed during migration of %s (stage %d)", vm->getCname(), stage);
472     MSG_task_destroy(task);
473     THROWF(host_error, 0, "SRC host failed during migration of %s (stage %d)", vm->getCname(), stage);
474   }else if(ret == MSG_TRANSFER_FAILURE){
475     XBT_DEBUG("DST host failed during migration of %s (stage %d)", vm->getCname(), stage);
476     MSG_task_destroy(task);
477     THROWF(host_error, 0, "DST host failed during migration of %s (stage %d)", vm->getCname(), stage);
478   }
479
480   double clock_end = MSG_get_clock();
481   double duration = clock_end - clock_sta;
482   double actual_speed = size / duration;
483
484   if (stage == 2)
485     XBT_DEBUG("mig-stage%d.%d: sent %llu duration %f actual_speed %f (target %f)", stage, stage2_round, size, duration,
486               actual_speed, mig_speed);
487   else
488     XBT_DEBUG("mig-stage%d: sent %llu duration %f actual_speed %f (target %f)", stage, size, duration, actual_speed,
489               mig_speed);
490
491   return sent;
492 }
493
494 static sg_size_t get_updated_size(double computed, double dp_rate, double dp_cap)
495 {
496   double updated_size = computed * dp_rate;
497   XBT_DEBUG("updated_size %f dp_rate %f", updated_size, dp_rate);
498   if (updated_size > dp_cap) {
499     updated_size = dp_cap;
500   }
501
502   return static_cast<sg_size_t>(updated_size);
503 }
504
505 static int migration_tx_fun(int argc, char *argv[])
506 {
507   XBT_DEBUG("mig: tx_start");
508
509   // Note that the ms structure has been allocated in do_migration and hence should be freed in the same function ;)
510   migration_session* ms = static_cast<migration_session*>(MSG_process_get_data(MSG_process_self()));
511
512   double host_speed = ms->vm->pimpl_vm_->getPm()->getSpeed();
513   s_vm_params_t params;
514   ms->vm->getParameters(&params);
515   const sg_size_t ramsize   = params.ramsize;
516   const sg_size_t devsize   = params.devsize;
517   const int skip_stage1     = params.skip_stage1;
518   int skip_stage2           = params.skip_stage2;
519   const double dp_rate      = host_speed ? (params.mig_speed * params.dp_intensity) / host_speed : 1;
520   const double dp_cap       = params.dp_cap;
521   const double mig_speed    = params.mig_speed;
522   double max_downtime       = params.max_downtime;
523
524   double mig_timeout = 10000000.0;
525
526   double remaining_size = static_cast<double>(ramsize + devsize);
527   double threshold = 0.0;
528
529   /* check parameters */
530   if (ramsize == 0)
531     XBT_WARN("migrate a VM, but ramsize is zero");
532
533   if (max_downtime <= 0) {
534     XBT_WARN("use the default max_downtime value 30ms");
535     max_downtime = 0.03;
536   }
537
538   /* Stage1: send all memory pages to the destination. */
539   XBT_DEBUG("mig-stage1: remaining_size %f", remaining_size);
540   start_dirty_page_tracking(ms->vm);
541
542   double computed_during_stage1 = 0;
543   if (not skip_stage1) {
544     double clock_prev_send = MSG_get_clock();
545
546     try {
547       /* At stage 1, we do not need timeout. We have to send all the memory pages even though the duration of this
548        * transfer exceeds the timeout value. */
549       XBT_VERB("Stage 1: Gonna send %llu bytes", ramsize);
550       sg_size_t sent = send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, ramsize, ms->mbox, 1, 0, mig_speed, -1);
551       remaining_size -= sent;
552       computed_during_stage1 = lookup_computed_flop_counts(ms->vm, 1, 0);
553
554       if (sent < ramsize) {
555         XBT_VERB("mig-stage1: timeout, force moving to stage 3");
556         skip_stage2 = 1;
557       } else if (sent > ramsize)
558         XBT_CRITICAL("bug");
559
560     }
561     catch (xbt_ex& e) {
562       //hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
563       // Stop the dirty page tracking an return (there is no memory space to release)
564       stop_dirty_page_tracking(ms->vm);
565       return 0;
566     }
567
568     double clock_post_send = MSG_get_clock();
569     mig_timeout -= (clock_post_send - clock_prev_send);
570     if (mig_timeout < 0) {
571       XBT_VERB("The duration of stage 1 exceeds the timeout value, skip stage 2");
572       skip_stage2 = 1;
573     }
574
575     /* estimate bandwidth */
576     double bandwidth = ramsize / (clock_post_send - clock_prev_send);
577     threshold        = bandwidth * max_downtime;
578     XBT_DEBUG("actual bandwidth %f (MB/s), threshold %f", bandwidth / 1024 / 1024, threshold);
579   }
580
581
582   /* Stage2: send update pages iteratively until the size of remaining states becomes smaller than threshold value. */
583   if (not skip_stage2) {
584
585     int stage2_round = 0;
586     for (;;) {
587
588       sg_size_t updated_size = 0;
589       if (stage2_round == 0) {
590         /* just after stage1, nothing has been updated. But, we have to send the data updated during stage1 */
591         updated_size = get_updated_size(computed_during_stage1, dp_rate, dp_cap);
592       } else {
593         double computed = lookup_computed_flop_counts(ms->vm, 2, stage2_round);
594         updated_size    = get_updated_size(computed, dp_rate, dp_cap);
595       }
596
597       XBT_DEBUG("mig-stage 2:%d updated_size %llu computed_during_stage1 %f dp_rate %f dp_cap %f", stage2_round,
598                 updated_size, computed_during_stage1, dp_rate, dp_cap);
599
600       /* Check whether the remaining size is below the threshold value. If so, move to stage 3. */
601       remaining_size += updated_size;
602       XBT_DEBUG("mig-stage2.%d: remaining_size %f (%s threshold %f)", stage2_round, remaining_size,
603                 (remaining_size < threshold) ? "<" : ">", threshold);
604       if (remaining_size < threshold)
605         break;
606
607       sg_size_t sent         = 0;
608       double clock_prev_send = MSG_get_clock();
609       try {
610         XBT_DEBUG("Stage 2, gonna send %llu", updated_size);
611         sent = send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, updated_size, ms->mbox, 2, stage2_round, mig_speed,
612                                    mig_timeout);
613       } catch (xbt_ex& e) {
614         // hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data
615         // code)
616         // Stop the dirty page tracking an return (there is no memory space to release)
617         stop_dirty_page_tracking(ms->vm);
618         return 0;
619       }
620       double clock_post_send = MSG_get_clock();
621
622       if (sent == updated_size) {
623         /* timeout did not happen */
624         double bandwidth = updated_size / (clock_post_send - clock_prev_send);
625         threshold        = bandwidth * max_downtime;
626         XBT_DEBUG("actual bandwidth %f, threshold %f", bandwidth / 1024 / 1024, threshold);
627         remaining_size -= sent;
628         stage2_round += 1;
629         mig_timeout -= (clock_post_send - clock_prev_send);
630         xbt_assert(mig_timeout > 0);
631
632       } else if (sent < updated_size) {
633         /* When timeout happens, we move to stage 3. The size of memory pages
634          * updated before timeout must be added to the remaining size. */
635         XBT_VERB("mig-stage2.%d: timeout, force moving to stage 3. sent %llu / %llu, eta %lf", stage2_round, sent,
636                  updated_size, (clock_post_send - clock_prev_send));
637         remaining_size -= sent;
638
639         double computed = lookup_computed_flop_counts(ms->vm, 2, stage2_round);
640         updated_size    = get_updated_size(computed, dp_rate, dp_cap);
641         remaining_size += updated_size;
642         break;
643       } else
644         XBT_CRITICAL("bug");
645     }
646   }
647
648   /* Stage3: stop the VM and copy the rest of states. */
649   XBT_DEBUG("mig-stage3: remaining_size %f", remaining_size);
650   simgrid::vm::VirtualMachineImpl* pimpl = ms->vm->pimpl_vm_;
651   pimpl->setState(SURF_VM_STATE_RUNNING); // FIXME: this bypass of the checks in suspend() is not nice
652   pimpl->isMigrating = false;             // FIXME: this bypass of the checks in suspend() is not nice
653   pimpl->suspend(SIMIX_process_self());
654   stop_dirty_page_tracking(ms->vm);
655
656   try {
657     XBT_DEBUG("Stage 3: Gonna send %f bytes", remaining_size);
658     send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, static_cast<sg_size_t>(remaining_size), ms->mbox, 3, 0,
659                         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->pimpl_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->pimpl_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 = xbt_new(migration_session, 1);
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 = bprintf("__mbox_mig_ctl:%s(%s-%s)", vm->getCname(), src_pm->getCname(), dst_pm->getCname());
717   ms->mbox     = bprintf("__mbox_mig_src_dst:%s(%s-%s)", vm->getCname(), src_pm->getCname(), dst_pm->getCname());
718
719   std::string pr_rx_name = get_mig_process_rx_name(vm, src_pm, dst_pm);
720   std::string pr_tx_name = get_mig_process_tx_name(vm, src_pm, dst_pm);
721
722   MSG_process_create(pr_rx_name.c_str(), migration_rx_fun, ms, dst_pm);
723
724   MSG_process_create(pr_tx_name.c_str(), migration_tx_fun, ms, src_pm);
725
726   /* wait until the migration have finished or on error has occurred */
727   XBT_DEBUG("wait for reception of the final ACK (i.e. migration has been correctly performed");
728   msg_task_t task = nullptr;
729   msg_error_t ret = MSG_task_receive(&task, ms->mbox_ctl);
730
731   vm->pimpl_vm_->isMigrating = false;
732
733   xbt_free(ms->mbox_ctl);
734   xbt_free(ms->mbox);
735   xbt_free(ms);
736
737   if (ret == MSG_HOST_FAILURE) {
738     // Note that since the communication failed, the owner did not change and the task should be destroyed on the
739     // other side. Hence, just throw the execption
740     XBT_ERROR("SRC crashes, throw an exception (m-control)");
741     // MSG_process_kill(tx_process); // Adrien, I made a merge on Nov 28th 2014, I'm not sure whether this line is
742     // required or not
743     THROWF(host_error, 0, "Source host '%s' failed during the migration of VM '%s'.", src_pm->getCname(),
744            vm->getCname());
745   } else if ((ret == MSG_TRANSFER_FAILURE) || (ret == MSG_TIMEOUT)) {
746     // MSG_TIMEOUT here means that MSG_host_is_avail() returned false.
747     XBT_ERROR("DST crashes, throw an exception (m-control)");
748     THROWF(host_error, 0, "Destination host '%s' failed during the migration of VM '%s'.", dst_pm->getCname(),
749            vm->getCname());
750   }
751
752   xbt_assert(get_mig_task_name(vm, src_pm, dst_pm, 4) == task->name);
753   MSG_task_destroy(task);
754 }
755
756 /** @brief Immediately suspend the execution of all processes within the given VM.
757  *  @ingroup msg_VMs
758  *
759  * This function stops the execution of the VM. All the processes on this VM
760  * will pause. The state of the VM is preserved. We can later resume it again.
761  *
762  * No suspension cost occurs.
763  */
764 void MSG_vm_suspend(msg_vm_t vm)
765 {
766   smx_actor_t issuer = SIMIX_process_self();
767   simgrid::simix::kernelImmediate([vm, issuer]() { vm->pimpl_vm_->suspend(issuer); });
768
769   XBT_DEBUG("vm_suspend done");
770
771   if (TRACE_msg_vm_is_enabled()) {
772     container_t vm_container    = simgrid::instr::Container::byName(vm->getName());
773     simgrid::instr::StateType* state =
774         static_cast<simgrid::instr::StateType*>(vm_container->type_->byName("MSG_VM_STATE"));
775     state->addEntityValue("suspend", "1 0 0"); // suspend is red
776     state->pushEvent(MSG_get_clock(), vm_container, "suspend");
777   }
778 }
779
780 /** @brief Resume the execution of the VM. All processes on the VM run again.
781  *  @ingroup msg_VMs
782  *
783  * No resume cost occurs.
784  */
785 void MSG_vm_resume(msg_vm_t vm)
786 {
787   vm->pimpl_vm_->resume();
788
789   if (TRACE_msg_vm_is_enabled()) {
790     container_t vm_container   = simgrid::instr::Container::byName(vm->getName());
791     simgrid::instr::StateType* state =
792         static_cast<simgrid::instr::StateType*>(vm_container->type_->byName("MSG_VM_STATE"));
793     state->popEvent(MSG_get_clock(), vm_container);
794   }
795 }
796
797 /** @brief Get the physical host of a given VM.
798  *  @ingroup msg_VMs
799  */
800 msg_host_t MSG_vm_get_pm(msg_vm_t vm)
801 {
802   return vm->getPm();
803 }
804
805 /** @brief Set a CPU bound for a given VM.
806  *  @ingroup msg_VMs
807  *
808  * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
809  *
810  * For example,
811  *  On PM0, there are Task1 and VM0.
812  *  On VM0, there is Task2.
813  * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
814  * Then,
815  *  Task1\@PM0 gets 50%.
816  *  Task2\@VM0 gets 25%.
817  * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
818  *
819  * 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
820  * the dummy CPU action. The bound of the dummy CPU action is unlimited.
821  *
822  * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
823  * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
824  * on the VM in share_resource() or we have to trap both the start and end of task execution.
825  *
826  * The current solution is to use MSG_vm_set_bound(), which allows us to directly set the bound of the dummy CPU action.
827  *
828  * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
829  *    computation task (or a VM) never exceeds the capacity of a CPU core.
830  */
831 void MSG_vm_set_bound(msg_vm_t vm, double bound)
832 {
833   simgrid::simix::kernelImmediate([vm, bound]() { vm->pimpl_vm_->setBound(bound); });
834 }
835 }