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_HL13(void){
  13   if (surf_cpu_model_vm) {
  14     surf_vm_workstation_model = new WorkstationVMHL13Model();
  15     ModelPtr model = 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 WorkstationVMPtr WorkstationVMHL13Model::createWorkstationVM(const char *name, surf_resource_t ind_phys_workstation)
  42 {
  43   WorkstationVMHL13Ptr ws = new WorkstationVMHL13(this, name, NULL, ind_phys_workstation);
  44
  45   xbt_lib_set(host_lib, name, SURF_WKS_LEVEL, ws);
  46
  47   /* TODO:
  48    * - check how network requests are scheduled between distinct processes competing for the same card.
  49    */
  50   return ws;
  51 }
  52
  53 static inline double get_solved_value(CpuActionPtr cpu_action)
  54 {
  55   return cpu_action->getVariable()->value;
  56 }
  57
  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;
  64
  65 double WorkstationVMHL13Model::shareResources(double now)
  66 {
  67   /* TODO: udpate action's cost with the total cost of processes on the VM. */
  68
  69
  70   /* 0. Make sure that we already calculated the resource share at the physical
  71    * machine layer. */
  72   {
  73     _XBT_GNUC_UNUSED ModelPtr ws_model = surf_workstation_model;
  74     _XBT_GNUC_UNUSED ModelPtr vm_ws_model = surf_vm_workstation_model;
  75     _XBT_GNUC_UNUSED unsigned int index_of_pm_ws_model = xbt_dynar_search(model_list_invoke, &ws_model);
  76     _XBT_GNUC_UNUSED 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");
  78
  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
  81      * ensure that. */
  82   }
  83
  84
  85   /* 1. Now we know how many resource should be assigned to each virtual
  86    * machine. We update constraints of the virtual machine layer.
  87    *
  88    *
  89    * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
  90    *     X1 + X2 = C       (Equation 1)
  91    * where
  92    *    the resource share of VM1: X1
  93    *    the resource share of VM2: X2
  94    *    the capacity of PM1: C
  95    *
  96    * Then, if we have two process (P1 and P2) on VM1.
  97    *     X1_1 + X1_2 = X1  (Equation 2)
  98    * where
  99    *    the resource share of P1: X1_1
 100    *    the resource share of P2: X1_2
 101    *    the capacity of VM1: X1
 102    *
 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.
 106    *
 107    **/
 108
 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) {
 113
 114     WorkstationVMPtr ws_vm = &*iter;
 115     CpuPtr cpu = ws_vm->p_cpu;
 116     xbt_assert(cpu, "cpu-less workstation");
 117
 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());
 121
 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);
 127   }
 128
 129
 130   /* 2. Calculate resource share at the virtual machine layer. */
 131   adjustWeightOfDummyCpuActions();
 132
 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);
 138
 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);
 143
 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)
 146         ret = min_by_cpu;
 147   if (min_by_net >= 0.0 && min_by_net < ret)
 148         ret = min_by_net;
 149   if (min_by_sto >= 0.0 && min_by_sto < ret)
 150         ret = min_by_sto;
 151
 152   /* FIXME: 3. do we have to re-initialize our cpu_action object? */
 153 #if 0
 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) {
 158
 159     {
 160 #if 0
 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
 166           );
 167 #endif
 168 #if 0
 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);
 174 #endif
 175
 176     }
 177   }
 178 #endif
 179
 180
 181   return ret;
 182 }
 183
 184 ActionPtr WorkstationVMHL13Model::executeParallelTask(int workstation_nb,
 185                                         void **workstation_list,
 186                                         double *flops_amount,
 187                                         double *bytes_amount,
 188                                         double rate){
 189 #define cost_or_zero(array,pos) ((array)?(array)[pos]:0.0)
 190   if ((workstation_nb == 1)
 191       && (cost_or_zero(bytes_amount, 0) == 0.0))
 192     return ((WorkstationCLM03Ptr)workstation_list[0])->execute(flops_amount[0]);
 193   else if ((workstation_nb == 1)
 194            && (cost_or_zero(flops_amount, 0) == 0.0))
 195     return communicate((WorkstationCLM03Ptr)workstation_list[0], (WorkstationCLM03Ptr)workstation_list[0],bytes_amount[0], rate);
 196   else if ((workstation_nb == 2)
 197              && (cost_or_zero(flops_amount, 0) == 0.0)
 198              && (cost_or_zero(flops_amount, 1) == 0.0)) {
 199     int i,nb = 0;
 200     double value = 0.0;
 201
 202     for (i = 0; i < workstation_nb * workstation_nb; i++) {
 203       if (cost_or_zero(bytes_amount, i) > 0.0) {
 204         nb++;
 205         value = cost_or_zero(bytes_amount, i);
 206       }
 207     }
 208     if (nb == 1)
 209       return communicate((WorkstationCLM03Ptr)workstation_list[0], (WorkstationCLM03Ptr)workstation_list[1],value, rate);
 210   }
 211 #undef cost_or_zero
 212
 213   THROW_UNIMPLEMENTED;          /* This model does not implement parallel tasks */
 214   return NULL;
 215 }
 216
 217 /************
 218  * Resource *
 219  ************/
 220
 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)
 224 {
 225   WorkstationPtr sub_ws = static_cast<WorkstationPtr>(surf_workstation_resource_priv(ind_phys_workstation));
 226
 227   /* Currently, we assume a VM has no storage. */
 228   p_storage = NULL;
 229
 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 = new RoutingEdgeWrapper(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);
 238
 239   p_subWs = sub_ws;
 240   p_currentState = SURF_VM_STATE_CREATED;
 241
 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));
 245
 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. */
 248
 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,
 258
 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);
 263
 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.
 267    *
 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));
 272 }
 273
 274 /*
 275  * A physical host does not disappear in the current SimGrid code, but a VM may
 276  * disappear during a simulation.
 277  */
 278 WorkstationVMHL13::~WorkstationVMHL13()
 279 {
 280   /* Free the cpu_action of the VM. */
 281   _XBT_GNUC_UNUSED int ret = p_action->unref();
 282   xbt_assert(ret == 1, "Bug: some resource still remains");
 283 }
 284
 285 void WorkstationVMHL13::updateState(tmgr_trace_event_t /*event_type*/, double /*value*/, double /*date*/) {
 286   THROW_IMPOSSIBLE;             /* This model does not implement parallel tasks */
 287 }
 288
 289 bool WorkstationVMHL13::isUsed() {
 290   THROW_IMPOSSIBLE;             /* This model does not implement parallel tasks */
 291   return -1;
 292 }
 293
 294 e_surf_resource_state_t WorkstationVMHL13::getState()
 295 {
 296   return (e_surf_resource_state_t) p_currentState;
 297 }
 298
 299 void WorkstationVMHL13::setState(e_surf_resource_state_t state)
 300 {
 301   p_currentState = (e_surf_vm_state_t) state;
 302 }
 303
 304 void WorkstationVMHL13::suspend()
 305 {
 306   p_action->suspend();
 307   p_currentState = SURF_VM_STATE_SUSPENDED;
 308 }
 309
 310 void WorkstationVMHL13::resume()
 311 {
 312   p_action->resume();
 313   p_currentState = SURF_VM_STATE_RUNNING;
 314 }
 315
 316 void WorkstationVMHL13::save()
 317 {
 318   p_currentState = SURF_VM_STATE_SAVING;
 319
 320   /* FIXME: do something here */
 321   p_action->suspend();
 322   p_currentState = SURF_VM_STATE_SAVED;
 323 }
 324
 325 void WorkstationVMHL13::restore()
 326 {
 327   p_currentState = SURF_VM_STATE_RESTORING;
 328
 329   /* FIXME: do something here */
 330   p_action->resume();
 331   p_currentState = SURF_VM_STATE_RUNNING;
 332 }
 333
 334 /*
 335  * Update the physical host of the given VM
 336  */
 337 void WorkstationVMHL13::migrate(surf_resource_t ind_dst_pm)
 338 {
 339    /* ind_phys_workstation equals to smx_host_t */
 340    WorkstationPtr ws_dst = static_cast<WorkstationPtr>(surf_workstation_resource_priv(ind_dst_pm));
 341    const char *vm_name = getName();
 342    const char *pm_name_src = p_subWs->getName();
 343    const char *pm_name_dst = ws_dst->getName();
 344
 345    xbt_assert(ws_dst);
 346
 347    /* do something */
 348
 349    /* update net_elm with that of the destination physical host */
 350    RoutingEdgePtr old_net_elm = p_netElm;
 351    RoutingEdgePtr new_net_elm = new RoutingEdgeWrapper(static_cast<RoutingEdgePtr>(xbt_lib_get_or_null(host_lib, pm_name_dst, ROUTING_HOST_LEVEL)));
 352    xbt_assert(new_net_elm);
 353
 354    /* Unregister the current net_elm from host_lib. Do not call the free callback. */
 355    xbt_lib_unset(host_lib, vm_name, ROUTING_HOST_LEVEL, 0);
 356
 357    /* Then, resister the new one. */
 358    p_netElm = new_net_elm;
 359    xbt_lib_set(host_lib, vm_name, ROUTING_HOST_LEVEL, p_netElm);
 360
 361    p_subWs = ws_dst;
 362
 363    /* Update vcpu's action for the new pm */
 364    {
 365 #if 0
 366      XBT_INFO("cpu_action->remains %g", p_action->remains);
 367      XBT_INFO("cost %f remains %f start %f finish %f", p_action->cost,
 368          p_action->remains,
 369          p_action->start,
 370          p_action->finish
 371          );
 372      XBT_INFO("cpu_action state %d", surf_action_get_state(p_action));
 373 #endif
 374
 375      /* create a cpu action bound to the pm model at the destination. */
 376      CpuActionPtr new_cpu_action = static_cast<CpuActionPtr>(
 377                                             static_cast<CpuPtr>(surf_cpu_resource_priv(ind_dst_pm))->execute(0));
 378
 379      e_surf_action_state_t state = p_action->getState();
 380      if (state != SURF_ACTION_DONE)
 381        XBT_CRITICAL("FIXME: may need a proper handling, %d", state);
 382      if (p_action->getRemainsNoUpdate() > 0)
 383        XBT_CRITICAL("FIXME: need copy the state(?), %f", p_action->getRemainsNoUpdate());
 384
 385      /* keep the bound value of the cpu action of the VM. */
 386      double old_bound = p_action->getBound();
 387      if (old_bound != 0) {
 388        XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name, old_bound, pm_name_dst);
 389        new_cpu_action->setBound(old_bound);
 390      }
 391
 392      _XBT_GNUC_UNUSED int ret = p_action->unref();
 393      xbt_assert(ret == 1, "Bug: some resource still remains");
 394
 395      p_action = new_cpu_action;
 396    }
 397
 398    XBT_DEBUG("migrate VM(%s): change net_elm (%p to %p)", vm_name, old_net_elm, new_net_elm);
 399    XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name, pm_name_src, pm_name_dst);
 400    delete old_net_elm;
 401 }
 402
 403 void WorkstationVMHL13::setBound(double bound){
 404  p_action->setBound(bound);
 405 }
 406
 407 void WorkstationVMHL13::setAffinity(CpuPtr cpu, unsigned long mask){
 408  p_action->setAffinity(cpu, mask);
 409 }
 410
 411 /*
 412  * A surf level object will be useless in the upper layer. Returning the
 413  * dict_elm of the host.
 414  **/
 415 surf_resource_t WorkstationVMHL13::getPm()
 416 {
 417   return xbt_lib_get_elm_or_null(host_lib, p_subWs->getName());
 418 }
 419
 420 /* Adding a task to a VM updates the VCPU task on its physical machine. */
 421 ActionPtr WorkstationVMHL13::execute(double size)
 422 {
 423   double old_cost = p_action->getCost();
 424   double new_cost = old_cost + size;
 425
 426   XBT_DEBUG("VM(%s)@PM(%s): update dummy action's cost (%f -> %f)",
 427       getName(), p_subWs->getName(),
 428       old_cost, new_cost);
 429
 430   p_action->setCost(new_cost);
 431
 432   return p_cpu->execute(size);
 433 }
 434
 435 ActionPtr WorkstationVMHL13::sleep(double duration) {
 436   return p_cpu->sleep(duration);
 437 }
 438
 439 /**********
 440  * Action *
 441  **********/
 442
 443 //FIME:: handle action cancel
 444