Logo AND Algorithmique Numérique Distribuée

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