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/kernel/routing/NetZoneImpl.hpp"
9 #include "simgrid/s4u/Engine.hpp"
10 #include "simgrid/s4u/Exec.hpp"
11 #include "simgrid/sg_config.hpp"
12 #include "src/include/surf/surf.hpp"
13 #include "src/kernel/EngineImpl.hpp"
14 #include "src/kernel/activity/ExecImpl.hpp"
15 #include "src/surf/cpu_cas01.hpp"
16 #include "src/surf/cpu_ti.hpp"
18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(res_vm, ker_resource, "Virtual Machines, containing actors and mobile across hosts");
20 void surf_vm_model_init_HL13(simgrid::kernel::resource::CpuModel* cpu_pm_model)
22 auto vm_model = std::make_shared<simgrid::vm::VMModel>("VM_HL13");
24 simgrid::kernel::EngineImpl::get_instance()->add_model(vm_model, {cpu_pm_model});
25 std::shared_ptr<simgrid::kernel::resource::CpuModel> cpu_model_vm;
27 auto cpu_optim = simgrid::config::get_value<std::string>("cpu/optim");
28 if (cpu_optim == "TI") {
29 cpu_model_vm = std::make_shared<simgrid::kernel::resource::CpuTiModel>("VmCpu_TI");
31 cpu_model_vm = std::make_shared<simgrid::kernel::resource::CpuCas01Model>("VmCpu_Cas01");
33 simgrid::kernel::EngineImpl::get_instance()->add_model(cpu_model_vm, {cpu_pm_model, vm_model.get()});
34 simgrid::s4u::Engine::get_instance()->get_netzone_root()->get_impl()->set_cpu_vm_model(cpu_model_vm);
39 template class xbt::Extendable<vm::VirtualMachineImpl>;
45 xbt::signal<void(VirtualMachineImpl&)> VirtualMachineImpl::on_creation;
46 xbt::signal<void(VirtualMachineImpl const&)> VirtualMachineImpl::on_destruction;
52 std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
54 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
55 * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system.
56 * FIXME: add a configuration flag for this
58 const double virt_overhead = 1; // 0.95
60 static void host_state_change(s4u::Host const& host)
62 if (not host.is_on()) { // just turned off.
63 std::vector<s4u::VirtualMachine*> trash;
64 /* Find all VMs living on that host */
65 for (s4u::VirtualMachine* const& vm : VirtualMachineImpl::allVms_)
66 if (vm->get_pm() == &host)
68 for (s4u::VirtualMachine* vm : trash)
73 static void add_active_exec(s4u::Exec const& task)
75 const s4u::VirtualMachine* vm = dynamic_cast<s4u::VirtualMachine*>(task.get_host());
77 VirtualMachineImpl* vm_impl = vm->get_vm_impl();
78 vm_impl->add_active_exec();
79 vm_impl->update_action_weight();
83 static void remove_active_exec(s4u::Exec const& task)
85 const s4u::VirtualMachine* vm = dynamic_cast<s4u::VirtualMachine*>(task.get_host());
87 VirtualMachineImpl* vm_impl = vm->get_vm_impl();
88 vm_impl->remove_active_exec();
89 vm_impl->update_action_weight();
93 static s4u::VirtualMachine* get_vm_from_activity(kernel::activity::ActivityImpl const& act)
95 auto* exec = dynamic_cast<kernel::activity::ExecImpl const*>(&act);
96 return exec != nullptr ? dynamic_cast<s4u::VirtualMachine*>(exec->get_host()) : nullptr;
99 static void add_active_activity(kernel::activity::ActivityImpl const& act)
101 const s4u::VirtualMachine* vm = get_vm_from_activity(act);
103 VirtualMachineImpl* vm_impl = vm->get_vm_impl();
104 vm_impl->add_active_exec();
105 vm_impl->update_action_weight();
109 static void remove_active_activity(kernel::activity::ActivityImpl const& act)
111 const s4u::VirtualMachine* vm = get_vm_from_activity(act);
113 VirtualMachineImpl* vm_impl = vm->get_vm_impl();
114 vm_impl->remove_active_exec();
115 vm_impl->update_action_weight();
119 VMModel::VMModel(const std::string& name) : HostModel(name)
121 s4u::Host::on_state_change.connect(host_state_change);
122 s4u::Exec::on_start.connect(add_active_exec);
123 s4u::Exec::on_completion.connect(remove_active_exec);
124 kernel::activity::ActivityImpl::on_resumed.connect(add_active_activity);
125 kernel::activity::ActivityImpl::on_suspended.connect(remove_active_activity);
128 double VMModel::next_occurring_event(double now)
130 /* TODO: update action's cost with the total cost of processes on the VM. */
132 /* 1. Now we know how many resource should be assigned to each virtual
133 * machine. We update constraints of the virtual machine layer.
135 * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
136 * X1 + X2 = C (Equation 1)
138 * the resource share of VM1: X1
139 * the resource share of VM2: X2
140 * the capacity of PM1: C
142 * Then, if we have two process (P1 and P2) on VM1.
143 * X1_1 + X1_2 = X1 (Equation 2)
145 * the resource share of P1: X1_1
146 * the resource share of P2: X1_2
147 * the capacity of VM1: X1
149 * Equation 1 was solved in the physical machine layer.
150 * Equation 2 is solved in the virtual machine layer (here).
151 * X1 must be passed to the virtual machine layer as a constraint value.
154 /* iterate for all virtual machines */
155 for (s4u::VirtualMachine* const& ws_vm : VirtualMachineImpl::allVms_) {
156 if (ws_vm->get_state() == s4u::VirtualMachine::State::SUSPENDED) // Ignore suspended VMs
159 const kernel::resource::Cpu* cpu = ws_vm->pimpl_cpu;
161 // solved_value below is X1 in comment above: what this VM got in the sharing on the PM
162 double solved_value = ws_vm->get_vm_impl()->get_action()->get_variable()->get_value();
163 XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->get_cname(), ws_vm->get_pm()->get_cname());
165 kernel::lmm::System* vcpu_system = cpu->get_model()->get_maxmin_system();
166 vcpu_system->update_constraint_bound(cpu->get_constraint(), virt_overhead * solved_value);
168 /* actual next occurring event is determined by VM CPU model at surf_solve */
176 VirtualMachineImpl::VirtualMachineImpl(const std::string& name, s4u::VirtualMachine* piface,
177 simgrid::s4u::Host* host_PM, int core_amount, size_t ramsize)
178 : HostImpl(name, piface), piface_(piface), physical_host_(host_PM), core_amount_(core_amount), ramsize_(ramsize)
180 /* Register this VM to the list of all VMs */
181 allVms_.push_back(piface);
182 /* We create cpu_action corresponding to a VM process on the host operating system. */
183 /* TODO: we have to periodically input GUESTOS_NOISE to the system? how ?
184 * The value for GUESTOS_NOISE corresponds to the cost of the global action associated to the VM. It corresponds to
185 * the cost of a VM running no tasks.
187 action_ = physical_host_->pimpl_cpu->execution_start(0, core_amount_);
189 // It's empty for now, so it should not request resources in the PM
190 update_action_weight();
192 XBT_VERB("Create VM(%s)@PM(%s)", name.c_str(), physical_host_->get_cname());
196 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
197 VirtualMachineImpl::~VirtualMachineImpl()
199 on_destruction(*this);
200 /* I was already removed from the allVms set if the VM was destroyed cleanly */
201 auto iter = find(allVms_.begin(), allVms_.end(), piface_);
202 if (iter != allVms_.end())
205 /* Free the cpu_action of the VM. */
206 XBT_ATTRIB_UNUSED bool ret = action_->unref();
207 xbt_assert(ret, "Bug: some resource still remains");
210 void VirtualMachineImpl::suspend(smx_actor_t issuer)
212 if (get_state() != s4u::VirtualMachine::State::RUNNING)
213 throw VmFailureException(XBT_THROW_POINT,
214 xbt::string_printf("Cannot suspend VM %s: it is not running.", piface_->get_cname()));
215 if (issuer->get_host() == piface_)
216 throw VmFailureException(XBT_THROW_POINT, xbt::string_printf("Actor %s cannot suspend the VM %s in which it runs",
217 issuer->get_cname(), piface_->get_cname()));
219 XBT_DEBUG("suspend VM(%s), where %zu actors exist", piface_->get_cname(), get_actor_count());
223 foreach_actor([](auto& actor) {
224 XBT_DEBUG("suspend %s", actor.get_cname());
228 XBT_DEBUG("suspend all actors on the VM done done");
230 vm_state_ = s4u::VirtualMachine::State::SUSPENDED;
233 void VirtualMachineImpl::resume()
235 if (get_state() != s4u::VirtualMachine::State::SUSPENDED)
236 throw VmFailureException(XBT_THROW_POINT,
237 xbt::string_printf("Cannot resume VM %s: it was not suspended", piface_->get_cname()));
239 XBT_DEBUG("Resume VM %s, containing %zu actors.", piface_->get_cname(), get_actor_count());
243 foreach_actor([](auto& actor) {
244 XBT_DEBUG("resume %s", actor.get_cname());
248 vm_state_ = s4u::VirtualMachine::State::RUNNING;
251 /** @brief Power off a VM.
253 * All hosted processes will be killed, but the VM state is preserved on memory.
254 * It can later be restarted.
256 * @param issuer the actor requesting the shutdown
258 void VirtualMachineImpl::shutdown(smx_actor_t issuer)
260 if (get_state() != s4u::VirtualMachine::State::RUNNING)
261 XBT_VERB("Shutting down the VM %s even if it's not running but in state %s", piface_->get_cname(),
262 s4u::VirtualMachine::to_c_str(get_state()));
264 XBT_DEBUG("shutdown VM %s, that contains %zu actors", piface_->get_cname(), get_actor_count());
266 foreach_actor([issuer](auto& actor) {
267 XBT_DEBUG("kill %s@%s on behalf of %s which shutdown that VM.", actor.get_cname(), actor.get_host()->get_cname(),
268 issuer->get_cname());
269 issuer->kill(&actor);
272 set_state(s4u::VirtualMachine::State::DESTROYED);
274 /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
277 /** @brief Change the physical host on which the given VM is running
279 * This is an instantaneous migration.
281 void VirtualMachineImpl::set_physical_host(s4u::Host* destination)
283 std::string vm_name = piface_->get_name();
284 std::string pm_name_src = physical_host_->get_name();
285 std::string pm_name_dst = destination->get_name();
287 /* update net_elm with that of the destination physical host */
288 piface_->set_netpoint(destination->get_netpoint());
290 /* Adapt the speed, pstate and other physical characteristics to the one of our new physical CPU */
291 piface_->pimpl_cpu->reset_vcpu(destination->pimpl_cpu);
293 physical_host_ = destination;
295 /* Update vcpu's action for the new pm */
296 /* create a cpu action bound to the pm model at the destination. */
297 kernel::resource::CpuAction* new_cpu_action = destination->pimpl_cpu->execution_start(0, this->core_amount_);
299 if (action_->get_remains_no_update() > 0)
300 XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->get_remains_no_update());
302 /* keep the bound value of the cpu action of the VM. */
303 double old_bound = action_->get_bound();
305 XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name.c_str(), old_bound, pm_name_dst.c_str());
306 new_cpu_action->set_bound(old_bound);
309 XBT_ATTRIB_UNUSED bool ret = action_->unref();
310 xbt_assert(ret, "Bug: some resource still remains");
312 action_ = new_cpu_action;
314 XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name.c_str(), pm_name_src.c_str(), pm_name_dst.c_str());
317 void VirtualMachineImpl::set_bound(double bound)
320 action_->set_user_bound(user_bound_);
321 update_action_weight();
324 void VirtualMachineImpl::update_action_weight()
326 /* The impact of the VM over its PM is the min between its vCPU amount and the amount of tasks it contains */
327 int impact = std::min(active_execs_, get_core_amount());
329 XBT_DEBUG("set the weight of the dummy CPU action of VM%p on PM to %d (#tasks: %u)", this, impact, active_execs_);
332 action_->set_sharing_penalty(1. / impact);
334 action_->set_sharing_penalty(0.);
336 action_->set_bound(std::min(impact * physical_host_->get_speed(), user_bound_));
340 } // namespace simgrid