src/simix/smx_vm.cpp

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