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