/* 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. */
+// QUESTIONS:
+// 1./ check how and where a new VM is added to the list of the hosts
+// 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"
#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
+
+/* **** ******** GENERAL ********* **** */
+
+/** \ingroup m_vm_management
+ * \brief Returns the value of a given vm property
*
- * @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.
+ * \param vm a vm
+ * \param name a property name
+ * \return value of a property (or NULL if property not set)
*/
-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);
+const char *MSG_vm_get_property_value(msg_vm_t vm, const char *name)
+{
+ return MSG_host_get_property_value(vm, name);
+}
- xbt_swag_insert(res,msg_global->vms);
- xbt_swag_insert(res,location->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
+ */
+xbt_dict_t MSG_vm_get_properties(msg_vm_t vm)
+{
+ xbt_assert((vm != NULL), "Invalid parameters (vm is NULL)");
- return res;
+ return (simcall_host_get_properties(vm));
}
-/** @brief Returns a newly constructed dynar containing all existing VMs in the system
- * @ingroup msg_VMs
+
+/** \ingroup m_host_management
+ * \brief Change the value of a given host property
*
- * Don't forget to free the dynar after use.
+ * \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
*/
-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;
+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 Returns whether the given VM is currently suspended
+/** \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.
+ */
+
+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);
+}
+
+
+/* **** 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_suspended(msg_vm_t vm) {
- return vm->state == msg_vm_state_suspended;
+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 vm->state == msg_vm_state_running;
+int MSG_vm_is_running(msg_vm_t vm)
+{
+ return __MSG_vm_is_state(vm, SURF_VM_STATE_RUNNING);
}
-/** @brief Add the given process into the VM.
+
+/** @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 with specified parameters.
+ * @ingroup msg_VMs*
*
- * Afterward, when the VM is migrated or suspended or whatever, the process will have the corresponding handling, too.
+ */
+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;
+}
+
+
+/** @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_pm);
+ ind_vm = (msg_vm_t) __MSG_host_create(ind_vm_workstation);
+
+ XBT_DEBUG("A new VM (%s) has been created", name);
+
+ #ifdef HAVE_TRACING
+ TRACE_msg_vm_create(name, ind_pm);
+ #endif
+
+ return ind_vm;
+}
+
+
+/** @brief Start a vm (ie. boot)
+ * @ingroup msg_VMs
+ *
+ * If the VM cannot be started, an exception is generated.
*
- * @bug for now, if a binded process terminates, every VM functions will segfault. Baaaad.
*/
-void MSG_vm_bind(msg_vm_t vm, m_process_t process) {
- xbt_dynar_push_as(vm->processes,m_process_t,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 Removes the given process from the given VM, and kill it
+
+
+
+/** @brief Immediately kills all processes within the given VM. Any memory that they allocated will be leaked.
* @ingroup msg_VMs
*
- * Will raise a not_found exception if the process were not binded to that VM
+ * 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_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);
+void MSG_vm_shutdown(msg_vm_t vm)
+{
+ /* msg_vm_t equals to msg_host_t */
+ simcall_vm_shutdown(vm);
+
+ // #ifdef HAVE_TRACING
+ // TRACE_msg_vm_(vm);
+ // #endif
}
-/** @brief Immediately change the host on which all processes are running
+
+/** @brief Migrate the VM to the given host.
* @ingroup msg_VMs
*
- * 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.
*/
-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;
+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
+ *
+ * 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)
+{
+ simcall_vm_suspend(vm);
+
+ #ifdef HAVE_TRACING
+ TRACE_msg_vm_suspend(vm);
+ #endif
+}
+
+
+/** @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 suspend the execution of all processes within the given VM
+
+/** @brief Immediately save 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
+ * 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.
- */
-void MSG_vm_suspend(msg_vm_t vm) {
- unsigned int cpt;
- m_process_t process;
- xbt_dynar_foreach(vm->processes,cpt,process) {
- XBT_INFO("suspend process %s of host %s",MSG_process_get_name(process),MSG_host_get_name(MSG_process_get_host(process)));
- MSG_process_suspend(process);
- }
+ * 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 Immediately resumes the execution of all processes within the given VM
+/** @brief Restore 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
+ * 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 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_INFO("resume process %s of host %s",MSG_process_get_name(process),MSG_host_get_name(MSG_process_get_host(process)));
- MSG_process_resume(process);
- }
+ * 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 Immediately kills all processes within the given VM. Any memory that they allocated will be leaked.
+
+/** @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) {
- unsigned int cpt;
- m_process_t process;
- xbt_dynar_foreach(vm->processes,cpt,process) {
- MSG_process_kill(process);
- }
+void MSG_vm_destroy(msg_vm_t vm)
+{
+ /* 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_end(vm);
+ #endif
}
