Logo AND Algorithmique Numérique Distribuée

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