src/surf/surf_interface.cpp

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