Logo AND Algorithmique Numérique Distribuée

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