1 /* Copyright (c) 2012-2017. 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/instr/instr_private.hpp"
15 #include "src/msg/msg_private.hpp"
16 #include "src/plugins/vm/VirtualMachineImpl.hpp"
17 #include "src/plugins/vm/VmHostExt.hpp"
19 #include "simgrid/host.h"
20 #include "simgrid/simix.hpp"
26 double prev_remaining;
29 typedef s_dirty_page* dirty_page_t;
31 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_vm, msg, "Cloud-oriented parts of the MSG API");
33 /* **** ******** GENERAL ********* **** */
34 const char* MSG_vm_get_name(msg_vm_t vm)
36 return vm->getCname();
39 /** \ingroup m_vm_management
40 * \brief Set the parameters of a given host
43 * \param params a parameter object
45 void MSG_vm_set_params(msg_vm_t vm, vm_params_t params)
47 vm->setParameters(params);
50 /** \ingroup m_vm_management
51 * \brief Get the parameters of a given host
53 * \param vm the vm you are interested into
54 * \param params a prameter object
56 void MSG_vm_get_params(msg_vm_t vm, vm_params_t params)
58 vm->getParameters(params);
61 /* **** Check state of a VM **** */
62 static inline int __MSG_vm_is_state(msg_vm_t vm, e_surf_vm_state_t state)
64 return vm->pimpl_vm_ != nullptr && vm->pimpl_vm_->getState() == state;
67 /** @brief Returns whether the given VM has just created, not running.
70 int MSG_vm_is_created(msg_vm_t vm)
72 return __MSG_vm_is_state(vm, SURF_VM_STATE_CREATED);
75 /** @brief Returns whether the given VM is currently running
78 int MSG_vm_is_running(msg_vm_t vm)
80 return __MSG_vm_is_state(vm, SURF_VM_STATE_RUNNING);
83 /** @brief Returns whether the given VM is currently migrating
86 int MSG_vm_is_migrating(msg_vm_t vm)
88 return vm->isMigrating();
91 /** @brief Returns whether the given VM is currently suspended, not running.
94 int MSG_vm_is_suspended(msg_vm_t vm)
96 return __MSG_vm_is_state(vm, SURF_VM_STATE_SUSPENDED);
99 /* **** ******** MSG vm actions ********* **** */
100 /** @brief Create a new VM with specified parameters.
102 * @param pm Physical machine that will host the VM
103 * @param name Must be unique
104 * @param coreAmount Must be >= 1
105 * @param ramsize [TODO]
106 * @param mig_netspeed Amount of Mbyte/s allocated to the migration (cannot be larger than net_cap). Use 0 if unsure.
107 * @param dp_intensity Dirty page percentage according to migNetSpeed, [0-100]. Use 0 if unsure.
109 msg_vm_t MSG_vm_create(msg_host_t pm, const char* name, int coreAmount, int ramsize, int mig_netspeed, int dp_intensity)
111 simgrid::vm::VmHostExt::ensureVmExtInstalled();
113 /* For the moment, intensity_rate is the percentage against the migration bandwidth */
115 msg_vm_t vm = new simgrid::s4u::VirtualMachine(name, pm, coreAmount);
116 s_vm_params_t params;
117 memset(¶ms, 0, sizeof(params));
118 params.ramsize = static_cast<sg_size_t>(ramsize) * 1024 * 1024;
120 params.skip_stage2 = 0;
121 params.max_downtime = 0.03;
122 params.mig_speed = static_cast<double>(mig_netspeed) * 1024 * 1024; // mig_speed
123 params.dp_intensity = static_cast<double>(dp_intensity) / 100;
124 params.dp_cap = params.ramsize * 0.9; // assume working set memory is 90% of ramsize
126 XBT_DEBUG("migspeed : %f intensity mem : %d", params.mig_speed, dp_intensity);
127 vm->setParameters(¶ms);
132 /** @brief Create a new VM object with the default parameters
135 * A VM is treated as a host. The name of the VM must be unique among all hosts.
137 msg_vm_t MSG_vm_create_core(msg_host_t pm, const char* name)
139 xbt_assert(sg_host_by_name(name) == nullptr,
140 "Cannot create a VM named %s: this name is already used by an host or a VM", name);
142 return new simgrid::s4u::VirtualMachine(name, pm, 1);
144 /** @brief Create a new VM object with the default parameters, but with a specified amount of cores
147 * A VM is treated as a host. The name of the VM must be unique among all hosts.
149 msg_vm_t MSG_vm_create_multicore(msg_host_t pm, const char* name, int coreAmount)
151 xbt_assert(sg_host_by_name(name) == nullptr,
152 "Cannot create a VM named %s: this name is already used by an host or a VM", name);
154 return new simgrid::s4u::VirtualMachine(name, pm, coreAmount);
157 /** @brief Destroy a VM. Destroy the VM object from the simulation.
160 void MSG_vm_destroy(msg_vm_t vm)
162 if (vm->isMigrating())
163 THROWF(vm_error, 0, "Cannot destroy VM '%s', which is migrating.", vm->getCname());
165 /* First, terminate all processes on the VM if necessary */
166 if (MSG_vm_is_running(vm))
169 /* Then, destroy the VM object */
170 simgrid::simix::kernelImmediate([vm]() { vm->destroy(); });
172 if (TRACE_msg_vm_is_enabled()) {
173 container_t container = simgrid::instr::Container::byName(vm->getName());
174 container->removeFromParent();
179 /** @brief Start a vm (i.e., boot the guest operating system)
182 * If the VM cannot be started (because of memory over-provisioning), an exception is generated.
184 void MSG_vm_start(msg_vm_t vm)
187 if (TRACE_msg_vm_is_enabled()) {
188 simgrid::instr::StateType* state = simgrid::instr::Container::byName(vm->getName())->getState("MSG_VM_STATE");
189 state->addEntityValue("start", "0 0 1"); // start is blue
190 state->pushEvent("start");
194 /** @brief Immediately kills all processes within the given VM.
197 * Any memory that they allocated will be leaked, unless you used #MSG_process_on_exit().
199 * No extra delay occurs. If you want to simulate this too, you want to use a #MSG_process_sleep().
201 void MSG_vm_shutdown(msg_vm_t vm)
203 smx_actor_t issuer = SIMIX_process_self();
204 simgrid::simix::kernelImmediate([vm, issuer]() { vm->pimpl_vm_->shutdown(issuer); });
206 // Make sure that processes in the VM are killed in this scheduling round before processing (eg with the VM destroy)
207 MSG_process_sleep(0.);
210 static std::string get_mig_process_tx_name(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
212 return std::string("__pr_mig_tx:") + vm->getCname() + "(" + src_pm->getCname() + "-" + dst_pm->getCname() + ")";
215 static std::string get_mig_process_rx_name(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm)
217 return std::string("__pr_mig_rx:") + vm->getCname() + "(" + src_pm->getCname() + "-" + dst_pm->getCname() + ")";
220 static std::string get_mig_task_name(msg_vm_t vm, msg_host_t src_pm, msg_host_t dst_pm, int stage)
222 return std::string("__task_mig_stage") + std::to_string(stage) + ":" + vm->getCname() + "(" + src_pm->getCname() +
223 "-" + dst_pm->getCname() + ")";
226 struct migration_session {
231 /* The miration_rx process uses mbox_ctl to let the caller of do_migration()
232 * know the completion of the migration. */
234 /* The migration_rx and migration_tx processes use mbox to transfer migration data. */
238 static int migration_rx_fun(int argc, char *argv[])
240 XBT_DEBUG("mig: rx_start");
242 // The structure has been created in the do_migration function and should only be freed in the same place ;)
243 migration_session* ms = static_cast<migration_session*>(MSG_process_get_data(MSG_process_self()));
245 bool received_finalize = false;
247 std::string finalize_task_name = get_mig_task_name(ms->vm, ms->src_pm, ms->dst_pm, 3);
248 while (not received_finalize) {
249 msg_task_t task = nullptr;
250 int ret = MSG_task_recv(&task, ms->mbox);
253 // An error occurred, clean the code and return
254 // The owner did not change, hence the task should be only destroyed on the other side
258 if (finalize_task_name == task->name)
259 received_finalize = 1;
261 MSG_task_destroy(task);
264 // Here Stage 1, 2 and 3 have been performed.
265 // Hence complete the migration
267 // Copy the reference to the vm (if SRC crashes now, do_migration will free ms)
268 // This is clearly ugly but I (Adrien) need more time to do something cleaner (actually we should copy the whole ms
269 // structure at the beginning and free it at the end of each function)
270 simgrid::s4u::VirtualMachine* vm = ms->vm;
271 msg_host_t dst_pm = ms->dst_pm;
273 // Make sure that we cannot get interrupted between the migrate and the resume to not end in an inconsistent state
274 simgrid::simix::kernelImmediate([vm, dst_pm]() {
275 /* Update the vm location */
276 /* precopy migration makes the VM temporally paused */
277 xbt_assert(vm->pimpl_vm_->getState() == SURF_VM_STATE_SUSPENDED);
279 /* Update the vm location and resume it */
280 vm->pimpl_vm_->setPm(dst_pm);
281 vm->pimpl_vm_->resume();
285 // Now the VM is running on the new host (the migration is completed) (even if the SRC crash)
286 vm->pimpl_vm_->isMigrating = false;
287 XBT_DEBUG("VM(%s) moved from PM(%s) to PM(%s)", ms->vm->getCname(), ms->src_pm->getCname(), ms->dst_pm->getCname());
289 if (TRACE_msg_vm_is_enabled()) {
290 static long long int counter = 0;
291 std::string key = std::to_string(counter);
295 container_t msg = simgrid::instr::Container::byName(vm->getName());
296 simgrid::instr::LinkType* link = simgrid::instr::Container::getRootContainer()->getLink("MSG_VM_LINK");
297 link->startEvent(simgrid::instr::Container::getRootContainer(), msg, "M", key);
299 // destroy existing container of this vm
300 container_t existing_container = simgrid::instr::Container::byName(vm->getName());
301 existing_container->removeFromParent();
302 delete existing_container;
304 // create new container on the new_host location
305 new simgrid::instr::Container(vm->getCname(), "MSG_VM", simgrid::instr::Container::byName(ms->dst_pm->getName()));
308 msg = simgrid::instr::Container::byName(vm->getName());
309 link->endEvent(simgrid::instr::Container::getRootContainer(), msg, "M", key);
312 // Inform the SRC that the migration has been correctly performed
313 std::string task_name = get_mig_task_name(ms->vm, ms->src_pm, ms->dst_pm, 4);
314 msg_task_t task = MSG_task_create(task_name.c_str(), 0, 0, nullptr);
315 msg_error_t ret = MSG_task_send(task, ms->mbox_ctl);
316 if(ret == MSG_HOST_FAILURE){
317 // The DST has crashed, this is a problem has the VM since we are not sure whether SRC is considering that the VM
318 // has been correctly migrated on the DST node
319 // TODO What does it mean ? What should we do ?
320 MSG_task_destroy(task);
321 } else if(ret == MSG_TRANSFER_FAILURE){
322 // The SRC has crashed, this is not a problem has the VM has been correctly migrated on the DST node
323 MSG_task_destroy(task);
326 XBT_DEBUG("mig: rx_done");
330 static void start_dirty_page_tracking(msg_vm_t vm)
332 vm->pimpl_vm_->dp_enabled = 1;
333 if (vm->pimpl_vm_->dp_objs.empty())
336 for (auto const& elm : vm->pimpl_vm_->dp_objs) {
337 dirty_page_t dp = elm.second;
338 double remaining = MSG_task_get_flops_amount(dp->task);
339 dp->prev_clock = MSG_get_clock();
340 dp->prev_remaining = remaining;
341 XBT_DEBUG("%s@%s remaining %f", elm.first.c_str(), vm->getCname(), remaining);
345 static void stop_dirty_page_tracking(msg_vm_t vm)
347 vm->pimpl_vm_->dp_enabled = 0;
350 static double get_computed(const char* key, msg_vm_t vm, dirty_page_t dp, double remaining, double clock)
352 double computed = dp->prev_remaining - remaining;
353 double duration = clock - dp->prev_clock;
355 XBT_DEBUG("%s@%s: computed %f ops (remaining %f -> %f) in %f secs (%f -> %f)", key, vm->getCname(), computed,
356 dp->prev_remaining, remaining, duration, dp->prev_clock, clock);
361 static double lookup_computed_flop_counts(msg_vm_t vm, int stage_for_fancy_debug, int stage2_round_for_fancy_debug)
365 for (auto const& elm : vm->pimpl_vm_->dp_objs) {
366 const char* key = elm.first.c_str();
367 dirty_page_t dp = elm.second;
368 double remaining = MSG_task_get_flops_amount(dp->task);
370 double clock = MSG_get_clock();
372 total += get_computed(key, vm, dp, remaining, clock);
374 dp->prev_remaining = remaining;
375 dp->prev_clock = clock;
378 total += vm->pimpl_vm_->dp_updated_by_deleted_tasks;
380 XBT_DEBUG("mig-stage%d.%d: computed %f flop_counts (including %f by deleted tasks)", stage_for_fancy_debug,
381 stage2_round_for_fancy_debug, total, vm->pimpl_vm_->dp_updated_by_deleted_tasks);
383 vm->pimpl_vm_->dp_updated_by_deleted_tasks = 0;
388 // TODO Is this code redundant with the information provided by
389 // msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
390 /** @brief take care of the dirty page tracking, in case we're adding a task to a migrating VM */
391 void MSG_host_add_task(msg_host_t host, msg_task_t task)
393 simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host);
397 double remaining = MSG_task_get_flops_amount(task);
398 char *key = bprintf("%s-%p", task->name, task);
400 dirty_page_t dp = xbt_new0(s_dirty_page, 1);
402 if (vm->pimpl_vm_->dp_enabled) {
403 dp->prev_clock = MSG_get_clock();
404 dp->prev_remaining = remaining;
406 vm->pimpl_vm_->dp_objs.insert({key, dp});
407 XBT_DEBUG("add %s on %s (remaining %f, dp_enabled %d)", key, host->getCname(), remaining, vm->pimpl_vm_->dp_enabled);
412 void MSG_host_del_task(msg_host_t host, msg_task_t task)
414 simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host);
418 char *key = bprintf("%s-%p", task->name, task);
419 dirty_page_t dp = nullptr;
420 if (vm->pimpl_vm_->dp_objs.find(key) != vm->pimpl_vm_->dp_objs.end())
421 dp = vm->pimpl_vm_->dp_objs.at(key);
422 xbt_assert(dp && dp->task == task);
424 /* If we are in the middle of dirty page tracking, we record how much computation has been done until now, and keep
425 * the information for the lookup_() function that will called soon. */
426 if (vm->pimpl_vm_->dp_enabled) {
427 double remaining = MSG_task_get_flops_amount(task);
428 double clock = MSG_get_clock();
429 double updated = get_computed(key, vm, dp, remaining, clock); // was host instead of vm
431 vm->pimpl_vm_->dp_updated_by_deleted_tasks += updated;
434 vm->pimpl_vm_->dp_objs.erase(key);
437 XBT_DEBUG("del %s on %s", key, host->getCname());
441 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,
442 int stage, int stage2_round, double mig_speed, double timeout)
445 std::string task_name = get_mig_task_name(vm, src_pm, dst_pm, stage);
446 msg_task_t task = MSG_task_create(task_name.c_str(), 0, static_cast<double>(size), nullptr);
448 double clock_sta = MSG_get_clock();
452 ret = MSG_task_send_with_timeout_bounded(task, mbox, timeout, mig_speed);
454 ret = MSG_task_send(task, mbox);
458 } else if (ret == MSG_TIMEOUT) {
459 sg_size_t remaining = static_cast<sg_size_t>(MSG_task_get_remaining_communication(task));
460 sent = size - remaining;
461 XBT_VERB("timeout (%lf s) in sending_migration_data, remaining %llu bytes of %llu", timeout, remaining, size);
464 /* FIXME: why try-and-catch is used here? */
465 if(ret == MSG_HOST_FAILURE){
466 XBT_DEBUG("SRC host failed during migration of %s (stage %d)", vm->getCname(), stage);
467 MSG_task_destroy(task);
468 THROWF(host_error, 0, "SRC host failed during migration of %s (stage %d)", vm->getCname(), stage);
469 }else if(ret == MSG_TRANSFER_FAILURE){
470 XBT_DEBUG("DST host failed during migration of %s (stage %d)", vm->getCname(), stage);
471 MSG_task_destroy(task);
472 THROWF(host_error, 0, "DST host failed during migration of %s (stage %d)", vm->getCname(), stage);
475 double clock_end = MSG_get_clock();
476 double duration = clock_end - clock_sta;
477 double actual_speed = size / duration;
480 XBT_DEBUG("mig-stage%d.%d: sent %llu duration %f actual_speed %f (target %f)", stage, stage2_round, size, duration,
481 actual_speed, mig_speed);
483 XBT_DEBUG("mig-stage%d: sent %llu duration %f actual_speed %f (target %f)", stage, size, duration, actual_speed,
489 static sg_size_t get_updated_size(double computed, double dp_rate, double dp_cap)
491 double updated_size = computed * dp_rate;
492 XBT_DEBUG("updated_size %f dp_rate %f", updated_size, dp_rate);
493 if (updated_size > dp_cap) {
494 updated_size = dp_cap;
497 return static_cast<sg_size_t>(updated_size);
500 static int migration_tx_fun(int argc, char *argv[])
502 XBT_DEBUG("mig: tx_start");
504 // Note that the ms structure has been allocated in do_migration and hence should be freed in the same function ;)
505 migration_session* ms = static_cast<migration_session*>(MSG_process_get_data(MSG_process_self()));
507 double host_speed = ms->vm->pimpl_vm_->getPm()->getSpeed();
508 s_vm_params_t params;
509 ms->vm->getParameters(¶ms);
510 const sg_size_t ramsize = params.ramsize;
511 const sg_size_t devsize = params.devsize;
512 const int skip_stage1 = params.skip_stage1;
513 int skip_stage2 = params.skip_stage2;
514 const double dp_rate = host_speed ? (params.mig_speed * params.dp_intensity) / host_speed : 1;
515 const double dp_cap = params.dp_cap;
516 const double mig_speed = params.mig_speed;
517 double max_downtime = params.max_downtime;
519 double mig_timeout = 10000000.0;
521 double remaining_size = static_cast<double>(ramsize + devsize);
522 double threshold = 0.0;
524 /* check parameters */
526 XBT_WARN("migrate a VM, but ramsize is zero");
528 if (max_downtime <= 0) {
529 XBT_WARN("use the default max_downtime value 30ms");
533 /* Stage1: send all memory pages to the destination. */
534 XBT_DEBUG("mig-stage1: remaining_size %f", remaining_size);
535 start_dirty_page_tracking(ms->vm);
537 double computed_during_stage1 = 0;
538 if (not skip_stage1) {
539 double clock_prev_send = MSG_get_clock();
542 /* At stage 1, we do not need timeout. We have to send all the memory pages even though the duration of this
543 * transfer exceeds the timeout value. */
544 XBT_VERB("Stage 1: Gonna send %llu bytes", ramsize);
545 sg_size_t sent = send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, ramsize, ms->mbox, 1, 0, mig_speed, -1);
546 remaining_size -= sent;
547 computed_during_stage1 = lookup_computed_flop_counts(ms->vm, 1, 0);
549 if (sent < ramsize) {
550 XBT_VERB("mig-stage1: timeout, force moving to stage 3");
552 } else if (sent > ramsize)
557 //hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
558 // Stop the dirty page tracking an return (there is no memory space to release)
559 stop_dirty_page_tracking(ms->vm);
563 double clock_post_send = MSG_get_clock();
564 mig_timeout -= (clock_post_send - clock_prev_send);
565 if (mig_timeout < 0) {
566 XBT_VERB("The duration of stage 1 exceeds the timeout value, skip stage 2");
570 /* estimate bandwidth */
571 double bandwidth = ramsize / (clock_post_send - clock_prev_send);
572 threshold = bandwidth * max_downtime;
573 XBT_DEBUG("actual bandwidth %f (MB/s), threshold %f", bandwidth / 1024 / 1024, threshold);
577 /* Stage2: send update pages iteratively until the size of remaining states becomes smaller than threshold value. */
578 if (not skip_stage2) {
580 int stage2_round = 0;
583 sg_size_t updated_size = 0;
584 if (stage2_round == 0) {
585 /* just after stage1, nothing has been updated. But, we have to send the data updated during stage1 */
586 updated_size = get_updated_size(computed_during_stage1, dp_rate, dp_cap);
588 double computed = lookup_computed_flop_counts(ms->vm, 2, stage2_round);
589 updated_size = get_updated_size(computed, dp_rate, dp_cap);
592 XBT_DEBUG("mig-stage 2:%d updated_size %llu computed_during_stage1 %f dp_rate %f dp_cap %f", stage2_round,
593 updated_size, computed_during_stage1, dp_rate, dp_cap);
595 /* Check whether the remaining size is below the threshold value. If so, move to stage 3. */
596 remaining_size += updated_size;
597 XBT_DEBUG("mig-stage2.%d: remaining_size %f (%s threshold %f)", stage2_round, remaining_size,
598 (remaining_size < threshold) ? "<" : ">", threshold);
599 if (remaining_size < threshold)
603 double clock_prev_send = MSG_get_clock();
605 XBT_DEBUG("Stage 2, gonna send %llu", updated_size);
606 sent = send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, updated_size, ms->mbox, 2, stage2_round, mig_speed,
608 } catch (xbt_ex& e) {
609 // hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data
611 // Stop the dirty page tracking an return (there is no memory space to release)
612 stop_dirty_page_tracking(ms->vm);
615 double clock_post_send = MSG_get_clock();
617 if (sent == updated_size) {
618 /* timeout did not happen */
619 double bandwidth = updated_size / (clock_post_send - clock_prev_send);
620 threshold = bandwidth * max_downtime;
621 XBT_DEBUG("actual bandwidth %f, threshold %f", bandwidth / 1024 / 1024, threshold);
622 remaining_size -= sent;
624 mig_timeout -= (clock_post_send - clock_prev_send);
625 xbt_assert(mig_timeout > 0);
627 } else if (sent < updated_size) {
628 /* When timeout happens, we move to stage 3. The size of memory pages
629 * updated before timeout must be added to the remaining size. */
630 XBT_VERB("mig-stage2.%d: timeout, force moving to stage 3. sent %llu / %llu, eta %lf", stage2_round, sent,
631 updated_size, (clock_post_send - clock_prev_send));
632 remaining_size -= sent;
634 double computed = lookup_computed_flop_counts(ms->vm, 2, stage2_round);
635 updated_size = get_updated_size(computed, dp_rate, dp_cap);
636 remaining_size += updated_size;
643 /* Stage3: stop the VM and copy the rest of states. */
644 XBT_DEBUG("mig-stage3: remaining_size %f", remaining_size);
645 simgrid::vm::VirtualMachineImpl* pimpl = ms->vm->pimpl_vm_;
646 pimpl->setState(SURF_VM_STATE_RUNNING); // FIXME: this bypass of the checks in suspend() is not nice
647 pimpl->isMigrating = false; // FIXME: this bypass of the checks in suspend() is not nice
648 pimpl->suspend(SIMIX_process_self());
649 stop_dirty_page_tracking(ms->vm);
652 XBT_DEBUG("Stage 3: Gonna send %f bytes", remaining_size);
653 send_migration_data(ms->vm, ms->src_pm, ms->dst_pm, static_cast<sg_size_t>(remaining_size), ms->mbox, 3, 0,
657 //hostfailure (if you want to know whether this is the SRC or the DST check directly in send_migration_data code)
658 // Stop the dirty page tracking an return (there is no memory space to release)
659 ms->vm->pimpl_vm_->resume();
663 // At that point the Migration is considered valid for the SRC node but remind that the DST side should relocate
664 // effectively the VM on the DST node.
665 XBT_DEBUG("mig: tx_done");
670 /** @brief Migrate the VM to the given host.
673 void MSG_vm_migrate(msg_vm_t vm, msg_host_t dst_pm)
676 * - One approach is ...
677 * We first create a new VM (i.e., destination VM) on the destination physical host. The destination VM will
678 * receive the state of the source
679 * VM over network. We will finally destroy the source VM.
680 * - This behavior is similar to the way of migration in the real world.
681 * Even before a migration is completed, we will see a destination VM, consuming resources.
682 * - We have to relocate all processes. The existing process migration code will work for this?
683 * - The name of the VM is a somewhat unique ID in the code. It is tricky for the destination VM?
685 * - Another one is ...
686 * We update the information of the given VM to place it to the destination physical host.
688 * The second one would be easier.
691 msg_host_t src_pm = vm->pimpl_vm_->getPm();
694 THROWF(vm_error, 0, "Cannot migrate VM '%s' from host '%s', which is offline.", vm->getCname(), src_pm->getCname());
696 THROWF(vm_error, 0, "Cannot migrate VM '%s' to host '%s', which is offline.", vm->getCname(), dst_pm->getCname());
697 if (not MSG_vm_is_running(vm))
698 THROWF(vm_error, 0, "Cannot migrate VM '%s' that is not running yet.", vm->getCname());
699 if (vm->isMigrating())
700 THROWF(vm_error, 0, "Cannot migrate VM '%s' that is already migrating.", vm->getCname());
702 vm->pimpl_vm_->isMigrating = true;
704 migration_session* ms = xbt_new(migration_session, 1);
709 /* We have two mailboxes. mbox is used to transfer migration data between source and destination PMs. mbox_ctl is used
710 * to detect the completion of a migration. The names of these mailboxes must not conflict with others. */
711 ms->mbox_ctl = bprintf("__mbox_mig_ctl:%s(%s-%s)", vm->getCname(), src_pm->getCname(), dst_pm->getCname());
712 ms->mbox = bprintf("__mbox_mig_src_dst:%s(%s-%s)", vm->getCname(), src_pm->getCname(), dst_pm->getCname());
714 std::string pr_rx_name = get_mig_process_rx_name(vm, src_pm, dst_pm);
715 std::string pr_tx_name = get_mig_process_tx_name(vm, src_pm, dst_pm);
717 MSG_process_create(pr_rx_name.c_str(), migration_rx_fun, ms, dst_pm);
719 MSG_process_create(pr_tx_name.c_str(), migration_tx_fun, ms, src_pm);
721 /* wait until the migration have finished or on error has occurred */
722 XBT_DEBUG("wait for reception of the final ACK (i.e. migration has been correctly performed");
723 msg_task_t task = nullptr;
724 msg_error_t ret = MSG_task_receive(&task, ms->mbox_ctl);
726 vm->pimpl_vm_->isMigrating = false;
728 xbt_free(ms->mbox_ctl);
732 if (ret == MSG_HOST_FAILURE) {
733 // Note that since the communication failed, the owner did not change and the task should be destroyed on the
734 // other side. Hence, just throw the execption
735 XBT_ERROR("SRC crashes, throw an exception (m-control)");
736 // MSG_process_kill(tx_process); // Adrien, I made a merge on Nov 28th 2014, I'm not sure whether this line is
738 THROWF(host_error, 0, "Source host '%s' failed during the migration of VM '%s'.", src_pm->getCname(),
740 } else if ((ret == MSG_TRANSFER_FAILURE) || (ret == MSG_TIMEOUT)) {
741 // MSG_TIMEOUT here means that MSG_host_is_avail() returned false.
742 XBT_ERROR("DST crashes, throw an exception (m-control)");
743 THROWF(host_error, 0, "Destination host '%s' failed during the migration of VM '%s'.", dst_pm->getCname(),
747 xbt_assert(get_mig_task_name(vm, src_pm, dst_pm, 4) == task->name);
748 MSG_task_destroy(task);
751 /** @brief Immediately suspend the execution of all processes within the given VM.
754 * This function stops the execution of the VM. All the processes on this VM
755 * will pause. The state of the VM is preserved. We can later resume it again.
757 * No suspension cost occurs.
759 void MSG_vm_suspend(msg_vm_t vm)
761 smx_actor_t issuer = SIMIX_process_self();
762 simgrid::simix::kernelImmediate([vm, issuer]() { vm->pimpl_vm_->suspend(issuer); });
764 XBT_DEBUG("vm_suspend done");
766 if (TRACE_msg_vm_is_enabled()) {
767 simgrid::instr::StateType* state = simgrid::instr::Container::byName(vm->getName())->getState("MSG_VM_STATE");
768 state->addEntityValue("suspend", "1 0 0"); // suspend is red
769 state->pushEvent("suspend");
773 /** @brief Resume the execution of the VM. All processes on the VM run again.
776 * No resume cost occurs.
778 void MSG_vm_resume(msg_vm_t vm)
780 vm->pimpl_vm_->resume();
782 if (TRACE_msg_vm_is_enabled())
783 simgrid::instr::Container::byName(vm->getName())->getState("MSG_VM_STATE")->popEvent();
786 /** @brief Get the physical host of a given VM.
789 msg_host_t MSG_vm_get_pm(msg_vm_t vm)
794 /** @brief Set a CPU bound for a given VM.
797 * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
800 * On PM0, there are Task1 and VM0.
801 * On VM0, there is Task2.
802 * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
804 * Task1\@PM0 gets 50%.
805 * Task2\@VM0 gets 25%.
806 * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
808 * 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
809 * the dummy CPU action. The bound of the dummy CPU action is unlimited.
811 * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
812 * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
813 * on the VM in share_resource() or we have to trap both the start and end of task execution.
815 * The current solution is to use MSG_vm_set_bound(), which allows us to directly set the bound of the dummy CPU action.
817 * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
818 * computation task (or a VM) never exceeds the capacity of a CPU core.
820 void MSG_vm_set_bound(msg_vm_t vm, double bound)
822 simgrid::simix::kernelImmediate([vm, bound]() { vm->pimpl_vm_->setBound(bound); });