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