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/NetPoint.hpp"
  16 #include "src/simix/smx_host_private.h"
  17 #include "src/surf/HostImpl.hpp"
  18 #include "surf_private.h"
  19 #include <fstream>
  20 #include <vector>
  21
  22 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
  23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf, "Logging specific to SURF (kernel)");
  24
  25 /*********
  26  * Utils *
  27  *********/
  28
  29 std::vector<surf_model_t> * all_existing_models = nullptr; /* to destroy models correctly */
  30
  31 simgrid::trace_mgr::future_evt_set *future_evt_set = nullptr;
  32 std::vector<std::string> surf_path;
  33 std::vector<simgrid::s4u::Host*> host_that_restart;
  34 xbt_dict_t watched_hosts_lib;
  35
  36 namespace simgrid {
  37 namespace surf {
  38
  39 simgrid::xbt::signal<void(void)> surfExitCallbacks;
  40
  41 }
  42 }
  43
  44 #include <simgrid/plugins/energy.h> // FIXME: this plugin should not be linked to the core
  45 #include <simgrid/plugins/load.h>   // FIXME: this plugin should not be linked to the core
  46
  47 s_surf_model_description_t surf_plugin_description[] = {
  48     {"Energy", "Cpu energy consumption.", &sg_host_energy_plugin_init},
  49     {"Load", "Cpu load.", &sg_host_load_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 std::ifstream* surf_ifsopen(const char* name)
 132 {
 133   std::ifstream* fs = new std::ifstream();
 134   xbt_assert(name);
 135   if (__surf_is_absolute_file_path(name)) { /* don't mess with absolute file names */
 136     fs->open(name, std::ifstream::in);
 137   }
 138   /* search relative files in the path */
 139   for (auto path_elm : surf_path) {
 140     std::string buff = path_elm + FILE_DELIM + name;
 141     fs->open(buff.c_str(), std::ifstream::in);
 142
 143     if (!fs->fail()) {
 144       XBT_DEBUG("Found file at %s", buff.c_str());
 145       return fs;
 146     }
 147   }
 148
 149   return fs;
 150 }
 151 FILE *surf_fopen(const char *name, const char *mode)
 152 {
 153   char *buff;
 154   FILE *file = nullptr;
 155
 156   xbt_assert(name);
 157
 158   if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
 159     return fopen(name, mode);
 160
 161   /* search relative files in the path */
 162   for (auto path_elm : surf_path) {
 163     buff = bprintf("%s" FILE_DELIM "%s", path_elm.c_str(), name);
 164     file = fopen(buff, mode);
 165     free(buff);
 166
 167     if (file)
 168       return file;
 169   }
 170   return nullptr;
 171 }
 172
 173 #ifdef _WIN32
 174 #include <windows.h>
 175 #define MAX_DRIVE 26
 176 static const char *disk_drives_letter_table[MAX_DRIVE] = {
 177   "A:\\","B:\\","C:\\","D:\\","E:\\","F:\\","G:\\","H:\\","I:\\","J:\\","K:\\","L:\\","M:\\",
 178   "N:\\","O:\\","P:\\","Q:\\","R:\\","S:\\","T:\\","U:\\","V:\\","W:\\","X:\\","Y:\\","Z:\\"
 179 };
 180 #endif
 181
 182 /*
 183  * Returns the initial path. On Windows the initial path is
 184  * the current directory for the current process in the other
 185  * case the function returns "./" that represents the current
 186  * directory on Unix/Linux platforms.
 187  */
 188
 189 const char *__surf_get_initial_path()
 190 {
 191
 192 #ifdef _WIN32
 193   unsigned i;
 194   char current_directory[MAX_PATH + 1] = { 0 };
 195   unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
 196   char root[4] = { 0 };
 197
 198   if (!len)
 199     return nullptr;
 200
 201   strncpy(root, current_directory, 3);
 202
 203   for (i = 0; i < MAX_DRIVE; i++) {
 204     if (toupper(root[0]) == disk_drives_letter_table[i][0])
 205       return disk_drives_letter_table[i];
 206   }
 207
 208   return nullptr;
 209 #else
 210   return "./";
 211 #endif
 212 }
 213
 214 /* The __surf_is_absolute_file_path() returns 1 if
 215  * file_path is a absolute file path, in the other
 216  * case the function returns 0.
 217  */
 218 int __surf_is_absolute_file_path(const char *file_path)
 219 {
 220 #ifdef _WIN32
 221   WIN32_FIND_DATA wfd = { 0 };
 222   HANDLE hFile = FindFirstFile(file_path, &wfd);
 223
 224   if (INVALID_HANDLE_VALUE == hFile)
 225     return 0;
 226
 227   FindClose(hFile);
 228   return 1;
 229 #else
 230   return (file_path[0] == '/');
 231 #endif
 232 }
 233
 234 /** Displays the long description of all registered models, and quit */
 235 void model_help(const char *category, s_surf_model_description_t * table)
 236 {
 237   printf("Long description of the %s models accepted by this simulator:\n", category);
 238   for (int i = 0; table[i].name; i++)
 239     printf("  %s: %s\n", table[i].name, table[i].description);
 240 }
 241
 242 int find_model_description(s_surf_model_description_t * table,
 243                            const char *name)
 244 {
 245   int i;
 246   char *name_list = nullptr;
 247
 248   for (i = 0; table[i].name; i++)
 249     if (!strcmp(name, table[i].name)) {
 250       return i;
 251     }
 252   if (!table[0].name)
 253     xbt_die("No model is valid! This is a bug.");
 254   name_list = xbt_strdup(table[0].name);
 255   for (i = 1; table[i].name; i++) {
 256     name_list = (char *) xbt_realloc(name_list, strlen(name_list) + strlen(table[i].name) + 3);
 257     strncat(name_list, ", ", 2);
 258     strncat(name_list, table[i].name, strlen(table[i].name));
 259   }
 260   xbt_die("Model '%s' is invalid! Valid models are: %s.", name, name_list);
 261   return -1;
 262 }
 263
 264 static inline void surf_storage_free(void *r)
 265 {
 266   delete static_cast<simgrid::surf::Storage*>(r);
 267 }
 268
 269 void sg_version_check(int lib_version_major,int lib_version_minor,int lib_version_patch) {
 270     if ((lib_version_major != SIMGRID_VERSION_MAJOR) || (lib_version_minor != SIMGRID_VERSION_MINOR)) {
 271       fprintf(stderr,
 272           "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
 273           "and then linked against SimGrid %d.%d.%d. Please fix this.\n",
 274           lib_version_major,lib_version_minor,lib_version_patch,
 275           SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);
 276       abort();
 277     }
 278     if (lib_version_patch != SIMGRID_VERSION_PATCH) {
 279       if(SIMGRID_VERSION_PATCH >= 90 || lib_version_patch >=90){
 280         fprintf(stderr,
 281         "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
 282         "and then linked against SimGrid %d.%d.%d. \n"
 283         "One of them is a development version, and should not be mixed with the stable release. Please fix this.\n",
 284         lib_version_major,lib_version_minor,lib_version_patch,
 285         SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);
 286         abort();
 287       }
 288         fprintf(stderr,
 289             "Warning: Your program was compiled with SimGrid version %d.%d.%d, "
 290             "and then linked against SimGrid %d.%d.%d. Proceeding anyway.\n",
 291             lib_version_major,lib_version_minor,lib_version_patch,
 292             SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);
 293     }
 294 }
 295
 296 void sg_version_get(int* ver_major, int* ver_minor, int* ver_patch)
 297 {
 298   *ver_major = SIMGRID_VERSION_MAJOR;
 299   *ver_minor = SIMGRID_VERSION_MINOR;
 300   *ver_patch = SIMGRID_VERSION_PATCH;
 301 }
 302
 303 void sg_version()
 304 {
 305   std::printf("This program was linked against %s (git: %s), found in %s.\n",
 306               SIMGRID_VERSION_STRING, SIMGRID_GIT_VERSION, SIMGRID_INSTALL_PREFIX);
 307
 308 #if HAVE_MC
 309   std::printf("   Model-checking support compiled in.\n");
 310 #else
 311   std::printf("   Model-checking support disabled at compilation.\n");
 312 #endif
 313
 314 #if HAVE_NS3
 315   std::printf("   NS3 support compiled in.\n");
 316 #else
 317   std::printf("   NS3 support disabled at compilation.\n");
 318 #endif
 319
 320 #if HAVE_JEDULE
 321   std::printf("   Jedule support compiled in.\n");
 322 #else
 323   std::printf("   Jedule support disabled at compilation.\n");
 324 #endif
 325
 326 #if HAVE_LUA
 327   std::printf("   Lua support compiled in.\n");
 328 #else
 329   std::printf("   Lua support disabled at compilation.\n");
 330 #endif
 331
 332 #if HAVE_MALLOCATOR
 333   std::printf("   Mallocator support compiled in.\n");
 334 #else
 335   std::printf("   Mallocator support disabled at compilation.\n");
 336 #endif
 337
 338   std::printf("\nTo cite SimGrid in a publication, please use:\n"
 339               "   Henri Casanova, Arnaud Giersch, Arnaud Legrand, Martin Quinson, Frédéric Suter. \n"
 340               "   Versatile, Scalable, and Accurate Simulation of Distributed Applications and Platforms. \n"
 341               "   Journal of Parallel and Distributed Computing, Elsevier, 2014, 74 (10), pp.2899-2917.\n");
 342   std::printf("The pdf file and a BibTeX entry for LaTeX users can be found at http://hal.inria.fr/hal-01017319\n");
 343 }
 344
 345 void surf_init(int *argc, char **argv)
 346 {
 347   if (USER_HOST_LEVEL != -1) // Already initialized
 348     return;
 349
 350   XBT_DEBUG("Create all Libs");
 351   USER_HOST_LEVEL = simgrid::s4u::Host::extension_create(nullptr);
 352
 353   storage_lib = xbt_lib_new();
 354   storage_type_lib = xbt_lib_new();
 355   file_lib = xbt_lib_new();
 356   watched_hosts_lib = xbt_dict_new_homogeneous(nullptr);
 357
 358   XBT_DEBUG("Add SURF levels");
 359   SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_free);
 360
 361   xbt_init(argc, argv);
 362   if (!all_existing_models)
 363     all_existing_models = new std::vector<simgrid::surf::Model*>();
 364   if (!future_evt_set)
 365     future_evt_set = new simgrid::trace_mgr::future_evt_set();
 366
 367   TRACE_add_start_function(TRACE_surf_alloc);
 368   TRACE_add_end_function(TRACE_surf_release);
 369
 370   sg_config_init(argc, argv);
 371
 372   if (MC_is_active())
 373     MC_memory_init();
 374 }
 375
 376 void surf_exit()
 377 {
 378   TRACE_end();                  /* Just in case it was not called by the upper layer (or there is no upper layer) */
 379
 380   sg_host_exit();
 381   xbt_lib_free(&storage_lib);
 382   sg_link_exit();
 383   xbt_lib_free(&storage_type_lib);
 384   xbt_lib_free(&file_lib);
 385   xbt_dict_free(&watched_hosts_lib);
 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(!modifiedSet_->empty()) {
 455     Action *action = &(modifiedSet_->front());
 456     modifiedSet_->pop_front();
 457     int max_dur_flag = 0;
 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 = 1;
 486     }
 487
 488
 489     XBT_DEBUG("Action(%p) corresponds to variable %d", action, action->getVariable()->id_int);
 490
 491     XBT_DEBUG("Action(%p) Start %f. May finish at %f (got a share of %f). Max_duration %f", action,
 492         action->getStartTime(), min, share,
 493         action->getMaxDuration());
 494
 495     if (min != -1) {
 496       action->heapUpdate(actionHeap_, min, max_dur_flag ? MAX_DURATION : NORMAL);
 497       XBT_DEBUG("Insert at heap action(%p) min %f now %f", action, min,
 498                 now);
 499     } else DIE_IMPOSSIBLE;
 500   }
 501
 502   //hereafter must have already the min value for this resource model
 503   if (xbt_heap_size(actionHeap_) > 0) {
 504     double min = xbt_heap_maxkey(actionHeap_) - now;
 505     XBT_DEBUG("minimum with the HEAP %f", min);
 506     return min;
 507   } else {
 508     XBT_DEBUG("The HEAP is empty, thus returning -1");
 509     return -1;
 510   }
 511 }
 512
 513 double Model::nextOccuringEventFull(double /*now*/) {
 514   maxminSystem_->solve_fun(maxminSystem_);
 515
 516   double min = -1;
 517   for (auto it(getRunningActionSet()->begin()), itend(getRunningActionSet()->end()); it != itend ; ++it) {
 518     Action *action = &*it;
 519     double value = lmm_variable_getvalue(action->getVariable());
 520     if (value > 0) {
 521       if (action->getRemains() > 0)
 522         value = action->getRemainsNoUpdate() / value;
 523       else
 524         value = 0.0;
 525       if (min < 0 || value < min) {
 526         min = value;
 527         XBT_DEBUG("Updating min (value) with %p: %f", action, min);
 528       }
 529     }
 530     if ((action->getMaxDuration() >= 0) && (min<0 || action->getMaxDuration() < min)) {
 531       min = action->getMaxDuration();
 532       XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
 533     }
 534   }
 535   XBT_DEBUG("min value : %f", min);
 536
 537   return min;
 538 }
 539
 540 void Model::updateActionsState(double now, double delta)
 541 {
 542   if (updateMechanism_ == UM_FULL)
 543     updateActionsStateFull(now, delta);
 544   else if (updateMechanism_ == UM_LAZY)
 545     updateActionsStateLazy(now, delta);
 546   else
 547     xbt_die("Invalid cpu update mechanism!");
 548 }
 549
 550 void Model::updateActionsStateLazy(double /*now*/, double /*delta*/)
 551 {
 552   THROW_UNIMPLEMENTED;
 553 }
 554
 555 void Model::updateActionsStateFull(double /*now*/, double /*delta*/)
 556 {
 557   THROW_UNIMPLEMENTED;
 558 }
 559
 560 }
 561 }
 562
 563 /************
 564  * Resource *
 565  ************/
 566
 567 namespace simgrid {
 568 namespace surf {
 569
 570 Resource::Resource(Model* model, const char* name, lmm_constraint_t constraint)
 571     : name_(name), model_(model), constraint_(constraint)
 572 {}
 573
 574 Resource::~Resource() = default;
 575
 576 bool Resource::isOn() const {
 577   return isOn_;
 578 }
 579 bool Resource::isOff() const {
 580   return ! isOn_;
 581 }
 582
 583 void Resource::turnOn()
 584 {
 585   isOn_ = true;
 586 }
 587
 588 void Resource::turnOff()
 589 {
 590   isOn_ = false;
 591 }
 592
 593 Model* Resource::model() const
 594 {
 595   return model_;
 596 }
 597
 598 const char* Resource::cname() const
 599 {
 600   return name_.c_str();
 601 }
 602
 603 bool Resource::operator==(const Resource &other) const {
 604   return name_ == other.name_;
 605 }
 606
 607 lmm_constraint_t Resource::constraint() const
 608 {
 609   return constraint_;
 610 }
 611
 612 }
 613 }
 614
 615 /**********
 616  * Action *
 617  **********/
 618
 619 const char *surf_action_state_names[6] = {
 620   "SURF_ACTION_READY",
 621   "SURF_ACTION_RUNNING",
 622   "SURF_ACTION_FAILED",
 623   "SURF_ACTION_DONE",
 624   "SURF_ACTION_TO_FREE",
 625   "SURF_ACTION_NOT_IN_THE_SYSTEM"
 626 };
 627
 628 /* added to manage the communication action's heap */
 629 void surf_action_lmm_update_index_heap(void *action, int i) {
 630   static_cast<simgrid::surf::Action*>(action)->updateIndexHeap(i);
 631 }
 632
 633 namespace simgrid {
 634 namespace surf {
 635
 636 Action::Action(simgrid::surf::Model* model, double cost, bool failed) : Action(model, cost, failed, nullptr)
 637 {
 638 }
 639
 640 Action::Action(simgrid::surf::Model* model, double cost, bool failed, lmm_variable_t var)
 641     : remains_(cost), start_(surf_get_clock()), cost_(cost), model_(model), variable_(var)
 642 {
 643   if (failed)
 644     stateSet_ = getModel()->getFailedActionSet();
 645   else
 646     stateSet_ = getModel()->getRunningActionSet();
 647
 648   stateSet_->push_back(*this);
 649 }
 650
 651 Action::~Action() {
 652   xbt_free(category_);
 653 }
 654
 655 void Action::finish() {
 656     finishTime_ = surf_get_clock();
 657 }
 658
 659 Action::State Action::getState()
 660 {
 661   if (stateSet_ == model_->getReadyActionSet())
 662     return Action::State::ready;
 663   if (stateSet_ == model_->getRunningActionSet())
 664     return Action::State::running;
 665   if (stateSet_ == model_->getFailedActionSet())
 666     return Action::State::failed;
 667   if (stateSet_ == model_->getDoneActionSet())
 668     return Action::State::done;
 669   return Action::State::not_in_the_system;
 670 }
 671
 672 void Action::setState(Action::State state)
 673 {
 674   stateSet_->erase(stateSet_->iterator_to(*this));
 675   switch (state) {
 676   case Action::State::ready:
 677     stateSet_ = model_->getReadyActionSet();
 678     break;
 679   case Action::State::running:
 680     stateSet_ = model_->getRunningActionSet();
 681     break;
 682   case Action::State::failed:
 683     stateSet_ = model_->getFailedActionSet();
 684     break;
 685   case Action::State::done:
 686     stateSet_ = model_->getDoneActionSet();
 687     break;
 688   default:
 689     stateSet_ = nullptr;
 690     break;
 691   }
 692   if (stateSet_)
 693     stateSet_->push_back(*this);
 694 }
 695
 696 double Action::getBound()
 697 {
 698   return (variable_) ? lmm_variable_getbound(variable_) : 0;
 699 }
 700
 701 void Action::setBound(double bound)
 702 {
 703   XBT_IN("(%p,%g)", this, bound);
 704   if (variable_)
 705     lmm_update_variable_bound(getModel()->getMaxminSystem(), variable_, bound);
 706
 707   if (getModel()->getUpdateMechanism() == UM_LAZY && getLastUpdate()!=surf_get_clock())
 708     heapRemove(getModel()->getActionHeap());
 709   XBT_OUT();
 710 }
 711
 712 double Action::getStartTime()
 713 {
 714   return start_;
 715 }
 716
 717 double Action::getFinishTime()
 718 {
 719   /* keep the function behavior, some models (cpu_ti) change the finish time before the action end */
 720   return remains_ == 0 ? finishTime_ : -1;
 721 }
 722
 723 void Action::setData(void* data)
 724 {
 725   data_ = data;
 726 }
 727
 728 void Action::setCategory(const char *category)
 729 {
 730   category_ = xbt_strdup(category);
 731 }
 732
 733 void Action::ref(){
 734   refcount_++;
 735 }
 736
 737 void Action::setMaxDuration(double duration)
 738 {
 739   maxDuration_ = duration;
 740   if (getModel()->getUpdateMechanism() == UM_LAZY)      // remove action from the heap
 741     heapRemove(getModel()->getActionHeap());
 742 }
 743
 744 void Action::gapRemove() {}
 745
 746 void Action::setPriority(double priority)
 747 {
 748   XBT_IN("(%p,%g)", this, priority);
 749   priority_ = priority;
 750   lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), priority);
 751
 752   if (getModel()->getUpdateMechanism() == UM_LAZY)
 753     heapRemove(getModel()->getActionHeap());
 754   XBT_OUT();
 755 }
 756
 757 void Action::cancel(){
 758   setState(Action::State::failed);
 759   if (getModel()->getUpdateMechanism() == UM_LAZY) {
 760     if (action_lmm_hook.is_linked())
 761       getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
 762     heapRemove(getModel()->getActionHeap());
 763   }
 764 }
 765
 766 int Action::unref(){
 767   refcount_--;
 768   if (!refcount_) {
 769     if (action_hook.is_linked())
 770       stateSet_->erase(stateSet_->iterator_to(*this));
 771     if (getVariable())
 772       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
 773     if (getModel()->getUpdateMechanism() == UM_LAZY) {
 774       /* remove from heap */
 775       heapRemove(getModel()->getActionHeap());
 776       if (action_lmm_hook.is_linked())
 777         getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
 778     }
 779     delete this;
 780     return 1;
 781   }
 782   return 0;
 783 }
 784
 785 void Action::suspend()
 786 {
 787   XBT_IN("(%p)", this);
 788   if (suspended_ != 2) {
 789     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
 790     if (getModel()->getUpdateMechanism() == UM_LAZY){
 791       heapRemove(getModel()->getActionHeap());
 792       if (getModel()->getUpdateMechanism() == UM_LAZY  && stateSet_ == getModel()->getRunningActionSet() && priority_ > 0){
 793         //If we have a lazy model, we need to update the remaining value accordingly
 794         updateRemainingLazy(surf_get_clock());
 795       }
 796     }
 797     suspended_ = 1;
 798   }
 799   XBT_OUT();
 800 }
 801
 802 void Action::resume()
 803 {
 804   XBT_IN("(%p)", this);
 805   if (suspended_ != 2) {
 806     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), priority_);
 807     suspended_ = 0;
 808     if (getModel()->getUpdateMechanism() == UM_LAZY)
 809       heapRemove(getModel()->getActionHeap());
 810   }
 811   XBT_OUT();
 812 }
 813
 814 bool Action::isSuspended()
 815 {
 816   return suspended_ == 1;
 817 }
 818 /* insert action on heap using a given key and a hat (heap_action_type)
 819  * a hat can be of three types for communications:
 820  *
 821  * NORMAL = this is a normal heap entry stating the date to finish transmitting
 822  * LATENCY = this is a heap entry to warn us when the latency is payed
 823  * MAX_DURATION =this is a heap entry to warn us when the max_duration limit is reached
 824  */
 825 void Action::heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat)
 826 {
 827   hat_ = hat;
 828   xbt_heap_push(heap, this, key);
 829 }
 830
 831 void Action::heapRemove(xbt_heap_t heap)
 832 {
 833   hat_ = NOTSET;
 834   if (indexHeap_ >= 0) {
 835     xbt_heap_remove(heap, indexHeap_);
 836   }
 837 }
 838
 839 void Action::heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat)
 840 {
 841   hat_ = hat;
 842   if (indexHeap_ >= 0) {
 843     xbt_heap_update(heap, indexHeap_, key);
 844   }else{
 845     xbt_heap_push(heap, this, key);
 846   }
 847 }
 848
 849 void Action::updateIndexHeap(int i) {
 850   indexHeap_ = i;
 851 }
 852
 853 double Action::getRemains()
 854 {
 855   XBT_IN("(%p)", this);
 856   /* update remains before return it */
 857   if (getModel()->getUpdateMechanism() == UM_LAZY)      /* update remains before return it */
 858     updateRemainingLazy(surf_get_clock());
 859   XBT_OUT();
 860   return remains_;
 861 }
 862
 863 double Action::getRemainsNoUpdate()
 864 {
 865   return remains_;
 866 }
 867
 868 //FIXME split code in the right places
 869 void Action::updateRemainingLazy(double now)
 870 {
 871   double delta = 0.0;
 872
 873   if(getModel() == surf_network_model)
 874   {
 875     if (suspended_ != 0)
 876       return;
 877   }
 878   else
 879   {
 880     xbt_assert(stateSet_ == getModel()->getRunningActionSet(), "You're updating an action that is not running.");
 881     xbt_assert(priority_ > 0, "You're updating an action that seems suspended.");
 882   }
 883
 884   delta = now - lastUpdate_;
 885
 886   if (remains_ > 0) {
 887     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, remains_, lastUpdate_);
 888     double_update(&remains_, lastValue_ * delta, sg_surf_precision*sg_maxmin_precision);
 889
 890     if (getModel() == surf_cpu_model_pm && TRACE_is_enabled()) {
 891       simgrid::surf::Resource *cpu = static_cast<simgrid::surf::Resource*>(
 892         lmm_constraint_id(lmm_get_cnst_from_var(getModel()->getMaxminSystem(), getVariable(), 0)));
 893       TRACE_surf_host_set_utilization(cpu->cname(), getCategory(), lastValue_, lastUpdate_, now - lastUpdate_);
 894     }
 895     XBT_DEBUG("Updating action(%p): remains is now %f", this, remains_);
 896   }
 897
 898   if(getModel() == surf_network_model)
 899   {
 900     if (maxDuration_ != NO_MAX_DURATION)
 901       double_update(&maxDuration_, delta, sg_surf_precision);
 902
 903     //FIXME: duplicated code
 904     if ((remains_ <= 0) &&
 905         (lmm_get_variable_weight(getVariable()) > 0)) {
 906       finish();
 907       setState(Action::State::done);
 908       heapRemove(getModel()->getActionHeap());
 909     } else if (((maxDuration_ != NO_MAX_DURATION)
 910         && (maxDuration_ <= 0))) {
 911       finish();
 912       setState(Action::State::done);
 913       heapRemove(getModel()->getActionHeap());
 914     }
 915   }
 916
 917   lastUpdate_ = now;
 918   lastValue_ = lmm_variable_getvalue(getVariable());
 919 }
 920
 921 }
 922 }