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