Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
kill useless simcall handlers
[simgrid.git] / src / simix / smx_vm.cpp
1 /* Copyright (c) 2007-2015. 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 "mc/mc.h"
7 #include "simgrid/s4u/VirtualMachine.hpp"
8 #include "smx_private.h"
9 #include "src/plugins/vm/VirtualMachineImpl.hpp"
10 #include "src/surf/HostImpl.hpp"
11
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_vm, simix, "Logging specific to SIMIX Virtual Machines");
13
14 /* works for VMs and PMs */
15 static long host_get_ramsize(sg_host_t vm, int *overcommit)
16 {
17   s_vm_params_t params;
18   static_cast<simgrid::s4u::VirtualMachine*>(vm)->parameters(&params);
19
20   if (overcommit)
21     *overcommit = params.overcommit;
22
23   return params.ramsize;
24 }
25
26 /* **** start a VM **** */
27 static int __can_be_started(sg_host_t vm)
28 {
29   sg_host_t pm = static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->getPm();
30
31   int pm_overcommit = 0;
32   long pm_ramsize = host_get_ramsize(pm, &pm_overcommit);
33   long vm_ramsize = host_get_ramsize(vm, nullptr);
34
35   if (!pm_ramsize) {
36     /* We assume users do not want to care about ramsize. */
37     return 1;
38   }
39
40   if (pm_overcommit) {
41     XBT_VERB("%s allows memory overcommit.", sg_host_get_name(pm));
42     return 1;
43   }
44
45   long total_ramsize_of_vms = 0;
46   xbt_dynar_t dyn_vms       = pm->pimpl_->getVms();
47   {
48     unsigned int cursor = 0;
49     sg_host_t another_vm;
50     xbt_dynar_foreach(dyn_vms, cursor, another_vm) {
51       long another_vm_ramsize = host_get_ramsize(vm, nullptr);
52       total_ramsize_of_vms += another_vm_ramsize;
53     }
54   }
55
56   if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
57     XBT_WARN("cannnot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
58         sg_host_get_name(vm), sg_host_get_name(pm),
59         vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
60     xbt_dynar_free(&dyn_vms);
61     return 0;
62   }
63
64   return 1;
65 }
66
67 void SIMIX_vm_start(sg_host_t vm)
68 {
69   if (__can_be_started(vm))
70     static_cast<simgrid::surf::VirtualMachineImpl*>(vm->pimpl_)->setState(SURF_VM_STATE_RUNNING);
71   else
72     THROWF(vm_error, 0, "The VM %s cannot be started", vm->name().c_str());
73 }
74
75
76 e_surf_vm_state_t SIMIX_vm_get_state(sg_host_t vm)
77 {
78   return static_cast<simgrid::surf::VirtualMachineImpl*>(vm->pimpl_)->getState();
79 }
80
81 /**
82  * @brief Function to migrate a SIMIX VM host.
83  *
84  * @param host the vm host to migrate (a sg_host_t)
85  */
86 void SIMIX_vm_migrate(sg_host_t vm, sg_host_t dst_pm)
87 {
88   /* precopy migration makes the VM temporally paused */
89   xbt_assert(SIMIX_vm_get_state(vm) == SURF_VM_STATE_SUSPENDED);
90
91   /* jump to vm_ws_xigrate(). this will update the vm location. */
92   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->migrate(dst_pm);
93 }
94
95 /**
96  * @brief Encompassing simcall to prevent the removal of the src or the dst node at the end of a VM migration
97  *  The simcall actually invokes the following calls: 
98  *     simcall_vm_migrate(vm, dst_pm); 
99  *     simcall_vm_resume(vm);
100  *
101  * It is called at the end of the migration_rx_fun function from msg/msg_vm.c
102  *
103  * @param vm VM to migrate
104  * @param src_pm  Source physical host
105  * @param dst_pmt Destination physical host
106  */
107 void SIMIX_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst_pm)
108 {
109   /* Update the vm location */
110   SIMIX_vm_migrate(vm, dst_pm);
111  
112   /* Resume the VM */
113   SIMIX_vm_resume(vm);
114
115
116 /**
117  * @brief Function to suspend a SIMIX VM host. This function stops the execution of the
118  * VM. All the processes on this VM will pause. The state of the VM is
119  * preserved on memory. We can later resume it again.
120  *
121  * @param vm the vm host to suspend (a sg_host_t)
122  */
123 void SIMIX_vm_suspend(sg_host_t vm, smx_actor_t issuer)
124 {
125   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_RUNNING)
126     THROWF(vm_error, 0, "VM(%s) is not running", vm->name().c_str());
127
128   XBT_DEBUG("suspend VM(%s), where %d processes exist", vm->name().c_str(), xbt_swag_size(sg_host_simix(vm)->process_list));
129
130   /* jump to vm_ws_suspend. The state will be set. */
131   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->suspend();
132
133   smx_actor_t smx_process, smx_process_safe;
134   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
135     XBT_DEBUG("suspend %s", smx_process->name.c_str());
136     SIMIX_process_suspend(smx_process, issuer);
137   }
138
139   XBT_DEBUG("suspend all processes on the VM done done");
140 }
141
142 void simcall_HANDLER_vm_suspend(smx_simcall_t simcall, sg_host_t vm)
143 {
144   xbt_assert(simcall->issuer->host != vm, "cannot suspend the VM where I run");
145
146   SIMIX_vm_suspend(vm, simcall->issuer);
147
148   XBT_DEBUG("simcall_HANDLER_vm_suspend done");
149 }
150
151
152 /**
153  * @brief Function to resume a SIMIX VM host. This function restart the execution of the
154  * VM. All the processes on this VM will run again.
155  *
156  * @param vm the vm host to resume (a sg_host_t)
157  */
158 void SIMIX_vm_resume(sg_host_t vm)
159 {
160   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_SUSPENDED)
161     THROWF(vm_error, 0, "VM(%s) was not suspended", vm->name().c_str());
162
163   XBT_DEBUG("resume VM(%s), where %d processes exist",
164       vm->name().c_str(), xbt_swag_size(sg_host_simix(vm)->process_list));
165
166   /* jump to vm_ws_resume() */
167   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->resume();
168
169   smx_actor_t smx_process, smx_process_safe;
170   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
171     XBT_DEBUG("resume %s", smx_process->name.c_str());
172     SIMIX_process_resume(smx_process);
173   }
174 }
175
176 /**
177  * @brief Function to save a SIMIX VM host.
178  * This function is the same as vm_suspend, but the state of the VM is saved to the disk, and not preserved on memory.
179  * We can later restore it again.
180  *
181  * @param vm the vm host to save (a sg_host_t)
182  */
183 void SIMIX_vm_save(sg_host_t vm, smx_actor_t issuer)
184 {
185   const char *name = sg_host_get_name(vm);
186
187   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_RUNNING)
188     THROWF(vm_error, 0, "VM(%s) is not running", name);
189
190   XBT_DEBUG("save VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(vm)->process_list));
191
192   /* jump to vm_ws_save() */
193   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->resume();
194
195   smx_actor_t smx_process, smx_process_safe;
196   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
197     XBT_DEBUG("suspend %s", smx_process->name.c_str());
198     SIMIX_process_suspend(smx_process, issuer);
199   }
200 }
201
202 void simcall_HANDLER_vm_save(smx_simcall_t simcall, sg_host_t vm)
203 {
204   SIMIX_vm_save(vm, simcall->issuer);
205 }
206
207
208 /**
209  * @brief Function to restore a SIMIX VM host. This function restart the execution of the
210  * VM. All the processes on this VM will run again.
211  *
212  * @param vm the vm host to restore (a sg_host_t)
213  */
214 void SIMIX_vm_restore(sg_host_t vm)
215 {
216   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_SAVED)
217     THROWF(vm_error, 0, "VM(%s) was not saved", vm->name().c_str());
218
219   XBT_DEBUG("restore VM(%s), where %d processes exist",
220       vm->name().c_str(), xbt_swag_size(sg_host_simix(vm)->process_list));
221
222   /* jump to vm_ws_restore() */
223   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->resume();
224
225   smx_actor_t smx_process, smx_process_safe;
226   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
227     XBT_DEBUG("resume %s", smx_process->name.c_str());
228     SIMIX_process_resume(smx_process);
229   }
230 }
231
232 /**
233  * @brief Function to shutdown a SIMIX VM host. This function powers off the
234  * VM. All the processes on this VM will be killed. But, the state of the VM is
235  * preserved on memory. We can later start it again.
236  *
237  * @param vm the VM to shutdown (a sg_host_t)
238  */
239 void SIMIX_vm_shutdown(sg_host_t vm, smx_actor_t issuer)
240 {
241   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_RUNNING)
242     THROWF(vm_error, 0, "VM(%s) is not running", vm->name().c_str());
243
244   XBT_DEBUG("shutdown VM %s, that contains %d processes",
245       vm->name().c_str(),xbt_swag_size(sg_host_simix(vm)->process_list));
246
247   smx_actor_t smx_process, smx_process_safe;
248   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
249     XBT_DEBUG("kill %s", smx_process->name.c_str());
250     SIMIX_process_kill(smx_process, issuer);
251   }
252
253   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
254   static_cast<simgrid::surf::VirtualMachineImpl*>(vm->pimpl_)->setState(SURF_VM_STATE_CREATED);
255 }
256
257 void simcall_HANDLER_vm_shutdown(smx_simcall_t simcall, sg_host_t vm)
258 {
259   SIMIX_vm_shutdown(vm, simcall->issuer);
260 }
261
262 /**
263  * @brief Function to destroy a SIMIX VM host.
264  *
265  * @param vm the vm host to destroy (a sg_host_t)
266  */
267 void SIMIX_vm_destroy(sg_host_t vm)
268 {
269   /* this code basically performs a similar thing like SIMIX_host_destroy() */
270   XBT_DEBUG("destroy %s", vm->name().c_str());
271
272   /* FIXME: this is really strange that everything fails if the next line is removed.
273    * This is as if we shared these data with the PM, which definitely should not be the case...
274    *
275    * We need to test that suspending a VM does not suspends the processes running on its PM, for example.
276    * Or we need to simplify this code enough to make it actually readable (but this sounds harder than testing)
277    */
278   vm->extension_set<simgrid::simix::Host>(nullptr);
279
280   /* Don't free these things twice: they are the ones of my physical host */
281   vm->pimpl_cpu = nullptr;
282   vm->pimpl_netcard = nullptr;
283
284   vm->destroy();
285 }