src/surf/surf_interface.cpp

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