Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'hypervisor' of scm.gforge.inria.fr:/gitroot/simgrid/simgrid into hypervisor
[simgrid.git] / src / surf / vm_workstation.c
1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #include "xbt/ex.h"
8 #include "xbt/dict.h"
9 #include "portable.h"
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 "cpu_cas01_private.h"
15 #include "maxmin_private.h"
16
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_vm_workstation, surf,
18                                 "Logging specific to the SURF VM workstation module");
19
20
21 surf_model_t surf_vm_workstation_model = NULL;
22
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) */
25
26 static void vm_ws_create(const char *name, void *ind_phys_workstation)
27 {
28   workstation_CLM03_t sub_ws = surf_workstation_resource_priv(ind_phys_workstation);
29   const char *sub_ws_name = sub_ws->generic_resource.name;
30
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);
36
37   /* Currently, we assume a VM has no storage. */
38   ws->storage = NULL;
39
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);
48
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. 
52    *
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);
58
59
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;
64
65
66
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);
70
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,
81       surf_cpu_model_vm);
82
83
84
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);
89
90
91   /* TODO:
92    * - check how network requests are scheduled between distinct processes competing for the same card.
93    */
94 }
95
96 /*
97  * Update the physical host of the given VM
98  */
99 static void vm_ws_migrate(void *ind_vm, void *ind_dst_pm)
100
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;
107
108    xbt_assert(ws_vm2013);
109    xbt_assert(ws_clm03_dst);
110
111    /* do something */
112
113    /* update net_elm with that of the destination physical host */
114    void *old_net_elm = ws_vm2013->ws.net_elm;
115    void *new_net_elm = xbt_lib_get_or_null(host_lib, pm_name_dst, ROUTING_HOST_LEVEL);
116    xbt_assert(new_net_elm);
117
118    /* Unregister the current net_elm from host_lib. Do not call the free callback. */
119    xbt_lib_unset(host_lib, vm_name, ROUTING_HOST_LEVEL, 0);
120
121    /* Then, resister the new one. */
122    ws_vm2013->ws.net_elm = new_net_elm;
123    xbt_lib_set(host_lib, vm_name, ROUTING_HOST_LEVEL, ws_vm2013->ws.net_elm);
124
125    ws_vm2013->sub_ws = ws_clm03_dst;
126
127    /* Update vcpu's action for the new pm */
128    {
129 #if 0
130      XBT_INFO("cpu_action->remains %g", ws_vm2013->cpu_action->remains);
131      XBT_INFO("cost %f remains %f start %f finish %f", ws_vm2013->cpu_action->cost,
132          ws_vm2013->cpu_action->remains,
133          ws_vm2013->cpu_action->start,
134          ws_vm2013->cpu_action->finish
135          );
136      XBT_INFO("cpu_action state %d", surf_action_state_get(ws_vm2013->cpu_action));
137 #endif
138
139      /* create a cpu action bound to the pm model at the destination. */
140      surf_action_t new_cpu_action = surf_cpu_model_pm->extension.cpu.execute(ind_dst_pm, 0);
141
142      e_surf_action_state_t state = surf_action_state_get(ws_vm2013->cpu_action);
143      if (state != SURF_ACTION_DONE)
144        XBT_CRITICAL("FIXME: may need a proper handling, %d", state);
145      if (ws_vm2013->cpu_action->remains > 0)
146        XBT_CRITICAL("FIXME: need copy the state(?), %f", ws_vm2013->cpu_action->remains);
147
148      int ret = surf_cpu_model_pm->action_unref(ws_vm2013->cpu_action);
149      xbt_assert(ret == 1, "Bug: some resource still remains");
150
151      ws_vm2013->cpu_action = new_cpu_action;
152    }
153
154    XBT_DEBUG("migrate VM(%s): change net_elm (%p to %p)", vm_name, old_net_elm, new_net_elm);
155    XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name, pm_name_src, pm_name_dst);
156 }
157
158 /*
159  * A physical host does not disapper in the current SimGrid code, but a VM may
160  * disapper during a simulation.
161  */
162 static void vm_ws_destroy(void *ind_vm_workstation)
163
164         /* ind_phys_workstation equals to smx_host_t */
165
166   /* Before clearing the entries in host_lib, we have to pick up resources. */
167         workstation_VM2013_t vm_ws = surf_workstation_resource_priv(ind_vm_workstation);
168   cpu_Cas01_t cpu = surf_cpu_resource_priv(ind_vm_workstation);
169         const char *name = vm_ws->ws.generic_resource.name;
170
171         xbt_assert(vm_ws);
172         xbt_assert(vm_ws->ws.generic_resource.model == surf_vm_workstation_model);
173
174
175   /* We deregister objects from host_lib, without invoking the freeing callback
176    * of each level.
177    *
178    * Do not call xbt_lib_remove() here. It deletes all levels of the key,
179    * including MSG_HOST_LEVEL and others. We should unregister only what we know.
180    */
181   xbt_lib_unset(host_lib, name, SURF_CPU_LEVEL, 0);
182   xbt_lib_unset(host_lib, name, ROUTING_HOST_LEVEL, 0);
183   xbt_lib_unset(host_lib, name, SURF_WKS_LEVEL, 0);
184
185   /* TODO: comment out when VM stroage is implemented. */
186   // xbt_lib_unset(host_lib, name, SURF_STORAGE_LEVEL, 0);
187
188
189   /* Free the cpu_action of the VM. */
190   int ret = surf_cpu_model_pm->action_unref(vm_ws->cpu_action);
191   xbt_assert(ret == 1, "Bug: some resource still remains");
192
193   /* Free the cpu resource of the VM. If using power_trace, we will have to
194    * free other objects than lmm_constraint. */
195   surf_model_t cpu_model = cpu->generic_resource.model;
196   lmm_constraint_free(cpu_model->model_private->maxmin_system, cpu->constraint);
197   surf_resource_free(cpu);
198
199   /* Free the network resource of the VM. */
200         // Nothing has to be done, because net_elmts is just a pointer on the physical one
201
202   /* Free the storage resource of the VM. */
203   // Not relevant yet
204
205         /* Free the workstation resource of the VM. */
206   surf_resource_free(vm_ws);
207 }
208
209 static int vm_ws_get_state(void *ind_vm_ws)
210 {
211         return ((workstation_VM2013_t) surf_workstation_resource_priv(ind_vm_ws))->current_state;
212 }
213
214 static void vm_ws_set_state(void *ind_vm_ws, int state)
215 {
216          ((workstation_VM2013_t) surf_workstation_resource_priv(ind_vm_ws))->current_state = state;
217 }
218
219 static void vm_ws_suspend(void *ind_vm_ws)
220 {
221   workstation_VM2013_t vm_ws = surf_workstation_resource_priv(ind_vm_ws);
222
223   surf_action_suspend(vm_ws->cpu_action);
224
225   vm_ws->current_state = SURF_VM_STATE_SUSPENDED;
226 }
227
228 static void vm_ws_resume(void *ind_vm_ws)
229 {
230   workstation_VM2013_t vm_ws = surf_workstation_resource_priv(ind_vm_ws);
231
232   surf_action_resume(vm_ws->cpu_action);
233
234   vm_ws->current_state = SURF_VM_STATE_RUNNING;
235 }
236
237 static void vm_ws_save(void *ind_vm_ws)
238 {
239   workstation_VM2013_t vm_ws = surf_workstation_resource_priv(ind_vm_ws);
240
241   vm_ws->current_state = SURF_VM_STATE_SAVING;
242
243   /* FIXME: do something here */
244   surf_action_suspend(vm_ws->cpu_action);
245
246   vm_ws->current_state = SURF_VM_STATE_SAVED;
247 }
248
249 static void vm_ws_restore(void *ind_vm_ws)
250 {
251   workstation_VM2013_t vm_ws = surf_workstation_resource_priv(ind_vm_ws);
252
253   vm_ws->current_state = SURF_VM_STATE_RESTORING;
254
255   /* FIXME: do something here */
256   surf_action_resume(vm_ws->cpu_action);
257
258   vm_ws->current_state = SURF_VM_STATE_RUNNING;
259 }
260
261
262 static double get_solved_value(surf_action_t cpu_action)
263 {
264   int found = 0;
265   /* NOTE: Do not use surf_workstation_model's maxmin_system. It is not used. */
266   lmm_system_t pm_system = surf_cpu_model_pm->model_private->maxmin_system;
267   lmm_variable_t var = NULL;
268
269   xbt_swag_foreach(var, &pm_system->variable_set) {
270     XBT_DEBUG("var id %p id_int %d double %f", var->id, var->id_int, var->value);
271     if (var->id == cpu_action) {
272       found = 1;
273       break;
274     }
275   }
276
277   if (found)
278     return var->value;
279
280   XBT_CRITICAL("bug: cannot found the solved variable of the action %p", cpu_action);
281   DIE_IMPOSSIBLE;
282   return -1; /* NOT REACHED */
283 }
284
285
286
287 /* In the real world, processes on the guest operating system will be somewhat
288  * degraded due to virtualization overhead. The total CPU share that these
289  * processes get is smaller than that of the VM process gets on a host
290  * operating system. */
291 const double virt_overhead = 0.95;
292
293 static double vm_ws_share_resources(surf_model_t workstation_model, double now)
294 {
295   /* TODO: udpate action's cost with the total cost of processes on the VM. */
296
297
298   /* 0. Make sure that we already calculated the resource share at the physical
299    * machine layer. */
300   {
301     unsigned int index_of_pm_ws_model = xbt_dynar_search(model_list_invoke, &surf_workstation_model);
302     unsigned int index_of_vm_ws_model = xbt_dynar_search(model_list_invoke, &surf_vm_workstation_model);
303     xbt_assert((index_of_pm_ws_model < index_of_vm_ws_model), "Cannot assume surf_workstation_model comes before");
304  
305     /* Another option is that we call sub_ws->share_resource() here. The
306      * share_resource() function has no side-effect. We can call it here to
307      * ensure that. */
308   }
309
310
311   /* 1. Now we know how many resource should be assigned to each virtual
312    * machine. We update constraints of the virtual machine layer.
313    *
314    *
315    * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
316    *     X1 + X2 = C       (Equation 1)
317    * where
318    *    the resource share of VM1: X1
319    *    the resource share of VM2: X2
320    *    the capacity of PM1: C
321    *
322    * Then, if we have two process (P1 and P2) on VM1.
323    *     X1_1 + X1_2 = X1  (Equation 2)
324    * where
325    *    the resource share of P1: X1_1
326    *    the resource share of P2: X1_2
327    *    the capacity of VM1: X1
328    *
329    * Equation 1 was solved in the physical machine layer.
330    * Equation 2 is solved in the virtual machine layer (here).
331    * X1 must be passed to the virtual machine laye as a constraint value.
332    *
333    **/
334
335   /* iterate for all hosts including virtual machines */
336   xbt_lib_cursor_t cursor;
337   char *key;
338   void **ind_host;
339   xbt_lib_foreach(host_lib, cursor, key, ind_host) {
340     workstation_CLM03_t ws_clm03 = ind_host[SURF_WKS_LEVEL];
341     cpu_Cas01_t cpu_cas01 = ind_host[SURF_CPU_LEVEL];
342
343     if (!ws_clm03)
344       continue;
345     /* skip if it is not a virtual machine */
346     if (ws_clm03->generic_resource.model != surf_vm_workstation_model)
347       continue;
348     xbt_assert(cpu_cas01, "cpu-less workstation");
349
350     /* It is a virtual machine, so we can cast it to workstation_VM2013_t */
351     workstation_VM2013_t ws_vm2013 = (workstation_VM2013_t) ws_clm03;
352
353     double solved_value = get_solved_value(ws_vm2013->cpu_action);
354     XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value,
355         ws_clm03->generic_resource.name, ws_vm2013->sub_ws->generic_resource.name);
356
357     // TODO: check lmm_update_constraint_bound() works fine instead of the below manual substitution.
358     // cpu_cas01->constraint->bound = solved_value;
359     surf_model_t cpu_model = cpu_cas01->generic_resource.model;
360     xbt_assert(cpu_model == surf_cpu_model_vm);
361     lmm_system_t vcpu_system = cpu_model->model_private->maxmin_system;
362     lmm_update_constraint_bound(vcpu_system, cpu_cas01->constraint, virt_overhead * solved_value);
363   }
364
365
366   /* 2. Calculate resource share at the virtual machine layer. */
367   double ret = ws_share_resources(workstation_model, now);
368
369
370   /* FIXME: 3. do we have to re-initialize our cpu_action object? */
371 #if 1
372   /* iterate for all hosts including virtual machines */
373   xbt_lib_foreach(host_lib, cursor, key, ind_host) {
374     workstation_CLM03_t ws_clm03 = ind_host[SURF_WKS_LEVEL];
375
376     /* skip if it is not a virtual machine */
377     if (!ws_clm03)
378       continue;
379     if (ws_clm03->generic_resource.model != surf_vm_workstation_model)
380       continue;
381
382     /* It is a virtual machine, so we can cast it to workstation_VM2013_t */
383     {
384 #if 0
385       workstation_VM2013_t ws_vm2013 = (workstation_VM2013_t) ws_clm03;     
386       XBT_INFO("cost %f remains %f start %f finish %f", ws_vm2013->cpu_action->cost,
387           ws_vm2013->cpu_action->remains,
388           ws_vm2013->cpu_action->start,
389           ws_vm2013->cpu_action->finish
390           );
391 #endif
392 #if 0
393       void *ind_sub_host = xbt_lib_get_elm_or_null(host_lib, ws_vm2013->sub_ws->generic_resource.name);      
394       surf_cpu_model_pm->action_unref(ws_vm2013->cpu_action);
395       /* FIXME: this means busy loop? */
396       // ws_vm2013->cpu_action = surf_cpu_model_pm->extension.cpu.execute(ind_sub_host, GUESTOS_NOISE);
397       ws_vm2013->cpu_action = surf_cpu_model_pm->extension.cpu.execute(ind_sub_host, 0);
398 #endif
399
400     }
401   }
402 #endif
403
404
405   return ret;
406 }
407
408
409 /*
410  * A surf level object will be useless in the upper layer. Returing the
411  * dict_elm of the host.
412  **/
413 static void *vm_ws_get_pm(void *ind_vm_ws)
414 {
415         workstation_VM2013_t vm_ws = surf_workstation_resource_priv(ind_vm_ws);
416   const char *sub_ws_name = vm_ws->sub_ws->generic_resource.name;
417
418   return xbt_lib_get_elm_or_null(host_lib, sub_ws_name);
419 }
420
421
422 /* Adding a task to a VM updates the VCPU task on its physical machine. */
423 static surf_action_t vm_ws_execute(void *workstation, double size)
424 {
425   surf_resource_t ws = ((surf_resource_t) surf_workstation_resource_priv(workstation));
426
427   xbt_assert(ws->model->type == SURF_MODEL_TYPE_VM_WORKSTATION);
428   workstation_VM2013_t vm_ws = (workstation_VM2013_t) ws;
429
430   double old_cost = vm_ws->cpu_action->cost;
431   double new_cost = old_cost + size;
432
433   XBT_DEBUG("VM(%s)@PM(%s): update dummy action's cost (%f -> %f)",
434       ws->name, vm_ws->sub_ws->generic_resource.name,
435       old_cost, new_cost);
436
437   vm_ws->cpu_action->cost = new_cost;
438
439   return ws_execute(workstation, size);
440 }
441
442 static void vm_ws_action_cancel(surf_action_t action)
443 {
444   XBT_CRITICAL("FIXME: Not yet implemented. Reduce dummy action's cost by %f", action->cost);
445
446   ws_action_cancel(action);
447 }
448
449
450 static void surf_vm_workstation_model_init_internal(void)
451 {
452   surf_model_t model = surf_model_init();
453
454   model->name = "Virtual Workstation";
455   model->type = SURF_MODEL_TYPE_VM_WORKSTATION;
456
457   model->action_unref     = ws_action_unref;
458   model->action_cancel    = vm_ws_action_cancel;
459   // model->action_state_set = ws_action_state_set;
460
461
462   model->model_private->share_resources       = vm_ws_share_resources;
463   model->model_private->resource_used         = ws_resource_used;
464   model->model_private->update_actions_state  = ws_update_actions_state;
465   model->model_private->update_resource_state = ws_update_resource_state;
466   model->model_private->finalize              = ws_finalize;
467
468
469   /* operation for an action, not for VM it self */
470   model->suspend          = ws_action_suspend;
471   model->resume           = ws_action_resume;
472 //   model->is_suspended     = ws_action_is_suspended;
473 //   model->set_max_duration = ws_action_set_max_duration;
474   model->set_priority     = ws_action_set_priority;
475   model->set_bound        = ws_action_set_bound;
476 // #ifdef HAVE_TRACING
477 //   model->set_category     = ws_action_set_category;
478 // #endif
479   model->get_remains      = ws_action_get_remains;
480 // #ifdef HAVE_LATENCY_BOUND_TRACKING
481 //   model->get_latency_limited = ws_get_latency_limited;
482 // #endif
483
484
485
486
487
488
489
490   xbt_assert(surf_cpu_model_vm);
491   model->extension.workstation.cpu_model = surf_cpu_model_vm;
492
493   model->extension.workstation.execute   = vm_ws_execute;
494   model->extension.workstation.sleep     = ws_action_sleep;
495   model->extension.workstation.get_state = ws_get_state;
496   model->extension.workstation.get_speed = ws_get_speed;
497   // model->extension.workstation.get_available_speed = ws_get_available_speed;
498
499   // model->extension.workstation.communicate           = ws_communicate;
500   // model->extension.workstation.get_route             = ws_get_route;
501   // model->extension.workstation.execute_parallel_task = ws_execute_parallel_task;
502   // model->extension.workstation.get_link_bandwidth    = ws_get_link_bandwidth;
503   // model->extension.workstation.get_link_latency      = ws_get_link_latency;
504   // model->extension.workstation.link_shared           = ws_link_shared;
505   // model->extension.workstation.get_properties        = ws_get_properties;
506
507   // model->extension.workstation.open   = ws_action_open;
508   // model->extension.workstation.close  = ws_action_close;
509   // model->extension.workstation.read   = ws_action_read;
510   // model->extension.workstation.write  = ws_action_write;
511   // model->extension.workstation.stat   = ws_action_stat;
512   // model->extension.workstation.unlink = ws_action_unlink;
513   // model->extension.workstation.ls     = ws_action_ls;
514
515
516   model->extension.vm_workstation.create        = vm_ws_create;
517   model->extension.vm_workstation.set_state     = vm_ws_set_state;
518   model->extension.vm_workstation.get_state     = vm_ws_get_state;
519   model->extension.vm_workstation.migrate       = vm_ws_migrate;
520   model->extension.vm_workstation.destroy       = vm_ws_destroy;
521   model->extension.vm_workstation.suspend       = vm_ws_suspend;
522   model->extension.vm_workstation.resume        = vm_ws_resume;
523   model->extension.vm_workstation.save          = vm_ws_save;
524   model->extension.vm_workstation.restore       = vm_ws_restore;
525   model->extension.vm_workstation.get_pm        = vm_ws_get_pm;
526
527   model->extension.workstation.set_params    = ws_set_params;
528   model->extension.workstation.get_params    = ws_get_params;
529
530   surf_vm_workstation_model = model;
531 }
532
533 void surf_vm_workstation_model_init(void)
534 {
535   surf_vm_workstation_model_init_internal();
536   xbt_dynar_push(model_list, &surf_vm_workstation_model);
537   xbt_dynar_push(model_list_invoke, &surf_vm_workstation_model);
538 }