Logo AND Algorithmique Numérique Distribuée

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