Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Compilation is at least ok - Ad(rien)
[simgrid.git] / src / simix / smx_vm.c
index 37c25aa..213c165 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2007-2012. The SimGrid Team.
+/* Copyright (c) 2007-2014. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -10,8 +10,9 @@
 #include "xbt/dict.h"
 #include "mc/mc.h"
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_vm, simix,
-                                "Logging specific to SIMIX (vms)");
+//If you need to log some stuffs, just uncomment these two lines and uses XBT_DEBUG for instance
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_vm, simix, "Logging specific to SIMIX (vms)");
+
 /* **** create a VM **** */
 
 /**
@@ -19,89 +20,355 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_vm, simix,
  * \param name name of the host to create
  * \param data some user data (may be NULL)
  */
-smx_host_t SIMIX_vm_create(const char *name, smx_host_t phys_host)
+smx_host_t SIMIX_vm_create(const char *name, smx_host_t ind_phys_host)
 {
+  /* Create surf associated resource */
+  surf_vm_workstation_model_create(name, ind_phys_host);
 
-  smx_host_priv_t smx_host = xbt_new0(s_smx_host_priv_t, 1);
-  s_smx_process_t proc;
+  smx_host_t smx_host = SIMIX_host_create(name, ind_phys_host, NULL);
 
-  // TODO check why we do not have any VM here and why we have the host_proc_hookup  ?
+  /* We will be able to register the VM to its physical host, so that we can promptly
+   * retrieve the list VMs on the physical host. */
 
-  /* Host structure */
-  smx_host->data = NULL;
-  smx_host->process_list =
-      xbt_swag_new(xbt_swag_offset(proc, host_proc_hookup));
+  return smx_host;
+}
 
-  /* Update global variables */
-  xbt_lib_set(host_lib,name,SIMIX_HOST_LEVEL,smx_host);
 
-  /* Create surf associated resource */
-  // TODO change phys_host into the right workstation surf model
-  surf_vm_workstation_model->extension.vm_workstation.create(name, phys_host);
+/* works for VMs and PMs */
+static long host_get_ramsize(smx_host_t vm, int *overcommit)
+{
+  s_ws_params_t params;
+  surf_workstation_get_params(vm, &params);
+
+  if (overcommit)
+    *overcommit = params.overcommit;
 
-  return xbt_lib_get_elm_or_null(host_lib, name);
+  return params.ramsize;
 }
 
+/* **** start a VM **** */
+static int __can_be_started(smx_host_t vm)
+{
+  smx_host_t pm = surf_vm_workstation_get_pm(vm);
 
-smx_host_t SIMIX_pre_vm_create(smx_simcall_t simcall, const char *name, smx_host_t phys_host){
-   return SIMIX_vm_create(name, phys_host);
-}
+  int pm_overcommit = 0;
+  long pm_ramsize = host_get_ramsize(pm, &pm_overcommit);
+  long vm_ramsize = host_get_ramsize(vm, NULL);
 
+  if (!pm_ramsize) {
+    /* We assume users do not want to care about ramsize. */
+    return 1;
+  }
 
-/* **** start a VM **** */
-int __can_be_started(smx_host_t vm){
-       // TODO add checking code related to overcommitment or not.
+  if (pm_overcommit) {
+    XBT_INFO("%s allows memory overcommit.", pm->key);
+    return 1;
+  }
+
+  long total_ramsize_of_vms = 0;
+  xbt_dynar_t dyn_vms = surf_workstation_get_vms(pm);
+  {
+    unsigned int cursor = 0;
+    smx_host_t another_vm;
+    xbt_dynar_foreach(dyn_vms, cursor, another_vm) {
+      long another_vm_ramsize = host_get_ramsize(vm, NULL);
+      total_ramsize_of_vms += another_vm_ramsize;
+    }
+  }
+
+  if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
+    XBT_WARN("cannnot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
+        vm->key, pm->key, vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
+    xbt_dynar_free(&dyn_vms);
+    return 0;
+  }
+
+  xbt_dynar_free(&dyn_vms);
        return 1;
 }
-void SIMIX_vm_start(smx_host_t vm){
 
-  //TODO only start the VM if you can
-  if (can_be_started(vm))
-         SIMIX_set_vm_state(vm, msg_vm_state_running);
+void SIMIX_vm_start(smx_host_t ind_vm)
+{
+  if (__can_be_started(ind_vm))
+    surf_resource_set_state(surf_workstation_resource_priv(ind_vm),
+                            (int)SURF_VM_STATE_RUNNING);
   else
-         THROWF(vm_error, 0, "The VM %s cannot be started", SIMIX_host_get_name(vm));
+    THROWF(vm_error, 0, "The VM %s cannot be started", SIMIX_host_get_name(ind_vm));
+}
+
+
+int SIMIX_vm_get_state(smx_host_t ind_vm)
+{
+  return surf_resource_get_state(surf_workstation_resource_priv(ind_vm));
+}
+
+/**
+ * \brief Function to migrate a SIMIX VM host.
+ *
+ * \param host the vm host to migrate (a smx_host_t)
+ */
+void SIMIX_vm_migrate(smx_host_t ind_vm, smx_host_t ind_dst_pm)
+{
+  /* precopy migration makes the VM temporally paused */
+  xbt_assert(SIMIX_vm_get_state(ind_vm) == SURF_VM_STATE_SUSPENDED);
+
+  /* jump to vm_ws_xigrate(). this will update the vm location. */
+  surf_vm_workstation_migrate(ind_vm, ind_dst_pm);
+}
+
+/**
+ * \brief Encompassing simcall to prevent the removal of the src or the dst node at the end of a VM migration
+ *  The simcall actually invokes the following calls: 
+ *     simcall_vm_set_affinity(vm, src_pm, 0); 
+ *     simcall_vm_migrate(vm, dst_pm); 
+ *     simcall_vm_resume(vm);
+ *
+ * It is called at the end of the migration_rx_fun function from msg/msg_vm.c
+ *
+ * \param vm VM to migrate
+ * \param src_pm  Source physical host
+ * \param dst_pmt Destination physical host
+ */
+void SIMIX_vm_migratefrom_resumeto(smx_host_t vm, smx_host_t src_pm, smx_host_t dst_pm)
+{
+  /* deinstall the current affinity setting for the CPU */
+  SIMIX_vm_set_affinity(vm, src_pm, 0);
+
+  /* Update the vm location */
+  SIMIX_vm_migrate(vm, dst_pm);
+  /* Resume the VM */
+  smx_process_t self = SIMIX_process_self(); 
+  SIMIX_vm_resume(vm, self->simcall.issuer);
+} 
+
+/**
+ * \brief Function to get the physical host of the given SIMIX VM host.
+ *
+ * \param host the vm host to get_phys_host (a smx_host_t)
+ */
+void *SIMIX_vm_get_pm(smx_host_t ind_vm)
+{
+  /* jump to vm_ws_get_pm(). this will return the vm name. */
+  return surf_vm_workstation_get_pm(ind_vm);
+}
+
+/**
+ * \brief Function to set the CPU bound of the given SIMIX VM host.
+ *
+ * \param host the vm host (a smx_host_t)
+ * \param bound bound (a double)
+ */
+void SIMIX_vm_set_bound(smx_host_t ind_vm, double bound)
+{
+  /* jump to vm_ws_set_vm_bound(). */
+  surf_vm_workstation_set_bound(ind_vm, bound);
+}
+
+/**
+ * \brief Function to set the CPU affinity of the given SIMIX VM host.
+ *
+ * \param host the vm host (a smx_host_t)
+ * \param host the pm host (a smx_host_t)
+ * \param mask affinity mask (a unsigned long)
+ */
+void SIMIX_vm_set_affinity(smx_host_t ind_vm, smx_host_t ind_pm, unsigned long mask)
+{
+  /* make sure this at the MSG layer. */
+  xbt_assert(SIMIX_vm_get_pm(ind_vm) == ind_pm);
+
+  /* jump to vm_ws_set_vm_affinity(). */
+  surf_vm_workstation_set_affinity(ind_vm, ind_pm, mask);
+}
+
+
+/**
+ * \brief Function to suspend a SIMIX VM host. This function stops the execution of the
+ * VM. All the processes on this VM will pause. The state of the VM is
+ * preserved on memory. We can later resume it again.
+ *
+ * \param host the vm host to suspend (a smx_host_t)
+ */
+void SIMIX_vm_suspend(smx_host_t ind_vm, smx_process_t issuer)
+{
+  const char *name = SIMIX_host_get_name(ind_vm);
+
+  if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
+    THROWF(vm_error, 0, "VM(%s) is not running", name);
+
+  XBT_DEBUG("suspend VM(%s), where %d processes exist", name, xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
+
+  /* jump to vm_ws_suspend. The state will be set. */
+  surf_vm_workstation_suspend(ind_vm);
+
+  smx_process_t smx_process, smx_process_safe;
+  xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
+    XBT_DEBUG("suspend %s", smx_process->name);
+    SIMIX_process_suspend(smx_process, issuer);
+  }
+
+  XBT_DEBUG("suspend all processes on the VM done done");
+}
+
+void simcall_HANDLER_vm_suspend(smx_simcall_t simcall, smx_host_t ind_vm)
+{
+  if (simcall->issuer->smx_host == ind_vm) {
+    XBT_ERROR("cannot suspend the VM where I run");
+    DIE_IMPOSSIBLE;
+  }
+
+  SIMIX_vm_suspend(ind_vm, simcall->issuer);
+
+  XBT_DEBUG("simcall_HANDLER_vm_suspend done");
+}
+
+
+/**
+ * \brief Function to resume a SIMIX VM host. This function restart the execution of the
+ * VM. All the processes on this VM will run again.
+ *
+ * \param host the vm host to resume (a smx_host_t)
+ */
+void SIMIX_vm_resume(smx_host_t ind_vm, smx_process_t issuer)
+{
+  const char *name = SIMIX_host_get_name(ind_vm);
+
+  if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_SUSPENDED)
+    THROWF(vm_error, 0, "VM(%s) was not suspended", name);
+
+  XBT_DEBUG("resume VM(%s), where %d processes exist", name, xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
+
+  /* jump to vm_ws_resume() */
+  surf_vm_workstation_resume(ind_vm);
+
+  smx_process_t smx_process, smx_process_safe;
+  xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
+    XBT_DEBUG("resume %s", smx_process->name);
+    SIMIX_process_resume(smx_process, issuer);
+  }
+}
+
+void simcall_HANDLER_vm_resume(smx_simcall_t simcall, smx_host_t ind_vm)
+{
+  SIMIX_vm_resume(ind_vm, simcall->issuer);
+}
+
+
+/**
+ * \brief Function to save a SIMIX VM host.
+ * This function is the same as vm_suspend, but the state of the VM is saved to the disk, and not preserved on memory.
+ * We can later restore it again.
+ *
+ * \param host the vm host to save (a smx_host_t)
+ */
+void SIMIX_vm_save(smx_host_t ind_vm, smx_process_t issuer)
+{
+  const char *name = SIMIX_host_get_name(ind_vm);
+
+  if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
+    THROWF(vm_error, 0, "VM(%s) is not running", name);
+
+
+  XBT_DEBUG("save VM(%s), where %d processes exist", name, xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
+
+  /* jump to vm_ws_save() */
+  surf_vm_workstation_save(ind_vm);
+
+  smx_process_t smx_process, smx_process_safe;
+  xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
+    XBT_DEBUG("suspend %s", smx_process->name);
+    SIMIX_process_suspend(smx_process, issuer);
+  }
 }
 
-void SIMIX_pre_vm_start(smx_simcall_t simcall, smx_host_t vm){
-   SIMIX_vm_start(vm);
+void simcall_HANDLER_vm_save(smx_simcall_t simcall, smx_host_t ind_vm)
+{
+  SIMIX_vm_save(ind_vm, simcall->issuer);
 }
 
-/* ***** set/get state of a VM ***** */
-void SIMIX_set_vm_state(smx_host_t vm, int state){
-       surf_vm_workstation_model->extension.vm_workstation.set_state(vm, state);
+
+/**
+ * \brief Function to restore a SIMIX VM host. This function restart the execution of the
+ * VM. All the processes on this VM will run again.
+ *
+ * \param host the vm host to restore (a smx_host_t)
+ */
+void SIMIX_vm_restore(smx_host_t ind_vm, smx_process_t issuer)
+{
+  const char *name = SIMIX_host_get_name(ind_vm);
+
+  if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_SAVED)
+    THROWF(vm_error, 0, "VM(%s) was not saved", name);
+
+  XBT_DEBUG("restore VM(%s), where %d processes exist", name, xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
+
+  /* jump to vm_ws_restore() */
+  surf_vm_workstation_resume(ind_vm);
+
+  smx_process_t smx_process, smx_process_safe;
+  xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
+    XBT_DEBUG("resume %s", smx_process->name);
+    SIMIX_process_resume(smx_process, issuer);
+  }
 }
-void SIMIX_prev_set_vm_state(smx_host_t vm, int state){
-       SIMIX_set_vm_state(vm, state);
+
+void simcall_HANDLER_vm_restore(smx_simcall_t simcall, smx_host_t ind_vm)
+{
+  SIMIX_vm_restore(ind_vm, simcall->issuer);
 }
 
-int SIMIX_get_vm_state(smx_host_t vm){
- return surf_vm_workstation_model->extension.vm_workstation.get_state(vm);
+
+/**
+ * \brief Function to shutdown a SIMIX VM host. This function powers off the
+ * VM. All the processes on this VM will be killed. But, the state of the VM is
+ * preserved on memory. We can later start it again.
+ *
+ * \param host the vm host to shutdown (a smx_host_t)
+ */
+void SIMIX_vm_shutdown(smx_host_t ind_vm, smx_process_t issuer)
+{
+  const char *name = SIMIX_host_get_name(ind_vm);
+
+  if (SIMIX_vm_get_state(ind_vm) != SURF_VM_STATE_RUNNING)
+    THROWF(vm_error, 0, "VM(%s) is not running", name);
+
+  XBT_DEBUG("shutdown %s", name);
+  XBT_DEBUG("%d processes in the VM", xbt_swag_size(SIMIX_host_priv(ind_vm)->process_list));
+
+  smx_process_t smx_process, smx_process_safe;
+  xbt_swag_foreach_safe(smx_process, smx_process_safe, SIMIX_host_priv(ind_vm)->process_list) {
+    XBT_DEBUG("kill %s", smx_process->name);
+    SIMIX_process_kill(smx_process, issuer);
+  }
+
+  /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
+  surf_resource_set_state(surf_workstation_resource_priv(ind_vm),
+                          (int)SURF_VM_STATE_CREATED);
 }
-int SIMIX_pre_vm_state(smx_host_t vm){
-       return SIMIX_get_vm_state(vm);
+
+void simcall_HANDLER_vm_shutdown(smx_simcall_t simcall, smx_host_t ind_vm)
+{
+  SIMIX_vm_shutdown(ind_vm, simcall->issuer);
 }
 
+
 /**
  * \brief Function to destroy a SIMIX VM host.
  *
  * \param host the vm host to destroy (a smx_host_t)
  */
-void SIMIX_vm_destroy(smx_host_t host)
+void SIMIX_vm_destroy(smx_host_t ind_vm)
 {
   /* this code basically performs a similar thing like SIMIX_host_destroy() */
 
-  xbt_assert((host != NULL), "Invalid parameters");
-  char *hostname = host->key;
+  xbt_assert((ind_vm != NULL), "Invalid parameters");
+  const char *hostname = SIMIX_host_get_name(ind_vm);
 
-  smx_host_priv_t host_priv = SIMIX_host_priv(host);
+  XBT_DEBUG("destroy %s", hostname);
 
   /* this will call the registered callback function, i.e., SIMIX_host_destroy().  */
-  xbt_lib_unset(host_lib, hostname, SIMIX_HOST_LEVEL);
+  xbt_lib_unset(host_lib, hostname, SIMIX_HOST_LEVEL, 1);
 
   /* jump to vm_ws_destroy(). The surf level resource will be freed. */
-  surf_vm_workstation_model->extension.vm_workstation.destroy(host);
-}
-
-void SIMIX_pre_vm_destroy(smx_simcall_t simcall, smx_host_t vm){
-   SIMIX_vm_start(vm);
+  surf_vm_workstation_destroy(ind_vm);
 }