Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge lmm into base to avoid diamond inheritance
[simgrid.git] / src / surf / vm_workstation_hl13.cpp
1 /*
2  * vm_workstation.cpp
3  *
4  *  Created on: Nov 12, 2013
5  *      Author: bedaride
6  */
7 #include "vm_workstation_hl13.hpp"
8 #include "cpu_cas01.hpp"
9
10 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_vm_workstation);
11
12 void surf_vm_workstation_model_init_current_default(void){
13   if (surf_cpu_model_vm) {
14     surf_vm_workstation_model = new WorkstationVMHL13Model();
15     ModelPtr model = static_cast<ModelPtr>(surf_vm_workstation_model);
16
17     xbt_dynar_push(model_list, &model);
18     xbt_dynar_push(model_list_invoke, &model);
19   }
20 }
21
22 /*********
23  * Model *
24  *********/
25
26 WorkstationVMHL13Model::WorkstationVMHL13Model() : WorkstationVMModel() {
27   p_cpuModel = surf_cpu_model_vm;
28 }
29
30 void WorkstationVMHL13Model::updateActionsState(double /*now*/, double /*delta*/){
31   return;
32 }
33
34 xbt_dynar_t WorkstationVMHL13Model::getRoute(WorkstationPtr src, WorkstationPtr dst){
35   XBT_DEBUG("ws_get_route");
36   return surf_network_model->getRoute(src->p_netElm, dst->p_netElm);
37 }
38
39 ActionPtr WorkstationVMHL13Model::communicate(WorkstationPtr src, WorkstationPtr dst, double size, double rate){
40   return surf_network_model->communicate(src->p_netElm, dst->p_netElm, size, rate);
41 }
42
43 /* ind means ''indirect'' that this is a reference on the whole dict_elm
44  * structure (i.e not on the surf_resource_private infos) */
45
46 void WorkstationVMHL13Model::createResource(const char *name, void *ind_phys_workstation)
47 {
48   WorkstationVMHL13Ptr ws = new WorkstationVMHL13(this, name, NULL, static_cast<surf_resource_t>(ind_phys_workstation));
49
50   xbt_lib_set(host_lib, name, SURF_WKS_LEVEL, static_cast<ResourcePtr>(ws));
51
52   /* TODO:
53    * - check how network requests are scheduled between distinct processes competing for the same card.
54    */
55 }
56
57 static inline double get_solved_value(CpuActionPtr cpu_action)
58 {
59   return cpu_action->getVariable()->value;
60 }
61
62 /* In the real world, processes on the guest operating system will be somewhat
63  * degraded due to virtualization overhead. The total CPU share that these
64  * processes get is smaller than that of the VM process gets on a host
65  * operating system. */
66 // const double virt_overhead = 0.95;
67 const double virt_overhead = 1;
68
69 double WorkstationVMHL13Model::shareResources(double now)
70 {
71   /* TODO: udpate action's cost with the total cost of processes on the VM. */
72
73
74   /* 0. Make sure that we already calculated the resource share at the physical
75    * machine layer. */
76   {
77         ModelPtr ws_model = static_cast<ModelPtr>(surf_workstation_model);
78         ModelPtr vm_ws_model = static_cast<ModelPtr>(surf_vm_workstation_model);
79     unsigned int index_of_pm_ws_model = xbt_dynar_search(model_list_invoke, &ws_model);
80     unsigned int index_of_vm_ws_model = xbt_dynar_search(model_list_invoke, &vm_ws_model);
81     xbt_assert((index_of_pm_ws_model < index_of_vm_ws_model), "Cannot assume surf_workstation_model comes before");
82
83     /* Another option is that we call sub_ws->share_resource() here. The
84      * share_resource() function has no side-effect. We can call it here to
85      * ensure that. */
86   }
87
88
89   /* 1. Now we know how many resource should be assigned to each virtual
90    * machine. We update constraints of the virtual machine layer.
91    *
92    *
93    * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
94    *     X1 + X2 = C       (Equation 1)
95    * where
96    *    the resource share of VM1: X1
97    *    the resource share of VM2: X2
98    *    the capacity of PM1: C
99    *
100    * Then, if we have two process (P1 and P2) on VM1.
101    *     X1_1 + X1_2 = X1  (Equation 2)
102    * where
103    *    the resource share of P1: X1_1
104    *    the resource share of P2: X1_2
105    *    the capacity of VM1: X1
106    *
107    * Equation 1 was solved in the physical machine layer.
108    * Equation 2 is solved in the virtual machine layer (here).
109    * X1 must be passed to the virtual machine laye as a constraint value.
110    *
111    **/
112
113   /* iterate for all hosts including virtual machines */
114   xbt_lib_cursor_t cursor;
115   char *key;
116   void **ind_host;
117   xbt_lib_foreach(host_lib, cursor, key, ind_host) {
118     WorkstationPtr ws = dynamic_cast<WorkstationPtr>(
119                                    static_cast<ResourcePtr>(ind_host[SURF_WKS_LEVEL]));
120     CpuPtr cpu = dynamic_cast<CpuPtr>(
121                                static_cast<ResourcePtr>(ind_host[SURF_CPU_LEVEL]));
122
123     if (!ws)
124       continue;
125     /* skip if it is not a virtual machine */
126     if (ws->getModel() != static_cast<ModelPtr>(surf_vm_workstation_model))
127       continue;
128     xbt_assert(cpu, "cpu-less workstation");
129
130     /* It is a virtual machine, so we can cast it to workstation_VM2013_t */
131     WorkstationVMPtr ws_vm = dynamic_cast<WorkstationVMPtr>(ws);
132
133     double solved_value = get_solved_value(reinterpret_cast<CpuActionPtr>(ws_vm->p_action));
134     XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value,
135         ws->getName(), ws_vm->p_subWs->getName());
136
137     // TODO: check lmm_update_constraint_bound() works fine instead of the below manual substitution.
138     // cpu_cas01->constraint->bound = solved_value;
139     xbt_assert(cpu->getModel() == static_cast<ModelPtr>(surf_cpu_model_vm));
140     lmm_system_t vcpu_system = cpu->getModel()->getMaxminSystem();
141     lmm_update_constraint_bound(vcpu_system, cpu->getConstraint(), virt_overhead * solved_value);
142   }
143
144
145   /* 2. Calculate resource share at the virtual machine layer. */
146   adjustWeightOfDummyCpuActions();
147
148   double min_by_cpu = p_cpuModel->shareResources(now);
149   double min_by_net = surf_network_model->shareResources(now);
150   double min_by_sto = -1;
151   if (p_cpuModel == surf_cpu_model_pm)
152         min_by_sto = surf_storage_model->shareResources(now);
153
154   XBT_DEBUG("model %p, %s min_by_cpu %f, %s min_by_net %f, %s min_by_sto %f",
155       this, surf_cpu_model_pm->getName(), min_by_cpu,
156             surf_network_model->getName(), min_by_net,
157             surf_storage_model->getName(), min_by_sto);
158
159   double ret = max(max(min_by_cpu, min_by_net), min_by_sto);
160   if (min_by_cpu >= 0.0 && min_by_cpu < ret)
161         ret = min_by_cpu;
162   if (min_by_net >= 0.0 && min_by_net < ret)
163         ret = min_by_net;
164   if (min_by_sto >= 0.0 && min_by_sto < ret)
165         ret = min_by_sto;
166
167   /* FIXME: 3. do we have to re-initialize our cpu_action object? */
168 #if 0
169   /* iterate for all hosts including virtual machines */
170   xbt_lib_foreach(host_lib, cursor, key, ind_host) {
171     WorkstationCLM03Ptr ws_clm03 = ind_host[SURF_WKS_LEVEL];
172
173     /* skip if it is not a virtual machine */
174     if (!ws_clm03)
175       continue;
176     if (ws_clm03->getModel() != surf_vm_workstation_model)
177       continue;
178
179     /* It is a virtual machine, so we can cast it to workstation_VM2013_t */
180     {
181 #if 0
182       WorkstationVM2013Ptr ws_vm2013 = (workstation_VM2013_t) ws_clm03;
183       XBT_INFO("cost %f remains %f start %f finish %f", ws_vm2013->cpu_action->cost,
184           ws_vm2013->cpu_action->remains,
185           ws_vm2013->cpu_action->start,
186           ws_vm2013->cpu_action->finish
187           );
188 #endif
189 #if 0
190       void *ind_sub_host = xbt_lib_get_elm_or_null(host_lib, ws_vm2013->sub_ws->generic_resource.getName);
191       surf_cpu_model_pm->action_unref(ws_vm2013->cpu_action);
192       /* FIXME: this means busy loop? */
193       // ws_vm2013->cpu_action = surf_cpu_model_pm->extension.cpu.execute(ind_sub_host, GUESTOS_NOISE);
194       ws_vm2013->cpu_action = surf_cpu_model_pm->extension.cpu.execute(ind_sub_host, 0);
195 #endif
196
197     }
198   }
199 #endif
200
201
202   return ret;
203 }
204
205 ActionPtr WorkstationVMHL13Model::executeParallelTask(int workstation_nb,
206                                         void **workstation_list,
207                                         double *computation_amount,
208                                         double *communication_amount,
209                                         double rate){
210 #define cost_or_zero(array,pos) ((array)?(array)[pos]:0.0)
211   if ((workstation_nb == 1)
212       && (cost_or_zero(communication_amount, 0) == 0.0))
213     return ((WorkstationCLM03Ptr)workstation_list[0])->execute(computation_amount[0]);
214   else if ((workstation_nb == 1)
215            && (cost_or_zero(computation_amount, 0) == 0.0))
216     return communicate((WorkstationCLM03Ptr)workstation_list[0], (WorkstationCLM03Ptr)workstation_list[0],communication_amount[0], rate);
217   else if ((workstation_nb == 2)
218              && (cost_or_zero(computation_amount, 0) == 0.0)
219              && (cost_or_zero(computation_amount, 1) == 0.0)) {
220     int i,nb = 0;
221     double value = 0.0;
222
223     for (i = 0; i < workstation_nb * workstation_nb; i++) {
224       if (cost_or_zero(communication_amount, i) > 0.0) {
225         nb++;
226         value = cost_or_zero(communication_amount, i);
227       }
228     }
229     if (nb == 1)
230       return communicate((WorkstationCLM03Ptr)workstation_list[0], (WorkstationCLM03Ptr)workstation_list[1],value, rate);
231   }
232 #undef cost_or_zero
233
234   THROW_UNIMPLEMENTED;          /* This model does not implement parallel tasks */
235   return NULL;
236 }
237
238 /************
239  * Resource *
240  ************/
241
242 WorkstationVMHL13::WorkstationVMHL13(WorkstationVMModelPtr model, const char* name, xbt_dict_t props,
243                                                    surf_resource_t ind_phys_workstation)
244  : WorkstationVM(model, name, props, NULL, NULL)
245 {
246   WorkstationPtr sub_ws = dynamic_cast<WorkstationPtr>(
247                                static_cast<ResourcePtr>(
248                                  surf_workstation_resource_priv(ind_phys_workstation)));
249
250   /* Currently, we assume a VM has no storage. */
251   p_storage = NULL;
252
253   /* Currently, a VM uses the network resource of its physical host. In
254    * host_lib, this network resource object is refered from two different keys.
255    * When deregistering the reference that points the network resource object
256    * from the VM name, we have to make sure that the system does not call the
257    * free callback for the network resource object. The network resource object
258    * is still used by the physical machine. */
259   p_netElm = static_cast<RoutingEdgePtr>(xbt_lib_get_or_null(host_lib, sub_ws->getName(), ROUTING_HOST_LEVEL));
260   xbt_lib_set(host_lib, name, ROUTING_HOST_LEVEL, p_netElm);
261
262   p_subWs = sub_ws;
263   p_currentState = SURF_VM_STATE_CREATED;
264
265   // //// CPU  RELATED STUFF ////
266   // Roughly, create a vcpu resource by using the values of the sub_cpu one.
267   CpuCas01Ptr sub_cpu = dynamic_cast<CpuCas01Ptr>(
268                    static_cast<ResourcePtr>(
269                          surf_cpu_resource_priv(ind_phys_workstation)));
270
271   /* We can assume one core and cas01 cpu for the first step.
272    * Do xbt_lib_set(host_lib, name, SURF_CPU_LEVEL, cpu) if you get the resource. */
273
274   p_cpu = static_cast<CpuCas01ModelPtr>(surf_cpu_model_vm)->createResource(name, // name
275       sub_cpu->p_powerPeakList,        // host->power_peak,
276       sub_cpu->m_pstate,
277       1,                          // host->power_scale,
278       NULL,                       // host->power_trace,
279       1,                          // host->core_amount,
280       SURF_RESOURCE_ON,           // host->initial_state,
281       NULL,                       // host->state_trace,
282       NULL);                       // host->properties,
283
284   /* We create cpu_action corresponding to a VM process on the host operating system. */
285   /* FIXME: TODO: we have to peridocally input GUESTOS_NOISE to the system? how ? */
286   // vm_ws->cpu_action = surf_cpu_model_pm->extension.cpu.execute(ind_phys_workstation, GUESTOS_NOISE);
287   p_action = dynamic_cast<CpuActionPtr>(sub_cpu->execute(0));
288
289   /* The SURF_WKS_LEVEL at host_lib saves workstation_CLM03 objects. Please
290    * note workstation_VM2013 objects, inheriting the workstation_CLM03
291    * structure, are also saved there.
292    *
293    * If you want to get a workstation_VM2013 object from host_lib, see
294    * ws->generic_resouce.model->type first. If it is
295    * SURF_MODEL_TYPE_VM_WORKSTATION, you can cast ws to vm_ws. */
296   XBT_INFO("Create VM(%s)@PM(%s) with %ld mounted disks", name, sub_ws->getName(), xbt_dynar_length(p_storage));
297 }
298
299 /*
300  * A physical host does not disapper in the current SimGrid code, but a VM may
301  * disapper during a simulation.
302  */
303 WorkstationVMHL13::~WorkstationVMHL13()
304 {
305   /* ind_phys_workstation equals to smx_host_t */
306   surf_resource_t ind_vm_workstation = xbt_lib_get_elm_or_null(host_lib, getName());
307
308   /* Before clearing the entries in host_lib, we have to pick up resources. */
309   CpuCas01Ptr cpu = dynamic_cast<CpuCas01Ptr>(
310                     static_cast<ResourcePtr>(
311                       surf_cpu_resource_priv(ind_vm_workstation)));
312
313   /* We deregister objects from host_lib, without invoking the freeing callback
314    * of each level.
315    *
316    * Do not call xbt_lib_remove() here. It deletes all levels of the key,
317    * including MSG_HOST_LEVEL and others. We should unregister only what we know.
318    */
319   xbt_lib_unset(host_lib, getName(), SURF_CPU_LEVEL, 0);
320   xbt_lib_unset(host_lib, getName(), ROUTING_HOST_LEVEL, 0);
321   xbt_lib_unset(host_lib, getName(), SURF_WKS_LEVEL, 0);
322
323   /* TODO: comment out when VM stroage is implemented. */
324   // xbt_lib_unset(host_lib, name, SURF_STORAGE_LEVEL, 0);
325
326
327   /* Free the cpu_action of the VM. */
328   int ret = p_action->unref();
329   xbt_assert(ret == 1, "Bug: some resource still remains");
330
331   /* Free the cpu resource of the VM. If using power_trace, we will have to */
332   delete cpu;
333
334   /* Free the network resource of the VM. */
335         // Nothing has to be done, because net_elmts is just a pointer on the physical one
336
337   /* Free the storage resource of the VM. */
338   // Not relevant yet
339
340         /* Free the workstation resource of the VM. */
341 }
342
343 void WorkstationVMHL13::updateState(tmgr_trace_event_t event_type, double value, double date) {
344   THROW_IMPOSSIBLE;             /* This model does not implement parallel tasks */
345 }
346
347 bool WorkstationVMHL13::isUsed() {
348   THROW_IMPOSSIBLE;             /* This model does not implement parallel tasks */
349   return -1;
350 }
351
352 e_surf_resource_state_t WorkstationVMHL13::getState()
353 {
354   return (e_surf_resource_state_t) p_currentState;
355 }
356
357 void WorkstationVMHL13::setState(e_surf_resource_state_t state)
358 {
359   p_currentState = (e_surf_vm_state_t) state;
360 }
361
362 void WorkstationVMHL13::suspend()
363 {
364   p_action->suspend();
365   p_currentState = SURF_VM_STATE_SUSPENDED;
366 }
367
368 void WorkstationVMHL13::resume()
369 {
370   p_action->resume();
371   p_currentState = SURF_VM_STATE_RUNNING;
372 }
373
374 void WorkstationVMHL13::save()
375 {
376   p_currentState = SURF_VM_STATE_SAVING;
377
378   /* FIXME: do something here */
379   p_action->suspend();
380   p_currentState = SURF_VM_STATE_SAVED;
381 }
382
383 void WorkstationVMHL13::restore()
384 {
385   p_currentState = SURF_VM_STATE_RESTORING;
386
387   /* FIXME: do something here */
388   p_action->resume();
389   p_currentState = SURF_VM_STATE_RUNNING;
390 }
391
392 /*
393  * Update the physical host of the given VM
394  */
395 void WorkstationVMHL13::migrate(surf_resource_t ind_dst_pm)
396 {
397    /* ind_phys_workstation equals to smx_host_t */
398    WorkstationPtr ws_dst = dynamic_cast<WorkstationPtr>(
399                                           static_cast<ResourcePtr>(
400                                            surf_workstation_resource_priv(ind_dst_pm)));
401    const char *vm_name = getName();
402    const char *pm_name_src = p_subWs->getName();
403    const char *pm_name_dst = ws_dst->getName();
404
405    xbt_assert(ws_dst);
406
407    /* do something */
408
409    /* update net_elm with that of the destination physical host */
410    RoutingEdgePtr old_net_elm = p_netElm;
411    RoutingEdgePtr new_net_elm = static_cast<RoutingEdgePtr>(xbt_lib_get_or_null(host_lib, pm_name_dst, ROUTING_HOST_LEVEL));
412    xbt_assert(new_net_elm);
413
414    /* Unregister the current net_elm from host_lib. Do not call the free callback. */
415    xbt_lib_unset(host_lib, vm_name, ROUTING_HOST_LEVEL, 0);
416
417    /* Then, resister the new one. */
418    p_netElm = new_net_elm;
419    xbt_lib_set(host_lib, vm_name, ROUTING_HOST_LEVEL, p_netElm);
420
421    p_subWs = ws_dst;
422
423    /* Update vcpu's action for the new pm */
424    {
425 #if 0
426      XBT_INFO("cpu_action->remains %g", p_action->remains);
427      XBT_INFO("cost %f remains %f start %f finish %f", p_action->cost,
428          p_action->remains,
429          p_action->start,
430          p_action->finish
431          );
432      XBT_INFO("cpu_action state %d", surf_action_get_state(p_action));
433 #endif
434
435      /* create a cpu action bound to the pm model at the destination. */
436      CpuActionPtr new_cpu_action = dynamic_cast<CpuActionPtr>(
437                                             dynamic_cast<CpuCas01Ptr>(
438                                         static_cast<ResourcePtr>(
439                                         surf_cpu_resource_priv(ind_dst_pm)))->execute(0));
440
441      e_surf_action_state_t state = p_action->getState();
442      if (state != SURF_ACTION_DONE)
443        XBT_CRITICAL("FIXME: may need a proper handling, %d", state);
444      if (p_action->getRemains() > 0)
445        XBT_CRITICAL("FIXME: need copy the state(?), %f", p_action->getRemains());
446
447      int ret = p_action->unref();
448      xbt_assert(ret == 1, "Bug: some resource still remains");
449
450      /* keep the bound value of the cpu action of the VM. */
451      double old_bound = p_action->getBound();
452      if (old_bound != 0) {
453        XBT_INFO("migrate VM(%s): set bound (%lf) at %s", vm_name, old_bound, pm_name_dst);
454        new_cpu_action->setBound(old_bound);
455      }
456
457      p_action = new_cpu_action;
458    }
459
460    XBT_DEBUG("migrate VM(%s): change net_elm (%p to %p)", vm_name, old_net_elm, new_net_elm);
461    XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name, pm_name_src, pm_name_dst);
462 }
463
464 void WorkstationVMHL13::setBound(double bound){
465  p_action->setBound(bound);
466 }
467
468 void WorkstationVMHL13::setAffinity(CpuPtr cpu, unsigned long mask){
469  p_action->setAffinity(cpu, mask);
470 }
471
472 /*
473  * A surf level object will be useless in the upper layer. Returing the
474  * dict_elm of the host.
475  **/
476 surf_resource_t WorkstationVMHL13::getPm()
477 {
478   return xbt_lib_get_elm_or_null(host_lib, p_subWs->getName());
479 }
480
481 /* Adding a task to a VM updates the VCPU task on its physical machine. */
482 ActionPtr WorkstationVMHL13::execute(double size)
483 {
484   double old_cost = p_action->getCost();
485   double new_cost = old_cost + size;
486
487   XBT_DEBUG("VM(%s)@PM(%s): update dummy action's cost (%f -> %f)",
488       getName(), p_subWs->getName(),
489       old_cost, new_cost);
490
491   p_action->setCost(new_cost);
492
493   return p_cpu->execute(size);
494 }
495
496 ActionPtr WorkstationVMHL13::sleep(double duration) {
497   return p_cpu->sleep(duration);
498 }
499
500 /**********
501  * Action *
502  **********/
503
504 //FIME:: handle action cancel
505