1 /* Copyright (c) 2013-2021. 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 "simgrid/Exception.hpp"
8 #include "simgrid/s4u/Exec.hpp"
9 #include "src/include/surf/surf.hpp"
10 #include "src/kernel/EngineImpl.hpp"
11 #include "src/kernel/activity/ExecImpl.hpp"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(res_vm, ker_resource, "Virtual Machines, containing actors and mobile accross hosts");
15 void surf_vm_model_init_HL13()
17 auto vm_model = std::make_shared<simgrid::vm::VMModel>();
18 simgrid::kernel::EngineImpl::get_instance()->add_model(simgrid::kernel::resource::Model::Type::VM,
19 std::move(vm_model), true);
24 template class xbt::Extendable<vm::VirtualMachineImpl>;
30 xbt::signal<void(VirtualMachineImpl&)> VirtualMachineImpl::on_creation;
31 xbt::signal<void(VirtualMachineImpl const&)> VirtualMachineImpl::on_destruction;
37 std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
39 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
40 * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system.
41 * FIXME: add a configuration flag for this
43 const double virt_overhead = 1; // 0.95
45 static void host_state_change(s4u::Host const& host)
47 if (not host.is_on()) { // just turned off.
48 std::vector<s4u::VirtualMachine*> trash;
49 /* Find all VMs living on that host */
50 for (s4u::VirtualMachine* const& vm : VirtualMachineImpl::allVms_)
51 if (vm->get_pm() == &host)
53 for (s4u::VirtualMachine* vm : trash)
58 static void add_active_exec(s4u::Exec const& task)
60 const s4u::VirtualMachine* vm = dynamic_cast<s4u::VirtualMachine*>(task.get_host());
62 VirtualMachineImpl* vm_impl = vm->get_impl();
63 vm_impl->add_active_exec();
64 vm_impl->update_action_weight();
68 static void remove_active_exec(s4u::Exec const& task)
70 const s4u::VirtualMachine* vm = dynamic_cast<s4u::VirtualMachine*>(task.get_host());
72 VirtualMachineImpl* vm_impl = vm->get_impl();
73 vm_impl->remove_active_exec();
74 vm_impl->update_action_weight();
78 static s4u::VirtualMachine* get_vm_from_activity(kernel::activity::ActivityImpl const& act)
80 auto* exec = dynamic_cast<kernel::activity::ExecImpl const*>(&act);
81 return exec != nullptr ? dynamic_cast<s4u::VirtualMachine*>(exec->get_host()) : nullptr;
84 static void add_active_activity(kernel::activity::ActivityImpl const& act)
86 const s4u::VirtualMachine* vm = get_vm_from_activity(act);
88 VirtualMachineImpl* vm_impl = vm->get_impl();
89 vm_impl->add_active_exec();
90 vm_impl->update_action_weight();
94 static void remove_active_activity(kernel::activity::ActivityImpl const& act)
96 const s4u::VirtualMachine* vm = get_vm_from_activity(act);
98 VirtualMachineImpl* vm_impl = vm->get_impl();
99 vm_impl->remove_active_exec();
100 vm_impl->update_action_weight();
106 s4u::Host::on_state_change.connect(host_state_change);
107 s4u::Exec::on_start.connect(add_active_exec);
108 s4u::Exec::on_completion.connect(remove_active_exec);
109 kernel::activity::ActivityImpl::on_resumed.connect(add_active_activity);
110 kernel::activity::ActivityImpl::on_suspended.connect(remove_active_activity);
113 double VMModel::next_occurring_event(double now)
115 /* TODO: update action's cost with the total cost of processes on the VM. */
117 /* 1. Now we know how many resource should be assigned to each virtual
118 * machine. We update constraints of the virtual machine layer.
120 * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
121 * X1 + X2 = C (Equation 1)
123 * the resource share of VM1: X1
124 * the resource share of VM2: X2
125 * the capacity of PM1: C
127 * Then, if we have two process (P1 and P2) on VM1.
128 * X1_1 + X1_2 = X1 (Equation 2)
130 * the resource share of P1: X1_1
131 * the resource share of P2: X1_2
132 * the capacity of VM1: X1
134 * Equation 1 was solved in the physical machine layer.
135 * Equation 2 is solved in the virtual machine layer (here).
136 * X1 must be passed to the virtual machine layer as a constraint value.
139 /* iterate for all virtual machines */
140 for (s4u::VirtualMachine* const& ws_vm : VirtualMachineImpl::allVms_) {
141 if (ws_vm->get_state() == s4u::VirtualMachine::state::SUSPENDED) // Ignore suspended VMs
144 const kernel::resource::Cpu* cpu = ws_vm->pimpl_cpu;
146 // solved_value below is X1 in comment above: what this VM got in the sharing on the PM
147 double solved_value = ws_vm->get_impl()->get_action()->get_variable()->get_value();
148 XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->get_cname(), ws_vm->get_pm()->get_cname());
150 kernel::lmm::System* vcpu_system = cpu->get_model()->get_maxmin_system();
151 vcpu_system->update_constraint_bound(cpu->get_constraint(), virt_overhead * solved_value);
154 /* actual next occurring event is determined by VM CPU model at surf_solve */
162 VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::VirtualMachine* piface, simgrid::s4u::Host* host_PM,
163 int core_amount, size_t ramsize)
164 : HostImpl(piface), physical_host_(host_PM), core_amount_(core_amount), ramsize_(ramsize)
166 /* Register this VM to the list of all VMs */
167 allVms_.push_back(piface);
169 /* We create cpu_action corresponding to a VM process on the host operating system. */
170 /* TODO: we have to periodically input GUESTOS_NOISE to the system? how ?
171 * The value for GUESTOS_NOISE corresponds to the cost of the global action associated to the VM. It corresponds to
172 * the cost of a VM running no tasks.
174 action_ = physical_host_->pimpl_cpu->execution_start(0, core_amount_);
176 // It's empty for now, so it should not request resources in the PM
177 update_action_weight();
179 XBT_VERB("Create VM(%s)@PM(%s)", piface->get_cname(), physical_host_->get_cname());
183 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
184 VirtualMachineImpl::~VirtualMachineImpl()
186 on_destruction(*this);
187 /* I was already removed from the allVms set if the VM was destroyed cleanly */
188 auto iter = find(allVms_.begin(), allVms_.end(), piface_);
189 if (iter != allVms_.end())
192 /* Free the cpu_action of the VM. */
193 XBT_ATTRIB_UNUSED bool ret = action_->unref();
194 xbt_assert(ret, "Bug: some resource still remains");
197 void VirtualMachineImpl::suspend(smx_actor_t issuer)
199 if (get_state() != s4u::VirtualMachine::state::RUNNING)
200 throw VmFailureException(XBT_THROW_POINT,
201 xbt::string_printf("Cannot suspend VM %s: it is not running.", piface_->get_cname()));
202 if (issuer->get_host() == piface_)
203 throw VmFailureException(XBT_THROW_POINT, xbt::string_printf("Actor %s cannot suspend the VM %s in which it runs",
204 issuer->get_cname(), piface_->get_cname()));
206 XBT_DEBUG("suspend VM(%s), where %zu actors exist", piface_->get_cname(), get_actor_count());
210 foreach_actor([](auto& actor) {
211 XBT_DEBUG("suspend %s", actor.get_cname());
215 XBT_DEBUG("suspend all actors on the VM done done");
217 vm_state_ = s4u::VirtualMachine::state::SUSPENDED;
220 void VirtualMachineImpl::resume()
222 if (get_state() != s4u::VirtualMachine::state::SUSPENDED)
223 throw VmFailureException(XBT_THROW_POINT,
224 xbt::string_printf("Cannot resume VM %s: it was not suspended", piface_->get_cname()));
226 XBT_DEBUG("Resume VM %s, containing %zu actors.", piface_->get_cname(), get_actor_count());
230 foreach_actor([](auto& actor) {
231 XBT_DEBUG("resume %s", actor.get_cname());
235 vm_state_ = s4u::VirtualMachine::state::RUNNING;
238 /** @brief Power off a VM.
240 * All hosted processes will be killed, but the VM state is preserved on memory.
241 * It can later be restarted.
243 * @param issuer the actor requesting the shutdown
245 void VirtualMachineImpl::shutdown(smx_actor_t issuer)
247 if (get_state() != s4u::VirtualMachine::state::RUNNING) {
248 const char* stateName;
249 switch (get_state()) {
250 case s4u::VirtualMachine::state::CREATED:
251 stateName = "created, but not yet started";
253 case s4u::VirtualMachine::state::SUSPENDED:
254 stateName = "suspended";
256 case s4u::VirtualMachine::state::DESTROYED:
257 stateName = "destroyed";
259 default: /* SURF_VM_STATE_RUNNING or unexpected values */
262 XBT_VERB("Shutting down the VM %s even if it's not running but %s", piface_->get_cname(), stateName);
265 XBT_DEBUG("shutdown VM %s, that contains %zu actors", piface_->get_cname(), get_actor_count());
267 foreach_actor([issuer](auto& actor) {
268 XBT_DEBUG("kill %s@%s on behalf of %s which shutdown that VM.", actor.get_cname(), actor.get_host()->get_cname(),
269 issuer->get_cname());
270 issuer->kill(&actor);
273 set_state(s4u::VirtualMachine::state::DESTROYED);
275 /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
278 /** @brief Change the physical host on which the given VM is running
280 * This is an instantaneous migration.
282 void VirtualMachineImpl::set_physical_host(s4u::Host* destination)
284 std::string vm_name = piface_->get_name();
285 std::string pm_name_src = physical_host_->get_name();
286 std::string pm_name_dst = destination->get_name();
288 /* update net_elm with that of the destination physical host */
289 piface_->set_netpoint(destination->get_netpoint());
291 /* Adapt the speed, pstate and other physical characteristics to the one of our new physical CPU */
292 piface_->pimpl_cpu->reset_vcpu(destination->pimpl_cpu);
294 physical_host_ = destination;
296 /* Update vcpu's action for the new pm */
297 /* create a cpu action bound to the pm model at the destination. */
298 kernel::resource::CpuAction* new_cpu_action = destination->pimpl_cpu->execution_start(0, this->core_amount_);
300 if (action_->get_remains_no_update() > 0)
301 XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->get_remains_no_update());
303 /* keep the bound value of the cpu action of the VM. */
304 double old_bound = action_->get_bound();
306 XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name.c_str(), old_bound, pm_name_dst.c_str());
307 new_cpu_action->set_bound(old_bound);
310 XBT_ATTRIB_UNUSED bool ret = action_->unref();
311 xbt_assert(ret, "Bug: some resource still remains");
313 action_ = new_cpu_action;
315 XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name.c_str(), pm_name_src.c_str(), pm_name_dst.c_str());
318 void VirtualMachineImpl::set_bound(double bound)
321 action_->set_user_bound(user_bound_);
322 update_action_weight();
325 void VirtualMachineImpl::update_action_weight()
327 /* The impact of the VM over its PM is the min between its vCPU amount and the amount of tasks it contains */
328 int impact = std::min(active_execs_, get_core_amount());
330 XBT_DEBUG("set the weight of the dummy CPU action of VM%p on PM to %d (#tasks: %u)", this, impact, active_execs_);
333 action_->set_sharing_penalty(1. / impact);
335 action_->set_sharing_penalty(0.);
337 action_->set_bound(std::min(impact * physical_host_->get_speed(), user_bound_));
341 } // namespace simgrid