Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge with master and fix conflicts
[simgrid.git] / src / msg / msg_vm.c
index 71a614d..908d89c 100644 (file)
@@ -3,11 +3,19 @@
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-
-// TODO
+// QUESTIONS:
 // 1./ check how and where a new VM is added to the list of the hosts
-// 2./ MSG_TRACE can be revisited in order to use  the host
+// 2./ Diff between SIMIX_Actions and SURF_Actions
+// => SIMIX_actions : point synchro entre processus de niveau (theoretically speaking I do not have to create such SIMIX_ACTION
+// =>  Surf_Actions
 
+// TODO
+//     MSG_TRACE can be revisited in order to use  the host
+//     To implement a mixed model between workstation and vm_workstation,
+//     please give a look at surf_model_private_t model_private at SURF Level and to the share resource functions
+//     double (*share_resources) (double now);
+//     For the action into the vm workstation model, we should be able to leverage the usual one (and if needed, look at
+//             the workstation model.
 
 #include "msg_private.h"
 #include "xbt/sysdep.h"
@@ -84,46 +92,136 @@ const char *MSG_vm_get_name(msg_vm_t vm) {
   return MSG_host_get_name(vm);
 }
 
+
+/* **** Check state of a VM **** */
+static inline int __MSG_vm_is_state(msg_vm_t vm, e_surf_vm_state_t state) {
+  return simcall_vm_get_state(vm) == state;
+}
+
+/** @brief Returns whether the given VM has just reated, not running.
+ *  @ingroup msg_VMs
+ */
+int MSG_vm_is_created(msg_vm_t vm)
+{
+  return __MSG_vm_is_state(vm, SURF_VM_STATE_CREATED);
+}
+
+/** @brief Returns whether the given VM is currently running
+ *  @ingroup msg_VMs
+ */
+int MSG_vm_is_running(msg_vm_t vm)
+{
+  return __MSG_vm_is_state(vm, SURF_VM_STATE_RUNNING);
+}
+
+/** @brief Returns whether the given VM is currently migrating
+ *  @ingroup msg_VMs
+ */
+int MSG_vm_is_migrating(msg_vm_t vm)
+{
+  return __MSG_vm_is_state(vm, SURF_VM_STATE_MIGRATING);
+}
+
+/** @brief Returns whether the given VM is currently suspended, not running.
+ *  @ingroup msg_VMs
+ */
+int MSG_vm_is_suspended(msg_vm_t vm)
+{
+  return __MSG_vm_is_state(vm, SURF_VM_STATE_SUSPENDED);
+}
+
+/** @brief Returns whether the given VM is being saved (FIXME: live saving or not?).
+ *  @ingroup msg_VMs
+ */
+int MSG_vm_is_saving(msg_vm_t vm)
+{
+  return __MSG_vm_is_state(vm, SURF_VM_STATE_SAVING);
+}
+
+/** @brief Returns whether the given VM has been saved, not running.
+ *  @ingroup msg_VMs
+ */
+int MSG_vm_is_saved(msg_vm_t vm)
+{
+  return __MSG_vm_is_state(vm, SURF_VM_STATE_SAVED);
+}
+
+/** @brief Returns whether the given VM is being restored, not running.
+ *  @ingroup msg_VMs
+ */
+int MSG_vm_is_restoring(msg_vm_t vm)
+{
+  return __MSG_vm_is_state(vm, SURF_VM_STATE_RESTORING);
+}
+
+
+
+/* ------------------------------------------------------------------------- */
+/* ------------------------------------------------------------------------- */
+
 /* **** ******** MSG vm actions ********* **** */
 
-/** @brief Create a new VM (the VM is just attached to the location but it is not started yet).
+/** @brief Create a new VM with specified parameters.
  *  @ingroup msg_VMs*
  *
- * Please note that a VM is a specific host. Hence, you should give a different name
- * for each VM/PM.
  */
-msg_vm_t MSG_vm_create(msg_host_t ind_host, const char *name,
-                                            int core_nb, int mem_cap, int net_cap){
+msg_vm_t MSG_vm_create(msg_host_t ind_pm, const char *name,
+                                            int core_nb, int mem_cap, int net_cap, char *disk_path, int disk_size)
+{
+  msg_vm_t vm = MSG_vm_create_core(ind_pm, name);
+
+  MSG_vm_set_property_value(vm, "CORE_NB", bprintf("%d", core_nb), free);
+  MSG_vm_set_property_value(vm, "MEM_CAP", bprintf("%d", mem_cap), free);
+  MSG_vm_set_property_value(vm, "NET_CAP", bprintf("%d", net_cap), free);
+
+  /* TODO: We will revisit the disk support later. */
+
+  return vm;
+}
+
 
-  // Note new and vm_workstation refer to the same area (due to the lib/dict appraoch)
-  msg_vm_t new = NULL;
+/** @brief Create a new VM object. The VM is not yet started. The resource of the VM is allocated upon MSG_vm_start().
+ *  @ingroup msg_VMs*
+ *
+ * A VM is treated as a host. The name of the VM must be unique among all hosts.
+ */
+msg_vm_t MSG_vm_create_core(msg_host_t ind_pm, const char *name)
+{
+  /* make sure the VM of the same name does not exit */
+  {
+    void *ind_host_tmp = xbt_lib_get_elm_or_null(host_lib, name);
+    if (ind_host_tmp) {
+      XBT_ERROR("host %s already exits", name);
+      return NULL;
+    }
+  }
+
+  /* Note: ind_vm and vm_workstation point to the same elm object. */
+  msg_vm_t ind_vm = NULL;
   void *ind_vm_workstation =  NULL;
-  // Ask simix to create the surf vm resource
-  ind_vm_workstation = simcall_vm_ws_create(name,ind_host);
-  new = (msg_vm_t) __MSG_host_create(ind_vm_workstation);
 
-  MSG_vm_set_property_value(new, "CORE_NB", bprintf("%d", core_nb), free);
-  MSG_vm_set_property_value(new, "MEM_CAP", bprintf("%d", core_nb), free);
-  MSG_vm_set_property_value(new, "NET_CAP", bprintf("%d", core_nb), free);
+  // Ask simix to create the surf vm resource
+  ind_vm_workstation = simcall_vm_create(name, ind_pm);
+  ind_vm = (msg_vm_t) __MSG_host_create(ind_vm_workstation);
 
-  XBT_DEBUG("A new VM has been created");
-  // TODO check whether the vm (i.e the virtual host) has been correctly added into the list of all hosts.
+  XBT_DEBUG("A new VM (%s) has been created", name);
 
   #ifdef HAVE_TRACING
-  TRACE_msg_vm_create(name, ind_host);
+  TRACE_msg_vm_create(name, ind_pm);
   #endif
 
-  return new;
+  return ind_vm;
 }
 
+
 /** @brief Start a vm (ie. boot)
  *  @ingroup msg_VMs
  *
  *  If the VM cannot be started, an exception is generated.
  *
  */
-void MSG_vm_start(msg_vm_t vm) {
-
+void MSG_vm_start(msg_vm_t vm)
+{
   //Please note that vm start can raise an exception if the VM cannot be started.
   simcall_vm_start(vm);
 
@@ -132,26 +230,14 @@ void MSG_vm_start(msg_vm_t vm) {
   #endif
 }
 
-/* **** Check state of a VM **** */
-int __MSG_vm_is_state(msg_vm_t vm, e_msg_vm_state_t state) {
-       return simcall_get_vm_state(vm) == state ;
-}
 
-/** @brief Returns whether the given VM is currently suspended
- *  @ingroup msg_VMs
- */
-int MSG_vm_is_suspended(msg_vm_t vm) {
-       return __MSG_vm_is_state(vm, msg_vm_state_suspended);
-}
-/** @brief Returns whether the given VM is currently running
+
+/** @brief Immediately kills all processes within the given VM. Any memory that they allocated will be leaked.
  *  @ingroup msg_VMs
+ *
+ * FIXME: No extra delay occurs. If you want to simulate this too, you want to
+ * use a #MSG_process_sleep() or something. I'm not quite sure.
  */
-int MSG_vm_is_running(msg_vm_t vm) {
-  return __MSG_vm_is_state(vm, msg_vm_state_running);
-}
-
-// TODO Implement the functions for the different state
-
 void MSG_vm_shutdown(msg_vm_t vm)
 {
   /* msg_vm_t equals to msg_host_t */
@@ -163,71 +249,57 @@ void MSG_vm_shutdown(msg_vm_t vm)
 }
 
 
-///** @brief Add the given process into the VM.
-// *  @ingroup msg_VMs
-// *
-// * Afterward, when the VM is migrated or suspended or whatever, the process will have the corresponding handling, too.
-// *
-// */
-//void MSG_vm_bind(msg_vm_t vm, msg_process_t process) {
-//  /* check if the process is already in a VM */
-//  simdata_process_t simdata = simcall_process_get_data(process);
-//  if (simdata->vm) {
-//    msg_vm_t old_vm = simdata->vm;
-//    int pos = xbt_dynar_search(old_vm->processes,&process);
-//    xbt_dynar_remove_at(old_vm->processes,pos, NULL);
-//  }
-//  /* check if the host is in the right host */
-//  if (simdata->m_host != vm->location) {
-//    MSG_process_migrate(process,vm->location);
-//  }
-//  simdata->vm = vm;
-//
-//  XBT_DEBUG("binding Process %s to %p",MSG_process_get_name(process),vm);
-//
-//  xbt_dynar_push_as(vm->processes,msg_process_t,process);
-//}
-///** @brief Removes the given process from the given VM, and kill it
-// *  @ingroup msg_VMs
-// *
-// *  Will raise a not_found exception if the process were not binded to that VM
-// */
-//void MSG_vm_unbind(msg_vm_t vm, msg_process_t process) {
-//  int pos = xbt_dynar_search(vm->processes,process);
-//  xbt_dynar_remove_at(vm->processes,pos, NULL);
-//  MSG_process_kill(process);
-//}
-//
-///** @brief Immediately change the host on which all processes are running.
-// *  @ingroup msg_VMs
-// *
-// * No migration cost occurs. If you want to simulate this too, you want to use a
-// * MSG_task_send() before or after, depending on whether you want to do cold or hot
-// * migration.
-// */
-//void MSG_vm_migrate(msg_vm_t vm, msg_host_t destination) {
-//  unsigned int cpt;
-//  msg_process_t process;
-//  xbt_dynar_foreach(vm->processes,cpt,process) {
-//    MSG_process_migrate(process,destination);
-//  }
-//  xbt_swag_remove(vm, MSG_host_priv(vm->location)->vms);
-//  xbt_swag_insert_at_tail(vm, MSG_host_priv(destination)->vms);
-//
-//  #ifdef HAVE_TRACING
-//  TRACE_msg_vm_change_host(vm,vm->location,destination);
-//  #endif
-//
-//  vm->location = destination;
-//}
-//
+/** @brief Migrate the VM to the given host.
+ *  @ingroup msg_VMs
+ *
+ * FIXME: No migration cost occurs. If you want to simulate this too, you want to use a
+ * MSG_task_send() before or after, depending on whether you want to do cold or hot
+ * migration.
+ */
+void MSG_vm_migrate(msg_vm_t vm, msg_host_t destination)
+{
+  /* some thoughts:
+   * - One approach is ...
+   *   We first create a new VM (i.e., destination VM) on the destination
+   *   physical host. The destination VM will receive the state of the source
+   *   VM over network. We will finally destroy the source VM.
+   *   - This behavior is similar to the way of migration in the real world.
+   *     Even before a migration is completed, we will see a destination VM,
+   *     consuming resources.
+   *   - We have to relocate all processes. The existing process migraion code
+   *     will work for this?
+   *   - The name of the VM is a somewhat unique ID in the code. It is tricky
+   *     for the destination VM?
+   *
+   * - Another one is ...
+   *   We update the information of the given VM to place it to the destination
+   *   physical host.
+   *
+   * The second one would be easier.
+   *   
+   */
+
+  #ifdef HAVE_TRACING
+  const char *old_pm_name = simcall_vm_get_phys_host(vm);
+  msg_host_t old_pm_ind  = xbt_lib_get_elm_or_null(host_lib, old_pm_name);
+  #endif
+
+  simcall_vm_migrate(vm, destination);
+
+
+  #ifdef HAVE_TRACING
+  TRACE_msg_vm_change_host(vm, old_pm_ind, destination);
+  #endif
+}
+
 
 /** @brief Immediately suspend the execution of all processes within the given VM.
  *  @ingroup msg_VMs
  *
- * No suspension cost occurs. If you want to simulate this too, you want to
- * use a \ref MSG_file_write() before or after, depending on the exact semantic
- * of VM suspend to you.
+ * This function stops the exection of the VM. All the processes on this VM
+ * will pause. The state of the VM is perserved. We can later resume it again.
+ *
+ * No suspension cost occurs.
  */
 void MSG_vm_suspend(msg_vm_t vm)
 {
@@ -236,63 +308,58 @@ void MSG_vm_suspend(msg_vm_t vm)
   #ifdef HAVE_TRACING
   TRACE_msg_vm_suspend(vm);
   #endif
-#if 0
-  unsigned int cpt;
-  msg_process_t process;
-  xbt_dynar_foreach(vm->processes,cpt,process) {
-    XBT_DEBUG("suspend process %s of host %s",MSG_process_get_name(process),MSG_host_get_name(MSG_process_get_host(process)));
-    MSG_process_suspend(process);
-  }
-#endif
 }
 
-//
-//
-///** @brief Immediately resumes the execution of all processes within the given VM.
-// *  @ingroup msg_VMs
-// *
-// * No resume cost occurs. If you want to simulate this too, you want to
-// * use a \ref MSG_file_read() before or after, depending on the exact semantic
-// * of VM resume to you.
-// */
-//void MSG_vm_resume(msg_vm_t vm) {
-//  unsigned int cpt;
-//  msg_process_t process;
-//  xbt_dynar_foreach(vm->processes,cpt,process) {
-//    XBT_DEBUG("resume process %s of host %s",MSG_process_get_name(process),MSG_host_get_name(MSG_process_get_host(process)));
-//    MSG_process_resume(process);
-//  }
-//
-//  #ifdef HAVE_TRACING
-//  TRACE_msg_vm_resume(vm);
-//  #endif
-//}
-//
-//
-///**
-// * \ingroup msg_VMs
-// * \brief Reboot the VM, restarting all the processes in it.
-// */
-//void MSG_vm_reboot(msg_vm_t vm)
-//{
-//  xbt_dynar_t new_processes = xbt_dynar_new(sizeof(msg_process_t),NULL);
-//
-//  msg_process_t process;
-//  unsigned int cpt;
-//
-//  xbt_dynar_foreach(vm->processes,cpt,process) {
-//    msg_process_t new_process = MSG_process_restart(process);
-//    xbt_dynar_push_as(new_processes,msg_process_t,new_process);
-//
-//  }
-//
-//  xbt_dynar_foreach(new_processes, cpt, process) {
-//    MSG_vm_bind(vm,process);
-//  }
-//
-//  xbt_dynar_free(&new_processes);
-//}
-//
+
+/** @brief Resume the execution of the VM. All processes on the VM run again.
+ *  @ingroup msg_VMs
+ *
+ * No resume cost occurs.
+ */
+void MSG_vm_resume(msg_vm_t vm)
+{
+  simcall_vm_resume(vm);
+
+  #ifdef HAVE_TRACING
+  TRACE_msg_vm_resume(vm);
+  #endif
+}
+
+
+/** @brief Immediately save the execution of all processes within the given VM.
+ *  @ingroup msg_VMs
+ *
+ * This function stops the exection of the VM. All the processes on this VM
+ * will pause. The state of the VM is perserved. We can later resume it again.
+ *
+ * FIXME: No suspension cost occurs. If you want to simulate this too, you want to
+ * use a \ref MSG_file_write() before or after, depending on the exact semantic
+ * of VM save to you.
+ */
+void MSG_vm_save(msg_vm_t vm)
+{
+  simcall_vm_save(vm);
+  #ifdef HAVE_TRACING
+  TRACE_msg_vm_save(vm);
+  #endif
+}
+
+/** @brief Restore the execution of the VM. All processes on the VM run again.
+ *  @ingroup msg_VMs
+ *
+ * FIXME: No restore cost occurs. If you want to simulate this too, you want to
+ * use a \ref MSG_file_read() before or after, depending on the exact semantic
+ * of VM restore to you.
+ */
+void MSG_vm_restore(msg_vm_t vm)
+{
+  simcall_vm_restore(vm);
+
+  #ifdef HAVE_TRACING
+  TRACE_msg_vm_restore(vm);
+  #endif
+}
+
 
 /** @brief Destroy a VM. Destroy the VM object from the simulation.
  *  @ingroup msg_VMs
@@ -308,17 +375,4 @@ void MSG_vm_destroy(msg_vm_t vm)
   #ifdef HAVE_TRACING
   TRACE_msg_vm_end(vm);
   #endif
-
-#if 0
-  unsigned int cpt;
-  msg_process_t process;
-  xbt_dynar_foreach(vm->processes,cpt,process) {
-    //FIXME: Slow ?
-    simdata_process_t simdata = simcall_process_get_data(process);
-    simdata->vm = NULL;
-  }
-
-  xbt_dynar_free(&vm->processes);
-  xbt_free(vm);
-#endif
 }