Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
d6bb3ecf3eb4f5d480839956cd0572293d5f1db8
[simgrid.git] / src / simix / smx_vm.c
1 /* Copyright (c) 2007-2014. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #include "smx_private.h"
8 #include "xbt/sysdep.h"
9 #include "xbt/log.h"
10 #include "xbt/dict.h"
11 #include "mc/mc.h"
12
13 //If you need to log some stuffs, just uncomment these two lines and uses XBT_DEBUG for instance
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_vm, simix, "Logging specific to SIMIX (vms)");
15
16 /* **** create a VM **** */
17
18 /**
19  * \brief Internal function to create a SIMIX host.
20  * \param name name of the host to create
21  * \param data some user data (may be NULL)
22  */
23 smx_host_t SIMIX_vm_create(const char *name, smx_host_t ind_phys_host)
24 {
25   /* Create surf associated resource */
26   surf_vm_workstation_model_create(name, ind_phys_host);
27
28   smx_host_t smx_host = SIMIX_host_create(name, ind_phys_host, NULL);
29
30   /* We will be able to register the VM to its physical host, so that we can promptly
31    * retrieve the list VMs on the physical host. */
32
33   return smx_host;
34 }
35
36
37 smx_host_t SIMIX_pre_vm_create(smx_simcall_t simcall, const char *name, smx_host_t ind_phys_host)
38 {
39   return SIMIX_vm_create(name, ind_phys_host);
40 }
41
42
43 /* works for VMs and PMs */
44 static long host_get_ramsize(smx_host_t vm, int *overcommit)
45 {
46   s_ws_params_t params;
47   surf_workstation_get_params(vm, &params);
48
49   if (overcommit)
50     *overcommit = params.overcommit;
51
52   return params.ramsize;
53 }
54
55 /* **** start a VM **** */
56 static int __can_be_started(smx_host_t vm)
57 {
58   smx_host_t pm = surf_vm_workstation_get_pm(vm);
59
60   int pm_overcommit = 0;
61   long pm_ramsize = host_get_ramsize(pm, &pm_overcommit);
62   long vm_ramsize = host_get_ramsize(vm, NULL);
63
64   if (!pm_ramsize) {
65     /* We assume users do not want to care about ramsize. */
66     return 1;
67   }
68
69   if (pm_overcommit) {
70     XBT_INFO("%s allows memory overcommit.", pm->key);
71     return 1;
72   }
73
74   long total_ramsize_of_vms = 0;
75   xbt_dynar_t dyn_vms = surf_workstation_get_vms(pm);
76   {
77     unsigned int cursor = 0;
78     smx_host_t another_vm;
79     xbt_dynar_foreach(dyn_vms, cursor, another_vm) {
80       long another_vm_ramsize = host_get_ramsize(vm, NULL);
81       total_ramsize_of_vms += another_vm_ramsize;
82     }
83   }
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         vm->key, pm->key, vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
88     xbt_dynar_free(&dyn_vms);
89     return 0;
90   }
91
92   xbt_dynar_free(&dyn_vms);
93         return 1;
94 }
95
96 void SIMIX_vm_start(smx_host_t ind_vm)
97 {
98   if (__can_be_started(ind_vm))
99         surf_resource_set_state(surf_workstation_resource_priv(ind_vm), SURF_VM_STATE_RUNNING);
100   else
101     THROWF(vm_error, 0, "The VM %s cannot be started", SIMIX_host_get_name(ind_vm));
102 }
103
104
105
106 void SIMIX_pre_vm_start(smx_simcall_t simcall, smx_host_t ind_vm)
107 {
108   SIMIX_vm_start(ind_vm);
109 }
110
111 int SIMIX_vm_get_state(smx_host_t ind_vm)
112 {
113   return surf_resource_get_state(surf_workstation_resource_priv(ind_vm));
114 }
115
116 int SIMIX_pre_vm_get_state(smx_simcall_t simcall, smx_host_t ind_vm)
117 {
118   return SIMIX_vm_get_state(ind_vm);
119 }
120
121
122 /**
123  * \brief Function to migrate a SIMIX VM host. 
124  *
125  * \param host the vm host to migrate (a smx_host_t)
126  */
127 void SIMIX_vm_migrate(smx_host_t ind_vm, smx_host_t ind_dst_pm)
128 {
129   /* precopy migration makes the VM temporally paused */
130   e_surf_vm_state_t state = SIMIX_vm_get_state(ind_vm);
131   xbt_assert(state == SURF_VM_STATE_SUSPENDED);
132
133   /* jump to vm_ws_migrate(). this will update the vm location. */
134   surf_vm_workstation_migrate(ind_vm, ind_dst_pm);
135 }
136
137 void SIMIX_pre_vm_migrate(smx_simcall_t simcall, smx_host_t ind_vm, smx_host_t ind_dst_pm)
138 {
139   SIMIX_vm_migrate(ind_vm, ind_dst_pm);
140 }
141
142
143 /**
144  * \brief Function to get the physical host of the given SIMIX VM host.
145  *
146  * \param host the vm host to get_phys_host (a smx_host_t)
147  */
148 void *SIMIX_vm_get_pm(smx_host_t ind_vm)
149 {
150   /* jump to vm_ws_get_pm(). this will return the vm name. */
151   return surf_vm_workstation_get_pm(ind_vm);
152 }
153
154 void *SIMIX_pre_vm_get_pm(smx_simcall_t simcall, smx_host_t ind_vm)
155 {
156   return SIMIX_vm_get_pm(ind_vm);
157 }
158
159
160 /**
161  * \brief Function to set the CPU bound of the given SIMIX VM host.
162  *
163  * \param host the vm host (a smx_host_t)
164  * \param bound bound (a double)
165  */
166 void SIMIX_vm_set_bound(smx_host_t ind_vm, double bound)
167 {
168   /* jump to vm_ws_set_vm_bound(). */
169   surf_vm_workstation_set_bound(ind_vm, bound);
170 }
171
172 void SIMIX_pre_vm_set_bound(smx_simcall_t simcall, smx_host_t ind_vm, double bound)
173 {
174   SIMIX_vm_set_bound(ind_vm, bound);
175 }
176
177
178 /**
179  * \brief Function to set the CPU affinity of the given SIMIX VM host.
180  *
181  * \param host the vm host (a smx_host_t)
182  * \param host the pm host (a smx_host_t)
183  * \param mask affinity mask (a unsigned long)
184  */
185 void SIMIX_vm_set_affinity(smx_host_t ind_vm, smx_host_t ind_pm, unsigned long mask)
186 {
187   /* make sure this at the MSG layer. */
188   xbt_assert(SIMIX_vm_get_pm(ind_vm) == ind_pm);
189
190   /* jump to vm_ws_set_vm_affinity(). */
191   surf_vm_workstation_set_affinity(ind_vm, ind_pm, mask);
192 }
193
194 void SIMIX_pre_vm_set_affinity(smx_simcall_t simcall, smx_host_t ind_vm, smx_host_t ind_pm, unsigned long mask)
195 {
196   SIMIX_vm_set_affinity(ind_vm, ind_pm, mask);
197 }
198
199
200 /**
201  * \brief Function to suspend a SIMIX VM host. This function stops the exection of the
202  * VM. All the processes on this VM will pause. The state of the VM is
203  * preserved on memory. We can later resume it again.
204  *
205  * \param host the vm host to suspend (a smx_host_t)
206  */
207 void SIMIX_vm_suspend(smx_host_t ind_vm, smx_process_t issuer)
208 {
209   const char *name = SIMIX_host_get_name(ind_vm);
210
211   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
212     THROWF(vm_error, 0, "VM(%s) is not running", name);
213
214   XBT_DEBUG("suspend VM(%s), where %d processes exist", name, xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
215
216   /* jump to vm_ws_suspend. The state will be set. */
217   surf_vm_workstation_suspend(ind_vm);
218
219   smx_process_t smx_process, smx_process_safe;
220   xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
221     XBT_DEBUG("suspend %s", smx_process->name);
222     SIMIX_process_suspend(smx_process, issuer);
223   }
224
225   XBT_DEBUG("suspend all processes on the VM done done");
226 }
227
228 void SIMIX_pre_vm_suspend(smx_simcall_t simcall, smx_host_t ind_vm)
229 {
230   if (simcall->issuer->smx_host == ind_vm) {
231     XBT_ERROR("cannot suspend the VM where I run");
232     DIE_IMPOSSIBLE;
233   }
234
235   SIMIX_vm_suspend(ind_vm, simcall->issuer);
236
237   XBT_DEBUG("SIMIX_pre_vm_suspend done");
238 }
239
240
241 /**
242  * \brief Function to resume a SIMIX VM host. This function restart the execution of the
243  * VM. All the processes on this VM will run again. 
244  *
245  * \param host the vm host to resume (a smx_host_t)
246  */
247 void SIMIX_vm_resume(smx_host_t ind_vm, smx_process_t issuer)
248 {
249   const char *name = SIMIX_host_get_name(ind_vm);
250
251   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_SUSPENDED)
252     THROWF(vm_error, 0, "VM(%s) was not suspended", name);
253
254   XBT_DEBUG("resume VM(%s), where %d processes exist", name, xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
255
256   /* jump to vm_ws_resume() */
257   surf_vm_workstation_resume(ind_vm);
258
259   smx_process_t smx_process, smx_process_safe;
260   xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
261     XBT_DEBUG("resume %s", smx_process->name);
262     SIMIX_process_resume(smx_process, issuer);
263   }
264 }
265
266 void SIMIX_pre_vm_resume(smx_simcall_t simcall, smx_host_t ind_vm)
267 {
268   SIMIX_vm_resume(ind_vm, simcall->issuer);
269 }
270
271
272 /**
273  * \brief Function to save a SIMIX VM host.
274  * This function is the same as vm_suspend, but the state of the VM is saved to the disk, and not preserved on memory.
275  * We can later restore it again.
276  *
277  * \param host the vm host to save (a smx_host_t)
278  */
279 void SIMIX_vm_save(smx_host_t ind_vm, smx_process_t issuer)
280 {
281   const char *name = SIMIX_host_get_name(ind_vm);
282
283   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
284     THROWF(vm_error, 0, "VM(%s) is not running", name);
285
286
287   XBT_DEBUG("save VM(%s), where %d processes exist", name, xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
288
289   /* jump to vm_ws_save() */
290   surf_vm_workstation_save(ind_vm);
291
292   smx_process_t smx_process, smx_process_safe;
293   xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
294     XBT_DEBUG("suspend %s", smx_process->name);
295     SIMIX_process_suspend(smx_process, issuer);
296   }
297 }
298
299 void SIMIX_pre_vm_save(smx_simcall_t simcall, smx_host_t ind_vm)
300 {
301   SIMIX_vm_save(ind_vm, simcall->issuer);
302 }
303
304
305 /**
306  * \brief Function to restore a SIMIX VM host. This function restart the execution of the
307  * VM. All the processes on this VM will run again. 
308  *
309  * \param host the vm host to restore (a smx_host_t)
310  */
311 void SIMIX_vm_restore(smx_host_t ind_vm, smx_process_t issuer)
312 {
313   const char *name = SIMIX_host_get_name(ind_vm);
314
315   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_SAVED)
316     THROWF(vm_error, 0, "VM(%s) was not saved", name);
317
318   XBT_DEBUG("restore VM(%s), where %d processes exist", name, xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
319
320   /* jump to vm_ws_restore() */
321   surf_vm_workstation_resume(ind_vm);
322
323   smx_process_t smx_process, smx_process_safe;
324   xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
325     XBT_DEBUG("resume %s", smx_process->name);
326     SIMIX_process_resume(smx_process, issuer);
327   }
328 }
329
330 void SIMIX_pre_vm_restore(smx_simcall_t simcall, smx_host_t ind_vm)
331 {
332   SIMIX_vm_restore(ind_vm, simcall->issuer);
333 }
334
335
336 /**
337  * \brief Function to shutdown a SIMIX VM host. This function powers off the
338  * VM. All the processes on this VM will be killed. But, the state of the VM is
339  * preserved on memory. We can later start it again.
340  *
341  * \param host the vm host to shutdown (a smx_host_t)
342  */
343 void SIMIX_vm_shutdown(smx_host_t ind_vm, smx_process_t issuer)
344 {
345   const char *name = SIMIX_host_get_name(ind_vm);
346
347   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
348     THROWF(vm_error, 0, "VM(%s) is not running", name);
349
350   XBT_DEBUG("shutdown %s", name);
351   XBT_DEBUG("%d processes in the VM", xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
352
353   smx_process_t smx_process, smx_process_safe;
354   xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
355     XBT_DEBUG("kill %s", smx_process->name);
356     SIMIX_process_kill(smx_process, issuer);
357   }
358
359   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
360   surf_resource_set_state(surf_workstation_resource_priv(ind_vm), SURF_VM_STATE_CREATED);
361 }
362
363 void SIMIX_pre_vm_shutdown(smx_simcall_t simcall, smx_host_t ind_vm)
364 {
365   SIMIX_vm_shutdown(ind_vm, simcall->issuer);
366 }
367
368
369 /**
370  * \brief Function to destroy a SIMIX VM host.
371  *
372  * \param host the vm host to destroy (a smx_host_t)
373  */
374 void SIMIX_vm_destroy(smx_host_t ind_vm)
375 {
376   /* this code basically performs a similar thing like SIMIX_host_destroy() */
377
378   xbt_assert((ind_vm != NULL), "Invalid parameters");
379   const char *hostname = SIMIX_host_get_name(ind_vm);
380
381   XBT_DEBUG("destroy %s", hostname);
382
383   /* this will call the registered callback function, i.e., SIMIX_host_destroy().  */
384   xbt_lib_unset(host_lib, hostname, SIMIX_HOST_LEVEL, 1);
385
386   /* jump to vm_ws_destroy(). The surf level resource will be freed. */
387   surf_vm_workstation_destroy(ind_vm);
388 }
389
390 void SIMIX_pre_vm_destroy(smx_simcall_t simcall, smx_host_t ind_vm)
391 {
392   SIMIX_vm_destroy(ind_vm);
393 }