Logo AND Algorithmique Numérique Distribuée

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