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