1 /* Copyright (c) 2015-2022. 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/Exception.hpp>
7 #include <simgrid/kernel/routing/NetPoint.hpp>
8 #include <simgrid/vm.h>
10 #include "src/kernel/resource/VirtualMachineImpl.hpp"
11 #include "src/surf/cpu_cas01.hpp"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_vm, s4u, "S4U virtual machines");
15 namespace simgrid::s4u {
16 xbt::signal<void(VirtualMachine&)> VirtualMachine::on_vm_creation;
17 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_start;
18 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_started;
19 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_shutdown;
20 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_suspend;
21 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_resume;
22 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_migration_start;
23 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_migration_end;
24 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_vm_destruction;
26 xbt::Extension<Host, VmHostExt> VmHostExt::EXTENSION_ID;
28 void VmHostExt::ensureVmExtInstalled()
30 if (not EXTENSION_ID.valid())
31 EXTENSION_ID = Host::extension_create<VmHostExt>();
34 VirtualMachine::VirtualMachine(const std::string& name, s4u::Host* physical_host, int core_amount, size_t ramsize)
35 : Host(new kernel::resource::VirtualMachineImpl(name, this, physical_host, core_amount, ramsize))
36 , pimpl_vm_(dynamic_cast<kernel::resource::VirtualMachineImpl*>(Host::get_impl()))
38 physical_host->get_impl()->create_vm(name, this);
41 VirtualMachine::VirtualMachine(kernel::resource::VirtualMachineImpl* impl)
42 : Host(impl), pimpl_vm_(dynamic_cast<kernel::resource::VirtualMachineImpl*>(Host::get_impl()))
46 void VirtualMachine::start()
48 kernel::actor::simcall_answered([this]() { pimpl_vm_->start(); });
51 void VirtualMachine::suspend()
53 const kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
54 kernel::actor::simcall_answered([this, issuer]() { pimpl_vm_->suspend(issuer); });
57 void VirtualMachine::resume()
62 void VirtualMachine::shutdown()
64 kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
65 kernel::actor::simcall_answered([this, issuer]() { pimpl_vm_->shutdown(issuer); });
68 void VirtualMachine::destroy()
70 auto destroy_code = [this]() {
71 /* First, terminate all processes on the VM if necessary */
74 XBT_DEBUG("destroy %s", get_cname());
75 on_vm_destruction(*this);
76 /* Then, destroy the VM object */
77 kernel::actor::simcall_answered(
78 [this]() { get_vm_impl()->get_physical_host()->get_impl()->destroy_vm(get_name()); });
81 if (not this_actor::is_maestro() && this_actor::get_host() == this) {
82 XBT_VERB("Launch another actor on physical host %s to destroy my own VM: %s", get_pm()->get_cname(), get_cname());
83 simgrid::s4u::Actor::create(get_cname() + std::string("-vm_destroy"), get_pm(), destroy_code);
84 simgrid::s4u::this_actor::yield();
85 XBT_CRITICAL("I should be dead now!");
92 simgrid::s4u::Host* VirtualMachine::get_pm() const
94 return pimpl_vm_->get_physical_host();
97 VirtualMachine* VirtualMachine::set_pm(simgrid::s4u::Host* pm)
99 kernel::actor::simcall_answered([this, pm]() { pimpl_vm_->set_physical_host(pm); });
103 VirtualMachine::State VirtualMachine::get_state() const
105 return kernel::actor::simcall_answered([this]() { return pimpl_vm_->get_state(); });
108 size_t VirtualMachine::get_ramsize() const
110 return pimpl_vm_->get_ramsize();
113 VirtualMachine* VirtualMachine::set_ramsize(size_t ramsize)
115 pimpl_vm_->set_ramsize(ramsize);
118 /** @brief Set a CPU bound for a given VM.
121 * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
124 * On PM0, there are Task1 and VM0.
125 * On VM0, there is Task2.
126 * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
128 * Task1\@PM0 gets 50%.
129 * Task2\@VM0 gets 25%.
130 * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
132 * 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
133 * the dummy CPU action. The bound of the dummy CPU action is unlimited.
135 * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
136 * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
137 * on the VM in share_resource() or we have to trap both the start and end of task execution.
139 * The current solution is to use setBound(), which allows us to directly set the bound of the dummy CPU action.
141 * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
142 * computation task (or a VM) never exceeds the capacity of a CPU core.
144 VirtualMachine* VirtualMachine::set_bound(double bound)
146 kernel::actor::simcall_answered([this, bound]() { pimpl_vm_->set_bound(bound); });
150 void VirtualMachine::start_migration() const
152 pimpl_vm_->start_migration();
155 void VirtualMachine::end_migration() const
157 pimpl_vm_->end_migration();
160 } // namespace simgrid::s4u
162 /* **************************** Public C interface *************************** */
164 /** @brief Create a new VM object with the default parameters
165 * A VM is treated as a host. The name of the VM must be unique among all hosts.
167 sg_vm_t sg_vm_create_core(sg_host_t pm, const char* name)
169 return sg_vm_create_multicore(pm, name, 1);
171 /** @brief Create a new VM object with the default parameters, but with a specified amount of cores
172 * A VM is treated as a host. The name of the VM must be unique among all hosts.
174 sg_vm_t sg_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
176 return pm->create_vm(name, coreAmount);
179 const char* sg_vm_get_name(const_sg_vm_t vm)
181 return vm->get_cname();
184 /** @brief Get the physical host of a given VM. */
185 sg_host_t sg_vm_get_pm(const_sg_vm_t vm)
190 void sg_vm_set_ramsize(sg_vm_t vm, size_t size)
192 vm->set_ramsize(size);
195 size_t sg_vm_get_ramsize(const_sg_vm_t vm)
197 return vm->get_ramsize();
200 void sg_vm_set_bound(sg_vm_t vm, double bound)
202 vm->set_bound(bound);
205 /** @brief Returns whether the given VM has just created, not running. */
206 int sg_vm_is_created(const_sg_vm_t vm)
208 return vm->get_state() == simgrid::s4u::VirtualMachine::State::CREATED;
211 /** @brief Returns whether the given VM is currently running */
212 int sg_vm_is_running(const_sg_vm_t vm)
214 return vm->get_state() == simgrid::s4u::VirtualMachine::State::RUNNING;
217 /** @brief Returns whether the given VM is currently suspended, not running. */
218 int sg_vm_is_suspended(const_sg_vm_t vm)
220 return vm->get_state() == simgrid::s4u::VirtualMachine::State::SUSPENDED;
223 /** @brief Start a vm (i.e., boot the guest operating system)
224 * If the VM cannot be started (because of memory over-provisioning), an exception is generated.
226 void sg_vm_start(sg_vm_t vm)
231 /** @brief Immediately suspend the execution of all processes within the given VM.
233 * This function stops the execution of the VM. All the processes on this VM
234 * will pause. The state of the VM is preserved. We can later resume it again.
236 * No suspension cost occurs.
238 void sg_vm_suspend(sg_vm_t vm)
243 /** @brief Resume the execution of the VM. All processes on the VM run again.
244 * No resume cost occurs.
246 void sg_vm_resume(sg_vm_t vm)
251 /** @brief Immediately kills all processes within the given VM.
255 The memory allocated by these actors is leaked, unless you used :cpp:func:`simgrid::s4u::Actor::on_exit`.
259 * No extra delay occurs by default. You may let your actor sleep by a specific amount to simulate any extra delay that
262 void sg_vm_shutdown(sg_vm_t vm)
267 /** @brief Destroy a VM. Destroy the VM object from the simulation. */
268 void sg_vm_destroy(sg_vm_t vm)