src/msg/msg_vm.c

   1 /* Copyright (c) 2012. The SimGrid Team. All rights reserved.               */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "msg_private.h"
   7 #include "xbt/sysdep.h"
   8 #include "xbt/log.h"
   9
  10 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_vm, msg,
  11                                 "Cloud-oriented parts of the MSG API");
  12
  13 /** @brief Create a new (empty) VMs
  14  *  @ingroup msg_VMs
  15  *
  16  *  @bug it is expected that in the future, the coreAmount parameter will be used
  17  *  to add extra constraints on the execution, but the argument is ignored for now.
  18  */
  19
  20 msg_vm_t MSG_vm_start(m_host_t location, int coreAmount) {
  21   msg_vm_t res = xbt_new0(s_msg_vm_t,1);
  22   res->all_vms_hookup.prev = NULL;
  23   res->host_vms_hookup.prev = NULL;
  24   res->state = msg_vm_state_running;
  25   res->location = location;
  26   res->coreAmount = coreAmount;
  27   res->processes = xbt_dynar_new(sizeof(m_process_t),NULL);
  28
  29   xbt_swag_insert(res,msg_global->vms);
  30   xbt_swag_insert(res,location->vms);
  31
  32   return res;
  33 }
  34 /** @brief Returns a newly constructed dynar containing all existing VMs in the system
  35  *  @ingroup msg_VMs
  36  *
  37  * Don't forget to free the dynar after use.
  38  */
  39 xbt_dynar_t MSG_vms_as_dynar(void) {
  40   xbt_dynar_t res = xbt_dynar_new(sizeof(msg_vm_t),NULL);
  41   msg_vm_t vm;
  42   xbt_swag_foreach(vm,msg_global->vms) {
  43     xbt_dynar_push(res,&vm);
  44   }
  45   return res;
  46 }
  47
  48 /** @brief Returns whether the given VM is currently suspended
  49  *  @ingroup msg_VMs
  50  */
  51 int MSG_vm_is_suspended(msg_vm_t vm) {
  52   return vm->state == msg_vm_state_suspended;
  53 }
  54 /** @brief Returns whether the given VM is currently running
  55  *  @ingroup msg_VMs
  56  */
  57 int MSG_vm_is_running(msg_vm_t vm) {
  58   return vm->state == msg_vm_state_running;
  59 }
  60 /** @brief Add the given process into the VM.
  61  *  @ingroup msg_VMs
  62  *
  63  * Afterward, when the VM is migrated or suspended or whatever, the process will have the corresponding handling, too.
  64  *
  65  * @bug for now, if a binded process terminates, every VM functions will segfault. Baaaad.
  66  */
  67 void MSG_vm_bind(msg_vm_t vm, m_process_t process) {
  68   simdata_process_t simdata = simcall_process_get_data(process);
  69   if (!simdata->data) {
  70         simdata->data = xbt_new0(s_msg_process_data_t,1);
  71   }
  72   //If if it is already in a vm, get it out of it
  73   if ( ((msg_process_data_t)(simdata->data))->current_vm) {
  74         msg_vm_t old_vm = ((msg_process_data_t)(simdata->data))->current_vm;
  75     int pos = xbt_dynar_search(old_vm->processes,&process);
  76     xbt_dynar_remove_at(old_vm->processes,pos, NULL);
  77     //If it is on the wrong host, migrate it to the new host
  78     if (vm->location != old_vm->location) {
  79         MSG_process_migrate(process,vm->location);
  80     }
  81   }
  82
  83   ((msg_process_data_t)(simdata->data))->current_vm = vm;
  84
  85         xbt_dynar_push_as(vm->processes,m_process_t,process);
  86 }
  87 /** @brief Removes the given process from the given VM, and kill it
  88  *  @ingroup msg_VMs
  89  *
  90  *  Will raise a not_found exception if the process were not binded to that VM
  91  */
  92 void MSG_vm_unbind(msg_vm_t vm, m_process_t process) {
  93   int pos = xbt_dynar_search(vm->processes,process);
  94   xbt_dynar_remove_at(vm->processes,pos, NULL);
  95   MSG_process_kill(process);
  96 }
  97
  98 /** @brief Immediately change the host on which all processes are running
  99  *  @ingroup msg_VMs
 100  *
 101  * No migration cost occurs. If you want to simulate this too, you want to use a
 102  * MSG_task_send() before or after, depending on whether you want to do cold or hot
 103  * migration.
 104  */
 105 void MSG_vm_migrate(msg_vm_t vm, m_host_t destination) {
 106   unsigned int cpt;
 107   m_process_t process;
 108   xbt_dynar_foreach(vm->processes,cpt,process) {
 109     MSG_process_migrate(process,destination);
 110   }
 111   xbt_swag_remove(vm,vm->location->vms);
 112   xbt_swag_insert_at_tail(vm,destination->vms);
 113   vm->location = destination;
 114 }
 115
 116 /** @brief Immediately suspend the execution of all processes within the given VM
 117  *  @ingroup msg_VMs
 118  *
 119  * No suspension cost occurs. If you want to simulate this too, you want to
 120  * use a \ref MSG_file_write() before or after, depending on the exact semantic
 121  * of VM suspend to you.
 122  */
 123 void MSG_vm_suspend(msg_vm_t vm) {
 124   unsigned int cpt;
 125   m_process_t process;
 126   xbt_dynar_foreach(vm->processes,cpt,process) {
 127         XBT_DEBUG("suspend process %s of host %s",MSG_process_get_name(process),MSG_host_get_name(MSG_process_get_host(process)));
 128     MSG_process_suspend(process);
 129   }
 130 }
 131
 132 /** @brief Immediately resumes the execution of all processes within the given VM
 133  *  @ingroup msg_VMs
 134  *
 135  * No resume cost occurs. If you want to simulate this too, you want to
 136  * use a \ref MSG_file_read() before or after, depending on the exact semantic
 137  * of VM resume to you.
 138  */
 139 void MSG_vm_resume(msg_vm_t vm) {
 140   unsigned int cpt;
 141   m_process_t process;
 142   xbt_dynar_foreach(vm->processes,cpt,process) {
 143     XBT_DEBUG("resume process %s of host %s",MSG_process_get_name(process),MSG_host_get_name(MSG_process_get_host(process)));
 144     MSG_process_resume(process);
 145   }
 146 }
 147
 148 /** @brief Immediately kills all processes within the given VM. Any memory that they allocated will be leaked.
 149  *  @ingroup msg_VMs
 150  *
 151  * No extra delay occurs. If you want to simulate this too, you want to
 152  * use a #MSG_process_sleep() or something. I'm not quite sure.
 153  */
 154 void MSG_vm_shutdown(msg_vm_t vm) {
 155   unsigned int cpt;
 156   m_process_t process;
 157   xbt_dynar_foreach(vm->processes,cpt,process) {
 158     MSG_process_kill(process);
 159   }
 160 }