src/simix/smx_vm.c

   1 /* Copyright (c) 2007-2012. 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->extension.vm_workstation.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 smx_host_t SIMIX_pre_vm_create(smx_simcall_t simcall, const char *name, smx_host_t ind_phys_host)
  38 {
  39   return SIMIX_vm_create(name, ind_phys_host);
  40 }
  41
  42
  43 /* works for VMs and PMs */
  44 static long host_get_ramsize(smx_host_t vm, int *overcommit)
  45 {
  46   s_ws_params_t params;
  47   surf_workstation_model->extension.workstation.get_params(vm, &params);
  48
  49   if (overcommit)
  50     *overcommit = params.overcommit;
  51
  52   return params.ramsize;
  53 }
  54
  55 /* **** start a VM **** */
  56 static int __can_be_started(smx_host_t vm)
  57 {
  58   smx_host_t pm = surf_vm_workstation_model->extension.vm_workstation.get_pm(vm);
  59
  60   int pm_overcommit = 0;
  61   long pm_ramsize = host_get_ramsize(pm, &pm_overcommit);
  62   long vm_ramsize = host_get_ramsize(vm, NULL);
  63
  64   if (!pm_ramsize) {
  65     /* We assume users do not want to care about ramsize. */
  66     return 1;
  67   }
  68
  69   if (pm_overcommit) {
  70     XBT_INFO("%s allows memory overcommit.", pm->key);
  71     return 1;
  72   }
  73
  74   long total_ramsize_of_vms = 0;
  75   xbt_dynar_t dyn_vms = surf_workstation_model->extension.workstation.get_vms(pm);
  76   {
  77     unsigned int cursor = 0;
  78     smx_host_t another_vm;
  79     xbt_dynar_foreach(dyn_vms, cursor, another_vm) {
  80       long another_vm_ramsize = host_get_ramsize(vm, NULL);
  81       total_ramsize_of_vms += another_vm_ramsize;
  82     }
  83   }
  84
  85   if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
  86     XBT_WARN("cannnot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
  87         vm->key, pm->key, vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
  88     xbt_dynar_free(&dyn_vms);
  89     return 0;
  90   }
  91
  92   xbt_dynar_free(&dyn_vms);
  93         return 1;
  94 }
  95
  96 void SIMIX_vm_start(smx_host_t ind_vm)
  97 {
  98   if (__can_be_started(ind_vm))
  99     SIMIX_vm_set_state(ind_vm, SURF_VM_STATE_RUNNING);
 100   else
 101     THROWF(vm_error, 0, "The VM %s cannot be started", SIMIX_host_get_name(ind_vm));
 102 }
 103
 104
 105
 106 void SIMIX_pre_vm_start(smx_simcall_t simcall, smx_host_t ind_vm)
 107 {
 108   SIMIX_vm_start(ind_vm);
 109   SIMIX_simcall_answer(simcall);
 110 }
 111
 112 /* ***** set/get state of a VM ***** */
 113 void SIMIX_vm_set_state(smx_host_t ind_vm, int state)
 114 {
 115   /* jump to vm_ws_set_state */
 116   surf_vm_workstation_model->extension.vm_workstation.set_state(ind_vm, state);
 117 }
 118
 119 void SIMIX_pre_vm_set_state(smx_simcall_t simcall, smx_host_t ind_vm, int state)
 120 {
 121   SIMIX_vm_set_state(ind_vm, state);
 122 }
 123
 124 int SIMIX_vm_get_state(smx_host_t ind_vm)
 125 {
 126   return surf_vm_workstation_model->extension.vm_workstation.get_state(ind_vm);
 127 }
 128
 129 int SIMIX_pre_vm_get_state(smx_simcall_t simcall, smx_host_t ind_vm)
 130 {
 131   return SIMIX_vm_get_state(ind_vm);
 132 }
 133
 134
 135 /**
 136  * \brief Function to migrate a SIMIX VM host.
 137  *
 138  * \param host the vm host to migrate (a smx_host_t)
 139  */
 140 void SIMIX_vm_migrate(smx_host_t ind_vm, smx_host_t ind_dst_pm)
 141 {
 142   /* precopy migration makes the VM temporally paused */
 143   e_surf_vm_state_t state = SIMIX_vm_get_state(ind_vm);
 144   xbt_assert(state == SURF_VM_STATE_SUSPENDED);
 145
 146   /* jump to vm_ws_migrate(). this will update the vm location. */
 147   surf_vm_workstation_model->extension.vm_workstation.migrate(ind_vm, ind_dst_pm);
 148 }
 149
 150 void SIMIX_pre_vm_migrate(smx_simcall_t simcall, smx_host_t ind_vm, smx_host_t ind_dst_pm)
 151 {
 152   SIMIX_vm_migrate(ind_vm, ind_dst_pm);
 153   SIMIX_simcall_answer(simcall);
 154 }
 155
 156
 157 /**
 158  * \brief Function to get the physical host of the given SIMIX VM host.
 159  *
 160  * \param host the vm host to get_phys_host (a smx_host_t)
 161  */
 162 void *SIMIX_vm_get_pm(smx_host_t ind_vm)
 163 {
 164   /* jump to vm_ws_get_pm(). this will return the vm name. */
 165   return surf_vm_workstation_model->extension.vm_workstation.get_pm(ind_vm);
 166 }
 167
 168 void *SIMIX_pre_vm_get_pm(smx_simcall_t simcall, smx_host_t ind_vm)
 169 {
 170   return SIMIX_vm_get_pm(ind_vm);
 171 }
 172
 173
 174 /**
 175  * \brief Function to set the CPU bound of the given SIMIX VM host.
 176  *
 177  * \param host the vm host (a smx_host_t)
 178  * \param bound bound (a double)
 179  */
 180 void SIMIX_vm_set_bound(smx_host_t ind_vm, double bound)
 181 {
 182   /* jump to vm_ws_set_vm_bound(). */
 183   surf_vm_workstation_model->extension.vm_workstation.set_vm_bound(ind_vm, bound);
 184 }
 185
 186 void SIMIX_pre_vm_set_bound(smx_simcall_t simcall, smx_host_t ind_vm, double bound)
 187 {
 188   SIMIX_vm_set_bound(ind_vm, bound);
 189   SIMIX_simcall_answer(simcall);
 190 }
 191
 192
 193 /**
 194  * \brief Function to suspend a SIMIX VM host. This function stops the exection of the
 195  * VM. All the processes on this VM will pause. The state of the VM is
 196  * preserved on memory. We can later resume it again.
 197  *
 198  * \param host the vm host to suspend (a smx_host_t)
 199  */
 200 void SIMIX_vm_suspend(smx_host_t ind_vm, smx_process_t issuer)
 201 {
 202   const char *name = SIMIX_host_get_name(ind_vm);
 203
 204   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
 205     THROWF(vm_error, 0, "VM(%s) is not running", name);
 206
 207   XBT_DEBUG("suspend VM(%s), where %d processes exist", name, xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
 208
 209   /* jump to vm_ws_suspend. The state will be set. */
 210   surf_vm_workstation_model->extension.vm_workstation.suspend(ind_vm);
 211
 212   smx_process_t smx_process, smx_process_safe;
 213   xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
 214     XBT_DEBUG("suspend %s", smx_process->name);
 215     SIMIX_process_suspend(smx_process, issuer);
 216   }
 217
 218   XBT_DEBUG("suspend all processes on the VM done done");
 219 }
 220
 221 void SIMIX_pre_vm_suspend(smx_simcall_t simcall, smx_host_t ind_vm)
 222 {
 223   if (simcall->issuer->smx_host == ind_vm) {
 224     XBT_ERROR("cannot suspend the VM where I run");
 225     DIE_IMPOSSIBLE;
 226   }
 227
 228   SIMIX_vm_suspend(ind_vm, simcall->issuer);
 229
 230   /* without this, simcall_vm_suspend() does not return to the userland. why? */
 231   SIMIX_simcall_answer(simcall);
 232
 233   XBT_DEBUG("SIMIX_pre_vm_suspend done");
 234 }
 235
 236
 237 /**
 238  * \brief Function to resume a SIMIX VM host. This function restart the execution of the
 239  * VM. All the processes on this VM will run again.
 240  *
 241  * \param host the vm host to resume (a smx_host_t)
 242  */
 243 void SIMIX_vm_resume(smx_host_t ind_vm, smx_process_t issuer)
 244 {
 245   const char *name = SIMIX_host_get_name(ind_vm);
 246
 247   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_SUSPENDED)
 248     THROWF(vm_error, 0, "VM(%s) was not suspended", name);
 249
 250   XBT_DEBUG("resume VM(%s), where %d processes exist", name, xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
 251
 252   /* jump to vm_ws_resume() */
 253   surf_vm_workstation_model->extension.vm_workstation.resume(ind_vm);
 254
 255   smx_process_t smx_process, smx_process_safe;
 256   xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
 257     XBT_DEBUG("resume %s", smx_process->name);
 258     SIMIX_process_resume(smx_process, issuer);
 259   }
 260 }
 261
 262 void SIMIX_pre_vm_resume(smx_simcall_t simcall, smx_host_t ind_vm)
 263 {
 264   SIMIX_vm_resume(ind_vm, simcall->issuer);
 265   SIMIX_simcall_answer(simcall);
 266 }
 267
 268
 269 /**
 270  * \brief Function to save a SIMIX VM host.
 271  * This function is the same as vm_suspend, but the state of the VM is saved to the disk, and not preserved on memory.
 272  * We can later restore it again.
 273  *
 274  * \param host the vm host to save (a smx_host_t)
 275  */
 276 void SIMIX_vm_save(smx_host_t ind_vm, smx_process_t issuer)
 277 {
 278   const char *name = SIMIX_host_get_name(ind_vm);
 279
 280   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
 281     THROWF(vm_error, 0, "VM(%s) is not running", name);
 282
 283
 284   XBT_DEBUG("save VM(%s), where %d processes exist", name, xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
 285
 286   /* jump to vm_ws_save() */
 287   surf_vm_workstation_model->extension.vm_workstation.save(ind_vm);
 288
 289   smx_process_t smx_process, smx_process_safe;
 290   xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
 291     XBT_DEBUG("suspend %s", smx_process->name);
 292     SIMIX_process_suspend(smx_process, issuer);
 293   }
 294 }
 295
 296 void SIMIX_pre_vm_save(smx_simcall_t simcall, smx_host_t ind_vm)
 297 {
 298   SIMIX_vm_save(ind_vm, simcall->issuer);
 299
 300   /* without this, simcall_vm_suspend() does not return to the userland. why? */
 301   SIMIX_simcall_answer(simcall);
 302 }
 303
 304
 305 /**
 306  * \brief Function to restore a SIMIX VM host. This function restart the execution of the
 307  * VM. All the processes on this VM will run again.
 308  *
 309  * \param host the vm host to restore (a smx_host_t)
 310  */
 311 void SIMIX_vm_restore(smx_host_t ind_vm, smx_process_t issuer)
 312 {
 313   const char *name = SIMIX_host_get_name(ind_vm);
 314
 315   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_SAVED)
 316     THROWF(vm_error, 0, "VM(%s) was not saved", name);
 317
 318   XBT_DEBUG("restore VM(%s), where %d processes exist", name, xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
 319
 320   /* jump to vm_ws_restore() */
 321   surf_vm_workstation_model->extension.vm_workstation.resume(ind_vm);
 322
 323   smx_process_t smx_process, smx_process_safe;
 324   xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
 325     XBT_DEBUG("resume %s", smx_process->name);
 326     SIMIX_process_resume(smx_process, issuer);
 327   }
 328 }
 329
 330 void SIMIX_pre_vm_restore(smx_simcall_t simcall, smx_host_t ind_vm)
 331 {
 332   SIMIX_vm_restore(ind_vm, simcall->issuer);
 333   SIMIX_simcall_answer(simcall);
 334 }
 335
 336
 337 /**
 338  * \brief Function to shutdown a SIMIX VM host. This function powers off the
 339  * VM. All the processes on this VM will be killed. But, the state of the VM is
 340  * preserved on memory. We can later start it again.
 341  *
 342  * \param host the vm host to shutdown (a smx_host_t)
 343  */
 344 void SIMIX_vm_shutdown(smx_host_t ind_vm, smx_process_t issuer)
 345 {
 346   const char *name = SIMIX_host_get_name(ind_vm);
 347
 348   if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
 349     THROWF(vm_error, 0, "VM(%s) is not running", name);
 350
 351   XBT_DEBUG("%d processes in the VM", xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
 352
 353   smx_process_t smx_process, smx_process_safe;
 354   xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
 355     XBT_DEBUG("shutdown %s", name);
 356     SIMIX_process_kill(smx_process, issuer);
 357   }
 358
 359   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
 360   SIMIX_vm_set_state(ind_vm, SURF_VM_STATE_CREATED);
 361 }
 362
 363 void SIMIX_pre_vm_shutdown(smx_simcall_t simcall, smx_host_t ind_vm)
 364 {
 365   SIMIX_vm_shutdown(ind_vm, simcall->issuer);
 366   SIMIX_simcall_answer(simcall);
 367 }
 368
 369
 370 /**
 371  * \brief Function to destroy a SIMIX VM host.
 372  *
 373  * \param host the vm host to destroy (a smx_host_t)
 374  */
 375 void SIMIX_vm_destroy(smx_host_t ind_vm)
 376 {
 377   /* this code basically performs a similar thing like SIMIX_host_destroy() */
 378
 379   xbt_assert((ind_vm != NULL), "Invalid parameters");
 380   const char *hostname = SIMIX_host_get_name(ind_vm);
 381
 382   /* this will call the registered callback function, i.e., SIMIX_host_destroy().  */
 383   xbt_lib_unset(host_lib, hostname, SIMIX_HOST_LEVEL, 1);
 384
 385   /* jump to vm_ws_destroy(). The surf level resource will be freed. */
 386   surf_vm_workstation_model->extension.vm_workstation.destroy(ind_vm);
 387 }
 388
 389 void SIMIX_pre_vm_destroy(smx_simcall_t simcall, smx_host_t ind_vm)
 390 {
 391   SIMIX_vm_destroy(ind_vm);
 392   SIMIX_simcall_answer(simcall);
 393 }