src/surf/surf_interface.cpp

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