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