1 /* Copyright (c) 2015-2018. 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/s4u/Actor.hpp"
7 #include "simgrid/vm.h"
8 #include "src/plugins/vm/VirtualMachineImpl.hpp"
9 #include "src/plugins/vm/VmHostExt.hpp"
10 #include "src/simix/smx_host_private.hpp"
11 #include "src/surf/cpu_cas01.hpp"
13 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_vm, "S4U virtual machines");
18 simgrid::xbt::signal<void(VirtualMachine&)> VirtualMachine::on_start;
19 simgrid::xbt::signal<void(VirtualMachine&)> VirtualMachine::on_started;
20 simgrid::xbt::signal<void(VirtualMachine&)> VirtualMachine::on_shutdown;
21 simgrid::xbt::signal<void(VirtualMachine&)> VirtualMachine::on_suspend;
22 simgrid::xbt::signal<void(VirtualMachine&)> VirtualMachine::on_resume;
24 VirtualMachine::VirtualMachine(const char* name, s4u::Host* pm, int coreAmount)
25 : VirtualMachine(name, pm, coreAmount, 1024)
29 VirtualMachine::VirtualMachine(const char* name, s4u::Host* pm, int coreAmount, size_t ramsize)
30 : Host(name), pimpl_vm_(new vm::VirtualMachineImpl(this, pm, coreAmount, ramsize))
32 XBT_DEBUG("Create VM %s", name);
34 /* Currently, a VM uses the network resource of its physical host */
35 pimpl_netpoint = pm->pimpl_netpoint;
37 // Create a VCPU for this VM
38 std::vector<double> speeds;
39 for (int i = 0; i < pm->get_pstate_count(); i++)
40 speeds.push_back(pm->getPstateSpeed(i));
42 surf_cpu_model_vm->create_cpu(this, &speeds, pm->get_core_count());
43 if (pm->get_pstate() != 0)
44 set_pstate(pm->get_pstate());
46 /* Make a process container */
47 extension_set<simgrid::simix::Host>(new simgrid::simix::Host());
50 VirtualMachine::~VirtualMachine()
52 on_destruction(*this);
54 XBT_DEBUG("destroy %s", get_cname());
56 /* FIXME: this is really strange that everything fails if the next line is removed.
57 * This is as if we shared these data with the PM, which definitely should not be the case...
59 * We need to test that suspending a VM does not suspends the processes running on its PM, for example.
60 * Or we need to simplify this code enough to make it actually readable (but this sounds harder than testing)
62 extension_set<simgrid::simix::Host>(nullptr);
64 /* Don't free these things twice: they are the ones of my physical host */
65 pimpl_netpoint = nullptr;
68 void VirtualMachine::start()
72 simgrid::simix::simcall([this]() {
73 simgrid::vm::VmHostExt::ensureVmExtInstalled();
75 simgrid::s4u::Host* pm = this->pimpl_vm_->getPm();
76 if (pm->extension<simgrid::vm::VmHostExt>() == nullptr)
77 pm->extension_set(new simgrid::vm::VmHostExt());
79 long pm_ramsize = pm->extension<simgrid::vm::VmHostExt>()->ramsize;
80 int pm_overcommit = pm->extension<simgrid::vm::VmHostExt>()->overcommit;
81 long vm_ramsize = this->getRamsize();
83 if (pm_ramsize && not pm_overcommit) { /* Only verify that we don't overcommit on need */
84 /* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
85 long total_ramsize_of_vms = 0;
86 for (simgrid::s4u::VirtualMachine* const& ws_vm : simgrid::vm::VirtualMachineImpl::allVms_)
87 if (pm == ws_vm->getPm())
88 total_ramsize_of_vms += ws_vm->getRamsize();
90 if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
91 XBT_WARN("cannot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
92 this->get_cname(), pm->get_cname(), vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
93 THROWF(vm_error, 0, "Memory shortage on host '%s', VM '%s' cannot be started", pm->get_cname(),
98 this->pimpl_vm_->setState(SURF_VM_STATE_RUNNING);
104 void VirtualMachine::suspend()
107 smx_actor_t issuer = SIMIX_process_self();
108 simgrid::simix::simcall([this, issuer]() { pimpl_vm_->suspend(issuer); });
111 void VirtualMachine::resume()
117 void VirtualMachine::shutdown()
119 smx_actor_t issuer = SIMIX_process_self();
120 simgrid::simix::simcall([this, issuer]() { pimpl_vm_->shutdown(issuer); });
124 void VirtualMachine::destroy()
126 /* First, terminate all processes on the VM if necessary */
129 /* Then, destroy the VM object */
133 simgrid::s4u::Host* VirtualMachine::getPm()
135 return pimpl_vm_->getPm();
138 void VirtualMachine::setPm(simgrid::s4u::Host* pm)
140 simgrid::simix::simcall([this, pm]() { pimpl_vm_->setPm(pm); });
143 e_surf_vm_state_t VirtualMachine::getState()
145 return simgrid::simix::simcall([this]() { return pimpl_vm_->getState(); });
148 size_t VirtualMachine::getRamsize()
150 return pimpl_vm_->getRamsize();
153 void VirtualMachine::setRamsize(size_t ramsize)
155 pimpl_vm_->setRamsize(ramsize);
157 /** @brief Set a CPU bound for a given VM.
160 * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
163 * On PM0, there are Task1 and VM0.
164 * On VM0, there is Task2.
165 * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
167 * Task1\@PM0 gets 50%.
168 * Task2\@VM0 gets 25%.
169 * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
171 * 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
172 * the dummy CPU action. The bound of the dummy CPU action is unlimited.
174 * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
175 * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
176 * on the VM in share_resource() or we have to trap both the start and end of task execution.
178 * The current solution is to use setBound(), which allows us to directly set the bound of the dummy CPU action.
180 * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
181 * computation task (or a VM) never exceeds the capacity of a CPU core.
183 void VirtualMachine::setBound(double bound)
185 simgrid::simix::simcall([this, bound]() { pimpl_vm_->setBound(bound); });
188 } // namespace simgrid
191 /* **************************** Public C interface *************************** */
193 /** @brief Create a new VM object with the default parameters
194 * A VM is treated as a host. The name of the VM must be unique among all hosts.
196 sg_vm_t sg_vm_create_core(sg_host_t pm, const char* name)
198 return sg_vm_create_multicore(pm, name, 1);
200 /** @brief Create a new VM object with the default parameters, but with a specified amount of cores
201 * A VM is treated as a host. The name of the VM must be unique among all hosts.
203 sg_vm_t sg_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
205 xbt_assert(sg_host_by_name(name) == nullptr,
206 "Cannot create a VM named %s: this name is already used by an host or a VM", name);
208 return new simgrid::s4u::VirtualMachine(name, pm, coreAmount);
211 const char* sg_vm_get_name(sg_vm_t vm)
213 return vm->get_cname();
216 /** @brief Get the physical host of a given VM. */
217 sg_host_t sg_vm_get_pm(sg_vm_t vm)
222 void sg_vm_set_ramsize(sg_vm_t vm, size_t size)
224 vm->setRamsize(size);
227 size_t sg_vm_get_ramsize(sg_vm_t vm)
229 return vm->getRamsize();
232 void sg_vm_set_bound(sg_vm_t vm, double bound)
237 /** @brief Returns whether the given VM has just created, not running. */
238 int sg_vm_is_created(sg_vm_t vm)
240 return vm->getState() == SURF_VM_STATE_CREATED;
243 /** @brief Returns whether the given VM is currently running */
244 int sg_vm_is_running(sg_vm_t vm)
246 return vm->getState() == SURF_VM_STATE_RUNNING;
249 /** @brief Returns whether the given VM is currently suspended, not running. */
250 int sg_vm_is_suspended(sg_vm_t vm)
252 return vm->getState() == SURF_VM_STATE_SUSPENDED;
255 /** @brief Start a vm (i.e., boot the guest operating system)
256 * If the VM cannot be started (because of memory over-provisioning), an exception is generated.
258 void sg_vm_start(sg_vm_t vm)
263 /** @brief Immediately suspend the execution of all processes within the given VM.
265 * This function stops the execution of the VM. All the processes on this VM
266 * will pause. The state of the VM is preserved. We can later resume it again.
268 * No suspension cost occurs.
270 void sg_vm_suspend(sg_vm_t vm)
275 /** @brief Resume the execution of the VM. All processes on the VM run again.
276 * No resume cost occurs.
278 void sg_vm_resume(sg_vm_t vm)
283 /** @brief Immediately kills all processes within the given VM.
284 * Any memory that they allocated will be leaked, unless you used #MSG_process_on_exit().
286 * No extra delay occurs. If you want to simulate this too, you want to use a #MSG_process_sleep().
288 void sg_vm_shutdown(sg_vm_t vm)
293 /** @brief Destroy a VM. Destroy the VM object from the simulation. */
294 void sg_vm_destroy(sg_vm_t vm)