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 "smx_private.h"
   7 #include "mc/mc.h"
   8 #include "src/surf/virtual_machine.hpp"
   9 #include "src/surf/HostImpl.hpp"
  10
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_vm, simix, "Logging specific to SIMIX Virtual Machines");
  12
  13 /* works for VMs and PMs */
  14 static long host_get_ramsize(sg_host_t vm, int *overcommit)
  15 {
  16   s_vm_params_t params;
  17   vm->pimpl_->getParams(&params);
  18
  19   if (overcommit)
  20     *overcommit = params.overcommit;
  21
  22   return params.ramsize;
  23 }
  24
  25 /* **** start a VM **** */
  26 static int __can_be_started(sg_host_t vm)
  27 {
  28   sg_host_t pm = surf_vm_get_pm(vm);
  29
  30   int pm_overcommit = 0;
  31   long pm_ramsize = host_get_ramsize(pm, &pm_overcommit);
  32   long vm_ramsize = host_get_ramsize(vm, nullptr);
  33
  34   if (!pm_ramsize) {
  35     /* We assume users do not want to care about ramsize. */
  36     return 1;
  37   }
  38
  39   if (pm_overcommit) {
  40     XBT_VERB("%s allows memory overcommit.", sg_host_get_name(pm));
  41     return 1;
  42   }
  43
  44   long total_ramsize_of_vms = 0;
  45   xbt_dynar_t dyn_vms       = pm->pimpl_->getVms();
  46   {
  47     unsigned int cursor = 0;
  48     sg_host_t another_vm;
  49     xbt_dynar_foreach(dyn_vms, cursor, another_vm) {
  50       long another_vm_ramsize = host_get_ramsize(vm, nullptr);
  51       total_ramsize_of_vms += another_vm_ramsize;
  52     }
  53   }
  54
  55   if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
  56     XBT_WARN("cannnot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
  57         sg_host_get_name(vm), sg_host_get_name(pm),
  58         vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
  59     xbt_dynar_free(&dyn_vms);
  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::surf::VirtualMachine*>(vm->pimpl_)->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 e_surf_vm_state_t SIMIX_vm_get_state(sg_host_t vm)
  76 {
  77   return static_cast<simgrid::surf::VirtualMachine*>(vm->pimpl_)->getState();
  78 }
  79
  80 /**
  81  * @brief Function to migrate a SIMIX VM host.
  82  *
  83  * @param host the vm host to migrate (a sg_host_t)
  84  */
  85 void SIMIX_vm_migrate(sg_host_t vm, sg_host_t dst_pm)
  86 {
  87   /* precopy migration makes the VM temporally paused */
  88   xbt_assert(SIMIX_vm_get_state(vm) == SURF_VM_STATE_SUSPENDED);
  89
  90   /* jump to vm_ws_xigrate(). this will update the vm location. */
  91   surf_vm_migrate(vm, dst_pm);
  92 }
  93
  94 /**
  95  * @brief Encompassing simcall to prevent the removal of the src or the dst node at the end of a VM migration
  96  *  The simcall actually invokes the following calls:
  97  *     simcall_vm_migrate(vm, dst_pm);
  98  *     simcall_vm_resume(vm);
  99  *
 100  * It is called at the end of the migration_rx_fun function from msg/msg_vm.c
 101  *
 102  * @param vm VM to migrate
 103  * @param src_pm  Source physical host
 104  * @param dst_pmt Destination physical host
 105  */
 106 void SIMIX_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst_pm)
 107 {
 108   /* Update the vm location */
 109   SIMIX_vm_migrate(vm, dst_pm);
 110
 111   /* Resume the VM */
 112   smx_actor_t self = SIMIX_process_self();
 113   SIMIX_vm_resume(vm, self);
 114 }
 115
 116 /**
 117  * @brief Function to get the physical host of the given SIMIX VM host.
 118  *
 119  * @param host the vm host to get_phys_host (a sg_host_t)
 120  */
 121 void *SIMIX_vm_get_pm(sg_host_t host)
 122 {
 123   return surf_vm_get_pm(host);
 124 }
 125
 126 /**
 127  * @brief Function to set the CPU bound of the given SIMIX VM host.
 128  *
 129  * @param host the vm host (a sg_host_t)
 130  * @param bound bound (a double)
 131  */
 132 void SIMIX_vm_set_bound(sg_host_t vm, double bound)
 133 {
 134   surf_vm_set_bound(vm, bound);
 135 }
 136
 137 /**
 138  * @brief Function to suspend a SIMIX VM host. This function stops the execution of the
 139  * VM. All the processes on this VM will pause. The state of the VM is
 140  * preserved on memory. We can later resume it again.
 141  *
 142  * @param vm the vm host to suspend (a sg_host_t)
 143  */
 144 void SIMIX_vm_suspend(sg_host_t vm, smx_actor_t issuer)
 145 {
 146   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_RUNNING)
 147     THROWF(vm_error, 0, "VM(%s) is not running", vm->name().c_str());
 148
 149   XBT_DEBUG("suspend VM(%s), where %d processes exist", vm->name().c_str(), xbt_swag_size(sg_host_simix(vm)->process_list));
 150
 151   /* jump to vm_ws_suspend. The state will be set. */
 152   surf_vm_suspend(vm);
 153
 154   smx_actor_t smx_process, smx_process_safe;
 155   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
 156     XBT_DEBUG("suspend %s", smx_process->name.c_str());
 157     SIMIX_process_suspend(smx_process, issuer);
 158   }
 159
 160   XBT_DEBUG("suspend all processes on the VM done done");
 161 }
 162
 163 void simcall_HANDLER_vm_suspend(smx_simcall_t simcall, sg_host_t vm)
 164 {
 165   xbt_assert(simcall->issuer->host != vm, "cannot suspend the VM where I run");
 166
 167   SIMIX_vm_suspend(vm, simcall->issuer);
 168
 169   XBT_DEBUG("simcall_HANDLER_vm_suspend done");
 170 }
 171
 172
 173 /**
 174  * @brief Function to resume a SIMIX VM host. This function restart the execution of the
 175  * VM. All the processes on this VM will run again.
 176  *
 177  * @param vm the vm host to resume (a sg_host_t)
 178  */
 179 void SIMIX_vm_resume(sg_host_t vm, smx_actor_t issuer)
 180 {
 181   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_SUSPENDED)
 182     THROWF(vm_error, 0, "VM(%s) was not suspended", vm->name().c_str());
 183
 184   XBT_DEBUG("resume VM(%s), where %d processes exist",
 185       vm->name().c_str(), xbt_swag_size(sg_host_simix(vm)->process_list));
 186
 187   /* jump to vm_ws_resume() */
 188   surf_vm_resume(vm);
 189
 190   smx_actor_t smx_process, smx_process_safe;
 191   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
 192     XBT_DEBUG("resume %s", smx_process->name.c_str());
 193     SIMIX_process_resume(smx_process, issuer);
 194   }
 195 }
 196
 197 void simcall_HANDLER_vm_resume(smx_simcall_t simcall, sg_host_t vm)
 198 {
 199   SIMIX_vm_resume(vm, simcall->issuer);
 200 }
 201
 202
 203 /**
 204  * @brief Function to save a SIMIX VM host.
 205  * This function is the same as vm_suspend, but the state of the VM is saved to the disk, and not preserved on memory.
 206  * We can later restore it again.
 207  *
 208  * @param vm the vm host to save (a sg_host_t)
 209  */
 210 void SIMIX_vm_save(sg_host_t vm, smx_actor_t issuer)
 211 {
 212   const char *name = sg_host_get_name(vm);
 213
 214   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_RUNNING)
 215     THROWF(vm_error, 0, "VM(%s) is not running", name);
 216
 217   XBT_DEBUG("save VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(vm)->process_list));
 218
 219   /* jump to vm_ws_save() */
 220   surf_vm_save(vm);
 221
 222   smx_actor_t smx_process, smx_process_safe;
 223   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
 224     XBT_DEBUG("suspend %s", smx_process->name.c_str());
 225     SIMIX_process_suspend(smx_process, issuer);
 226   }
 227 }
 228
 229 void simcall_HANDLER_vm_save(smx_simcall_t simcall, sg_host_t vm)
 230 {
 231   SIMIX_vm_save(vm, simcall->issuer);
 232 }
 233
 234
 235 /**
 236  * @brief Function to restore a SIMIX VM host. This function restart the execution of the
 237  * VM. All the processes on this VM will run again.
 238  *
 239  * @param vm the vm host to restore (a sg_host_t)
 240  */
 241 void SIMIX_vm_restore(sg_host_t vm, smx_actor_t issuer)
 242 {
 243   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_SAVED)
 244     THROWF(vm_error, 0, "VM(%s) was not saved", vm->name().c_str());
 245
 246   XBT_DEBUG("restore VM(%s), where %d processes exist",
 247       vm->name().c_str(), xbt_swag_size(sg_host_simix(vm)->process_list));
 248
 249   /* jump to vm_ws_restore() */
 250   surf_vm_resume(vm);
 251
 252   smx_actor_t smx_process, smx_process_safe;
 253   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
 254     XBT_DEBUG("resume %s", smx_process->name.c_str());
 255     SIMIX_process_resume(smx_process, issuer);
 256   }
 257 }
 258
 259 void simcall_HANDLER_vm_restore(smx_simcall_t simcall, sg_host_t vm)
 260 {
 261   SIMIX_vm_restore(vm, simcall->issuer);
 262 }
 263
 264
 265 /**
 266  * @brief Function to shutdown a SIMIX VM host. This function powers off the
 267  * VM. All the processes on this VM will be killed. But, the state of the VM is
 268  * preserved on memory. We can later start it again.
 269  *
 270  * @param vm the VM to shutdown (a sg_host_t)
 271  */
 272 void SIMIX_vm_shutdown(sg_host_t vm, smx_actor_t issuer)
 273 {
 274   if (SIMIX_vm_get_state(vm) != SURF_VM_STATE_RUNNING)
 275     THROWF(vm_error, 0, "VM(%s) is not running", vm->name().c_str());
 276
 277   XBT_DEBUG("shutdown VM %s, that contains %d processes",
 278       vm->name().c_str(),xbt_swag_size(sg_host_simix(vm)->process_list));
 279
 280   smx_actor_t smx_process, smx_process_safe;
 281   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(vm)->process_list) {
 282     XBT_DEBUG("kill %s", smx_process->name.c_str());
 283     SIMIX_process_kill(smx_process, issuer);
 284   }
 285
 286   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
 287   static_cast<simgrid::surf::VirtualMachine*>(vm->pimpl_)->setState(SURF_VM_STATE_CREATED);
 288 }
 289
 290 void simcall_HANDLER_vm_shutdown(smx_simcall_t simcall, sg_host_t vm)
 291 {
 292   SIMIX_vm_shutdown(vm, simcall->issuer);
 293 }
 294
 295 /**
 296  * @brief Function to destroy a SIMIX VM host.
 297  *
 298  * @param vm the vm host to destroy (a sg_host_t)
 299  */
 300 void SIMIX_vm_destroy(sg_host_t vm)
 301 {
 302   /* this code basically performs a similar thing like SIMIX_host_destroy() */
 303   XBT_DEBUG("destroy %s", vm->name().c_str());
 304
 305   /* FIXME: this is really strange that everything fails if the next line is removed.
 306    * This is as if we shared these data with the PM, which definitely should not be the case...
 307    *
 308    * We need to test that suspending a VM does not suspends the processes running on its PM, for example.
 309    * Or we need to simplify this code enough to make it actually readable (but this sounds harder than testing)
 310    */
 311   vm->extension_set<simgrid::simix::Host>(nullptr);
 312
 313   /* Don't free these things twice: they are the ones of my physical host */
 314   vm->pimpl_cpu = nullptr;
 315   vm->pimpl_netcard = nullptr;
 316
 317   vm->destroy();
 318 }