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         /* check if the process is already in a VM */
  69         simdata_process_t simdata = simcall_process_get_data(process);
  70         if (simdata->vm) {
  71                 msg_vm_t old_vm = simdata->vm;
  72                 int pos = xbt_dynar_search(old_vm->processes,&process);
  73                 xbt_dynar_remove_at(old_vm->processes,pos, NULL);
  74         }
  75         /* check if the host is in the right host */
  76         if (simdata->m_host != vm->location) {
  77                 MSG_process_migrate(process,vm->location);
  78         }
  79         simdata->vm = vm;
  80
  81   xbt_dynar_push_as(vm->processes,m_process_t,process);
  82 }
  83 /** @brief Removes the given process from the given VM, and kill it
  84  *  @ingroup msg_VMs
  85  *
  86  *  Will raise a not_found exception if the process were not binded to that VM
  87  */
  88 void MSG_vm_unbind(msg_vm_t vm, m_process_t process) {
  89   int pos = xbt_dynar_search(vm->processes,process);
  90   xbt_dynar_remove_at(vm->processes,pos, NULL);
  91   MSG_process_kill(process);
  92 }
  93
  94 /** @brief Immediately change the host on which all processes are running
  95  *  @ingroup msg_VMs
  96  *
  97  * No migration cost occurs. If you want to simulate this too, you want to use a
  98  * MSG_task_send() before or after, depending on whether you want to do cold or hot
  99  * migration.
 100  */
 101 void MSG_vm_migrate(msg_vm_t vm, m_host_t destination) {
 102   unsigned int cpt;
 103   m_process_t process;
 104   xbt_dynar_foreach(vm->processes,cpt,process) {
 105     MSG_process_migrate(process,destination);
 106   }
 107   xbt_swag_remove(vm,vm->location->vms);
 108   xbt_swag_insert_at_tail(vm,destination->vms);
 109   vm->location = destination;
 110 }
 111
 112 /** @brief Immediately suspend the execution of all processes within the given VM
 113  *  @ingroup msg_VMs
 114  *
 115  * No suspension cost occurs. If you want to simulate this too, you want to
 116  * use a \ref MSG_file_write() before or after, depending on the exact semantic
 117  * of VM suspend to you.
 118  */
 119 void MSG_vm_suspend(msg_vm_t vm) {
 120   unsigned int cpt;
 121   m_process_t process;
 122   xbt_dynar_foreach(vm->processes,cpt,process) {
 123     XBT_DEBUG("suspend process %s of host %s",MSG_process_get_name(process),MSG_host_get_name(MSG_process_get_host(process)));
 124     MSG_process_suspend(process);
 125   }
 126 }
 127
 128 /** @brief Immediately resumes the execution of all processes within the given VM
 129  *  @ingroup msg_VMs
 130  *
 131  * No resume cost occurs. If you want to simulate this too, you want to
 132  * use a \ref MSG_file_read() before or after, depending on the exact semantic
 133  * of VM resume to you.
 134  */
 135 void MSG_vm_resume(msg_vm_t vm) {
 136   unsigned int cpt;
 137   m_process_t process;
 138   xbt_dynar_foreach(vm->processes,cpt,process) {
 139         XBT_DEBUG("resume process %s of host %s",MSG_process_get_name(process),MSG_host_get_name(MSG_process_get_host(process)));
 140     MSG_process_resume(process);
 141   }
 142 }
 143
 144 /** @brief Immediately kills all processes within the given VM. Any memory that they allocated will be leaked.
 145  *  @ingroup msg_VMs
 146  *
 147  * No extra delay occurs. If you want to simulate this too, you want to
 148  * use a #MSG_process_sleep() or something. I'm not quite sure.
 149  */
 150 void MSG_vm_shutdown(msg_vm_t vm) {
 151   unsigned int cpt;
 152   m_process_t process;
 153   xbt_dynar_foreach(vm->processes,cpt,process) {
 154         MSG_process_kill(process);
 155   }
 156 }