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 #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::next_occuring_event(double now)
 397 {
 398   //FIXME: set the good function once and for all
 399   if (updateMechanism_ == UM_LAZY)
 400     return next_occuring_event_lazy(now);
 401   else if (updateMechanism_ == UM_FULL)
 402     return next_occuring_event_full(now);
 403   else
 404     xbt_die("Invalid cpu update mechanism!");
 405 }
 406
 407 double Model::next_occuring_event_lazy(double now)
 408 {
 409   Action *action = nullptr;
 410   double min = -1;
 411   double share;
 412
 413   XBT_DEBUG
 414       ("Before share resources, the size of modified actions set is %zd",
 415        modifiedSet_->size());
 416
 417   lmm_solve(maxminSystem_);
 418
 419   XBT_DEBUG
 420       ("After share resources, The size of modified actions set is %zd",
 421        modifiedSet_->size());
 422
 423   while(!modifiedSet_->empty()) {
 424     action = &(modifiedSet_->front());
 425     modifiedSet_->pop_front();
 426     int max_dur_flag = 0;
 427
 428     if (action->getStateSet() != runningActionSet_)
 429       continue;
 430
 431     /* bogus priority, skip it */
 432     if (action->getPriority() <= 0 || action->getHat()==LATENCY)
 433       continue;
 434
 435     action->updateRemainingLazy(now);
 436
 437     min = -1;
 438     share = lmm_variable_getvalue(action->getVariable());
 439
 440     if (share > 0) {
 441       double time_to_completion;
 442       if (action->getRemains() > 0) {
 443         time_to_completion = action->getRemainsNoUpdate() / share;
 444       } else {
 445         time_to_completion = 0.0;
 446       }
 447       min = now + time_to_completion; // when the task will complete if nothing changes
 448     }
 449
 450     if ((action->getMaxDuration() != NO_MAX_DURATION)
 451         && (min == -1
 452             || action->getStartTime() +
 453             action->getMaxDuration() < min)) {
 454       min = action->getStartTime() +
 455           action->getMaxDuration();  // when the task will complete anyway because of the deadline if any
 456       max_dur_flag = 1;
 457     }
 458
 459
 460     XBT_DEBUG("Action(%p) corresponds to variable %d", action, action->getVariable()->id_int);
 461
 462     XBT_DEBUG("Action(%p) Start %f. May finish at %f (got a share of %f). Max_duration %f", action,
 463         action->getStartTime(), min, share,
 464         action->getMaxDuration());
 465
 466     if (min != -1) {
 467       action->heapUpdate(actionHeap_, min, max_dur_flag ? MAX_DURATION : NORMAL);
 468       XBT_DEBUG("Insert at heap action(%p) min %f now %f", action, min,
 469                 now);
 470     } else DIE_IMPOSSIBLE;
 471   }
 472
 473   //hereafter must have already the min value for this resource model
 474   if (xbt_heap_size(actionHeap_) > 0)
 475     min = xbt_heap_maxkey(actionHeap_) - now;
 476   else
 477     min = -1;
 478
 479   XBT_DEBUG("The minimum with the HEAP %f", min);
 480
 481   return min;
 482 }
 483
 484 double Model::next_occuring_event_full(double /*now*/) {
 485   THROW_UNIMPLEMENTED;
 486   return 0.0;
 487 }
 488
 489 double Model::shareResourcesMaxMin(ActionList *running_actions,
 490                           lmm_system_t sys,
 491                           void (*solve) (lmm_system_t))
 492 {
 493   Action *action = nullptr;
 494   double min = -1;
 495   double value = -1;
 496
 497   solve(sys);
 498
 499   ActionList::iterator it(running_actions->begin()), itend(running_actions->end());
 500   for(; it != itend ; ++it) {
 501     action = &*it;
 502     value = lmm_variable_getvalue(action->getVariable());
 503     if ((value > 0) || (action->getMaxDuration() >= 0))
 504       break;
 505   }
 506
 507   if (!action)
 508     return -1.0;
 509
 510   if (value > 0) {
 511     if (action->getRemains() > 0)
 512       min = action->getRemainsNoUpdate() / value;
 513     else
 514       min = 0.0;
 515     if ((action->getMaxDuration() >= 0) && (action->getMaxDuration() < min))
 516       min = action->getMaxDuration();
 517   } else
 518     min = action->getMaxDuration();
 519
 520
 521   for (++it; it != itend; ++it) {
 522   action = &*it;
 523     value = lmm_variable_getvalue(action->getVariable());
 524     if (value > 0) {
 525       if (action->getRemains() > 0)
 526         value = action->getRemainsNoUpdate() / value;
 527       else
 528         value = 0.0;
 529       if (value < min) {
 530         min = value;
 531         XBT_DEBUG("Updating min (value) with %p: %f", action, min);
 532       }
 533     }
 534     if ((action->getMaxDuration() >= 0) && (action->getMaxDuration() < min)) {
 535       min = action->getMaxDuration();
 536       XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
 537     }
 538   }
 539   XBT_DEBUG("min value : %f", min);
 540
 541   return min;
 542 }
 543
 544 void Model::updateActionsState(double now, double delta)
 545 {
 546   if (updateMechanism_ == UM_FULL)
 547   updateActionsStateFull(now, delta);
 548   else if (updateMechanism_ == UM_LAZY)
 549   updateActionsStateLazy(now, delta);
 550   else
 551   xbt_die("Invalid cpu update mechanism!");
 552 }
 553
 554 void Model::updateActionsStateLazy(double /*now*/, double /*delta*/)
 555 {
 556  THROW_UNIMPLEMENTED;
 557 }
 558
 559 void Model::updateActionsStateFull(double /*now*/, double /*delta*/)
 560 {
 561   THROW_UNIMPLEMENTED;
 562 }
 563
 564 }
 565 }
 566
 567 /************
 568  * Resource *
 569  ************/
 570
 571 namespace simgrid {
 572 namespace surf {
 573
 574 Resource::Resource(Model *model, const char *name)
 575   : name_(xbt_strdup(name))
 576   , model_(model)
 577 {}
 578
 579 Resource::Resource(Model *model, const char *name, lmm_constraint_t constraint)
 580   : name_(xbt_strdup(name))
 581   , model_(model)
 582   , constraint_(constraint)
 583 {}
 584
 585 Resource::~Resource() {
 586   xbt_free((void*)name_);
 587 }
 588
 589 bool Resource::isOn() const {
 590   return isOn_;
 591 }
 592 bool Resource::isOff() const {
 593   return ! isOn_;
 594 }
 595
 596 void Resource::turnOn()
 597 {
 598   isOn_ = true;
 599 }
 600
 601 void Resource::turnOff()
 602 {
 603   isOn_ = false;
 604 }
 605
 606 Model *Resource::getModel() const {
 607   return model_;
 608 }
 609
 610 const char *Resource::getName() const {
 611   return name_;
 612 }
 613
 614 bool Resource::operator==(const Resource &other) const {
 615   return strcmp(name_, other.name_);
 616 }
 617
 618 lmm_constraint_t Resource::getConstraint() const {
 619   return constraint_;
 620 }
 621
 622 }
 623 }
 624
 625 /**********
 626  * Action *
 627  **********/
 628
 629 const char *surf_action_state_names[6] = {
 630   "SURF_ACTION_READY",
 631   "SURF_ACTION_RUNNING",
 632   "SURF_ACTION_FAILED",
 633   "SURF_ACTION_DONE",
 634   "SURF_ACTION_TO_FREE",
 635   "SURF_ACTION_NOT_IN_THE_SYSTEM"
 636 };
 637
 638 /* added to manage the communication action's heap */
 639 void surf_action_lmm_update_index_heap(void *action, int i) {
 640   static_cast<simgrid::surf::Action*>(action)->updateIndexHeap(i);
 641 }
 642
 643 namespace simgrid {
 644 namespace surf {
 645
 646 void Action::initialize(simgrid::surf::Model *model, double cost, bool failed,
 647                         lmm_variable_t var)
 648 {
 649   remains_ = cost;
 650   start_ = surf_get_clock();
 651   cost_ = cost;
 652   model_ = model;
 653   variable_ = var;
 654   if (failed)
 655     stateSet_ = getModel()->getFailedActionSet();
 656   else
 657     stateSet_ = getModel()->getRunningActionSet();
 658
 659   stateSet_->push_back(*this);
 660 }
 661
 662 Action::Action(simgrid::surf::Model *model, double cost, bool failed)
 663 {
 664   initialize(model, cost, failed);
 665 }
 666
 667 Action::Action(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var)
 668 {
 669   initialize(model, cost, failed, var);
 670 }
 671
 672 Action::~Action() {
 673   xbt_free(category_);
 674 }
 675
 676 void Action::finish() {
 677     finishTime_ = surf_get_clock();
 678 }
 679
 680 Action::State Action::getState()
 681 {
 682   if (stateSet_ ==  getModel()->getReadyActionSet())
 683     return Action::State::ready;
 684   if (stateSet_ ==  getModel()->getRunningActionSet())
 685     return Action::State::running;
 686   if (stateSet_ ==  getModel()->getFailedActionSet())
 687     return Action::State::failed;
 688   if (stateSet_ ==  getModel()->getDoneActionSet())
 689     return Action::State::done;
 690   return Action::State::not_in_the_system;
 691 }
 692
 693 void Action::setState(Action::State state)
 694 {
 695   stateSet_->erase(stateSet_->iterator_to(*this));
 696   switch (state) {
 697   case Action::State::ready:
 698     stateSet_ = getModel()->getReadyActionSet();
 699     break;
 700   case Action::State::running:
 701     stateSet_ = getModel()->getRunningActionSet();
 702     break;
 703   case Action::State::failed:
 704     stateSet_ = getModel()->getFailedActionSet();
 705     break;
 706   case Action::State::done:
 707     stateSet_ = getModel()->getDoneActionSet();
 708     break;
 709   default:
 710     stateSet_ = nullptr;
 711     break;
 712   }
 713   if (stateSet_)
 714     stateSet_->push_back(*this);
 715 }
 716
 717 double Action::getBound()
 718 {
 719   return (variable_) ? lmm_variable_getbound(variable_) : 0;
 720 }
 721
 722 void Action::setBound(double bound)
 723 {
 724   XBT_IN("(%p,%g)", this, bound);
 725   if (variable_)
 726     lmm_update_variable_bound(getModel()->getMaxminSystem(), variable_, bound);
 727
 728   if (getModel()->getUpdateMechanism() == UM_LAZY && getLastUpdate()!=surf_get_clock())
 729     heapRemove(getModel()->getActionHeap());
 730   XBT_OUT();
 731 }
 732
 733 double Action::getStartTime()
 734 {
 735   return start_;
 736 }
 737
 738 double Action::getFinishTime()
 739 {
 740   /* keep the function behavior, some models (cpu_ti) change the finish time before the action end */
 741   return remains_ == 0 ? finishTime_ : -1;
 742 }
 743
 744 void Action::setData(void* data)
 745 {
 746   data_ = data;
 747 }
 748
 749 void Action::setCategory(const char *category)
 750 {
 751   XBT_IN("(%p,%s)", this, category);
 752   category_ = xbt_strdup(category);
 753   XBT_OUT();
 754 }
 755
 756 void Action::ref(){
 757   refcount_++;
 758 }
 759
 760 void Action::setMaxDuration(double duration)
 761 {
 762   XBT_IN("(%p,%g)", this, duration);
 763   maxDuration_ = duration;
 764   if (getModel()->getUpdateMechanism() == UM_LAZY)      // remove action from the heap
 765     heapRemove(getModel()->getActionHeap());
 766   XBT_OUT();
 767 }
 768
 769 void Action::gapRemove() {}
 770
 771 void Action::setPriority(double priority)
 772 {
 773   XBT_IN("(%p,%g)", this, priority);
 774   priority_ = priority;
 775   lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), priority);
 776
 777   if (getModel()->getUpdateMechanism() == UM_LAZY)
 778     heapRemove(getModel()->getActionHeap());
 779   XBT_OUT();
 780 }
 781
 782 void Action::cancel(){
 783   setState(Action::State::failed);
 784   if (getModel()->getUpdateMechanism() == UM_LAZY) {
 785     if (action_lmm_hook.is_linked())
 786       getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
 787     heapRemove(getModel()->getActionHeap());
 788   }
 789 }
 790
 791 int Action::unref(){
 792   refcount_--;
 793   if (!refcount_) {
 794     if (action_hook.is_linked())
 795       stateSet_->erase(stateSet_->iterator_to(*this));
 796     if (getVariable())
 797       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
 798     if (getModel()->getUpdateMechanism() == UM_LAZY) {
 799       /* remove from heap */
 800       heapRemove(getModel()->getActionHeap());
 801       if (action_lmm_hook.is_linked())
 802         getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
 803     }
 804     delete this;
 805     return 1;
 806   }
 807   return 0;
 808 }
 809
 810 void Action::suspend()
 811 {
 812   XBT_IN("(%p)", this);
 813   if (suspended_ != 2) {
 814     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
 815     suspended_ = 1;
 816     if (getModel()->getUpdateMechanism() == UM_LAZY)
 817       heapRemove(getModel()->getActionHeap());
 818   }
 819   XBT_OUT();
 820 }
 821
 822 void Action::resume()
 823 {
 824   XBT_IN("(%p)", this);
 825   if (suspended_ != 2) {
 826     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), priority_);
 827     suspended_ = 0;
 828     if (getModel()->getUpdateMechanism() == UM_LAZY)
 829       heapRemove(getModel()->getActionHeap());
 830   }
 831   XBT_OUT();
 832 }
 833
 834 bool Action::isSuspended()
 835 {
 836   return suspended_ == 1;
 837 }
 838 /* insert action on heap using a given key and a hat (heap_action_type)
 839  * a hat can be of three types for communications:
 840  *
 841  * NORMAL = this is a normal heap entry stating the date to finish transmitting
 842  * LATENCY = this is a heap entry to warn us when the latency is payed
 843  * MAX_DURATION =this is a heap entry to warn us when the max_duration limit is reached
 844  */
 845 void Action::heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat)
 846 {
 847   hat_ = hat;
 848   xbt_heap_push(heap, this, key);
 849 }
 850
 851 void Action::heapRemove(xbt_heap_t heap)
 852 {
 853   hat_ = NOTSET;
 854   if (indexHeap_ >= 0) {
 855     xbt_heap_remove(heap, indexHeap_);
 856   }
 857 }
 858
 859 void Action::heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat)
 860 {
 861   hat_ = hat;
 862   if (indexHeap_ >= 0) {
 863     xbt_heap_update(heap, indexHeap_, key);
 864   }else{
 865     xbt_heap_push(heap, this, key);
 866   }
 867 }
 868
 869 void Action::updateIndexHeap(int i) {
 870   indexHeap_ = i;
 871 }
 872
 873 double Action::getRemains()
 874 {
 875   XBT_IN("(%p)", this);
 876   /* update remains before return it */
 877   if (getModel()->getUpdateMechanism() == UM_LAZY)      /* update remains before return it */
 878     updateRemainingLazy(surf_get_clock());
 879   XBT_OUT();
 880   return remains_;
 881 }
 882
 883 double Action::getRemainsNoUpdate()
 884 {
 885   return remains_;
 886 }
 887
 888 //FIXME split code in the right places
 889 void Action::updateRemainingLazy(double now)
 890 {
 891   double delta = 0.0;
 892
 893   if(getModel() == surf_network_model)
 894   {
 895     if (suspended_ != 0)
 896       return;
 897   }
 898   else
 899   {
 900     xbt_assert(stateSet_ == getModel()->getRunningActionSet(), "You're updating an action that is not running.");
 901     xbt_assert(priority_ > 0, "You're updating an action that seems suspended.");
 902   }
 903
 904   delta = now - lastUpdate_;
 905
 906   if (remains_ > 0) {
 907     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, remains_, lastUpdate_);
 908     double_update(&remains_, lastValue_ * delta, sg_surf_precision*sg_maxmin_precision);
 909
 910     if (getModel() == surf_cpu_model_pm && TRACE_is_enabled()) {
 911       simgrid::surf::Resource *cpu = static_cast<simgrid::surf::Resource*>(
 912         lmm_constraint_id(lmm_get_cnst_from_var(getModel()->getMaxminSystem(), getVariable(), 0)));
 913       TRACE_surf_host_set_utilization(cpu->getName(), getCategory(), lastValue_, lastUpdate_, now - lastUpdate_);
 914     }
 915     XBT_DEBUG("Updating action(%p): remains is now %f", this, remains_);
 916   }
 917
 918   if(getModel() == surf_network_model)
 919   {
 920     if (maxDuration_ != NO_MAX_DURATION)
 921       double_update(&maxDuration_, delta, sg_surf_precision);
 922
 923     //FIXME: duplicated code
 924     if ((remains_ <= 0) &&
 925         (lmm_get_variable_weight(getVariable()) > 0)) {
 926       finish();
 927       setState(Action::State::done);
 928       heapRemove(getModel()->getActionHeap());
 929     } else if (((maxDuration_ != NO_MAX_DURATION)
 930         && (maxDuration_ <= 0))) {
 931       finish();
 932       setState(Action::State::done);
 933       heapRemove(getModel()->getActionHeap());
 934     }
 935   }
 936
 937   lastUpdate_ = now;
 938   lastValue_ = lmm_variable_getvalue(getVariable());
 939 }
 940
 941 }
 942 }