Logo AND Algorithmique Numérique Distribuée

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