Logo AND Algorithmique Numérique Distribuée

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