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"
12 #include "src/surf/host_interface.hpp"
13 #include "src/surf/virtual_machine.hpp"
15 //If you need to log some stuffs, just uncomment these two lines and uses XBT_DEBUG for instance
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_vm, simix, "Logging specific to SIMIX (vms)");
18 /* **** create a VM **** */
21 * \brief Internal function to create a SIMIX host.
22 * \param name name of the host to create
23 * \param data some user data (may be NULL)
25 sg_host_t SIMIX_vm_create(const char *name, sg_host_t ind_phys_host)
27 /* Create surf associated resource */
28 surf_vm_model_create(name, ind_phys_host);
29 sg_host_t host = sg_host_by_name(name);
30 SIMIX_host_create(host);
32 /* We will be able to register the VM to its physical host, so that we can promptly
33 * retrieve the list VMs on the physical host. */
39 /* works for VMs and PMs */
40 static long host_get_ramsize(sg_host_t vm, int *overcommit)
43 vm->extension<simgrid::surf::Host>()->getParams(¶ms);
46 *overcommit = params.overcommit;
48 return params.ramsize;
51 /* **** start a VM **** */
52 static int __can_be_started(sg_host_t vm)
54 sg_host_t pm = surf_vm_get_pm(vm);
56 int pm_overcommit = 0;
57 long pm_ramsize = host_get_ramsize(pm, &pm_overcommit);
58 long vm_ramsize = host_get_ramsize(vm, NULL);
61 /* We assume users do not want to care about ramsize. */
66 XBT_INFO("%s allows memory overcommit.", sg_host_get_name(pm));
70 long total_ramsize_of_vms = 0;
71 xbt_dynar_t dyn_vms = pm->extension<simgrid::surf::Host>()->getVms();
73 unsigned int cursor = 0;
75 xbt_dynar_foreach(dyn_vms, cursor, another_vm) {
76 long another_vm_ramsize = host_get_ramsize(vm, NULL);
77 total_ramsize_of_vms += another_vm_ramsize;
81 if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
82 XBT_WARN("cannnot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
83 sg_host_get_name(vm), sg_host_get_name(pm),
84 vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
85 xbt_dynar_free(&dyn_vms);
92 void SIMIX_vm_start(sg_host_t ind_vm)
94 if (__can_be_started(ind_vm))
95 static_cast<simgrid::surf::VirtualMachine*>(
96 ind_vm->extension<simgrid::surf::Host>()
97 )->setState(SURF_VM_STATE_RUNNING);
99 THROWF(vm_error, 0, "The VM %s cannot be started", sg_host_get_name(ind_vm));
103 e_surf_vm_state_t SIMIX_vm_get_state(sg_host_t ind_vm)
105 return static_cast<simgrid::surf::VirtualMachine*>(
106 ind_vm->extension<simgrid::surf::Host>()
111 * \brief Function to migrate a SIMIX VM host.
113 * \param host the vm host to migrate (a sg_host_t)
115 void SIMIX_vm_migrate(sg_host_t ind_vm, sg_host_t ind_dst_pm)
117 /* precopy migration makes the VM temporally paused */
118 xbt_assert(SIMIX_vm_get_state(ind_vm) == SURF_VM_STATE_SUSPENDED);
120 /* jump to vm_ws_xigrate(). this will update the vm location. */
121 surf_vm_migrate(ind_vm, ind_dst_pm);
125 * \brief Encompassing simcall to prevent the removal of the src or the dst node at the end of a VM migration
126 * The simcall actually invokes the following calls:
127 * simcall_vm_set_affinity(vm, src_pm, 0);
128 * simcall_vm_migrate(vm, dst_pm);
129 * simcall_vm_resume(vm);
131 * It is called at the end of the migration_rx_fun function from msg/msg_vm.c
133 * \param vm VM to migrate
134 * \param src_pm Source physical host
135 * \param dst_pmt Destination physical host
137 void SIMIX_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst_pm)
139 /* deinstall the current affinity setting for the CPU */
140 SIMIX_vm_set_affinity(vm, src_pm, 0);
142 /* Update the vm location */
143 SIMIX_vm_migrate(vm, dst_pm);
146 smx_process_t self = SIMIX_process_self();
147 SIMIX_vm_resume(vm, self->simcall.issuer);
151 * \brief Function to get the physical host of the given SIMIX VM host.
153 * \param host the vm host to get_phys_host (a sg_host_t)
155 void *SIMIX_vm_get_pm(sg_host_t ind_vm)
157 /* jump to vm_ws_get_pm(). this will return the vm name. */
158 return surf_vm_get_pm(ind_vm);
162 * \brief Function to set the CPU bound of the given SIMIX VM host.
164 * \param host the vm host (a sg_host_t)
165 * \param bound bound (a double)
167 void SIMIX_vm_set_bound(sg_host_t ind_vm, double bound)
169 /* jump to vm_ws_set_vm_bound(). */
170 surf_vm_set_bound(ind_vm, bound);
174 * \brief Function to set the CPU affinity of the given SIMIX VM host.
176 * \param host the vm host (a sg_host_t)
177 * \param host the pm host (a sg_host_t)
178 * \param mask affinity mask (a unsigned long)
180 void SIMIX_vm_set_affinity(sg_host_t ind_vm, sg_host_t ind_pm, unsigned long mask)
182 /* make sure this at the MSG layer. */
183 xbt_assert(SIMIX_vm_get_pm(ind_vm) == ind_pm);
185 /* jump to vm_ws_set_vm_affinity(). */
186 surf_vm_set_affinity(ind_vm, ind_pm, mask);
191 * \brief Function to suspend a SIMIX VM host. This function stops the execution of the
192 * VM. All the processes on this VM will pause. The state of the VM is
193 * preserved on memory. We can later resume it again.
195 * \param host the vm host to suspend (a sg_host_t)
197 void SIMIX_vm_suspend(sg_host_t ind_vm, smx_process_t issuer)
199 const char *name = sg_host_get_name(ind_vm);
201 if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
202 THROWF(vm_error, 0, "VM(%s) is not running", name);
204 XBT_DEBUG("suspend VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(ind_vm)->process_list));
206 /* jump to vm_ws_suspend. The state will be set. */
207 surf_vm_suspend(ind_vm);
209 smx_process_t smx_process, smx_process_safe;
210 xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
211 XBT_DEBUG("suspend %s", smx_process->name);
212 SIMIX_process_suspend(smx_process, issuer);
215 XBT_DEBUG("suspend all processes on the VM done done");
218 void simcall_HANDLER_vm_suspend(smx_simcall_t simcall, sg_host_t ind_vm)
220 if (simcall->issuer->host == ind_vm) {
221 XBT_ERROR("cannot suspend the VM where I run");
225 SIMIX_vm_suspend(ind_vm, simcall->issuer);
227 XBT_DEBUG("simcall_HANDLER_vm_suspend done");
232 * \brief Function to resume a SIMIX VM host. This function restart the execution of the
233 * VM. All the processes on this VM will run again.
235 * \param host the vm host to resume (a sg_host_t)
237 void SIMIX_vm_resume(sg_host_t ind_vm, smx_process_t issuer)
239 const char *name = sg_host_get_name(ind_vm);
241 if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_SUSPENDED)
242 THROWF(vm_error, 0, "VM(%s) was not suspended", name);
244 XBT_DEBUG("resume VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(ind_vm)->process_list));
246 /* jump to vm_ws_resume() */
247 surf_vm_resume(ind_vm);
249 smx_process_t smx_process, smx_process_safe;
250 xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
251 XBT_DEBUG("resume %s", smx_process->name);
252 SIMIX_process_resume(smx_process, issuer);
256 void simcall_HANDLER_vm_resume(smx_simcall_t simcall, sg_host_t ind_vm)
258 SIMIX_vm_resume(ind_vm, simcall->issuer);
263 * \brief Function to save a SIMIX VM host.
264 * This function is the same as vm_suspend, but the state of the VM is saved to the disk, and not preserved on memory.
265 * We can later restore it again.
267 * \param host the vm host to save (a sg_host_t)
269 void SIMIX_vm_save(sg_host_t ind_vm, smx_process_t issuer)
271 const char *name = sg_host_get_name(ind_vm);
273 if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
274 THROWF(vm_error, 0, "VM(%s) is not running", name);
277 XBT_DEBUG("save VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(ind_vm)->process_list));
279 /* jump to vm_ws_save() */
280 surf_vm_save(ind_vm);
282 smx_process_t smx_process, smx_process_safe;
283 xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
284 XBT_DEBUG("suspend %s", smx_process->name);
285 SIMIX_process_suspend(smx_process, issuer);
289 void simcall_HANDLER_vm_save(smx_simcall_t simcall, sg_host_t ind_vm)
291 SIMIX_vm_save(ind_vm, simcall->issuer);
296 * \brief Function to restore a SIMIX VM host. This function restart the execution of the
297 * VM. All the processes on this VM will run again.
299 * \param host the vm host to restore (a sg_host_t)
301 void SIMIX_vm_restore(sg_host_t ind_vm, smx_process_t issuer)
303 const char *name = sg_host_get_name(ind_vm);
305 if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_SAVED)
306 THROWF(vm_error, 0, "VM(%s) was not saved", name);
308 XBT_DEBUG("restore VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(ind_vm)->process_list));
310 /* jump to vm_ws_restore() */
311 surf_vm_resume(ind_vm);
313 smx_process_t smx_process, smx_process_safe;
314 xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
315 XBT_DEBUG("resume %s", smx_process->name);
316 SIMIX_process_resume(smx_process, issuer);
320 void simcall_HANDLER_vm_restore(smx_simcall_t simcall, sg_host_t ind_vm)
322 SIMIX_vm_restore(ind_vm, simcall->issuer);
327 * \brief Function to shutdown a SIMIX VM host. This function powers off the
328 * VM. All the processes on this VM will be killed. But, the state of the VM is
329 * preserved on memory. We can later start it again.
331 * \param host the vm host to shutdown (a sg_host_t)
333 void SIMIX_vm_shutdown(sg_host_t ind_vm, smx_process_t issuer)
335 const char *name = sg_host_get_name(ind_vm);
337 if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
338 THROWF(vm_error, 0, "VM(%s) is not running", name);
340 XBT_DEBUG("shutdown %s", name);
341 XBT_DEBUG("%d processes in the VM", xbt_swag_size(sg_host_simix(ind_vm)->process_list));
343 smx_process_t smx_process, smx_process_safe;
344 xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
345 XBT_DEBUG("kill %s", smx_process->name);
346 SIMIX_process_kill(smx_process, issuer);
349 /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
350 static_cast<simgrid::surf::VirtualMachine*>(
351 ind_vm->extension<simgrid::surf::Host>()
352 )->setState(SURF_VM_STATE_CREATED);
355 void simcall_HANDLER_vm_shutdown(smx_simcall_t simcall, sg_host_t ind_vm)
357 SIMIX_vm_shutdown(ind_vm, simcall->issuer);
362 * \brief Function to destroy a SIMIX VM host.
364 * \param host the vm host to destroy (a sg_host_t)
366 void SIMIX_vm_destroy(sg_host_t ind_vm)
368 /* this code basically performs a similar thing like SIMIX_host_destroy() */
370 const char *hostname = sg_host_get_name(ind_vm);
372 XBT_DEBUG("destroy %s", hostname);
374 /* this will call the registered callback function, i.e., SIMIX_host_destroy(). */
375 sg_host_simix_destroy(ind_vm);
377 /* jump to vm_ws_destroy(). The surf level resource will be freed. */
378 surf_vm_destroy(ind_vm);