1 /* Copyright (c) 2007-2015. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #include "smx_private.h"
8 #include "xbt/sysdep.h"
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)");
16 /* **** create a VM **** */
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)
23 sg_host_t SIMIX_vm_create(const char *name, sg_host_t ind_phys_host)
25 /* Create surf associated resource */
26 surf_vm_model_create(name, ind_phys_host);
27 sg_host_t host = sg_host_by_name(name);
28 SIMIX_host_create(host);
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. */
37 /* works for VMs and PMs */
38 static long host_get_ramsize(sg_host_t vm, int *overcommit)
41 surf_host_get_params(vm, ¶ms);
44 *overcommit = params.overcommit;
46 return params.ramsize;
49 /* **** start a VM **** */
50 static int __can_be_started(sg_host_t vm)
52 sg_host_t pm = surf_vm_get_pm(vm);
54 int pm_overcommit = 0;
55 long pm_ramsize = host_get_ramsize(pm, &pm_overcommit);
56 long vm_ramsize = host_get_ramsize(vm, NULL);
59 /* We assume users do not want to care about ramsize. */
64 XBT_INFO("%s allows memory overcommit.", sg_host_get_name(pm));
68 long total_ramsize_of_vms = 0;
69 xbt_dynar_t dyn_vms = surf_host_get_vms(pm);
71 unsigned int cursor = 0;
73 xbt_dynar_foreach(dyn_vms, cursor, another_vm) {
74 long another_vm_ramsize = host_get_ramsize(vm, NULL);
75 total_ramsize_of_vms += another_vm_ramsize;
79 if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
80 XBT_WARN("cannnot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
81 sg_host_get_name(vm), sg_host_get_name(pm),
82 vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
83 xbt_dynar_free(&dyn_vms);
87 xbt_dynar_free(&dyn_vms);
91 void SIMIX_vm_start(sg_host_t ind_vm)
93 if (__can_be_started(ind_vm))
94 surf_host_set_state(surf_host_resource_priv(ind_vm),
95 (e_surf_resource_state_t) SURF_VM_STATE_RUNNING);
97 THROWF(vm_error, 0, "The VM %s cannot be started", SIMIX_host_get_name(ind_vm));
101 int SIMIX_vm_get_state(sg_host_t ind_vm)
103 return surf_host_get_state(surf_host_resource_priv(ind_vm));
107 * \brief Function to migrate a SIMIX VM host.
109 * \param host the vm host to migrate (a sg_host_t)
111 void SIMIX_vm_migrate(sg_host_t ind_vm, sg_host_t ind_dst_pm)
113 /* precopy migration makes the VM temporally paused */
114 xbt_assert(SIMIX_vm_get_state(ind_vm) == SURF_VM_STATE_SUSPENDED);
116 /* jump to vm_ws_xigrate(). this will update the vm location. */
117 surf_vm_migrate(ind_vm, ind_dst_pm);
121 * \brief Encompassing simcall to prevent the removal of the src or the dst node at the end of a VM migration
122 * The simcall actually invokes the following calls:
123 * simcall_vm_set_affinity(vm, src_pm, 0);
124 * simcall_vm_migrate(vm, dst_pm);
125 * simcall_vm_resume(vm);
127 * It is called at the end of the migration_rx_fun function from msg/msg_vm.c
129 * \param vm VM to migrate
130 * \param src_pm Source physical host
131 * \param dst_pmt Destination physical host
133 void SIMIX_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst_pm)
135 /* deinstall the current affinity setting for the CPU */
136 SIMIX_vm_set_affinity(vm, src_pm, 0);
138 /* Update the vm location */
139 SIMIX_vm_migrate(vm, dst_pm);
142 smx_process_t self = SIMIX_process_self();
143 SIMIX_vm_resume(vm, self->simcall.issuer);
147 * \brief Function to get the physical host of the given SIMIX VM host.
149 * \param host the vm host to get_phys_host (a sg_host_t)
151 void *SIMIX_vm_get_pm(sg_host_t ind_vm)
153 /* jump to vm_ws_get_pm(). this will return the vm name. */
154 return surf_vm_get_pm(ind_vm);
158 * \brief Function to set the CPU bound of the given SIMIX VM host.
160 * \param host the vm host (a sg_host_t)
161 * \param bound bound (a double)
163 void SIMIX_vm_set_bound(sg_host_t ind_vm, double bound)
165 /* jump to vm_ws_set_vm_bound(). */
166 surf_vm_set_bound(ind_vm, bound);
170 * \brief Function to set the CPU affinity of the given SIMIX VM host.
172 * \param host the vm host (a sg_host_t)
173 * \param host the pm host (a sg_host_t)
174 * \param mask affinity mask (a unsigned long)
176 void SIMIX_vm_set_affinity(sg_host_t ind_vm, sg_host_t ind_pm, unsigned long mask)
178 /* make sure this at the MSG layer. */
179 xbt_assert(SIMIX_vm_get_pm(ind_vm) == ind_pm);
181 /* jump to vm_ws_set_vm_affinity(). */
182 surf_vm_set_affinity(ind_vm, ind_pm, mask);
187 * \brief Function to suspend a SIMIX VM host. This function stops the execution of the
188 * VM. All the processes on this VM will pause. The state of the VM is
189 * preserved on memory. We can later resume it again.
191 * \param host the vm host to suspend (a sg_host_t)
193 void SIMIX_vm_suspend(sg_host_t ind_vm, smx_process_t issuer)
195 const char *name = SIMIX_host_get_name(ind_vm);
197 if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
198 THROWF(vm_error, 0, "VM(%s) is not running", name);
200 XBT_DEBUG("suspend VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(ind_vm)->process_list));
202 /* jump to vm_ws_suspend. The state will be set. */
203 surf_vm_suspend(ind_vm);
205 smx_process_t smx_process, smx_process_safe;
206 xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
207 XBT_DEBUG("suspend %s", smx_process->name);
208 SIMIX_process_suspend(smx_process, issuer);
211 XBT_DEBUG("suspend all processes on the VM done done");
214 void simcall_HANDLER_vm_suspend(smx_simcall_t simcall, sg_host_t ind_vm)
216 if (simcall->issuer->host == ind_vm) {
217 XBT_ERROR("cannot suspend the VM where I run");
221 SIMIX_vm_suspend(ind_vm, simcall->issuer);
223 XBT_DEBUG("simcall_HANDLER_vm_suspend done");
228 * \brief Function to resume a SIMIX VM host. This function restart the execution of the
229 * VM. All the processes on this VM will run again.
231 * \param host the vm host to resume (a sg_host_t)
233 void SIMIX_vm_resume(sg_host_t ind_vm, smx_process_t issuer)
235 const char *name = SIMIX_host_get_name(ind_vm);
237 if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_SUSPENDED)
238 THROWF(vm_error, 0, "VM(%s) was not suspended", name);
240 XBT_DEBUG("resume VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(ind_vm)->process_list));
242 /* jump to vm_ws_resume() */
243 surf_vm_resume(ind_vm);
245 smx_process_t smx_process, smx_process_safe;
246 xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
247 XBT_DEBUG("resume %s", smx_process->name);
248 SIMIX_process_resume(smx_process, issuer);
252 void simcall_HANDLER_vm_resume(smx_simcall_t simcall, sg_host_t ind_vm)
254 SIMIX_vm_resume(ind_vm, simcall->issuer);
259 * \brief Function to save a SIMIX VM host.
260 * This function is the same as vm_suspend, but the state of the VM is saved to the disk, and not preserved on memory.
261 * We can later restore it again.
263 * \param host the vm host to save (a sg_host_t)
265 void SIMIX_vm_save(sg_host_t ind_vm, smx_process_t issuer)
267 const char *name = SIMIX_host_get_name(ind_vm);
269 if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
270 THROWF(vm_error, 0, "VM(%s) is not running", name);
273 XBT_DEBUG("save VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(ind_vm)->process_list));
275 /* jump to vm_ws_save() */
276 surf_vm_save(ind_vm);
278 smx_process_t smx_process, smx_process_safe;
279 xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
280 XBT_DEBUG("suspend %s", smx_process->name);
281 SIMIX_process_suspend(smx_process, issuer);
285 void simcall_HANDLER_vm_save(smx_simcall_t simcall, sg_host_t ind_vm)
287 SIMIX_vm_save(ind_vm, simcall->issuer);
292 * \brief Function to restore a SIMIX VM host. This function restart the execution of the
293 * VM. All the processes on this VM will run again.
295 * \param host the vm host to restore (a sg_host_t)
297 void SIMIX_vm_restore(sg_host_t ind_vm, smx_process_t issuer)
299 const char *name = SIMIX_host_get_name(ind_vm);
301 if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_SAVED)
302 THROWF(vm_error, 0, "VM(%s) was not saved", name);
304 XBT_DEBUG("restore VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(ind_vm)->process_list));
306 /* jump to vm_ws_restore() */
307 surf_vm_resume(ind_vm);
309 smx_process_t smx_process, smx_process_safe;
310 xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
311 XBT_DEBUG("resume %s", smx_process->name);
312 SIMIX_process_resume(smx_process, issuer);
316 void simcall_HANDLER_vm_restore(smx_simcall_t simcall, sg_host_t ind_vm)
318 SIMIX_vm_restore(ind_vm, simcall->issuer);
323 * \brief Function to shutdown a SIMIX VM host. This function powers off the
324 * VM. All the processes on this VM will be killed. But, the state of the VM is
325 * preserved on memory. We can later start it again.
327 * \param host the vm host to shutdown (a sg_host_t)
329 void SIMIX_vm_shutdown(sg_host_t ind_vm, smx_process_t issuer)
331 const char *name = SIMIX_host_get_name(ind_vm);
333 if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
334 THROWF(vm_error, 0, "VM(%s) is not running", name);
336 XBT_DEBUG("shutdown %s", name);
337 XBT_DEBUG("%d processes in the VM", xbt_swag_size(sg_host_simix(ind_vm)->process_list));
339 smx_process_t smx_process, smx_process_safe;
340 xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
341 XBT_DEBUG("kill %s", smx_process->name);
342 SIMIX_process_kill(smx_process, issuer);
345 /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
346 surf_host_set_state(surf_host_resource_priv(ind_vm),
347 (e_surf_resource_state_t) SURF_VM_STATE_CREATED);
350 void simcall_HANDLER_vm_shutdown(smx_simcall_t simcall, sg_host_t ind_vm)
352 SIMIX_vm_shutdown(ind_vm, simcall->issuer);
357 * \brief Function to destroy a SIMIX VM host.
359 * \param host the vm host to destroy (a sg_host_t)
361 void SIMIX_vm_destroy(sg_host_t ind_vm)
363 /* this code basically performs a similar thing like SIMIX_host_destroy() */
365 xbt_assert((ind_vm != NULL), "Invalid parameters");
366 const char *hostname = SIMIX_host_get_name(ind_vm);
368 XBT_DEBUG("destroy %s", hostname);
370 /* this will call the registered callback function, i.e., SIMIX_host_destroy(). */
371 sg_host_simix_destroy(ind_vm);
373 /* jump to vm_ws_destroy(). The surf level resource will be freed. */
374 surf_vm_destroy(ind_vm);