1 /* Copyright (c) 2012. The SimGrid Team. All rights reserved. */
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. */
7 // 1./ check how and where a new VM is added to the list of the hosts
8 // 2./ Diff between SIMIX_Actions and SURF_Actions
9 // => SIMIX_actions : point synchro entre processus de niveau (theoretically speaking I do not have to create such SIMIX_ACTION
13 // MSG_TRACE can be revisited in order to use the host
14 // To implement a mixed model between workstation and vm_workstation,
15 // please give a look at surf_model_private_t model_private at SURF Level and to the share resource functions
16 // double (*share_resources) (double now);
17 // For the action into the vm workstation model, we should be able to leverage the usual one (and if needed, look at
18 // the workstation model.
20 #include "msg_private.h"
21 #include "xbt/sysdep.h"
24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_vm, msg,
25 "Cloud-oriented parts of the MSG API");
28 /* **** ******** GENERAL ********* **** */
30 /** \ingroup m_vm_management
31 * \brief Returns the value of a given vm property
34 * \param name a property name
35 * \return value of a property (or NULL if property not set)
38 const char *MSG_vm_get_property_value(msg_vm_t vm, const char *name)
40 return MSG_host_get_property_value(vm, name);
43 /** \ingroup m_vm_management
44 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
47 * \return a dict containing the properties
49 xbt_dict_t MSG_vm_get_properties(msg_vm_t vm)
51 xbt_assert((vm != NULL), "Invalid parameters (vm is NULL)");
53 return (simcall_host_get_properties(vm));
56 /** \ingroup m_host_management
57 * \brief Change the value of a given host property
60 * \param name a property name
61 * \param value what to change the property to
62 * \param free_ctn the freeing function to use to kill the value on need
64 void MSG_vm_set_property_value(msg_vm_t vm, const char *name, void *value,void_f_pvoid_t free_ctn) {
66 xbt_dict_set(MSG_host_get_properties(vm), name, value,free_ctn);
69 /** \ingroup msg_vm_management
70 * \brief Finds a msg_vm_t using its name.
72 * This is a name directory service
73 * \param name the name of a vm.
74 * \return the corresponding vm
76 * Please note that a VM is a specific host. Hence, you should give a different name
80 msg_vm_t MSG_vm_get_by_name(const char *name){
81 return MSG_get_host_by_name(name);
84 /** \ingroup m_vm_management
86 * \brief Return the name of the #msg_host_t.
88 * This functions checks whether \a host is a valid pointer or not and return
91 const char *MSG_vm_get_name(msg_vm_t vm) {
92 return MSG_host_get_name(vm);
95 /* **** ******** MSG vm actions ********* **** */
97 /** @brief Create a new VM (the VM is just attached to the location but it is not started yet).
100 * Please note that a VM is a specific host. Hence, you should give a different name
103 msg_vm_t MSG_vm_create(msg_host_t ind_host, const char *name,
104 int core_nb, int mem_cap, int net_cap){
106 // Note new and vm_workstation refer to the same area (due to the lib/dict appraoch)
108 void *ind_vm_workstation = NULL;
109 // Ask simix to create the surf vm resource
110 ind_vm_workstation = simcall_vm_ws_create(name,ind_host);
111 new = (msg_vm_t) __MSG_host_create(ind_vm_workstation);
113 MSG_vm_set_property_value(new, "CORE_NB", bprintf("%d", core_nb), free);
114 MSG_vm_set_property_value(new, "MEM_CAP", bprintf("%d", core_nb), free);
115 MSG_vm_set_property_value(new, "NET_CAP", bprintf("%d", core_nb), free);
117 XBT_DEBUG("A new VM has been created");
118 // TODO check whether the vm (i.e the virtual host) has been correctly added into the list of all hosts.
121 TRACE_msg_vm_create(name, ind_host);
127 /** @brief Start a vm (ie. boot)
130 * If the VM cannot be started, an exception is generated.
133 void MSG_vm_start(msg_vm_t vm) {
135 //Please note that vm start can raise an exception if the VM cannot be started.
136 simcall_vm_start(vm);
139 TRACE_msg_vm_start(vm);
143 /* **** Check state of a VM **** */
144 int __MSG_vm_is_state(msg_vm_t vm, e_msg_vm_state_t state) {
145 return simcall_get_vm_state(vm) == state ;
148 /** @brief Returns whether the given VM is currently suspended
151 int MSG_vm_is_suspended(msg_vm_t vm) {
152 return __MSG_vm_is_state(vm, msg_vm_state_suspended);
154 /** @brief Returns whether the given VM is currently running
157 int MSG_vm_is_running(msg_vm_t vm) {
158 return __MSG_vm_is_state(vm, msg_vm_state_running);
161 // TODO Implement the functions for the different state
164 /** @brief Immediately kills all processes within the given VM. Any memory that they allocated will be leaked.
167 * No extra delay occurs. If you want to simulate this too, you want to
168 * use a #MSG_process_sleep() or something. I'm not quite sure.
170 void MSG_vm_shutdown(msg_vm_t vm)
172 /* msg_vm_t equals to msg_host_t */
173 simcall_vm_shutdown(vm);
175 // #ifdef HAVE_TRACING
176 // TRACE_msg_vm_(vm);
181 ///** @brief Add the given process into the VM.
182 // * @ingroup msg_VMs
184 // * Afterward, when the VM is migrated or suspended or whatever, the process will have the corresponding handling, too.
187 //void MSG_vm_bind(msg_vm_t vm, msg_process_t process) {
188 // /* check if the process is already in a VM */
189 // simdata_process_t simdata = simcall_process_get_data(process);
190 // if (simdata->vm) {
191 // msg_vm_t old_vm = simdata->vm;
192 // int pos = xbt_dynar_search(old_vm->processes,&process);
193 // xbt_dynar_remove_at(old_vm->processes,pos, NULL);
195 // /* check if the host is in the right host */
196 // if (simdata->m_host != vm->location) {
197 // MSG_process_migrate(process,vm->location);
201 // XBT_DEBUG("binding Process %s to %p",MSG_process_get_name(process),vm);
203 // xbt_dynar_push_as(vm->processes,msg_process_t,process);
205 ///** @brief Removes the given process from the given VM, and kill it
206 // * @ingroup msg_VMs
208 // * Will raise a not_found exception if the process were not binded to that VM
210 //void MSG_vm_unbind(msg_vm_t vm, msg_process_t process) {
211 // int pos = xbt_dynar_search(vm->processes,process);
212 // xbt_dynar_remove_at(vm->processes,pos, NULL);
213 // MSG_process_kill(process);
217 /** @brief Migrate the VM to the given host.
220 * FIXME: update comments.
221 * No migration cost occurs. If you want to simulate this too, you want to use a
222 * MSG_task_send() before or after, depending on whether you want to do cold or hot
225 void MSG_vm_migrate(msg_vm_t vm, msg_host_t destination)
228 * - One approach is ...
229 * We first create a new VM (i.e., destination VM) on the destination
230 * physical host. The destination VM will receive the state of the source
231 * VM over network. We will finally destroy the source VM.
232 * - This behavior is similar to the way of migration in the real world.
233 * Even before a migration is completed, we will see a destination VM,
234 * consuming resources.
235 * - We have to relocate all processes. The existing process migraion code
236 * will work for this?
237 * - The name of the VM is a somewhat unique ID in the code. It is tricky
238 * for the destination VM?
240 * - Another one is ...
241 * We update the information of the given VM to place it to the destination
244 * The second one would be easier.
249 const char *old_pm_name = simcall_vm_get_phys_host(vm);
250 msg_host_t old_pm_ind = xbt_lib_get_elm_or_null(host_lib, old_pm_name);
253 simcall_vm_migrate(vm, destination);
257 TRACE_msg_vm_change_host(vm, old_pm_ind, destination);
262 msg_process_t process;
263 xbt_dynar_foreach(vm->processes,cpt,process) {
264 MSG_process_migrate(process,destination);
266 xbt_swag_remove(vm, MSG_host_priv(vm->location)->vms);
267 xbt_swag_insert_at_tail(vm, MSG_host_priv(destination)->vms);
269 vm->location = destination;
274 /** @brief Immediately suspend the execution of all processes within the given VM.
277 * No suspension cost occurs. If you want to simulate this too, you want to
278 * use a \ref MSG_file_write() before or after, depending on the exact semantic
279 * of VM suspend to you.
281 void MSG_vm_suspend(msg_vm_t vm)
283 simcall_vm_suspend(vm);
286 TRACE_msg_vm_suspend(vm);
291 msg_process_t process;
292 xbt_dynar_foreach(vm->processes,cpt,process) {
293 XBT_DEBUG("suspend process %s of host %s",MSG_process_get_name(process),MSG_host_get_name(MSG_process_get_host(process)));
294 MSG_process_suspend(process);
301 /** @brief Resume the execution of the VM. All processes on the VM run again.
304 * No resume cost occurs. If you want to simulate this too, you want to
305 * use a \ref MSG_file_read() before or after, depending on the exact semantic
306 * of VM resume to you.
308 void MSG_vm_resume(msg_vm_t vm)
310 simcall_vm_resume(vm);
313 TRACE_msg_vm_resume(vm);
318 msg_process_t process;
319 xbt_dynar_foreach(vm->processes,cpt,process) {
320 XBT_DEBUG("resume process %s of host %s",MSG_process_get_name(process),MSG_host_get_name(MSG_process_get_host(process)));
321 MSG_process_resume(process);
328 // * \ingroup msg_VMs
329 // * \brief Reboot the VM, restarting all the processes in it.
331 //void MSG_vm_reboot(msg_vm_t vm)
333 // xbt_dynar_t new_processes = xbt_dynar_new(sizeof(msg_process_t),NULL);
335 // msg_process_t process;
338 // xbt_dynar_foreach(vm->processes,cpt,process) {
339 // msg_process_t new_process = MSG_process_restart(process);
340 // xbt_dynar_push_as(new_processes,msg_process_t,new_process);
344 // xbt_dynar_foreach(new_processes, cpt, process) {
345 // MSG_vm_bind(vm,process);
348 // xbt_dynar_free(&new_processes);
352 /** @brief Destroy a VM. Destroy the VM object from the simulation.
355 void MSG_vm_destroy(msg_vm_t vm)
357 /* First, terminate all processes on the VM */
358 simcall_vm_shutdown(vm);
360 /* Then, destroy the VM object */
361 simcall_vm_destroy(vm);
364 TRACE_msg_vm_end(vm);
369 msg_process_t process;
370 xbt_dynar_foreach(vm->processes,cpt,process) {
372 simdata_process_t simdata = simcall_process_get_data(process);
376 xbt_dynar_free(&vm->processes);