src/surf/surf_interface.cpp

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