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_set_affinity(vm, src_pm, 0);
 123  *     simcall_vm_migrate(vm, dst_pm);
 124  *     simcall_vm_resume(vm);
 125  *
 126  * It is called at the end of the migration_rx_fun function from msg/msg_vm.c
 127  *
 128  * @param vm VM to migrate
 129  * @param src_pm  Source physical host
 130  * @param dst_pmt Destination physical host
 131  */
 132 void SIMIX_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst_pm)
 133 {
 134   /* deinstall the current affinity setting for the CPU */
 135   SIMIX_vm_set_affinity(vm, src_pm, 0);
 136
 137   /* Update the vm location */
 138   SIMIX_vm_migrate(vm, dst_pm);
 139
 140   /* Resume the VM */
 141   smx_process_t self = SIMIX_process_self();
 142   SIMIX_vm_resume(vm, self->simcall.issuer);
 143 }
 144
 145 /**
 146  * @brief Function to get the physical host of the given SIMIX VM host.
 147  *
 148  * @param host the vm host to get_phys_host (a sg_host_t)
 149  */
 150 void *SIMIX_vm_get_pm(sg_host_t ind_vm)
 151 {
 152   /* jump to vm_ws_get_pm(). this will return the vm name. */
 153   return surf_vm_get_pm(ind_vm);
 154 }
 155
 156 /**
 157  * @brief Function to set the CPU bound of the given SIMIX VM host.
 158  *
 159  * @param host the vm host (a sg_host_t)
 160  * @param bound bound (a double)
 161  */
 162 void SIMIX_vm_set_bound(sg_host_t ind_vm, double bound)
 163 {
 164   /* jump to vm_ws_set_vm_bound(). */
 165   surf_vm_set_bound(ind_vm, bound);
 166 }
 167
 168 /**
 169  * @brief Function to set the CPU affinity of the given SIMIX VM host.
 170  *
 171  * @param host the vm host (a sg_host_t)
 172  * @param host the pm host (a sg_host_t)
 173  * @param mask affinity mask (a unsigned long)
 174  */
 175 void SIMIX_vm_set_affinity(sg_host_t ind_vm, sg_host_t ind_pm, unsigned long mask)
 176 {
 177   /* make sure this at the MSG layer. */
 178   xbt_assert(SIMIX_vm_get_pm(ind_vm) == ind_pm);
 179
 180   /* jump to vm_ws_set_vm_affinity(). */
 181   surf_vm_set_affinity(ind_vm, ind_pm, mask);
 182 }
 183
 184
 185 /**
 186  * @brief Function to suspend a SIMIX VM host. This function stops the execution of the
 187  * VM. All the processes on this VM will pause. The state of the VM is
 188  * preserved on memory. We can later resume it again.
 189  *
 190  * @param host the vm host to suspend (a sg_host_t)
 191  */
 192 void SIMIX_vm_suspend(sg_host_t ind_vm, smx_process_t issuer)
 193 {
 194   const char *name = sg_host_get_name(ind_vm);
 195
 196   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
 197     THROWF(vm_error, 0, "VM(%s) is not running", name);
 198
 199   XBT_DEBUG("suspend VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(ind_vm)->process_list));
 200
 201   /* jump to vm_ws_suspend. The state will be set. */
 202   surf_vm_suspend(ind_vm);
 203
 204   smx_process_t smx_process, smx_process_safe;
 205   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
 206     XBT_DEBUG("suspend %s", smx_process->name.c_str());
 207     SIMIX_process_suspend(smx_process, issuer);
 208   }
 209
 210   XBT_DEBUG("suspend all processes on the VM done done");
 211 }
 212
 213 void simcall_HANDLER_vm_suspend(smx_simcall_t simcall, sg_host_t ind_vm)
 214 {
 215   if (simcall->issuer->host == ind_vm) {
 216     XBT_ERROR("cannot suspend the VM where I run");
 217     DIE_IMPOSSIBLE;
 218   }
 219
 220   SIMIX_vm_suspend(ind_vm, simcall->issuer);
 221
 222   XBT_DEBUG("simcall_HANDLER_vm_suspend done");
 223 }
 224
 225
 226 /**
 227  * @brief Function to resume a SIMIX VM host. This function restart the execution of the
 228  * VM. All the processes on this VM will run again.
 229  *
 230  * @param host the vm host to resume (a sg_host_t)
 231  */
 232 void SIMIX_vm_resume(sg_host_t ind_vm, smx_process_t issuer)
 233 {
 234   const char *name = sg_host_get_name(ind_vm);
 235
 236   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_SUSPENDED)
 237     THROWF(vm_error, 0, "VM(%s) was not suspended", name);
 238
 239   XBT_DEBUG("resume VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(ind_vm)->process_list));
 240
 241   /* jump to vm_ws_resume() */
 242   surf_vm_resume(ind_vm);
 243
 244   smx_process_t smx_process, smx_process_safe;
 245   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
 246     XBT_DEBUG("resume %s", smx_process->name.c_str());
 247     SIMIX_process_resume(smx_process, issuer);
 248   }
 249 }
 250
 251 void simcall_HANDLER_vm_resume(smx_simcall_t simcall, sg_host_t ind_vm)
 252 {
 253   SIMIX_vm_resume(ind_vm, simcall->issuer);
 254 }
 255
 256
 257 /**
 258  * @brief Function to save a SIMIX VM host.
 259  * This function is the same as vm_suspend, but the state of the VM is saved to the disk, and not preserved on memory.
 260  * We can later restore it again.
 261  *
 262  * @param host the vm host to save (a sg_host_t)
 263  */
 264 void SIMIX_vm_save(sg_host_t ind_vm, smx_process_t issuer)
 265 {
 266   const char *name = sg_host_get_name(ind_vm);
 267
 268   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
 269     THROWF(vm_error, 0, "VM(%s) is not running", name);
 270
 271
 272   XBT_DEBUG("save VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(ind_vm)->process_list));
 273
 274   /* jump to vm_ws_save() */
 275   surf_vm_save(ind_vm);
 276
 277   smx_process_t smx_process, smx_process_safe;
 278   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
 279     XBT_DEBUG("suspend %s", smx_process->name.c_str());
 280     SIMIX_process_suspend(smx_process, issuer);
 281   }
 282 }
 283
 284 void simcall_HANDLER_vm_save(smx_simcall_t simcall, sg_host_t ind_vm)
 285 {
 286   SIMIX_vm_save(ind_vm, simcall->issuer);
 287 }
 288
 289
 290 /**
 291  * @brief Function to restore a SIMIX VM host. This function restart the execution of the
 292  * VM. All the processes on this VM will run again.
 293  *
 294  * @param host the vm host to restore (a sg_host_t)
 295  */
 296 void SIMIX_vm_restore(sg_host_t ind_vm, smx_process_t issuer)
 297 {
 298   const char *name = sg_host_get_name(ind_vm);
 299
 300   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_SAVED)
 301     THROWF(vm_error, 0, "VM(%s) was not saved", name);
 302
 303   XBT_DEBUG("restore VM(%s), where %d processes exist", name, xbt_swag_size(sg_host_simix(ind_vm)->process_list));
 304
 305   /* jump to vm_ws_restore() */
 306   surf_vm_resume(ind_vm);
 307
 308   smx_process_t smx_process, smx_process_safe;
 309   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
 310     XBT_DEBUG("resume %s", smx_process->name.c_str());
 311     SIMIX_process_resume(smx_process, issuer);
 312   }
 313 }
 314
 315 void simcall_HANDLER_vm_restore(smx_simcall_t simcall, sg_host_t ind_vm)
 316 {
 317   SIMIX_vm_restore(ind_vm, simcall->issuer);
 318 }
 319
 320
 321 /**
 322  * @brief Function to shutdown a SIMIX VM host. This function powers off the
 323  * VM. All the processes on this VM will be killed. But, the state of the VM is
 324  * preserved on memory. We can later start it again.
 325  *
 326  * @param host the vm host to shutdown (a sg_host_t)
 327  */
 328 void SIMIX_vm_shutdown(sg_host_t ind_vm, smx_process_t issuer)
 329 {
 330   const char *name = sg_host_get_name(ind_vm);
 331
 332   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
 333     THROWF(vm_error, 0, "VM(%s) is not running", name);
 334
 335   XBT_DEBUG("shutdown %s", name);
 336   XBT_DEBUG("%d processes in the VM", xbt_swag_size(sg_host_simix(ind_vm)->process_list));
 337
 338   smx_process_t smx_process, smx_process_safe;
 339   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
 340     XBT_DEBUG("kill %s", smx_process->name.c_str());
 341     SIMIX_process_kill(smx_process, issuer);
 342   }
 343
 344   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
 345   static_cast<simgrid::surf::VirtualMachine*>(
 346     ind_vm->extension<simgrid::surf::HostImpl>()
 347   )->setState(SURF_VM_STATE_CREATED);
 348 }
 349
 350 void simcall_HANDLER_vm_shutdown(smx_simcall_t simcall, sg_host_t ind_vm)
 351 {
 352   SIMIX_vm_shutdown(ind_vm, simcall->issuer);
 353 }
 354
 355
 356 /**
 357  * @brief Function to destroy a SIMIX VM host.
 358  *
 359  * @param vm the vm host to destroy (a sg_host_t)
 360  */
 361 void SIMIX_vm_destroy(sg_host_t vm)
 362 {
 363   /* this code basically performs a similar thing like SIMIX_host_destroy() */
 364
 365   const char *hostname = sg_host_get_name(vm);
 366
 367   XBT_DEBUG("destroy %s", hostname);
 368
 369   /* this will call the registered callback function, i.e., SIMIX_host_destroy().  */
 370   sg_host_simix_destroy(vm);
 371
 372   /* jump to vm_ws_destroy(). The surf level resource will be freed. */
 373   surf_vm_destroy(vm);
 374 }