1 /* Copyright (c) 2013-2019. 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 "src/plugins/vm/VirtualMachineImpl.hpp"
7 #include "src/include/surf/surf.hpp"
8 #include "src/kernel/activity/ExecImpl.hpp"
9 #include "xbt/asserts.h" // xbt_log_no_loc
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_vm, surf, "Logging specific to the SURF VM module");
13 simgrid::vm::VMModel* surf_vm_model = nullptr;
15 void surf_vm_model_init_HL13()
17 if (surf_cpu_model_vm != nullptr)
18 surf_vm_model = new simgrid::vm::VMModel();
26 simgrid::xbt::signal<void(VirtualMachineImpl*)> VirtualMachineImpl::on_creation;
27 simgrid::xbt::signal<void(VirtualMachineImpl*)> VirtualMachineImpl::on_destruction;
33 std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
35 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
36 * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system.
37 * FIXME: add a configuration flag for this
39 const double virt_overhead = 1; // 0.95
41 static void host_state_change(s4u::Host& host)
43 if (not host.is_on()) { // just turned off.
44 std::vector<s4u::VirtualMachine*> trash;
45 /* Find all VMs living on that host */
46 for (s4u::VirtualMachine* const& vm : VirtualMachineImpl::allVms_)
47 if (vm->get_pm() == &host)
49 for (s4u::VirtualMachine* vm : trash)
54 static s4u::VirtualMachine* get_vm_from_task(kernel::activity::ActivityImplPtr task)
56 kernel::activity::ExecImpl* exec = dynamic_cast<kernel::activity::ExecImpl*>(task.get());
57 return exec != nullptr ? dynamic_cast<s4u::VirtualMachine*>(exec->host_) : nullptr;
60 static void add_active_task(kernel::activity::ActivityImplPtr task)
62 s4u::VirtualMachine* vm = get_vm_from_task(task);
64 VirtualMachineImpl *vm_impl = vm->get_impl();
65 vm_impl->active_tasks_ = vm_impl->active_tasks_ + 1;
66 vm_impl->update_action_weight();
70 static void remove_active_task(kernel::activity::ActivityImplPtr task)
72 s4u::VirtualMachine* vm = get_vm_from_task(task);
74 VirtualMachineImpl *vm_impl = vm->get_impl();
75 vm_impl->active_tasks_ = vm_impl->active_tasks_ - 1;
76 vm_impl->update_action_weight();
82 all_existing_models.push_back(this);
83 s4u::Host::on_state_change.connect(host_state_change);
84 kernel::activity::ExecImpl::on_creation.connect(add_active_task);
85 kernel::activity::ExecImpl::on_completion.connect(remove_active_task);
86 kernel::activity::ActivityImpl::on_resumed.connect(add_active_task);
87 kernel::activity::ActivityImpl::on_suspended.connect(remove_active_task);
90 double VMModel::next_occuring_event(double now)
92 /* TODO: update action's cost with the total cost of processes on the VM. */
94 /* 1. Now we know how many resource should be assigned to each virtual
95 * machine. We update constraints of the virtual machine layer.
97 * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
98 * X1 + X2 = C (Equation 1)
100 * the resource share of VM1: X1
101 * the resource share of VM2: X2
102 * the capacity of PM1: C
104 * Then, if we have two process (P1 and P2) on VM1.
105 * X1_1 + X1_2 = X1 (Equation 2)
107 * the resource share of P1: X1_1
108 * the resource share of P2: X1_2
109 * the capacity of VM1: X1
111 * Equation 1 was solved in the physical machine layer.
112 * Equation 2 is solved in the virtual machine layer (here).
113 * X1 must be passed to the virtual machine layer as a constraint value.
116 /* iterate for all virtual machines */
117 for (s4u::VirtualMachine* const& ws_vm : VirtualMachineImpl::allVms_) {
118 surf::Cpu* cpu = ws_vm->pimpl_cpu;
120 double solved_value =
121 ws_vm->get_impl()->action_->get_variable()->get_value(); // this is X1 in comment above, what
122 // this VM got in the sharing on the PM
123 XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->get_cname(), ws_vm->get_pm()->get_cname());
125 xbt_assert(cpu->get_model() == surf_cpu_model_vm);
126 kernel::lmm::System* vcpu_system = cpu->get_model()->get_maxmin_system();
127 vcpu_system->update_constraint_bound(cpu->get_constraint(), virt_overhead * solved_value);
130 /* 2. Ready. Get the next occurring event */
131 return surf_cpu_model_vm->next_occuring_event(now);
138 VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::VirtualMachine* piface, simgrid::s4u::Host* host_PM,
139 int core_amount, size_t ramsize)
140 : HostImpl(piface), physical_host_(host_PM), core_amount_(core_amount), user_bound_(std::numeric_limits<double>::max()), ramsize_(ramsize)
142 /* Register this VM to the list of all VMs */
143 allVms_.push_back(piface);
145 /* We create cpu_action corresponding to a VM process on the host operating system. */
146 /* TODO: we have to periodically input GUESTOS_NOISE to the system? how ?
147 * The value for GUESTOS_NOISE corresponds to the cost of the global action associated to the VM. It corresponds to
148 * the cost of a VM running no tasks.
150 action_ = host_PM->pimpl_cpu->execution_start(0, core_amount);
152 // It's empty for now, so it should not request resources in the PM
153 update_action_weight();
155 XBT_VERB("Create VM(%s)@PM(%s)", piface->get_cname(), physical_host_->get_cname());
159 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
160 VirtualMachineImpl::~VirtualMachineImpl()
162 on_destruction(this);
163 /* I was already removed from the allVms set if the VM was destroyed cleanly */
164 auto iter = find(allVms_.begin(), allVms_.end(), piface_);
165 if (iter != allVms_.end())
168 /* Free the cpu_action of the VM. */
169 XBT_ATTRIB_UNUSED bool ret = action_->unref();
170 xbt_assert(ret, "Bug: some resource still remains");
173 void VirtualMachineImpl::suspend(smx_actor_t issuer)
175 if (get_state() != s4u::VirtualMachine::state::RUNNING)
176 THROWF(vm_error, 0, "Cannot suspend VM %s: it is not running.", piface_->get_cname());
177 if (issuer->get_host() == piface_)
178 THROWF(vm_error, 0, "Actor %s cannot suspend the VM %s in which it runs", issuer->get_cname(),
179 piface_->get_cname());
181 XBT_DEBUG("suspend VM(%s), where %zu processes exist", piface_->get_cname(), process_list_.size());
185 for (auto& smx_process : process_list_) {
186 XBT_DEBUG("suspend %s", smx_process.get_cname());
187 smx_process.suspend(issuer);
190 XBT_DEBUG("suspend all processes on the VM done done");
192 vm_state_ = s4u::VirtualMachine::state::SUSPENDED;
195 void VirtualMachineImpl::resume()
197 if (get_state() != s4u::VirtualMachine::state::SUSPENDED)
198 THROWF(vm_error, 0, "Cannot resume VM %s: it was not suspended", piface_->get_cname());
200 XBT_DEBUG("Resume VM %s, containing %zu processes.", piface_->get_cname(), process_list_.size());
204 for (auto& smx_process : process_list_) {
205 XBT_DEBUG("resume %s", smx_process.get_cname());
206 smx_process.resume();
209 vm_state_ = s4u::VirtualMachine::state::RUNNING;
212 /** @brief Power off a VM.
214 * All hosted processes will be killed, but the VM state is preserved on memory.
215 * It can later be restarted.
217 * @param issuer the actor requesting the shutdown
219 void VirtualMachineImpl::shutdown(smx_actor_t issuer)
221 if (get_state() != s4u::VirtualMachine::state::RUNNING) {
222 const char* stateName = "(unknown state)";
223 switch (get_state()) {
224 case s4u::VirtualMachine::state::CREATED:
225 stateName = "created, but not yet started";
227 case s4u::VirtualMachine::state::SUSPENDED:
228 stateName = "suspended";
230 case s4u::VirtualMachine::state::DESTROYED:
231 stateName = "destroyed";
233 default: /* SURF_VM_STATE_RUNNING or unexpected values */
236 XBT_VERB("Shutting down the VM %s even if it's not running but %s", piface_->get_cname(), stateName);
239 XBT_DEBUG("shutdown VM %s, that contains %zu processes", piface_->get_cname(), process_list_.size());
241 for (auto& smx_process : process_list_) {
242 XBT_DEBUG("kill %s@%s on behalf of %s which shutdown that VM.", smx_process.get_cname(),
243 smx_process.get_host()->get_cname(), issuer->get_cname());
244 issuer->kill(&smx_process);
247 set_state(s4u::VirtualMachine::state::DESTROYED);
249 /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
252 /** @brief Change the physical host on which the given VM is running
254 * This is an instantaneous migration.
256 void VirtualMachineImpl::set_physical_host(s4u::Host* destination)
258 std::string vm_name = piface_->get_name();
259 std::string pm_name_src = physical_host_->get_name();
260 std::string pm_name_dst = destination->get_name();
262 /* update net_elm with that of the destination physical host */
263 piface_->pimpl_netpoint = destination->pimpl_netpoint;
265 physical_host_ = destination;
267 /* Update vcpu's action for the new pm */
268 /* create a cpu action bound to the pm model at the destination. */
269 surf::CpuAction* new_cpu_action =
270 static_cast<surf::CpuAction*>(destination->pimpl_cpu->execution_start(0, this->core_amount_));
272 if (action_->get_remains_no_update() > 0)
273 XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->get_remains_no_update());
275 /* keep the bound value of the cpu action of the VM. */
276 double old_bound = action_->get_bound();
278 XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name.c_str(), old_bound, pm_name_dst.c_str());
279 new_cpu_action->set_bound(old_bound);
282 XBT_ATTRIB_UNUSED bool ret = action_->unref();
283 xbt_assert(ret, "Bug: some resource still remains");
285 action_ = new_cpu_action;
287 XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name.c_str(), pm_name_src.c_str(), pm_name_dst.c_str());
290 void VirtualMachineImpl::set_bound(double bound)
293 update_action_weight();
296 void VirtualMachineImpl::update_action_weight(){
297 /* The impact of the VM over its PM is the min between its vCPU amount and the amount of tasks it contains */
298 int impact = std::min(active_tasks_, get_core_amount());
300 XBT_DEBUG("set the weight of the dummy CPU action of VM%p on PM to %d (#tasks: %d)", this, impact, active_tasks_);
303 action_->set_priority(1. / impact);
305 action_->set_priority(0.);
307 action_->set_bound(std::min(impact * physical_host_->get_speed(), user_bound_));