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* physical_host, int core_amount)
25 : VirtualMachine(name, physical_host, core_amount, 1024)
29 VirtualMachine::VirtualMachine(const char* name, s4u::Host* physical_host, int core_amount, size_t ramsize)
30 : Host(name), pimpl_vm_(new vm::VirtualMachineImpl(this, physical_host, core_amount, ramsize))
32 XBT_DEBUG("Create VM %s", name);
34 /* Currently, a VM uses the network resource of its physical host */
35 pimpl_netpoint = physical_host->pimpl_netpoint;
37 // Create a VCPU for this VM
38 std::vector<double> speeds;
39 for (int i = 0; i < physical_host->get_pstate_count(); i++)
40 speeds.push_back(physical_host->get_pstate_speed(i));
42 surf_cpu_model_vm->create_cpu(this, &speeds, physical_host->get_core_count());
43 if (physical_host->get_pstate() != 0)
44 set_pstate(physical_host->get_pstate());
47 VirtualMachine::~VirtualMachine()
49 on_destruction(*this);
51 XBT_DEBUG("destroy %s", get_cname());
53 /* Don't free these things twice: they are the ones of my physical host */
54 pimpl_netpoint = nullptr;
57 void VirtualMachine::start()
61 simgrid::simix::simcall([this]() {
62 simgrid::vm::VmHostExt::ensureVmExtInstalled();
64 simgrid::s4u::Host* pm = this->pimpl_vm_->get_physical_host();
65 if (pm->extension<simgrid::vm::VmHostExt>() == nullptr)
66 pm->extension_set(new simgrid::vm::VmHostExt());
68 long pm_ramsize = pm->extension<simgrid::vm::VmHostExt>()->ramsize;
69 int pm_overcommit = pm->extension<simgrid::vm::VmHostExt>()->overcommit;
70 long vm_ramsize = this->get_ramsize();
72 if (pm_ramsize && not pm_overcommit) { /* Only verify that we don't overcommit on need */
73 /* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
74 long total_ramsize_of_vms = 0;
75 for (simgrid::s4u::VirtualMachine* const& ws_vm : simgrid::vm::VirtualMachineImpl::allVms_)
76 if (pm == ws_vm->get_pm())
77 total_ramsize_of_vms += ws_vm->get_ramsize();
79 if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
80 XBT_WARN("cannot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
81 this->get_cname(), pm->get_cname(), vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
82 THROWF(vm_error, 0, "Memory shortage on host '%s', VM '%s' cannot be started", pm->get_cname(),
87 this->pimpl_vm_->set_state(VirtualMachine::state::RUNNING);
93 void VirtualMachine::suspend()
96 smx_actor_t issuer = SIMIX_process_self();
97 simgrid::simix::simcall([this, issuer]() { pimpl_vm_->suspend(issuer); });
100 void VirtualMachine::resume()
106 void VirtualMachine::shutdown()
108 smx_actor_t issuer = SIMIX_process_self();
109 simgrid::simix::simcall([this, issuer]() { pimpl_vm_->shutdown(issuer); });
113 void VirtualMachine::destroy()
115 /* First, terminate all processes on the VM if necessary */
118 /* Then, destroy the VM object */
122 simgrid::s4u::Host* VirtualMachine::get_pm()
124 return pimpl_vm_->get_physical_host();
127 void VirtualMachine::set_pm(simgrid::s4u::Host* pm)
129 simgrid::simix::simcall([this, pm]() { pimpl_vm_->set_physical_host(pm); });
132 VirtualMachine::state VirtualMachine::get_state()
134 return simgrid::simix::simcall([this]() { return pimpl_vm_->get_state(); });
137 size_t VirtualMachine::get_ramsize()
139 return pimpl_vm_->get_ramsize();
142 void VirtualMachine::set_ramsize(size_t ramsize)
144 pimpl_vm_->set_ramsize(ramsize);
146 /** @brief Set a CPU bound for a given VM.
149 * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
152 * On PM0, there are Task1 and VM0.
153 * On VM0, there is Task2.
154 * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
156 * Task1\@PM0 gets 50%.
157 * Task2\@VM0 gets 25%.
158 * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
160 * 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
161 * the dummy CPU action. The bound of the dummy CPU action is unlimited.
163 * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
164 * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
165 * on the VM in share_resource() or we have to trap both the start and end of task execution.
167 * The current solution is to use setBound(), which allows us to directly set the bound of the dummy CPU action.
169 * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
170 * computation task (or a VM) never exceeds the capacity of a CPU core.
172 void VirtualMachine::set_bound(double bound)
174 simgrid::simix::simcall([this, bound]() { pimpl_vm_->set_bound(bound); });
177 } // namespace simgrid
180 /* **************************** Public C interface *************************** */
182 /** @brief Create a new VM object with the default parameters
183 * A VM is treated as a host. The name of the VM must be unique among all hosts.
185 sg_vm_t sg_vm_create_core(sg_host_t pm, const char* name)
187 return sg_vm_create_multicore(pm, name, 1);
189 /** @brief Create a new VM object with the default parameters, but with a specified amount of cores
190 * A VM is treated as a host. The name of the VM must be unique among all hosts.
192 sg_vm_t sg_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
194 xbt_assert(sg_host_by_name(name) == nullptr,
195 "Cannot create a VM named %s: this name is already used by an host or a VM", name);
197 return new simgrid::s4u::VirtualMachine(name, pm, coreAmount);
200 const char* sg_vm_get_name(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(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(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.
273 * Any memory that they allocated will be leaked, unless you used #MSG_process_on_exit().
275 * No extra delay occurs. If you want to simulate this too, you want to use a #MSG_process_sleep().
277 void sg_vm_shutdown(sg_vm_t vm)
282 /** @brief Destroy a VM. Destroy the VM object from the simulation. */
283 void sg_vm_destroy(sg_vm_t vm)