Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Still fixing bugs - Adrien
[simgrid.git] / src / msg / msg_vm.c
index bda366c..be8e935 100644 (file)
@@ -3,6 +3,12 @@
 /* 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
+// 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
+
+
 #include "msg_private.h"
 #include "xbt/sysdep.h"
 #include "xbt/log.h"
 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_start(m_host_t location, int coreAmount) {
-  msg_vm_t res = xbt_new0(s_msg_vm_t,1);
-  res->all_vms_hookup.prev = NULL;
-  res->host_vms_hookup.prev = NULL;
-  res->state = msg_vm_state_running;
-  res->location = location;
-  res->coreAmount = coreAmount;
-  res->processes = xbt_dynar_new(sizeof(m_process_t),NULL);
 
-  xbt_swag_insert(res,msg_global->vms);
-  xbt_swag_insert(res,location->vms);
+/* **** ******** GENERAL ********* **** */
 
-  return res;
-}
-/** @brief Returns a newly constructed dynar containing all existing VMs in the system
- *  @ingroup msg_VMs
+/** \ingroup m_vm_management
+ * \brief Returns the value of a given vm property
  *
- * Don't forget to free the dynar after use.
+ * \param vm a vm
+ * \param name a property name
+ * \return value of a property (or NULL if property not set)
  */
-xbt_dynar_t MSG_vms_as_dynar(void) {
-  xbt_dynar_t res = xbt_dynar_new(sizeof(msg_vm_t),NULL);
-  msg_vm_t vm;
-  xbt_swag_foreach(vm,msg_global->vms) {
-    xbt_dynar_push(res,&vm);
-  }
-  return res;
+
+const char *MSG_vm_get_property_value(msg_vm_t vm, const char *name)
+{
+  return MSG_host_get_property_value(vm, name);
 }
 
-/** @brief Returns whether the given VM is currently suspended
- *  @ingroup msg_VMs
+/** \ingroup m_vm_management
+ * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
+ *
+ * \param vm a vm
+ * \return a dict containing the properties
  */
-int MSG_vm_is_suspended(msg_vm_t vm) {
-  return vm->state == msg_vm_state_suspended;
+xbt_dict_t MSG_vm_get_properties(msg_vm_t vm)
+{
+  xbt_assert((vm != NULL), "Invalid parameters (vm is NULL)");
+
+  return (simcall_host_get_properties(vm));
 }
-/** @brief Returns whether the given VM is currently running
- *  @ingroup msg_VMs
+
+/** \ingroup m_host_management
+ * \brief Change the value of a given host property
+ *
+ * \param host a host
+ * \param name a property name
+ * \param value what to change the property to
+ * \param free_ctn the freeing function to use to kill the value on need
  */
-int MSG_vm_is_running(msg_vm_t vm) {
-  return vm->state == msg_vm_state_running;
+void MSG_vm_set_property_value(msg_vm_t vm, const char *name, void *value,void_f_pvoid_t free_ctn) {
+
+  xbt_dict_set(MSG_host_get_properties(vm), name, value,free_ctn);
 }
-/** @brief Add the given process into the VM.
- *  @ingroup msg_VMs
+
+/** \ingroup msg_vm_management
+ * \brief Finds a msg_vm_t using its name.
  *
- * Afterward, when the VM is migrated or suspended or whatever, the process will have the corresponding handling, too.
+ * This is a name directory service
+ * \param name the name of a vm.
+ * \return the corresponding vm
  *
- * @bug for now, if a binded process terminates, every VM functions will segfault. Baaaad.
+ * Please note that a VM is a specific host. Hence, you should give a different name
+ * for each VM/PM.
  */
-void MSG_vm_bind(msg_vm_t vm, m_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,m_process_t,process);
+
+msg_vm_t MSG_vm_get_by_name(const char *name){
+       return MSG_get_host_by_name(name);
 }
-/** @brief Removes the given process from the given VM, and kill it
- *  @ingroup msg_VMs
+
+/** \ingroup m_vm_management
+ *
+ * \brief Return the name of the #msg_host_t.
  *
- *  Will raise a not_found exception if the process were not binded to that VM
+ * This functions checks whether \a host is a valid pointer or not and return
+   its name.
  */
-void MSG_vm_unbind(msg_vm_t vm, m_process_t process) {
-  int pos = xbt_dynar_search(vm->processes,process);
-  xbt_dynar_remove_at(vm->processes,pos, NULL);
-  MSG_process_kill(process);
+const char *MSG_vm_get_name(msg_vm_t vm) {
+  return MSG_host_get_name(vm);
 }
 
-/** @brief Immediately change the host on which all processes are 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*
  *
- * 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.
+ * Please note that a VM is a specific host. Hence, you should give a different name
+ * for each VM/PM.
  */
-void MSG_vm_migrate(msg_vm_t vm, m_host_t destination) {
-  unsigned int cpt;
-  m_process_t process;
-  xbt_dynar_foreach(vm->processes,cpt,process) {
-    MSG_process_migrate(process,destination);
-  }
-  xbt_swag_remove(vm,vm->location->vms);
-  xbt_swag_insert_at_tail(vm,destination->vms);
-  vm->location = destination;
+msg_vm_t MSG_vm_create(msg_host_t ind_host, 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 *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);
+
+  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.
+
+  #ifdef HAVE_TRACING
+  TRACE_msg_vm_create(name, ind_host);
+  #endif
+
+  return new;
 }
 
-/** @brief Immediately suspend the execution of all processes within the given VM
+/** @brief Start a vm (ie. boot)
  *  @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.
+ *  If the VM cannot be started, an exception is generated.
+ *
  */
-void MSG_vm_suspend(msg_vm_t vm) {
-  unsigned int cpt;
-  m_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_start(msg_vm_t 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
 }
 
-/** @brief Immediately resumes the execution of all processes within the given VM
+/* **** 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
- *
- * 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;
-  m_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);
-  }
+int MSG_vm_is_suspended(msg_vm_t vm) {
+       return __MSG_vm_is_state(vm, msg_vm_state_suspended);
 }
-
-/** @brief Immediately kills all processes within the given VM. Any memory that they allocated will be leaked.
+/** @brief Returns whether the given VM is currently running
  *  @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.
  */
+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)
 {
-  m_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,m_process_t);
-       MSG_process_kill(process);
-  }
-}
+  /* msg_vm_t equals to msg_host_t */
+  simcall_vm_shutdown(vm);
+
+  /* taka: not yet confirmed */
+  #ifdef HAVE_TRACING
+  TRACE_msg_vm_kill(vm);
+  #endif
 
-/** @brief Destroy a msg_vm_t.
- *  @ingroup msg_VMs
- */
-void MSG_vm_destroy(msg_vm_t vm) {
-       unsigned int cpt;
-       m_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);
 }
+
+
+///** @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
+// *
+// * 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.
+// */
+//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);
+//  }
+//
+//  #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) {
+//  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 msg_vm_t.
+// *  @ingroup msg_VMs
+// */
+//void MSG_vm_destroy(msg_vm_t vm)
+//{
+//  simcall_vm_destroy(vm);
+//
+//#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;
+//  }
+//
+//  #ifdef HAVE_TRACING
+//  TRACE_msg_vm_end(vm);
+//  #endif
+//
+//
+//  xbt_dynar_free(&vm->processes);
+//  xbt_free(vm);
+//#endif
+//}