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_HL13(void){
13 if (surf_cpu_model_vm) {
14 surf_vm_workstation_model = new WorkstationVMHL13Model();
15 ModelPtr model = 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 WorkstationVMPtr WorkstationVMHL13Model::createWorkstationVM(const char *name, surf_resource_t ind_phys_workstation)
43 WorkstationVMHL13Ptr ws = new WorkstationVMHL13(this, name, NULL, ind_phys_workstation);
45 xbt_lib_set(host_lib, name, SURF_WKS_LEVEL, ws);
48 * - check how network requests are scheduled between distinct processes competing for the same card.
53 static inline double get_solved_value(CpuActionPtr cpu_action)
55 return cpu_action->getVariable()->value;
58 /* In the real world, processes on the guest operating system will be somewhat
59 * degraded due to virtualization overhead. The total CPU share that these
60 * processes get is smaller than that of the VM process gets on a host
61 * operating system. */
62 // const double virt_overhead = 0.95;
63 const double virt_overhead = 1;
65 double WorkstationVMHL13Model::shareResources(double now)
67 /* TODO: udpate action's cost with the total cost of processes on the VM. */
70 /* 0. Make sure that we already calculated the resource share at the physical
73 ModelPtr ws_model = surf_workstation_model;
74 ModelPtr vm_ws_model = surf_vm_workstation_model;
75 unsigned int index_of_pm_ws_model = xbt_dynar_search(model_list_invoke, &ws_model);
76 unsigned int index_of_vm_ws_model = xbt_dynar_search(model_list_invoke, &vm_ws_model);
77 xbt_assert((index_of_pm_ws_model < index_of_vm_ws_model), "Cannot assume surf_workstation_model comes before");
79 /* Another option is that we call sub_ws->share_resource() here. The
80 * share_resource() function has no side-effect. We can call it here to
85 /* 1. Now we know how many resource should be assigned to each virtual
86 * machine. We update constraints of the virtual machine layer.
89 * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
90 * X1 + X2 = C (Equation 1)
92 * the resource share of VM1: X1
93 * the resource share of VM2: X2
94 * the capacity of PM1: C
96 * Then, if we have two process (P1 and P2) on VM1.
97 * X1_1 + X1_2 = X1 (Equation 2)
99 * the resource share of P1: X1_1
100 * the resource share of P2: X1_2
101 * the capacity of VM1: X1
103 * Equation 1 was solved in the physical machine layer.
104 * Equation 2 is solved in the virtual machine layer (here).
105 * X1 must be passed to the virtual machine laye as a constraint value.
109 /* iterate for all virtual machines */
110 for (WorkstationVMModel::vm_list_t::iterator iter =
111 WorkstationVMModel::ws_vms.begin();
112 iter != WorkstationVMModel::ws_vms.end(); ++iter) {
114 WorkstationVMPtr ws_vm = &*iter;
115 CpuPtr cpu = ws_vm->p_cpu;
116 xbt_assert(cpu, "cpu-less workstation");
118 double solved_value = get_solved_value(ws_vm->p_action);
119 XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value,
120 ws_vm->getName(), ws_vm->p_subWs->getName());
122 // TODO: check lmm_update_constraint_bound() works fine instead of the below manual substitution.
123 // cpu_cas01->constraint->bound = solved_value;
124 xbt_assert(cpu->getModel() == surf_cpu_model_vm);
125 lmm_system_t vcpu_system = cpu->getModel()->getMaxminSystem();
126 lmm_update_constraint_bound(vcpu_system, cpu->getConstraint(), virt_overhead * solved_value);
130 /* 2. Calculate resource share at the virtual machine layer. */
131 adjustWeightOfDummyCpuActions();
133 double min_by_cpu = p_cpuModel->shareResources(now);
134 double min_by_net = (strcmp(surf_network_model->getName(), "network NS3")) ? surf_network_model->shareResources(now) : -1;
135 double min_by_sto = -1;
136 if (p_cpuModel == surf_cpu_model_pm)
137 min_by_sto = surf_storage_model->shareResources(now);
139 XBT_DEBUG("model %p, %s min_by_cpu %f, %s min_by_net %f, %s min_by_sto %f",
140 this, surf_cpu_model_pm->getName(), min_by_cpu,
141 surf_network_model->getName(), min_by_net,
142 surf_storage_model->getName(), min_by_sto);
144 double ret = max(max(min_by_cpu, min_by_net), min_by_sto);
145 if (min_by_cpu >= 0.0 && min_by_cpu < ret)
147 if (min_by_net >= 0.0 && min_by_net < ret)
149 if (min_by_sto >= 0.0 && min_by_sto < ret)
152 /* FIXME: 3. do we have to re-initialize our cpu_action object? */
154 /* iterate for all virtual machines */
155 for (WorkstationVMModel::vm_list_t::iterator iter =
156 WorkstationVMModel::ws_vms.begin();
157 iter != WorkstationVMModel::ws_vms.end(); ++iter) {
161 WorkstationVM2013Ptr ws_vm2013 = static_cast<WorkstationVM2013Ptr>(&*iter);
162 XBT_INFO("cost %f remains %f start %f finish %f", ws_vm2013->cpu_action->cost,
163 ws_vm2013->cpu_action->remains,
164 ws_vm2013->cpu_action->start,
165 ws_vm2013->cpu_action->finish
169 void *ind_sub_host = xbt_lib_get_elm_or_null(host_lib, ws_vm2013->sub_ws->generic_resource.getName);
170 surf_cpu_model_pm->action_unref(ws_vm2013->cpu_action);
171 /* FIXME: this means busy loop? */
172 // ws_vm2013->cpu_action = surf_cpu_model_pm->extension.cpu.execute(ind_sub_host, GUESTOS_NOISE);
173 ws_vm2013->cpu_action = surf_cpu_model_pm->extension.cpu.execute(ind_sub_host, 0);
184 ActionPtr WorkstationVMHL13Model::executeParallelTask(int workstation_nb,
185 void **workstation_list,
186 double *computation_amount,
187 double *communication_amount,
189 #define cost_or_zero(array,pos) ((array)?(array)[pos]:0.0)
190 if ((workstation_nb == 1)
191 && (cost_or_zero(communication_amount, 0) == 0.0))
192 return ((WorkstationCLM03Ptr)workstation_list[0])->execute(computation_amount[0]);
193 else if ((workstation_nb == 1)
194 && (cost_or_zero(computation_amount, 0) == 0.0))
195 return communicate((WorkstationCLM03Ptr)workstation_list[0], (WorkstationCLM03Ptr)workstation_list[0],communication_amount[0], rate);
196 else if ((workstation_nb == 2)
197 && (cost_or_zero(computation_amount, 0) == 0.0)
198 && (cost_or_zero(computation_amount, 1) == 0.0)) {
202 for (i = 0; i < workstation_nb * workstation_nb; i++) {
203 if (cost_or_zero(communication_amount, i) > 0.0) {
205 value = cost_or_zero(communication_amount, i);
209 return communicate((WorkstationCLM03Ptr)workstation_list[0], (WorkstationCLM03Ptr)workstation_list[1],value, rate);
213 THROW_UNIMPLEMENTED; /* This model does not implement parallel tasks */
221 WorkstationVMHL13::WorkstationVMHL13(WorkstationVMModelPtr model, const char* name, xbt_dict_t props,
222 surf_resource_t ind_phys_workstation)
223 : WorkstationVM(model, name, props, NULL, NULL)
225 WorkstationPtr sub_ws = static_cast<WorkstationPtr>(surf_workstation_resource_priv(ind_phys_workstation));
227 /* Currently, we assume a VM has no storage. */
230 /* Currently, a VM uses the network resource of its physical host. In
231 * host_lib, this network resource object is referred from two different keys.
232 * When deregistering the reference that points the network resource object
233 * from the VM name, we have to make sure that the system does not call the
234 * free callback for the network resource object. The network resource object
235 * is still used by the physical machine. */
236 p_netElm = static_cast<RoutingEdgePtr>(xbt_lib_get_or_null(host_lib, sub_ws->getName(), ROUTING_HOST_LEVEL));
237 xbt_lib_set(host_lib, name, ROUTING_HOST_LEVEL, p_netElm);
240 p_currentState = SURF_VM_STATE_CREATED;
242 // //// CPU RELATED STUFF ////
243 // Roughly, create a vcpu resource by using the values of the sub_cpu one.
244 CpuCas01Ptr sub_cpu = static_cast<CpuCas01Ptr>(surf_cpu_resource_priv(ind_phys_workstation));
246 /* We can assume one core and cas01 cpu for the first step.
247 * Do xbt_lib_set(host_lib, name, SURF_CPU_LEVEL, cpu) if you get the resource. */
249 p_cpu = surf_cpu_model_vm->createCpu(name, // name
250 sub_cpu->getPowerPeakList(), // host->power_peak,
251 sub_cpu->getPState(),
252 1, // host->power_scale,
253 NULL, // host->power_trace,
254 1, // host->core_amount,
255 SURF_RESOURCE_ON, // host->initial_state,
256 NULL, // host->state_trace,
257 NULL); // host->properties,
259 /* We create cpu_action corresponding to a VM process on the host operating system. */
260 /* FIXME: TODO: we have to peridocally input GUESTOS_NOISE to the system? how ? */
261 // vm_ws->cpu_action = surf_cpu_model_pm->extension.cpu.execute(ind_phys_workstation, GUESTOS_NOISE);
262 p_action = sub_cpu->execute(0);
264 /* The SURF_WKS_LEVEL at host_lib saves workstation_CLM03 objects. Please
265 * note workstation_VM2013 objects, inheriting the workstation_CLM03
266 * structure, are also saved there.
268 * If you want to get a workstation_VM2013 object from host_lib, see
269 * ws->generic_resouce.model->type first. If it is
270 * SURF_MODEL_TYPE_VM_WORKSTATION, you can cast ws to vm_ws. */
271 XBT_INFO("Create VM(%s)@PM(%s) with %ld mounted disks", name, sub_ws->getName(), xbt_dynar_length(p_storage));
275 * A physical host does not disappear in the current SimGrid code, but a VM may
276 * disappear during a simulation.
278 WorkstationVMHL13::~WorkstationVMHL13()
280 /* ind_phys_workstation equals to smx_host_t */
281 surf_resource_t ind_vm_workstation = xbt_lib_get_elm_or_null(host_lib, getName());
283 /* Before clearing the entries in host_lib, we have to pick up resources. */
284 CpuCas01Ptr cpu = static_cast<CpuCas01Ptr>(surf_cpu_resource_priv(ind_vm_workstation));
286 /* We deregister objects from host_lib, without invoking the freeing callback
289 * Do not call xbt_lib_remove() here. It deletes all levels of the key,
290 * including MSG_HOST_LEVEL and others. We should unregister only what we know.
292 xbt_lib_unset(host_lib, getName(), SURF_CPU_LEVEL, 0);
293 xbt_lib_unset(host_lib, getName(), ROUTING_HOST_LEVEL, 0);
294 xbt_lib_unset(host_lib, getName(), SURF_WKS_LEVEL, 0);
296 /* TODO: comment out when VM storage is implemented. */
297 // xbt_lib_unset(host_lib, name, SURF_STORAGE_LEVEL, 0);
300 /* Free the cpu_action of the VM. */
301 int ret = p_action->unref();
302 xbt_assert(ret == 1, "Bug: some resource still remains");
304 /* Free the cpu resource of the VM. If using power_trace, we will have to */
307 /* Free the network resource of the VM. */
308 // Nothing has to be done, because net_elmts is just a pointer on the physical one
310 /* Free the storage resource of the VM. */
313 /* Free the workstation resource of the VM. */
316 void WorkstationVMHL13::updateState(tmgr_trace_event_t /*event_type*/, double /*value*/, double /*date*/) {
317 THROW_IMPOSSIBLE; /* This model does not implement parallel tasks */
320 bool WorkstationVMHL13::isUsed() {
321 THROW_IMPOSSIBLE; /* This model does not implement parallel tasks */
325 e_surf_resource_state_t WorkstationVMHL13::getState()
327 return (e_surf_resource_state_t) p_currentState;
330 void WorkstationVMHL13::setState(e_surf_resource_state_t state)
332 p_currentState = (e_surf_vm_state_t) state;
335 void WorkstationVMHL13::suspend()
338 p_currentState = SURF_VM_STATE_SUSPENDED;
341 void WorkstationVMHL13::resume()
344 p_currentState = SURF_VM_STATE_RUNNING;
347 void WorkstationVMHL13::save()
349 p_currentState = SURF_VM_STATE_SAVING;
351 /* FIXME: do something here */
353 p_currentState = SURF_VM_STATE_SAVED;
356 void WorkstationVMHL13::restore()
358 p_currentState = SURF_VM_STATE_RESTORING;
360 /* FIXME: do something here */
362 p_currentState = SURF_VM_STATE_RUNNING;
366 * Update the physical host of the given VM
368 void WorkstationVMHL13::migrate(surf_resource_t ind_dst_pm)
370 /* ind_phys_workstation equals to smx_host_t */
371 WorkstationPtr ws_dst = static_cast<WorkstationPtr>(surf_workstation_resource_priv(ind_dst_pm));
372 const char *vm_name = getName();
373 const char *pm_name_src = p_subWs->getName();
374 const char *pm_name_dst = ws_dst->getName();
380 /* update net_elm with that of the destination physical host */
381 RoutingEdgePtr old_net_elm = p_netElm;
382 RoutingEdgePtr new_net_elm = static_cast<RoutingEdgePtr>(xbt_lib_get_or_null(host_lib, pm_name_dst, ROUTING_HOST_LEVEL));
383 xbt_assert(new_net_elm);
385 /* Unregister the current net_elm from host_lib. Do not call the free callback. */
386 xbt_lib_unset(host_lib, vm_name, ROUTING_HOST_LEVEL, 0);
388 /* Then, resister the new one. */
389 p_netElm = new_net_elm;
390 xbt_lib_set(host_lib, vm_name, ROUTING_HOST_LEVEL, p_netElm);
394 /* Update vcpu's action for the new pm */
397 XBT_INFO("cpu_action->remains %g", p_action->remains);
398 XBT_INFO("cost %f remains %f start %f finish %f", p_action->cost,
403 XBT_INFO("cpu_action state %d", surf_action_get_state(p_action));
406 /* create a cpu action bound to the pm model at the destination. */
407 CpuActionPtr new_cpu_action = static_cast<CpuActionPtr>(
408 static_cast<CpuPtr>(surf_cpu_resource_priv(ind_dst_pm))->execute(0));
410 e_surf_action_state_t state = p_action->getState();
411 if (state != SURF_ACTION_DONE)
412 XBT_CRITICAL("FIXME: may need a proper handling, %d", state);
413 if (p_action->getRemainsNoUpdate() > 0)
414 XBT_CRITICAL("FIXME: need copy the state(?), %f", p_action->getRemainsNoUpdate());
416 /* keep the bound value of the cpu action of the VM. */
417 double old_bound = p_action->getBound();
418 if (old_bound != 0) {
419 XBT_INFO("migrate VM(%s): set bound (%f) at %s", vm_name, old_bound, pm_name_dst);
420 new_cpu_action->setBound(old_bound);
423 int ret = p_action->unref();
424 xbt_assert(ret == 1, "Bug: some resource still remains");
426 p_action = new_cpu_action;
429 XBT_DEBUG("migrate VM(%s): change net_elm (%p to %p)", vm_name, old_net_elm, new_net_elm);
430 XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name, pm_name_src, pm_name_dst);
433 void WorkstationVMHL13::setBound(double bound){
434 p_action->setBound(bound);
437 void WorkstationVMHL13::setAffinity(CpuPtr cpu, unsigned long mask){
438 p_action->setAffinity(cpu, mask);
442 * A surf level object will be useless in the upper layer. Returning the
443 * dict_elm of the host.
445 surf_resource_t WorkstationVMHL13::getPm()
447 return xbt_lib_get_elm_or_null(host_lib, p_subWs->getName());
450 /* Adding a task to a VM updates the VCPU task on its physical machine. */
451 ActionPtr WorkstationVMHL13::execute(double size)
453 double old_cost = p_action->getCost();
454 double new_cost = old_cost + size;
456 XBT_DEBUG("VM(%s)@PM(%s): update dummy action's cost (%f -> %f)",
457 getName(), p_subWs->getName(),
460 p_action->setCost(new_cost);
462 return p_cpu->execute(size);
465 ActionPtr WorkstationVMHL13::sleep(double duration) {
466 return p_cpu->sleep(duration);
473 //FIME:: handle action cancel