src/surf/vm_workstation_hl13.cpp

   1 /* Copyright (c) 2013-2014. 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 "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 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);
  36 }
  37
  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) */
  40
  41 void WorkstationVMHL13Model::createResource(const char *name, void *ind_phys_workstation)
  42 {
  43   WorkstationVMHL13Ptr ws = new WorkstationVMHL13(this, name, NULL, static_cast<surf_resource_t>(ind_phys_workstation));
  44
  45   xbt_lib_set(host_lib, name, SURF_WKS_LEVEL, static_cast<ResourcePtr>(ws));
  46
  47   /* TODO:
  48    * - check how network requests are scheduled between distinct processes competing for the same card.
  49    */
  50 }
  51
  52 static inline double get_solved_value(CpuActionPtr cpu_action)
  53 {
  54   return cpu_action->getVariable()->value;
  55 }
  56
  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;
  63
  64 double WorkstationVMHL13Model::shareResources(double now)
  65 {
  66   /* TODO: udpate action's cost with the total cost of processes on the VM. */
  67
  68
  69   /* 0. Make sure that we already calculated the resource share at the physical
  70    * machine layer. */
  71   {
  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");
  77
  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
  80      * ensure that. */
  81   }
  82
  83
  84   /* 1. Now we know how many resource should be assigned to each virtual
  85    * machine. We update constraints of the virtual machine layer.
  86    *
  87    *
  88    * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
  89    *     X1 + X2 = C       (Equation 1)
  90    * where
  91    *    the resource share of VM1: X1
  92    *    the resource share of VM2: X2
  93    *    the capacity of PM1: C
  94    *
  95    * Then, if we have two process (P1 and P2) on VM1.
  96    *     X1_1 + X1_2 = X1  (Equation 2)
  97    * where
  98    *    the resource share of P1: X1_1
  99    *    the resource share of P2: X1_2
 100    *    the capacity of VM1: X1
 101    *
 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.
 105    *
 106    **/
 107
 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) {
 112
 113     WorkstationVMPtr ws_vm = &*iter;
 114     CpuPtr cpu = static_cast<CpuPtr>(ws_vm->p_cpu);
 115     xbt_assert(cpu, "cpu-less workstation");
 116
 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());
 120
 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);
 126   }
 127
 128
 129   /* 2. Calculate resource share at the virtual machine layer. */
 130   adjustWeightOfDummyCpuActions();
 131
 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);
 137
 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);
 142
 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)
 145         ret = min_by_cpu;
 146   if (min_by_net >= 0.0 && min_by_net < ret)
 147         ret = min_by_net;
 148   if (min_by_sto >= 0.0 && min_by_sto < ret)
 149         ret = min_by_sto;
 150
 151   /* FIXME: 3. do we have to re-initialize our cpu_action object? */
 152 #if 0
 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) {
 157
 158     {
 159 #if 0
 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
 165           );
 166 #endif
 167 #if 0
 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);
 173 #endif
 174
 175     }
 176   }
 177 #endif
 178
 179
 180   return ret;
 181 }
 182
 183 ActionPtr WorkstationVMHL13Model::executeParallelTask(int workstation_nb,
 184                                         void **workstation_list,
 185                                         double *computation_amount,
 186                                         double *communication_amount,
 187                                         double rate){
 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)) {
 198     int i,nb = 0;
 199     double value = 0.0;
 200
 201     for (i = 0; i < workstation_nb * workstation_nb; i++) {
 202       if (cost_or_zero(communication_amount, i) > 0.0) {
 203         nb++;
 204         value = cost_or_zero(communication_amount, i);
 205       }
 206     }
 207     if (nb == 1)
 208       return communicate((WorkstationCLM03Ptr)workstation_list[0], (WorkstationCLM03Ptr)workstation_list[1],value, rate);
 209   }
 210 #undef cost_or_zero
 211
 212   THROW_UNIMPLEMENTED;          /* This model does not implement parallel tasks */
 213   return NULL;
 214 }
 215
 216 /************
 217  * Resource *
 218  ************/
 219
 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)
 223 {
 224   WorkstationPtr sub_ws = static_cast<WorkstationPtr>(surf_workstation_resource_priv(ind_phys_workstation));
 225
 226   /* Currently, we assume a VM has no storage. */
 227   p_storage = NULL;
 228
 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);
 237
 238   p_subWs = sub_ws;
 239   p_currentState = SURF_VM_STATE_CREATED;
 240
 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));
 244
 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. */
 247
 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,
 257
 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));
 262
 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.
 266    *
 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));
 271 }
 272
 273 /*
 274  * A physical host does not disapper in the current SimGrid code, but a VM may
 275  * disapper during a simulation.
 276  */
 277 WorkstationVMHL13::~WorkstationVMHL13()
 278 {
 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());
 281
 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));
 284
 285   /* We deregister objects from host_lib, without invoking the freeing callback
 286    * of each level.
 287    *
 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.
 290    */
 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);
 294
 295   /* TODO: comment out when VM stroage is implemented. */
 296   // xbt_lib_unset(host_lib, name, SURF_STORAGE_LEVEL, 0);
 297
 298
 299   /* Free the cpu_action of the VM. */
 300   int ret = p_action->unref();
 301   xbt_assert(ret == 1, "Bug: some resource still remains");
 302
 303   /* Free the cpu resource of the VM. If using power_trace, we will have to */
 304   delete cpu;
 305
 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
 308
 309   /* Free the storage resource of the VM. */
 310   // Not relevant yet
 311
 312   /* Free the workstation resource of the VM. */
 313 }
 314
 315 void WorkstationVMHL13::updateState(tmgr_trace_event_t /*event_type*/, double /*value*/, double /*date*/) {
 316   THROW_IMPOSSIBLE;             /* This model does not implement parallel tasks */
 317 }
 318
 319 bool WorkstationVMHL13::isUsed() {
 320   THROW_IMPOSSIBLE;             /* This model does not implement parallel tasks */
 321   return -1;
 322 }
 323
 324 e_surf_resource_state_t WorkstationVMHL13::getState()
 325 {
 326   return (e_surf_resource_state_t) p_currentState;
 327 }
 328
 329 void WorkstationVMHL13::setState(e_surf_resource_state_t state)
 330 {
 331   p_currentState = (e_surf_vm_state_t) state;
 332 }
 333
 334 void WorkstationVMHL13::suspend()
 335 {
 336   p_action->suspend();
 337   p_currentState = SURF_VM_STATE_SUSPENDED;
 338 }
 339
 340 void WorkstationVMHL13::resume()
 341 {
 342   p_action->resume();
 343   p_currentState = SURF_VM_STATE_RUNNING;
 344 }
 345
 346 void WorkstationVMHL13::save()
 347 {
 348   p_currentState = SURF_VM_STATE_SAVING;
 349
 350   /* FIXME: do something here */
 351   p_action->suspend();
 352   p_currentState = SURF_VM_STATE_SAVED;
 353 }
 354
 355 void WorkstationVMHL13::restore()
 356 {
 357   p_currentState = SURF_VM_STATE_RESTORING;
 358
 359   /* FIXME: do something here */
 360   p_action->resume();
 361   p_currentState = SURF_VM_STATE_RUNNING;
 362 }
 363
 364 /*
 365  * Update the physical host of the given VM
 366  */
 367 void WorkstationVMHL13::migrate(surf_resource_t ind_dst_pm)
 368 {
 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();
 374
 375    xbt_assert(ws_dst);
 376
 377    /* do something */
 378
 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);
 383
 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);
 386
 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);
 390
 391    p_subWs = ws_dst;
 392
 393    /* Update vcpu's action for the new pm */
 394    {
 395 #if 0
 396      XBT_INFO("cpu_action->remains %g", p_action->remains);
 397      XBT_INFO("cost %f remains %f start %f finish %f", p_action->cost,
 398          p_action->remains,
 399          p_action->start,
 400          p_action->finish
 401          );
 402      XBT_INFO("cpu_action state %d", surf_action_get_state(p_action));
 403 #endif
 404
 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));
 408
 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());
 414
 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);
 420      }
 421
 422      int ret = p_action->unref();
 423      xbt_assert(ret == 1, "Bug: some resource still remains");
 424
 425      p_action = new_cpu_action;
 426    }
 427
 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);
 430 }
 431
 432 void WorkstationVMHL13::setBound(double bound){
 433  p_action->setBound(bound);
 434 }
 435
 436 void WorkstationVMHL13::setAffinity(CpuPtr cpu, unsigned long mask){
 437  p_action->setAffinity(cpu, mask);
 438 }
 439
 440 /*
 441  * A surf level object will be useless in the upper layer. Returing the
 442  * dict_elm of the host.
 443  **/
 444 surf_resource_t WorkstationVMHL13::getPm()
 445 {
 446   return xbt_lib_get_elm_or_null(host_lib, p_subWs->getName());
 447 }
 448
 449 /* Adding a task to a VM updates the VCPU task on its physical machine. */
 450 ActionPtr WorkstationVMHL13::execute(double size)
 451 {
 452   double old_cost = p_action->getCost();
 453   double new_cost = old_cost + size;
 454
 455   XBT_DEBUG("VM(%s)@PM(%s): update dummy action's cost (%f -> %f)",
 456       getName(), p_subWs->getName(),
 457       old_cost, new_cost);
 458
 459   p_action->setCost(new_cost);
 460
 461   return p_cpu->execute(size);
 462 }
 463
 464 ActionPtr WorkstationVMHL13::sleep(double duration) {
 465   return p_cpu->sleep(duration);
 466 }
 467
 468 /**********
 469  * Action *
 470  **********/
 471
 472 //FIME:: handle action cancel
 473