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 Function to suspend a SIMIX VM host. This function stops the execution of the
  97  * VM. All the processes on this VM will pause. The state of the VM is
  98  * preserved on memory. We can later resume it again.
  99  *
 100  * @param vm the vm host to suspend (a sg_host_t)
 101  */
 102 void SIMIX_vm_suspend(sg_host_t vm, smx_actor_t issuer)
 103 {
 104   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_RUNNING)
 105     THROWF(vm_error, 0, "VM(%s) is not running", vm->name().c_str());
 106
 107   XBT_DEBUG("suspend VM(%s), where %d processes exist", vm->name().c_str(), xbt_swag_size(sg_host_simix(vm)->process_list));
 108
 109   /* jump to vm_ws_suspend. The state will be set. */
 110   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->suspend();
 111
 112   smx_actor_t smx_process, smx_process_safe;
 113   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
 114     XBT_DEBUG("suspend %s", smx_process->name.c_str());
 115     SIMIX_process_suspend(smx_process, issuer);
 116   }
 117
 118   XBT_DEBUG("suspend all processes on the VM done done");
 119 }
 120
 121 void simcall_HANDLER_vm_suspend(smx_simcall_t simcall, sg_host_t vm)
 122 {
 123   xbt_assert(simcall->issuer->host != vm, "cannot suspend the VM where I run");
 124
 125   SIMIX_vm_suspend(vm, simcall->issuer);
 126
 127   XBT_DEBUG("simcall_HANDLER_vm_suspend done");
 128 }
 129
 130
 131 /**
 132  * @brief Function to resume a SIMIX VM host. This function restart the execution of the
 133  * VM. All the processes on this VM will run again.
 134  *
 135  * @param vm the vm host to resume (a sg_host_t)
 136  */
 137 void SIMIX_vm_resume(sg_host_t vm)
 138 {
 139   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_SUSPENDED)
 140     THROWF(vm_error, 0, "VM(%s) was not suspended", vm->name().c_str());
 141
 142   XBT_DEBUG("resume VM(%s), where %d processes exist",
 143       vm->name().c_str(), xbt_swag_size(sg_host_simix(vm)->process_list));
 144
 145   /* jump to vm_ws_resume() */
 146   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->resume();
 147
 148   smx_actor_t smx_process, smx_process_safe;
 149   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
 150     XBT_DEBUG("resume %s", smx_process->name.c_str());
 151     SIMIX_process_resume(smx_process);
 152   }
 153 }
 154
 155 /**
 156  * @brief Function to save a SIMIX VM host.
 157  * This function is the same as vm_suspend, but the state of the VM is saved to the disk, and not preserved on memory.
 158  * We can later restore it again.
 159  *
 160  * @param vm the vm host to save (a sg_host_t)
 161  */
 162 void SIMIX_vm_save(sg_host_t vm, smx_actor_t issuer)
 163 {
 164   const char *name = sg_host_get_name(vm);
 165
 166   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_RUNNING)
 167     THROWF(vm_error, 0, "VM(%s) is not running", name);
 168
 169   XBT_DEBUG("save VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(vm)->process_list));
 170
 171   /* jump to vm_ws_save() */
 172   static_cast<simgrid::s4u::VirtualMachine*>(vm)->pimpl_vm_->save();
 173
 174   smx_actor_t smx_process, smx_process_safe;
 175   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
 176     XBT_DEBUG("suspend %s", smx_process->name.c_str());
 177     SIMIX_process_suspend(smx_process, issuer);
 178   }
 179 }
 180
 181 void simcall_HANDLER_vm_save(smx_simcall_t simcall, sg_host_t vm)
 182 {
 183   SIMIX_vm_save(vm, simcall->issuer);
 184 }
 185
 186 /**
 187  * @brief Function to shutdown a SIMIX VM host. This function powers off the
 188  * VM. All the processes on this VM will be killed. But, the state of the VM is
 189  * preserved on memory. We can later start it again.
 190  *
 191  * @param vm the VM to shutdown (a sg_host_t)
 192  */
 193 void SIMIX_vm_shutdown(sg_host_t vm, smx_actor_t issuer)
 194 {
 195   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_RUNNING)
 196     THROWF(vm_error, 0, "VM(%s) is not running", vm->name().c_str());
 197
 198   XBT_DEBUG("shutdown VM %s, that contains %d processes",
 199       vm->name().c_str(),xbt_swag_size(sg_host_simix(vm)->process_list));
 200
 201   smx_actor_t smx_process, smx_process_safe;
 202   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
 203     XBT_DEBUG("kill %s", smx_process->name.c_str());
 204     SIMIX_process_kill(smx_process, issuer);
 205   }
 206
 207   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
 208   static_cast<simgrid::surf::VirtualMachineImpl*>(vm->pimpl_)->setState(SURF_VM_STATE_CREATED);
 209 }
 210
 211 void simcall_HANDLER_vm_shutdown(smx_simcall_t simcall, sg_host_t vm)
 212 {
 213   SIMIX_vm_shutdown(vm, simcall->issuer);
 214 }