1 /* Copyright (c) 2013-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 "src/plugins/vm/VirtualMachineImpl.hpp"
7 #include "src/include/surf/surf.hpp"
8 #include "src/simix/ActorImpl.hpp"
9 #include "src/simix/smx_host_private.hpp"
10 #include "xbt/asserts.h" // xbt_log_no_loc
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_vm, surf, "Logging specific to the SURF VM module");
14 simgrid::vm::VMModel* surf_vm_model = nullptr;
16 void surf_vm_model_init_HL13()
18 if (surf_cpu_model_vm != nullptr)
19 surf_vm_model = new simgrid::vm::VMModel();
27 simgrid::xbt::signal<void(VirtualMachineImpl*)> VirtualMachineImpl::on_creation;
28 simgrid::xbt::signal<void(VirtualMachineImpl*)> VirtualMachineImpl::on_destruction;
29 simgrid::xbt::signal<void(VirtualMachineImpl*)> VirtualMachineImpl::on_state_change;
34 std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
36 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
37 * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system.
38 * FIXME: add a configuration flag for this
40 const double virt_overhead = 1; // 0.95
42 static void hostStateChange(s4u::Host& host)
44 if (host.is_off()) { // just turned off.
45 std::vector<s4u::VirtualMachine*> trash;
46 /* Find all VMs living on that host */
47 for (s4u::VirtualMachine* const& vm : VirtualMachineImpl::allVms_)
48 if (vm->get_pm() == &host)
50 for (s4u::VirtualMachine* vm : trash)
57 all_existing_models.push_back(this);
58 s4u::Host::on_state_change.connect(hostStateChange);
61 double VMModel::next_occuring_event(double now)
63 /* TODO: update action's cost with the total cost of processes on the VM. */
65 /* 1. Now we know how many resource should be assigned to each virtual
66 * machine. We update constraints of the virtual machine layer.
68 * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
69 * X1 + X2 = C (Equation 1)
71 * the resource share of VM1: X1
72 * the resource share of VM2: X2
73 * the capacity of PM1: C
75 * Then, if we have two process (P1 and P2) on VM1.
76 * X1_1 + X1_2 = X1 (Equation 2)
78 * the resource share of P1: X1_1
79 * the resource share of P2: X1_2
80 * the capacity of VM1: X1
82 * Equation 1 was solved in the physical machine layer.
83 * Equation 2 is solved in the virtual machine layer (here).
84 * X1 must be passed to the virtual machine layer as a constraint value.
87 /* iterate for all virtual machines */
88 for (s4u::VirtualMachine* const& ws_vm : VirtualMachineImpl::allVms_) {
89 surf::Cpu* cpu = ws_vm->pimpl_cpu;
92 ws_vm->get_impl()->action_->get_variable()->get_value(); // this is X1 in comment above, what
93 // this VM got in the sharing on the PM
94 XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->get_cname(), ws_vm->get_pm()->get_cname());
96 xbt_assert(cpu->get_model() == surf_cpu_model_vm);
97 kernel::lmm::System* vcpu_system = cpu->get_model()->get_maxmin_system();
98 vcpu_system->update_constraint_bound(cpu->get_constraint(), virt_overhead * solved_value);
101 /* 2. Calculate resource share at the virtual machine layer. */
102 ignore_empty_vm_in_pm_LMM();
104 /* 3. Ready. Get the next occurring event */
105 return surf_cpu_model_vm->next_occuring_event(now);
112 VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::VirtualMachine* piface, simgrid::s4u::Host* host_PM,
113 int core_amount, size_t ramsize)
114 : HostImpl(piface), physical_host_(host_PM), core_amount_(core_amount), ramsize_(ramsize)
116 /* Register this VM to the list of all VMs */
117 allVms_.push_back(piface);
119 /* We create cpu_action corresponding to a VM process on the host operating system. */
120 /* TODO: we have to periodically input GUESTOS_NOISE to the system? how ? */
121 action_ = host_PM->pimpl_cpu->execution_start(0, core_amount);
123 XBT_VERB("Create VM(%s)@PM(%s)", piface->get_cname(), physical_host_->get_cname());
127 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
128 VirtualMachineImpl::~VirtualMachineImpl()
130 on_destruction(this);
131 /* I was already removed from the allVms set if the VM was destroyed cleanly */
132 auto iter = find(allVms_.begin(), allVms_.end(), piface_);
133 if (iter != allVms_.end())
136 /* Free the cpu_action of the VM. */
137 XBT_ATTRIB_UNUSED bool ret = action_->unref();
138 xbt_assert(ret, "Bug: some resource still remains");
141 void VirtualMachineImpl::suspend(smx_actor_t issuer)
143 if (get_state() != s4u::VirtualMachine::state::RUNNING)
144 THROWF(vm_error, 0, "Cannot suspend VM %s: it is not running.", piface_->get_cname());
145 if (issuer->host_ == piface_)
146 THROWF(vm_error, 0, "Actor %s cannot suspend the VM %s in which it runs", issuer->get_cname(),
147 piface_->get_cname());
149 XBT_DEBUG("suspend VM(%s), where %zu processes exist", piface_->get_cname(), process_list_.size());
153 for (auto& smx_process : process_list_) {
154 XBT_DEBUG("suspend %s", smx_process.get_cname());
155 smx_process.suspend(issuer);
158 XBT_DEBUG("suspend all processes on the VM done done");
160 vm_state_ = s4u::VirtualMachine::state::SUSPENDED;
163 void VirtualMachineImpl::resume()
165 if (get_state() != s4u::VirtualMachine::state::SUSPENDED)
166 THROWF(vm_error, 0, "Cannot resume VM %s: it was not suspended", piface_->get_cname());
168 XBT_DEBUG("Resume VM %s, containing %zu processes.", piface_->get_cname(), process_list_.size());
172 for (auto& smx_process : process_list_) {
173 XBT_DEBUG("resume %s", smx_process.get_cname());
174 smx_process.resume();
177 vm_state_ = s4u::VirtualMachine::state::RUNNING;
180 /** @brief Power off a VM.
182 * All hosted processes will be killed, but the VM state is preserved on memory.
183 * It can later be restarted.
185 * @param issuer the actor requesting the shutdown
187 void VirtualMachineImpl::shutdown(smx_actor_t issuer)
189 if (get_state() != s4u::VirtualMachine::state::RUNNING) {
190 const char* stateName = "(unknown state)";
191 switch (get_state()) {
192 case s4u::VirtualMachine::state::CREATED:
193 stateName = "created, but not yet started";
195 case s4u::VirtualMachine::state::SUSPENDED:
196 stateName = "suspended";
198 case s4u::VirtualMachine::state::DESTROYED:
199 stateName = "destroyed";
201 default: /* SURF_VM_STATE_RUNNING or unexpected values */
205 XBT_VERB("Shutting down the VM %s even if it's not running but %s", piface_->get_cname(), stateName);
208 XBT_DEBUG("shutdown VM %s, that contains %zu processes", piface_->get_cname(), process_list_.size());
210 for (auto& smx_process : process_list_) {
211 XBT_DEBUG("kill %s@%s on behalf of %s which shutdown that VM.", smx_process.get_cname(),
212 smx_process.host_->get_cname(), issuer->get_cname());
213 SIMIX_process_kill(&smx_process, issuer);
216 set_state(s4u::VirtualMachine::state::DESTROYED);
218 /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
221 /** @brief Change the physical host on which the given VM is running
223 * This is an instantaneous migration.
225 void VirtualMachineImpl::set_physical_host(s4u::Host* destination)
227 std::string vm_name = piface_->get_name();
228 std::string pm_name_src = physical_host_->get_name();
229 std::string pm_name_dst = destination->get_name();
231 /* update net_elm with that of the destination physical host */
232 piface_->pimpl_netpoint = destination->pimpl_netpoint;
234 physical_host_ = destination;
236 /* Update vcpu's action for the new pm */
237 /* create a cpu action bound to the pm model at the destination. */
238 surf::CpuAction* new_cpu_action =
239 static_cast<surf::CpuAction*>(destination->pimpl_cpu->execution_start(0, this->core_amount_));
241 if (action_->get_remains_no_update() > 0)
242 XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->get_remains_no_update());
244 /* keep the bound value of the cpu action of the VM. */
245 double old_bound = action_->get_bound();
247 XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name.c_str(), old_bound, pm_name_dst.c_str());
248 new_cpu_action->set_bound(old_bound);
251 XBT_ATTRIB_UNUSED bool ret = action_->unref();
252 xbt_assert(ret, "Bug: some resource still remains");
254 action_ = new_cpu_action;
256 XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name.c_str(), pm_name_src.c_str(), pm_name_dst.c_str());
259 void VirtualMachineImpl::set_bound(double bound)
261 action_->set_bound(bound);