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/plugins/vm/VmHostExt.hpp"
  11 #include "src/surf/HostImpl.hpp"
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_vm, simix, "Logging specific to SIMIX Virtual Machines");
  14
  15 /* works for VMs and PMs */
  16 static long host_get_ramsize(sg_host_t vm, int *overcommit)
  17 {
  18   s_vm_params_t params;
  19   static_cast<simgrid::s4u::VirtualMachine*>(vm)->parameters(&params);
  20
  21   if (overcommit)
  22     *overcommit = params.overcommit;
  23
  24   return params.ramsize;
  25 }
  26
  27 /* **** start a VM **** */
  28 static int __can_be_started(sg_host_t vm)
  29 {
  30   sg_host_t pm = static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->getPm();
  31
  32   simgrid::vm::VmHostExt::ensureVmExtInstalled();
  33   if (pm->extension<simgrid::vm::VmHostExt>() == nullptr)
  34     pm->extension_set(new simgrid::vm::VmHostExt());
  35
  36   long pm_ramsize = pm->extension<simgrid::vm::VmHostExt>()->ramsize;
  37   int pm_overcommit = pm->extension<simgrid::vm::VmHostExt>()->overcommit;
  38   long vm_ramsize = host_get_ramsize(vm, nullptr);
  39
  40   if (!pm_ramsize) {
  41     /* We assume users do not want to care about ramsize. */
  42     return 1;
  43   }
  44
  45   if (pm_overcommit) {
  46     XBT_VERB("%s allows memory overcommit.", sg_host_get_name(pm));
  47     return 1;
  48   }
  49
  50   /* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
  51   long total_ramsize_of_vms = 0;
  52   for (simgrid::surf::VirtualMachineImpl* ws_vm : simgrid::surf::VirtualMachineImpl::allVms_)
  53     if (pm == ws_vm->getPm())
  54       total_ramsize_of_vms += ws_vm->getRamsize();
  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     return 0;
  61   }
  62
  63   return 1;
  64 }
  65
  66 void SIMIX_vm_start(sg_host_t vm)
  67 {
  68   if (__can_be_started(vm))
  69     static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->setState(SURF_VM_STATE_RUNNING);
  70   else
  71     THROWF(vm_error, 0, "The VM %s cannot be started", vm->name().c_str());
  72 }
  73
  74 /**
  75  * @brief Function to migrate a SIMIX VM host.
  76  *
  77  * @param host the vm host to migrate (a sg_host_t)
  78  */
  79 void SIMIX_vm_migrate(sg_host_t vm, sg_host_t dst_pm)
  80 {
  81   /* precopy migration makes the VM temporally paused */
  82   xbt_assert(static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->getState() == SURF_VM_STATE_SUSPENDED);
  83
  84   /* jump to vm_ws_xigrate(). this will update the vm location. */
  85   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->migrate(dst_pm);
  86 }
  87
  88 /**
  89  * @brief Function to suspend a SIMIX VM host. This function stops the execution of the
  90  * VM. All the processes on this VM will pause. The state of the VM is
  91  * preserved on memory. We can later resume it again.
  92  *
  93  * @param vm the vm host to suspend (a sg_host_t)
  94  */
  95 void SIMIX_vm_suspend(sg_host_t vm, smx_actor_t issuer)
  96 {
  97   if (static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->getState() != SURF_VM_STATE_RUNNING)
  98     THROWF(vm_error, 0, "VM(%s) is not running", vm->name().c_str());
  99
 100   XBT_DEBUG("suspend VM(%s), where %d processes exist", vm->name().c_str(), xbt_swag_size(sg_host_simix(vm)->process_list));
 101
 102   /* jump to vm_ws_suspend. The state will be set. */
 103   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->suspend();
 104
 105   smx_actor_t smx_process, smx_process_safe;
 106   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
 107     XBT_DEBUG("suspend %s", smx_process->name.c_str());
 108     SIMIX_process_suspend(smx_process, issuer);
 109   }
 110
 111   XBT_DEBUG("suspend all processes on the VM done done");
 112 }
 113
 114 void simcall_HANDLER_vm_suspend(smx_simcall_t simcall, sg_host_t vm)
 115 {
 116   xbt_assert(simcall->issuer->host != vm, "cannot suspend the VM where I run");
 117
 118   SIMIX_vm_suspend(vm, simcall->issuer);
 119
 120   XBT_DEBUG("simcall_HANDLER_vm_suspend done");
 121 }
 122
 123
 124 /**
 125  * @brief Function to resume a SIMIX VM host. This function restart the execution of the
 126  * VM. All the processes on this VM will run again.
 127  *
 128  * @param vm the vm host to resume (a sg_host_t)
 129  */
 130 void SIMIX_vm_resume(sg_host_t vm)
 131 {
 132   if (static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->getState() != SURF_VM_STATE_SUSPENDED)
 133     THROWF(vm_error, 0, "VM(%s) was not suspended", vm->name().c_str());
 134
 135   XBT_DEBUG("resume VM(%s), where %d processes exist",
 136       vm->name().c_str(), xbt_swag_size(sg_host_simix(vm)->process_list));
 137
 138   /* jump to vm_ws_resume() */
 139   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->resume();
 140
 141   smx_actor_t smx_process, smx_process_safe;
 142   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
 143     XBT_DEBUG("resume %s", smx_process->name.c_str());
 144     SIMIX_process_resume(smx_process);
 145   }
 146 }
 147
 148 /**
 149  * @brief Function to save a SIMIX VM host.
 150  * This function is the same as vm_suspend, but the state of the VM is saved to the disk, and not preserved on memory.
 151  * We can later restore it again.
 152  *
 153  * @param vm the vm host to save (a sg_host_t)
 154  */
 155 void SIMIX_vm_save(sg_host_t vm, smx_actor_t issuer)
 156 {
 157   const char *name = sg_host_get_name(vm);
 158
 159   if (static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->getState() != SURF_VM_STATE_RUNNING)
 160     THROWF(vm_error, 0, "VM(%s) is not running", name);
 161
 162   XBT_DEBUG("save VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(vm)->process_list));
 163
 164   /* jump to vm_ws_save() */
 165   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->save();
 166
 167   smx_actor_t smx_process, smx_process_safe;
 168   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
 169     XBT_DEBUG("suspend %s", smx_process->name.c_str());
 170     SIMIX_process_suspend(smx_process, issuer);
 171   }
 172 }
 173
 174 void simcall_HANDLER_vm_save(smx_simcall_t simcall, sg_host_t vm)
 175 {
 176   SIMIX_vm_save(vm, simcall->issuer);
 177 }
 178
 179 /**
 180  * @brief Function to shutdown a SIMIX VM host. This function powers off the
 181  * VM. All the processes on this VM will be killed. But, the state of the VM is
 182  * preserved on memory. We can later start it again.
 183  *
 184  * @param vm the VM to shutdown (a sg_host_t)
 185  */
 186 void SIMIX_vm_shutdown(sg_host_t vm, smx_actor_t issuer)
 187 {
 188   if (static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->getState() != SURF_VM_STATE_RUNNING)
 189     THROWF(vm_error, 0, "VM(%s) is not running", vm->name().c_str());
 190
 191   XBT_DEBUG("shutdown VM %s, that contains %d processes",
 192       vm->name().c_str(),xbt_swag_size(sg_host_simix(vm)->process_list));
 193
 194   smx_actor_t smx_process, smx_process_safe;
 195   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
 196     XBT_DEBUG("kill %s", smx_process->name.c_str());
 197     SIMIX_process_kill(smx_process, issuer);
 198   }
 199
 200   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
 201   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->setState(SURF_VM_STATE_CREATED);
 202 }
 203
 204 void simcall_HANDLER_vm_shutdown(smx_simcall_t simcall, sg_host_t vm)
 205 {
 206   SIMIX_vm_shutdown(vm, simcall->issuer);
 207 }