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, storage_type_t> 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 #if HAVE_THREAD_CONTEXTS
 119 static xbt_parmap_t surf_parmap = nullptr; /* parallel map on models */
 120 #endif
 121
 122 double NOW = 0;
 123
 124 double surf_get_clock()
 125 {
 126   return NOW;
 127 }
 128
 129 #ifdef _WIN32
 130 # define FILE_DELIM "\\"
 131 #else
 132 # define FILE_DELIM "/"         /* FIXME: move to better location */
 133 #endif
 134
 135 std::ifstream* surf_ifsopen(const char* name)
 136 {
 137   std::ifstream* fs = new std::ifstream();
 138   xbt_assert(name);
 139   if (__surf_is_absolute_file_path(name)) { /* don't mess with absolute file names */
 140     fs->open(name, std::ifstream::in);
 141   }
 142
 143   /* search relative files in the path */
 144   for (auto path_elm : surf_path) {
 145     std::string buff = path_elm + FILE_DELIM + name;
 146     fs->open(buff.c_str(), std::ifstream::in);
 147
 148     if (not fs->fail()) {
 149       XBT_DEBUG("Found file at %s", buff.c_str());
 150       return fs;
 151     }
 152   }
 153
 154   return fs;
 155 }
 156 FILE *surf_fopen(const char *name, const char *mode)
 157 {
 158   FILE *file = nullptr;
 159
 160   xbt_assert(name);
 161
 162   if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
 163     return fopen(name, mode);
 164
 165   /* search relative files in the path */
 166   for (auto path_elm : surf_path) {
 167     std::string buff = path_elm + FILE_DELIM + name;
 168     file             = fopen(buff.c_str(), mode);
 169
 170     if (file)
 171       return file;
 172   }
 173   return nullptr;
 174 }
 175
 176 #ifdef _WIN32
 177 #include <windows.h>
 178 #define MAX_DRIVE 26
 179 static const char *disk_drives_letter_table[MAX_DRIVE] = {
 180   "A:\\","B:\\","C:\\","D:\\","E:\\","F:\\","G:\\","H:\\","I:\\","J:\\","K:\\","L:\\","M:\\",
 181   "N:\\","O:\\","P:\\","Q:\\","R:\\","S:\\","T:\\","U:\\","V:\\","W:\\","X:\\","Y:\\","Z:\\"
 182 };
 183 #endif
 184
 185 /*
 186  * Returns the initial path. On Windows the initial path is
 187  * the current directory for the current process in the other
 188  * case the function returns "./" that represents the current
 189  * directory on Unix/Linux platforms.
 190  */
 191
 192 const char *__surf_get_initial_path()
 193 {
 194
 195 #ifdef _WIN32
 196   unsigned i;
 197   char current_directory[MAX_PATH + 1] = { 0 };
 198   unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
 199   char root[4] = { 0 };
 200
 201   if (not len)
 202     return nullptr;
 203
 204   strncpy(root, current_directory, 3);
 205
 206   for (i = 0; i < MAX_DRIVE; i++) {
 207     if (toupper(root[0]) == disk_drives_letter_table[i][0])
 208       return disk_drives_letter_table[i];
 209   }
 210
 211   return nullptr;
 212 #else
 213   return "./";
 214 #endif
 215 }
 216
 217 /* The __surf_is_absolute_file_path() returns 1 if
 218  * file_path is a absolute file path, in the other
 219  * case the function returns 0.
 220  */
 221 int __surf_is_absolute_file_path(const char *file_path)
 222 {
 223 #ifdef _WIN32
 224   WIN32_FIND_DATA wfd = { 0 };
 225   HANDLE hFile = FindFirstFile(file_path, &wfd);
 226
 227   if (INVALID_HANDLE_VALUE == hFile)
 228     return 0;
 229
 230   FindClose(hFile);
 231   return 1;
 232 #else
 233   return (file_path[0] == '/');
 234 #endif
 235 }
 236
 237 /** Displays the long description of all registered models, and quit */
 238 void model_help(const char *category, s_surf_model_description_t * table)
 239 {
 240   printf("Long description of the %s models accepted by this simulator:\n", category);
 241   for (int i = 0; table[i].name; i++)
 242     printf("  %s: %s\n", table[i].name, table[i].description);
 243 }
 244
 245 int find_model_description(s_surf_model_description_t* table, const char* name)
 246 {
 247   for (int i = 0; table[i].name; i++)
 248     if (not strcmp(name, table[i].name)) {
 249       return i;
 250     }
 251
 252   if (not table[0].name)
 253     xbt_die("No model is valid! This is a bug.");
 254
 255   char* name_list = xbt_strdup(table[0].name);
 256   for (int 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   xbt_init(argc, argv);
 350   if (not all_existing_models)
 351     all_existing_models = new std::vector<simgrid::surf::Model*>();
 352   if (not future_evt_set)
 353     future_evt_set = new simgrid::trace_mgr::future_evt_set();
 354
 355   TRACE_surf_alloc();
 356   simgrid::surf::surfExitCallbacks.connect(TRACE_surf_release);
 357
 358   sg_config_init(argc, argv);
 359
 360   if (MC_is_active())
 361     MC_memory_init();
 362 }
 363
 364 void surf_exit()
 365 {
 366   TRACE_end();                  /* Just in case it was not called by the upper layer (or there is no upper layer) */
 367
 368   sg_host_exit();
 369   sg_link_exit();
 370   for (auto e : storage_types) {
 371     storage_type_t stype = e.second;
 372     free(stype->model);
 373     free(stype->type_id);
 374     free(stype->content);
 375     xbt_dict_free(&(stype->properties));
 376     delete stype->model_properties;
 377     free(stype);
 378   }
 379   for (auto s : *simgrid::surf::StorageImpl::storagesMap())
 380     delete s.second;
 381   delete simgrid::surf::StorageImpl::storagesMap();
 382
 383   for (auto model : *all_existing_models)
 384     delete model;
 385   delete all_existing_models;
 386
 387   simgrid::surf::surfExitCallbacks();
 388
 389   if (future_evt_set) {
 390     delete future_evt_set;
 391     future_evt_set = nullptr;
 392   }
 393
 394 #if HAVE_THREAD_CONTEXTS
 395   xbt_parmap_destroy(surf_parmap);
 396 #endif
 397
 398   tmgr_finalize();
 399   sg_platf_exit();
 400   simgrid::s4u::Engine::shutdown();
 401
 402   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
 403 }
 404
 405 /*********
 406  * Model *
 407  *********/
 408
 409 namespace simgrid {
 410 namespace surf {
 411
 412 Model::Model()
 413   : maxminSystem_(nullptr)
 414 {
 415   readyActionSet_ = new ActionList();
 416   runningActionSet_ = new ActionList();
 417   failedActionSet_ = new ActionList();
 418   doneActionSet_ = new ActionList();
 419
 420   modifiedSet_ = nullptr;
 421   actionHeap_ = nullptr;
 422   updateMechanism_ = UM_UNDEFINED;
 423   selectiveUpdate_ = 0;
 424 }
 425
 426 Model::~Model(){
 427   delete readyActionSet_;
 428   delete runningActionSet_;
 429   delete failedActionSet_;
 430   delete doneActionSet_;
 431 }
 432
 433 double Model::nextOccuringEvent(double now)
 434 {
 435   //FIXME: set the good function once and for all
 436   if (updateMechanism_ == UM_LAZY)
 437     return nextOccuringEventLazy(now);
 438   else if (updateMechanism_ == UM_FULL)
 439     return nextOccuringEventFull(now);
 440   else
 441     xbt_die("Invalid cpu update mechanism!");
 442 }
 443
 444 double Model::nextOccuringEventLazy(double now)
 445 {
 446   XBT_DEBUG("Before share resources, the size of modified actions set is %zu", modifiedSet_->size());
 447   lmm_solve(maxminSystem_);
 448   XBT_DEBUG("After share resources, The size of modified actions set is %zu", modifiedSet_->size());
 449
 450   while (not modifiedSet_->empty()) {
 451     Action *action = &(modifiedSet_->front());
 452     modifiedSet_->pop_front();
 453     bool max_dur_flag = false;
 454
 455     if (action->getStateSet() != runningActionSet_)
 456       continue;
 457
 458     /* bogus priority, skip it */
 459     if (action->getPriority() <= 0 || action->getHat()==LATENCY)
 460       continue;
 461
 462     action->updateRemainingLazy(now);
 463
 464     double min = -1;
 465     double share = lmm_variable_getvalue(action->getVariable());
 466
 467     if (share > 0) {
 468       double time_to_completion;
 469       if (action->getRemains() > 0) {
 470         time_to_completion = action->getRemainsNoUpdate() / share;
 471       } else {
 472         time_to_completion = 0.0;
 473       }
 474       min = now + time_to_completion; // when the task will complete if nothing changes
 475     }
 476
 477     if ((action->getMaxDuration() > NO_MAX_DURATION) &&
 478         (min <= -1 || action->getStartTime() + action->getMaxDuration() < min)) {
 479       // when the task will complete anyway because of the deadline if any
 480       min          = action->getStartTime() + action->getMaxDuration();
 481       max_dur_flag = true;
 482     }
 483
 484     XBT_DEBUG("Action(%p) corresponds to variable %d", action, action->getVariable()->id_int);
 485
 486     XBT_DEBUG("Action(%p) Start %f. May finish at %f (got a share of %f). Max_duration %f", action,
 487         action->getStartTime(), min, share,
 488         action->getMaxDuration());
 489
 490     if (min > -1) {
 491       action->heapUpdate(actionHeap_, min, max_dur_flag ? MAX_DURATION : NORMAL);
 492       XBT_DEBUG("Insert at heap action(%p) min %f now %f", action, min, now);
 493     } else
 494       DIE_IMPOSSIBLE;
 495   }
 496
 497   //hereafter must have already the min value for this resource model
 498   if (xbt_heap_size(actionHeap_) > 0) {
 499     double min = xbt_heap_maxkey(actionHeap_) - now;
 500     XBT_DEBUG("minimum with the HEAP %f", min);
 501     return min;
 502   } else {
 503     XBT_DEBUG("The HEAP is empty, thus returning -1");
 504     return -1;
 505   }
 506 }
 507
 508 double Model::nextOccuringEventFull(double /*now*/) {
 509   maxminSystem_->solve_fun(maxminSystem_);
 510
 511   double min = -1;
 512   for (auto it(getRunningActionSet()->begin()), itend(getRunningActionSet()->end()); it != itend ; ++it) {
 513     Action *action = &*it;
 514     double value = lmm_variable_getvalue(action->getVariable());
 515     if (value > 0) {
 516       if (action->getRemains() > 0)
 517         value = action->getRemainsNoUpdate() / value;
 518       else
 519         value = 0.0;
 520       if (min < 0 || value < min) {
 521         min = value;
 522         XBT_DEBUG("Updating min (value) with %p: %f", action, min);
 523       }
 524     }
 525     if ((action->getMaxDuration() >= 0) && (min<0 || action->getMaxDuration() < min)) {
 526       min = action->getMaxDuration();
 527       XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
 528     }
 529   }
 530   XBT_DEBUG("min value : %f", min);
 531
 532   return min;
 533 }
 534
 535 void Model::updateActionsState(double now, double delta)
 536 {
 537   if (updateMechanism_ == UM_FULL)
 538     updateActionsStateFull(now, delta);
 539   else if (updateMechanism_ == UM_LAZY)
 540     updateActionsStateLazy(now, delta);
 541   else
 542     xbt_die("Invalid cpu update mechanism!");
 543 }
 544
 545 void Model::updateActionsStateLazy(double /*now*/, double /*delta*/)
 546 {
 547   THROW_UNIMPLEMENTED;
 548 }
 549
 550 void Model::updateActionsStateFull(double /*now*/, double /*delta*/)
 551 {
 552   THROW_UNIMPLEMENTED;
 553 }
 554
 555 }
 556 }
 557
 558 /************
 559  * Resource *
 560  ************/
 561
 562 namespace simgrid {
 563 namespace surf {
 564
 565 Resource::Resource(Model* model, const char* name, lmm_constraint_t constraint)
 566     : name_(name), model_(model), constraint_(constraint)
 567 {}
 568
 569 Resource::~Resource() = default;
 570
 571 bool Resource::isOn() const {
 572   return isOn_;
 573 }
 574 bool Resource::isOff() const {
 575   return not isOn_;
 576 }
 577
 578 void Resource::turnOn()
 579 {
 580   isOn_ = true;
 581 }
 582
 583 void Resource::turnOff()
 584 {
 585   isOn_ = false;
 586 }
 587
 588 Model* Resource::model() const
 589 {
 590   return model_;
 591 }
 592
 593 const char* Resource::cname() const
 594 {
 595   return name_.c_str();
 596 }
 597
 598 bool Resource::operator==(const Resource &other) const {
 599   return name_ == other.name_;
 600 }
 601
 602 lmm_constraint_t Resource::constraint() const
 603 {
 604   return constraint_;
 605 }
 606
 607 }
 608 }
 609
 610 /**********
 611  * Action *
 612  **********/
 613
 614 const char *surf_action_state_names[6] = {
 615   "SURF_ACTION_READY",
 616   "SURF_ACTION_RUNNING",
 617   "SURF_ACTION_FAILED",
 618   "SURF_ACTION_DONE",
 619   "SURF_ACTION_TO_FREE",
 620   "SURF_ACTION_NOT_IN_THE_SYSTEM"
 621 };
 622
 623 /* added to manage the communication action's heap */
 624 void surf_action_lmm_update_index_heap(void *action, int i) {
 625   static_cast<simgrid::surf::Action*>(action)->updateIndexHeap(i);
 626 }
 627
 628 namespace simgrid {
 629 namespace surf {
 630
 631 Action::Action(simgrid::surf::Model* model, double cost, bool failed) : Action(model, cost, failed, nullptr)
 632 {
 633 }
 634
 635 Action::Action(simgrid::surf::Model* model, double cost, bool failed, lmm_variable_t var)
 636     : remains_(cost), start_(surf_get_clock()), cost_(cost), model_(model), variable_(var)
 637 {
 638   if (failed)
 639     stateSet_ = getModel()->getFailedActionSet();
 640   else
 641     stateSet_ = getModel()->getRunningActionSet();
 642
 643   stateSet_->push_back(*this);
 644 }
 645
 646 Action::~Action() {
 647   xbt_free(category_);
 648 }
 649
 650 void Action::finish() {
 651   finishTime_ = surf_get_clock();
 652 }
 653
 654 Action::State Action::getState()
 655 {
 656   if (stateSet_ == model_->getReadyActionSet())
 657     return Action::State::ready;
 658   if (stateSet_ == model_->getRunningActionSet())
 659     return Action::State::running;
 660   if (stateSet_ == model_->getFailedActionSet())
 661     return Action::State::failed;
 662   if (stateSet_ == model_->getDoneActionSet())
 663     return Action::State::done;
 664   return Action::State::not_in_the_system;
 665 }
 666
 667 void Action::setState(Action::State state)
 668 {
 669   stateSet_->erase(stateSet_->iterator_to(*this));
 670   switch (state) {
 671   case Action::State::ready:
 672     stateSet_ = model_->getReadyActionSet();
 673     break;
 674   case Action::State::running:
 675     stateSet_ = model_->getRunningActionSet();
 676     break;
 677   case Action::State::failed:
 678     stateSet_ = model_->getFailedActionSet();
 679     break;
 680   case Action::State::done:
 681     stateSet_ = model_->getDoneActionSet();
 682     break;
 683   default:
 684     stateSet_ = nullptr;
 685     break;
 686   }
 687   if (stateSet_)
 688     stateSet_->push_back(*this);
 689 }
 690
 691 double Action::getBound()
 692 {
 693   return (variable_) ? lmm_variable_getbound(variable_) : 0;
 694 }
 695
 696 void Action::setBound(double bound)
 697 {
 698   XBT_IN("(%p,%g)", this, bound);
 699   if (variable_)
 700     lmm_update_variable_bound(getModel()->getMaxminSystem(), variable_, bound);
 701
 702   if (getModel()->getUpdateMechanism() == UM_LAZY && getLastUpdate() != surf_get_clock())
 703     heapRemove(getModel()->getActionHeap());
 704   XBT_OUT();
 705 }
 706
 707 double Action::getStartTime()
 708 {
 709   return start_;
 710 }
 711
 712 double Action::getFinishTime()
 713 {
 714   /* keep the function behavior, some models (cpu_ti) change the finish time before the action end */
 715   return remains_ <= 0 ? finishTime_ : -1;
 716 }
 717
 718 void Action::setData(void* data)
 719 {
 720   data_ = data;
 721 }
 722
 723 void Action::setCategory(const char *category)
 724 {
 725   category_ = xbt_strdup(category);
 726 }
 727
 728 void Action::ref(){
 729   refcount_++;
 730 }
 731
 732 void Action::setMaxDuration(double duration)
 733 {
 734   maxDuration_ = duration;
 735   if (getModel()->getUpdateMechanism() == UM_LAZY)      // remove action from the heap
 736     heapRemove(getModel()->getActionHeap());
 737 }
 738
 739 void Action::setSharingWeight(double weight)
 740 {
 741   XBT_IN("(%p,%g)", this, weight);
 742   sharingWeight_ = weight;
 743   lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), weight);
 744
 745   if (getModel()->getUpdateMechanism() == UM_LAZY)
 746     heapRemove(getModel()->getActionHeap());
 747   XBT_OUT();
 748 }
 749
 750 void Action::cancel(){
 751   setState(Action::State::failed);
 752   if (getModel()->getUpdateMechanism() == UM_LAZY) {
 753     if (action_lmm_hook.is_linked())
 754       getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
 755     heapRemove(getModel()->getActionHeap());
 756   }
 757 }
 758
 759 int Action::unref(){
 760   refcount_--;
 761   if (not refcount_) {
 762     if (action_hook.is_linked())
 763       stateSet_->erase(stateSet_->iterator_to(*this));
 764     if (getVariable())
 765       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
 766     if (getModel()->getUpdateMechanism() == UM_LAZY) {
 767       /* remove from heap */
 768       heapRemove(getModel()->getActionHeap());
 769       if (action_lmm_hook.is_linked())
 770         getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
 771     }
 772     delete this;
 773     return 1;
 774   }
 775   return 0;
 776 }
 777
 778 void Action::suspend()
 779 {
 780   XBT_IN("(%p)", this);
 781   if (suspended_ != 2) {
 782     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
 783     if (getModel()->getUpdateMechanism() == UM_LAZY){
 784       heapRemove(getModel()->getActionHeap());
 785       if (getModel()->getUpdateMechanism() == UM_LAZY && stateSet_ == getModel()->getRunningActionSet() &&
 786           sharingWeight_ > 0) {
 787         //If we have a lazy model, we need to update the remaining value accordingly
 788         updateRemainingLazy(surf_get_clock());
 789       }
 790     }
 791     suspended_ = 1;
 792   }
 793   XBT_OUT();
 794 }
 795
 796 void Action::resume()
 797 {
 798   XBT_IN("(%p)", this);
 799   if (suspended_ != 2) {
 800     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), sharingWeight_);
 801     suspended_ = 0;
 802     if (getModel()->getUpdateMechanism() == UM_LAZY)
 803       heapRemove(getModel()->getActionHeap());
 804   }
 805   XBT_OUT();
 806 }
 807
 808 bool Action::isSuspended()
 809 {
 810   return suspended_ == 1;
 811 }
 812 /* insert action on heap using a given key and a hat (heap_action_type)
 813  * a hat can be of three types for communications:
 814  *
 815  * NORMAL = this is a normal heap entry stating the date to finish transmitting
 816  * LATENCY = this is a heap entry to warn us when the latency is payed
 817  * MAX_DURATION =this is a heap entry to warn us when the max_duration limit is reached
 818  */
 819 void Action::heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat)
 820 {
 821   hat_ = hat;
 822   xbt_heap_push(heap, this, key);
 823 }
 824
 825 void Action::heapRemove(xbt_heap_t heap)
 826 {
 827   hat_ = NOTSET;
 828   if (indexHeap_ >= 0) {
 829     xbt_heap_remove(heap, indexHeap_);
 830   }
 831 }
 832
 833 void Action::heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat)
 834 {
 835   hat_ = hat;
 836   if (indexHeap_ >= 0) {
 837     xbt_heap_update(heap, indexHeap_, key);
 838   }else{
 839     xbt_heap_push(heap, this, key);
 840   }
 841 }
 842
 843 void Action::updateIndexHeap(int i) {
 844   indexHeap_ = i;
 845 }
 846
 847 double Action::getRemains()
 848 {
 849   XBT_IN("(%p)", this);
 850   /* update remains before return it */
 851   if (getModel()->getUpdateMechanism() == UM_LAZY)      /* update remains before return it */
 852     updateRemainingLazy(surf_get_clock());
 853   XBT_OUT();
 854   return remains_;
 855 }
 856
 857 double Action::getRemainsNoUpdate()
 858 {
 859   return remains_;
 860 }
 861
 862 //FIXME split code in the right places
 863 void Action::updateRemainingLazy(double now)
 864 {
 865   double delta = 0.0;
 866
 867   if (getModel() == surf_network_model) {
 868     if (suspended_ != 0)
 869       return;
 870   } else {
 871     xbt_assert(stateSet_ == getModel()->getRunningActionSet(), "You're updating an action that is not running.");
 872     xbt_assert(sharingWeight_ > 0, "You're updating an action that seems suspended.");
 873   }
 874
 875   delta = now - lastUpdate_;
 876
 877   if (remains_ > 0) {
 878     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, remains_, lastUpdate_);
 879     double_update(&remains_, lastValue_ * delta, sg_surf_precision*sg_maxmin_precision);
 880
 881     if (getModel() == surf_cpu_model_pm && TRACE_is_enabled()) {
 882       simgrid::surf::Resource *cpu = static_cast<simgrid::surf::Resource*>(
 883         lmm_constraint_id(lmm_get_cnst_from_var(getModel()->getMaxminSystem(), getVariable(), 0)));
 884       TRACE_surf_host_set_utilization(cpu->cname(), getCategory(), lastValue_, lastUpdate_, now - lastUpdate_);
 885     }
 886     XBT_DEBUG("Updating action(%p): remains is now %f", this, remains_);
 887   }
 888
 889   if (getModel() == surf_network_model) {
 890     if (maxDuration_ != NO_MAX_DURATION)
 891       double_update(&maxDuration_, delta, sg_surf_precision);
 892
 893     //FIXME: duplicated code
 894     if (((remains_ <= 0) && (lmm_get_variable_weight(getVariable()) > 0)) ||
 895         ((maxDuration_ > NO_MAX_DURATION) && (maxDuration_ <= 0))) {
 896       finish();
 897       setState(Action::State::done);
 898       heapRemove(getModel()->getActionHeap());
 899     }
 900   }
 901
 902   lastUpdate_ = now;
 903   lastValue_ = lmm_variable_getvalue(getVariable());
 904 }
 905
 906 }
 907 }