Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Make hypervisor compile with compile_warnings=ON
[simgrid.git] / src / msg / msg_vm.c
1 /* Copyright (c) 2012. The SimGrid Team. All rights reserved.               */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 // QUESTIONS:
7 // 1./ check how and where a new VM is added to the list of the hosts
8 // 2./ Diff between SIMIX_Actions and SURF_Actions
9 // => SIMIX_actions : point synchro entre processus de niveau (theoretically speaking I do not have to create such SIMIX_ACTION
10 // =>  Surf_Actions
11
12 // TODO
13 //      MSG_TRACE can be revisited in order to use  the host
14 //      To implement a mixed model between workstation and vm_workstation,
15 //     please give a look at surf_model_private_t model_private at SURF Level and to the share resource functions
16 //     double (*share_resources) (double now);
17 //      For the action into the vm workstation model, we should be able to leverage the usual one (and if needed, look at
18 //              the workstation model.
19
20 #include "msg_private.h"
21 #include "xbt/sysdep.h"
22 #include "xbt/log.h"
23
24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_vm, msg,
25                                 "Cloud-oriented parts of the MSG API");
26
27
28 /* **** ******** GENERAL ********* **** */
29
30 /** \ingroup m_vm_management
31  * \brief Returns the value of a given vm property
32  *
33  * \param vm a vm
34  * \param name a property name
35  * \return value of a property (or NULL if property not set)
36  */
37
38 const char *MSG_vm_get_property_value(msg_vm_t vm, const char *name)
39 {
40   return MSG_host_get_property_value(vm, name);
41 }
42
43 /** \ingroup m_vm_management
44  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
45  *
46  * \param vm a vm
47  * \return a dict containing the properties
48  */
49 xbt_dict_t MSG_vm_get_properties(msg_vm_t vm)
50 {
51   xbt_assert((vm != NULL), "Invalid parameters (vm is NULL)");
52
53   return (simcall_host_get_properties(vm));
54 }
55
56 /** \ingroup m_host_management
57  * \brief Change the value of a given host property
58  *
59  * \param host a host
60  * \param name a property name
61  * \param value what to change the property to
62  * \param free_ctn the freeing function to use to kill the value on need
63  */
64 void MSG_vm_set_property_value(msg_vm_t vm, const char *name, void *value, void_f_pvoid_t free_ctn)
65 {
66   xbt_dict_set(MSG_host_get_properties(vm), name, value, free_ctn);
67 }
68
69 /** \ingroup msg_vm_management
70  * \brief Finds a msg_vm_t using its name.
71  *
72  * This is a name directory service
73  * \param name the name of a vm.
74  * \return the corresponding vm
75  *
76  * Please note that a VM is a specific host. Hence, you should give a different name
77  * for each VM/PM.
78  */
79
80 msg_vm_t MSG_vm_get_by_name(const char *name)
81 {
82         return MSG_get_host_by_name(name);
83 }
84
85 /** \ingroup m_vm_management
86  *
87  * \brief Return the name of the #msg_host_t.
88  *
89  * This functions checks whether \a host is a valid pointer or not and return
90    its name.
91  */
92 const char *MSG_vm_get_name(msg_vm_t vm)
93 {
94   return MSG_host_get_name(vm);
95 }
96
97
98 /* **** Check state of a VM **** */
99 static inline int __MSG_vm_is_state(msg_vm_t vm, e_surf_vm_state_t state)
100 {
101   return simcall_vm_get_state(vm) == state;
102 }
103
104 /** @brief Returns whether the given VM has just reated, not running.
105  *  @ingroup msg_VMs
106  */
107 int MSG_vm_is_created(msg_vm_t vm)
108 {
109   return __MSG_vm_is_state(vm, SURF_VM_STATE_CREATED);
110 }
111
112 /** @brief Returns whether the given VM is currently running
113  *  @ingroup msg_VMs
114  */
115 int MSG_vm_is_running(msg_vm_t vm)
116 {
117   return __MSG_vm_is_state(vm, SURF_VM_STATE_RUNNING);
118 }
119
120 /** @brief Returns whether the given VM is currently migrating
121  *  @ingroup msg_VMs
122  */
123 int MSG_vm_is_migrating(msg_vm_t vm)
124 {
125   return __MSG_vm_is_state(vm, SURF_VM_STATE_MIGRATING);
126 }
127
128 /** @brief Returns whether the given VM is currently suspended, not running.
129  *  @ingroup msg_VMs
130  */
131 int MSG_vm_is_suspended(msg_vm_t vm)
132 {
133   return __MSG_vm_is_state(vm, SURF_VM_STATE_SUSPENDED);
134 }
135
136 /** @brief Returns whether the given VM is being saved (FIXME: live saving or not?).
137  *  @ingroup msg_VMs
138  */
139 int MSG_vm_is_saving(msg_vm_t vm)
140 {
141   return __MSG_vm_is_state(vm, SURF_VM_STATE_SAVING);
142 }
143
144 /** @brief Returns whether the given VM has been saved, not running.
145  *  @ingroup msg_VMs
146  */
147 int MSG_vm_is_saved(msg_vm_t vm)
148 {
149   return __MSG_vm_is_state(vm, SURF_VM_STATE_SAVED);
150 }
151
152 /** @brief Returns whether the given VM is being restored, not running.
153  *  @ingroup msg_VMs
154  */
155 int MSG_vm_is_restoring(msg_vm_t vm)
156 {
157   return __MSG_vm_is_state(vm, SURF_VM_STATE_RESTORING);
158 }
159
160
161
162 /* ------------------------------------------------------------------------- */
163 /* ------------------------------------------------------------------------- */
164
165 /* **** ******** MSG vm actions ********* **** */
166
167 /** @brief Create a new VM with specified parameters.
168  *  @ingroup msg_VMs*
169  *
170  */
171 msg_vm_t MSG_vm_create(msg_host_t ind_pm, const char *name,
172                                              int ncpus, long ramsize, long net_cap, char *disk_path, long disksize)
173 {
174   msg_vm_t vm = MSG_vm_create_core(ind_pm, name);
175
176   {
177     s_ws_params_t params;
178     memset(&params, 0, sizeof(params));
179     params.ramsize = ramsize;
180     //params.overcommit = 0;
181     simcall_host_set_params(vm, &params);
182   }
183
184   /* TODO: Limit net capability, take into account disk considerations. */
185
186   return vm;
187 }
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     void *ind_host_tmp = xbt_lib_get_elm_or_null(host_lib, name);
200     if (ind_host_tmp) {
201       XBT_ERROR("host %s already exits", name);
202       return NULL;
203     }
204   }
205
206   /* Note: ind_vm and vm_workstation point to the same elm object. */
207   msg_vm_t ind_vm = NULL;
208   void *ind_vm_workstation =  NULL;
209
210   /* Ask the SIMIX layer to create the surf vm resource */
211   ind_vm_workstation = simcall_vm_create(name, ind_pm);
212   ind_vm = (msg_vm_t) __MSG_host_create(ind_vm_workstation);
213
214   XBT_DEBUG("A new VM (%s) has been created", name);
215
216   #ifdef HAVE_TRACING
217   TRACE_msg_vm_create(name, ind_pm);
218   #endif
219
220   return ind_vm;
221 }
222
223 /** @brief Destroy a VM. Destroy the VM object from the simulation.
224  *  @ingroup msg_VMs
225  */
226 void MSG_vm_destroy(msg_vm_t vm)
227 {
228   /* First, terminate all processes on the VM if necessary */
229   if (MSG_vm_is_running(vm))
230       simcall_vm_shutdown(vm);
231
232   if (!MSG_vm_is_created(vm)) {
233     XBT_CRITICAL("shutdown the given VM before destroying it");
234     DIE_IMPOSSIBLE;
235   }
236
237   /* Then, destroy the VM object */
238   simcall_vm_destroy(vm);
239
240   __MSG_host_destroy(vm);
241
242   #ifdef HAVE_TRACING
243   TRACE_msg_vm_end(vm);
244   #endif
245 }
246
247
248 /** @brief Start a vm (i.e., boot the guest operating system)
249  *  @ingroup msg_VMs
250  *
251  *  If the VM cannot be started, an exception is generated.
252  *
253  */
254 void MSG_vm_start(msg_vm_t vm)
255 {
256   simcall_vm_start(vm);
257
258   #ifdef HAVE_TRACING
259   TRACE_msg_vm_start(vm);
260   #endif
261 }
262
263
264
265 /** @brief Immediately kills all processes within the given VM. Any memory that they allocated will be leaked.
266  *  @ingroup msg_VMs
267  *
268  * FIXME: No extra delay occurs. If you want to simulate this too, you want to
269  * use a #MSG_process_sleep() or something. I'm not quite sure.
270  */
271 void MSG_vm_shutdown(msg_vm_t vm)
272 {
273   /* msg_vm_t equals to msg_host_t */
274   simcall_vm_shutdown(vm);
275
276   // #ifdef HAVE_TRACING
277   // TRACE_msg_vm_(vm);
278   // #endif
279 }
280
281
282
283 /* We have two mailboxes. mbox is used to transfer migration data between
284  * source and destiantion PMs. mbox_ctl is used to detect the completion of a
285  * migration. The names of these mailboxes must not conflict with others. */
286 static inline char *get_mig_mbox_src_dst(const char *vm_name, const char *src_pm_name, const char *dst_pm_name)
287 {
288   return bprintf("__mbox_mig_src_dst:%s(%s-%s)", vm_name, src_pm_name, dst_pm_name);
289 }
290
291 static inline char *get_mig_mbox_ctl(const char *vm_name, const char *src_pm_name, const char *dst_pm_name)
292 {
293   return bprintf("__mbox_mig_ctl:%s(%s-%s)", vm_name, src_pm_name, dst_pm_name);
294 }
295
296 static inline char *get_mig_process_tx_name(const char *vm_name, const char *src_pm_name, const char *dst_pm_name)
297 {
298   return bprintf("__pr_mig_tx:%s(%s-%s)", vm_name, src_pm_name, dst_pm_name);
299 }
300
301 static inline char *get_mig_process_rx_name(const char *vm_name, const char *src_pm_name, const char *dst_pm_name)
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(const char *vm_name, const char *src_pm_name, const char *dst_pm_name, int stage)
307 {
308   return bprintf("__task_mig_stage%d:%s(%s-%s)", stage, vm_name, src_pm_name, dst_pm_name);
309 }
310
311 static int migration_rx_fun(int argc, char *argv[])
312 {
313   XBT_DEBUG("mig: rx_start");
314
315   xbt_assert(argc == 4);
316   const char *vm_name = argv[1];
317   const char *src_pm_name  = argv[2];
318   const char *dst_pm_name  = argv[3];
319   msg_vm_t vm = MSG_get_host_by_name(vm_name);
320   msg_vm_t dst_pm = MSG_get_host_by_name(dst_pm_name);
321
322   int need_exit = 0;
323
324   char *mbox = get_mig_mbox_src_dst(vm_name, src_pm_name, dst_pm_name);
325   char *mbox_ctl = get_mig_mbox_ctl(vm_name, src_pm_name, dst_pm_name);
326   char *finalize_task_name = get_mig_task_name(vm_name, src_pm_name, dst_pm_name, 3);
327
328   for (;;) {
329     msg_task_t task = NULL;
330     MSG_task_recv(&task, mbox);
331
332     if (strcmp(task->name, finalize_task_name) == 0)
333       need_exit = 1;
334
335     MSG_task_destroy(task);
336
337     if (need_exit)
338       break;
339   }
340
341
342   simcall_vm_migrate(vm, dst_pm);
343   simcall_vm_resume(vm);
344
345   {
346     char *task_name = get_mig_task_name(vm_name, src_pm_name, dst_pm_name, 4);
347
348     msg_task_t task = MSG_task_create(task_name, 0, 0, NULL);
349     msg_error_t ret = MSG_task_send(task, mbox_ctl);
350     xbt_assert(ret == MSG_OK);
351
352     xbt_free(task_name);
353   }
354
355
356   xbt_free(mbox);
357   xbt_free(mbox_ctl);
358   xbt_free(finalize_task_name);
359
360   XBT_DEBUG("mig: rx_done");
361
362   return 0;
363 }
364
365 static void reset_dirty_pages(msg_vm_t vm)
366 {
367   msg_host_priv_t priv = msg_host_resource_priv(vm);
368
369   char *key = NULL;
370   xbt_dict_cursor_t cursor = NULL;
371   dirty_page_t dp = NULL;
372   xbt_dict_foreach(priv->dp_objs, cursor, key, dp) {
373     double remaining = MSG_task_get_remaining_computation(dp->task);
374     dp->prev_clock = MSG_get_clock();
375     dp->prev_remaining = remaining;
376
377     // XBT_INFO("%s@%s remaining %f", key, sg_host_name(vm), remaining);
378   }
379 }
380
381 static void start_dirty_page_tracking(msg_vm_t vm)
382 {
383   msg_host_priv_t priv = msg_host_resource_priv(vm);
384   priv->dp_enabled = 1;
385
386   reset_dirty_pages(vm);
387 }
388
389 static void stop_dirty_page_tracking(msg_vm_t vm)
390 {
391   msg_host_priv_t priv = msg_host_resource_priv(vm);
392   priv->dp_enabled = 0;
393 }
394
395 #if 0
396 /* It might be natural that we define dp_rate for each task. But, we will also
397  * have to care about how each task behavior affects the memory update behavior
398  * at the operating system level. It may not be easy to model it with a simple algorithm. */
399 double calc_updated_pages(char *key, msg_vm_t vm, dirty_page_t dp, double remaining, double clock)
400 {
401     double computed = dp->prev_remaining - remaining;
402     double duration = clock - dp->prev_clock;
403     double updated = dp->task->dp_rate * computed;
404
405     XBT_INFO("%s@%s: computated %f ops (remaining %f -> %f) in %f secs (%f -> %f)",
406         key, sg_host_name(vm), computed, dp->prev_remaining, remaining, duration, dp->prev_clock, clock);
407     XBT_INFO("%s@%s: updated %f bytes, %f Mbytes/s",
408         key, sg_host_name(vm), updated, updated / duration / 1000 / 1000);
409
410     return updated;
411 }
412 #endif
413
414 double get_computed(char *key, msg_vm_t vm, dirty_page_t dp, double remaining, double clock)
415 {
416   double computed = dp->prev_remaining - remaining;
417   double duration = clock - dp->prev_clock;
418
419   XBT_DEBUG("%s@%s: computated %f ops (remaining %f -> %f) in %f secs (%f -> %f)",
420       key, sg_host_name(vm), computed, dp->prev_remaining, remaining, duration, dp->prev_clock, clock);
421
422   return computed;
423 }
424
425 static double lookup_computed_flop_counts(msg_vm_t vm, int stage2_round_for_fancy_debug)
426 {
427   msg_host_priv_t priv = msg_host_resource_priv(vm);
428   double total = 0;
429
430   char *key = NULL;
431   xbt_dict_cursor_t cursor = NULL;
432   dirty_page_t dp = NULL;
433   xbt_dict_foreach(priv->dp_objs, cursor, key, dp) {
434     double remaining = MSG_task_get_remaining_computation(dp->task);
435     double clock = MSG_get_clock();
436
437     // total += calc_updated_pages(key, vm, dp, remaining, clock);
438     total += get_computed(key, vm, dp, remaining, clock);
439
440     dp->prev_remaining = remaining;
441     dp->prev_clock = clock;
442   }
443
444   total += priv->dp_updated_by_deleted_tasks;
445
446   XBT_INFO("mig-stage2.%d: computed %f flop_counts (including %f by deleted tasks)",
447       stage2_round_for_fancy_debug,
448       total, priv->dp_updated_by_deleted_tasks);
449
450
451
452   priv->dp_updated_by_deleted_tasks = 0;
453
454
455   return total;
456 }
457
458 // TODO Is this code redundant with the information provided by
459 // msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
460 void MSG_host_add_task(msg_host_t host, msg_task_t task)
461 {
462   msg_host_priv_t priv = msg_host_resource_priv(host);
463   double remaining = MSG_task_get_remaining_computation(task);
464   char *key = bprintf("%s-%lld", task->name, task->counter);
465
466   dirty_page_t dp = xbt_new0(s_dirty_page, 1);
467   dp->task = task;
468
469   /* It should be okay that we add a task onto a migrating VM. */
470   if (priv->dp_enabled) {
471     dp->prev_clock = MSG_get_clock();
472     dp->prev_remaining = remaining;
473   }
474
475   xbt_assert(xbt_dict_get_or_null(priv->dp_objs, key) == NULL);
476   xbt_dict_set(priv->dp_objs, key, dp, NULL);
477   XBT_DEBUG("add %s on %s (remaining %f, dp_enabled %d)", key, sg_host_name(host), remaining, priv->dp_enabled);
478
479   xbt_free(key);
480 }
481
482 void MSG_host_del_task(msg_host_t host, msg_task_t task)
483 {
484   msg_host_priv_t priv = msg_host_resource_priv(host);
485
486   char *key = bprintf("%s-%lld", task->name, task->counter);
487
488   dirty_page_t dp = xbt_dict_get_or_null(priv->dp_objs, key);
489   xbt_assert(dp->task == task);
490
491   /* If we are in the middle of dirty page tracking, we record how much
492    * computaion has been done until now, and keep the information for the
493    * lookup_() function that will called soon. */
494   if (priv->dp_enabled) {
495     double remaining = MSG_task_get_remaining_computation(task);
496     double clock = MSG_get_clock();
497     // double updated = calc_updated_pages(key, host, dp, remaining, clock);
498     double updated = get_computed(key, host, dp, remaining, clock);
499
500     priv->dp_updated_by_deleted_tasks += updated;
501   }
502
503   xbt_dict_remove(priv->dp_objs, key);
504   xbt_free(dp);
505
506   XBT_DEBUG("del %s on %s", key, sg_host_name(host));
507
508   xbt_free(key);
509 }
510
511
512 static void send_migration_data(const char *vm_name, const char *src_pm_name, const char *dst_pm_name,
513     double size, char *mbox, int stage, int stage2_round, double mig_speed)
514 {
515   char *task_name = get_mig_task_name(vm_name, src_pm_name, dst_pm_name, stage);
516   msg_task_t task = MSG_task_create(task_name, 0, size, NULL);
517
518   msg_error_t ret;
519   if (mig_speed > 0)
520     ret = MSG_task_send_bounded(task, mbox, mig_speed);
521   else
522     ret = MSG_task_send(task, mbox);
523   xbt_assert(ret == MSG_OK);
524
525   if (stage == 2)
526     XBT_INFO("mig-stage%d.%d: sent %f", stage, stage2_round, size);
527   else
528     XBT_INFO("mig-stage%d: sent %f", stage, size);
529
530   xbt_free(task_name);
531 }
532
533
534 static int migration_tx_fun(int argc, char *argv[])
535 {
536   XBT_DEBUG("mig: tx_start");
537
538   xbt_assert(argc == 4);
539   const char *vm_name = argv[1];
540   const char *src_pm_name  = argv[2];
541   const char *dst_pm_name  = argv[3];
542   msg_vm_t vm = MSG_get_host_by_name(vm_name);
543
544
545   s_ws_params_t params;
546   simcall_host_get_params(vm, &params);
547   const long ramsize        = params.ramsize;
548   const long devsize        = params.devsize;
549   const int skip_stage2     = params.skip_stage2;
550   const double dp_rate      = params.dp_rate;
551   const double dp_cap       = params.dp_cap;
552   const double mig_speed    = params.mig_speed;
553   double remaining_size = ramsize + devsize;
554
555   double max_downtime = params.max_downtime;
556   if (max_downtime == 0) {
557     XBT_WARN("use the default max_downtime value 30ms");
558     max_downtime = 0.03;
559   }
560
561   double threshold = max_downtime * 125 * 1024 * 1024;
562
563   /* setting up parameters has done */
564
565
566   if (ramsize == 0)
567     XBT_WARN("migrate a VM, but ramsize is zero");
568
569   char *mbox = get_mig_mbox_src_dst(vm_name, src_pm_name, dst_pm_name);
570
571   XBT_INFO("mig-stage1: remaining_size %f", remaining_size);
572
573   /* Stage1: send all memory pages to the destination. */
574   start_dirty_page_tracking(vm);
575
576   send_migration_data(vm_name, src_pm_name, dst_pm_name, ramsize, mbox, 1, 0, mig_speed);
577
578   remaining_size -= ramsize;
579
580
581
582   /* Stage2: send update pages iteratively until the size of remaining states
583    * becomes smaller than the threshold value. */
584   if (skip_stage2)
585     goto stage3;
586   if (max_downtime == 0) {
587     XBT_WARN("no max_downtime parameter, skip stage2");
588     goto stage3;
589   }
590
591
592   int stage2_round = 0;
593   for (;;) {
594     // long updated_size = lookup_dirty_pages(vm);
595     double updated_size = lookup_computed_flop_counts(vm, stage2_round) * dp_rate;
596     if (updated_size > dp_cap) {
597       XBT_INFO("mig-stage2.%d: %f bytes updated, but cap it with the working set size %f",
598           stage2_round, updated_size, dp_cap);
599       updated_size = dp_cap;
600     }
601
602     remaining_size += updated_size;
603
604     XBT_INFO("mig-stage2.%d: remaining_size %f (%s threshold %f)", stage2_round,
605         remaining_size, (remaining_size < threshold) ? "<" : ">", threshold);
606
607     if (remaining_size < threshold)
608       break;
609
610     send_migration_data(vm_name, src_pm_name, dst_pm_name, updated_size, mbox, 2, stage2_round, mig_speed);
611
612     remaining_size -= updated_size;
613     stage2_round += 1;
614   }
615
616
617 stage3:
618   /* Stage3: stop the VM and copy the rest of states. */
619   XBT_INFO("mig-stage3: remaining_size %f", remaining_size);
620   simcall_vm_suspend(vm);
621   stop_dirty_page_tracking(vm);
622
623   send_migration_data(vm_name, src_pm_name, dst_pm_name, remaining_size, mbox, 3, 0, mig_speed);
624
625   xbt_free(mbox);
626
627   XBT_DEBUG("mig: tx_done");
628
629   return 0;
630 }
631
632
633
634 static void do_migration(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
635 {
636   char *mbox_ctl = get_mig_mbox_ctl(sg_host_name(vm), sg_host_name(src_pm), sg_host_name(dst_pm));
637
638   {
639     char *pr_name = get_mig_process_rx_name(sg_host_name(vm), sg_host_name(src_pm), sg_host_name(dst_pm));
640     int nargvs = 5;
641     char **argv = xbt_new(char *, nargvs);
642     argv[0] = xbt_strdup(pr_name);
643     argv[1] = xbt_strdup(sg_host_name(vm));
644     argv[2] = xbt_strdup(sg_host_name(src_pm));
645     argv[3] = xbt_strdup(sg_host_name(dst_pm));
646     argv[4] = NULL;
647
648     MSG_process_create_with_arguments(pr_name, migration_rx_fun, NULL, dst_pm, nargvs - 1, argv);
649
650     xbt_free(pr_name);
651   }
652
653   {
654     char *pr_name = get_mig_process_tx_name(sg_host_name(vm), sg_host_name(src_pm), sg_host_name(dst_pm));
655     int nargvs = 5;
656     char **argv = xbt_new(char *, nargvs);
657     argv[0] = xbt_strdup(pr_name);
658     argv[1] = xbt_strdup(sg_host_name(vm));
659     argv[2] = xbt_strdup(sg_host_name(src_pm));
660     argv[3] = xbt_strdup(sg_host_name(dst_pm));
661     argv[4] = NULL;
662     MSG_process_create_with_arguments(pr_name, migration_tx_fun, NULL, src_pm, nargvs - 1, argv);
663
664     xbt_free(pr_name);
665   }
666
667   /* wait until the migration have finished */
668   {
669     msg_task_t task = NULL;
670     msg_error_t ret = MSG_task_recv(&task, mbox_ctl);
671     xbt_assert(ret == MSG_OK);
672
673     char *expected_task_name = get_mig_task_name(sg_host_name(vm), sg_host_name(src_pm), sg_host_name(dst_pm), 4);
674     xbt_assert(strcmp(task->name, expected_task_name) == 0);
675     xbt_free(expected_task_name);
676   }
677
678   xbt_free(mbox_ctl);
679 }
680
681
682 /** @brief Migrate the VM to the given host.
683  *  @ingroup msg_VMs
684  *
685  * FIXME: No migration cost occurs. If you want to simulate this too, you want to use a
686  * MSG_task_send() before or after, depending on whether you want to do cold or hot
687  * migration.
688  */
689 void MSG_vm_migrate(msg_vm_t vm, msg_host_t new_pm)
690 {
691   /* some thoughts:
692    * - One approach is ...
693    *   We first create a new VM (i.e., destination VM) on the destination
694    *   physical host. The destination VM will receive the state of the source
695    *   VM over network. We will finally destroy the source VM.
696    *   - This behavior is similar to the way of migration in the real world.
697    *     Even before a migration is completed, we will see a destination VM,
698    *     consuming resources.
699    *   - We have to relocate all processes. The existing process migraion code
700    *     will work for this?
701    *   - The name of the VM is a somewhat unique ID in the code. It is tricky
702    *     for the destination VM?
703    *
704    * - Another one is ...
705    *   We update the information of the given VM to place it to the destination
706    *   physical host.
707    *
708    * The second one would be easier.
709    *   
710    */
711
712   msg_host_t old_pm = simcall_vm_get_pm(vm);
713
714   if (simcall_vm_get_state(vm) != SURF_VM_STATE_RUNNING)
715     THROWF(vm_error, 0, "VM(%s) is not running", sg_host_name(vm));
716
717   do_migration(vm, old_pm, new_pm);
718
719
720
721   XBT_DEBUG("VM(%s) moved from PM(%s) to PM(%s)", vm->key, old_pm->key, new_pm->key);
722
723   #ifdef HAVE_TRACING
724   TRACE_msg_vm_change_host(vm, old_pm, new_pm);
725   #endif
726 }
727
728
729 /** @brief Immediately suspend the execution of all processes within the given VM.
730  *  @ingroup msg_VMs
731  *
732  * This function stops the exection of the VM. All the processes on this VM
733  * will pause. The state of the VM is perserved. We can later resume it again.
734  *
735  * No suspension cost occurs.
736  */
737 void MSG_vm_suspend(msg_vm_t vm)
738 {
739   simcall_vm_suspend(vm);
740
741   XBT_DEBUG("vm_suspend done");
742
743   #ifdef HAVE_TRACING
744   TRACE_msg_vm_suspend(vm);
745   #endif
746 }
747
748
749 /** @brief Resume the execution of the VM. All processes on the VM run again.
750  *  @ingroup msg_VMs
751  *
752  * No resume cost occurs.
753  */
754 void MSG_vm_resume(msg_vm_t vm)
755 {
756   simcall_vm_resume(vm);
757
758   #ifdef HAVE_TRACING
759   TRACE_msg_vm_resume(vm);
760   #endif
761 }
762
763
764 /** @brief Immediately save the execution of all processes within the given VM.
765  *  @ingroup msg_VMs
766  *
767  * This function stops the exection of the VM. All the processes on this VM
768  * will pause. The state of the VM is perserved. We can later resume it again.
769  *
770  * FIXME: No suspension cost occurs. If you want to simulate this too, you want to
771  * use a \ref MSG_file_write() before or after, depending on the exact semantic
772  * of VM save to you.
773  */
774 void MSG_vm_save(msg_vm_t vm)
775 {
776   simcall_vm_save(vm);
777   #ifdef HAVE_TRACING
778   TRACE_msg_vm_save(vm);
779   #endif
780 }
781
782 /** @brief Restore the execution of the VM. All processes on the VM run again.
783  *  @ingroup msg_VMs
784  *
785  * FIXME: No restore cost occurs. If you want to simulate this too, you want to
786  * use a \ref MSG_file_read() before or after, depending on the exact semantic
787  * of VM restore to you.
788  */
789 void MSG_vm_restore(msg_vm_t vm)
790 {
791   simcall_vm_restore(vm);
792
793   #ifdef HAVE_TRACING
794   TRACE_msg_vm_restore(vm);
795   #endif
796 }
797
798
799
800
801 /** @brief Get the physical host of a given VM.
802  *  @ingroup msg_VMs
803  */
804 msg_host_t MSG_vm_get_pm(msg_vm_t vm)
805 {
806   return simcall_vm_get_pm(vm);
807 }