Logo AND Algorithmique Numérique Distribuée

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