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);
96 /* **** Check state of a VM **** */
97 static inline int __MSG_vm_is_state(msg_vm_t vm, e_surf_vm_state_t state) {
98 return simcall_vm_get_state(vm) == state;
101 /** @brief Returns whether the given VM has just reated, not running.
104 int MSG_vm_is_created(msg_vm_t vm)
106 return __MSG_vm_is_state(vm, SURF_VM_STATE_CREATED);
109 /** @brief Returns whether the given VM is currently running
112 int MSG_vm_is_running(msg_vm_t vm)
114 return __MSG_vm_is_state(vm, SURF_VM_STATE_RUNNING);
117 /** @brief Returns whether the given VM is currently migrating
120 int MSG_vm_is_migrating(msg_vm_t vm)
122 return __MSG_vm_is_state(vm, SURF_VM_STATE_MIGRATING);
125 /** @brief Returns whether the given VM is currently suspended, not running.
128 int MSG_vm_is_suspended(msg_vm_t vm)
130 return __MSG_vm_is_state(vm, SURF_VM_STATE_SUSPENDED);
133 /** @brief Returns whether the given VM is being saved (FIXME: live saving or not?).
136 int MSG_vm_is_saving(msg_vm_t vm)
138 return __MSG_vm_is_state(vm, SURF_VM_STATE_SAVING);
141 /** @brief Returns whether the given VM has been saved, not running.
144 int MSG_vm_is_saved(msg_vm_t vm)
146 return __MSG_vm_is_state(vm, SURF_VM_STATE_SAVED);
149 /** @brief Returns whether the given VM is being restored, not running.
152 int MSG_vm_is_restoring(msg_vm_t vm)
154 return __MSG_vm_is_state(vm, SURF_VM_STATE_RESTORING);
159 /* ------------------------------------------------------------------------- */
160 /* ------------------------------------------------------------------------- */
162 /* **** ******** MSG vm actions ********* **** */
164 /** @brief Create a new VM with specified parameters.
168 msg_vm_t MSG_vm_create(msg_host_t ind_pm, const char *name,
169 int ncpus, int ramsize, int net_cap, char *disk_path, int disksize)
171 msg_vm_t vm = MSG_vm_create_core(ind_pm, name);
174 s_ws_params_t params;
175 memset(¶ms, 0, sizeof(params));
176 params.ramsize = ramsize;
177 params.overcommit = 0;
178 simcall_host_set_params(vm, ¶ms);
181 /* TODO: We will revisit the disk support later. */
187 /** @brief Create a new VM object. The VM is not yet started. The resource of the VM is allocated upon MSG_vm_start().
190 * A VM is treated as a host. The name of the VM must be unique among all hosts.
192 msg_vm_t MSG_vm_create_core(msg_host_t ind_pm, const char *name)
194 /* make sure the VM of the same name does not exit */
196 void *ind_host_tmp = xbt_lib_get_elm_or_null(host_lib, name);
198 XBT_ERROR("host %s already exits", name);
203 /* Note: ind_vm and vm_workstation point to the same elm object. */
204 msg_vm_t ind_vm = NULL;
205 void *ind_vm_workstation = NULL;
207 // Ask simix to create the surf vm resource
208 ind_vm_workstation = simcall_vm_create(name, ind_pm);
209 ind_vm = (msg_vm_t) __MSG_host_create(ind_vm_workstation);
211 XBT_DEBUG("A new VM (%s) has been created", name);
214 TRACE_msg_vm_create(name, ind_pm);
221 /** @brief Start a vm (ie. boot)
224 * If the VM cannot be started, an exception is generated.
227 void MSG_vm_start(msg_vm_t vm)
229 //Please note that vm start can raise an exception if the VM cannot be started.
230 simcall_vm_start(vm);
233 TRACE_msg_vm_start(vm);
239 /** @brief Immediately kills all processes within the given VM. Any memory that they allocated will be leaked.
242 * FIXME: No extra delay occurs. If you want to simulate this too, you want to
243 * use a #MSG_process_sleep() or something. I'm not quite sure.
245 void MSG_vm_shutdown(msg_vm_t vm)
247 /* msg_vm_t equals to msg_host_t */
248 simcall_vm_shutdown(vm);
250 // #ifdef HAVE_TRACING
251 // TRACE_msg_vm_(vm);
256 /** @brief Migrate the VM to the given host.
259 * FIXME: No migration cost occurs. If you want to simulate this too, you want to use a
260 * MSG_task_send() before or after, depending on whether you want to do cold or hot
263 void MSG_vm_migrate(msg_vm_t vm, msg_host_t new_pm)
266 * - One approach is ...
267 * We first create a new VM (i.e., destination VM) on the destination
268 * physical host. The destination VM will receive the state of the source
269 * VM over network. We will finally destroy the source VM.
270 * - This behavior is similar to the way of migration in the real world.
271 * Even before a migration is completed, we will see a destination VM,
272 * consuming resources.
273 * - We have to relocate all processes. The existing process migraion code
274 * will work for this?
275 * - The name of the VM is a somewhat unique ID in the code. It is tricky
276 * for the destination VM?
278 * - Another one is ...
279 * We update the information of the given VM to place it to the destination
282 * The second one would be easier.
286 msg_host_t old_pm = simcall_vm_get_pm(vm);
288 simcall_vm_migrate(vm, new_pm);
290 XBT_DEBUG("VM(%s) moved from PM(%s) to PM(%s)", vm->key, old_pm->key, new_pm->key);
293 TRACE_msg_vm_change_host(vm, old_pm, new_pm);
298 /** @brief Immediately suspend the execution of all processes within the given VM.
301 * This function stops the exection of the VM. All the processes on this VM
302 * will pause. The state of the VM is perserved. We can later resume it again.
304 * No suspension cost occurs.
306 void MSG_vm_suspend(msg_vm_t vm)
308 simcall_vm_suspend(vm);
310 XBT_DEBUG("vm_suspend done");
313 TRACE_msg_vm_suspend(vm);
318 /** @brief Resume the execution of the VM. All processes on the VM run again.
321 * No resume cost occurs.
323 void MSG_vm_resume(msg_vm_t vm)
325 simcall_vm_resume(vm);
328 TRACE_msg_vm_resume(vm);
333 /** @brief Immediately save the execution of all processes within the given VM.
336 * This function stops the exection of the VM. All the processes on this VM
337 * will pause. The state of the VM is perserved. We can later resume it again.
339 * FIXME: No suspension cost occurs. If you want to simulate this too, you want to
340 * use a \ref MSG_file_write() before or after, depending on the exact semantic
343 void MSG_vm_save(msg_vm_t vm)
347 TRACE_msg_vm_save(vm);
351 /** @brief Restore the execution of the VM. All processes on the VM run again.
354 * FIXME: No restore cost occurs. If you want to simulate this too, you want to
355 * use a \ref MSG_file_read() before or after, depending on the exact semantic
356 * of VM restore to you.
358 void MSG_vm_restore(msg_vm_t vm)
360 simcall_vm_restore(vm);
363 TRACE_msg_vm_restore(vm);
368 /** @brief Destroy a VM. Destroy the VM object from the simulation.
371 void MSG_vm_destroy(msg_vm_t vm)
373 /* First, terminate all processes on the VM if necessary */
374 if (MSG_vm_is_running(vm))
375 simcall_vm_shutdown(vm);
377 if (!MSG_vm_is_created(vm)) {
378 XBT_CRITICAL("shutdown the given VM before destroying it");
382 /* Then, destroy the VM object */
383 simcall_vm_destroy(vm);
385 __MSG_host_destroy(vm);
388 TRACE_msg_vm_end(vm);
393 /** @brief Get the physical host of a givne VM.
396 msg_host_t MSG_vm_get_pm(msg_vm_t vm)
398 return simcall_vm_get_pm(vm);