src/surf/surf_interface.cpp

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