Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge with master and fix conflicts
[simgrid.git] / src / msg / msg_vm.c
index b6f55c7..908d89c 100644 (file)
@@ -92,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. */
 
-  // Note new and vm_workstation refer to the same area (due to the lib/dict appraoch)
-  msg_vm_t new = NULL;
+  return vm;
+}
+
+
+/** @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_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", mem_cap), free);
-  MSG_vm_set_property_value(new, "NET_CAP", bprintf("%d", net_cap), 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);
 
@@ -140,31 +230,12 @@ 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_vm_get_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
- *  @ingroup msg_VMs
- */
-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
 
 
 /** @brief Immediately kills all processes within the given VM. Any memory that they allocated will be leaked.
  *  @ingroup msg_VMs
  *
- * No extra delay occurs. If you want to simulate this too, you want to
+ * 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.
  */
 void MSG_vm_shutdown(msg_vm_t vm)
@@ -178,47 +249,10 @@ 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 Migrate the VM to the given host.
  *  @ingroup msg_VMs
  *
- * FIXME: update comments.
- * No migration cost occurs. If you want to simulate this too, you want to use a
+ * 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.
  */
@@ -265,9 +299,7 @@ void MSG_vm_migrate(msg_vm_t vm, msg_host_t destination)
  * 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 suspend to you.
+ * No suspension cost occurs.
  */
 void MSG_vm_suspend(msg_vm_t vm)
 {
@@ -276,25 +308,13 @@ 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 Resume the execution of the VM. All processes on the VM run again.
  *  @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.
+ * No resume cost occurs.
  */
 void MSG_vm_resume(msg_vm_t vm)
 {
@@ -303,42 +323,43 @@ void MSG_vm_resume(msg_vm_t vm)
   #ifdef HAVE_TRACING
   TRACE_msg_vm_resume(vm);
   #endif
+}
 
-#if 0
-  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);
-  }
-#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
 }
 
-//
-///**
-// * \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 Destroy a VM. Destroy the VM object from the simulation.
  *  @ingroup msg_VMs
@@ -354,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
 }