Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
The VirtualMachineImpl is stored in VirtualMachine->pimpl_vm_, not in Host->pimpl_
[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   if (TRACE_msg_vm_is_enabled()) {
189     container_t container = PJ_container_get(vm->name().c_str());
190     PJ_container_remove_from_parent(container);
191     PJ_container_free(container);
192   }
193 }
194
195 /** @brief Start a vm (i.e., boot the guest operating system)
196  *  @ingroup msg_VMs
197  *
198  *  If the VM cannot be started, an exception is generated.
199  */
200 void MSG_vm_start(msg_vm_t vm)
201 {
202   simcall_vm_start(vm);
203
204   if (TRACE_msg_vm_is_enabled()) {
205     container_t vm_container = PJ_container_get(vm->name().c_str());
206     type_t type              = PJ_type_get("MSG_VM_STATE", vm_container->type);
207     val_t value              = PJ_value_get_or_new("start", "0 0 1", type); // start is blue
208     new_pajePushState(MSG_get_clock(), vm_container, type, value);
209   }
210 }
211
212 /** @brief Immediately kills all processes within the given VM. Any memory that they allocated will be leaked.
213  *  @ingroup msg_VMs
214  *
215  * FIXME: No extra delay occurs. If you want to simulate this too, you want to use a #MSG_process_sleep() or something.
216  *        I'm not quite sure.
217  */
218 void MSG_vm_shutdown(msg_vm_t vm)
219 {
220   simcall_vm_shutdown(vm);
221   MSG_process_sleep(0.); // Make sure that the processes in the VM are killed in this scheduling round before processing
222                          // (eg with the VM destroy)
223 }
224
225 /* We have two mailboxes. mbox is used to transfer migration data between source and destination PMs. mbox_ctl is used
226  * to detect the completion of a migration. The names of these mailboxes must not conflict with others. */
227 static inline char *get_mig_mbox_src_dst(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
228 {
229   const char *vm_name = sg_host_get_name(vm);
230   const char *src_pm_name = sg_host_get_name(src_pm);
231   const char *dst_pm_name = sg_host_get_name(dst_pm);
232
233   return bprintf("__mbox_mig_src_dst:%s(%s-%s)", vm_name, src_pm_name, dst_pm_name);
234 }
235
236 static inline char *get_mig_mbox_ctl(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
237 {
238   const char *vm_name = sg_host_get_name(vm);
239   const char *src_pm_name = sg_host_get_name(src_pm);
240   const char *dst_pm_name = sg_host_get_name(dst_pm);
241
242   return bprintf("__mbox_mig_ctl:%s(%s-%s)", vm_name, src_pm_name, dst_pm_name);
243 }
244
245 static inline char *get_mig_process_tx_name(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
246 {
247   const char *vm_name = sg_host_get_name(vm);
248   const char *src_pm_name = sg_host_get_name(src_pm);
249   const char *dst_pm_name = sg_host_get_name(dst_pm);
250
251   return bprintf("__pr_mig_tx:%s(%s-%s)", vm_name, src_pm_name, dst_pm_name);
252 }
253
254 static inline char *get_mig_process_rx_name(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
255 {
256   const char *vm_name = sg_host_get_name(vm);
257   const char *src_pm_name = sg_host_get_name(src_pm);
258   const char *dst_pm_name = sg_host_get_name(dst_pm);
259
260   return bprintf("__pr_mig_rx:%s(%s-%s)", vm_name, src_pm_name, dst_pm_name);
261 }
262
263 static inline char *get_mig_task_name(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm, int stage)
264 {
265   const char *vm_name = sg_host_get_name(vm);
266   const char *src_pm_name = sg_host_get_name(src_pm);
267   const char *dst_pm_name = sg_host_get_name(dst_pm);
268
269   return bprintf("__task_mig_stage%d:%s(%s-%s)", stage, vm_name, src_pm_name, dst_pm_name);
270 }
271
272 struct migration_session {
273   msg_vm_t vm;
274   msg_host_t src_pm;
275   msg_host_t dst_pm;
276
277   /* The miration_rx process uses mbox_ctl to let the caller of do_migration()
278    * know the completion of the migration. */
279   char *mbox_ctl;
280   /* The migration_rx and migration_tx processes use mbox to transfer migration data. */
281   char *mbox;
282 };
283
284 static int migration_rx_fun(int argc, char *argv[])
285 {
286   XBT_DEBUG("mig: rx_start");
287
288   // The structure has been created in the do_migration function and should only be freed in the same place ;)
289   struct migration_session *ms = (migration_session *) MSG_process_get_data(MSG_process_self());
290
291   s_vm_params_t params;
292   static_cast<simgrid::s4u::VirtualMachine*>(ms->vm)->parameters(&params);
293
294   int need_exit = 0;
295
296   char *finalize_task_name = get_mig_task_name(ms->vm, ms->src_pm, ms->dst_pm, 3);
297
298   int ret = 0;
299   for (;;) {
300     msg_task_t task = nullptr;
301     ret = MSG_task_recv(&task, ms->mbox);
302     {
303       if (ret != MSG_OK) {
304         // An error occurred, clean the code and return
305         // The owner did not change, hence the task should be only destroyed on the other side
306         xbt_free(finalize_task_name);
307         return 0;
308       }
309     }
310
311     if (strcmp(task->name, finalize_task_name) == 0)
312       need_exit = 1;
313
314     MSG_task_destroy(task);
315
316     if (need_exit)
317       break;
318   }
319
320   // Here Stage 1, 2  and 3 have been performed.
321   // Hence complete the migration
322
323   // Copy the reference to the vm (if SRC crashes now, do_migration will free ms)
324   // This is clearly ugly but I (Adrien) need more time to do something cleaner (actually we should copy the whole ms
325   // structure at the beginning and free it at the end of each function)
326   simgrid::s4u::VirtualMachine* vm = static_cast<simgrid::s4u::VirtualMachine*>(ms->vm);
327   msg_host_t src_pm                = ms->src_pm;
328   msg_host_t dst_pm                = ms->dst_pm;
329
330   // Make sure that we cannot get interrupted between the migrate and the resume to not end in an inconsistent state
331   simgrid::simix::kernelImmediate([vm, src_pm, dst_pm]() {
332     /* Update the vm location */
333     /* precopy migration makes the VM temporally paused */
334     xbt_assert(static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->getState() == SURF_VM_STATE_SUSPENDED);
335
336     /* jump to vm_ws_xigrate(). this will update the vm location. */
337     static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->migrate(dst_pm);
338
339     /* Resume the VM */
340     SIMIX_vm_resume(vm);
341   });
342
343   {
344    // Now the VM is running on the new host (the migration is completed) (even if the SRC crash)
345    vm->pimpl_vm_->isMigrating = false;
346    XBT_DEBUG("VM(%s) moved from PM(%s) to PM(%s)", sg_host_get_name(ms->vm), sg_host_get_name(ms->src_pm),
347              sg_host_get_name(ms->dst_pm));
348
349    if (TRACE_msg_vm_is_enabled()) {
350      static long long int counter = 0;
351      char key[INSTR_DEFAULT_STR_SIZE];
352      snprintf(key, INSTR_DEFAULT_STR_SIZE, "%lld", counter++);
353
354      // start link
355      container_t msg = PJ_container_get(vm->name().c_str());
356      type_t type     = PJ_type_get("MSG_VM_LINK", PJ_type_get_root());
357      new_pajeStartLink(MSG_get_clock(), PJ_container_get_root(), type, msg, "M", key);
358
359      // destroy existing container of this vm
360      container_t existing_container = PJ_container_get(vm->name().c_str());
361      PJ_container_remove_from_parent(existing_container);
362      PJ_container_free(existing_container);
363
364      // create new container on the new_host location
365      PJ_container_new(vm->name().c_str(), INSTR_MSG_VM, PJ_container_get(sg_host_get_name(ms->dst_pm)));
366
367      // end link
368      msg  = PJ_container_get(vm->name().c_str());
369      type = PJ_type_get("MSG_VM_LINK", PJ_type_get_root());
370      new_pajeEndLink(MSG_get_clock(), PJ_container_get_root(), type, msg, "M", key);
371    }
372   }
373   // Inform the SRC that the migration has been correctly performed
374   {
375     char *task_name = get_mig_task_name(ms->vm, ms->src_pm, ms->dst_pm, 4);
376     msg_task_t task = MSG_task_create(task_name, 0, 0, nullptr);
377     msg_error_t ret = MSG_task_send(task, ms->mbox_ctl);
378     // xbt_assert(ret == MSG_OK);
379     if(ret == MSG_HOST_FAILURE){
380       // The DST has crashed, this is a problem has the VM since we are not sure whether SRC is considering that the VM
381       // has been correctly migrated on the DST node
382       // TODO What does it mean ? What should we do ?
383       MSG_task_destroy(task);
384     } else if(ret == MSG_TRANSFER_FAILURE){
385       // The SRC has crashed, this is not a problem has the VM has been correctly migrated on the DST node
386       MSG_task_destroy(task);
387     }
388     xbt_free(task_name);
389   }
390
391   xbt_free(finalize_task_name);
392
393   XBT_DEBUG("mig: rx_done");
394   return 0;
395 }
396
397 static void reset_dirty_pages(msg_vm_t vm)
398 {
399   simgrid::surf::VirtualMachineImpl* pimpl = static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_;
400
401   char *key = nullptr;
402   xbt_dict_cursor_t cursor = nullptr;
403   dirty_page_t dp = nullptr;
404   if (!pimpl->dp_objs)
405     return;
406   xbt_dict_foreach (pimpl->dp_objs, cursor, key, dp) {
407     double remaining = MSG_task_get_flops_amount(dp->task);
408     dp->prev_clock = MSG_get_clock();
409     dp->prev_remaining = remaining;
410
411     // XBT_INFO("%s@%s remaining %f", key, sg_host_name(vm), remaining);
412   }
413 }
414
415 static void start_dirty_page_tracking(msg_vm_t vm)
416 {
417   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->dp_enabled = 1;
418
419   reset_dirty_pages(vm);
420 }
421
422 static void stop_dirty_page_tracking(msg_vm_t vm)
423 {
424   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->dp_enabled = 0;
425 }
426
427 static double get_computed(char *key, msg_vm_t vm, dirty_page_t dp, double remaining, double clock)
428 {
429   double computed = dp->prev_remaining - remaining;
430   double duration = clock - dp->prev_clock;
431
432   XBT_DEBUG("%s@%s: computed %f ops (remaining %f -> %f) in %f secs (%f -> %f)",
433       key, sg_host_get_name(vm), computed, dp->prev_remaining, remaining, duration, dp->prev_clock, clock);
434
435   return computed;
436 }
437
438 static double lookup_computed_flop_counts(msg_vm_t vm, int stage_for_fancy_debug, int stage2_round_for_fancy_debug)
439 {
440   simgrid::surf::VirtualMachineImpl* pimpl = static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_;
441   double total = 0;
442
443   char *key = nullptr;
444   xbt_dict_cursor_t cursor = nullptr;
445   dirty_page_t dp = nullptr;
446   xbt_dict_foreach (pimpl->dp_objs, cursor, key, dp) {
447     double remaining = MSG_task_get_flops_amount(dp->task);
448
449     double clock = MSG_get_clock();
450
451     // total += calc_updated_pages(key, vm, dp, remaining, clock);
452     total += get_computed(key, vm, dp, remaining, clock);
453
454     dp->prev_remaining = remaining;
455     dp->prev_clock = clock;
456   }
457
458   total += pimpl->dp_updated_by_deleted_tasks;
459
460   XBT_DEBUG("mig-stage%d.%d: computed %f flop_counts (including %f by deleted tasks)", stage_for_fancy_debug,
461             stage2_round_for_fancy_debug, total, pimpl->dp_updated_by_deleted_tasks);
462
463   pimpl->dp_updated_by_deleted_tasks = 0;
464
465   return total;
466 }
467
468 // TODO Is this code redundant with the information provided by
469 // msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
470 /** @brief take care of the dirty page tracking, in case we're adding a task to a migrating VM */
471 void MSG_host_add_task(msg_host_t host, msg_task_t task)
472 {
473   simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host);
474   if (vm == nullptr)
475     return;
476   simgrid::surf::VirtualMachineImpl* pimpl = static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_;
477
478   double remaining = MSG_task_get_flops_amount(task);
479   char *key = bprintf("%s-%p", task->name, task);
480
481   dirty_page_t dp = xbt_new0(s_dirty_page, 1);
482   dp->task = task;
483   if (pimpl->dp_enabled) {
484     dp->prev_clock = MSG_get_clock();
485     dp->prev_remaining = remaining;
486   }
487   if (!pimpl->dp_objs)
488     pimpl->dp_objs = xbt_dict_new();
489   xbt_assert(xbt_dict_get_or_null(pimpl->dp_objs, key) == nullptr);
490   xbt_dict_set(pimpl->dp_objs, key, dp, nullptr);
491   XBT_DEBUG("add %s on %s (remaining %f, dp_enabled %d)", key, sg_host_get_name(host), remaining, pimpl->dp_enabled);
492
493   xbt_free(key);
494 }
495
496 void MSG_host_del_task(msg_host_t host, msg_task_t task)
497 {
498   simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host);
499   if (vm == nullptr)
500     return;
501   simgrid::surf::VirtualMachineImpl* pimpl = static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_;
502
503   char *key = bprintf("%s-%p", task->name, task);
504   dirty_page_t dp = (dirty_page_t)(pimpl->dp_objs ? xbt_dict_get_or_null(pimpl->dp_objs, key) : NULL);
505   xbt_assert(dp->task == task);
506
507   /* If we are in the middle of dirty page tracking, we record how much computation has been done until now, and keep
508    * the information for the lookup_() function that will called soon. */
509   if (pimpl->dp_enabled) {
510     double remaining = MSG_task_get_flops_amount(task);
511     double clock = MSG_get_clock();
512     // double updated = calc_updated_pages(key, host, dp, remaining, clock);
513     double updated = get_computed(key, host, dp, remaining, clock);
514
515     pimpl->dp_updated_by_deleted_tasks += updated;
516   }
517   if (pimpl->dp_objs)
518     xbt_dict_remove(pimpl->dp_objs, key);
519   xbt_free(dp);
520
521   XBT_DEBUG("del %s on %s", key, sg_host_get_name(host));
522   xbt_free(key);
523 }
524
525 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,
526                                      int stage, int stage2_round, double mig_speed, double timeout)
527 {
528   sg_size_t sent = 0;
529   char *task_name = get_mig_task_name(vm, src_pm, dst_pm, stage);
530   msg_task_t task = MSG_task_create(task_name, 0, (double)size, nullptr);
531
532   /* TODO: clean up */
533
534   double clock_sta = MSG_get_clock();
535
536   msg_error_t ret;
537   if (mig_speed > 0)
538     ret = MSG_task_send_with_timeout_bounded(task, mbox, timeout, mig_speed);
539   else
540     ret = MSG_task_send(task, mbox);
541
542   xbt_free(task_name);
543
544   if (ret == MSG_OK) {
545     sent = size;
546   } else if (ret == MSG_TIMEOUT) {
547     sg_size_t remaining = (sg_size_t)MSG_task_get_remaining_communication(task);
548     sent = size - remaining;
549     XBT_VERB("timeout (%lf s) in sending_migration_data, remaining %llu bytes of %llu", timeout, remaining, size);
550   }
551
552   /* FIXME: why try-and-catch is used here? */
553   if(ret == MSG_HOST_FAILURE){
554     //XBT_DEBUG("SRC host failed during migration of %s (stage %d)", sg_host_name(vm), stage);
555     MSG_task_destroy(task);
556     THROWF(host_error, 0, "SRC host failed during migration of %s (stage %d)", sg_host_get_name(vm), stage);
557   }else if(ret == MSG_TRANSFER_FAILURE){
558     //XBT_DEBUG("DST host failed during migration of %s (stage %d)", sg_host_name(vm), stage);
559     MSG_task_destroy(task);
560     THROWF(host_error, 0, "DST host failed during migration of %s (stage %d)", sg_host_get_name(vm), stage);
561   }
562
563   double clock_end = MSG_get_clock();
564   double duration = clock_end - clock_sta;
565   double actual_speed = size / duration;
566
567   if (stage == 2)
568     XBT_DEBUG("mig-stage%d.%d: sent %llu duration %f actual_speed %f (target %f)",
569               stage, stage2_round, size, duration, actual_speed, mig_speed);
570   else
571     XBT_DEBUG("mig-stage%d: sent %llu duration %f actual_speed %f (target %f)",
572               stage, size, duration, actual_speed, mig_speed);
573
574   return sent;
575 }
576
577 static sg_size_t get_updated_size(double computed, double dp_rate, double dp_cap)
578 {
579   double updated_size = computed * dp_rate;
580   XBT_DEBUG("updated_size %f dp_rate %f", updated_size, dp_rate);
581   if (updated_size > dp_cap) {
582     // XBT_INFO("mig-stage2.%d: %f bytes updated, but cap it with the working set size %f", stage2_round, updated_size,
583     //          dp_cap);
584     updated_size = dp_cap;
585   }
586
587   return (sg_size_t) updated_size;
588 }
589
590 static double send_stage1(struct migration_session *ms, sg_size_t ramsize, double mig_speed, double dp_rate,
591                           double dp_cap)
592 {
593   // const long chunksize = (sg_size_t)1024 * 1024 * 100;
594   const sg_size_t chunksize = (sg_size_t)1024 * 1024 * 100000;
595   sg_size_t remaining = ramsize;
596   double computed_total = 0;
597
598   while (remaining > 0) {
599     sg_size_t datasize = chunksize;
600     if (remaining < chunksize)
601       datasize = remaining;
602
603     remaining -= datasize;
604     send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, datasize, ms->mbox, 1, 0, mig_speed, -1);
605     double computed = lookup_computed_flop_counts(ms->vm, 1, 0);
606     computed_total += computed;
607   }
608
609   return computed_total;
610 }
611
612 static double get_threshold_value(double bandwidth, double max_downtime)
613 {
614   return max_downtime * bandwidth;
615 }
616
617 static int migration_tx_fun(int argc, char *argv[])
618 {
619   XBT_DEBUG("mig: tx_start");
620
621   // Note that the ms structure has been allocated in do_migration and hence should be freed in the same function ;)
622   migration_session *ms = (migration_session *) MSG_process_get_data(MSG_process_self());
623
624   s_vm_params_t params;
625   static_cast<simgrid::s4u::VirtualMachine*>(ms->vm)->parameters(&params);
626   const sg_size_t ramsize   = params.ramsize;
627   const sg_size_t devsize   = params.devsize;
628   const int skip_stage1     = params.skip_stage1;
629   int skip_stage2           = params.skip_stage2;
630   const double dp_rate      = params.dp_rate;
631   const double dp_cap       = params.dp_cap;
632   const double mig_speed    = params.mig_speed;
633   double max_downtime       = params.max_downtime;
634
635   /* hard code it temporally. Fix Me */
636 #define MIGRATION_TIMEOUT_DO_NOT_HARDCODE_ME 10000000.0
637   double mig_timeout = MIGRATION_TIMEOUT_DO_NOT_HARDCODE_ME;
638
639   double remaining_size = (double) (ramsize + devsize);
640   double threshold = 0.0;
641
642   /* check parameters */
643   if (ramsize == 0)
644     XBT_WARN("migrate a VM, but ramsize is zero");
645
646   if (max_downtime <= 0) {
647     XBT_WARN("use the default max_downtime value 30ms");
648     max_downtime = 0.03;
649   }
650
651   /* Stage1: send all memory pages to the destination. */
652   XBT_DEBUG("mig-stage1: remaining_size %f", remaining_size);
653   start_dirty_page_tracking(ms->vm);
654
655   double computed_during_stage1 = 0;
656   if (!skip_stage1) {
657     double clock_prev_send = MSG_get_clock();
658
659     try {
660       /* At stage 1, we do not need timeout. We have to send all the memory pages even though the duration of this
661        * transfer exceeds the timeout value. */
662       XBT_VERB("Stage 1: Gonna send %llu", ramsize);
663       sg_size_t sent = send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, ramsize, ms->mbox, 1, 0, mig_speed, -1);
664       remaining_size -= sent;
665       computed_during_stage1 = lookup_computed_flop_counts(ms->vm, 1, 0);
666
667       if (sent < ramsize) {
668         XBT_VERB("mig-stage1: timeout, force moving to stage 3");
669         skip_stage2 = 1;
670       } else if (sent > ramsize)
671         XBT_CRITICAL("bug");
672
673     }
674     catch (xbt_ex& e) {
675       //hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
676       // Stop the dirty page tracking an return (there is no memory space to release)
677       stop_dirty_page_tracking(ms->vm);
678       return 0;
679     }
680
681     double clock_post_send = MSG_get_clock();
682     mig_timeout -= (clock_post_send - clock_prev_send);
683     if (mig_timeout < 0) {
684       XBT_VERB("The duration of stage 1 exceeds the timeout value (%lf > %lf), skip stage 2",
685           (clock_post_send - clock_prev_send), MIGRATION_TIMEOUT_DO_NOT_HARDCODE_ME);
686       skip_stage2 = 1;
687     }
688
689     /* estimate bandwidth */
690     double bandwidth = ramsize / (clock_post_send - clock_prev_send);
691     threshold = get_threshold_value(bandwidth, max_downtime);
692     XBT_DEBUG("actual bandwidth %f (MB/s), threshold %f", bandwidth / 1024 / 1024, threshold);
693   }
694
695
696   /* Stage2: send update pages iteratively until the size of remaining states becomes smaller than threshold value. */
697  if (! skip_stage2) {
698
699   int stage2_round = 0;
700   for (;;) {
701
702     sg_size_t updated_size = 0;
703     if (stage2_round == 0) {
704       /* just after stage1, nothing has been updated. But, we have to send the data updated during stage1 */
705       updated_size = get_updated_size(computed_during_stage1, dp_rate, dp_cap);
706     } else {
707       double computed = lookup_computed_flop_counts(ms->vm, 2, stage2_round);
708       updated_size = get_updated_size(computed, dp_rate, dp_cap);
709     }
710
711     XBT_DEBUG("mig-stage 2:%d updated_size %llu computed_during_stage1 %f dp_rate %f dp_cap %f",
712         stage2_round, updated_size, computed_during_stage1, dp_rate, dp_cap);
713
714     /* Check whether the remaining size is below the threshold value. If so, move to stage 3. */
715     remaining_size += updated_size;
716     XBT_DEBUG("mig-stage2.%d: remaining_size %f (%s threshold %f)", stage2_round,
717         remaining_size, (remaining_size < threshold) ? "<" : ">", threshold);
718     if (remaining_size < threshold)
719       break;
720
721     sg_size_t sent = 0;
722     double clock_prev_send = MSG_get_clock();
723     try {
724       XBT_DEBUG("Stage 2, gonna send %llu", updated_size);
725       sent = send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, updated_size, ms->mbox, 2, stage2_round, mig_speed,
726                                  mig_timeout);
727     }
728     catch (xbt_ex& e) {
729       //hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
730       // Stop the dirty page tracking an return (there is no memory space to release)
731       stop_dirty_page_tracking(ms->vm);
732       return 0;
733     }
734     double clock_post_send = MSG_get_clock();
735
736     if (sent == updated_size) {
737       /* timeout did not happen */
738       double bandwidth = updated_size / (clock_post_send - clock_prev_send);
739       threshold = get_threshold_value(bandwidth, max_downtime);
740       XBT_DEBUG("actual bandwidth %f, threshold %f", bandwidth / 1024 / 1024, threshold);
741       remaining_size -= sent;
742       stage2_round += 1;
743       mig_timeout -= (clock_post_send - clock_prev_send);
744       xbt_assert(mig_timeout > 0);
745
746     } else if (sent < updated_size) {
747       /* When timeout happens, we move to stage 3. The size of memory pages
748        * updated before timeout must be added to the remaining size. */
749       XBT_VERB("mig-stage2.%d: timeout, force moving to stage 3. sent %llu / %llu, eta %lf",
750           stage2_round, sent, updated_size, (clock_post_send - clock_prev_send));
751       remaining_size -= sent;
752
753       double computed = lookup_computed_flop_counts(ms->vm, 2, stage2_round);
754       updated_size = get_updated_size(computed, dp_rate, dp_cap);
755       remaining_size += updated_size;
756       break;
757     } else
758       XBT_CRITICAL("bug");
759   }
760  }
761
762   /* Stage3: stop the VM and copy the rest of states. */
763   XBT_DEBUG("mig-stage3: remaining_size %f", remaining_size);
764   simcall_vm_suspend(ms->vm);
765   stop_dirty_page_tracking(ms->vm);
766
767   try {
768     XBT_DEBUG("Stage 3: Gonna send %f", remaining_size);
769     send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, (sg_size_t)remaining_size, ms->mbox, 3, 0, mig_speed, -1);
770   }
771   catch(xbt_ex& e) {
772     //hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
773     // Stop the dirty page tracking an return (there is no memory space to release)
774     simcall_vm_resume(ms->vm);
775     return 0;
776   }
777
778   // At that point the Migration is considered valid for the SRC node but remind that the DST side should relocate
779   // effectively the VM on the DST node.
780   XBT_DEBUG("mig: tx_done");
781
782   return 0;
783 }
784
785 static int do_migration(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
786 {
787   struct migration_session *ms = xbt_new(struct migration_session, 1);
788   ms->vm = vm;
789   ms->src_pm = src_pm;
790   ms->dst_pm = dst_pm;
791   ms->mbox_ctl = get_mig_mbox_ctl(vm, src_pm, dst_pm);
792   ms->mbox = get_mig_mbox_src_dst(vm, src_pm, dst_pm);
793
794   char *pr_rx_name = get_mig_process_rx_name(vm, src_pm, dst_pm);
795   char *pr_tx_name = get_mig_process_tx_name(vm, src_pm, dst_pm);
796
797 //  msg_process_t tx_process, rx_process; 
798 //  MSG_process_create(pr_rx_name, migration_rx_fun, ms, dst_pm);
799 //  MSG_process_create(pr_tx_name, migration_tx_fun, ms, src_pm);
800 #if 1
801  {
802  char **argv = xbt_new(char *, 2);
803  argv[0] = pr_rx_name;
804  argv[1] = nullptr;
805 /*rx_process = */ MSG_process_create_with_arguments(pr_rx_name, migration_rx_fun, ms, dst_pm, 1, argv);
806  }
807  {
808  char **argv = xbt_new(char *, 2);
809  argv[0] = pr_tx_name;
810  argv[1] = nullptr;
811 /* tx_process = */MSG_process_create_with_arguments(pr_tx_name, migration_tx_fun, ms, src_pm, 1, argv);
812  }
813 #endif
814
815   /* wait until the migration have finished or on error has occurred */
816   {
817     XBT_DEBUG("wait for reception of the final ACK (i.e. migration has been correctly performed");
818     msg_task_t task = nullptr;
819     msg_error_t ret = MSG_TIMEOUT;
820     while (ret == MSG_TIMEOUT && MSG_host_is_on(dst_pm)) //Wait while you receive the message o
821      ret = MSG_task_receive_with_timeout(&task, ms->mbox_ctl, 4);
822
823     xbt_free(ms->mbox_ctl);
824     xbt_free(ms->mbox);
825     xbt_free(ms);
826
827     //xbt_assert(ret == MSG_OK);
828     if(ret == MSG_HOST_FAILURE){
829         // Note that since the communication failed, the owner did not change and the task should be destroyed on the
830         // other side. Hence, just throw the execption
831         XBT_ERROR("SRC crashes, throw an exception (m-control)");
832         //MSG_process_kill(tx_process); // Adrien, I made a merge on Nov 28th 2014, I'm not sure whether this line is
833                                         // required or not
834         return -1; 
835     } 
836     else if((ret == MSG_TRANSFER_FAILURE) || (ret == MSG_TIMEOUT)){
837         // MSG_TIMEOUT here means that MSG_host_is_avail() returned false.
838         XBT_ERROR("DST crashes, throw an exception (m-control)");
839         return -2;  
840     }
841
842     char *expected_task_name = get_mig_task_name(vm, src_pm, dst_pm, 4);
843     xbt_assert(strcmp(task->name, expected_task_name) == 0);
844     xbt_free(expected_task_name);
845     MSG_task_destroy(task);
846     return 0;
847   }
848 }
849
850 /** @brief Migrate the VM to the given host.
851  *  @ingroup msg_VMs
852  *
853  * FIXME: No migration cost occurs. If you want to simulate this too, you want to use a MSG_task_send() before or after,
854  * depending on whether you want to do cold or hot migration.
855  */
856 void MSG_vm_migrate(msg_vm_t vm, msg_host_t new_pm)
857 {
858   /* some thoughts:
859    * - One approach is ...
860    *   We first create a new VM (i.e., destination VM) on the destination   physical host. The destination VM will
861    *   receive the state of the source
862    *   VM over network. We will finally destroy the source VM.
863    *   - This behavior is similar to the way of migration in the real world.
864    *     Even before a migration is completed, we will see a destination VM, consuming resources.
865    *   - We have to relocate all processes. The existing process migration code will work for this?
866    *   - The name of the VM is a somewhat unique ID in the code. It is tricky for the destination VM?
867    *
868    * - Another one is ...
869    *   We update the information of the given VM to place it to the destination physical host.
870    *
871    * The second one would be easier.
872    */
873
874   msg_host_t old_pm = (msg_host_t) simcall_vm_get_pm(vm);
875
876   if(MSG_host_is_off(old_pm))
877     THROWF(vm_error, 0, "SRC host(%s) seems off, cannot start a migration", sg_host_get_name(old_pm));
878
879   if(MSG_host_is_off(new_pm))
880     THROWF(vm_error, 0, "DST host(%s) seems off, cannot start a migration", sg_host_get_name(new_pm));
881
882   if (!MSG_vm_is_running(vm))
883     THROWF(vm_error, 0, "VM(%s) is not running", sg_host_get_name(vm));
884
885   if (MSG_vm_is_migrating(vm))
886     THROWF(vm_error, 0, "VM(%s) is already migrating", sg_host_get_name(vm));
887
888   simgrid::surf::VirtualMachineImpl* pimpl = static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_;
889   pimpl->isMigrating                       = 1;
890
891   {
892     int ret = do_migration(vm, old_pm, new_pm);
893     if (ret == -1){
894       pimpl->isMigrating = 0;
895       THROWF(host_error, 0, "SRC host failed during migration");
896     }
897     else if(ret == -2){
898       pimpl->isMigrating = 0;
899       THROWF(host_error, 0, "DST host failed during migration");
900     }
901   }
902
903   // This part is done in the RX code, to handle the corner case where SRC can crash just at the end of the migration
904   // process. In that case, the VM has been already assigned to the DST node.
905   //XBT_DEBUG("VM(%s) moved from PM(%s) to PM(%s)", vm->key, old_pm->key, new_pm->key);
906   //TRACE_msg_vm_change_host(vm, old_pm, new_pm);
907 }
908
909 /** @brief Immediately suspend the execution of all processes within the given VM.
910  *  @ingroup msg_VMs
911  *
912  * This function stops the execution of the VM. All the processes on this VM
913  * will pause. The state of the VM is preserved. We can later resume it again.
914  *
915  * No suspension cost occurs.
916  */
917 void MSG_vm_suspend(msg_vm_t vm)
918 {
919   if (MSG_vm_is_migrating(vm))
920     THROWF(vm_error, 0, "VM(%s) is migrating", sg_host_get_name(vm));
921
922   simcall_vm_suspend(vm);
923
924   XBT_DEBUG("vm_suspend done");
925
926   if (TRACE_msg_vm_is_enabled()) {
927     container_t vm_container = PJ_container_get(vm->name().c_str());
928     type_t type              = PJ_type_get("MSG_VM_STATE", vm_container->type);
929     val_t value              = PJ_value_get_or_new("suspend", "1 0 0", type); // suspend is red
930     new_pajePushState(MSG_get_clock(), vm_container, type, value);
931   }
932 }
933
934 /** @brief Resume the execution of the VM. All processes on the VM run again.
935  *  @ingroup msg_VMs
936  *
937  * No resume cost occurs.
938  */
939 void MSG_vm_resume(msg_vm_t vm)
940 {
941   simcall_vm_resume(vm);
942
943   if (TRACE_msg_vm_is_enabled()) {
944     container_t vm_container = PJ_container_get(vm->name().c_str());
945     type_t type              = PJ_type_get("MSG_VM_STATE", vm_container->type);
946     new_pajePopState(MSG_get_clock(), vm_container, type);
947   }
948 }
949
950
951 /** @brief Immediately save the execution of all processes within the given VM.
952  *  @ingroup msg_VMs
953  *
954  * This function stops the execution of the VM. All the processes on this VM
955  * will pause. The state of the VM is preserved. We can later resume it again.
956  *
957  * FIXME: No suspension cost occurs. If you want to simulate this too, you want to use a \ref MSG_file_write() before
958  * or after, depending on the exact semantic of VM save to you.
959  */
960 void MSG_vm_save(msg_vm_t vm)
961 {
962   if (MSG_vm_is_migrating(vm))
963     THROWF(vm_error, 0, "VM(%s) is migrating", sg_host_get_name(vm));
964
965   simcall_vm_save(vm);
966
967   if (TRACE_msg_vm_is_enabled()) {
968     container_t vm_container = PJ_container_get(vm->name().c_str());
969     type_t type              = PJ_type_get("MSG_VM_STATE", vm_container->type);
970     val_t value              = PJ_value_get_or_new("save", "0 1 0", type); // save is green
971     new_pajePushState(MSG_get_clock(), vm_container, type, value);
972   }
973 }
974
975 /** @brief Restore the execution of the VM. All processes on the VM run again.
976  *  @ingroup msg_VMs
977  *
978  * FIXME: No restore cost occurs. If you want to simulate this too, you want to use a \ref MSG_file_read() before or
979  * after, depending on the exact semantic of VM restore to you.
980  */
981 void MSG_vm_restore(msg_vm_t vm)
982 {
983   simcall_vm_restore(vm);
984
985   if (TRACE_msg_vm_is_enabled()) {
986     container_t vm_container = PJ_container_get(vm->name().c_str());
987     type_t type              = PJ_type_get("MSG_VM_STATE", vm_container->type);
988     new_pajePopState(MSG_get_clock(), vm_container, type);
989   }
990 }
991
992 /** @brief Get the physical host of a given VM.
993  *  @ingroup msg_VMs
994  */
995 msg_host_t MSG_vm_get_pm(msg_vm_t vm)
996 {
997   return (msg_host_t) simcall_vm_get_pm(vm);
998 }
999
1000 /** @brief Set a CPU bound for a given VM.
1001  *  @ingroup msg_VMs
1002  *
1003  * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
1004  *
1005  * For example,
1006  *  On PM0, there are Task1 and VM0.
1007  *  On VM0, there is Task2.
1008  * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
1009  * Then,
1010  *  Task1\@PM0 gets 50%.
1011  *  Task2\@VM0 gets 25%.
1012  * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
1013  *
1014  * 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
1015  * the dummy CPU action. The bound of the dummy CPU action is unlimited.
1016  *
1017  * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
1018  * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
1019  * on the VM in share_resource() or we have to trap both the start and end of task execution.
1020  *
1021  * The current solution is to use MSG_vm_set_bound(), which allows us to directly set the bound of the dummy CPU action.
1022  *
1023  * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
1024  *    computation task (or a VM) never exceeds the capacity of a CPU core.
1025  */
1026 void MSG_vm_set_bound(msg_vm_t vm, double bound)
1027 {
1028   simcall_vm_set_bound(vm, bound);
1029 }