1 /* Copyright (c) 2013-2014. 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. */
7 #include "vm_workstation_hl13.hpp"
8 #include "cpu_cas01.hpp"
10 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_vm_workstation);
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);
17 xbt_dynar_push(model_list, &model);
18 xbt_dynar_push(model_list_invoke, &model);
26 WorkstationVMHL13Model::WorkstationVMHL13Model() : WorkstationVMModel() {
27 p_cpuModel = surf_cpu_model_vm;
30 void WorkstationVMHL13Model::updateActionsState(double /*now*/, double /*delta*/){
34 ActionPtr WorkstationVMHL13Model::communicate(WorkstationPtr src, WorkstationPtr dst, double size, double rate){
35 return surf_network_model->communicate(src->p_netElm, dst->p_netElm, size, rate);
38 /* ind means ''indirect'' that this is a reference on the whole dict_elm
39 * structure (i.e not on the surf_resource_private infos) */
41 void WorkstationVMHL13Model::createResource(const char *name, void *ind_phys_workstation)
43 WorkstationVMHL13Ptr ws = new WorkstationVMHL13(this, name, NULL, static_cast<surf_resource_t>(ind_phys_workstation));
45 xbt_lib_set(host_lib, name, SURF_WKS_LEVEL, static_cast<ResourcePtr>(ws));
48 * - check how network requests are scheduled between distinct processes competing for the same card.
52 static inline double get_solved_value(CpuActionPtr cpu_action)
54 return cpu_action->getVariable()->value;
57 /* In the real world, processes on the guest operating system will be somewhat
58 * degraded due to virtualization overhead. The total CPU share that these
59 * processes get is smaller than that of the VM process gets on a host
60 * operating system. */
61 // const double virt_overhead = 0.95;
62 const double virt_overhead = 1;
64 double WorkstationVMHL13Model::shareResources(double now)
66 /* TODO: udpate action's cost with the total cost of processes on the VM. */
69 /* 0. Make sure that we already calculated the resource share at the physical
72 ModelPtr ws_model = static_cast<ModelPtr>(surf_workstation_model);
73 ModelPtr vm_ws_model = static_cast<ModelPtr>(surf_vm_workstation_model);
74 unsigned int index_of_pm_ws_model = xbt_dynar_search(model_list_invoke, &ws_model);
75 unsigned int index_of_vm_ws_model = xbt_dynar_search(model_list_invoke, &vm_ws_model);
76 xbt_assert((index_of_pm_ws_model < index_of_vm_ws_model), "Cannot assume surf_workstation_model comes before");
78 /* Another option is that we call sub_ws->share_resource() here. The
79 * share_resource() function has no side-effect. We can call it here to
84 /* 1. Now we know how many resource should be assigned to each virtual
85 * machine. We update constraints of the virtual machine layer.
88 * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
89 * X1 + X2 = C (Equation 1)
91 * the resource share of VM1: X1
92 * the resource share of VM2: X2
93 * the capacity of PM1: C
95 * Then, if we have two process (P1 and P2) on VM1.
96 * X1_1 + X1_2 = X1 (Equation 2)
98 * the resource share of P1: X1_1
99 * the resource share of P2: X1_2
100 * the capacity of VM1: X1
102 * Equation 1 was solved in the physical machine layer.
103 * Equation 2 is solved in the virtual machine layer (here).
104 * X1 must be passed to the virtual machine laye as a constraint value.
108 /* iterate for all virtual machines */
109 for (WorkstationVMModel::vm_list_t::iterator iter =
110 WorkstationVMModel::ws_vms.begin();
111 iter != WorkstationVMModel::ws_vms.end(); ++iter) {
113 WorkstationVMPtr ws_vm = &*iter;
114 CpuPtr cpu = static_cast<CpuPtr>(ws_vm->p_cpu);
115 xbt_assert(cpu, "cpu-less workstation");
117 double solved_value = get_solved_value(static_cast<CpuActionPtr>(ws_vm->p_action));
118 XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value,
119 ws_vm->getName(), ws_vm->p_subWs->getName());
121 // TODO: check lmm_update_constraint_bound() works fine instead of the below manual substitution.
122 // cpu_cas01->constraint->bound = solved_value;
123 xbt_assert(cpu->getModel() == static_cast<ModelPtr>(surf_cpu_model_vm));
124 lmm_system_t vcpu_system = cpu->getModel()->getMaxminSystem();
125 lmm_update_constraint_bound(vcpu_system, cpu->getConstraint(), virt_overhead * solved_value);
129 /* 2. Calculate resource share at the virtual machine layer. */
130 adjustWeightOfDummyCpuActions();
132 double min_by_cpu = p_cpuModel->shareResources(now);
133 double min_by_net = (strcmp(surf_network_model->getName(), "network NS3")) ? surf_network_model->shareResources(now) : -1;
134 double min_by_sto = -1;
135 if (p_cpuModel == surf_cpu_model_pm)
136 min_by_sto = surf_storage_model->shareResources(now);
138 XBT_DEBUG("model %p, %s min_by_cpu %f, %s min_by_net %f, %s min_by_sto %f",
139 this, surf_cpu_model_pm->getName(), min_by_cpu,
140 surf_network_model->getName(), min_by_net,
141 surf_storage_model->getName(), min_by_sto);
143 double ret = max(max(min_by_cpu, min_by_net), min_by_sto);
144 if (min_by_cpu >= 0.0 && min_by_cpu < ret)
146 if (min_by_net >= 0.0 && min_by_net < ret)
148 if (min_by_sto >= 0.0 && min_by_sto < ret)
151 /* FIXME: 3. do we have to re-initialize our cpu_action object? */
153 /* iterate for all virtual machines */
154 for (WorkstationVMModel::vm_list_t::iterator iter =
155 WorkstationVMModel::ws_vms.begin();
156 iter != WorkstationVMModel::ws_vms.end(); ++iter) {
160 WorkstationVM2013Ptr ws_vm2013 = static_cast<WorkstationVM2013Ptr>(&*iter);
161 XBT_INFO("cost %f remains %f start %f finish %f", ws_vm2013->cpu_action->cost,
162 ws_vm2013->cpu_action->remains,
163 ws_vm2013->cpu_action->start,
164 ws_vm2013->cpu_action->finish
168 void *ind_sub_host = xbt_lib_get_elm_or_null(host_lib, ws_vm2013->sub_ws->generic_resource.getName);
169 surf_cpu_model_pm->action_unref(ws_vm2013->cpu_action);
170 /* FIXME: this means busy loop? */
171 // ws_vm2013->cpu_action = surf_cpu_model_pm->extension.cpu.execute(ind_sub_host, GUESTOS_NOISE);
172 ws_vm2013->cpu_action = surf_cpu_model_pm->extension.cpu.execute(ind_sub_host, 0);
183 ActionPtr WorkstationVMHL13Model::executeParallelTask(int workstation_nb,
184 void **workstation_list,
185 double *computation_amount,
186 double *communication_amount,
188 #define cost_or_zero(array,pos) ((array)?(array)[pos]:0.0)
189 if ((workstation_nb == 1)
190 && (cost_or_zero(communication_amount, 0) == 0.0))
191 return ((WorkstationCLM03Ptr)workstation_list[0])->execute(computation_amount[0]);
192 else if ((workstation_nb == 1)
193 && (cost_or_zero(computation_amount, 0) == 0.0))
194 return communicate((WorkstationCLM03Ptr)workstation_list[0], (WorkstationCLM03Ptr)workstation_list[0],communication_amount[0], rate);
195 else if ((workstation_nb == 2)
196 && (cost_or_zero(computation_amount, 0) == 0.0)
197 && (cost_or_zero(computation_amount, 1) == 0.0)) {
201 for (i = 0; i < workstation_nb * workstation_nb; i++) {
202 if (cost_or_zero(communication_amount, i) > 0.0) {
204 value = cost_or_zero(communication_amount, i);
208 return communicate((WorkstationCLM03Ptr)workstation_list[0], (WorkstationCLM03Ptr)workstation_list[1],value, rate);
212 THROW_UNIMPLEMENTED; /* This model does not implement parallel tasks */
220 WorkstationVMHL13::WorkstationVMHL13(WorkstationVMModelPtr model, const char* name, xbt_dict_t props,
221 surf_resource_t ind_phys_workstation)
222 : WorkstationVM(model, name, props, NULL, NULL)
224 WorkstationPtr sub_ws = static_cast<WorkstationPtr>(surf_workstation_resource_priv(ind_phys_workstation));
226 /* Currently, we assume a VM has no storage. */
229 /* Currently, a VM uses the network resource of its physical host. In
230 * host_lib, this network resource object is refered from two different keys.
231 * When deregistering the reference that points the network resource object
232 * from the VM name, we have to make sure that the system does not call the
233 * free callback for the network resource object. The network resource object
234 * is still used by the physical machine. */
235 p_netElm = static_cast<RoutingEdgePtr>(xbt_lib_get_or_null(host_lib, sub_ws->getName(), ROUTING_HOST_LEVEL));
236 xbt_lib_set(host_lib, name, ROUTING_HOST_LEVEL, p_netElm);
239 p_currentState = SURF_VM_STATE_CREATED;
241 // //// CPU RELATED STUFF ////
242 // Roughly, create a vcpu resource by using the values of the sub_cpu one.
243 CpuCas01Ptr sub_cpu = static_cast<CpuCas01Ptr>(surf_cpu_resource_priv(ind_phys_workstation));
245 /* We can assume one core and cas01 cpu for the first step.
246 * Do xbt_lib_set(host_lib, name, SURF_CPU_LEVEL, cpu) if you get the resource. */
248 p_cpu = static_cast<CpuCas01ModelPtr>(surf_cpu_model_vm)->createResource(name, // name
249 sub_cpu->getPowerPeakList(), // host->power_peak,
250 sub_cpu->getPState(),
251 1, // host->power_scale,
252 NULL, // host->power_trace,
253 1, // host->core_amount,
254 SURF_RESOURCE_ON, // host->initial_state,
255 NULL, // host->state_trace,
256 NULL); // host->properties,
258 /* We create cpu_action corresponding to a VM process on the host operating system. */
259 /* FIXME: TODO: we have to peridocally input GUESTOS_NOISE to the system? how ? */
260 // vm_ws->cpu_action = surf_cpu_model_pm->extension.cpu.execute(ind_phys_workstation, GUESTOS_NOISE);
261 p_action = static_cast<CpuActionPtr>(sub_cpu->execute(0));
263 /* The SURF_WKS_LEVEL at host_lib saves workstation_CLM03 objects. Please
264 * note workstation_VM2013 objects, inheriting the workstation_CLM03
265 * structure, are also saved there.
267 * If you want to get a workstation_VM2013 object from host_lib, see
268 * ws->generic_resouce.model->type first. If it is
269 * SURF_MODEL_TYPE_VM_WORKSTATION, you can cast ws to vm_ws. */
270 XBT_INFO("Create VM(%s)@PM(%s) with %ld mounted disks", name, sub_ws->getName(), xbt_dynar_length(p_storage));
274 * A physical host does not disapper in the current SimGrid code, but a VM may
275 * disapper during a simulation.
277 WorkstationVMHL13::~WorkstationVMHL13()
279 /* ind_phys_workstation equals to smx_host_t */
280 surf_resource_t ind_vm_workstation = xbt_lib_get_elm_or_null(host_lib, getName());
282 /* Before clearing the entries in host_lib, we have to pick up resources. */
283 CpuCas01Ptr cpu = static_cast<CpuCas01Ptr>(surf_cpu_resource_priv(ind_vm_workstation));
285 /* We deregister objects from host_lib, without invoking the freeing callback
288 * Do not call xbt_lib_remove() here. It deletes all levels of the key,
289 * including MSG_HOST_LEVEL and others. We should unregister only what we know.
291 xbt_lib_unset(host_lib, getName(), SURF_CPU_LEVEL, 0);
292 xbt_lib_unset(host_lib, getName(), ROUTING_HOST_LEVEL, 0);
293 xbt_lib_unset(host_lib, getName(), SURF_WKS_LEVEL, 0);
295 /* TODO: comment out when VM stroage is implemented. */
296 // xbt_lib_unset(host_lib, name, SURF_STORAGE_LEVEL, 0);
299 /* Free the cpu_action of the VM. */
300 int ret = p_action->unref();
301 xbt_assert(ret == 1, "Bug: some resource still remains");
303 /* Free the cpu resource of the VM. If using power_trace, we will have to */
306 /* Free the network resource of the VM. */
307 // Nothing has to be done, because net_elmts is just a pointer on the physical one
309 /* Free the storage resource of the VM. */
312 /* Free the workstation resource of the VM. */
315 void WorkstationVMHL13::updateState(tmgr_trace_event_t /*event_type*/, double /*value*/, double /*date*/) {
316 THROW_IMPOSSIBLE; /* This model does not implement parallel tasks */
319 bool WorkstationVMHL13::isUsed() {
320 THROW_IMPOSSIBLE; /* This model does not implement parallel tasks */
324 e_surf_resource_state_t WorkstationVMHL13::getState()
326 return (e_surf_resource_state_t) p_currentState;
329 void WorkstationVMHL13::setState(e_surf_resource_state_t state)
331 p_currentState = (e_surf_vm_state_t) state;
334 void WorkstationVMHL13::suspend()
337 p_currentState = SURF_VM_STATE_SUSPENDED;
340 void WorkstationVMHL13::resume()
343 p_currentState = SURF_VM_STATE_RUNNING;
346 void WorkstationVMHL13::save()
348 p_currentState = SURF_VM_STATE_SAVING;
350 /* FIXME: do something here */
352 p_currentState = SURF_VM_STATE_SAVED;
355 void WorkstationVMHL13::restore()
357 p_currentState = SURF_VM_STATE_RESTORING;
359 /* FIXME: do something here */
361 p_currentState = SURF_VM_STATE_RUNNING;
365 * Update the physical host of the given VM
367 void WorkstationVMHL13::migrate(surf_resource_t ind_dst_pm)
369 /* ind_phys_workstation equals to smx_host_t */
370 WorkstationPtr ws_dst = static_cast<WorkstationPtr>(surf_workstation_resource_priv(ind_dst_pm));
371 const char *vm_name = getName();
372 const char *pm_name_src = p_subWs->getName();
373 const char *pm_name_dst = ws_dst->getName();
379 /* update net_elm with that of the destination physical host */
380 RoutingEdgePtr old_net_elm = p_netElm;
381 RoutingEdgePtr new_net_elm = static_cast<RoutingEdgePtr>(xbt_lib_get_or_null(host_lib, pm_name_dst, ROUTING_HOST_LEVEL));
382 xbt_assert(new_net_elm);
384 /* Unregister the current net_elm from host_lib. Do not call the free callback. */
385 xbt_lib_unset(host_lib, vm_name, ROUTING_HOST_LEVEL, 0);
387 /* Then, resister the new one. */
388 p_netElm = new_net_elm;
389 xbt_lib_set(host_lib, vm_name, ROUTING_HOST_LEVEL, p_netElm);
393 /* Update vcpu's action for the new pm */
396 XBT_INFO("cpu_action->remains %g", p_action->remains);
397 XBT_INFO("cost %f remains %f start %f finish %f", p_action->cost,
402 XBT_INFO("cpu_action state %d", surf_action_get_state(p_action));
405 /* create a cpu action bound to the pm model at the destination. */
406 CpuActionPtr new_cpu_action = static_cast<CpuActionPtr>(
407 static_cast<CpuPtr>(surf_cpu_resource_priv(ind_dst_pm))->execute(0));
409 e_surf_action_state_t state = p_action->getState();
410 if (state != SURF_ACTION_DONE)
411 XBT_CRITICAL("FIXME: may need a proper handling, %d", state);
412 if (p_action->getRemainsNoUpdate() > 0)
413 XBT_CRITICAL("FIXME: need copy the state(?), %f", p_action->getRemainsNoUpdate());
415 /* keep the bound value of the cpu action of the VM. */
416 double old_bound = p_action->getBound();
417 if (old_bound != 0) {
418 XBT_INFO("migrate VM(%s): set bound (%f) at %s", vm_name, old_bound, pm_name_dst);
419 new_cpu_action->setBound(old_bound);
422 int ret = p_action->unref();
423 xbt_assert(ret == 1, "Bug: some resource still remains");
425 p_action = new_cpu_action;
428 XBT_DEBUG("migrate VM(%s): change net_elm (%p to %p)", vm_name, old_net_elm, new_net_elm);
429 XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name, pm_name_src, pm_name_dst);
432 void WorkstationVMHL13::setBound(double bound){
433 p_action->setBound(bound);
436 void WorkstationVMHL13::setAffinity(CpuPtr cpu, unsigned long mask){
437 p_action->setAffinity(cpu, mask);
441 * A surf level object will be useless in the upper layer. Returing the
442 * dict_elm of the host.
444 surf_resource_t WorkstationVMHL13::getPm()
446 return xbt_lib_get_elm_or_null(host_lib, p_subWs->getName());
449 /* Adding a task to a VM updates the VCPU task on its physical machine. */
450 ActionPtr WorkstationVMHL13::execute(double size)
452 double old_cost = p_action->getCost();
453 double new_cost = old_cost + size;
455 XBT_DEBUG("VM(%s)@PM(%s): update dummy action's cost (%f -> %f)",
456 getName(), p_subWs->getName(),
459 p_action->setCost(new_cost);
461 return p_cpu->execute(size);
464 ActionPtr WorkstationVMHL13::sleep(double duration) {
465 return p_cpu->sleep(duration);
472 //FIME:: handle action cancel