1 /* Copyright (c) 2015-2023. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #include "simgrid/simix.hpp"
7 #include <simgrid/Exception.hpp>
8 #include <simgrid/kernel/routing/NetPoint.hpp>
9 #include <simgrid/vm.h>
11 #include "src/kernel/resource/VirtualMachineImpl.hpp"
12 #include "src/kernel/resource/models/cpu_cas01.hpp"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_vm, s4u, "S4U virtual machines");
16 namespace simgrid::s4u {
17 xbt::signal<void(VirtualMachine&)> VirtualMachine::on_vm_creation;
18 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_start;
19 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_started;
20 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_shutdown;
21 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_suspend;
22 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_resume;
23 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_migration_start;
24 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_migration_end;
25 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_vm_destruction;
27 xbt::Extension<Host, VmHostExt> VmHostExt::EXTENSION_ID;
29 void VmHostExt::ensureVmExtInstalled()
31 if (not EXTENSION_ID.valid())
32 EXTENSION_ID = Host::extension_create<VmHostExt>();
35 VirtualMachine::VirtualMachine(const std::string& name, s4u::Host* physical_host, int core_amount, size_t ramsize)
36 : Host(new kernel::resource::VirtualMachineImpl(name, this, physical_host, core_amount, ramsize))
37 , pimpl_vm_(dynamic_cast<kernel::resource::VirtualMachineImpl*>(Host::get_impl()))
39 physical_host->get_impl()->create_vm(name, this);
42 VirtualMachine::VirtualMachine(kernel::resource::VirtualMachineImpl* impl)
43 : Host(impl), pimpl_vm_(dynamic_cast<kernel::resource::VirtualMachineImpl*>(Host::get_impl()))
47 void VirtualMachine::start()
49 kernel::actor::simcall_answered([this]() { pimpl_vm_->start(); });
52 void VirtualMachine::suspend()
54 const kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
55 kernel::actor::simcall_answered([this, issuer]() { pimpl_vm_->suspend(issuer); });
58 void VirtualMachine::resume()
63 void VirtualMachine::shutdown()
65 kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
66 kernel::actor::simcall_answered([this, issuer]() { pimpl_vm_->shutdown(issuer); });
69 void VirtualMachine::destroy()
71 auto destroy_code = [this]() {
72 /* First, terminate all processes on the VM if necessary */
75 XBT_DEBUG("destroy %s", get_cname());
76 on_vm_destruction(*this);
77 /* Then, destroy the VM object */
78 kernel::actor::simcall_answered(
79 [this]() { get_vm_impl()->get_physical_host()->get_impl()->destroy_vm(get_name()); });
82 if (not this_actor::is_maestro() && this_actor::get_host() == this) {
83 XBT_VERB("Launch another actor on physical host %s to destroy my own VM: %s", get_pm()->get_cname(), get_cname());
84 simgrid::s4u::Actor::create(get_name() + "-vm_destroy", get_pm(), destroy_code);
85 simgrid::s4u::this_actor::yield();
86 XBT_CRITICAL("I should be dead now!");
93 simgrid::s4u::Host* VirtualMachine::get_pm() const
95 return pimpl_vm_->get_physical_host();
98 VirtualMachine* VirtualMachine::set_pm(simgrid::s4u::Host* pm)
100 kernel::actor::simcall_answered([this, pm]() { pimpl_vm_->set_physical_host(pm); });
104 VirtualMachine::State VirtualMachine::get_state() const
106 return kernel::actor::simcall_answered([this]() { return pimpl_vm_->get_state(); });
109 size_t VirtualMachine::get_ramsize() const
111 return pimpl_vm_->get_ramsize();
114 VirtualMachine* VirtualMachine::set_ramsize(size_t ramsize)
116 pimpl_vm_->set_ramsize(ramsize);
119 /** @brief Set a CPU bound for a given VM.
122 * 1. Note that in some cases sg_exec_set_bound() may not intuitively work for VMs.
125 * On PM0, there are Task1 and VM0.
126 * On VM0, there is Task2.
127 * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
129 * Task1\@PM0 gets 50%.
130 * Task2\@VM0 gets 25%.
131 * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
133 * 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
134 * the dummy CPU action. The bound of the dummy CPU action is unlimited.
136 * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
137 * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
138 * on the VM in share_resource() or we have to trap both the start and end of task execution.
140 * The current solution is to use set_bound(), which allows us to directly set the bound of the dummy CPU action.
142 * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
143 * computation task (or a VM) never exceeds the capacity of a CPU core.
145 VirtualMachine* VirtualMachine::set_bound(double bound)
147 kernel::actor::simcall_answered([this, bound]() { pimpl_vm_->set_bound(bound); });
151 void VirtualMachine::start_migration() const
153 pimpl_vm_->start_migration();
156 void VirtualMachine::end_migration() const
158 pimpl_vm_->end_migration();
161 } // namespace simgrid::s4u
163 /* **************************** Public C interface *************************** */
165 /** @brief Create a new VM object with the default parameters
166 * A VM is treated as a host. The name of the VM must be unique among all hosts.
168 sg_vm_t sg_vm_create_core(sg_host_t pm, const char* name)
170 return sg_vm_create_multicore(pm, name, 1);
172 /** @brief Create a new VM object with the default parameters, but with a specified amount of cores
173 * A VM is treated as a host. The name of the VM must be unique among all hosts.
175 sg_vm_t sg_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
177 return pm->create_vm(name, coreAmount);
180 const char* sg_vm_get_name(const_sg_vm_t vm)
182 return vm->get_cname();
185 /** @brief Get the physical host of a given VM. */
186 sg_host_t sg_vm_get_pm(const_sg_vm_t vm)
191 void sg_vm_set_ramsize(sg_vm_t vm, size_t size)
193 vm->set_ramsize(size);
196 size_t sg_vm_get_ramsize(const_sg_vm_t vm)
198 return vm->get_ramsize();
201 void sg_vm_set_bound(sg_vm_t vm, double bound)
203 vm->set_bound(bound);
206 /** @brief Returns whether the given VM has just created, not running. */
207 int sg_vm_is_created(const_sg_vm_t vm)
209 return vm->get_state() == simgrid::s4u::VirtualMachine::State::CREATED;
212 /** @brief Returns whether the given VM is currently running */
213 int sg_vm_is_running(const_sg_vm_t vm)
215 return vm->get_state() == simgrid::s4u::VirtualMachine::State::RUNNING;
218 /** @brief Returns whether the given VM is currently suspended, not running. */
219 int sg_vm_is_suspended(const_sg_vm_t vm)
221 return vm->get_state() == simgrid::s4u::VirtualMachine::State::SUSPENDED;
224 /** @brief Start a vm (i.e., boot the guest operating system)
225 * If the VM cannot be started (because of memory over-provisioning), an exception is generated.
227 void sg_vm_start(sg_vm_t vm)
232 /** @brief Immediately suspend the execution of all processes within the given VM.
234 * This function stops the execution of the VM. All the processes on this VM
235 * will pause. The state of the VM is preserved. We can later resume it again.
237 * No suspension cost occurs.
239 void sg_vm_suspend(sg_vm_t vm)
244 /** @brief Resume the execution of the VM. All processes on the VM run again.
245 * No resume cost occurs.
247 void sg_vm_resume(sg_vm_t vm)
252 /** @brief Immediately kills all processes within the given VM.
256 The memory allocated by these actors is leaked, unless you used :cpp:func:`simgrid::s4u::Actor::on_exit`.
260 * No extra delay occurs by default. You may let your actor sleep by a specific amount to simulate any extra delay that
263 void sg_vm_shutdown(sg_vm_t vm)
268 /** @brief Destroy a VM. Destroy the VM object from the simulation. */
269 void sg_vm_destroy(sg_vm_t vm)