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 (vms)");
  12
  13 /* **** create a VM **** */
  14
  15 /**
  16  * @brief Internal function to create a SIMIX host.
  17  * @param name name of the host to create
  18  * @param data some user data (may be nullptr)
  19  */
  20 sg_host_t SIMIX_vm_create(const char *name, sg_host_t ind_phys_host)
  21 {
  22   /* Create surf associated resource */
  23   surf_vm_model_create(name, ind_phys_host);
  24   sg_host_t host = sg_host_by_name(name);
  25   SIMIX_host_create(host);
  26
  27   /* We will be able to register the VM to its physical host, so that we can promptly
  28    * retrieve the list VMs on the physical host. */
  29
  30   return host;
  31 }
  32
  33
  34 /* works for VMs and PMs */
  35 static long host_get_ramsize(sg_host_t vm, int *overcommit)
  36 {
  37   s_vm_params_t params;
  38   vm->extension<simgrid::surf::HostImpl>()->getParams(&params);
  39
  40   if (overcommit)
  41     *overcommit = params.overcommit;
  42
  43   return params.ramsize;
  44 }
  45
  46 /* **** start a VM **** */
  47 static int __can_be_started(sg_host_t vm)
  48 {
  49   sg_host_t pm = surf_vm_get_pm(vm);
  50
  51   int pm_overcommit = 0;
  52   long pm_ramsize = host_get_ramsize(pm, &pm_overcommit);
  53   long vm_ramsize = host_get_ramsize(vm, nullptr);
  54
  55   if (!pm_ramsize) {
  56     /* We assume users do not want to care about ramsize. */
  57     return 1;
  58   }
  59
  60   if (pm_overcommit) {
  61     XBT_VERB("%s allows memory overcommit.", sg_host_get_name(pm));
  62     return 1;
  63   }
  64
  65   long total_ramsize_of_vms = 0;
  66   xbt_dynar_t dyn_vms = pm->extension<simgrid::surf::HostImpl>()->getVms();
  67   {
  68     unsigned int cursor = 0;
  69     sg_host_t another_vm;
  70     xbt_dynar_foreach(dyn_vms, cursor, another_vm) {
  71       long another_vm_ramsize = host_get_ramsize(vm, nullptr);
  72       total_ramsize_of_vms += another_vm_ramsize;
  73     }
  74   }
  75
  76   if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
  77     XBT_WARN("cannnot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
  78         sg_host_get_name(vm), sg_host_get_name(pm),
  79         vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
  80     xbt_dynar_free(&dyn_vms);
  81     return 0;
  82   }
  83
  84   return 1;
  85 }
  86
  87 void SIMIX_vm_start(sg_host_t ind_vm)
  88 {
  89   if (__can_be_started(ind_vm))
  90     static_cast<simgrid::surf::VirtualMachine*>(
  91       ind_vm->extension<simgrid::surf::HostImpl>()
  92     )->setState(SURF_VM_STATE_RUNNING);
  93   else
  94     THROWF(vm_error, 0, "The VM %s cannot be started", sg_host_get_name(ind_vm));
  95 }
  96
  97
  98 e_surf_vm_state_t SIMIX_vm_get_state(sg_host_t ind_vm)
  99 {
 100   return static_cast<simgrid::surf::VirtualMachine*>(
 101     ind_vm->extension<simgrid::surf::HostImpl>()
 102   )->getState();
 103 }
 104
 105 /**
 106  * @brief Function to migrate a SIMIX VM host.
 107  *
 108  * @param host the vm host to migrate (a sg_host_t)
 109  */
 110 void SIMIX_vm_migrate(sg_host_t ind_vm, sg_host_t ind_dst_pm)
 111 {
 112   /* precopy migration makes the VM temporally paused */
 113   xbt_assert(SIMIX_vm_get_state(ind_vm) == SURF_VM_STATE_SUSPENDED);
 114
 115   /* jump to vm_ws_xigrate(). this will update the vm location. */
 116   surf_vm_migrate(ind_vm, ind_dst_pm);
 117 }
 118
 119 /**
 120  * @brief Encompassing simcall to prevent the removal of the src or the dst node at the end of a VM migration
 121  *  The simcall actually invokes the following calls:
 122  *     simcall_vm_migrate(vm, dst_pm);
 123  *     simcall_vm_resume(vm);
 124  *
 125  * It is called at the end of the migration_rx_fun function from msg/msg_vm.c
 126  *
 127  * @param vm VM to migrate
 128  * @param src_pm  Source physical host
 129  * @param dst_pmt Destination physical host
 130  */
 131 void SIMIX_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst_pm)
 132 {
 133   /* Update the vm location */
 134   SIMIX_vm_migrate(vm, dst_pm);
 135
 136   /* Resume the VM */
 137   smx_actor_t self = SIMIX_process_self();
 138   SIMIX_vm_resume(vm, self->simcall.issuer);
 139 }
 140
 141 /**
 142  * @brief Function to get the physical host of the given SIMIX VM host.
 143  *
 144  * @param host the vm host to get_phys_host (a sg_host_t)
 145  */
 146 void *SIMIX_vm_get_pm(sg_host_t host)
 147 {
 148   return surf_vm_get_pm(host);
 149 }
 150
 151 /**
 152  * @brief Function to set the CPU bound of the given SIMIX VM host.
 153  *
 154  * @param host the vm host (a sg_host_t)
 155  * @param bound bound (a double)
 156  */
 157 void SIMIX_vm_set_bound(sg_host_t host, double bound)
 158 {
 159   surf_vm_set_bound(host, bound);
 160 }
 161
 162 /**
 163  * @brief Function to suspend a SIMIX VM host. This function stops the execution of the
 164  * VM. All the processes on this VM will pause. The state of the VM is
 165  * preserved on memory. We can later resume it again.
 166  *
 167  * @param host the vm host to suspend (a sg_host_t)
 168  */
 169 void SIMIX_vm_suspend(sg_host_t ind_vm, smx_actor_t issuer)
 170 {
 171   const char *name = sg_host_get_name(ind_vm);
 172
 173   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
 174     THROWF(vm_error, 0, "VM(%s) is not running", name);
 175
 176   XBT_DEBUG("suspend VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(ind_vm)->process_list));
 177
 178   /* jump to vm_ws_suspend. The state will be set. */
 179   surf_vm_suspend(ind_vm);
 180
 181   smx_actor_t smx_process, smx_process_safe;
 182   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
 183     XBT_DEBUG("suspend %s", smx_process->name.c_str());
 184     SIMIX_process_suspend(smx_process, issuer);
 185   }
 186
 187   XBT_DEBUG("suspend all processes on the VM done done");
 188 }
 189
 190 void simcall_HANDLER_vm_suspend(smx_simcall_t simcall, sg_host_t ind_vm)
 191 {
 192   if (simcall->issuer->host == ind_vm) {
 193     XBT_ERROR("cannot suspend the VM where I run");
 194     DIE_IMPOSSIBLE;
 195   }
 196
 197   SIMIX_vm_suspend(ind_vm, simcall->issuer);
 198
 199   XBT_DEBUG("simcall_HANDLER_vm_suspend done");
 200 }
 201
 202
 203 /**
 204  * @brief Function to resume a SIMIX VM host. This function restart the execution of the
 205  * VM. All the processes on this VM will run again.
 206  *
 207  * @param host the vm host to resume (a sg_host_t)
 208  */
 209 void SIMIX_vm_resume(sg_host_t ind_vm, smx_actor_t issuer)
 210 {
 211   const char *name = sg_host_get_name(ind_vm);
 212
 213   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_SUSPENDED)
 214     THROWF(vm_error, 0, "VM(%s) was not suspended", name);
 215
 216   XBT_DEBUG("resume VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(ind_vm)->process_list));
 217
 218   /* jump to vm_ws_resume() */
 219   surf_vm_resume(ind_vm);
 220
 221   smx_actor_t smx_process, smx_process_safe;
 222   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
 223     XBT_DEBUG("resume %s", smx_process->name.c_str());
 224     SIMIX_process_resume(smx_process, issuer);
 225   }
 226 }
 227
 228 void simcall_HANDLER_vm_resume(smx_simcall_t simcall, sg_host_t ind_vm)
 229 {
 230   SIMIX_vm_resume(ind_vm, simcall->issuer);
 231 }
 232
 233
 234 /**
 235  * @brief Function to save a SIMIX VM host.
 236  * This function is the same as vm_suspend, but the state of the VM is saved to the disk, and not preserved on memory.
 237  * We can later restore it again.
 238  *
 239  * @param host the vm host to save (a sg_host_t)
 240  */
 241 void SIMIX_vm_save(sg_host_t ind_vm, smx_actor_t issuer)
 242 {
 243   const char *name = sg_host_get_name(ind_vm);
 244
 245   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
 246     THROWF(vm_error, 0, "VM(%s) is not running", name);
 247
 248
 249   XBT_DEBUG("save VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(ind_vm)->process_list));
 250
 251   /* jump to vm_ws_save() */
 252   surf_vm_save(ind_vm);
 253
 254   smx_actor_t smx_process, smx_process_safe;
 255   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
 256     XBT_DEBUG("suspend %s", smx_process->name.c_str());
 257     SIMIX_process_suspend(smx_process, issuer);
 258   }
 259 }
 260
 261 void simcall_HANDLER_vm_save(smx_simcall_t simcall, sg_host_t ind_vm)
 262 {
 263   SIMIX_vm_save(ind_vm, simcall->issuer);
 264 }
 265
 266
 267 /**
 268  * @brief Function to restore a SIMIX VM host. This function restart the execution of the
 269  * VM. All the processes on this VM will run again.
 270  *
 271  * @param host the vm host to restore (a sg_host_t)
 272  */
 273 void SIMIX_vm_restore(sg_host_t ind_vm, smx_actor_t issuer)
 274 {
 275   const char *name = sg_host_get_name(ind_vm);
 276
 277   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_SAVED)
 278     THROWF(vm_error, 0, "VM(%s) was not saved", name);
 279
 280   XBT_DEBUG("restore VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(ind_vm)->process_list));
 281
 282   /* jump to vm_ws_restore() */
 283   surf_vm_resume(ind_vm);
 284
 285   smx_actor_t smx_process, smx_process_safe;
 286   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
 287     XBT_DEBUG("resume %s", smx_process->name.c_str());
 288     SIMIX_process_resume(smx_process, issuer);
 289   }
 290 }
 291
 292 void simcall_HANDLER_vm_restore(smx_simcall_t simcall, sg_host_t ind_vm)
 293 {
 294   SIMIX_vm_restore(ind_vm, simcall->issuer);
 295 }
 296
 297
 298 /**
 299  * @brief Function to shutdown a SIMIX VM host. This function powers off the
 300  * VM. All the processes on this VM will be killed. But, the state of the VM is
 301  * preserved on memory. We can later start it again.
 302  *
 303  * @param host the vm host to shutdown (a sg_host_t)
 304  */
 305 void SIMIX_vm_shutdown(sg_host_t ind_vm, smx_actor_t issuer)
 306 {
 307   const char *name = sg_host_get_name(ind_vm);
 308
 309   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
 310     THROWF(vm_error, 0, "VM(%s) is not running", name);
 311
 312   XBT_DEBUG("shutdown %s", name);
 313   XBT_DEBUG("%d processes in the VM", xbt_swag_size(sg_host_simix(ind_vm)->process_list));
 314
 315   smx_actor_t smx_process, smx_process_safe;
 316   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
 317     XBT_DEBUG("kill %s", smx_process->name.c_str());
 318     SIMIX_process_kill(smx_process, issuer);
 319   }
 320
 321   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
 322   static_cast<simgrid::surf::VirtualMachine*>(
 323     ind_vm->extension<simgrid::surf::HostImpl>()
 324   )->setState(SURF_VM_STATE_CREATED);
 325 }
 326
 327 void simcall_HANDLER_vm_shutdown(smx_simcall_t simcall, sg_host_t ind_vm)
 328 {
 329   SIMIX_vm_shutdown(ind_vm, simcall->issuer);
 330 }
 331
 332
 333 /**
 334  * @brief Function to destroy a SIMIX VM host.
 335  *
 336  * @param vm the vm host to destroy (a sg_host_t)
 337  */
 338 void SIMIX_vm_destroy(sg_host_t vm)
 339 {
 340   /* this code basically performs a similar thing like SIMIX_host_destroy() */
 341
 342   const char *hostname = sg_host_get_name(vm);
 343
 344   XBT_DEBUG("destroy %s", hostname);
 345
 346   /* this will call the registered callback function, i.e., SIMIX_host_destroy().  */
 347   sg_host_simix_destroy(vm);
 348
 349   /* jump to vm_ws_destroy(). The surf level resource will be freed. */
 350   surf_vm_destroy(vm);
 351 }