Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
VM: move things from MSG to the C++ plugin
[simgrid.git] / src / msg / msg_vm.cpp
1 /* Copyright (c) 2012-2015. 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/plugins/vm/VirtualMachineImpl.hpp"
15 #include "src/plugins/vm/VmHostExt.hpp"
16 #include <simgrid/s4u/VirtualMachine.hpp>
17 #include <simgrid/s4u/host.hpp>
18
19 #include "msg_private.h"
20 #include "xbt/sysdep.h"
21 #include "xbt/log.h"
22 #include "simgrid/host.h"
23
24 #include "src/simix/smx_host_private.h" /* don't ask me why the VM functions are in there (FIXME:KILLME) */
25
26 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_vm, msg, "Cloud-oriented parts of the MSG API");
27
28
29 /* **** ******** GENERAL ********* **** */
30
31 /** \ingroup m_vm_management
32  * \brief Set the parameters of a given host
33  *
34  * \param vm a vm
35  * \param params a parameter object
36  */
37 void MSG_vm_set_params(msg_vm_t vm, vm_params_t params)
38 {
39   static_cast<simgrid::s4u::VirtualMachine*>(vm)->setParameters(params);
40 }
41
42 /** \ingroup m_vm_management
43  * \brief Get the parameters of a given host
44  *
45  * \param host a host
46  * \param params a prameter object
47  */
48 void MSG_vm_get_params(msg_vm_t vm, vm_params_t params)
49 {
50   static_cast<simgrid::s4u::VirtualMachine*>(vm)->parameters(params);
51 }
52
53 /* **** Check state of a VM **** */
54 static inline int __MSG_vm_is_state(msg_vm_t vm, e_surf_vm_state_t state)
55 {
56   return static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->getState() == state;
57 }
58
59 /** @brief Returns whether the given VM has just created, not running.
60  *  @ingroup msg_VMs
61  */
62 int MSG_vm_is_created(msg_vm_t vm)
63 {
64   return __MSG_vm_is_state(vm, SURF_VM_STATE_CREATED);
65 }
66
67 /** @brief Returns whether the given VM is currently running
68  *  @ingroup msg_VMs
69  */
70 int MSG_vm_is_running(msg_vm_t vm)
71 {
72   return __MSG_vm_is_state(vm, SURF_VM_STATE_RUNNING);
73 }
74
75 /** @brief Returns whether the given VM is currently migrating
76  *  @ingroup msg_VMs
77  */
78 int MSG_vm_is_migrating(msg_vm_t vm)
79 {
80   return static_cast<simgrid::s4u::VirtualMachine*>(vm)->isMigrating();
81 }
82
83 /** @brief Returns whether the given VM is currently suspended, not running.
84  *  @ingroup msg_VMs
85  */
86 int MSG_vm_is_suspended(msg_vm_t vm)
87 {
88   return __MSG_vm_is_state(vm, SURF_VM_STATE_SUSPENDED);
89 }
90
91 /** @brief Returns whether the given VM is being saved (FIXME: live saving or not?).
92  *  @ingroup msg_VMs
93  */
94 int MSG_vm_is_saving(msg_vm_t vm)
95 {
96   return __MSG_vm_is_state(vm, SURF_VM_STATE_SAVING);
97 }
98
99 /** @brief Returns whether the given VM has been saved, not running.
100  *  @ingroup msg_VMs
101  */
102 int MSG_vm_is_saved(msg_vm_t vm)
103 {
104   return __MSG_vm_is_state(vm, SURF_VM_STATE_SAVED);
105 }
106
107 /** @brief Returns whether the given VM is being restored, not running.
108  *  @ingroup msg_VMs
109  */
110 int MSG_vm_is_restoring(msg_vm_t vm)
111 {
112   return __MSG_vm_is_state(vm, SURF_VM_STATE_RESTORING);
113 }
114
115 /* **** ******** MSG vm actions ********* **** */
116 /** @brief Create a new VM with specified parameters.
117  *  @ingroup msg_VMs*
118  *  @param pm        Physical machine that will host the VM
119  *  @param name      [TODO]
120  *  @param ncpus     [TODO]
121  *  @param ramsize   [TODO]
122  *  @param net_cap   Maximal bandwidth that the VM can consume (in MByte/s)
123  *  @param disk_path (unused) Path to the image that boots
124  *  @param disksize  (unused) will represent the size of the VM (will be used during migrations)
125  *  @param mig_netspeed Amount of Mbyte/s allocated to the migration (cannot be larger than net_cap). Use 0 if unsure.
126  *  @param dp_intensity Dirty page percentage according to migNetSpeed, [0-100]. Use 0 if unsure.
127  */
128 msg_vm_t MSG_vm_create(msg_host_t pm, const char *name, int ncpus, int ramsize, int net_cap, char *disk_path,
129                        int disksize, int mig_netspeed, int dp_intensity)
130 {
131   simgrid::vm::VmHostExt::ensureVmExtInstalled();
132
133   /* For the moment, intensity_rate is the percentage against the migration bandwidth */
134   double host_speed = MSG_host_get_speed(pm);
135   double update_speed = ((double)dp_intensity/100) * mig_netspeed;
136
137   msg_vm_t vm = MSG_vm_create_core(pm, name);
138   s_vm_params_t params;
139   memset(&params, 0, sizeof(params));
140   params.ramsize = (sg_size_t)ramsize * 1024 * 1024;
141   //params.overcommit = 0;
142   params.devsize = 0;
143   params.skip_stage2 = 0;
144   params.max_downtime = 0.03;
145   params.dp_rate = (update_speed * 1024 * 1024) / host_speed;
146   params.dp_cap = params.ramsize * 0.9; // assume working set memory is 90% of ramsize
147   params.mig_speed = (double)mig_netspeed * 1024 * 1024; // mig_speed
148
149   //XBT_INFO("dp rate %f migspeed : %f intensity mem : %d, updatespeed %f, hostspeed %f",params.dp_rate,
150   //         params.mig_speed, dp_intensity, update_speed, host_speed);
151   static_cast<simgrid::s4u::VirtualMachine*>(vm)->setParameters(&params);
152
153   return vm;
154 }
155
156 /** @brief Create a new VM object. The VM is not yet started. The resource of the VM is allocated upon MSG_vm_start().
157  *  @ingroup msg_VMs*
158  *
159  * A VM is treated as a host. The name of the VM must be unique among all hosts.
160  */
161 msg_vm_t MSG_vm_create_core(msg_host_t pm, const char* name)
162 {
163   xbt_assert(sg_host_by_name(name) == nullptr,
164              "Cannot create a VM named %s: this name is already used by an host or a VM", name);
165
166   return new simgrid::s4u::VirtualMachine(name, pm);
167 }
168
169 /** @brief Destroy a VM. Destroy the VM object from the simulation.
170  *  @ingroup msg_VMs
171  */
172 void MSG_vm_destroy(msg_vm_t vm)
173 {
174   if (MSG_vm_is_migrating(vm))
175     THROWF(vm_error, 0, "VM(%s) is migrating", vm->name().c_str());
176
177   /* First, terminate all processes on the VM if necessary */
178   if (MSG_vm_is_running(vm))
179     MSG_vm_shutdown(vm);
180
181   xbt_assert(MSG_vm_is_created(vm), "shutdown the given VM before destroying it");
182
183   /* Then, destroy the VM object */
184   simgrid::simix::kernelImmediate([vm]() {
185     vm->destroy();
186   });
187
188   TRACE_msg_vm_end(vm);
189 }
190
191 /** @brief Start a vm (i.e., boot the guest operating system)
192  *  @ingroup msg_VMs
193  *
194  *  If the VM cannot be started, an exception is generated.
195  */
196 void MSG_vm_start(msg_vm_t vm)
197 {
198   simcall_vm_start(vm);
199
200   TRACE_msg_vm_start(vm);
201 }
202
203 /** @brief Immediately kills all processes within the given VM. Any memory that they allocated will be leaked.
204  *  @ingroup msg_VMs
205  *
206  * FIXME: No extra delay occurs. If you want to simulate this too, you want to use a #MSG_process_sleep() or something.
207  *        I'm not quite sure.
208  */
209 void MSG_vm_shutdown(msg_vm_t vm)
210 {
211   /* msg_vm_t equals to msg_host_t */
212   simcall_vm_shutdown(vm);
213   MSG_process_sleep(0.); // Make sure that the processes in the VM are killed in this scheduling round before processing
214                          // (eg with the VM destroy)
215   // TRACE_msg_vm_(vm);
216 }
217
218 /* We have two mailboxes. mbox is used to transfer migration data between source and destination PMs. mbox_ctl is used
219  * to detect the completion of a migration. The names of these mailboxes must not conflict with others. */
220 static inline char *get_mig_mbox_src_dst(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
221 {
222   const char *vm_name = sg_host_get_name(vm);
223   const char *src_pm_name = sg_host_get_name(src_pm);
224   const char *dst_pm_name = sg_host_get_name(dst_pm);
225
226   return bprintf("__mbox_mig_src_dst:%s(%s-%s)", vm_name, src_pm_name, dst_pm_name);
227 }
228
229 static inline char *get_mig_mbox_ctl(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
230 {
231   const char *vm_name = sg_host_get_name(vm);
232   const char *src_pm_name = sg_host_get_name(src_pm);
233   const char *dst_pm_name = sg_host_get_name(dst_pm);
234
235   return bprintf("__mbox_mig_ctl:%s(%s-%s)", vm_name, src_pm_name, dst_pm_name);
236 }
237
238 static inline char *get_mig_process_tx_name(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
239 {
240   const char *vm_name = sg_host_get_name(vm);
241   const char *src_pm_name = sg_host_get_name(src_pm);
242   const char *dst_pm_name = sg_host_get_name(dst_pm);
243
244   return bprintf("__pr_mig_tx:%s(%s-%s)", vm_name, src_pm_name, dst_pm_name);
245 }
246
247 static inline char *get_mig_process_rx_name(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
248 {
249   const char *vm_name = sg_host_get_name(vm);
250   const char *src_pm_name = sg_host_get_name(src_pm);
251   const char *dst_pm_name = sg_host_get_name(dst_pm);
252
253   return bprintf("__pr_mig_rx:%s(%s-%s)", vm_name, src_pm_name, dst_pm_name);
254 }
255
256 static inline char *get_mig_task_name(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm, int stage)
257 {
258   const char *vm_name = sg_host_get_name(vm);
259   const char *src_pm_name = sg_host_get_name(src_pm);
260   const char *dst_pm_name = sg_host_get_name(dst_pm);
261
262   return bprintf("__task_mig_stage%d:%s(%s-%s)", stage, vm_name, src_pm_name, dst_pm_name);
263 }
264
265 struct migration_session {
266   msg_vm_t vm;
267   msg_host_t src_pm;
268   msg_host_t dst_pm;
269
270   /* The miration_rx process uses mbox_ctl to let the caller of do_migration()
271    * know the completion of the migration. */
272   char *mbox_ctl;
273   /* The migration_rx and migration_tx processes use mbox to transfer migration data. */
274   char *mbox;
275 };
276
277 static int migration_rx_fun(int argc, char *argv[])
278 {
279   XBT_DEBUG("mig: rx_start");
280
281   // The structure has been created in the do_migration function and should only be freed in the same place ;)
282   struct migration_session *ms = (migration_session *) MSG_process_get_data(MSG_process_self());
283
284   s_vm_params_t params;
285   static_cast<simgrid::s4u::VirtualMachine*>(ms->vm)->parameters(&params);
286
287   int need_exit = 0;
288
289   char *finalize_task_name = get_mig_task_name(ms->vm, ms->src_pm, ms->dst_pm, 3);
290
291   int ret = 0;
292   for (;;) {
293     msg_task_t task = nullptr;
294     ret = MSG_task_recv(&task, ms->mbox);
295     {
296       if (ret != MSG_OK) {
297         // An error occurred, clean the code and return
298         // The owner did not change, hence the task should be only destroyed on the other side
299         xbt_free(finalize_task_name);
300         return 0;
301       }
302     }
303
304     if (strcmp(task->name, finalize_task_name) == 0)
305       need_exit = 1;
306
307     MSG_task_destroy(task);
308
309     if (need_exit)
310       break;
311   }
312
313   // Here Stage 1, 2  and 3 have been performed.
314   // Hence complete the migration
315
316   // Copy the reference to the vm (if SRC crashes now, do_migration will free ms)
317   // This is clearly ugly but I (Adrien) need more time to do something cleaner (actually we should copy the whole ms
318   // structure at the beginning and free it at the end of each function)
319   simgrid::s4u::VirtualMachine* vm = static_cast<simgrid::s4u::VirtualMachine*>(ms->vm);
320   msg_host_t src_pm                = ms->src_pm;
321   msg_host_t dst_pm                = ms->dst_pm;
322
323   // Make sure that we cannot get interrupted between the migrate and the resume to not end in an inconsistent state
324   simgrid::simix::kernelImmediate([vm, src_pm, dst_pm]() {
325     /* Update the vm location */
326     /* precopy migration makes the VM temporally paused */
327     xbt_assert(static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->getState() == SURF_VM_STATE_SUSPENDED);
328
329     /* jump to vm_ws_xigrate(). this will update the vm location. */
330     static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->migrate(dst_pm);
331
332     /* Resume the VM */
333     SIMIX_vm_resume(vm);
334   });
335
336   {
337    // Now the VM is running on the new host (the migration is completed) (even if the SRC crash)
338    vm->pimpl_vm_->isMigrating = false;
339    XBT_DEBUG("VM(%s) moved from PM(%s) to PM(%s)", sg_host_get_name(ms->vm), sg_host_get_name(ms->src_pm),
340              sg_host_get_name(ms->dst_pm));
341    TRACE_msg_vm_change_host(ms->vm, ms->src_pm, ms->dst_pm);
342   }
343   // Inform the SRC that the migration has been correctly performed
344   {
345     char *task_name = get_mig_task_name(ms->vm, ms->src_pm, ms->dst_pm, 4);
346     msg_task_t task = MSG_task_create(task_name, 0, 0, nullptr);
347     msg_error_t ret = MSG_task_send(task, ms->mbox_ctl);
348     // xbt_assert(ret == MSG_OK);
349     if(ret == MSG_HOST_FAILURE){
350       // The DST has crashed, this is a problem has the VM since we are not sure whether SRC is considering that the VM
351       // has been correctly migrated on the DST node
352       // TODO What does it mean ? What should we do ?
353       MSG_task_destroy(task);
354     } else if(ret == MSG_TRANSFER_FAILURE){
355       // The SRC has crashed, this is not a problem has the VM has been correctly migrated on the DST node
356       MSG_task_destroy(task);
357     }
358     xbt_free(task_name);
359   }
360
361   xbt_free(finalize_task_name);
362
363   XBT_DEBUG("mig: rx_done");
364   return 0;
365 }
366
367 static void reset_dirty_pages(msg_vm_t vm)
368 {
369   simgrid::surf::VirtualMachineImpl* pimpl = static_cast<simgrid::surf::VirtualMachineImpl*>(vm->pimpl_);
370
371   char *key = nullptr;
372   xbt_dict_cursor_t cursor = nullptr;
373   dirty_page_t dp = nullptr;
374   if (!pimpl->dp_objs)
375     return;
376   xbt_dict_foreach (pimpl->dp_objs, cursor, key, dp) {
377     double remaining = MSG_task_get_flops_amount(dp->task);
378     dp->prev_clock = MSG_get_clock();
379     dp->prev_remaining = remaining;
380
381     // XBT_INFO("%s@%s remaining %f", key, sg_host_name(vm), remaining);
382   }
383 }
384
385 static void start_dirty_page_tracking(msg_vm_t vm)
386 {
387   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->dp_enabled = 1;
388
389   reset_dirty_pages(vm);
390 }
391
392 static void stop_dirty_page_tracking(msg_vm_t vm)
393 {
394   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->dp_enabled = 0;
395 }
396
397 static double get_computed(char *key, msg_vm_t vm, dirty_page_t dp, double remaining, double clock)
398 {
399   double computed = dp->prev_remaining - remaining;
400   double duration = clock - dp->prev_clock;
401
402   XBT_DEBUG("%s@%s: computed %f ops (remaining %f -> %f) in %f secs (%f -> %f)",
403       key, sg_host_get_name(vm), computed, dp->prev_remaining, remaining, duration, dp->prev_clock, clock);
404
405   return computed;
406 }
407
408 static double lookup_computed_flop_counts(msg_vm_t vm, int stage_for_fancy_debug, int stage2_round_for_fancy_debug)
409 {
410   simgrid::surf::VirtualMachineImpl* pimpl = static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_;
411   double total = 0;
412
413   char *key = nullptr;
414   xbt_dict_cursor_t cursor = nullptr;
415   dirty_page_t dp = nullptr;
416   xbt_dict_foreach (pimpl->dp_objs, cursor, key, dp) {
417     double remaining = MSG_task_get_flops_amount(dp->task);
418
419     double clock = MSG_get_clock();
420
421     // total += calc_updated_pages(key, vm, dp, remaining, clock);
422     total += get_computed(key, vm, dp, remaining, clock);
423
424     dp->prev_remaining = remaining;
425     dp->prev_clock = clock;
426   }
427
428   total += pimpl->dp_updated_by_deleted_tasks;
429
430   XBT_DEBUG("mig-stage%d.%d: computed %f flop_counts (including %f by deleted tasks)", stage_for_fancy_debug,
431             stage2_round_for_fancy_debug, total, pimpl->dp_updated_by_deleted_tasks);
432
433   pimpl->dp_updated_by_deleted_tasks = 0;
434
435   return total;
436 }
437
438 // TODO Is this code redundant with the information provided by
439 // msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
440 /** @brief take care of the dirty page tracking, in case we're adding a task to a migrating VM */
441 void MSG_host_add_task(msg_host_t host, msg_task_t task)
442 {
443   simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host);
444   if (vm == nullptr)
445     return;
446   simgrid::surf::VirtualMachineImpl* pimpl = static_cast<simgrid::surf::VirtualMachineImpl*>(vm->pimpl_);
447
448   double remaining = MSG_task_get_flops_amount(task);
449   char *key = bprintf("%s-%p", task->name, task);
450
451   dirty_page_t dp = xbt_new0(s_dirty_page, 1);
452   dp->task = task;
453   if (pimpl->dp_enabled) {
454     dp->prev_clock = MSG_get_clock();
455     dp->prev_remaining = remaining;
456   }
457   if (!pimpl->dp_objs)
458     pimpl->dp_objs = xbt_dict_new();
459   xbt_assert(xbt_dict_get_or_null(pimpl->dp_objs, key) == nullptr);
460   xbt_dict_set(pimpl->dp_objs, key, dp, nullptr);
461   XBT_DEBUG("add %s on %s (remaining %f, dp_enabled %d)", key, sg_host_get_name(host), remaining, pimpl->dp_enabled);
462
463   xbt_free(key);
464 }
465
466 void MSG_host_del_task(msg_host_t host, msg_task_t task)
467 {
468   simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host);
469   if (vm == nullptr)
470     return;
471   simgrid::surf::VirtualMachineImpl* pimpl = static_cast<simgrid::surf::VirtualMachineImpl*>(vm->pimpl_);
472
473   char *key = bprintf("%s-%p", task->name, task);
474   dirty_page_t dp = (dirty_page_t)(pimpl->dp_objs ? xbt_dict_get_or_null(pimpl->dp_objs, key) : NULL);
475   xbt_assert(dp->task == task);
476
477   /* If we are in the middle of dirty page tracking, we record how much computation has been done until now, and keep
478    * the information for the lookup_() function that will called soon. */
479   if (pimpl->dp_enabled) {
480     double remaining = MSG_task_get_flops_amount(task);
481     double clock = MSG_get_clock();
482     // double updated = calc_updated_pages(key, host, dp, remaining, clock);
483     double updated = get_computed(key, host, dp, remaining, clock);
484
485     pimpl->dp_updated_by_deleted_tasks += updated;
486   }
487   if (pimpl->dp_objs)
488     xbt_dict_remove(pimpl->dp_objs, key);
489   xbt_free(dp);
490
491   XBT_DEBUG("del %s on %s", key, sg_host_get_name(host));
492   xbt_free(key);
493 }
494
495 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,
496                                      int stage, int stage2_round, double mig_speed, double timeout)
497 {
498   sg_size_t sent = 0;
499   char *task_name = get_mig_task_name(vm, src_pm, dst_pm, stage);
500   msg_task_t task = MSG_task_create(task_name, 0, (double)size, nullptr);
501
502   /* TODO: clean up */
503
504   double clock_sta = MSG_get_clock();
505
506   msg_error_t ret;
507   if (mig_speed > 0)
508     ret = MSG_task_send_with_timeout_bounded(task, mbox, timeout, mig_speed);
509   else
510     ret = MSG_task_send(task, mbox);
511
512   xbt_free(task_name);
513
514   if (ret == MSG_OK) {
515     sent = size;
516   } else if (ret == MSG_TIMEOUT) {
517     sg_size_t remaining = (sg_size_t)MSG_task_get_remaining_communication(task);
518     sent = size - remaining;
519     XBT_VERB("timeout (%lf s) in sending_migration_data, remaining %llu bytes of %llu", timeout, remaining, size);
520   }
521
522   /* FIXME: why try-and-catch is used here? */
523   if(ret == MSG_HOST_FAILURE){
524     //XBT_DEBUG("SRC host failed during migration of %s (stage %d)", sg_host_name(vm), stage);
525     MSG_task_destroy(task);
526     THROWF(host_error, 0, "SRC host failed during migration of %s (stage %d)", sg_host_get_name(vm), stage);
527   }else if(ret == MSG_TRANSFER_FAILURE){
528     //XBT_DEBUG("DST host failed during migration of %s (stage %d)", sg_host_name(vm), stage);
529     MSG_task_destroy(task);
530     THROWF(host_error, 0, "DST host failed during migration of %s (stage %d)", sg_host_get_name(vm), stage);
531   }
532
533   double clock_end = MSG_get_clock();
534   double duration = clock_end - clock_sta;
535   double actual_speed = size / duration;
536
537   if (stage == 2)
538     XBT_DEBUG("mig-stage%d.%d: sent %llu duration %f actual_speed %f (target %f)",
539               stage, stage2_round, size, duration, actual_speed, mig_speed);
540   else
541     XBT_DEBUG("mig-stage%d: sent %llu duration %f actual_speed %f (target %f)",
542               stage, size, duration, actual_speed, mig_speed);
543
544   return sent;
545 }
546
547 static sg_size_t get_updated_size(double computed, double dp_rate, double dp_cap)
548 {
549   double updated_size = computed * dp_rate;
550   XBT_DEBUG("updated_size %f dp_rate %f", updated_size, dp_rate);
551   if (updated_size > dp_cap) {
552     // XBT_INFO("mig-stage2.%d: %f bytes updated, but cap it with the working set size %f", stage2_round, updated_size,
553     //          dp_cap);
554     updated_size = dp_cap;
555   }
556
557   return (sg_size_t) updated_size;
558 }
559
560 static double send_stage1(struct migration_session *ms, sg_size_t ramsize, double mig_speed, double dp_rate,
561                           double dp_cap)
562 {
563   // const long chunksize = (sg_size_t)1024 * 1024 * 100;
564   const sg_size_t chunksize = (sg_size_t)1024 * 1024 * 100000;
565   sg_size_t remaining = ramsize;
566   double computed_total = 0;
567
568   while (remaining > 0) {
569     sg_size_t datasize = chunksize;
570     if (remaining < chunksize)
571       datasize = remaining;
572
573     remaining -= datasize;
574     send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, datasize, ms->mbox, 1, 0, mig_speed, -1);
575     double computed = lookup_computed_flop_counts(ms->vm, 1, 0);
576     computed_total += computed;
577   }
578
579   return computed_total;
580 }
581
582 static double get_threshold_value(double bandwidth, double max_downtime)
583 {
584   return max_downtime * bandwidth;
585 }
586
587 static int migration_tx_fun(int argc, char *argv[])
588 {
589   XBT_DEBUG("mig: tx_start");
590
591   // Note that the ms structure has been allocated in do_migration and hence should be freed in the same function ;)
592   migration_session *ms = (migration_session *) MSG_process_get_data(MSG_process_self());
593
594   s_vm_params_t params;
595   static_cast<simgrid::s4u::VirtualMachine*>(ms->vm)->parameters(&params);
596   const sg_size_t ramsize   = params.ramsize;
597   const sg_size_t devsize   = params.devsize;
598   const int skip_stage1     = params.skip_stage1;
599   int skip_stage2           = params.skip_stage2;
600   const double dp_rate      = params.dp_rate;
601   const double dp_cap       = params.dp_cap;
602   const double mig_speed    = params.mig_speed;
603   double max_downtime       = params.max_downtime;
604
605   /* hard code it temporally. Fix Me */
606 #define MIGRATION_TIMEOUT_DO_NOT_HARDCODE_ME 10000000.0
607   double mig_timeout = MIGRATION_TIMEOUT_DO_NOT_HARDCODE_ME;
608
609   double remaining_size = (double) (ramsize + devsize);
610   double threshold = 0.0;
611
612   /* check parameters */
613   if (ramsize == 0)
614     XBT_WARN("migrate a VM, but ramsize is zero");
615
616   if (max_downtime <= 0) {
617     XBT_WARN("use the default max_downtime value 30ms");
618     max_downtime = 0.03;
619   }
620
621   /* Stage1: send all memory pages to the destination. */
622   XBT_DEBUG("mig-stage1: remaining_size %f", remaining_size);
623   start_dirty_page_tracking(ms->vm);
624
625   double computed_during_stage1 = 0;
626   if (!skip_stage1) {
627     double clock_prev_send = MSG_get_clock();
628
629     try {
630       /* At stage 1, we do not need timeout. We have to send all the memory pages even though the duration of this
631        * transfer exceeds the timeout value. */
632       XBT_VERB("Stage 1: Gonna send %llu", ramsize);
633       sg_size_t sent = send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, ramsize, ms->mbox, 1, 0, mig_speed, -1);
634       remaining_size -= sent;
635       computed_during_stage1 = lookup_computed_flop_counts(ms->vm, 1, 0);
636
637       if (sent < ramsize) {
638         XBT_VERB("mig-stage1: timeout, force moving to stage 3");
639         skip_stage2 = 1;
640       } else if (sent > ramsize)
641         XBT_CRITICAL("bug");
642
643     }
644     catch (xbt_ex& e) {
645       //hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
646       // Stop the dirty page tracking an return (there is no memory space to release)
647       stop_dirty_page_tracking(ms->vm);
648       return 0;
649     }
650
651     double clock_post_send = MSG_get_clock();
652     mig_timeout -= (clock_post_send - clock_prev_send);
653     if (mig_timeout < 0) {
654       XBT_VERB("The duration of stage 1 exceeds the timeout value (%lf > %lf), skip stage 2",
655           (clock_post_send - clock_prev_send), MIGRATION_TIMEOUT_DO_NOT_HARDCODE_ME);
656       skip_stage2 = 1;
657     }
658
659     /* estimate bandwidth */
660     double bandwidth = ramsize / (clock_post_send - clock_prev_send);
661     threshold = get_threshold_value(bandwidth, max_downtime);
662     XBT_DEBUG("actual bandwidth %f (MB/s), threshold %f", bandwidth / 1024 / 1024, threshold);
663   }
664
665
666   /* Stage2: send update pages iteratively until the size of remaining states becomes smaller than threshold value. */
667  if (! skip_stage2) {
668
669   int stage2_round = 0;
670   for (;;) {
671
672     sg_size_t updated_size = 0;
673     if (stage2_round == 0) {
674       /* just after stage1, nothing has been updated. But, we have to send the data updated during stage1 */
675       updated_size = get_updated_size(computed_during_stage1, dp_rate, dp_cap);
676     } else {
677       double computed = lookup_computed_flop_counts(ms->vm, 2, stage2_round);
678       updated_size = get_updated_size(computed, dp_rate, dp_cap);
679     }
680
681     XBT_DEBUG("mig-stage 2:%d updated_size %llu computed_during_stage1 %f dp_rate %f dp_cap %f",
682         stage2_round, updated_size, computed_during_stage1, dp_rate, dp_cap);
683
684     /* Check whether the remaining size is below the threshold value. If so, move to stage 3. */
685     remaining_size += updated_size;
686     XBT_DEBUG("mig-stage2.%d: remaining_size %f (%s threshold %f)", stage2_round,
687         remaining_size, (remaining_size < threshold) ? "<" : ">", threshold);
688     if (remaining_size < threshold)
689       break;
690
691     sg_size_t sent = 0;
692     double clock_prev_send = MSG_get_clock();
693     try {
694       XBT_DEBUG("Stage 2, gonna send %llu", updated_size);
695       sent = send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, updated_size, ms->mbox, 2, stage2_round, mig_speed,
696                                  mig_timeout);
697     }
698     catch (xbt_ex& e) {
699       //hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
700       // Stop the dirty page tracking an return (there is no memory space to release)
701       stop_dirty_page_tracking(ms->vm);
702       return 0;
703     }
704     double clock_post_send = MSG_get_clock();
705
706     if (sent == updated_size) {
707       /* timeout did not happen */
708       double bandwidth = updated_size / (clock_post_send - clock_prev_send);
709       threshold = get_threshold_value(bandwidth, max_downtime);
710       XBT_DEBUG("actual bandwidth %f, threshold %f", bandwidth / 1024 / 1024, threshold);
711       remaining_size -= sent;
712       stage2_round += 1;
713       mig_timeout -= (clock_post_send - clock_prev_send);
714       xbt_assert(mig_timeout > 0);
715
716     } else if (sent < updated_size) {
717       /* When timeout happens, we move to stage 3. The size of memory pages
718        * updated before timeout must be added to the remaining size. */
719       XBT_VERB("mig-stage2.%d: timeout, force moving to stage 3. sent %llu / %llu, eta %lf",
720           stage2_round, sent, updated_size, (clock_post_send - clock_prev_send));
721       remaining_size -= sent;
722
723       double computed = lookup_computed_flop_counts(ms->vm, 2, stage2_round);
724       updated_size = get_updated_size(computed, dp_rate, dp_cap);
725       remaining_size += updated_size;
726       break;
727     } else
728       XBT_CRITICAL("bug");
729   }
730  }
731
732   /* Stage3: stop the VM and copy the rest of states. */
733   XBT_DEBUG("mig-stage3: remaining_size %f", remaining_size);
734   simcall_vm_suspend(ms->vm);
735   stop_dirty_page_tracking(ms->vm);
736
737   try {
738     XBT_DEBUG("Stage 3: Gonna send %f", remaining_size);
739     send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, (sg_size_t)remaining_size, ms->mbox, 3, 0, mig_speed, -1);
740   }
741   catch(xbt_ex& e) {
742     //hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
743     // Stop the dirty page tracking an return (there is no memory space to release)
744     simcall_vm_resume(ms->vm);
745     return 0;
746   }
747
748   // At that point the Migration is considered valid for the SRC node but remind that the DST side should relocate
749   // effectively the VM on the DST node.
750   XBT_DEBUG("mig: tx_done");
751
752   return 0;
753 }
754
755 static int do_migration(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
756 {
757   struct migration_session *ms = xbt_new(struct migration_session, 1);
758   ms->vm = vm;
759   ms->src_pm = src_pm;
760   ms->dst_pm = dst_pm;
761   ms->mbox_ctl = get_mig_mbox_ctl(vm, src_pm, dst_pm);
762   ms->mbox = get_mig_mbox_src_dst(vm, src_pm, dst_pm);
763
764   char *pr_rx_name = get_mig_process_rx_name(vm, src_pm, dst_pm);
765   char *pr_tx_name = get_mig_process_tx_name(vm, src_pm, dst_pm);
766
767 //  msg_process_t tx_process, rx_process; 
768 //  MSG_process_create(pr_rx_name, migration_rx_fun, ms, dst_pm);
769 //  MSG_process_create(pr_tx_name, migration_tx_fun, ms, src_pm);
770 #if 1
771  {
772  char **argv = xbt_new(char *, 2);
773  argv[0] = pr_rx_name;
774  argv[1] = nullptr;
775 /*rx_process = */ MSG_process_create_with_arguments(pr_rx_name, migration_rx_fun, ms, dst_pm, 1, argv);
776  }
777  {
778  char **argv = xbt_new(char *, 2);
779  argv[0] = pr_tx_name;
780  argv[1] = nullptr;
781 /* tx_process = */MSG_process_create_with_arguments(pr_tx_name, migration_tx_fun, ms, src_pm, 1, argv);
782  }
783 #endif
784
785   /* wait until the migration have finished or on error has occurred */
786   {
787     XBT_DEBUG("wait for reception of the final ACK (i.e. migration has been correctly performed");
788     msg_task_t task = nullptr;
789     msg_error_t ret = MSG_TIMEOUT;
790     while (ret == MSG_TIMEOUT && MSG_host_is_on(dst_pm)) //Wait while you receive the message o
791      ret = MSG_task_receive_with_timeout(&task, ms->mbox_ctl, 4);
792
793     xbt_free(ms->mbox_ctl);
794     xbt_free(ms->mbox);
795     xbt_free(ms);
796
797     //xbt_assert(ret == MSG_OK);
798     if(ret == MSG_HOST_FAILURE){
799         // Note that since the communication failed, the owner did not change and the task should be destroyed on the
800         // other side. Hence, just throw the execption
801         XBT_ERROR("SRC crashes, throw an exception (m-control)");
802         //MSG_process_kill(tx_process); // Adrien, I made a merge on Nov 28th 2014, I'm not sure whether this line is
803                                         // required or not
804         return -1; 
805     } 
806     else if((ret == MSG_TRANSFER_FAILURE) || (ret == MSG_TIMEOUT)){
807         // MSG_TIMEOUT here means that MSG_host_is_avail() returned false.
808         XBT_ERROR("DST crashes, throw an exception (m-control)");
809         return -2;  
810     }
811
812     char *expected_task_name = get_mig_task_name(vm, src_pm, dst_pm, 4);
813     xbt_assert(strcmp(task->name, expected_task_name) == 0);
814     xbt_free(expected_task_name);
815     MSG_task_destroy(task);
816     return 0;
817   }
818 }
819
820 /** @brief Migrate the VM to the given host.
821  *  @ingroup msg_VMs
822  *
823  * FIXME: No migration cost occurs. If you want to simulate this too, you want to use a MSG_task_send() before or after,
824  * depending on whether you want to do cold or hot migration.
825  */
826 void MSG_vm_migrate(msg_vm_t vm, msg_host_t new_pm)
827 {
828   /* some thoughts:
829    * - One approach is ...
830    *   We first create a new VM (i.e., destination VM) on the destination   physical host. The destination VM will
831    *   receive the state of the source
832    *   VM over network. We will finally destroy the source VM.
833    *   - This behavior is similar to the way of migration in the real world.
834    *     Even before a migration is completed, we will see a destination VM, consuming resources.
835    *   - We have to relocate all processes. The existing process migration code will work for this?
836    *   - The name of the VM is a somewhat unique ID in the code. It is tricky for the destination VM?
837    *
838    * - Another one is ...
839    *   We update the information of the given VM to place it to the destination physical host.
840    *
841    * The second one would be easier.
842    */
843
844   msg_host_t old_pm = (msg_host_t) simcall_vm_get_pm(vm);
845
846   if(MSG_host_is_off(old_pm))
847     THROWF(vm_error, 0, "SRC host(%s) seems off, cannot start a migration", sg_host_get_name(old_pm));
848
849   if(MSG_host_is_off(new_pm))
850     THROWF(vm_error, 0, "DST host(%s) seems off, cannot start a migration", sg_host_get_name(new_pm));
851
852   if (!MSG_vm_is_running(vm))
853     THROWF(vm_error, 0, "VM(%s) is not running", sg_host_get_name(vm));
854
855   if (MSG_vm_is_migrating(vm))
856     THROWF(vm_error, 0, "VM(%s) is already migrating", sg_host_get_name(vm));
857
858   simgrid::surf::VirtualMachineImpl* pimpl = static_cast<simgrid::surf::VirtualMachineImpl*>(vm->pimpl_);
859   pimpl->isMigrating                       = 1;
860
861   {
862     int ret = do_migration(vm, old_pm, new_pm);
863     if (ret == -1){
864       pimpl->isMigrating = 0;
865       THROWF(host_error, 0, "SRC host failed during migration");
866     }
867     else if(ret == -2){
868       pimpl->isMigrating = 0;
869       THROWF(host_error, 0, "DST host failed during migration");
870     }
871   }
872
873   // This part is done in the RX code, to handle the corner case where SRC can crash just at the end of the migration
874   // process. In that case, the VM has been already assigned to the DST node.
875   //XBT_DEBUG("VM(%s) moved from PM(%s) to PM(%s)", vm->key, old_pm->key, new_pm->key);
876   //TRACE_msg_vm_change_host(vm, old_pm, new_pm);
877 }
878
879 /** @brief Immediately suspend the execution of all processes within the given VM.
880  *  @ingroup msg_VMs
881  *
882  * This function stops the execution of the VM. All the processes on this VM
883  * will pause. The state of the VM is preserved. We can later resume it again.
884  *
885  * No suspension cost occurs.
886  */
887 void MSG_vm_suspend(msg_vm_t vm)
888 {
889   if (MSG_vm_is_migrating(vm))
890     THROWF(vm_error, 0, "VM(%s) is migrating", sg_host_get_name(vm));
891
892   simcall_vm_suspend(vm);
893
894   XBT_DEBUG("vm_suspend done");
895
896   TRACE_msg_vm_suspend(vm);
897 }
898
899 /** @brief Resume the execution of the VM. All processes on the VM run again.
900  *  @ingroup msg_VMs
901  *
902  * No resume cost occurs.
903  */
904 void MSG_vm_resume(msg_vm_t vm)
905 {
906   simcall_vm_resume(vm);
907
908   TRACE_msg_vm_resume(vm);
909 }
910
911
912 /** @brief Immediately save the execution of all processes within the given VM.
913  *  @ingroup msg_VMs
914  *
915  * This function stops the execution of the VM. All the processes on this VM
916  * will pause. The state of the VM is preserved. We can later resume it again.
917  *
918  * FIXME: No suspension cost occurs. If you want to simulate this too, you want to use a \ref MSG_file_write() before
919  * or after, depending on the exact semantic of VM save to you.
920  */
921 void MSG_vm_save(msg_vm_t vm)
922 {
923   if (MSG_vm_is_migrating(vm))
924     THROWF(vm_error, 0, "VM(%s) is migrating", sg_host_get_name(vm));
925
926   simcall_vm_save(vm);
927   TRACE_msg_vm_save(vm);
928 }
929
930 /** @brief Restore the execution of the VM. All processes on the VM run again.
931  *  @ingroup msg_VMs
932  *
933  * FIXME: No restore cost occurs. If you want to simulate this too, you want to use a \ref MSG_file_read() before or
934  * after, depending on the exact semantic of VM restore to you.
935  */
936 void MSG_vm_restore(msg_vm_t vm)
937 {
938   simcall_vm_restore(vm);
939
940   TRACE_msg_vm_restore(vm);
941 }
942
943 /** @brief Get the physical host of a given VM.
944  *  @ingroup msg_VMs
945  */
946 msg_host_t MSG_vm_get_pm(msg_vm_t vm)
947 {
948   return (msg_host_t) simcall_vm_get_pm(vm);
949 }
950
951 /** @brief Set a CPU bound for a given VM.
952  *  @ingroup msg_VMs
953  *
954  * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
955  *
956  * For example,
957  *  On PM0, there are Task1 and VM0.
958  *  On VM0, there is Task2.
959  * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
960  * Then,
961  *  Task1\@PM0 gets 50%.
962  *  Task2\@VM0 gets 25%.
963  * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
964  *
965  * 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
966  * the dummy CPU action. The bound of the dummy CPU action is unlimited.
967  *
968  * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
969  * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
970  * on the VM in share_resource() or we have to trap both the start and end of task execution.
971  *
972  * The current solution is to use MSG_vm_set_bound(), which allows us to directly set the bound of the dummy CPU action.
973  *
974  * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
975  *    computation task (or a VM) never exceeds the capacity of a CPU core.
976  */
977 void MSG_vm_set_bound(msg_vm_t vm, double bound)
978 {
979   simcall_vm_set_bound(vm, bound);
980 }