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