1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
10 #include "surf_private.h"
11 #include "surf/surf_resource.h"
12 #include "simgrid/sg_config.h"
13 #include "vm_workstation_private.h"
14 #include "surf/cpu_cas01_private.h"
15 #include "surf/maxmin_private.h"
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_vm_workstation, surf,
18 "Logging specific to the SURF VM workstation module");
21 surf_model_t surf_vm_workstation_model = NULL;
23 /* ind means ''indirect'' that this is a reference on the whole dict_elm
24 * structure (i.e not on the surf_resource_private infos) */
26 static void vm_ws_create(const char *name, void *ind_phys_workstation)
28 workstation_CLM03_t sub_ws = surf_workstation_resource_priv(ind_phys_workstation);
29 const char *sub_ws_name = sub_ws->generic_resource.name;
31 /* The workstation_VM2013 struct inherits the workstation_CLM03 struct. We
32 * create a physical workstation resource, but specifying the size of
33 * s_workstation_VM2013_t and the vm workstation model object. */
34 workstation_CLM03_t ws = (workstation_CLM03_t) surf_resource_new(sizeof(s_workstation_VM2013_t),
35 surf_vm_workstation_model, name, NULL);
37 /* Currently, we assume a VM has no storage. */
40 /* Currently, a VM uses the network resource of its physical host. In
41 * host_lib, this network resource object is refered from two different keys.
42 * When deregistering the reference that points the network resource object
43 * from the VM name, we have to make sure that the system does not call the
44 * free callback for the network resource object. The network resource object
45 * is still used by the physical machine. */
46 ws->net_elm = xbt_lib_get_or_null(host_lib, sub_ws_name, ROUTING_HOST_LEVEL);
47 xbt_lib_set(host_lib, name, ROUTING_HOST_LEVEL, ws->net_elm);
49 /* The SURF_WKS_LEVEL at host_lib saves workstation_CLM03 objects. Please
50 * note workstation_VM2013 objects, inheriting the workstation_CLM03
51 * structure, are also saved there.
53 * If you want to get a workstation_VM2013 object from host_lib, see
54 * ws->generic_resouce.model->type first. If it is
55 * SURF_MODEL_TYPE_VM_WORKSTATION, you can cast ws to vm_ws. */
56 XBT_INFO("Create VM(%s)@PM(%s) with %ld mounted disks", name, sub_ws_name, xbt_dynar_length(ws->storage));
57 xbt_lib_set(host_lib, name, SURF_WKS_LEVEL, ws);
60 /* We initialize the VM-specific members. */
61 workstation_VM2013_t vm_ws = (workstation_VM2013_t) ws;
62 vm_ws->sub_ws = sub_ws;
63 vm_ws->current_state = SURF_VM_STATE_CREATED;
67 // //// CPU RELATED STUFF ////
68 // Roughly, create a vcpu resource by using the values of the sub_cpu one.
69 cpu_Cas01_t sub_cpu = surf_cpu_resource_priv(ind_phys_workstation);
71 /* We can assume one core and cas01 cpu for the first step.
72 * Do xbt_lib_set(host_lib, name, SURF_CPU_LEVEL, cpu) if you get the resource. */
73 cpu_cas01_create_resource(name, // name
74 sub_cpu->power_peak, // host->power_peak,
75 1, // host->power_scale,
76 NULL, // host->power_trace,
77 1, // host->core_amount,
78 SURF_RESOURCE_ON, // host->initial_state,
79 NULL, // host->state_trace,
80 NULL, // host->properties,
85 /* We create cpu_action corresponding to a VM process on the host operating system. */
86 /* FIXME: TODO: we have to peridocally input GUESTOS_NOISE to the system? how ? */
87 // vm_ws->cpu_action = surf_cpu_model_pm->extension.cpu.execute(ind_phys_workstation, GUESTOS_NOISE);
88 vm_ws->cpu_action = surf_cpu_model_pm->extension.cpu.execute(ind_phys_workstation, 0);
92 * - check how network requests are scheduled between distinct processes competing for the same card.
97 * Update the physical host of the given VM
99 static void vm_ws_migrate(void *ind_vm, void *ind_dst_pm)
101 /* ind_phys_workstation equals to smx_host_t */
102 workstation_VM2013_t ws_vm2013 = surf_workstation_resource_priv(ind_vm);
103 workstation_CLM03_t ws_clm03_dst = surf_workstation_resource_priv(ind_dst_pm);
104 const char *vm_name = ws_vm2013->ws.generic_resource.name;
105 const char *pm_name_src = ws_vm2013->sub_ws->generic_resource.name;
106 const char *pm_name_dst = ws_clm03_dst->generic_resource.name;
108 xbt_assert(ws_vm2013);
109 xbt_assert(ws_clm03_dst);
111 ws_vm2013->current_state = SURF_VM_STATE_MIGRATING;
115 /* update net_elm with that of the destination physical host */
116 void *old_net_elm = ws_vm2013->ws.net_elm;
117 void *new_net_elm = xbt_lib_get_or_null(host_lib, pm_name_dst, ROUTING_HOST_LEVEL);
118 xbt_assert(new_net_elm);
120 /* Unregister the current net_elm from host_lib. Do not call the free callback. */
121 xbt_lib_unset(host_lib, vm_name, ROUTING_HOST_LEVEL, 0);
123 /* Then, resister the new one. */
124 ws_vm2013->ws.net_elm = new_net_elm;
125 xbt_lib_set(host_lib, vm_name, ROUTING_HOST_LEVEL, ws_vm2013->ws.net_elm);
127 ws_vm2013->sub_ws = ws_clm03_dst;
129 XBT_DEBUG("migrate VM(%s): change net_elm (%p to %p)", vm_name, old_net_elm, new_net_elm);
130 XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name, pm_name_src, pm_name_dst);
132 ws_vm2013->current_state = SURF_VM_STATE_RUNNING;
136 * A physical host does not disapper in the current SimGrid code, but a VM may
137 * disapper during a simulation.
139 static void vm_ws_destroy(void *ind_vm_workstation)
141 /* ind_phys_workstation equals to smx_host_t */
143 /* Before clearing the entries in host_lib, we have to pick up resources. */
144 workstation_VM2013_t vm_ws = surf_workstation_resource_priv(ind_vm_workstation);
145 cpu_Cas01_t cpu = surf_cpu_resource_priv(ind_vm_workstation);
146 const char *name = vm_ws->ws.generic_resource.name;
147 XBT_INFO("%s", name);
150 xbt_assert(vm_ws->ws.generic_resource.model == surf_vm_workstation_model);
153 /* We deregister objects from host_lib, without invoking the freeing callback
156 * Do not call xbt_lib_remove() here. It deletes all levels of the key,
157 * including MSG_HOST_LEVEL and others. We should unregister only what we know.
159 xbt_lib_unset(host_lib, name, SURF_CPU_LEVEL, 0);
160 xbt_lib_unset(host_lib, name, ROUTING_HOST_LEVEL, 0);
161 xbt_lib_unset(host_lib, name, SURF_WKS_LEVEL, 0);
163 /* TODO: comment out when VM stroage is implemented. */
164 // xbt_lib_unset(host_lib, name, SURF_STORAGE_LEVEL, 0);
167 /* Free the cpu_action of the VM. */
168 int ret = surf_cpu_model_pm->action_unref(vm_ws->cpu_action);
169 xbt_assert(ret == 1, "Bug: some resource still remains");
171 /* Free the cpu resource of the VM. If using power_trace, we will have to
172 * free other objects than lmm_constraint. */
173 surf_model_t cpu_model = cpu->generic_resource.model;
174 lmm_constraint_free(cpu_model->model_private->maxmin_system, cpu->constraint);
175 surf_resource_free(cpu);
177 /* Free the network resource of the VM. */
178 // Nothing has to be done, because net_elmts is just a pointer on the physical one
180 /* Free the storage resource of the VM. */
183 /* Free the workstation resource of the VM. */
184 surf_resource_free(vm_ws);
187 static int vm_ws_get_state(void *ind_vm_ws)
189 return ((workstation_VM2013_t) surf_workstation_resource_priv(ind_vm_ws))->current_state;
192 static void vm_ws_set_state(void *ind_vm_ws, int state)
194 ((workstation_VM2013_t) surf_workstation_resource_priv(ind_vm_ws))->current_state = state;
197 static void vm_ws_suspend(void *ind_vm_ws)
199 workstation_VM2013_t vm_ws = surf_workstation_resource_priv(ind_vm_ws);
201 XBT_INFO("vm %p suspend", ind_vm_ws);
202 surf_action_suspend(vm_ws->cpu_action);
204 vm_ws->current_state = SURF_VM_STATE_SUSPENDED;
207 static void vm_ws_resume(void *ind_vm_ws)
209 workstation_VM2013_t vm_ws = surf_workstation_resource_priv(ind_vm_ws);
211 surf_action_resume(vm_ws->cpu_action);
213 vm_ws->current_state = SURF_VM_STATE_RUNNING;
216 static void vm_ws_save(void *ind_vm_ws)
218 workstation_VM2013_t vm_ws = surf_workstation_resource_priv(ind_vm_ws);
220 vm_ws->current_state = SURF_VM_STATE_SAVING;
222 /* FIXME: do something here */
223 surf_action_suspend(vm_ws->cpu_action);
225 vm_ws->current_state = SURF_VM_STATE_SAVED;
228 static void vm_ws_restore(void *ind_vm_ws)
230 workstation_VM2013_t vm_ws = surf_workstation_resource_priv(ind_vm_ws);
232 vm_ws->current_state = SURF_VM_STATE_RESTORING;
234 /* FIXME: do something here */
235 surf_action_resume(vm_ws->cpu_action);
237 vm_ws->current_state = SURF_VM_STATE_RUNNING;
241 static double get_solved_value(surf_action_t cpu_action)
244 /* NOTE: Do not use surf_workstation_model's maxmin_system. It is not used. */
245 lmm_system_t pm_system = surf_cpu_model_pm->model_private->maxmin_system;
246 lmm_variable_t var = NULL;
248 xbt_swag_foreach(var, &pm_system->variable_set) {
249 XBT_DEBUG("var id %p id_int %d double %f", var->id, var->id_int, var->value);
250 if (var->id == cpu_action) {
259 XBT_CRITICAL("bug: cannot found the solved variable of the action %p", cpu_action);
261 return -1; /* NOT REACHED */
266 /* In the real world, processes on the guest operating system will be somewhat
267 * degraded due to virtualization overhead. The total CPU share that these
268 * processes get is smaller than that of the VM process gets on a host
269 * operating system. */
270 const double virt_overhead = 0.95;
272 static double vm_ws_share_resources(surf_model_t workstation_model, double now)
274 /* TODO: udpate action's cost with the total cost of processes on the VM. */
277 /* 0. Make sure that we already calculated the resource share at the physical
280 unsigned int index_of_pm_ws_model = xbt_dynar_search(model_list_invoke, &surf_workstation_model);
281 unsigned int index_of_vm_ws_model = xbt_dynar_search(model_list_invoke, &surf_vm_workstation_model);
282 xbt_assert((index_of_pm_ws_model < index_of_vm_ws_model), "Cannot assume surf_workstation_model comes before");
284 /* Another option is that we call sub_ws->share_resource() here. The
285 * share_resource() function has no side-effect. We can call it here to
290 /* 1. Now we know how many resource should be assigned to each virtual
291 * machine. We update constraints of the virtual machine layer.
294 * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
295 * X1 + X2 = C (Equation 1)
297 * the resource share of VM1: X1
298 * the resource share of VM2: X2
299 * the capacity of PM1: C
301 * Then, if we have two process (P1 and P2) on VM1.
302 * X1_1 + X1_2 = X1 (Equation 2)
304 * the resource share of P1: X1_1
305 * the resource share of P2: X1_2
306 * the capacity of VM1: X1
308 * Equation 1 was solved in the physical machine layer.
309 * Equation 2 is solved in the virtual machine layer (here).
310 * X1 must be passed to the virtual machine laye as a constraint value.
314 /* iterate for all hosts including virtual machines */
315 xbt_lib_cursor_t cursor;
318 xbt_lib_foreach(host_lib, cursor, key, ind_host) {
319 workstation_CLM03_t ws_clm03 = ind_host[SURF_WKS_LEVEL];
320 cpu_Cas01_t cpu_cas01 = ind_host[SURF_CPU_LEVEL];
324 /* skip if it is not a virtual machine */
325 if (ws_clm03->generic_resource.model != surf_vm_workstation_model)
327 xbt_assert(cpu_cas01, "cpu-less workstation");
329 /* It is a virtual machine, so we can cast it to workstation_VM2013_t */
330 workstation_VM2013_t ws_vm2013 = (workstation_VM2013_t) ws_clm03;
332 double solved_value = get_solved_value(ws_vm2013->cpu_action);
333 XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value,
334 ws_clm03->generic_resource.name, ws_vm2013->sub_ws->generic_resource.name);
336 // TODO: check lmm_update_constraint_bound() works fine instead of the below manual substitution.
337 // cpu_cas01->constraint->bound = solved_value;
338 surf_model_t cpu_model = cpu_cas01->generic_resource.model;
339 xbt_assert(cpu_model == surf_cpu_model_vm);
340 lmm_system_t vcpu_system = cpu_model->model_private->maxmin_system;
341 lmm_update_constraint_bound(vcpu_system, cpu_cas01->constraint, virt_overhead * solved_value);
345 /* 2. Calculate resource share at the virtual machine layer. */
346 double ret = ws_share_resources(workstation_model, now);
349 /* FIXME: 3. do we have to re-initialize our cpu_action object? */
351 /* iterate for all hosts including virtual machines */
352 xbt_lib_foreach(host_lib, cursor, key, ind_host) {
353 workstation_CLM03_t ws_clm03 = ind_host[SURF_WKS_LEVEL];
355 /* skip if it is not a virtual machine */
358 if (ws_clm03->generic_resource.model != surf_vm_workstation_model)
361 /* It is a virtual machine, so we can cast it to workstation_VM2013_t */
362 workstation_VM2013_t ws_vm2013 = (workstation_VM2013_t) ws_clm03;
364 void *ind_sub_host = xbt_lib_get_elm_or_null(host_lib, ws_vm2013->sub_ws->generic_resource.name);
365 XBT_INFO("cost %f remains %f start %f finish %f", ws_vm2013->cpu_action->cost,
366 ws_vm2013->cpu_action->remains,
367 ws_vm2013->cpu_action->start,
368 ws_vm2013->cpu_action->finish
372 surf_cpu_model_pm->action_unref(ws_vm2013->cpu_action);
373 /* FIXME: this means busy loop? */
374 // ws_vm2013->cpu_action = surf_cpu_model_pm->extension.cpu.execute(ind_sub_host, GUESTOS_NOISE);
375 ws_vm2013->cpu_action = surf_cpu_model_pm->extension.cpu.execute(ind_sub_host, 0);
388 * A surf level object will be useless in the upper layer. Returing the
389 * dict_elm of the host.
391 static void *vm_ws_get_pm(void *ind_vm_ws)
393 workstation_VM2013_t vm_ws = surf_workstation_resource_priv(ind_vm_ws);
394 const char *sub_ws_name = vm_ws->sub_ws->generic_resource.name;
396 return xbt_lib_get_elm_or_null(host_lib, sub_ws_name);
401 /* Adding a task to a VM updates the VCPU task on its physical machine. */
402 surf_action_t vm_ws_execute(void *workstation, double size)
404 surf_resource_t ws = ((surf_resource_t) surf_workstation_resource_priv(workstation));
406 xbt_assert(ws->model->type == SURF_MODEL_TYPE_VM_WORKSTATION);
407 workstation_VM2013_t vm_ws = (workstation_VM2013_t) ws;
409 double old_cost = vm_ws->cpu_action->cost;
410 double new_cost = old_cost + size;
412 XBT_INFO("VM(%s)@PM(%s): update dummy action's cost (%f -> %f)",
413 ws->name, vm_ws->sub_ws->generic_resource.name,
416 vm_ws->cpu_action->cost = new_cost;
418 return ws_execute(workstation, size);
421 static void vm_ws_action_cancel(surf_action_t action)
423 XBT_CRITICAL("FIXME: Not yet implemented. Reduce dummy action's cost by %f", action->cost);
425 ws_action_cancel(action);
429 static void surf_vm_workstation_model_init_internal(void)
431 surf_model_t model = surf_model_init();
433 model->name = "Virtual Workstation";
434 model->type = SURF_MODEL_TYPE_VM_WORKSTATION;
436 model->action_unref = ws_action_unref;
437 model->action_cancel = vm_ws_action_cancel;
438 // model->action_state_set = ws_action_state_set;
441 model->model_private->share_resources = vm_ws_share_resources;
442 model->model_private->resource_used = ws_resource_used;
443 model->model_private->update_actions_state = ws_update_actions_state;
444 model->model_private->update_resource_state = ws_update_resource_state;
445 model->model_private->finalize = ws_finalize;
448 /* operation for an action, not for VM it self */
449 model->suspend = ws_action_suspend;
450 model->resume = ws_action_resume;
451 // model->is_suspended = ws_action_is_suspended;
452 // model->set_max_duration = ws_action_set_max_duration;
453 model->set_priority = ws_action_set_priority;
454 // #ifdef HAVE_TRACING
455 // model->set_category = ws_action_set_category;
457 // model->get_remains = ws_action_get_remains;
458 // #ifdef HAVE_LATENCY_BOUND_TRACKING
459 // model->get_latency_limited = ws_get_latency_limited;
468 xbt_assert(surf_cpu_model_vm);
469 model->extension.workstation.cpu_model = surf_cpu_model_vm;
471 model->extension.workstation.execute = vm_ws_execute;
472 model->extension.workstation.sleep = ws_action_sleep;
473 model->extension.workstation.get_state = ws_get_state;
474 // model->extension.workstation.get_speed = ws_get_speed;
475 // model->extension.workstation.get_available_speed = ws_get_available_speed;
477 // model->extension.workstation.communicate = ws_communicate;
478 // model->extension.workstation.get_route = ws_get_route;
479 // model->extension.workstation.execute_parallel_task = ws_execute_parallel_task;
480 // model->extension.workstation.get_link_bandwidth = ws_get_link_bandwidth;
481 // model->extension.workstation.get_link_latency = ws_get_link_latency;
482 // model->extension.workstation.link_shared = ws_link_shared;
483 // model->extension.workstation.get_properties = ws_get_properties;
485 // model->extension.workstation.open = ws_action_open;
486 // model->extension.workstation.close = ws_action_close;
487 // model->extension.workstation.read = ws_action_read;
488 // model->extension.workstation.write = ws_action_write;
489 // model->extension.workstation.stat = ws_action_stat;
490 // model->extension.workstation.unlink = ws_action_unlink;
491 // model->extension.workstation.ls = ws_action_ls;
494 model->extension.vm_workstation.create = vm_ws_create;
495 model->extension.vm_workstation.set_state = vm_ws_set_state;
496 model->extension.vm_workstation.get_state = vm_ws_get_state;
497 model->extension.vm_workstation.migrate = vm_ws_migrate;
498 model->extension.vm_workstation.get_pm = vm_ws_get_pm;
499 model->extension.vm_workstation.destroy = vm_ws_destroy;
500 model->extension.vm_workstation.suspend = vm_ws_suspend;
501 model->extension.vm_workstation.resume = vm_ws_resume;
502 model->extension.vm_workstation.save = vm_ws_save;
503 model->extension.vm_workstation.restore = vm_ws_restore;
505 surf_vm_workstation_model = model;
508 void surf_vm_workstation_model_init(void)
510 surf_vm_workstation_model_init_internal();
511 xbt_dynar_push(model_list, &surf_vm_workstation_model);
512 xbt_dynar_push(model_list_invoke, &surf_vm_workstation_model);