src/surf/surf_interface.cpp

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