src/simix/smx_vm.c

   1 /* Copyright (c) 2007-2014. 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
  13 //If you need to log some stuffs, just uncomment these two lines and uses XBT_DEBUG for instance
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_vm, simix, "Logging specific to SIMIX (vms)");
  15
  16 /* **** create a VM **** */
  17
  18 /**
  19  * \brief Internal function to create a SIMIX host.
  20  * \param name name of the host to create
  21  * \param data some user data (may be NULL)
  22  */
  23 smx_host_t SIMIX_vm_create(const char *name, smx_host_t ind_phys_host)
  24 {
  25   /* Create surf associated resource */
  26   surf_vm_workstation_model_create(name, ind_phys_host);
  27
  28   smx_host_t smx_host = SIMIX_host_create(name, ind_phys_host, NULL);
  29
  30   /* We will be able to register the VM to its physical host, so that we can promptly
  31    * retrieve the list VMs on the physical host. */
  32
  33   return smx_host;
  34 }
  35
  36
  37 /* works for VMs and PMs */
  38 static long host_get_ramsize(smx_host_t vm, int *overcommit)
  39 {
  40   s_ws_params_t params;
  41   surf_workstation_get_params(vm, &params);
  42
  43   if (overcommit)
  44     *overcommit = params.overcommit;
  45
  46   return params.ramsize;
  47 }
  48
  49 /* **** start a VM **** */
  50 static int __can_be_started(smx_host_t vm)
  51 {
  52   smx_host_t pm = surf_vm_workstation_get_pm(vm);
  53
  54   int pm_overcommit = 0;
  55   long pm_ramsize = host_get_ramsize(pm, &pm_overcommit);
  56   long vm_ramsize = host_get_ramsize(vm, NULL);
  57
  58   if (!pm_ramsize) {
  59     /* We assume users do not want to care about ramsize. */
  60     return 1;
  61   }
  62
  63   if (pm_overcommit) {
  64     XBT_INFO("%s allows memory overcommit.", pm->key);
  65     return 1;
  66   }
  67
  68   long total_ramsize_of_vms = 0;
  69   xbt_dynar_t dyn_vms = surf_workstation_get_vms(pm);
  70   {
  71     unsigned int cursor = 0;
  72     smx_host_t another_vm;
  73     xbt_dynar_foreach(dyn_vms, cursor, another_vm) {
  74       long another_vm_ramsize = host_get_ramsize(vm, NULL);
  75       total_ramsize_of_vms += another_vm_ramsize;
  76     }
  77   }
  78
  79   if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
  80     XBT_WARN("cannnot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
  81         vm->key, pm->key, vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
  82     xbt_dynar_free(&dyn_vms);
  83     return 0;
  84   }
  85
  86   xbt_dynar_free(&dyn_vms);
  87         return 1;
  88 }
  89
  90 void SIMIX_vm_start(smx_host_t ind_vm)
  91 {
  92   if (__can_be_started(ind_vm))
  93     surf_resource_set_state(surf_workstation_resource_priv(ind_vm),
  94                             (int)SURF_VM_STATE_RUNNING);
  95   else
  96     THROWF(vm_error, 0, "The VM %s cannot be started", SIMIX_host_get_name(ind_vm));
  97 }
  98
  99
 100 int SIMIX_vm_get_state(smx_host_t ind_vm)
 101 {
 102   return surf_resource_get_state(surf_workstation_resource_priv(ind_vm));
 103 }
 104
 105 /**
 106  * \brief Function to migrate a SIMIX VM host.
 107  *
 108  * \param host the vm host to migrate (a smx_host_t)
 109  */
 110 void SIMIX_vm_migrate(smx_host_t ind_vm, smx_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_workstation_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(smx_host_t vm, smx_host_t src_pm, smx_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   SIMIX_vm_resume(vm);
 142 }
 143
 144 /**
 145  * \brief Function to get the physical host of the given SIMIX VM host.
 146  *
 147  * \param host the vm host to get_phys_host (a smx_host_t)
 148  */
 149 void *SIMIX_vm_get_pm(smx_host_t ind_vm)
 150 {
 151   /* jump to vm_ws_get_pm(). this will return the vm name. */
 152   return surf_vm_workstation_get_pm(ind_vm);
 153 }
 154
 155 /**
 156  * \brief Function to set the CPU bound of the given SIMIX VM host.
 157  *
 158  * \param host the vm host (a smx_host_t)
 159  * \param bound bound (a double)
 160  */
 161 void SIMIX_vm_set_bound(smx_host_t ind_vm, double bound)
 162 {
 163   /* jump to vm_ws_set_vm_bound(). */
 164   surf_vm_workstation_set_bound(ind_vm, bound);
 165 }
 166
 167 /**
 168  * \brief Function to set the CPU affinity of the given SIMIX VM host.
 169  *
 170  * \param host the vm host (a smx_host_t)
 171  * \param host the pm host (a smx_host_t)
 172  * \param mask affinity mask (a unsigned long)
 173  */
 174 void SIMIX_vm_set_affinity(smx_host_t ind_vm, smx_host_t ind_pm, unsigned long mask)
 175 {
 176   /* make sure this at the MSG layer. */
 177   xbt_assert(SIMIX_vm_get_pm(ind_vm) == ind_pm);
 178
 179   /* jump to vm_ws_set_vm_affinity(). */
 180   surf_vm_workstation_set_affinity(ind_vm, ind_pm, mask);
 181 }
 182
 183
 184 /**
 185  * \brief Function to suspend a SIMIX VM host. This function stops the execution of the
 186  * VM. All the processes on this VM will pause. The state of the VM is
 187  * preserved on memory. We can later resume it again.
 188  *
 189  * \param host the vm host to suspend (a smx_host_t)
 190  */
 191 void SIMIX_vm_suspend(smx_host_t ind_vm, smx_process_t issuer)
 192 {
 193   const char *name = SIMIX_host_get_name(ind_vm);
 194
 195   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
 196     THROWF(vm_error, 0, "VM(%s) is not running", name);
 197
 198   XBT_DEBUG("suspend VM(%s), where %d processes exist", name, xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
 199
 200   /* jump to vm_ws_suspend. The state will be set. */
 201   surf_vm_workstation_suspend(ind_vm);
 202
 203   smx_process_t smx_process, smx_process_safe;
 204   xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
 205     XBT_DEBUG("suspend %s", smx_process->name);
 206     SIMIX_process_suspend(smx_process, issuer);
 207   }
 208
 209   XBT_DEBUG("suspend all processes on the VM done done");
 210 }
 211
 212 void simcall_HANDLER_vm_suspend(smx_simcall_t simcall, smx_host_t ind_vm)
 213 {
 214   if (simcall->issuer->smx_host == ind_vm) {
 215     XBT_ERROR("cannot suspend the VM where I run");
 216     DIE_IMPOSSIBLE;
 217   }
 218
 219   SIMIX_vm_suspend(ind_vm, simcall->issuer);
 220
 221   XBT_DEBUG("simcall_HANDLER_vm_suspend done");
 222 }
 223
 224
 225 /**
 226  * \brief Function to resume a SIMIX VM host. This function restart the execution of the
 227  * VM. All the processes on this VM will run again.
 228  *
 229  * \param host the vm host to resume (a smx_host_t)
 230  */
 231 void SIMIX_vm_resume(smx_host_t ind_vm, smx_process_t issuer)
 232 {
 233   const char *name = SIMIX_host_get_name(ind_vm);
 234
 235   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_SUSPENDED)
 236     THROWF(vm_error, 0, "VM(%s) was not suspended", name);
 237
 238   XBT_DEBUG("resume VM(%s), where %d processes exist", name, xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
 239
 240   /* jump to vm_ws_resume() */
 241   surf_vm_workstation_resume(ind_vm);
 242
 243   smx_process_t smx_process, smx_process_safe;
 244   xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
 245     XBT_DEBUG("resume %s", smx_process->name);
 246     SIMIX_process_resume(smx_process, issuer);
 247   }
 248 }
 249
 250 void simcall_HANDLER_vm_resume(smx_simcall_t simcall, smx_host_t ind_vm)
 251 {
 252   SIMIX_vm_resume(ind_vm, simcall->issuer);
 253 }
 254
 255
 256 /**
 257  * \brief Function to save a SIMIX VM host.
 258  * This function is the same as vm_suspend, but the state of the VM is saved to the disk, and not preserved on memory.
 259  * We can later restore it again.
 260  *
 261  * \param host the vm host to save (a smx_host_t)
 262  */
 263 void SIMIX_vm_save(smx_host_t ind_vm, smx_process_t issuer)
 264 {
 265   const char *name = SIMIX_host_get_name(ind_vm);
 266
 267   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
 268     THROWF(vm_error, 0, "VM(%s) is not running", name);
 269
 270
 271   XBT_DEBUG("save VM(%s), where %d processes exist", name, xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
 272
 273   /* jump to vm_ws_save() */
 274   surf_vm_workstation_save(ind_vm);
 275
 276   smx_process_t smx_process, smx_process_safe;
 277   xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
 278     XBT_DEBUG("suspend %s", smx_process->name);
 279     SIMIX_process_suspend(smx_process, issuer);
 280   }
 281 }
 282
 283 void simcall_HANDLER_vm_save(smx_simcall_t simcall, smx_host_t ind_vm)
 284 {
 285   SIMIX_vm_save(ind_vm, simcall->issuer);
 286 }
 287
 288
 289 /**
 290  * \brief Function to restore a SIMIX VM host. This function restart the execution of the
 291  * VM. All the processes on this VM will run again.
 292  *
 293  * \param host the vm host to restore (a smx_host_t)
 294  */
 295 void SIMIX_vm_restore(smx_host_t ind_vm, smx_process_t issuer)
 296 {
 297   const char *name = SIMIX_host_get_name(ind_vm);
 298
 299   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_SAVED)
 300     THROWF(vm_error, 0, "VM(%s) was not saved", name);
 301
 302   XBT_DEBUG("restore VM(%s), where %d processes exist", name, xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
 303
 304   /* jump to vm_ws_restore() */
 305   surf_vm_workstation_resume(ind_vm);
 306
 307   smx_process_t smx_process, smx_process_safe;
 308   xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
 309     XBT_DEBUG("resume %s", smx_process->name);
 310     SIMIX_process_resume(smx_process, issuer);
 311   }
 312 }
 313
 314 void simcall_HANDLER_vm_restore(smx_simcall_t simcall, smx_host_t ind_vm)
 315 {
 316   SIMIX_vm_restore(ind_vm, simcall->issuer);
 317 }
 318
 319
 320 /**
 321  * \brief Function to shutdown a SIMIX VM host. This function powers off the
 322  * VM. All the processes on this VM will be killed. But, the state of the VM is
 323  * preserved on memory. We can later start it again.
 324  *
 325  * \param host the vm host to shutdown (a smx_host_t)
 326  */
 327 void SIMIX_vm_shutdown(smx_host_t ind_vm, smx_process_t issuer)
 328 {
 329   const char *name = SIMIX_host_get_name(ind_vm);
 330
 331   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
 332     THROWF(vm_error, 0, "VM(%s) is not running", name);
 333
 334   XBT_DEBUG("shutdown %s", name);
 335   XBT_DEBUG("%d processes in the VM", xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
 336
 337   smx_process_t smx_process, smx_process_safe;
 338   xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
 339     XBT_DEBUG("kill %s", smx_process->name);
 340     SIMIX_process_kill(smx_process, issuer);
 341   }
 342
 343   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
 344   surf_resource_set_state(surf_workstation_resource_priv(ind_vm),
 345                           (int)SURF_VM_STATE_CREATED);
 346 }
 347
 348 void simcall_HANDLER_vm_shutdown(smx_simcall_t simcall, smx_host_t ind_vm)
 349 {
 350   SIMIX_vm_shutdown(ind_vm, simcall->issuer);
 351 }
 352
 353
 354 /**
 355  * \brief Function to destroy a SIMIX VM host.
 356  *
 357  * \param host the vm host to destroy (a smx_host_t)
 358  */
 359 void SIMIX_vm_destroy(smx_host_t ind_vm)
 360 {
 361   /* this code basically performs a similar thing like SIMIX_host_destroy() */
 362
 363   xbt_assert((ind_vm != NULL), "Invalid parameters");
 364   const char *hostname = SIMIX_host_get_name(ind_vm);
 365
 366   XBT_DEBUG("destroy %s", hostname);
 367
 368   /* this will call the registered callback function, i.e., SIMIX_host_destroy().  */
 369   xbt_lib_unset(host_lib, hostname, SIMIX_HOST_LEVEL, 1);
 370
 371   /* jump to vm_ws_destroy(). The surf level resource will be freed. */
 372   surf_vm_workstation_destroy(ind_vm);
 373 }