1 /* Copyright (c) 2012-2015. The SimGrid Team.
2 * All rights reserved. */
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. */
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
14 #include "src/surf/VirtualMachineImpl.hpp"
15 #include <simgrid/s4u/VirtualMachine.hpp>
16 #include <simgrid/s4u/host.hpp>
18 #include "msg_private.h"
19 #include "xbt/sysdep.h"
21 #include "simgrid/host.h"
23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_vm, msg, "Cloud-oriented parts of the MSG API");
26 /* **** ******** GENERAL ********* **** */
27 /** \ingroup m_vm_management
28 * \brief Returns the value of a given vm property
31 * \param name a property name
32 * \return value of a property (or nullptr if property not set)
34 const char *MSG_vm_get_property_value(msg_vm_t vm, const char *name)
36 return MSG_host_get_property_value(vm, name);
39 /** \ingroup m_vm_management
40 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
43 * \return a dict containing the properties
45 xbt_dict_t MSG_vm_get_properties(msg_vm_t vm)
47 xbt_assert((vm != nullptr), "Invalid parameters (vm is nullptr)");
48 return vm->properties();
51 /** \ingroup m_host_management
52 * \brief Change the value of a given host property
55 * \param name a property name
56 * \param value what to change the property to
57 * \param free_ctn the freeing function to use to kill the value on need
59 void MSG_vm_set_property_value(msg_vm_t vm, const char *name, void *value, void_f_pvoid_t free_ctn)
61 xbt_dict_set(MSG_host_get_properties(vm), name, value, free_ctn);
63 /** \ingroup m_vm_management
64 * \brief Set the parameters of a given host
67 * \param params a parameter object
69 void MSG_vm_set_params(msg_vm_t vm, vm_params_t params)
71 static_cast<simgrid::s4u::VirtualMachine*>(vm)->setParameters(params);
74 /** \ingroup m_vm_management
75 * \brief Get the parameters of a given host
78 * \param params a prameter object
80 void MSG_vm_get_params(msg_vm_t vm, vm_params_t params)
82 static_cast<simgrid::s4u::VirtualMachine*>(vm)->parameters(params);
85 /** \ingroup msg_vm_management
86 * \brief Finds a msg_vm_t using its name.
88 * This is a name directory service
89 * \param name the name of a vm.
90 * \return the corresponding vm
92 * Please note that a VM is a specific host. Hence, you should give a different name for each VM/PM.
94 msg_vm_t MSG_vm_get_by_name(const char *name)
96 return MSG_host_by_name(name);
99 /** \ingroup m_vm_management
101 * \brief Return the name of the #msg_host_t.
103 * This functions checks whether \a host is a valid pointer or not and return its name.
105 const char *MSG_vm_get_name(msg_vm_t vm)
107 return MSG_host_get_name(vm);
110 /* **** Check state of a VM **** */
111 static inline int __MSG_vm_is_state(msg_vm_t vm, e_surf_vm_state_t state)
113 return simcall_vm_get_state(vm) == state;
116 /** @brief Returns whether the given VM has just created, not running.
119 int MSG_vm_is_created(msg_vm_t vm)
121 return __MSG_vm_is_state(vm, SURF_VM_STATE_CREATED);
124 /** @brief Returns whether the given VM is currently running
127 int MSG_vm_is_running(msg_vm_t vm)
129 return __MSG_vm_is_state(vm, SURF_VM_STATE_RUNNING);
132 /** @brief Returns whether the given VM is currently migrating
135 int MSG_vm_is_migrating(msg_vm_t vm)
137 return static_cast<simgrid::s4u::VirtualMachine*>(vm)->isMigrating();
140 /** @brief Returns whether the given VM is currently suspended, not running.
143 int MSG_vm_is_suspended(msg_vm_t vm)
145 return __MSG_vm_is_state(vm, SURF_VM_STATE_SUSPENDED);
148 /** @brief Returns whether the given VM is being saved (FIXME: live saving or not?).
151 int MSG_vm_is_saving(msg_vm_t vm)
153 return __MSG_vm_is_state(vm, SURF_VM_STATE_SAVING);
156 /** @brief Returns whether the given VM has been saved, not running.
159 int MSG_vm_is_saved(msg_vm_t vm)
161 return __MSG_vm_is_state(vm, SURF_VM_STATE_SAVED);
164 /** @brief Returns whether the given VM is being restored, not running.
167 int MSG_vm_is_restoring(msg_vm_t vm)
169 return __MSG_vm_is_state(vm, SURF_VM_STATE_RESTORING);
172 /* **** ******** MSG vm actions ********* **** */
173 /** @brief Create a new VM with specified parameters.
175 * @param pm Physical machine that will host the VM
177 * @param ncpus [TODO]
178 * @param ramsize [TODO]
179 * @param net_cap Maximal bandwidth that the VM can consume (in MByte/s)
180 * @param disk_path (unused) Path to the image that boots
181 * @param disksize (unused) will represent the size of the VM (will be used during migrations)
182 * @param mig_netspeed Amount of Mbyte/s allocated to the migration (cannot be larger than net_cap). Use 0 if unsure.
183 * @param dp_intensity Dirty page percentage according to migNetSpeed, [0-100]. Use 0 if unsure.
185 msg_vm_t MSG_vm_create(msg_host_t pm, const char *name, int ncpus, int ramsize, int net_cap, char *disk_path,
186 int disksize, int mig_netspeed, int dp_intensity)
188 /* For the moment, intensity_rate is the percentage against the migration
190 double host_speed = MSG_host_get_speed(pm);
191 double update_speed = ((double)dp_intensity/100) * mig_netspeed;
193 msg_vm_t vm = MSG_vm_create_core(pm, name);
194 s_vm_params_t params;
195 memset(¶ms, 0, sizeof(params));
196 params.ramsize = (sg_size_t)ramsize * 1024 * 1024;
197 //params.overcommit = 0;
199 params.skip_stage2 = 0;
200 params.max_downtime = 0.03;
201 params.dp_rate = (update_speed * 1024 * 1024) / host_speed;
202 params.dp_cap = params.ramsize * 0.9; // assume working set memory is 90% of ramsize
203 params.mig_speed = (double)mig_netspeed * 1024 * 1024; // mig_speed
205 //XBT_INFO("dp rate %f migspeed : %f intensity mem : %d, updatespeed %f, hostspeed %f",params.dp_rate,
206 // params.mig_speed, dp_intensity, update_speed, host_speed);
207 static_cast<simgrid::s4u::VirtualMachine*>(vm)->setParameters(¶ms);
212 /** @brief Create a new VM object. The VM is not yet started. The resource of the VM is allocated upon MSG_vm_start().
215 * A VM is treated as a host. The name of the VM must be unique among all hosts.
217 msg_vm_t MSG_vm_create_core(msg_host_t ind_pm, const char *name)
219 /* make sure the VM of the same name does not exit */
221 simgrid::s4u::Host* ind_host_tmp = sg_host_by_name(name);
222 if (ind_host_tmp != nullptr && sg_host_simix(ind_host_tmp) != nullptr) {
223 XBT_ERROR("host %s already exits", name);
228 /* Note: ind_vm and vm_workstation point to the same elm object. */
229 /* Ask the SIMIX layer to create the surf vm resource */
230 sg_host_t ind_vm_workstation = simcall_vm_create(name, ind_pm);
232 msg_vm_t ind_vm = (msg_vm_t) __MSG_host_create(ind_vm_workstation);
234 XBT_DEBUG("A new VM (%s) has been created", name);
236 TRACE_msg_vm_create(name, ind_pm);
241 /** @brief Destroy a VM. Destroy the VM object from the simulation.
244 void MSG_vm_destroy(msg_vm_t vm)
246 if (MSG_vm_is_migrating(vm))
247 THROWF(vm_error, 0, "VM(%s) is migrating", sg_host_get_name(vm));
249 /* First, terminate all processes on the VM if necessary */
250 if (MSG_vm_is_running(vm))
251 simcall_vm_shutdown(vm);
253 if (!MSG_vm_is_created(vm)) {
254 XBT_CRITICAL("shutdown the given VM before destroying it");
258 /* Then, destroy the VM object */
259 simcall_vm_destroy(vm);
261 TRACE_msg_vm_end(vm);
264 /** @brief Start a vm (i.e., boot the guest operating system)
267 * If the VM cannot be started, an exception is generated.
269 void MSG_vm_start(msg_vm_t vm)
271 simcall_vm_start(vm);
273 TRACE_msg_vm_start(vm);
276 /** @brief Immediately kills all processes within the given VM. Any memory that they allocated will be leaked.
279 * FIXME: No extra delay occurs. If you want to simulate this too, you want to use a #MSG_process_sleep() or something.
280 * I'm not quite sure.
282 void MSG_vm_shutdown(msg_vm_t vm)
284 /* msg_vm_t equals to msg_host_t */
285 simcall_vm_shutdown(vm);
287 // TRACE_msg_vm_(vm);
290 /* We have two mailboxes. mbox is used to transfer migration data between source and destination PMs. mbox_ctl is used
291 * to detect the completion of a migration. The names of these mailboxes must not conflict with others. */
292 static inline char *get_mig_mbox_src_dst(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
294 const char *vm_name = sg_host_get_name(vm);
295 const char *src_pm_name = sg_host_get_name(src_pm);
296 const char *dst_pm_name = sg_host_get_name(dst_pm);
298 return bprintf("__mbox_mig_src_dst:%s(%s-%s)", vm_name, src_pm_name, dst_pm_name);
301 static inline char *get_mig_mbox_ctl(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
303 const char *vm_name = sg_host_get_name(vm);
304 const char *src_pm_name = sg_host_get_name(src_pm);
305 const char *dst_pm_name = sg_host_get_name(dst_pm);
307 return bprintf("__mbox_mig_ctl:%s(%s-%s)", vm_name, src_pm_name, dst_pm_name);
310 static inline char *get_mig_process_tx_name(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
312 const char *vm_name = sg_host_get_name(vm);
313 const char *src_pm_name = sg_host_get_name(src_pm);
314 const char *dst_pm_name = sg_host_get_name(dst_pm);
316 return bprintf("__pr_mig_tx:%s(%s-%s)", vm_name, src_pm_name, dst_pm_name);
319 static inline char *get_mig_process_rx_name(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
321 const char *vm_name = sg_host_get_name(vm);
322 const char *src_pm_name = sg_host_get_name(src_pm);
323 const char *dst_pm_name = sg_host_get_name(dst_pm);
325 return bprintf("__pr_mig_rx:%s(%s-%s)", vm_name, src_pm_name, dst_pm_name);
328 static inline char *get_mig_task_name(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm, int stage)
330 const char *vm_name = sg_host_get_name(vm);
331 const char *src_pm_name = sg_host_get_name(src_pm);
332 const char *dst_pm_name = sg_host_get_name(dst_pm);
334 return bprintf("__task_mig_stage%d:%s(%s-%s)", stage, vm_name, src_pm_name, dst_pm_name);
337 struct migration_session {
342 /* The miration_rx process uses mbox_ctl to let the caller of do_migration()
343 * know the completion of the migration. */
345 /* The migration_rx and migration_tx processes use mbox to transfer migration data. */
349 static int migration_rx_fun(int argc, char *argv[])
351 XBT_DEBUG("mig: rx_start");
353 // The structure has been created in the do_migration function and should only be freed in the same place ;)
354 struct migration_session *ms = (migration_session *) MSG_process_get_data(MSG_process_self());
356 s_vm_params_t params;
357 static_cast<simgrid::s4u::VirtualMachine*>(ms->vm)->parameters(¶ms);
361 char *finalize_task_name = get_mig_task_name(ms->vm, ms->src_pm, ms->dst_pm, 3);
365 msg_task_t task = nullptr;
366 ret = MSG_task_recv(&task, ms->mbox);
369 // An error occurred, clean the code and return
370 // The owner did not change, hence the task should be only destroyed on the other side
371 xbt_free(finalize_task_name);
376 if (strcmp(task->name, finalize_task_name) == 0)
379 MSG_task_destroy(task);
385 // Here Stage 1, 2 and 3 have been performed.
386 // Hence complete the migration
388 // Copy the reference to the vm (if SRC crashes now, do_migration will free ms)
389 // This is clearly ugly but I (Adrien) need more time to do something cleaner (actually we should copy the whole ms
390 // structure at the beginning and free it at the end of each function)
391 simgrid::s4u::VirtualMachine* vm = static_cast<simgrid::s4u::VirtualMachine*>(ms->vm);
392 msg_host_t src_pm = ms->src_pm;
393 msg_host_t dst_pm = ms->dst_pm;
395 // TODO: we have an issue, if the DST node is turning off during the three next calls, then the VM is in an
397 // state. I should check with Takahiro in order to make this portion of code atomic
399 // /* Update the vm location */
400 // simcall_vm_migrate(vm, dst_pm);
402 // /* Resume the VM */
403 // simcall_vm_resume(vm);
405 simcall_vm_migratefrom_resumeto(vm, src_pm, dst_pm);
408 // Now the VM is running on the new host (the migration is completed) (even if the SRC crash)
409 static_cast<simgrid::surf::VirtualMachineImpl*>(vm->pimpl_)->isMigrating = false;
410 XBT_DEBUG("VM(%s) moved from PM(%s) to PM(%s)", sg_host_get_name(ms->vm), sg_host_get_name(ms->src_pm),
411 sg_host_get_name(ms->dst_pm));
412 TRACE_msg_vm_change_host(ms->vm, ms->src_pm, ms->dst_pm);
414 // Inform the SRC that the migration has been correctly performed
416 char *task_name = get_mig_task_name(ms->vm, ms->src_pm, ms->dst_pm, 4);
417 msg_task_t task = MSG_task_create(task_name, 0, 0, nullptr);
418 msg_error_t ret = MSG_task_send(task, ms->mbox_ctl);
419 // xbt_assert(ret == MSG_OK);
420 if(ret == MSG_HOST_FAILURE){
421 // The DST has crashed, this is a problem has the VM since we are not sure whether SRC is considering that the VM
422 // has been correctly migrated on the DST node
423 // TODO What does it mean ? What should we do ?
424 MSG_task_destroy(task);
425 } else if(ret == MSG_TRANSFER_FAILURE){
426 // The SRC has crashed, this is not a problem has the VM has been correctly migrated on the DST node
427 MSG_task_destroy(task);
432 xbt_free(finalize_task_name);
434 XBT_DEBUG("mig: rx_done");
438 static void reset_dirty_pages(msg_vm_t vm)
440 simgrid::surf::VirtualMachineImpl* pimpl = static_cast<simgrid::surf::VirtualMachineImpl*>(vm->pimpl_);
443 xbt_dict_cursor_t cursor = nullptr;
444 dirty_page_t dp = nullptr;
447 xbt_dict_foreach (pimpl->dp_objs, cursor, key, dp) {
448 double remaining = MSG_task_get_flops_amount(dp->task);
449 dp->prev_clock = MSG_get_clock();
450 dp->prev_remaining = remaining;
452 // XBT_INFO("%s@%s remaining %f", key, sg_host_name(vm), remaining);
456 static void start_dirty_page_tracking(msg_vm_t vm)
458 simgrid::surf::VirtualMachineImpl* pimpl = static_cast<simgrid::surf::VirtualMachineImpl*>(vm->pimpl_);
459 pimpl->dp_enabled = 1;
461 reset_dirty_pages(vm);
464 static void stop_dirty_page_tracking(msg_vm_t vm)
466 simgrid::surf::VirtualMachineImpl* pimpl = static_cast<simgrid::surf::VirtualMachineImpl*>(vm->pimpl_);
467 pimpl->dp_enabled = 0;
470 static double get_computed(char *key, msg_vm_t vm, dirty_page_t dp, double remaining, double clock)
472 double computed = dp->prev_remaining - remaining;
473 double duration = clock - dp->prev_clock;
475 XBT_DEBUG("%s@%s: computed %f ops (remaining %f -> %f) in %f secs (%f -> %f)",
476 key, sg_host_get_name(vm), computed, dp->prev_remaining, remaining, duration, dp->prev_clock, clock);
481 static double lookup_computed_flop_counts(msg_vm_t vm, int stage_for_fancy_debug, int stage2_round_for_fancy_debug)
483 simgrid::surf::VirtualMachineImpl* pimpl = static_cast<simgrid::surf::VirtualMachineImpl*>(vm->pimpl_);
487 xbt_dict_cursor_t cursor = nullptr;
488 dirty_page_t dp = nullptr;
489 xbt_dict_foreach (pimpl->dp_objs, cursor, key, dp) {
490 double remaining = MSG_task_get_flops_amount(dp->task);
492 double clock = MSG_get_clock();
494 // total += calc_updated_pages(key, vm, dp, remaining, clock);
495 total += get_computed(key, vm, dp, remaining, clock);
497 dp->prev_remaining = remaining;
498 dp->prev_clock = clock;
501 total += pimpl->dp_updated_by_deleted_tasks;
503 XBT_DEBUG("mig-stage%d.%d: computed %f flop_counts (including %f by deleted tasks)", stage_for_fancy_debug,
504 stage2_round_for_fancy_debug, total, pimpl->dp_updated_by_deleted_tasks);
506 pimpl->dp_updated_by_deleted_tasks = 0;
511 // TODO Is this code redundant with the information provided by
512 // msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
513 /** @brief take care of the dirty page tracking, in case we're adding a task to a migrating VM */
514 void MSG_host_add_task(msg_host_t host, msg_task_t task)
516 simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host);
519 simgrid::surf::VirtualMachineImpl* pimpl = static_cast<simgrid::surf::VirtualMachineImpl*>(vm->pimpl_);
521 double remaining = MSG_task_get_flops_amount(task);
522 char *key = bprintf("%s-%p", task->name, task);
524 dirty_page_t dp = xbt_new0(s_dirty_page, 1);
526 if (pimpl->dp_enabled) {
527 dp->prev_clock = MSG_get_clock();
528 dp->prev_remaining = remaining;
531 pimpl->dp_objs = xbt_dict_new();
532 xbt_assert(xbt_dict_get_or_null(pimpl->dp_objs, key) == nullptr);
533 xbt_dict_set(pimpl->dp_objs, key, dp, nullptr);
534 XBT_DEBUG("add %s on %s (remaining %f, dp_enabled %d)", key, sg_host_get_name(host), remaining, pimpl->dp_enabled);
539 void MSG_host_del_task(msg_host_t host, msg_task_t task)
541 simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host);
544 simgrid::surf::VirtualMachineImpl* pimpl = static_cast<simgrid::surf::VirtualMachineImpl*>(vm->pimpl_);
546 char *key = bprintf("%s-%p", task->name, task);
547 dirty_page_t dp = (dirty_page_t)(pimpl->dp_objs ? xbt_dict_get_or_null(pimpl->dp_objs, key) : NULL);
548 xbt_assert(dp->task == task);
550 /* If we are in the middle of dirty page tracking, we record how much computation has been done until now, and keep
551 * the information for the lookup_() function that will called soon. */
552 if (pimpl->dp_enabled) {
553 double remaining = MSG_task_get_flops_amount(task);
554 double clock = MSG_get_clock();
555 // double updated = calc_updated_pages(key, host, dp, remaining, clock);
556 double updated = get_computed(key, host, dp, remaining, clock);
558 pimpl->dp_updated_by_deleted_tasks += updated;
561 xbt_dict_remove(pimpl->dp_objs, key);
564 XBT_DEBUG("del %s on %s", key, sg_host_get_name(host));
568 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,
569 int stage, int stage2_round, double mig_speed, double timeout)
572 char *task_name = get_mig_task_name(vm, src_pm, dst_pm, stage);
573 msg_task_t task = MSG_task_create(task_name, 0, (double)size, nullptr);
577 double clock_sta = MSG_get_clock();
581 ret = MSG_task_send_with_timeout_bounded(task, mbox, timeout, mig_speed);
583 ret = MSG_task_send(task, mbox);
589 } else if (ret == MSG_TIMEOUT) {
590 sg_size_t remaining = (sg_size_t)MSG_task_get_remaining_communication(task);
591 sent = size - remaining;
592 XBT_VERB("timeout (%lf s) in sending_migration_data, remaining %llu bytes of %llu", timeout, remaining, size);
595 /* FIXME: why try-and-catch is used here? */
596 if(ret == MSG_HOST_FAILURE){
597 //XBT_DEBUG("SRC host failed during migration of %s (stage %d)", sg_host_name(vm), stage);
598 MSG_task_destroy(task);
599 THROWF(host_error, 0, "SRC host failed during migration of %s (stage %d)", sg_host_get_name(vm), stage);
600 }else if(ret == MSG_TRANSFER_FAILURE){
601 //XBT_DEBUG("DST host failed during migration of %s (stage %d)", sg_host_name(vm), stage);
602 MSG_task_destroy(task);
603 THROWF(host_error, 0, "DST host failed during migration of %s (stage %d)", sg_host_get_name(vm), stage);
606 double clock_end = MSG_get_clock();
607 double duration = clock_end - clock_sta;
608 double actual_speed = size / duration;
611 XBT_DEBUG("mig-stage%d.%d: sent %llu duration %f actual_speed %f (target %f)",
612 stage, stage2_round, size, duration, actual_speed, mig_speed);
614 XBT_DEBUG("mig-stage%d: sent %llu duration %f actual_speed %f (target %f)",
615 stage, size, duration, actual_speed, mig_speed);
620 static sg_size_t get_updated_size(double computed, double dp_rate, double dp_cap)
622 double updated_size = computed * dp_rate;
623 XBT_DEBUG("updated_size %f dp_rate %f", updated_size, dp_rate);
624 if (updated_size > dp_cap) {
625 // XBT_INFO("mig-stage2.%d: %f bytes updated, but cap it with the working set size %f", stage2_round, updated_size,
627 updated_size = dp_cap;
630 return (sg_size_t) updated_size;
633 static double send_stage1(struct migration_session *ms, sg_size_t ramsize, double mig_speed, double dp_rate,
636 // const long chunksize = (sg_size_t)1024 * 1024 * 100;
637 const sg_size_t chunksize = (sg_size_t)1024 * 1024 * 100000;
638 sg_size_t remaining = ramsize;
639 double computed_total = 0;
641 while (remaining > 0) {
642 sg_size_t datasize = chunksize;
643 if (remaining < chunksize)
644 datasize = remaining;
646 remaining -= datasize;
647 send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, datasize, ms->mbox, 1, 0, mig_speed, -1);
648 double computed = lookup_computed_flop_counts(ms->vm, 1, 0);
649 computed_total += computed;
652 return computed_total;
655 static double get_threshold_value(double bandwidth, double max_downtime)
657 return max_downtime * bandwidth;
660 static int migration_tx_fun(int argc, char *argv[])
662 XBT_DEBUG("mig: tx_start");
664 // Note that the ms structure has been allocated in do_migration and hence should be freed in the same function ;)
665 migration_session *ms = (migration_session *) MSG_process_get_data(MSG_process_self());
667 s_vm_params_t params;
668 static_cast<simgrid::s4u::VirtualMachine*>(ms->vm)->parameters(¶ms);
669 const sg_size_t ramsize = params.ramsize;
670 const sg_size_t devsize = params.devsize;
671 const int skip_stage1 = params.skip_stage1;
672 int skip_stage2 = params.skip_stage2;
673 const double dp_rate = params.dp_rate;
674 const double dp_cap = params.dp_cap;
675 const double mig_speed = params.mig_speed;
676 double max_downtime = params.max_downtime;
678 /* hard code it temporally. Fix Me */
679 #define MIGRATION_TIMEOUT_DO_NOT_HARDCODE_ME 10000000.0
680 double mig_timeout = MIGRATION_TIMEOUT_DO_NOT_HARDCODE_ME;
682 double remaining_size = (double) (ramsize + devsize);
683 double threshold = 0.0;
685 /* check parameters */
687 XBT_WARN("migrate a VM, but ramsize is zero");
689 if (max_downtime <= 0) {
690 XBT_WARN("use the default max_downtime value 30ms");
694 /* Stage1: send all memory pages to the destination. */
695 XBT_DEBUG("mig-stage1: remaining_size %f", remaining_size);
696 start_dirty_page_tracking(ms->vm);
698 double computed_during_stage1 = 0;
700 double clock_prev_send = MSG_get_clock();
703 /* At stage 1, we do not need timeout. We have to send all the memory pages even though the duration of this
704 * transfer exceeds the timeout value. */
705 XBT_VERB("Stage 1: Gonna send %llu", ramsize);
706 sg_size_t sent = send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, ramsize, ms->mbox, 1, 0, mig_speed, -1);
707 remaining_size -= sent;
708 computed_during_stage1 = lookup_computed_flop_counts(ms->vm, 1, 0);
710 if (sent < ramsize) {
711 XBT_VERB("mig-stage1: timeout, force moving to stage 3");
713 } else if (sent > ramsize)
718 //hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
719 // Stop the dirty page tracking an return (there is no memory space to release)
720 stop_dirty_page_tracking(ms->vm);
724 double clock_post_send = MSG_get_clock();
725 mig_timeout -= (clock_post_send - clock_prev_send);
726 if (mig_timeout < 0) {
727 XBT_VERB("The duration of stage 1 exceeds the timeout value (%lf > %lf), skip stage 2",
728 (clock_post_send - clock_prev_send), MIGRATION_TIMEOUT_DO_NOT_HARDCODE_ME);
732 /* estimate bandwidth */
733 double bandwidth = ramsize / (clock_post_send - clock_prev_send);
734 threshold = get_threshold_value(bandwidth, max_downtime);
735 XBT_DEBUG("actual bandwidth %f (MB/s), threshold %f", bandwidth / 1024 / 1024, threshold);
739 /* Stage2: send update pages iteratively until the size of remaining states becomes smaller than threshold value. */
742 int stage2_round = 0;
745 sg_size_t updated_size = 0;
746 if (stage2_round == 0) {
747 /* just after stage1, nothing has been updated. But, we have to send the data updated during stage1 */
748 updated_size = get_updated_size(computed_during_stage1, dp_rate, dp_cap);
750 double computed = lookup_computed_flop_counts(ms->vm, 2, stage2_round);
751 updated_size = get_updated_size(computed, dp_rate, dp_cap);
754 XBT_DEBUG("mig-stage 2:%d updated_size %llu computed_during_stage1 %f dp_rate %f dp_cap %f",
755 stage2_round, updated_size, computed_during_stage1, dp_rate, dp_cap);
757 /* Check whether the remaining size is below the threshold value. If so, move to stage 3. */
758 remaining_size += updated_size;
759 XBT_DEBUG("mig-stage2.%d: remaining_size %f (%s threshold %f)", stage2_round,
760 remaining_size, (remaining_size < threshold) ? "<" : ">", threshold);
761 if (remaining_size < threshold)
765 double clock_prev_send = MSG_get_clock();
767 XBT_DEBUG("Stage 2, gonna send %llu", updated_size);
768 sent = send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, updated_size, ms->mbox, 2, stage2_round, mig_speed,
772 //hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
773 // Stop the dirty page tracking an return (there is no memory space to release)
774 stop_dirty_page_tracking(ms->vm);
777 double clock_post_send = MSG_get_clock();
779 if (sent == updated_size) {
780 /* timeout did not happen */
781 double bandwidth = updated_size / (clock_post_send - clock_prev_send);
782 threshold = get_threshold_value(bandwidth, max_downtime);
783 XBT_DEBUG("actual bandwidth %f, threshold %f", bandwidth / 1024 / 1024, threshold);
784 remaining_size -= sent;
786 mig_timeout -= (clock_post_send - clock_prev_send);
787 xbt_assert(mig_timeout > 0);
789 } else if (sent < updated_size) {
790 /* When timeout happens, we move to stage 3. The size of memory pages
791 * updated before timeout must be added to the remaining size. */
792 XBT_VERB("mig-stage2.%d: timeout, force moving to stage 3. sent %llu / %llu, eta %lf",
793 stage2_round, sent, updated_size, (clock_post_send - clock_prev_send));
794 remaining_size -= sent;
796 double computed = lookup_computed_flop_counts(ms->vm, 2, stage2_round);
797 updated_size = get_updated_size(computed, dp_rate, dp_cap);
798 remaining_size += updated_size;
805 /* Stage3: stop the VM and copy the rest of states. */
806 XBT_DEBUG("mig-stage3: remaining_size %f", remaining_size);
807 simcall_vm_suspend(ms->vm);
808 stop_dirty_page_tracking(ms->vm);
811 XBT_DEBUG("Stage 3: Gonna send %f", remaining_size);
812 send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, (sg_size_t)remaining_size, ms->mbox, 3, 0, mig_speed, -1);
815 //hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
816 // Stop the dirty page tracking an return (there is no memory space to release)
817 simcall_vm_resume(ms->vm);
821 // At that point the Migration is considered valid for the SRC node but remind that the DST side should relocate
822 // effectively the VM on the DST node.
823 XBT_DEBUG("mig: tx_done");
828 static int do_migration(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
830 struct migration_session *ms = xbt_new(struct migration_session, 1);
834 ms->mbox_ctl = get_mig_mbox_ctl(vm, src_pm, dst_pm);
835 ms->mbox = get_mig_mbox_src_dst(vm, src_pm, dst_pm);
837 char *pr_rx_name = get_mig_process_rx_name(vm, src_pm, dst_pm);
838 char *pr_tx_name = get_mig_process_tx_name(vm, src_pm, dst_pm);
840 // msg_process_t tx_process, rx_process;
841 // MSG_process_create(pr_rx_name, migration_rx_fun, ms, dst_pm);
842 // MSG_process_create(pr_tx_name, migration_tx_fun, ms, src_pm);
845 char **argv = xbt_new(char *, 2);
846 argv[0] = pr_rx_name;
848 /*rx_process = */ MSG_process_create_with_arguments(pr_rx_name, migration_rx_fun, ms, dst_pm, 1, argv);
851 char **argv = xbt_new(char *, 2);
852 argv[0] = pr_tx_name;
854 /* tx_process = */MSG_process_create_with_arguments(pr_tx_name, migration_tx_fun, ms, src_pm, 1, argv);
858 /* wait until the migration have finished or on error has occurred */
860 XBT_DEBUG("wait for reception of the final ACK (i.e. migration has been correctly performed");
861 msg_task_t task = nullptr;
862 msg_error_t ret = MSG_TIMEOUT;
863 while (ret == MSG_TIMEOUT && MSG_host_is_on(dst_pm)) //Wait while you receive the message o
864 ret = MSG_task_receive_with_timeout(&task, ms->mbox_ctl, 4);
866 xbt_free(ms->mbox_ctl);
870 //xbt_assert(ret == MSG_OK);
871 if(ret == MSG_HOST_FAILURE){
872 // Note that since the communication failed, the owner did not change and the task should be destroyed on the
873 // other side. Hence, just throw the execption
874 XBT_ERROR("SRC crashes, throw an exception (m-control)");
875 //MSG_process_kill(tx_process); // Adrien, I made a merge on Nov 28th 2014, I'm not sure whether this line is
879 else if((ret == MSG_TRANSFER_FAILURE) || (ret == MSG_TIMEOUT)){
880 // MSG_TIMEOUT here means that MSG_host_is_avail() returned false.
881 XBT_ERROR("DST crashes, throw an exception (m-control)");
885 char *expected_task_name = get_mig_task_name(vm, src_pm, dst_pm, 4);
886 xbt_assert(strcmp(task->name, expected_task_name) == 0);
887 xbt_free(expected_task_name);
888 MSG_task_destroy(task);
893 /** @brief Migrate the VM to the given host.
896 * FIXME: No migration cost occurs. If you want to simulate this too, you want to use a MSG_task_send() before or after,
897 * depending on whether you want to do cold or hot migration.
899 void MSG_vm_migrate(msg_vm_t vm, msg_host_t new_pm)
902 * - One approach is ...
903 * We first create a new VM (i.e., destination VM) on the destination physical host. The destination VM will
904 * receive the state of the source
905 * VM over network. We will finally destroy the source VM.
906 * - This behavior is similar to the way of migration in the real world.
907 * Even before a migration is completed, we will see a destination VM, consuming resources.
908 * - We have to relocate all processes. The existing process migration code will work for this?
909 * - The name of the VM is a somewhat unique ID in the code. It is tricky for the destination VM?
911 * - Another one is ...
912 * We update the information of the given VM to place it to the destination physical host.
914 * The second one would be easier.
917 msg_host_t old_pm = (msg_host_t) simcall_vm_get_pm(vm);
919 if(MSG_host_is_off(old_pm))
920 THROWF(vm_error, 0, "SRC host(%s) seems off, cannot start a migration", sg_host_get_name(old_pm));
922 if(MSG_host_is_off(new_pm))
923 THROWF(vm_error, 0, "DST host(%s) seems off, cannot start a migration", sg_host_get_name(new_pm));
925 if (!MSG_vm_is_running(vm))
926 THROWF(vm_error, 0, "VM(%s) is not running", sg_host_get_name(vm));
928 if (MSG_vm_is_migrating(vm))
929 THROWF(vm_error, 0, "VM(%s) is already migrating", sg_host_get_name(vm));
931 simgrid::surf::VirtualMachineImpl* pimpl = static_cast<simgrid::surf::VirtualMachineImpl*>(vm->pimpl_);
932 pimpl->isMigrating = 1;
935 int ret = do_migration(vm, old_pm, new_pm);
937 pimpl->isMigrating = 0;
938 THROWF(host_error, 0, "SRC host failed during migration");
941 pimpl->isMigrating = 0;
942 THROWF(host_error, 0, "DST host failed during migration");
946 // This part is done in the RX code, to handle the corner case where SRC can crash just at the end of the migration
947 // process. In that case, the VM has been already assigned to the DST node.
948 //XBT_DEBUG("VM(%s) moved from PM(%s) to PM(%s)", vm->key, old_pm->key, new_pm->key);
949 //TRACE_msg_vm_change_host(vm, old_pm, new_pm);
952 /** @brief Immediately suspend the execution of all processes within the given VM.
955 * This function stops the execution of the VM. All the processes on this VM
956 * will pause. The state of the VM is preserved. We can later resume it again.
958 * No suspension cost occurs.
960 void MSG_vm_suspend(msg_vm_t vm)
962 if (MSG_vm_is_migrating(vm))
963 THROWF(vm_error, 0, "VM(%s) is migrating", sg_host_get_name(vm));
965 simcall_vm_suspend(vm);
967 XBT_DEBUG("vm_suspend done");
969 TRACE_msg_vm_suspend(vm);
972 /** @brief Resume the execution of the VM. All processes on the VM run again.
975 * No resume cost occurs.
977 void MSG_vm_resume(msg_vm_t vm)
979 simcall_vm_resume(vm);
981 TRACE_msg_vm_resume(vm);
985 /** @brief Immediately save the execution of all processes within the given VM.
988 * This function stops the execution of the VM. All the processes on this VM
989 * will pause. The state of the VM is preserved. We can later resume it again.
991 * FIXME: No suspension cost occurs. If you want to simulate this too, you want to use a \ref MSG_file_write() before
992 * or after, depending on the exact semantic of VM save to you.
994 void MSG_vm_save(msg_vm_t vm)
996 if (MSG_vm_is_migrating(vm))
997 THROWF(vm_error, 0, "VM(%s) is migrating", sg_host_get_name(vm));
1000 TRACE_msg_vm_save(vm);
1003 /** @brief Restore the execution of the VM. All processes on the VM run again.
1006 * FIXME: No restore cost occurs. If you want to simulate this too, you want to use a \ref MSG_file_read() before or
1007 * after, depending on the exact semantic of VM restore to you.
1009 void MSG_vm_restore(msg_vm_t vm)
1011 simcall_vm_restore(vm);
1013 TRACE_msg_vm_restore(vm);
1016 /** @brief Get the physical host of a given VM.
1019 msg_host_t MSG_vm_get_pm(msg_vm_t vm)
1021 return (msg_host_t) simcall_vm_get_pm(vm);
1024 /** @brief Set a CPU bound for a given VM.
1027 * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
1030 * On PM0, there are Task1 and VM0.
1031 * On VM0, there is Task2.
1032 * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
1034 * Task1\@PM0 gets 50%.
1035 * Task2\@VM0 gets 25%.
1036 * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
1038 * 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
1039 * the dummy CPU action. The bound of the dummy CPU action is unlimited.
1041 * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
1042 * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
1043 * on the VM in share_resource() or we have to trap both the start and end of task execution.
1045 * The current solution is to use MSG_vm_set_bound(), which allows us to directly set the bound of the dummy CPU action.
1047 * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
1048 * computation task (or a VM) never exceeds the capacity of a CPU core.
1050 void MSG_vm_set_bound(msg_vm_t vm, double bound)
1052 simcall_vm_set_bound(vm, bound);