src/surf/surf_interface.cpp

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