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