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/surf/HostImpl.hpp"
  10 #include "src/surf/VirtualMachineImpl.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 = surf_vm_get_pm(vm);
  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   surf_vm_migrate(vm, dst_pm);
  93 }
  94
  95 /**
  96  * @brief Encompassing simcall to prevent the removal of the src or the dst node at the end of a VM migration
  97  *  The simcall actually invokes the following calls:
  98  *     simcall_vm_migrate(vm, dst_pm);
  99  *     simcall_vm_resume(vm);
 100  *
 101  * It is called at the end of the migration_rx_fun function from msg/msg_vm.c
 102  *
 103  * @param vm VM to migrate
 104  * @param src_pm  Source physical host
 105  * @param dst_pmt Destination physical host
 106  */
 107 void SIMIX_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst_pm)
 108 {
 109   /* Update the vm location */
 110   SIMIX_vm_migrate(vm, dst_pm);
 111
 112   /* Resume the VM */
 113   smx_actor_t self = SIMIX_process_self();
 114   SIMIX_vm_resume(vm, self);
 115 }
 116
 117 /**
 118  * @brief Function to get the physical host of the given SIMIX VM host.
 119  *
 120  * @param host the vm host to get_phys_host (a sg_host_t)
 121  */
 122 void *SIMIX_vm_get_pm(sg_host_t host)
 123 {
 124   return surf_vm_get_pm(host);
 125 }
 126
 127 /**
 128  * @brief Function to set the CPU bound of the given SIMIX VM host.
 129  *
 130  * @param host the vm host (a sg_host_t)
 131  * @param bound bound (a double)
 132  */
 133 void SIMIX_vm_set_bound(sg_host_t vm, double bound)
 134 {
 135   surf_vm_set_bound(vm, bound);
 136 }
 137
 138 /**
 139  * @brief Function to suspend a SIMIX VM host. This function stops the execution of the
 140  * VM. All the processes on this VM will pause. The state of the VM is
 141  * preserved on memory. We can later resume it again.
 142  *
 143  * @param vm the vm host to suspend (a sg_host_t)
 144  */
 145 void SIMIX_vm_suspend(sg_host_t vm, smx_actor_t issuer)
 146 {
 147   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_RUNNING)
 148     THROWF(vm_error, 0, "VM(%s) is not running", vm->name().c_str());
 149
 150   XBT_DEBUG("suspend VM(%s), where %d processes exist", vm->name().c_str(), xbt_swag_size(sg_host_simix(vm)->process_list));
 151
 152   /* jump to vm_ws_suspend. The state will be set. */
 153   surf_vm_suspend(vm);
 154
 155   smx_actor_t smx_process, smx_process_safe;
 156   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
 157     XBT_DEBUG("suspend %s", smx_process->name.c_str());
 158     SIMIX_process_suspend(smx_process, issuer);
 159   }
 160
 161   XBT_DEBUG("suspend all processes on the VM done done");
 162 }
 163
 164 void simcall_HANDLER_vm_suspend(smx_simcall_t simcall, sg_host_t vm)
 165 {
 166   xbt_assert(simcall->issuer->host != vm, "cannot suspend the VM where I run");
 167
 168   SIMIX_vm_suspend(vm, simcall->issuer);
 169
 170   XBT_DEBUG("simcall_HANDLER_vm_suspend done");
 171 }
 172
 173
 174 /**
 175  * @brief Function to resume a SIMIX VM host. This function restart the execution of the
 176  * VM. All the processes on this VM will run again.
 177  *
 178  * @param vm the vm host to resume (a sg_host_t)
 179  */
 180 void SIMIX_vm_resume(sg_host_t vm, smx_actor_t issuer)
 181 {
 182   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_SUSPENDED)
 183     THROWF(vm_error, 0, "VM(%s) was not suspended", vm->name().c_str());
 184
 185   XBT_DEBUG("resume VM(%s), where %d processes exist",
 186       vm->name().c_str(), xbt_swag_size(sg_host_simix(vm)->process_list));
 187
 188   /* jump to vm_ws_resume() */
 189   surf_vm_resume(vm);
 190
 191   smx_actor_t smx_process, smx_process_safe;
 192   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
 193     XBT_DEBUG("resume %s", smx_process->name.c_str());
 194     SIMIX_process_resume(smx_process, issuer);
 195   }
 196 }
 197
 198 void simcall_HANDLER_vm_resume(smx_simcall_t simcall, sg_host_t vm)
 199 {
 200   SIMIX_vm_resume(vm, simcall->issuer);
 201 }
 202
 203
 204 /**
 205  * @brief Function to save a SIMIX VM host.
 206  * This function is the same as vm_suspend, but the state of the VM is saved to the disk, and not preserved on memory.
 207  * We can later restore it again.
 208  *
 209  * @param vm the vm host to save (a sg_host_t)
 210  */
 211 void SIMIX_vm_save(sg_host_t vm, smx_actor_t issuer)
 212 {
 213   const char *name = sg_host_get_name(vm);
 214
 215   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_RUNNING)
 216     THROWF(vm_error, 0, "VM(%s) is not running", name);
 217
 218   XBT_DEBUG("save VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(vm)->process_list));
 219
 220   /* jump to vm_ws_save() */
 221   surf_vm_save(vm);
 222
 223   smx_actor_t smx_process, smx_process_safe;
 224   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
 225     XBT_DEBUG("suspend %s", smx_process->name.c_str());
 226     SIMIX_process_suspend(smx_process, issuer);
 227   }
 228 }
 229
 230 void simcall_HANDLER_vm_save(smx_simcall_t simcall, sg_host_t vm)
 231 {
 232   SIMIX_vm_save(vm, simcall->issuer);
 233 }
 234
 235
 236 /**
 237  * @brief Function to restore a SIMIX VM host. This function restart the execution of the
 238  * VM. All the processes on this VM will run again.
 239  *
 240  * @param vm the vm host to restore (a sg_host_t)
 241  */
 242 void SIMIX_vm_restore(sg_host_t vm, smx_actor_t issuer)
 243 {
 244   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_SAVED)
 245     THROWF(vm_error, 0, "VM(%s) was not saved", vm->name().c_str());
 246
 247   XBT_DEBUG("restore VM(%s), where %d processes exist",
 248       vm->name().c_str(), xbt_swag_size(sg_host_simix(vm)->process_list));
 249
 250   /* jump to vm_ws_restore() */
 251   surf_vm_resume(vm);
 252
 253   smx_actor_t smx_process, smx_process_safe;
 254   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
 255     XBT_DEBUG("resume %s", smx_process->name.c_str());
 256     SIMIX_process_resume(smx_process, issuer);
 257   }
 258 }
 259
 260 void simcall_HANDLER_vm_restore(smx_simcall_t simcall, sg_host_t vm)
 261 {
 262   SIMIX_vm_restore(vm, simcall->issuer);
 263 }
 264
 265
 266 /**
 267  * @brief Function to shutdown a SIMIX VM host. This function powers off the
 268  * VM. All the processes on this VM will be killed. But, the state of the VM is
 269  * preserved on memory. We can later start it again.
 270  *
 271  * @param vm the VM to shutdown (a sg_host_t)
 272  */
 273 void SIMIX_vm_shutdown(sg_host_t vm, smx_actor_t issuer)
 274 {
 275   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_RUNNING)
 276     THROWF(vm_error, 0, "VM(%s) is not running", vm->name().c_str());
 277
 278   XBT_DEBUG("shutdown VM %s, that contains %d processes",
 279       vm->name().c_str(),xbt_swag_size(sg_host_simix(vm)->process_list));
 280
 281   smx_actor_t smx_process, smx_process_safe;
 282   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
 283     XBT_DEBUG("kill %s", smx_process->name.c_str());
 284     SIMIX_process_kill(smx_process, issuer);
 285   }
 286
 287   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
 288   static_cast<simgrid::surf::VirtualMachineImpl*>(vm->pimpl_)->setState(SURF_VM_STATE_CREATED);
 289 }
 290
 291 void simcall_HANDLER_vm_shutdown(smx_simcall_t simcall, sg_host_t vm)
 292 {
 293   SIMIX_vm_shutdown(vm, simcall->issuer);
 294 }
 295
 296 /**
 297  * @brief Function to destroy a SIMIX VM host.
 298  *
 299  * @param vm the vm host to destroy (a sg_host_t)
 300  */
 301 void SIMIX_vm_destroy(sg_host_t vm)
 302 {
 303   /* this code basically performs a similar thing like SIMIX_host_destroy() */
 304   XBT_DEBUG("destroy %s", vm->name().c_str());
 305
 306   /* FIXME: this is really strange that everything fails if the next line is removed.
 307    * This is as if we shared these data with the PM, which definitely should not be the case...
 308    *
 309    * We need to test that suspending a VM does not suspends the processes running on its PM, for example.
 310    * Or we need to simplify this code enough to make it actually readable (but this sounds harder than testing)
 311    */
 312   vm->extension_set<simgrid::simix::Host>(nullptr);
 313
 314   /* Don't free these things twice: they are the ones of my physical host */
 315   vm->pimpl_cpu = nullptr;
 316   vm->pimpl_netcard = nullptr;
 317
 318   vm->destroy();
 319 }