src/surf/surf_interface.cpp

   1 /* Copyright (c) 2004-2015. 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 "surf_interface.hpp"
   8 #include "cpu_interface.hpp"
   9 #include "mc/mc.h"
  10 #include "network_interface.hpp"
  11 #include "simgrid/s4u/engine.hpp"
  12 #include "simgrid/sg_config.h"
  13 #include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
  14 #include "src/internal_config.h"
  15 #include "src/kernel/routing/NetCard.hpp"
  16 #include "src/simix/smx_host_private.h"
  17 #include "src/surf/HostImpl.hpp"
  18 #include "surf_private.h"
  19 #include <vector>
  20
  21 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
  22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf, "Logging specific to SURF (kernel)");
  23
  24 /*********
  25  * Utils *
  26  *********/
  27
  28 /* model_list_invoke contains only surf_host and surf_vm.
  29  * The callback functions of cpu_model and network_model will be called from those of these host models. */
  30 std::vector<surf_model_t> * all_existing_models = nullptr; /* to destroy models correctly */
  31 xbt_dynar_t model_list_invoke = nullptr;  /* to invoke callbacks */
  32
  33 simgrid::trace_mgr::future_evt_set *future_evt_set = nullptr;
  34 xbt_dynar_t surf_path = nullptr;
  35 std::vector<simgrid::s4u::Host*> host_that_restart;
  36 xbt_dict_t watched_hosts_lib;
  37
  38 namespace simgrid {
  39 namespace surf {
  40
  41 simgrid::xbt::signal<void(void)> surfExitCallbacks;
  42
  43 }
  44 }
  45
  46 #include <simgrid/plugins/energy.h> // FIXME: this plugin should not be linked to the core
  47
  48 s_surf_model_description_t surf_plugin_description[] = {
  49     {"Energy", "Cpu energy consumption.", &sg_energy_plugin_init},
  50      {nullptr, nullptr,  nullptr}      /* this array must be nullptr terminated */
  51 };
  52
  53 /* Don't forget to update the option description in smx_config when you change this */
  54 s_surf_model_description_t surf_network_model_description[] = {
  55   {"LV08", "Realistic network analytic model (slow-start modeled by multiplying latency by 10.4, bandwidth by .92; bottleneck sharing uses a payload of S=8775 for evaluating RTT). ",
  56    &surf_network_model_init_LegrandVelho},
  57   {"Constant",
  58    "Simplistic network model where all communication take a constant time (one second). This model provides the lowest realism, but is (marginally) faster.",
  59    &surf_network_model_init_Constant},
  60   {"SMPI", "Realistic network model specifically tailored for HPC settings (accurate modeling of slow start with correction factors on three intervals: < 1KiB, < 64 KiB, >= 64 KiB)",
  61    &surf_network_model_init_SMPI},
  62   {"IB", "Realistic network model specifically tailored for HPC settings, with Infiniband contention model",
  63    &surf_network_model_init_IB},
  64   {"CM02", "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of small messages are thus poorly modeled).",
  65    &surf_network_model_init_CM02},
  66   {"NS3", "Network pseudo-model using the NS3 tcp model instead of an analytic model", &surf_network_model_init_NS3},
  67   {"Reno",  "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
  68    &surf_network_model_init_Reno},
  69   {"Reno2", "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
  70    &surf_network_model_init_Reno2},
  71   {"Vegas", "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
  72    &surf_network_model_init_Vegas},
  73   {nullptr, nullptr, nullptr}      /* this array must be nullptr terminated */
  74 };
  75
  76 #if ! HAVE_SMPI
  77 void surf_network_model_init_SMPI() {
  78   xbt_die("Please activate SMPI support in cmake to use the SMPI network model.");
  79 }
  80 void surf_network_model_init_IB() {
  81   xbt_die("Please activate SMPI support in cmake to use the IB network model.");
  82 }
  83 #endif
  84 #if !HAVE_NS3
  85 void surf_network_model_init_NS3() {
  86   xbt_die("Please activate NS3 support in cmake and install the dependencies to use the NS3 network model.");
  87 }
  88 #endif
  89
  90 s_surf_model_description_t surf_cpu_model_description[] = {
  91   {"Cas01", "Simplistic CPU model (time=size/power).", &surf_cpu_model_init_Cas01},
  92   {nullptr, nullptr,  nullptr}      /* this array must be nullptr terminated */
  93 };
  94
  95 s_surf_model_description_t surf_host_model_description[] = {
  96   {"default",   "Default host model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)", &surf_host_model_init_current_default},
  97   {"compound",  "Host model that is automatically chosen if you change the network and CPU models", &surf_host_model_init_compound},
  98   {"ptask_L07", "Host model somehow similar to Cas01+CM02 but allowing parallel tasks", &surf_host_model_init_ptask_L07},
  99   {nullptr, nullptr, nullptr}      /* this array must be nullptr terminated */
 100 };
 101
 102 s_surf_model_description_t surf_optimization_mode_description[] = {
 103   {"Lazy", "Lazy action management (partial invalidation in lmm + heap in action remaining).", nullptr},
 104   {"TI",   "Trace integration. Highly optimized mode when using availability traces (only available for the Cas01 CPU model for now).", nullptr},
 105   {"Full", "Full update of remaining and variables. Slow but may be useful when debugging.", nullptr},
 106   {nullptr, nullptr, nullptr}      /* this array must be nullptr terminated */
 107 };
 108
 109 s_surf_model_description_t surf_storage_model_description[] = {
 110   {"default", "Simplistic storage model.", &surf_storage_model_init_default},
 111   {nullptr, nullptr,  nullptr}      /* this array must be nullptr terminated */
 112 };
 113
 114 #if HAVE_THREAD_CONTEXTS
 115 static xbt_parmap_t surf_parmap = nullptr; /* parallel map on models */
 116 #endif
 117
 118 double NOW = 0;
 119
 120 double surf_get_clock()
 121 {
 122   return NOW;
 123 }
 124
 125 #ifdef _WIN32
 126 # define FILE_DELIM "\\"
 127 #else
 128 # define FILE_DELIM "/"         /* FIXME: move to better location */
 129 #endif
 130
 131 FILE *surf_fopen(const char *name, const char *mode)
 132 {
 133   unsigned int cpt;
 134   char *path_elm = nullptr;
 135   char *buff;
 136   FILE *file = nullptr;
 137
 138   xbt_assert(name);
 139
 140   if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
 141     return fopen(name, mode);
 142
 143   /* search relative files in the path */
 144   xbt_dynar_foreach(surf_path, cpt, path_elm) {
 145     buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
 146     file = fopen(buff, mode);
 147     free(buff);
 148
 149     if (file)
 150       return file;
 151   }
 152   return nullptr;
 153 }
 154
 155 #ifdef _WIN32
 156 #include <windows.h>
 157 #define MAX_DRIVE 26
 158 static const char *disk_drives_letter_table[MAX_DRIVE] = {
 159   "A:\\","B:\\","C:\\","D:\\","E:\\","F:\\","G:\\","H:\\","I:\\","J:\\","K:\\","L:\\","M:\\",
 160   "N:\\","O:\\","P:\\","Q:\\","R:\\","S:\\","T:\\","U:\\","V:\\","W:\\","X:\\","Y:\\","Z:\\"
 161 };
 162 #endif
 163
 164 /*
 165  * Returns the initial path. On Windows the initial path is
 166  * the current directory for the current process in the other
 167  * case the function returns "./" that represents the current
 168  * directory on Unix/Linux platforms.
 169  */
 170
 171 const char *__surf_get_initial_path()
 172 {
 173
 174 #ifdef _WIN32
 175   unsigned i;
 176   char current_directory[MAX_PATH + 1] = { 0 };
 177   unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
 178   char root[4] = { 0 };
 179
 180   if (!len)
 181     return nullptr;
 182
 183   strncpy(root, current_directory, 3);
 184
 185   for (i = 0; i < MAX_DRIVE; i++) {
 186     if (toupper(root[0]) == disk_drives_letter_table[i][0])
 187       return disk_drives_letter_table[i];
 188   }
 189
 190   return nullptr;
 191 #else
 192   return "./";
 193 #endif
 194 }
 195
 196 /* The __surf_is_absolute_file_path() returns 1 if
 197  * file_path is a absolute file path, in the other
 198  * case the function returns 0.
 199  */
 200 int __surf_is_absolute_file_path(const char *file_path)
 201 {
 202 #ifdef _WIN32
 203   WIN32_FIND_DATA wfd = { 0 };
 204   HANDLE hFile = FindFirstFile(file_path, &wfd);
 205
 206   if (INVALID_HANDLE_VALUE == hFile)
 207     return 0;
 208
 209   FindClose(hFile);
 210   return 1;
 211 #else
 212   return (file_path[0] == '/');
 213 #endif
 214 }
 215
 216 /** Displays the long description of all registered models, and quit */
 217 void model_help(const char *category, s_surf_model_description_t * table)
 218 {
 219   printf("Long description of the %s models accepted by this simulator:\n", category);
 220   for (int i = 0; table[i].name; i++)
 221     printf("  %s: %s\n", table[i].name, table[i].description);
 222 }
 223
 224 int find_model_description(s_surf_model_description_t * table,
 225                            const char *name)
 226 {
 227   int i;
 228   char *name_list = nullptr;
 229
 230   for (i = 0; table[i].name; i++)
 231     if (!strcmp(name, table[i].name)) {
 232       return i;
 233     }
 234   if (!table[0].name)
 235     xbt_die("No model is valid! This is a bug.");
 236   name_list = xbt_strdup(table[0].name);
 237   for (i = 1; table[i].name; i++) {
 238     name_list = (char *) xbt_realloc(name_list, strlen(name_list) + strlen(table[i].name) + 3);
 239     strncat(name_list, ", ", 2);
 240     strncat(name_list, table[i].name, strlen(table[i].name));
 241   }
 242   xbt_die("Model '%s' is invalid! Valid models are: %s.", name, name_list);
 243   return -1;
 244 }
 245
 246 static inline void surf_storage_free(void *r)
 247 {
 248   delete static_cast<simgrid::surf::Storage*>(r);
 249 }
 250
 251 void sg_version_check(int lib_version_major,int lib_version_minor,int lib_version_patch) {
 252     if ((lib_version_major != SIMGRID_VERSION_MAJOR) || (lib_version_minor != SIMGRID_VERSION_MINOR)) {
 253       fprintf(stderr,
 254           "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
 255           "and then linked against SimGrid %d.%d.%d. Please fix this.\n",
 256           lib_version_major,lib_version_minor,lib_version_patch,
 257           SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);
 258       abort();
 259     }
 260     if (lib_version_patch != SIMGRID_VERSION_PATCH) {
 261       if(SIMGRID_VERSION_PATCH >= 90 || lib_version_patch >=90){
 262         fprintf(stderr,
 263         "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
 264         "and then linked against SimGrid %d.%d.%d. \n"
 265         "One of them is a development version, and should not be mixed with the stable release. Please fix this.\n",
 266         lib_version_major,lib_version_minor,lib_version_patch,
 267         SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);
 268         abort();
 269       }
 270         fprintf(stderr,
 271             "Warning: Your program was compiled with SimGrid version %d.%d.%d, "
 272             "and then linked against SimGrid %d.%d.%d. Proceeding anyway.\n",
 273             lib_version_major,lib_version_minor,lib_version_patch,
 274             SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);
 275     }
 276 }
 277
 278 void sg_version(int *ver_major,int *ver_minor,int *ver_patch) {
 279   *ver_major = SIMGRID_VERSION_MAJOR;
 280   *ver_minor = SIMGRID_VERSION_MINOR;
 281   *ver_patch = SIMGRID_VERSION_PATCH;
 282 }
 283
 284 void surf_init(int *argc, char **argv)
 285 {
 286   if (USER_HOST_LEVEL != -1) // Already initialized
 287     return;
 288
 289   XBT_DEBUG("Create all Libs");
 290   USER_HOST_LEVEL = simgrid::s4u::Host::extension_create(nullptr);
 291
 292   as_router_lib = xbt_lib_new();
 293   storage_lib = xbt_lib_new();
 294   storage_type_lib = xbt_lib_new();
 295   file_lib = xbt_lib_new();
 296   watched_hosts_lib = xbt_dict_new_homogeneous(nullptr);
 297
 298   XBT_DEBUG("Add routing levels");
 299   ROUTING_ASR_LEVEL = xbt_lib_add_level(as_router_lib, [](void* p) {
 300     delete static_cast<simgrid::kernel::routing::NetCard*>(p);
 301   });
 302
 303   XBT_DEBUG("Add SURF levels");
 304   SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_free);
 305
 306   xbt_init(argc, argv);
 307   if (!all_existing_models)
 308     all_existing_models = new std::vector<simgrid::surf::Model*>();
 309   if (!model_list_invoke)
 310     model_list_invoke = xbt_dynar_new(sizeof(simgrid::surf::Model*), nullptr);
 311   if (!future_evt_set)
 312     future_evt_set = new simgrid::trace_mgr::future_evt_set();
 313
 314   TRACE_add_start_function(TRACE_surf_alloc);
 315   TRACE_add_end_function(TRACE_surf_release);
 316
 317   sg_config_init(argc, argv);
 318
 319   if (MC_is_active())
 320     MC_memory_init();
 321 }
 322
 323 void surf_exit()
 324 {
 325   TRACE_end();                  /* Just in case it was not called by the upper layer (or there is no upper layer) */
 326
 327   xbt_dynar_free(&surf_path);
 328
 329   sg_host_exit();
 330   xbt_lib_free(&as_router_lib);
 331   xbt_lib_free(&storage_lib);
 332   sg_link_exit();
 333   xbt_lib_free(&storage_type_lib);
 334   xbt_lib_free(&file_lib);
 335   xbt_dict_free(&watched_hosts_lib);
 336
 337   for (auto model : *all_existing_models)
 338     delete model;
 339   delete all_existing_models;
 340   xbt_dynar_free(&model_list_invoke);
 341
 342   simgrid::surf::surfExitCallbacks();
 343
 344   if (future_evt_set) {
 345     delete future_evt_set;
 346     future_evt_set = nullptr;
 347   }
 348
 349 #if HAVE_THREAD_CONTEXTS
 350   xbt_parmap_destroy(surf_parmap);
 351 #endif
 352
 353   tmgr_finalize();
 354   sg_platf_exit();
 355   simgrid::s4u::Engine::shutdown();
 356
 357   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
 358 }
 359
 360 /*********
 361  * Model *
 362  *********/
 363
 364 namespace simgrid {
 365 namespace surf {
 366
 367 Model::Model()
 368   : maxminSystem_(nullptr)
 369 {
 370   readyActionSet_ = new ActionList();
 371   runningActionSet_ = new ActionList();
 372   failedActionSet_ = new ActionList();
 373   doneActionSet_ = new ActionList();
 374
 375   modifiedSet_ = nullptr;
 376   actionHeap_ = nullptr;
 377   updateMechanism_ = UM_UNDEFINED;
 378   selectiveUpdate_ = 0;
 379 }
 380
 381 Model::~Model(){
 382   delete readyActionSet_;
 383   delete runningActionSet_;
 384   delete failedActionSet_;
 385   delete doneActionSet_;
 386 }
 387
 388 double Model::nextOccuringEvent(double now)
 389 {
 390   //FIXME: set the good function once and for all
 391   if (updateMechanism_ == UM_LAZY)
 392     return nextOccuringEventLazy(now);
 393   else if (updateMechanism_ == UM_FULL)
 394     return nextOccuringEventFull(now);
 395   else
 396     xbt_die("Invalid cpu update mechanism!");
 397 }
 398
 399 double Model::nextOccuringEventLazy(double now)
 400 {
 401   XBT_DEBUG("Before share resources, the size of modified actions set is %zd", modifiedSet_->size());
 402   lmm_solve(maxminSystem_);
 403   XBT_DEBUG("After share resources, The size of modified actions set is %zd", modifiedSet_->size());
 404
 405   while(!modifiedSet_->empty()) {
 406     Action *action = &(modifiedSet_->front());
 407     modifiedSet_->pop_front();
 408     int max_dur_flag = 0;
 409
 410     if (action->getStateSet() != runningActionSet_)
 411       continue;
 412
 413     /* bogus priority, skip it */
 414     if (action->getPriority() <= 0 || action->getHat()==LATENCY)
 415       continue;
 416
 417     action->updateRemainingLazy(now);
 418
 419     double min = -1;
 420     double share = lmm_variable_getvalue(action->getVariable());
 421
 422     if (share > 0) {
 423       double time_to_completion;
 424       if (action->getRemains() > 0) {
 425         time_to_completion = action->getRemainsNoUpdate() / share;
 426       } else {
 427         time_to_completion = 0.0;
 428       }
 429       min = now + time_to_completion; // when the task will complete if nothing changes
 430     }
 431
 432     if ((action->getMaxDuration() != NO_MAX_DURATION)
 433         && (min == -1
 434             || action->getStartTime() +
 435             action->getMaxDuration() < min)) {
 436       min = action->getStartTime() +
 437           action->getMaxDuration();  // when the task will complete anyway because of the deadline if any
 438       max_dur_flag = 1;
 439     }
 440
 441
 442     XBT_DEBUG("Action(%p) corresponds to variable %d", action, action->getVariable()->id_int);
 443
 444     XBT_DEBUG("Action(%p) Start %f. May finish at %f (got a share of %f). Max_duration %f", action,
 445         action->getStartTime(), min, share,
 446         action->getMaxDuration());
 447
 448     if (min != -1) {
 449       action->heapUpdate(actionHeap_, min, max_dur_flag ? MAX_DURATION : NORMAL);
 450       XBT_DEBUG("Insert at heap action(%p) min %f now %f", action, min,
 451                 now);
 452     } else DIE_IMPOSSIBLE;
 453   }
 454
 455   //hereafter must have already the min value for this resource model
 456   if (xbt_heap_size(actionHeap_) > 0) {
 457     double min = xbt_heap_maxkey(actionHeap_) - now;
 458     XBT_DEBUG("minimum with the HEAP %f", min);
 459     return min;
 460   } else {
 461     XBT_DEBUG("The HEAP is empty, thus returning -1");
 462     return -1;
 463   }
 464 }
 465
 466 double Model::nextOccuringEventFull(double /*now*/) {
 467   maxminSystem_->solve_fun(maxminSystem_);
 468
 469   double min = -1;
 470   for (auto it(getRunningActionSet()->begin()), itend(getRunningActionSet()->end()); it != itend ; ++it) {
 471     Action *action = &*it;
 472     double value = lmm_variable_getvalue(action->getVariable());
 473     if (value > 0) {
 474       if (action->getRemains() > 0)
 475         value = action->getRemainsNoUpdate() / value;
 476       else
 477         value = 0.0;
 478       if (min < 0 || value < min) {
 479         min = value;
 480         XBT_DEBUG("Updating min (value) with %p: %f", action, min);
 481       }
 482     }
 483     if ((action->getMaxDuration() >= 0) && (min<0 || action->getMaxDuration() < min)) {
 484       min = action->getMaxDuration();
 485       XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
 486     }
 487   }
 488   XBT_DEBUG("min value : %f", min);
 489
 490   return min;
 491 }
 492
 493 void Model::updateActionsState(double now, double delta)
 494 {
 495   if (updateMechanism_ == UM_FULL)
 496     updateActionsStateFull(now, delta);
 497   else if (updateMechanism_ == UM_LAZY)
 498     updateActionsStateLazy(now, delta);
 499   else
 500     xbt_die("Invalid cpu update mechanism!");
 501 }
 502
 503 void Model::updateActionsStateLazy(double /*now*/, double /*delta*/)
 504 {
 505   THROW_UNIMPLEMENTED;
 506 }
 507
 508 void Model::updateActionsStateFull(double /*now*/, double /*delta*/)
 509 {
 510   THROW_UNIMPLEMENTED;
 511 }
 512
 513 }
 514 }
 515
 516 /************
 517  * Resource *
 518  ************/
 519
 520 namespace simgrid {
 521 namespace surf {
 522
 523 Resource::Resource(Model* model, const char* name, lmm_constraint_t constraint)
 524     : name_(name), model_(model), constraint_(constraint)
 525 {}
 526
 527 Resource::~Resource() = default;
 528
 529 bool Resource::isOn() const {
 530   return isOn_;
 531 }
 532 bool Resource::isOff() const {
 533   return ! isOn_;
 534 }
 535
 536 void Resource::turnOn()
 537 {
 538   isOn_ = true;
 539 }
 540
 541 void Resource::turnOff()
 542 {
 543   isOn_ = false;
 544 }
 545
 546 Model *Resource::getModel() const {
 547   return model_;
 548 }
 549
 550 const char *Resource::getName() const {
 551   return name_.c_str();
 552 }
 553
 554 bool Resource::operator==(const Resource &other) const {
 555   return name_ == other.name_;
 556 }
 557
 558 lmm_constraint_t Resource::getConstraint() const {
 559   return constraint_;
 560 }
 561
 562 }
 563 }
 564
 565 /**********
 566  * Action *
 567  **********/
 568
 569 const char *surf_action_state_names[6] = {
 570   "SURF_ACTION_READY",
 571   "SURF_ACTION_RUNNING",
 572   "SURF_ACTION_FAILED",
 573   "SURF_ACTION_DONE",
 574   "SURF_ACTION_TO_FREE",
 575   "SURF_ACTION_NOT_IN_THE_SYSTEM"
 576 };
 577
 578 /* added to manage the communication action's heap */
 579 void surf_action_lmm_update_index_heap(void *action, int i) {
 580   static_cast<simgrid::surf::Action*>(action)->updateIndexHeap(i);
 581 }
 582
 583 namespace simgrid {
 584 namespace surf {
 585
 586 Action::Action(simgrid::surf::Model* model, double cost, bool failed) : Action(model, cost, failed, nullptr)
 587 {
 588 }
 589
 590 Action::Action(simgrid::surf::Model* model, double cost, bool failed, lmm_variable_t var)
 591     : remains_(cost), start_(surf_get_clock()), cost_(cost), model_(model), variable_(var)
 592 {
 593   if (failed)
 594     stateSet_ = getModel()->getFailedActionSet();
 595   else
 596     stateSet_ = getModel()->getRunningActionSet();
 597
 598   stateSet_->push_back(*this);
 599 }
 600
 601 Action::~Action() {
 602   xbt_free(category_);
 603 }
 604
 605 void Action::finish() {
 606     finishTime_ = surf_get_clock();
 607 }
 608
 609 Action::State Action::getState()
 610 {
 611   if (stateSet_ ==  getModel()->getReadyActionSet())
 612     return Action::State::ready;
 613   if (stateSet_ ==  getModel()->getRunningActionSet())
 614     return Action::State::running;
 615   if (stateSet_ ==  getModel()->getFailedActionSet())
 616     return Action::State::failed;
 617   if (stateSet_ ==  getModel()->getDoneActionSet())
 618     return Action::State::done;
 619   return Action::State::not_in_the_system;
 620 }
 621
 622 void Action::setState(Action::State state)
 623 {
 624   stateSet_->erase(stateSet_->iterator_to(*this));
 625   switch (state) {
 626   case Action::State::ready:
 627     stateSet_ = getModel()->getReadyActionSet();
 628     break;
 629   case Action::State::running:
 630     stateSet_ = getModel()->getRunningActionSet();
 631     break;
 632   case Action::State::failed:
 633     stateSet_ = getModel()->getFailedActionSet();
 634     break;
 635   case Action::State::done:
 636     stateSet_ = getModel()->getDoneActionSet();
 637     break;
 638   default:
 639     stateSet_ = nullptr;
 640     break;
 641   }
 642   if (stateSet_)
 643     stateSet_->push_back(*this);
 644 }
 645
 646 double Action::getBound()
 647 {
 648   return (variable_) ? lmm_variable_getbound(variable_) : 0;
 649 }
 650
 651 void Action::setBound(double bound)
 652 {
 653   XBT_IN("(%p,%g)", this, bound);
 654   if (variable_)
 655     lmm_update_variable_bound(getModel()->getMaxminSystem(), variable_, bound);
 656
 657   if (getModel()->getUpdateMechanism() == UM_LAZY && getLastUpdate()!=surf_get_clock())
 658     heapRemove(getModel()->getActionHeap());
 659   XBT_OUT();
 660 }
 661
 662 double Action::getStartTime()
 663 {
 664   return start_;
 665 }
 666
 667 double Action::getFinishTime()
 668 {
 669   /* keep the function behavior, some models (cpu_ti) change the finish time before the action end */
 670   return remains_ == 0 ? finishTime_ : -1;
 671 }
 672
 673 void Action::setData(void* data)
 674 {
 675   data_ = data;
 676 }
 677
 678 void Action::setCategory(const char *category)
 679 {
 680   category_ = xbt_strdup(category);
 681 }
 682
 683 void Action::ref(){
 684   refcount_++;
 685 }
 686
 687 void Action::setMaxDuration(double duration)
 688 {
 689   maxDuration_ = duration;
 690   if (getModel()->getUpdateMechanism() == UM_LAZY)      // remove action from the heap
 691     heapRemove(getModel()->getActionHeap());
 692 }
 693
 694 void Action::gapRemove() {}
 695
 696 void Action::setPriority(double priority)
 697 {
 698   XBT_IN("(%p,%g)", this, priority);
 699   priority_ = priority;
 700   lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), priority);
 701
 702   if (getModel()->getUpdateMechanism() == UM_LAZY)
 703     heapRemove(getModel()->getActionHeap());
 704   XBT_OUT();
 705 }
 706
 707 void Action::cancel(){
 708   setState(Action::State::failed);
 709   if (getModel()->getUpdateMechanism() == UM_LAZY) {
 710     if (action_lmm_hook.is_linked())
 711       getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
 712     heapRemove(getModel()->getActionHeap());
 713   }
 714 }
 715
 716 int Action::unref(){
 717   refcount_--;
 718   if (!refcount_) {
 719     if (action_hook.is_linked())
 720       stateSet_->erase(stateSet_->iterator_to(*this));
 721     if (getVariable())
 722       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
 723     if (getModel()->getUpdateMechanism() == UM_LAZY) {
 724       /* remove from heap */
 725       heapRemove(getModel()->getActionHeap());
 726       if (action_lmm_hook.is_linked())
 727         getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
 728     }
 729     delete this;
 730     return 1;
 731   }
 732   return 0;
 733 }
 734
 735 void Action::suspend()
 736 {
 737   XBT_IN("(%p)", this);
 738   if (suspended_ != 2) {
 739     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
 740     if (getModel()->getUpdateMechanism() == UM_LAZY){
 741       heapRemove(getModel()->getActionHeap());
 742       if (getModel()->getUpdateMechanism() == UM_LAZY  && stateSet_ == getModel()->getRunningActionSet() && priority_ > 0){
 743         //If we have a lazy model, we need to update the remaining value accordingly
 744         updateRemainingLazy(surf_get_clock());
 745       }
 746     }
 747     suspended_ = 1;
 748   }
 749   XBT_OUT();
 750 }
 751
 752 void Action::resume()
 753 {
 754   XBT_IN("(%p)", this);
 755   if (suspended_ != 2) {
 756     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), priority_);
 757     suspended_ = 0;
 758     if (getModel()->getUpdateMechanism() == UM_LAZY)
 759       heapRemove(getModel()->getActionHeap());
 760   }
 761   XBT_OUT();
 762 }
 763
 764 bool Action::isSuspended()
 765 {
 766   return suspended_ == 1;
 767 }
 768 /* insert action on heap using a given key and a hat (heap_action_type)
 769  * a hat can be of three types for communications:
 770  *
 771  * NORMAL = this is a normal heap entry stating the date to finish transmitting
 772  * LATENCY = this is a heap entry to warn us when the latency is payed
 773  * MAX_DURATION =this is a heap entry to warn us when the max_duration limit is reached
 774  */
 775 void Action::heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat)
 776 {
 777   hat_ = hat;
 778   xbt_heap_push(heap, this, key);
 779 }
 780
 781 void Action::heapRemove(xbt_heap_t heap)
 782 {
 783   hat_ = NOTSET;
 784   if (indexHeap_ >= 0) {
 785     xbt_heap_remove(heap, indexHeap_);
 786   }
 787 }
 788
 789 void Action::heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat)
 790 {
 791   hat_ = hat;
 792   if (indexHeap_ >= 0) {
 793     xbt_heap_update(heap, indexHeap_, key);
 794   }else{
 795     xbt_heap_push(heap, this, key);
 796   }
 797 }
 798
 799 void Action::updateIndexHeap(int i) {
 800   indexHeap_ = i;
 801 }
 802
 803 double Action::getRemains()
 804 {
 805   XBT_IN("(%p)", this);
 806   /* update remains before return it */
 807   if (getModel()->getUpdateMechanism() == UM_LAZY)      /* update remains before return it */
 808     updateRemainingLazy(surf_get_clock());
 809   XBT_OUT();
 810   return remains_;
 811 }
 812
 813 double Action::getRemainsNoUpdate()
 814 {
 815   return remains_;
 816 }
 817
 818 //FIXME split code in the right places
 819 void Action::updateRemainingLazy(double now)
 820 {
 821   double delta = 0.0;
 822
 823   if(getModel() == surf_network_model)
 824   {
 825     if (suspended_ != 0)
 826       return;
 827   }
 828   else
 829   {
 830     xbt_assert(stateSet_ == getModel()->getRunningActionSet(), "You're updating an action that is not running.");
 831     xbt_assert(priority_ > 0, "You're updating an action that seems suspended.");
 832   }
 833
 834   delta = now - lastUpdate_;
 835
 836   if (remains_ > 0) {
 837     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, remains_, lastUpdate_);
 838     double_update(&remains_, lastValue_ * delta, sg_surf_precision*sg_maxmin_precision);
 839
 840     if (getModel() == surf_cpu_model_pm && TRACE_is_enabled()) {
 841       simgrid::surf::Resource *cpu = static_cast<simgrid::surf::Resource*>(
 842         lmm_constraint_id(lmm_get_cnst_from_var(getModel()->getMaxminSystem(), getVariable(), 0)));
 843       TRACE_surf_host_set_utilization(cpu->getName(), getCategory(), lastValue_, lastUpdate_, now - lastUpdate_);
 844     }
 845     XBT_DEBUG("Updating action(%p): remains is now %f", this, remains_);
 846   }
 847
 848   if(getModel() == surf_network_model)
 849   {
 850     if (maxDuration_ != NO_MAX_DURATION)
 851       double_update(&maxDuration_, delta, sg_surf_precision);
 852
 853     //FIXME: duplicated code
 854     if ((remains_ <= 0) &&
 855         (lmm_get_variable_weight(getVariable()) > 0)) {
 856       finish();
 857       setState(Action::State::done);
 858       heapRemove(getModel()->getActionHeap());
 859     } else if (((maxDuration_ != NO_MAX_DURATION)
 860         && (maxDuration_ <= 0))) {
 861       finish();
 862       setState(Action::State::done);
 863       heapRemove(getModel()->getActionHeap());
 864     }
 865   }
 866
 867   lastUpdate_ = now;
 868   lastValue_ = lmm_variable_getvalue(getVariable());
 869 }
 870
 871 }
 872 }