Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
403a647e9231ab686d8ce8e3e99b24bdf44e2984
[simgrid.git] / src / plugins / vm / s4u_VirtualMachine.cpp
1 /* Copyright (c) 2015-2017. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #include "simgrid/s4u/Actor.hpp"
7 #include "src/instr/instr_private.hpp"
8 #include "src/plugins/vm/VirtualMachineImpl.hpp"
9 #include "src/plugins/vm/VmHostExt.hpp"
10 #include "src/simix/smx_host_private.hpp"
11 #include "src/surf/cpu_cas01.hpp"
12 #include <src/plugins/vm/VmLiveMigration.hpp>
13
14 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_vm, "S4U virtual machines");
15
16 namespace simgrid {
17 namespace s4u {
18
19 VirtualMachine::VirtualMachine(const char* name, s4u::Host* pm, int coreAmount)
20     : VirtualMachine(name, pm, coreAmount, 0)
21 {
22 }
23
24 VirtualMachine::VirtualMachine(const char* name, s4u::Host* pm, int coreAmount, size_t ramsize)
25     : Host(name), pimpl_vm_(new vm::VirtualMachineImpl(this, pm, coreAmount, ramsize))
26 {
27   XBT_DEBUG("Create VM %s", name);
28
29   /* Currently, a VM uses the network resource of its physical host */
30   pimpl_netpoint = pm->pimpl_netpoint;
31   // Create a VCPU for this VM
32   surf::CpuCas01* sub_cpu = dynamic_cast<surf::CpuCas01*>(pm->pimpl_cpu);
33
34   pimpl_cpu = surf_cpu_model_vm->createCpu(this, sub_cpu->getSpeedPeakList(), coreAmount);
35   if (sub_cpu->getPState() != 0)
36     pimpl_cpu->setPState(sub_cpu->getPState());
37
38   /* Make a process container */
39   extension_set<simgrid::simix::Host>(new simgrid::simix::Host());
40
41   if (TRACE_msg_vm_is_enabled()) {
42     container_t host_container = simgrid::instr::Container::byName(pm->getName());
43     new simgrid::instr::Container(name, "MSG_VM", host_container);
44   }
45 }
46
47 VirtualMachine::~VirtualMachine()
48 {
49   onDestruction(*this);
50
51   XBT_DEBUG("destroy %s", getCname());
52
53   /* FIXME: this is really strange that everything fails if the next line is removed.
54    * This is as if we shared these data with the PM, which definitely should not be the case...
55    *
56    * We need to test that suspending a VM does not suspends the processes running on its PM, for example.
57    * Or we need to simplify this code enough to make it actually readable (but this sounds harder than testing)
58    */
59   extension_set<simgrid::simix::Host>(nullptr);
60
61   /* Don't free these things twice: they are the ones of my physical host */
62   pimpl_netpoint = nullptr;
63 }
64
65 void VirtualMachine::start()
66 {
67   simgrid::simix::kernelImmediate([this]() {
68     simgrid::vm::VmHostExt::ensureVmExtInstalled();
69
70     simgrid::s4u::Host* pm = this->pimpl_vm_->getPm();
71     if (pm->extension<simgrid::vm::VmHostExt>() == nullptr)
72       pm->extension_set(new simgrid::vm::VmHostExt());
73
74     long pm_ramsize   = pm->extension<simgrid::vm::VmHostExt>()->ramsize;
75     int pm_overcommit = pm->extension<simgrid::vm::VmHostExt>()->overcommit;
76     long vm_ramsize   = this->getRamsize();
77
78     if (pm_ramsize && not pm_overcommit) { /* Only verify that we don't overcommit on need */
79       /* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
80       long total_ramsize_of_vms = 0;
81       for (simgrid::s4u::VirtualMachine* const& ws_vm : simgrid::vm::VirtualMachineImpl::allVms_)
82         if (pm == ws_vm->pimpl_vm_->getPm())
83           total_ramsize_of_vms += ws_vm->pimpl_vm_->getRamsize();
84
85       if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
86         XBT_WARN("cannnot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
87                  this->getCname(), pm->getCname(), vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
88         THROWF(vm_error, 0, "Memory shortage on host '%s', VM '%s' cannot be started", pm->getCname(),
89                this->getCname());
90       }
91     }
92
93     this->pimpl_vm_->setState(SURF_VM_STATE_RUNNING);
94   });
95 }
96
97 void VirtualMachine::suspend()
98 {
99   smx_actor_t issuer = SIMIX_process_self();
100   simgrid::simix::kernelImmediate([this, issuer]() { pimpl_vm_->suspend(issuer); });
101   XBT_DEBUG("vm_suspend done");
102 }
103
104 void VirtualMachine::resume()
105 {
106   pimpl_vm_->resume();
107 }
108
109 void VirtualMachine::shutdown()
110 {
111   smx_actor_t issuer = SIMIX_process_self();
112   simgrid::simix::kernelImmediate([this, issuer]() { pimpl_vm_->shutdown(issuer); });
113 }
114
115 bool VirtualMachine::isMigrating()
116 {
117   return pimpl_vm_ && pimpl_vm_->isMigrating;
118 }
119
120 simgrid::s4u::Host* VirtualMachine::getPm()
121 {
122   return pimpl_vm_->getPm();
123 }
124
125 void VirtualMachine::setPm(simgrid::s4u::Host* pm)
126 {
127   simgrid::simix::kernelImmediate([this, pm]() { pimpl_vm_->setPm(pm); });
128 }
129
130 e_surf_vm_state_t VirtualMachine::getState()
131 {
132   return pimpl_vm_->getState();
133 }
134
135 size_t VirtualMachine::getRamsize()
136 {
137   return pimpl_vm_->getRamsize();
138 }
139
140 void VirtualMachine::setRamsize(size_t ramsize)
141 {
142   pimpl_vm_->setRamsize(ramsize);
143 }
144 /** @brief Set a CPU bound for a given VM.
145  *  @ingroup msg_VMs
146  *
147  * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
148  *
149  * For example,
150  *  On PM0, there are Task1 and VM0.
151  *  On VM0, there is Task2.
152  * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
153  * Then,
154  *  Task1\@PM0 gets 50%.
155  *  Task2\@VM0 gets 25%.
156  * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
157  *
158  * This is because a VM has the dummy CPU action in the PM layer. Putting a task on the VM does not affect the bound of
159  * the dummy CPU action. The bound of the dummy CPU action is unlimited.
160  *
161  * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
162  * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
163  * on the VM in share_resource() or we have to trap both the start and end of task execution.
164  *
165  * The current solution is to use setBound(), which allows us to directly set the bound of the dummy CPU action.
166  *
167  * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
168  *    computation task (or a VM) never exceeds the capacity of a CPU core.
169  */
170 void VirtualMachine::setBound(double bound)
171 {
172   simgrid::simix::kernelImmediate([this, bound]() { pimpl_vm_->setBound(bound); });
173 }
174
175 } // namespace simgrid
176 } // namespace s4u