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_PROP_ASR_LEVEL = xbt_lib_add_level(as_router_lib, nullptr);
 300   ROUTING_ASR_LEVEL = xbt_lib_add_level(as_router_lib, [](void* p) {
 301     delete static_cast<simgrid::kernel::routing::NetCard*>(p);
 302   });
 303
 304   XBT_DEBUG("Add SURF levels");
 305   SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_free);
 306
 307   xbt_init(argc, argv);
 308   if (!all_existing_models)
 309     all_existing_models = new std::vector<simgrid::surf::Model*>();
 310   if (!model_list_invoke)
 311     model_list_invoke = xbt_dynar_new(sizeof(simgrid::surf::Model*), nullptr);
 312   if (!future_evt_set)
 313     future_evt_set = new simgrid::trace_mgr::future_evt_set();
 314
 315   TRACE_add_start_function(TRACE_surf_alloc);
 316   TRACE_add_end_function(TRACE_surf_release);
 317
 318   sg_config_init(argc, argv);
 319
 320   if (MC_is_active())
 321     MC_memory_init();
 322 }
 323
 324 void surf_exit()
 325 {
 326   TRACE_end();                  /* Just in case it was not called by the upper layer (or there is no upper layer) */
 327
 328   xbt_dynar_free(&surf_path);
 329
 330   sg_host_exit();
 331   xbt_lib_free(&as_router_lib);
 332   xbt_lib_free(&storage_lib);
 333   sg_link_exit();
 334   xbt_lib_free(&storage_type_lib);
 335   xbt_lib_free(&file_lib);
 336   xbt_dict_free(&watched_hosts_lib);
 337
 338   for (auto model : *all_existing_models)
 339     delete model;
 340   delete all_existing_models;
 341   xbt_dynar_free(&model_list_invoke);
 342
 343   simgrid::surf::surfExitCallbacks();
 344
 345   if (future_evt_set) {
 346     delete future_evt_set;
 347     future_evt_set = nullptr;
 348   }
 349
 350 #if HAVE_THREAD_CONTEXTS
 351   xbt_parmap_destroy(surf_parmap);
 352 #endif
 353
 354   tmgr_finalize();
 355   sg_platf_exit();
 356   simgrid::s4u::Engine::shutdown();
 357
 358   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
 359 }
 360
 361 /*********
 362  * Model *
 363  *********/
 364
 365 namespace simgrid {
 366 namespace surf {
 367
 368 Model::Model()
 369   : maxminSystem_(nullptr)
 370 {
 371   readyActionSet_ = new ActionList();
 372   runningActionSet_ = new ActionList();
 373   failedActionSet_ = new ActionList();
 374   doneActionSet_ = new ActionList();
 375
 376   modifiedSet_ = nullptr;
 377   actionHeap_ = nullptr;
 378   updateMechanism_ = UM_UNDEFINED;
 379   selectiveUpdate_ = 0;
 380 }
 381
 382 Model::~Model(){
 383   delete readyActionSet_;
 384   delete runningActionSet_;
 385   delete failedActionSet_;
 386   delete doneActionSet_;
 387 }
 388
 389 double Model::nextOccuringEvent(double now)
 390 {
 391   //FIXME: set the good function once and for all
 392   if (updateMechanism_ == UM_LAZY)
 393     return nextOccuringEventLazy(now);
 394   else if (updateMechanism_ == UM_FULL)
 395     return nextOccuringEventFull(now);
 396   else
 397     xbt_die("Invalid cpu update mechanism!");
 398 }
 399
 400 double Model::nextOccuringEventLazy(double now)
 401 {
 402   XBT_DEBUG("Before share resources, the size of modified actions set is %zd", modifiedSet_->size());
 403   lmm_solve(maxminSystem_);
 404   XBT_DEBUG("After share resources, The size of modified actions set is %zd", modifiedSet_->size());
 405
 406   while(!modifiedSet_->empty()) {
 407     Action *action = &(modifiedSet_->front());
 408     modifiedSet_->pop_front();
 409     int max_dur_flag = 0;
 410
 411     if (action->getStateSet() != runningActionSet_)
 412       continue;
 413
 414     /* bogus priority, skip it */
 415     if (action->getPriority() <= 0 || action->getHat()==LATENCY)
 416       continue;
 417
 418     action->updateRemainingLazy(now);
 419
 420     double min = -1;
 421     double share = lmm_variable_getvalue(action->getVariable());
 422
 423     if (share > 0) {
 424       double time_to_completion;
 425       if (action->getRemains() > 0) {
 426         time_to_completion = action->getRemainsNoUpdate() / share;
 427       } else {
 428         time_to_completion = 0.0;
 429       }
 430       min = now + time_to_completion; // when the task will complete if nothing changes
 431     }
 432
 433     if ((action->getMaxDuration() != NO_MAX_DURATION)
 434         && (min == -1
 435             || action->getStartTime() +
 436             action->getMaxDuration() < min)) {
 437       min = action->getStartTime() +
 438           action->getMaxDuration();  // when the task will complete anyway because of the deadline if any
 439       max_dur_flag = 1;
 440     }
 441
 442
 443     XBT_DEBUG("Action(%p) corresponds to variable %d", action, action->getVariable()->id_int);
 444
 445     XBT_DEBUG("Action(%p) Start %f. May finish at %f (got a share of %f). Max_duration %f", action,
 446         action->getStartTime(), min, share,
 447         action->getMaxDuration());
 448
 449     if (min != -1) {
 450       action->heapUpdate(actionHeap_, min, max_dur_flag ? MAX_DURATION : NORMAL);
 451       XBT_DEBUG("Insert at heap action(%p) min %f now %f", action, min,
 452                 now);
 453     } else DIE_IMPOSSIBLE;
 454   }
 455
 456   //hereafter must have already the min value for this resource model
 457   if (xbt_heap_size(actionHeap_) > 0) {
 458     double min = xbt_heap_maxkey(actionHeap_) - now;
 459     XBT_DEBUG("minimum with the HEAP %f", min);
 460     return min;
 461   } else {
 462     XBT_DEBUG("The HEAP is empty, thus returning -1");
 463     return -1;
 464   }
 465 }
 466
 467 double Model::nextOccuringEventFull(double /*now*/) {
 468   maxminSystem_->solve_fun(maxminSystem_);
 469
 470   double min = -1;
 471   for (auto it(getRunningActionSet()->begin()), itend(getRunningActionSet()->end()); it != itend ; ++it) {
 472     Action *action = &*it;
 473     double value = lmm_variable_getvalue(action->getVariable());
 474     if (value > 0) {
 475       if (action->getRemains() > 0)
 476         value = action->getRemainsNoUpdate() / value;
 477       else
 478         value = 0.0;
 479       if (min < 0 || value < min) {
 480         min = value;
 481         XBT_DEBUG("Updating min (value) with %p: %f", action, min);
 482       }
 483     }
 484     if ((action->getMaxDuration() >= 0) && (min<0 || action->getMaxDuration() < min)) {
 485       min = action->getMaxDuration();
 486       XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
 487     }
 488   }
 489   XBT_DEBUG("min value : %f", min);
 490
 491   return min;
 492 }
 493
 494 void Model::updateActionsState(double now, double delta)
 495 {
 496   if (updateMechanism_ == UM_FULL)
 497     updateActionsStateFull(now, delta);
 498   else if (updateMechanism_ == UM_LAZY)
 499     updateActionsStateLazy(now, delta);
 500   else
 501     xbt_die("Invalid cpu update mechanism!");
 502 }
 503
 504 void Model::updateActionsStateLazy(double /*now*/, double /*delta*/)
 505 {
 506   THROW_UNIMPLEMENTED;
 507 }
 508
 509 void Model::updateActionsStateFull(double /*now*/, double /*delta*/)
 510 {
 511   THROW_UNIMPLEMENTED;
 512 }
 513
 514 }
 515 }
 516
 517 /************
 518  * Resource *
 519  ************/
 520
 521 namespace simgrid {
 522 namespace surf {
 523
 524 Resource::Resource(Model* model, const char* name, lmm_constraint_t constraint)
 525     : name_(name), model_(model), constraint_(constraint)
 526 {}
 527
 528 Resource::~Resource() = default;
 529
 530 bool Resource::isOn() const {
 531   return isOn_;
 532 }
 533 bool Resource::isOff() const {
 534   return ! isOn_;
 535 }
 536
 537 void Resource::turnOn()
 538 {
 539   isOn_ = true;
 540 }
 541
 542 void Resource::turnOff()
 543 {
 544   isOn_ = false;
 545 }
 546
 547 Model *Resource::getModel() const {
 548   return model_;
 549 }
 550
 551 const char *Resource::getName() const {
 552   return name_.c_str();
 553 }
 554
 555 bool Resource::operator==(const Resource &other) const {
 556   return name_ == other.name_;
 557 }
 558
 559 lmm_constraint_t Resource::getConstraint() const {
 560   return constraint_;
 561 }
 562
 563 }
 564 }
 565
 566 /**********
 567  * Action *
 568  **********/
 569
 570 const char *surf_action_state_names[6] = {
 571   "SURF_ACTION_READY",
 572   "SURF_ACTION_RUNNING",
 573   "SURF_ACTION_FAILED",
 574   "SURF_ACTION_DONE",
 575   "SURF_ACTION_TO_FREE",
 576   "SURF_ACTION_NOT_IN_THE_SYSTEM"
 577 };
 578
 579 /* added to manage the communication action's heap */
 580 void surf_action_lmm_update_index_heap(void *action, int i) {
 581   static_cast<simgrid::surf::Action*>(action)->updateIndexHeap(i);
 582 }
 583
 584 namespace simgrid {
 585 namespace surf {
 586
 587 Action::Action(simgrid::surf::Model* model, double cost, bool failed) : Action(model, cost, failed, nullptr)
 588 {
 589 }
 590
 591 Action::Action(simgrid::surf::Model* model, double cost, bool failed, lmm_variable_t var)
 592     : remains_(cost), start_(surf_get_clock()), cost_(cost), model_(model), variable_(var)
 593 {
 594   if (failed)
 595     stateSet_ = getModel()->getFailedActionSet();
 596   else
 597     stateSet_ = getModel()->getRunningActionSet();
 598
 599   stateSet_->push_back(*this);
 600 }
 601
 602 Action::~Action() {
 603   xbt_free(category_);
 604 }
 605
 606 void Action::finish() {
 607     finishTime_ = surf_get_clock();
 608 }
 609
 610 Action::State Action::getState()
 611 {
 612   if (stateSet_ ==  getModel()->getReadyActionSet())
 613     return Action::State::ready;
 614   if (stateSet_ ==  getModel()->getRunningActionSet())
 615     return Action::State::running;
 616   if (stateSet_ ==  getModel()->getFailedActionSet())
 617     return Action::State::failed;
 618   if (stateSet_ ==  getModel()->getDoneActionSet())
 619     return Action::State::done;
 620   return Action::State::not_in_the_system;
 621 }
 622
 623 void Action::setState(Action::State state)
 624 {
 625   stateSet_->erase(stateSet_->iterator_to(*this));
 626   switch (state) {
 627   case Action::State::ready:
 628     stateSet_ = getModel()->getReadyActionSet();
 629     break;
 630   case Action::State::running:
 631     stateSet_ = getModel()->getRunningActionSet();
 632     break;
 633   case Action::State::failed:
 634     stateSet_ = getModel()->getFailedActionSet();
 635     break;
 636   case Action::State::done:
 637     stateSet_ = getModel()->getDoneActionSet();
 638     break;
 639   default:
 640     stateSet_ = nullptr;
 641     break;
 642   }
 643   if (stateSet_)
 644     stateSet_->push_back(*this);
 645 }
 646
 647 double Action::getBound()
 648 {
 649   return (variable_) ? lmm_variable_getbound(variable_) : 0;
 650 }
 651
 652 void Action::setBound(double bound)
 653 {
 654   XBT_IN("(%p,%g)", this, bound);
 655   if (variable_)
 656     lmm_update_variable_bound(getModel()->getMaxminSystem(), variable_, bound);
 657
 658   if (getModel()->getUpdateMechanism() == UM_LAZY && getLastUpdate()!=surf_get_clock())
 659     heapRemove(getModel()->getActionHeap());
 660   XBT_OUT();
 661 }
 662
 663 double Action::getStartTime()
 664 {
 665   return start_;
 666 }
 667
 668 double Action::getFinishTime()
 669 {
 670   /* keep the function behavior, some models (cpu_ti) change the finish time before the action end */
 671   return remains_ == 0 ? finishTime_ : -1;
 672 }
 673
 674 void Action::setData(void* data)
 675 {
 676   data_ = data;
 677 }
 678
 679 void Action::setCategory(const char *category)
 680 {
 681   category_ = xbt_strdup(category);
 682 }
 683
 684 void Action::ref(){
 685   refcount_++;
 686 }
 687
 688 void Action::setMaxDuration(double duration)
 689 {
 690   maxDuration_ = duration;
 691   if (getModel()->getUpdateMechanism() == UM_LAZY)      // remove action from the heap
 692     heapRemove(getModel()->getActionHeap());
 693 }
 694
 695 void Action::gapRemove() {}
 696
 697 void Action::setPriority(double priority)
 698 {
 699   XBT_IN("(%p,%g)", this, priority);
 700   priority_ = priority;
 701   lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), priority);
 702
 703   if (getModel()->getUpdateMechanism() == UM_LAZY)
 704     heapRemove(getModel()->getActionHeap());
 705   XBT_OUT();
 706 }
 707
 708 void Action::cancel(){
 709   setState(Action::State::failed);
 710   if (getModel()->getUpdateMechanism() == UM_LAZY) {
 711     if (action_lmm_hook.is_linked())
 712       getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
 713     heapRemove(getModel()->getActionHeap());
 714   }
 715 }
 716
 717 int Action::unref(){
 718   refcount_--;
 719   if (!refcount_) {
 720     if (action_hook.is_linked())
 721       stateSet_->erase(stateSet_->iterator_to(*this));
 722     if (getVariable())
 723       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
 724     if (getModel()->getUpdateMechanism() == UM_LAZY) {
 725       /* remove from heap */
 726       heapRemove(getModel()->getActionHeap());
 727       if (action_lmm_hook.is_linked())
 728         getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
 729     }
 730     delete this;
 731     return 1;
 732   }
 733   return 0;
 734 }
 735
 736 void Action::suspend()
 737 {
 738   XBT_IN("(%p)", this);
 739   if (suspended_ != 2) {
 740     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
 741     if (getModel()->getUpdateMechanism() == UM_LAZY){
 742       heapRemove(getModel()->getActionHeap());
 743       if (getModel()->getUpdateMechanism() == UM_LAZY  && stateSet_ == getModel()->getRunningActionSet() && priority_ > 0){
 744         //If we have a lazy model, we need to update the remaining value accordingly
 745         updateRemainingLazy(surf_get_clock());
 746       }
 747     }
 748     suspended_ = 1;
 749   }
 750   XBT_OUT();
 751 }
 752
 753 void Action::resume()
 754 {
 755   XBT_IN("(%p)", this);
 756   if (suspended_ != 2) {
 757     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), priority_);
 758     suspended_ = 0;
 759     if (getModel()->getUpdateMechanism() == UM_LAZY)
 760       heapRemove(getModel()->getActionHeap());
 761   }
 762   XBT_OUT();
 763 }
 764
 765 bool Action::isSuspended()
 766 {
 767   return suspended_ == 1;
 768 }
 769 /* insert action on heap using a given key and a hat (heap_action_type)
 770  * a hat can be of three types for communications:
 771  *
 772  * NORMAL = this is a normal heap entry stating the date to finish transmitting
 773  * LATENCY = this is a heap entry to warn us when the latency is payed
 774  * MAX_DURATION =this is a heap entry to warn us when the max_duration limit is reached
 775  */
 776 void Action::heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat)
 777 {
 778   hat_ = hat;
 779   xbt_heap_push(heap, this, key);
 780 }
 781
 782 void Action::heapRemove(xbt_heap_t heap)
 783 {
 784   hat_ = NOTSET;
 785   if (indexHeap_ >= 0) {
 786     xbt_heap_remove(heap, indexHeap_);
 787   }
 788 }
 789
 790 void Action::heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat)
 791 {
 792   hat_ = hat;
 793   if (indexHeap_ >= 0) {
 794     xbt_heap_update(heap, indexHeap_, key);
 795   }else{
 796     xbt_heap_push(heap, this, key);
 797   }
 798 }
 799
 800 void Action::updateIndexHeap(int i) {
 801   indexHeap_ = i;
 802 }
 803
 804 double Action::getRemains()
 805 {
 806   XBT_IN("(%p)", this);
 807   /* update remains before return it */
 808   if (getModel()->getUpdateMechanism() == UM_LAZY)      /* update remains before return it */
 809     updateRemainingLazy(surf_get_clock());
 810   XBT_OUT();
 811   return remains_;
 812 }
 813
 814 double Action::getRemainsNoUpdate()
 815 {
 816   return remains_;
 817 }
 818
 819 //FIXME split code in the right places
 820 void Action::updateRemainingLazy(double now)
 821 {
 822   double delta = 0.0;
 823
 824   if(getModel() == surf_network_model)
 825   {
 826     if (suspended_ != 0)
 827       return;
 828   }
 829   else
 830   {
 831     xbt_assert(stateSet_ == getModel()->getRunningActionSet(), "You're updating an action that is not running.");
 832     xbt_assert(priority_ > 0, "You're updating an action that seems suspended.");
 833   }
 834
 835   delta = now - lastUpdate_;
 836
 837   if (remains_ > 0) {
 838     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, remains_, lastUpdate_);
 839     double_update(&remains_, lastValue_ * delta, sg_surf_precision*sg_maxmin_precision);
 840
 841     if (getModel() == surf_cpu_model_pm && TRACE_is_enabled()) {
 842       simgrid::surf::Resource *cpu = static_cast<simgrid::surf::Resource*>(
 843         lmm_constraint_id(lmm_get_cnst_from_var(getModel()->getMaxminSystem(), getVariable(), 0)));
 844       TRACE_surf_host_set_utilization(cpu->getName(), getCategory(), lastValue_, lastUpdate_, now - lastUpdate_);
 845     }
 846     XBT_DEBUG("Updating action(%p): remains is now %f", this, remains_);
 847   }
 848
 849   if(getModel() == surf_network_model)
 850   {
 851     if (maxDuration_ != NO_MAX_DURATION)
 852       double_update(&maxDuration_, delta, sg_surf_precision);
 853
 854     //FIXME: duplicated code
 855     if ((remains_ <= 0) &&
 856         (lmm_get_variable_weight(getVariable()) > 0)) {
 857       finish();
 858       setState(Action::State::done);
 859       heapRemove(getModel()->getActionHeap());
 860     } else if (((maxDuration_ != NO_MAX_DURATION)
 861         && (maxDuration_ <= 0))) {
 862       finish();
 863       setState(Action::State::done);
 864       heapRemove(getModel()->getActionHeap());
 865     }
 866   }
 867
 868   lastUpdate_ = now;
 869   lastValue_ = lmm_variable_getvalue(getVariable());
 870 }
 871
 872 }
 873 }