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;
36 // Create a VCPU for this VM
37 surf::CpuCas01* sub_cpu = dynamic_cast<surf::CpuCas01*>(pm->pimpl_cpu);
39 pimpl_cpu = surf_cpu_model_vm->createCpu(this, sub_cpu->getSpeedPeakList(), coreAmount);
40 if (sub_cpu->getPState() != 0)
41 pimpl_cpu->setPState(sub_cpu->getPState());
43 /* Make a process container */
44 extension_set<simgrid::simix::Host>(new simgrid::simix::Host());
47 VirtualMachine::~VirtualMachine()
51 XBT_DEBUG("destroy %s", get_cname());
53 /* FIXME: this is really strange that everything fails if the next line is removed.
54 * This is as if we shared these data with the PM, which definitely should not be the case...
56 * We need to test that suspending a VM does not suspends the processes running on its PM, for example.
57 * Or we need to simplify this code enough to make it actually readable (but this sounds harder than testing)
59 extension_set<simgrid::simix::Host>(nullptr);
61 /* Don't free these things twice: they are the ones of my physical host */
62 pimpl_netpoint = nullptr;
65 void VirtualMachine::start()
69 simgrid::simix::simcall([this]() {
70 simgrid::vm::VmHostExt::ensureVmExtInstalled();
72 simgrid::s4u::Host* pm = this->pimpl_vm_->getPm();
73 if (pm->extension<simgrid::vm::VmHostExt>() == nullptr)
74 pm->extension_set(new simgrid::vm::VmHostExt());
76 long pm_ramsize = pm->extension<simgrid::vm::VmHostExt>()->ramsize;
77 int pm_overcommit = pm->extension<simgrid::vm::VmHostExt>()->overcommit;
78 long vm_ramsize = this->getRamsize();
80 if (pm_ramsize && not pm_overcommit) { /* Only verify that we don't overcommit on need */
81 /* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
82 long total_ramsize_of_vms = 0;
83 for (simgrid::s4u::VirtualMachine* const& ws_vm : simgrid::vm::VirtualMachineImpl::allVms_)
84 if (pm == ws_vm->getPm())
85 total_ramsize_of_vms += ws_vm->getRamsize();
87 if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
88 XBT_WARN("cannot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
89 this->get_cname(), pm->get_cname(), vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
90 THROWF(vm_error, 0, "Memory shortage on host '%s', VM '%s' cannot be started", pm->get_cname(),
95 this->pimpl_vm_->setState(SURF_VM_STATE_RUNNING);
101 void VirtualMachine::suspend()
104 smx_actor_t issuer = SIMIX_process_self();
105 simgrid::simix::simcall([this, issuer]() { pimpl_vm_->suspend(issuer); });
108 void VirtualMachine::resume()
114 void VirtualMachine::shutdown()
116 smx_actor_t issuer = SIMIX_process_self();
117 simgrid::simix::simcall([this, issuer]() { pimpl_vm_->shutdown(issuer); });
121 void VirtualMachine::destroy()
123 /* First, terminate all processes on the VM if necessary */
126 /* Then, destroy the VM object */
130 simgrid::s4u::Host* VirtualMachine::getPm()
132 return pimpl_vm_->getPm();
135 void VirtualMachine::setPm(simgrid::s4u::Host* pm)
137 simgrid::simix::simcall([this, pm]() { pimpl_vm_->setPm(pm); });
140 e_surf_vm_state_t VirtualMachine::getState()
142 return simgrid::simix::simcall([this]() { return pimpl_vm_->getState(); });
145 size_t VirtualMachine::getRamsize()
147 return pimpl_vm_->getRamsize();
150 void VirtualMachine::setRamsize(size_t ramsize)
152 pimpl_vm_->setRamsize(ramsize);
154 /** @brief Set a CPU bound for a given VM.
157 * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
160 * On PM0, there are Task1 and VM0.
161 * On VM0, there is Task2.
162 * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
164 * Task1\@PM0 gets 50%.
165 * Task2\@VM0 gets 25%.
166 * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
168 * 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
169 * the dummy CPU action. The bound of the dummy CPU action is unlimited.
171 * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
172 * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
173 * on the VM in share_resource() or we have to trap both the start and end of task execution.
175 * The current solution is to use setBound(), which allows us to directly set the bound of the dummy CPU action.
177 * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
178 * computation task (or a VM) never exceeds the capacity of a CPU core.
180 void VirtualMachine::setBound(double bound)
182 simgrid::simix::simcall([this, bound]() { pimpl_vm_->setBound(bound); });
185 } // namespace simgrid
188 /* **************************** Public C interface *************************** */
190 /** @brief Create a new VM object with the default parameters
191 * A VM is treated as a host. The name of the VM must be unique among all hosts.
193 sg_vm_t sg_vm_create_core(sg_host_t pm, const char* name)
195 return sg_vm_create_multicore(pm, name, 1);
197 /** @brief Create a new VM object with the default parameters, but with a specified amount of cores
198 * A VM is treated as a host. The name of the VM must be unique among all hosts.
200 sg_vm_t sg_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
202 xbt_assert(sg_host_by_name(name) == nullptr,
203 "Cannot create a VM named %s: this name is already used by an host or a VM", name);
205 return new simgrid::s4u::VirtualMachine(name, pm, coreAmount);
208 const char* sg_vm_get_name(sg_vm_t vm)
210 return vm->get_cname();
213 /** @brief Get the physical host of a given VM. */
214 sg_host_t sg_vm_get_pm(sg_vm_t vm)
219 void sg_vm_set_ramsize(sg_vm_t vm, size_t size)
221 vm->setRamsize(size);
224 size_t sg_vm_get_ramsize(sg_vm_t vm)
226 return vm->getRamsize();
229 void sg_vm_set_bound(sg_vm_t vm, double bound)
234 /** @brief Returns whether the given VM has just created, not running. */
235 int sg_vm_is_created(sg_vm_t vm)
237 return vm->getState() == SURF_VM_STATE_CREATED;
240 /** @brief Returns whether the given VM is currently running */
241 int sg_vm_is_running(sg_vm_t vm)
243 return vm->getState() == SURF_VM_STATE_RUNNING;
246 /** @brief Returns whether the given VM is currently suspended, not running. */
247 int sg_vm_is_suspended(sg_vm_t vm)
249 return vm->getState() == SURF_VM_STATE_SUSPENDED;
252 /** @brief Start a vm (i.e., boot the guest operating system)
253 * If the VM cannot be started (because of memory over-provisioning), an exception is generated.
255 void sg_vm_start(sg_vm_t vm)
260 /** @brief Immediately suspend the execution of all processes within the given VM.
262 * This function stops the execution of the VM. All the processes on this VM
263 * will pause. The state of the VM is preserved. We can later resume it again.
265 * No suspension cost occurs.
267 void sg_vm_suspend(sg_vm_t vm)
272 /** @brief Resume the execution of the VM. All processes on the VM run again.
273 * No resume cost occurs.
275 void sg_vm_resume(sg_vm_t vm)
280 /** @brief Immediately kills all processes within the given VM.
281 * Any memory that they allocated will be leaked, unless you used #MSG_process_on_exit().
283 * No extra delay occurs. If you want to simulate this too, you want to use a #MSG_process_sleep().
285 void sg_vm_shutdown(sg_vm_t vm)
290 /** @brief Destroy a VM. Destroy the VM object from the simulation. */
291 void sg_vm_destroy(sg_vm_t vm)