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 <simgrid/Exception.hpp>
7 #include <simgrid/kernel/routing/NetZoneImpl.hpp>
8 #include <simgrid/s4u/Exec.hpp>
10 #include "simgrid/sg_config.hpp"
11 #include "src/kernel/EngineImpl.hpp"
12 #include "src/kernel/activity/ExecImpl.hpp"
13 #include "src/kernel/resource/VirtualMachineImpl.hpp"
14 #include "src/surf/cpu_cas01.hpp"
15 #include "src/surf/cpu_ti.hpp"
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(res_vm, ker_resource, "Virtual Machines, containing actors and mobile across hosts");
19 void surf_vm_model_init_HL13(simgrid::kernel::resource::CpuModel* cpu_pm_model)
21 auto vm_model = std::make_shared<simgrid::kernel::resource::VMModel>("VM_HL13");
22 auto* engine = simgrid::kernel::EngineImpl::get_instance();
24 engine->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 engine->add_model(cpu_model_vm, {cpu_pm_model, vm_model.get()});
34 engine->get_netzone_root()->set_cpu_vm_model(cpu_model_vm);
38 template class xbt::Extendable<kernel::resource::VirtualMachineImpl>;
47 std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
49 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
50 * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system.
51 * FIXME: add a configuration flag for this
53 const double virt_overhead = 1; // 0.95
55 static void host_state_change(s4u::Host const& host)
57 if (not host.is_on()) { // just turned off.
58 std::vector<s4u::VirtualMachine*> trash;
59 /* Find all VMs living on that host */
60 for (s4u::VirtualMachine* const& vm : VirtualMachineImpl::allVms_)
61 if (vm->get_pm() == &host)
63 for (s4u::VirtualMachine* vm : trash)
68 static void add_active_exec(s4u::Exec const& task)
70 const s4u::VirtualMachine* vm = dynamic_cast<s4u::VirtualMachine*>(task.get_host());
72 VirtualMachineImpl* vm_impl = vm->get_vm_impl();
73 vm_impl->add_active_exec();
74 vm_impl->update_action_weight();
78 static void remove_active_exec(s4u::Exec const& task)
80 const s4u::VirtualMachine* vm = dynamic_cast<s4u::VirtualMachine*>(task.get_host());
82 VirtualMachineImpl* vm_impl = vm->get_vm_impl();
83 vm_impl->remove_active_exec();
84 vm_impl->update_action_weight();
88 static s4u::VirtualMachine* get_vm_from_activity(kernel::activity::ActivityImpl const& act)
90 auto* exec = dynamic_cast<kernel::activity::ExecImpl const*>(&act);
91 return exec != nullptr ? dynamic_cast<s4u::VirtualMachine*>(exec->get_host()) : nullptr;
94 static void add_active_activity(kernel::activity::ActivityImpl const& act)
96 const s4u::VirtualMachine* vm = get_vm_from_activity(act);
98 VirtualMachineImpl* vm_impl = vm->get_vm_impl();
99 vm_impl->add_active_exec();
100 vm_impl->update_action_weight();
104 static void remove_active_activity(kernel::activity::ActivityImpl const& act)
106 const s4u::VirtualMachine* vm = get_vm_from_activity(act);
108 VirtualMachineImpl* vm_impl = vm->get_vm_impl();
109 vm_impl->remove_active_exec();
110 vm_impl->update_action_weight();
114 VMModel::VMModel(const std::string& name) : HostModel(name)
116 s4u::Host::on_state_change.connect(host_state_change);
117 s4u::Exec::on_start.connect(add_active_exec);
118 s4u::Exec::on_completion.connect(remove_active_exec);
119 activity::ActivityImpl::on_resumed.connect(add_active_activity);
120 activity::ActivityImpl::on_suspended.connect(remove_active_activity);
123 double VMModel::next_occurring_event(double now)
125 /* TODO: update action's cost with the total cost of processes on the VM. */
127 /* 1. Now we know how many resource should be assigned to each virtual
128 * machine. We update constraints of the virtual machine layer.
130 * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
131 * X1 + X2 = C (Equation 1)
133 * the resource share of VM1: X1
134 * the resource share of VM2: X2
135 * the capacity of PM1: C
137 * Then, if we have two process (P1 and P2) on VM1.
138 * X1_1 + X1_2 = X1 (Equation 2)
140 * the resource share of P1: X1_1
141 * the resource share of P2: X1_2
142 * the capacity of VM1: X1
144 * Equation 1 was solved in the physical machine layer.
145 * Equation 2 is solved in the virtual machine layer (here).
146 * X1 must be passed to the virtual machine layer as a constraint value.
149 /* iterate for all virtual machines */
150 for (s4u::VirtualMachine* const& ws_vm : VirtualMachineImpl::allVms_) {
151 if (ws_vm->get_state() == s4u::VirtualMachine::State::SUSPENDED) // Ignore suspended VMs
154 const kernel::resource::CpuImpl* cpu = ws_vm->get_cpu();
156 // solved_value below is X1 in comment above: what this VM got in the sharing on the PM
157 double solved_value = ws_vm->get_vm_impl()->get_action()->get_rate();
158 XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->get_cname(), ws_vm->get_pm()->get_cname());
160 lmm::System* vcpu_system = cpu->get_model()->get_maxmin_system();
161 vcpu_system->update_constraint_bound(cpu->get_constraint(), virt_overhead * solved_value);
163 /* actual next occurring event is determined by VM CPU model at EngineImpl::solve */
171 VirtualMachineImpl::VirtualMachineImpl(const std::string& name, s4u::VirtualMachine* piface,
172 simgrid::s4u::Host* host_PM, int core_amount, size_t ramsize)
173 : HostImpl(name, piface), piface_(piface), physical_host_(host_PM), core_amount_(core_amount), ramsize_(ramsize)
175 /* Register this VM to the list of all VMs */
176 allVms_.push_back(piface);
177 /* We create cpu_action corresponding to a VM process on the host operating system. */
178 /* TODO: we have to periodically input GUESTOS_NOISE to the system? how ?
179 * The value for GUESTOS_NOISE corresponds to the cost of the global action associated to the VM. It corresponds to
180 * the cost of a VM running no tasks.
182 action_ = physical_host_->get_cpu()->execution_start(0, core_amount_);
184 // It's empty for now, so it should not request resources in the PM
185 update_action_weight();
187 XBT_VERB("Create VM(%s)@PM(%s)", name.c_str(), physical_host_->get_cname());
190 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
191 void VirtualMachineImpl::vm_destroy()
193 s4u::VirtualMachine::on_destruction(*piface_);
194 /* I was already removed from the allVms set if the VM was destroyed cleanly */
195 auto iter = find(allVms_.begin(), allVms_.end(), piface_);
196 if (iter != allVms_.end())
199 /* Free the cpu_action of the VM. */
200 XBT_ATTRIB_UNUSED bool ret = action_->unref();
201 xbt_assert(ret, "Bug: some resource still remains");
204 void VirtualMachineImpl::suspend(smx_actor_t issuer)
206 if (vm_state_ != s4u::VirtualMachine::State::RUNNING)
207 throw VmFailureException(XBT_THROW_POINT,
208 xbt::string_printf("Cannot suspend VM %s: it is not running.", piface_->get_cname()));
209 if (issuer->get_host() == piface_)
210 throw VmFailureException(XBT_THROW_POINT, xbt::string_printf("Actor %s cannot suspend the VM %s in which it runs",
211 issuer->get_cname(), piface_->get_cname()));
213 XBT_DEBUG("suspend VM(%s), where %zu actors exist", piface_->get_cname(), get_actor_count());
217 foreach_actor([](auto& actor) {
218 XBT_DEBUG("suspend %s", actor.get_cname());
222 XBT_DEBUG("suspend all actors on the VM done done");
224 vm_state_ = s4u::VirtualMachine::State::SUSPENDED;
227 void VirtualMachineImpl::resume()
229 if (vm_state_ != s4u::VirtualMachine::State::SUSPENDED)
230 throw VmFailureException(XBT_THROW_POINT,
231 xbt::string_printf("Cannot resume VM %s: it was not suspended", piface_->get_cname()));
233 XBT_DEBUG("Resume VM %s, containing %zu actors.", piface_->get_cname(), get_actor_count());
237 foreach_actor([](auto& actor) {
238 XBT_DEBUG("resume %s", actor.get_cname());
242 vm_state_ = s4u::VirtualMachine::State::RUNNING;
245 /** @brief Power off a VM.
247 * All hosted processes will be killed, but the VM state is preserved on memory.
248 * It can later be restarted.
250 * @param issuer the actor requesting the shutdown
252 void VirtualMachineImpl::shutdown(smx_actor_t issuer)
254 if (vm_state_ != s4u::VirtualMachine::State::RUNNING)
255 XBT_VERB("Shutting down the VM %s even if it's not running but in state %s", piface_->get_cname(),
256 s4u::VirtualMachine::to_c_str(get_state()));
258 XBT_DEBUG("shutdown VM %s, that contains %zu actors", piface_->get_cname(), get_actor_count());
260 foreach_actor([issuer](auto& actor) {
261 XBT_DEBUG("kill %s@%s on behalf of %s which shutdown that VM.", actor.get_cname(), actor.get_host()->get_cname(),
262 issuer->get_cname());
263 issuer->kill(&actor);
266 set_state(s4u::VirtualMachine::State::DESTROYED);
268 /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
271 /** @brief Change the physical host on which the given VM is running
273 * This is an instantaneous migration.
275 void VirtualMachineImpl::set_physical_host(s4u::Host* destination)
277 std::string vm_name = piface_->get_name();
278 std::string pm_name_src = physical_host_->get_name();
279 std::string pm_name_dst = destination->get_name();
281 /* update net_elm with that of the destination physical host */
282 piface_->set_netpoint(destination->get_netpoint());
284 /* Adapt the speed, pstate and other physical characteristics to the one of our new physical CPU */
285 piface_->get_cpu()->reset_vcpu(destination->get_cpu());
287 physical_host_ = destination;
289 /* Update vcpu's action for the new pm */
290 /* create a cpu action bound to the pm model at the destination. */
291 CpuAction* new_cpu_action = destination->get_cpu()->execution_start(0, this->core_amount_);
293 if (action_->get_remains_no_update() > 0)
294 XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->get_remains_no_update());
296 /* keep the bound value of the cpu action of the VM. */
297 double old_bound = action_->get_bound();
299 XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name.c_str(), old_bound, pm_name_dst.c_str());
300 new_cpu_action->set_bound(old_bound);
303 XBT_ATTRIB_UNUSED bool ret = action_->unref();
304 xbt_assert(ret, "Bug: some resource still remains");
306 action_ = new_cpu_action;
308 XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name.c_str(), pm_name_src.c_str(), pm_name_dst.c_str());
311 void VirtualMachineImpl::set_bound(double bound)
314 action_->set_user_bound(user_bound_);
315 update_action_weight();
318 void VirtualMachineImpl::update_action_weight()
320 /* The impact of the VM over its PM is the min between its vCPU amount and the amount of tasks it contains */
321 int impact = std::min(active_execs_, get_core_amount());
323 XBT_DEBUG("set the weight of the dummy CPU action of VM%p on PM to %d (#tasks: %u)", this, impact, active_execs_);
326 action_->set_sharing_penalty(1. / impact);
328 action_->set_sharing_penalty(0.);
330 action_->set_bound(std::min(impact * physical_host_->get_speed(), user_bound_));
333 } // namespace resource
334 } // namespace kernel
335 } // namespace simgrid