Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
add vm_suspend stuff
[simgrid.git] / src / msg / msg_vm.c
index 66e1bc7..680dbe5 100644 (file)
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_vm, msg,
                                 "Cloud-oriented parts of the MSG API");
 
-/** @brief Create a new (empty) VMs.
- *  @ingroup msg_VMs
- *
- *  @bug it is expected that in the future, the coreAmount parameter will be used
- *  to add extra constraints on the execution, but the argument is ignored for now.
- */
 
-msg_vm_t MSG_vm_create(msg_host_t location, const char *name,
-                                            int core_nb, int mem_cap, int net_cap){
-
-  // Note new and vm_workstation refer to the same area (due to the lib/dict appraoch)
-  msg_vm_t new = NULL;
-  void *vm_workstation =  NULL;
-  // Ask simix to create the surf vm resource
-  vm_workstation = simcall_vm_create(name,location);
-  new = (msg_vm_t) __MSG_host_create(vm_workstation);
-
-
-  MSG_vm_set_property_value(new, "CORE_NB", bprintf("%d", core_nb)), NULL);
-  MSG_vm_set_property_value(new, "MEM_CAP", bprintf("%d", core_nb)), NULL);
-  MSG_vm_set_property_value(new, "NET_CAP", bprintf("%d", core_nb)), NULL);
-
-  #ifdef HAVE_TRACING
-  TRACE_msg_vm_create(name, location);
-  #endif
-  return new;
-}
+/* **** ******** GENERAL ********* **** */
 
-/** \ingroup m_host_management
- * \brief Returns the value of a given host property
+/** \ingroup m_vm_management
+ * \brief Returns the value of a given vm property
  *
- * \param host a host
+ * \param vm a vm
  * \param name a property name
  * \return value of a property (or NULL if property not set)
  */
-const char *MSG_host_get_property_value(msg_host_t host, const char *name)
+
+const char *MSG_vm_get_property_value(msg_vm_t vm, const char *name)
 {
-  return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
+  return MSG_host_get_property_value(vm, name);
 }
 
-/** \ingroup m_host_management
+/** \ingroup m_vm_management
  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
  *
- * \param host a host
+ * \param vm a vm
  * \return a dict containing the properties
  */
-xbt_dict_t MSG_host_get_properties(msg_host_t host)
+xbt_dict_t MSG_vm_get_properties(msg_vm_t vm)
 {
-  xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
+  xbt_assert((vm != NULL), "Invalid parameters (vm is NULL)");
 
-  return (simcall_host_get_properties(host));
+  return (simcall_host_get_properties(vm));
 }
 
 /** \ingroup m_host_management
@@ -76,17 +52,30 @@ void MSG_vm_set_property_value(msg_vm_t vm, const char *name, void *value,void_f
   xbt_dict_set(MSG_host_get_properties(vm), name, value,free_ctn);
 }
 
-/** @brief Immediately suspend the execution of all processes within the given VM.
- *  @ingroup msg_VMs
- *  return wheter the VM has been correctly started (0) or not (<0)
+/** \ingroup msg_vm_management
+ * \brief Finds a msg_vm_t using its name.
+ *
+ * This is a name directory service
+ * \param name the name of a vm.
+ * \return the corresponding vm
  *
+ * Please note that a VM is a specific host. Hence, you should give a different name
+ * for each VM/PM.
  */
-int MSG_vm_start(msg_vm_t vm) {
- // TODO Please complete the code
 
-  #ifdef HAVE_TRACING
-  TRACE_msg_vm_start(vm);
-  #endif
+msg_vm_t MSG_vm_get_by_name(const char *name){
+       return MSG_get_host_by_name(name);
+}
+
+/** \ingroup m_vm_management
+ *
+ * \brief Return the name of the #msg_host_t.
+ *
+ * This functions checks whether \a host is a valid pointer or not and return
+   its name.
+ */
+const char *MSG_vm_get_name(msg_vm_t vm) {
+  return MSG_host_get_name(vm);
 }
 
 /** @brief Returns a newly constructed dynar containing all existing VMs in the system.
@@ -103,76 +92,143 @@ xbt_dynar_t MSG_vms_as_dynar(void) {
   return res;
 }
 
-/** @brief Returns whether the given VM is currently suspended
- *  @ingroup msg_VMs
- */
-int MSG_vm_is_suspended(msg_vm_t vm) {
-  return vm->state == msg_vm_state_suspended;
-}
-/** @brief Returns whether the given VM is currently running
- *  @ingroup msg_VMs
+/* **** ******** MSG vm actions ********* **** */
+
+/** @brief Create a new VM (the VM is just attached to the location but it is not started yet).
+ *  @ingroup msg_VMs*
+ *
+ * Please note that a VM is a specific host. Hence, you should give a different name
+ * for each VM/PM.
  */
-int MSG_vm_is_running(msg_vm_t vm) {
-  return vm->state == msg_vm_state_running;
+msg_vm_t MSG_vm_create(msg_host_t location, const char *name,
+                                            int core_nb, int mem_cap, int net_cap){
+
+  // Note new and vm_workstation refer to the same area (due to the lib/dict appraoch)
+  msg_vm_t new = NULL;
+  void *vm_workstation =  NULL;
+  // Ask simix to create the surf vm resource
+  vm_workstation = simcall_vm_create(name,location);
+  new = (msg_vm_t) __MSG_host_create(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);
+
+  // TODO check whether the vm (i.e the virtual host) has been correctly added into the list of all hosts.
+
+  #ifdef HAVE_TRACING
+  TRACE_msg_vm_create(name, location);
+  #endif
+
+  return new;
 }
-/** @brief Add the given process into the VM.
+
+/** @brief Start a vm (ie. boot)
  *  @ingroup msg_VMs
  *
- * Afterward, when the VM is migrated or suspended or whatever, the process will have the corresponding handling, too.
+ *  If the VM cannot be started, an exception is generated.
  *
  */
-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;
+void MSG_vm_start(msg_vm_t vm) {
 
-  XBT_DEBUG("binding Process %s to %p",MSG_process_get_name(process),vm);
+  //Please note that vm start can raise an exception if the VM cannot be started.
+  simcall_vm_start(vm);
+
+  #ifdef HAVE_TRACING
+  TRACE_msg_vm_start(vm);
+  #endif
+}
 
-  xbt_dynar_push_as(vm->processes,msg_process_t,process);
+/* **** 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 Removes the given process from the given VM, and kill it
+
+/** @brief Returns whether the given VM is currently suspended
  *  @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);
+int MSG_vm_is_suspended(msg_vm_t vm) {
+       return __MSG_vm_is_state(msg_vm_state_suspended);
 }
-
-/** @brief Immediately change the host on which all processes are running.
+/** @brief Returns whether the given VM is currently 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
+int MSG_vm_is_running(msg_vm_t vm) {
+  return __MSG_vm_is_state(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 */
+  simcall_vm_shutdown(vm);
 
-  vm->location = destination;
+  // #ifdef HAVE_TRACING
+  // TRACE_msg_vm_(vm);
+  // #endif
 }
 
+
+///** @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 Immediately suspend the execution of all processes within the given VM.
  *  @ingroup msg_VMs
  *
@@ -180,86 +236,87 @@ void MSG_vm_migrate(msg_vm_t vm, msg_host_t destination) {
  * use a \ref MSG_file_write() before or after, depending on the exact semantic
  * of VM suspend to you.
  */
-void MSG_vm_suspend(msg_vm_t vm) {
-  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);
-  }
+void MSG_vm_suspend(msg_vm_t vm)
+{
+  simcall_vm_suspend(vm);
 
   #ifdef HAVE_TRACING
   TRACE_msg_vm_suspend(vm);
   #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) {
+#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);
+    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);
   }
-
-  #ifdef HAVE_TRACING
-  TRACE_msg_vm_resume(vm);
-  #endif
+#endif
 }
 
-/** @brief Immediately kills all processes within the given VM. Any memory that they allocated will be leaked.
+//
+//
+///** @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 Destroy a VM. Destroy the VM object from the simulation.
  *  @ingroup msg_VMs
- *
- * 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)
+void MSG_vm_destroy(msg_vm_t vm)
 {
-  msg_process_t process;
-  XBT_DEBUG("%lu processes in the VM", xbt_dynar_length(vm->processes));
-  while (xbt_dynar_length(vm->processes) > 0) {
-    process = xbt_dynar_get_as(vm->processes,0,msg_process_t);
-    MSG_process_kill(process);
-  }
+  /* First, terminate all processes on the VM */
+  simcall_vm_shutdown(vm);
+
+  /* Then, destroy the VM object */
+  simcall_vm_destroy(vm);
 
   #ifdef HAVE_TRACING
-  TRACE_msg_vm_kill(vm);
+  TRACE_msg_vm_end(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 msg_vm_t.
- *  @ingroup msg_VMs
- */
-void MSG_vm_destroy(msg_vm_t vm) {
+#if 0
   unsigned int cpt;
   msg_process_t process;
   xbt_dynar_foreach(vm->processes,cpt,process) {
@@ -268,11 +325,7 @@ void MSG_vm_destroy(msg_vm_t vm) {
     simdata->vm = NULL;
   }
 
-  #ifdef HAVE_TRACING
-  TRACE_msg_vm_end(vm);
-  #endif
-
-
   xbt_dynar_free(&vm->processes);
   xbt_free(vm);
+#endif
 }