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   char *buff;
 150   FILE *file = nullptr;
 151
 152   xbt_assert(name);
 153
 154   if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
 155     return fopen(name, mode);
 156
 157   /* search relative files in the path */
 158   for (auto path_elm : surf_path) {
 159     buff = bprintf("%s" FILE_DELIM "%s", path_elm.c_str(), name);
 160     file = fopen(buff, mode);
 161     free(buff);
 162
 163     if (file)
 164       return file;
 165   }
 166   return nullptr;
 167 }
 168
 169 #ifdef _WIN32
 170 #include <windows.h>
 171 #define MAX_DRIVE 26
 172 static const char *disk_drives_letter_table[MAX_DRIVE] = {
 173   "A:\\","B:\\","C:\\","D:\\","E:\\","F:\\","G:\\","H:\\","I:\\","J:\\","K:\\","L:\\","M:\\",
 174   "N:\\","O:\\","P:\\","Q:\\","R:\\","S:\\","T:\\","U:\\","V:\\","W:\\","X:\\","Y:\\","Z:\\"
 175 };
 176 #endif
 177
 178 /*
 179  * Returns the initial path. On Windows the initial path is
 180  * the current directory for the current process in the other
 181  * case the function returns "./" that represents the current
 182  * directory on Unix/Linux platforms.
 183  */
 184
 185 const char *__surf_get_initial_path()
 186 {
 187
 188 #ifdef _WIN32
 189   unsigned i;
 190   char current_directory[MAX_PATH + 1] = { 0 };
 191   unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
 192   char root[4] = { 0 };
 193
 194   if (not len)
 195     return nullptr;
 196
 197   strncpy(root, current_directory, 3);
 198
 199   for (i = 0; i < MAX_DRIVE; i++) {
 200     if (toupper(root[0]) == disk_drives_letter_table[i][0])
 201       return disk_drives_letter_table[i];
 202   }
 203
 204   return nullptr;
 205 #else
 206   return "./";
 207 #endif
 208 }
 209
 210 /* The __surf_is_absolute_file_path() returns 1 if
 211  * file_path is a absolute file path, in the other
 212  * case the function returns 0.
 213  */
 214 int __surf_is_absolute_file_path(const char *file_path)
 215 {
 216 #ifdef _WIN32
 217   WIN32_FIND_DATA wfd = { 0 };
 218   HANDLE hFile = FindFirstFile(file_path, &wfd);
 219
 220   if (INVALID_HANDLE_VALUE == hFile)
 221     return 0;
 222
 223   FindClose(hFile);
 224   return 1;
 225 #else
 226   return (file_path[0] == '/');
 227 #endif
 228 }
 229
 230 /** Displays the long description of all registered models, and quit */
 231 void model_help(const char *category, s_surf_model_description_t * table)
 232 {
 233   printf("Long description of the %s models accepted by this simulator:\n", category);
 234   for (int i = 0; table[i].name; i++)
 235     printf("  %s: %s\n", table[i].name, table[i].description);
 236 }
 237
 238 int find_model_description(s_surf_model_description_t * table,
 239                            const char *name)
 240 {
 241   int i;
 242   char *name_list = nullptr;
 243
 244   for (i = 0; table[i].name; i++)
 245     if (not strcmp(name, table[i].name)) {
 246       return i;
 247     }
 248   if (not table[0].name)
 249     xbt_die("No model is valid! This is a bug.");
 250   name_list = xbt_strdup(table[0].name);
 251   for (i = 1; table[i].name; i++) {
 252     name_list = (char *) xbt_realloc(name_list, strlen(name_list) + strlen(table[i].name) + 3);
 253     strncat(name_list, ", ", 2);
 254     strncat(name_list, table[i].name, strlen(table[i].name));
 255   }
 256   xbt_die("Model '%s' is invalid! Valid models are: %s.", name, name_list);
 257   return -1;
 258 }
 259
 260 static inline void surf_storage_free(void *r)
 261 {
 262   delete static_cast<simgrid::surf::StorageImpl*>(r);
 263 }
 264
 265 void sg_version_check(int lib_version_major,int lib_version_minor,int lib_version_patch) {
 266     if ((lib_version_major != SIMGRID_VERSION_MAJOR) || (lib_version_minor != SIMGRID_VERSION_MINOR)) {
 267       fprintf(stderr,
 268           "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
 269           "and then linked against SimGrid %d.%d.%d. Please fix this.\n",
 270           lib_version_major,lib_version_minor,lib_version_patch,
 271           SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);
 272       abort();
 273     }
 274     if (lib_version_patch != SIMGRID_VERSION_PATCH) {
 275       if(SIMGRID_VERSION_PATCH >= 90 || lib_version_patch >=90){
 276         fprintf(stderr,
 277         "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
 278         "and then linked against SimGrid %d.%d.%d. \n"
 279         "One of them is a development version, and should not be mixed with the stable release. Please fix this.\n",
 280         lib_version_major,lib_version_minor,lib_version_patch,
 281         SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);
 282         abort();
 283       }
 284         fprintf(stderr,
 285             "Warning: Your program was compiled with SimGrid version %d.%d.%d, "
 286             "and then linked against SimGrid %d.%d.%d. Proceeding anyway.\n",
 287             lib_version_major,lib_version_minor,lib_version_patch,
 288             SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);
 289     }
 290 }
 291
 292 void sg_version_get(int* ver_major, int* ver_minor, int* ver_patch)
 293 {
 294   *ver_major = SIMGRID_VERSION_MAJOR;
 295   *ver_minor = SIMGRID_VERSION_MINOR;
 296   *ver_patch = SIMGRID_VERSION_PATCH;
 297 }
 298
 299 void sg_version()
 300 {
 301   std::printf("This program was linked against %s (git: %s), found in %s.\n",
 302               SIMGRID_VERSION_STRING, SIMGRID_GIT_VERSION, SIMGRID_INSTALL_PREFIX);
 303
 304 #if SIMGRID_HAVE_MC
 305   std::printf("   Model-checking support compiled in.\n");
 306 #else
 307   std::printf("   Model-checking support disabled at compilation.\n");
 308 #endif
 309
 310 #if SIMGRID_HAVE_NS3
 311   std::printf("   NS3 support compiled in.\n");
 312 #else
 313   std::printf("   NS3 support disabled at compilation.\n");
 314 #endif
 315
 316 #if SIMGRID_HAVE_JEDULE
 317   std::printf("   Jedule support compiled in.\n");
 318 #else
 319   std::printf("   Jedule support disabled at compilation.\n");
 320 #endif
 321
 322 #if SIMGRID_HAVE_LUA
 323   std::printf("   Lua support compiled in.\n");
 324 #else
 325   std::printf("   Lua support disabled at compilation.\n");
 326 #endif
 327
 328 #if SIMGRID_HAVE_MALLOCATOR
 329   std::printf("   Mallocator support compiled in.\n");
 330 #else
 331   std::printf("   Mallocator support disabled at compilation.\n");
 332 #endif
 333
 334   std::printf("\nTo cite SimGrid in a publication, please use:\n"
 335               "   Henri Casanova, Arnaud Giersch, Arnaud Legrand, Martin Quinson, Frédéric Suter. \n"
 336               "   Versatile, Scalable, and Accurate Simulation of Distributed Applications and Platforms. \n"
 337               "   Journal of Parallel and Distributed Computing, Elsevier, 2014, 74 (10), pp.2899-2917.\n");
 338   std::printf("The pdf file and a BibTeX entry for LaTeX users can be found at http://hal.inria.fr/hal-01017319\n");
 339 }
 340
 341 void surf_init(int *argc, char **argv)
 342 {
 343   if (USER_HOST_LEVEL != -1) // Already initialized
 344     return;
 345
 346   XBT_DEBUG("Create all Libs");
 347   USER_HOST_LEVEL = simgrid::s4u::Host::extension_create(nullptr);
 348
 349   storage_lib = xbt_lib_new();
 350   watched_hosts_lib = xbt_dict_new_homogeneous(nullptr);
 351
 352   XBT_DEBUG("Add SURF levels");
 353   SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_free);
 354
 355   xbt_init(argc, argv);
 356   if (not all_existing_models)
 357     all_existing_models = new std::vector<simgrid::surf::Model*>();
 358   if (not future_evt_set)
 359     future_evt_set = new simgrid::trace_mgr::future_evt_set();
 360
 361   TRACE_surf_alloc();
 362   simgrid::surf::surfExitCallbacks.connect(TRACE_surf_release);
 363
 364   sg_config_init(argc, argv);
 365
 366   if (MC_is_active())
 367     MC_memory_init();
 368 }
 369
 370 void surf_exit()
 371 {
 372   TRACE_end();                  /* Just in case it was not called by the upper layer (or there is no upper layer) */
 373
 374   sg_host_exit();
 375   xbt_lib_free(&storage_lib);
 376   sg_link_exit();
 377   xbt_dict_free(&watched_hosts_lib);
 378   for (auto e : storage_types) {
 379     storage_type_t stype = e.second;
 380     free(stype->model);
 381     free(stype->type_id);
 382     free(stype->content);
 383     xbt_dict_free(&(stype->properties));
 384     delete stype->model_properties;
 385     free(stype);
 386   }
 387
 388   for (auto model : *all_existing_models)
 389     delete model;
 390   delete all_existing_models;
 391
 392   simgrid::surf::surfExitCallbacks();
 393
 394   if (future_evt_set) {
 395     delete future_evt_set;
 396     future_evt_set = nullptr;
 397   }
 398
 399 #if HAVE_THREAD_CONTEXTS
 400   xbt_parmap_destroy(surf_parmap);
 401 #endif
 402
 403   tmgr_finalize();
 404   sg_platf_exit();
 405   simgrid::s4u::Engine::shutdown();
 406
 407   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
 408 }
 409
 410 /*********
 411  * Model *
 412  *********/
 413
 414 namespace simgrid {
 415 namespace surf {
 416
 417 Model::Model()
 418   : maxminSystem_(nullptr)
 419 {
 420   readyActionSet_ = new ActionList();
 421   runningActionSet_ = new ActionList();
 422   failedActionSet_ = new ActionList();
 423   doneActionSet_ = new ActionList();
 424
 425   modifiedSet_ = nullptr;
 426   actionHeap_ = nullptr;
 427   updateMechanism_ = UM_UNDEFINED;
 428   selectiveUpdate_ = 0;
 429 }
 430
 431 Model::~Model(){
 432   delete readyActionSet_;
 433   delete runningActionSet_;
 434   delete failedActionSet_;
 435   delete doneActionSet_;
 436 }
 437
 438 double Model::nextOccuringEvent(double now)
 439 {
 440   //FIXME: set the good function once and for all
 441   if (updateMechanism_ == UM_LAZY)
 442     return nextOccuringEventLazy(now);
 443   else if (updateMechanism_ == UM_FULL)
 444     return nextOccuringEventFull(now);
 445   else
 446     xbt_die("Invalid cpu update mechanism!");
 447 }
 448
 449 double Model::nextOccuringEventLazy(double now)
 450 {
 451   XBT_DEBUG("Before share resources, the size of modified actions set is %zd", modifiedSet_->size());
 452   lmm_solve(maxminSystem_);
 453   XBT_DEBUG("After share resources, The size of modified actions set is %zd", modifiedSet_->size());
 454
 455   while (not modifiedSet_->empty()) {
 456     Action *action = &(modifiedSet_->front());
 457     modifiedSet_->pop_front();
 458     bool max_dur_flag = false;
 459
 460     if (action->getStateSet() != runningActionSet_)
 461       continue;
 462
 463     /* bogus priority, skip it */
 464     if (action->getPriority() <= 0 || action->getHat()==LATENCY)
 465       continue;
 466
 467     action->updateRemainingLazy(now);
 468
 469     double min = -1;
 470     double share = lmm_variable_getvalue(action->getVariable());
 471
 472     if (share > 0) {
 473       double time_to_completion;
 474       if (action->getRemains() > 0) {
 475         time_to_completion = action->getRemainsNoUpdate() / share;
 476       } else {
 477         time_to_completion = 0.0;
 478       }
 479       min = now + time_to_completion; // when the task will complete if nothing changes
 480     }
 481
 482     if ((action->getMaxDuration() > NO_MAX_DURATION) &&
 483         (min <= -1 || action->getStartTime() + action->getMaxDuration() < min)) {
 484       // when the task will complete anyway because of the deadline if any
 485       min          = action->getStartTime() + action->getMaxDuration();
 486       max_dur_flag = true;
 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, now);
 498     } else
 499       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 not 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 (not 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 }