1 /* Copyright (c) 2015-2020. 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/s4u/Actor.hpp"
8 #include "simgrid/vm.h"
9 #include "src/include/surf/surf.hpp"
10 #include "src/plugins/vm/VirtualMachineImpl.hpp"
11 #include "src/plugins/vm/VmHostExt.hpp"
12 #include "src/surf/cpu_cas01.hpp"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_vm, s4u, "S4U virtual machines");
18 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_start;
19 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_started;
20 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_shutdown;
21 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_suspend;
22 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_resume;
23 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_migration_start;
24 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_migration_end;
26 VirtualMachine::VirtualMachine(const std::string& name, s4u::Host* physical_host, int core_amount)
27 : VirtualMachine(name, physical_host, core_amount, 1024)
31 VirtualMachine::VirtualMachine(const std::string& name, s4u::Host* physical_host, int core_amount, size_t ramsize)
32 : Host(name), pimpl_vm_(new vm::VirtualMachineImpl(this, physical_host, core_amount, ramsize))
34 XBT_DEBUG("Create VM %s", get_cname());
36 /* Currently, a VM uses the network resource of its physical host */
37 set_netpoint(physical_host->get_netpoint());
39 // Create a VCPU for this VM
40 std::vector<double> speeds;
41 for (int i = 0; i < physical_host->get_pstate_count(); i++)
42 speeds.push_back(physical_host->get_pstate_speed(i));
44 surf_cpu_model_vm->create_cpu(this, speeds, core_amount);
45 if (physical_host->get_pstate() != 0)
46 set_pstate(physical_host->get_pstate());
49 VirtualMachine::~VirtualMachine()
51 on_destruction(*this);
53 XBT_DEBUG("destroy %s", get_cname());
55 /* Don't free these things twice: they are the ones of my physical host */
56 set_netpoint(nullptr);
59 void VirtualMachine::start()
63 kernel::actor::simcall([this]() {
64 vm::VmHostExt::ensureVmExtInstalled();
66 Host* pm = this->pimpl_vm_->get_physical_host();
67 if (pm->extension<vm::VmHostExt>() == nullptr)
68 pm->extension_set(new vm::VmHostExt());
70 long pm_ramsize = pm->extension<vm::VmHostExt>()->ramsize;
71 int pm_overcommit = pm->extension<vm::VmHostExt>()->overcommit;
72 long vm_ramsize = this->get_ramsize();
74 if (pm_ramsize && not pm_overcommit) { /* Only verify that we don't overcommit on need */
75 /* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
76 long total_ramsize_of_vms = 0;
77 for (VirtualMachine* const& ws_vm : vm::VirtualMachineImpl::allVms_)
78 if (pm == ws_vm->get_pm())
79 total_ramsize_of_vms += ws_vm->get_ramsize();
81 if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
82 XBT_WARN("cannot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
83 this->get_cname(), pm->get_cname(), vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
84 throw VmFailureException(XBT_THROW_POINT,
85 xbt::string_printf("Memory shortage on host '%s', VM '%s' cannot be started",
86 pm->get_cname(), this->get_cname()));
90 this->pimpl_vm_->set_state(VirtualMachine::state::RUNNING);
96 void VirtualMachine::suspend()
99 kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
100 kernel::actor::simcall([this, issuer]() { pimpl_vm_->suspend(issuer); });
103 void VirtualMachine::resume()
109 void VirtualMachine::shutdown()
111 kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
112 kernel::actor::simcall([this, issuer]() { pimpl_vm_->shutdown(issuer); });
116 void VirtualMachine::destroy()
118 /* First, terminate all processes on the VM if necessary */
121 /* Then, destroy the VM object */
125 simgrid::s4u::Host* VirtualMachine::get_pm() const
127 return pimpl_vm_->get_physical_host();
130 void VirtualMachine::set_pm(simgrid::s4u::Host* pm)
132 kernel::actor::simcall([this, pm]() { pimpl_vm_->set_physical_host(pm); });
135 VirtualMachine::state VirtualMachine::get_state()
137 return kernel::actor::simcall([this]() { return pimpl_vm_->get_state(); });
140 size_t VirtualMachine::get_ramsize() const
142 return pimpl_vm_->get_ramsize();
145 void VirtualMachine::set_ramsize(size_t ramsize)
147 pimpl_vm_->set_ramsize(ramsize);
149 /** @brief Set a CPU bound for a given VM.
152 * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
155 * On PM0, there are Task1 and VM0.
156 * On VM0, there is Task2.
157 * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
159 * Task1\@PM0 gets 50%.
160 * Task2\@VM0 gets 25%.
161 * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
163 * 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
164 * the dummy CPU action. The bound of the dummy CPU action is unlimited.
166 * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
167 * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
168 * on the VM in share_resource() or we have to trap both the start and end of task execution.
170 * The current solution is to use setBound(), which allows us to directly set the bound of the dummy CPU action.
172 * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
173 * computation task (or a VM) never exceeds the capacity of a CPU core.
175 void VirtualMachine::set_bound(double bound)
177 kernel::actor::simcall([this, bound]() { pimpl_vm_->set_bound(bound); });
180 } // namespace simgrid
183 /* **************************** Public C interface *************************** */
185 /** @brief Create a new VM object with the default parameters
186 * A VM is treated as a host. The name of the VM must be unique among all hosts.
188 sg_vm_t sg_vm_create_core(sg_host_t pm, const char* name)
190 return sg_vm_create_multicore(pm, name, 1);
192 /** @brief Create a new VM object with the default parameters, but with a specified amount of cores
193 * A VM is treated as a host. The name of the VM must be unique among all hosts.
195 sg_vm_t sg_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
197 return new simgrid::s4u::VirtualMachine(name, pm, coreAmount);
200 const char* sg_vm_get_name(const_sg_vm_t vm)
202 return vm->get_cname();
205 /** @brief Get the physical host of a given VM. */
206 sg_host_t sg_vm_get_pm(const_sg_vm_t vm)
211 void sg_vm_set_ramsize(sg_vm_t vm, size_t size)
213 vm->set_ramsize(size);
216 size_t sg_vm_get_ramsize(const_sg_vm_t vm)
218 return vm->get_ramsize();
221 void sg_vm_set_bound(sg_vm_t vm, double bound)
223 vm->set_bound(bound);
226 /** @brief Returns whether the given VM has just created, not running. */
227 int sg_vm_is_created(sg_vm_t vm)
229 return vm->get_state() == simgrid::s4u::VirtualMachine::state::CREATED;
232 /** @brief Returns whether the given VM is currently running */
233 int sg_vm_is_running(sg_vm_t vm)
235 return vm->get_state() == simgrid::s4u::VirtualMachine::state::RUNNING;
238 /** @brief Returns whether the given VM is currently suspended, not running. */
239 int sg_vm_is_suspended(sg_vm_t vm)
241 return vm->get_state() == simgrid::s4u::VirtualMachine::state::SUSPENDED;
244 /** @brief Start a vm (i.e., boot the guest operating system)
245 * If the VM cannot be started (because of memory over-provisioning), an exception is generated.
247 void sg_vm_start(sg_vm_t vm)
252 /** @brief Immediately suspend the execution of all processes within the given VM.
254 * This function stops the execution of the VM. All the processes on this VM
255 * will pause. The state of the VM is preserved. We can later resume it again.
257 * No suspension cost occurs.
259 void sg_vm_suspend(sg_vm_t vm)
264 /** @brief Resume the execution of the VM. All processes on the VM run again.
265 * No resume cost occurs.
267 void sg_vm_resume(sg_vm_t vm)
272 /** @brief Immediately kills all processes within the given VM.
276 The memory allocated by these actors is leaked, unless you used :cpp:func:`simgrid::s4u::Actor::on_exit`.
280 * No extra delay occurs by default. You may let your actor sleep by a specific amount to simulate any extra delay that you want.
282 void sg_vm_shutdown(sg_vm_t vm)
287 /** @brief Destroy a VM. Destroy the VM object from the simulation. */
288 void sg_vm_destroy(sg_vm_t vm)