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   as_router_lib = xbt_lib_new();
 307   storage_lib = xbt_lib_new();
 308   storage_type_lib = xbt_lib_new();
 309   file_lib = xbt_lib_new();
 310   watched_hosts_lib = xbt_dict_new_homogeneous(NULL);
 311
 312   sg_host_init();
 313
 314   XBT_DEBUG("Add routing levels");
 315   ROUTING_PROP_ASR_LEVEL = xbt_lib_add_level(as_router_lib, NULL);
 316
 317   XBT_DEBUG("Add SURF levels");
 318   simgrid::surf::HostImpl::classInit();
 319   SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_free);
 320
 321   xbt_init(argc, argv);
 322   if (!all_existing_models)
 323     all_existing_models = xbt_dynar_new(sizeof(simgrid::surf::Model*), NULL);
 324   if (!model_list_invoke)
 325     model_list_invoke = xbt_dynar_new(sizeof(simgrid::surf::Model*), NULL);
 326   if (!future_evt_set)
 327     future_evt_set = new simgrid::trace_mgr::future_evt_set();
 328
 329   TRACE_add_start_function(TRACE_surf_alloc);
 330   TRACE_add_end_function(TRACE_surf_release);
 331
 332   sg_config_init(argc, argv);
 333
 334   if (MC_is_active())
 335     MC_memory_init();
 336 }
 337
 338 void surf_exit(void)
 339 {
 340   unsigned int iter;
 341   simgrid::surf::Model *model = NULL;
 342
 343   TRACE_end();                  /* Just in case it was not called by the upper
 344                                  * layer (or there is no upper layer) */
 345
 346   sg_config_finalize();
 347
 348   xbt_dynar_free(&host_that_restart);
 349   xbt_dynar_free(&surf_path);
 350
 351   xbt_dict_free(&host_list);
 352   xbt_lib_free(&as_router_lib);
 353   xbt_lib_free(&storage_lib);
 354   sg_link_exit();
 355   xbt_lib_free(&storage_type_lib);
 356   xbt_lib_free(&file_lib);
 357   xbt_dict_free(&watched_hosts_lib);
 358
 359   xbt_dynar_foreach(all_existing_models, iter, model)
 360     delete model;
 361   xbt_dynar_free(&all_existing_models);
 362   xbt_dynar_free(&model_list_invoke);
 363   routing_exit();
 364
 365   simgrid::surf::surfExitCallbacks();
 366
 367   if (future_evt_set) {
 368     delete future_evt_set;
 369     future_evt_set = nullptr;
 370   }
 371
 372 #ifdef HAVE_THREAD_CONTEXTS
 373   xbt_parmap_destroy(surf_parmap);
 374 #endif
 375
 376   tmgr_finalize();
 377   sg_platf_exit();
 378
 379   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
 380 }
 381
 382 /*********
 383  * Model *
 384  *********/
 385
 386 namespace simgrid {
 387 namespace surf {
 388
 389 Model::Model()
 390   : p_maxminSystem(NULL)
 391 {
 392   p_readyActionSet = new ActionList();
 393   p_runningActionSet = new ActionList();
 394   p_failedActionSet = new ActionList();
 395   p_doneActionSet = new ActionList();
 396
 397   p_modifiedSet = NULL;
 398   p_actionHeap = NULL;
 399   p_updateMechanism = UM_UNDEFINED;
 400   m_selectiveUpdate = 0;
 401 }
 402
 403 Model::~Model(){
 404   delete p_readyActionSet;
 405   delete p_runningActionSet;
 406   delete p_failedActionSet;
 407   delete p_doneActionSet;
 408 }
 409
 410 double Model::next_occuring_event(double now)
 411 {
 412   //FIXME: set the good function once and for all
 413   if (p_updateMechanism == UM_LAZY)
 414     return next_occuring_event_lazy(now);
 415   else if (p_updateMechanism == UM_FULL)
 416     return next_occuring_event_full(now);
 417   else
 418     xbt_die("Invalid cpu update mechanism!");
 419 }
 420
 421 double Model::next_occuring_event_lazy(double now)
 422 {
 423   Action *action = NULL;
 424   double min = -1;
 425   double share;
 426
 427   XBT_DEBUG
 428       ("Before share resources, the size of modified actions set is %zd",
 429        p_modifiedSet->size());
 430
 431   lmm_solve(p_maxminSystem);
 432
 433   XBT_DEBUG
 434       ("After share resources, The size of modified actions set is %zd",
 435        p_modifiedSet->size());
 436
 437   while(!p_modifiedSet->empty()) {
 438     action = &(p_modifiedSet->front());
 439     p_modifiedSet->pop_front();
 440     int max_dur_flag = 0;
 441
 442     if (action->getStateSet() != p_runningActionSet)
 443       continue;
 444
 445     /* bogus priority, skip it */
 446     if (action->getPriority() <= 0 || action->getHat()==LATENCY)
 447       continue;
 448
 449     action->updateRemainingLazy(now);
 450
 451     min = -1;
 452     share = lmm_variable_getvalue(action->getVariable());
 453
 454     if (share > 0) {
 455       double time_to_completion;
 456       if (action->getRemains() > 0) {
 457         time_to_completion = action->getRemainsNoUpdate() / share;
 458       } else {
 459         time_to_completion = 0.0;
 460       }
 461       min = now + time_to_completion; // when the task will complete if nothing changes
 462     }
 463
 464     if ((action->getMaxDuration() != NO_MAX_DURATION)
 465         && (min == -1
 466             || action->getStartTime() +
 467             action->getMaxDuration() < min)) {
 468       min = action->getStartTime() +
 469           action->getMaxDuration();  // when the task will complete anyway because of the deadline if any
 470       max_dur_flag = 1;
 471     }
 472
 473
 474     XBT_DEBUG("Action(%p) corresponds to variable %d", action, action->getVariable()->id_int);
 475
 476     XBT_DEBUG("Action(%p) Start %f. May finish at %f (got a share of %f). Max_duration %f", action,
 477         action->getStartTime(), min, share,
 478         action->getMaxDuration());
 479
 480     if (min != -1) {
 481       action->heapUpdate(p_actionHeap, min, max_dur_flag ? MAX_DURATION : NORMAL);
 482       XBT_DEBUG("Insert at heap action(%p) min %f now %f", action, min,
 483                 now);
 484     } else DIE_IMPOSSIBLE;
 485   }
 486
 487   //hereafter must have already the min value for this resource model
 488   if (xbt_heap_size(p_actionHeap) > 0)
 489     min = xbt_heap_maxkey(p_actionHeap) - now;
 490   else
 491     min = -1;
 492
 493   XBT_DEBUG("The minimum with the HEAP %f", min);
 494
 495   return min;
 496 }
 497
 498 double Model::next_occuring_event_full(double /*now*/) {
 499   THROW_UNIMPLEMENTED;
 500 }
 501
 502 double Model::shareResourcesMaxMin(ActionList *running_actions,
 503                           lmm_system_t sys,
 504                           void (*solve) (lmm_system_t))
 505 {
 506   Action *action = NULL;
 507   double min = -1;
 508   double value = -1;
 509
 510   solve(sys);
 511
 512   ActionList::iterator it(running_actions->begin()), itend(running_actions->end());
 513   for(; it != itend ; ++it) {
 514     action = &*it;
 515     value = lmm_variable_getvalue(action->getVariable());
 516     if ((value > 0) || (action->getMaxDuration() >= 0))
 517       break;
 518   }
 519
 520   if (!action)
 521     return -1.0;
 522
 523   if (value > 0) {
 524     if (action->getRemains() > 0)
 525       min = action->getRemainsNoUpdate() / value;
 526     else
 527       min = 0.0;
 528     if ((action->getMaxDuration() >= 0) && (action->getMaxDuration() < min))
 529       min = action->getMaxDuration();
 530   } else
 531     min = action->getMaxDuration();
 532
 533
 534   for (++it; it != itend; ++it) {
 535   action = &*it;
 536     value = lmm_variable_getvalue(action->getVariable());
 537     if (value > 0) {
 538       if (action->getRemains() > 0)
 539         value = action->getRemainsNoUpdate() / value;
 540       else
 541         value = 0.0;
 542       if (value < min) {
 543         min = value;
 544         XBT_DEBUG("Updating min (value) with %p: %f", action, min);
 545       }
 546     }
 547     if ((action->getMaxDuration() >= 0) && (action->getMaxDuration() < min)) {
 548       min = action->getMaxDuration();
 549       XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
 550     }
 551   }
 552   XBT_DEBUG("min value : %f", min);
 553
 554   return min;
 555 }
 556
 557 void Model::updateActionsState(double now, double delta)
 558 {
 559   if (p_updateMechanism == UM_FULL)
 560   updateActionsStateFull(now, delta);
 561   else if (p_updateMechanism == UM_LAZY)
 562   updateActionsStateLazy(now, delta);
 563   else
 564   xbt_die("Invalid cpu update mechanism!");
 565 }
 566
 567 void Model::updateActionsStateLazy(double /*now*/, double /*delta*/)
 568 {
 569  THROW_UNIMPLEMENTED;
 570 }
 571
 572 void Model::updateActionsStateFull(double /*now*/, double /*delta*/)
 573 {
 574   THROW_UNIMPLEMENTED;
 575 }
 576
 577 }
 578 }
 579
 580 /************
 581  * Resource *
 582  ************/
 583
 584 namespace simgrid {
 585 namespace surf {
 586
 587 Resource::Resource(Model *model, const char *name)
 588   : Resource(model, name, 1/*ON*/)
 589 {}
 590
 591 Resource::Resource(Model *model, const char *name, lmm_constraint_t constraint)
 592   : Resource(model, name, constraint, 1/*ON*/)
 593 {}
 594
 595 Resource::Resource(Model *model, const char *name, lmm_constraint_t constraint, int initiallyOn)
 596   : p_name(xbt_strdup(name))
 597   , p_model(model)
 598   , m_isOn(initiallyOn)
 599   , p_constraint(constraint)
 600 {}
 601
 602 Resource::Resource(Model *model, const char *name, int initiallyOn)
 603   : p_name(xbt_strdup(name))
 604   , p_model(model)
 605   , m_isOn(initiallyOn)
 606 {}
 607
 608
 609 Resource::~Resource() {
 610   xbt_free((void*)p_name);
 611 }
 612
 613 bool Resource::isOn() {
 614   return m_isOn;
 615 }
 616 bool Resource::isOff() {
 617   return ! m_isOn;
 618 }
 619
 620 void Resource::turnOn()
 621 {
 622   if (!m_isOn) {
 623     m_isOn = true;
 624   }
 625 }
 626
 627 void Resource::turnOff()
 628 {
 629   if (m_isOn) {
 630     m_isOn = false;
 631   }
 632 }
 633
 634 Model *Resource::getModel() {
 635   return p_model;
 636 }
 637
 638 const char *Resource::getName() {
 639   return p_name;
 640 }
 641
 642 lmm_constraint_t Resource::getConstraint() {
 643   return p_constraint;
 644 }
 645
 646 }
 647 }
 648
 649 /**********
 650  * Action *
 651  **********/
 652
 653 const char *surf_action_state_names[6] = {
 654   "SURF_ACTION_READY",
 655   "SURF_ACTION_RUNNING",
 656   "SURF_ACTION_FAILED",
 657   "SURF_ACTION_DONE",
 658   "SURF_ACTION_TO_FREE",
 659   "SURF_ACTION_NOT_IN_THE_SYSTEM"
 660 };
 661
 662 /* added to manage the communication action's heap */
 663 void surf_action_lmm_update_index_heap(void *action, int i) {
 664   static_cast<simgrid::surf::Action*>(action)->updateIndexHeap(i);
 665 }
 666
 667 namespace simgrid {
 668 namespace surf {
 669
 670 void Action::initialize(simgrid::surf::Model *model, double cost, bool failed,
 671                         lmm_variable_t var)
 672 {
 673   m_remains = cost;
 674   m_start = surf_get_clock();
 675   m_cost = cost;
 676   p_model = model;
 677   p_variable = var;
 678   if (failed)
 679     p_stateSet = getModel()->getFailedActionSet();
 680   else
 681     p_stateSet = getModel()->getRunningActionSet();
 682
 683   p_stateSet->push_back(*this);
 684 }
 685
 686 Action::Action(simgrid::surf::Model *model, double cost, bool failed)
 687 {
 688   initialize(model, cost, failed);
 689 }
 690
 691 Action::Action(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var)
 692 {
 693   initialize(model, cost, failed, var);
 694 }
 695
 696 Action::~Action() {
 697   xbt_free(p_category);
 698 }
 699
 700 void Action::finish() {
 701     m_finish = surf_get_clock();
 702 }
 703
 704 e_surf_action_state_t Action::getState()
 705 {
 706   if (p_stateSet ==  getModel()->getReadyActionSet())
 707     return SURF_ACTION_READY;
 708   if (p_stateSet ==  getModel()->getRunningActionSet())
 709     return SURF_ACTION_RUNNING;
 710   if (p_stateSet ==  getModel()->getFailedActionSet())
 711     return SURF_ACTION_FAILED;
 712   if (p_stateSet ==  getModel()->getDoneActionSet())
 713     return SURF_ACTION_DONE;
 714   return SURF_ACTION_NOT_IN_THE_SYSTEM;
 715 }
 716
 717 void Action::setState(e_surf_action_state_t state)
 718 {
 719   //surf_action_state_t action_state = &(action->model_type->states);
 720   XBT_IN("(%p,%s)", this, surf_action_state_names[state]);
 721   p_stateSet->erase(p_stateSet->iterator_to(*this));
 722   if (state == SURF_ACTION_READY)
 723     p_stateSet = getModel()->getReadyActionSet();
 724   else if (state == SURF_ACTION_RUNNING)
 725     p_stateSet = getModel()->getRunningActionSet();
 726   else if (state == SURF_ACTION_FAILED)
 727     p_stateSet = getModel()->getFailedActionSet();
 728   else if (state == SURF_ACTION_DONE)
 729     p_stateSet = getModel()->getDoneActionSet();
 730   else
 731     p_stateSet = NULL;
 732
 733   if (p_stateSet)
 734     p_stateSet->push_back(*this);
 735   XBT_OUT();
 736 }
 737
 738 double Action::getBound()
 739 {
 740   return (p_variable) ? lmm_variable_getbound(p_variable) : 0;
 741 }
 742
 743 void Action::setBound(double bound)
 744 {
 745   XBT_IN("(%p,%g)", this, bound);
 746   if (p_variable)
 747     lmm_update_variable_bound(getModel()->getMaxminSystem(), p_variable, bound);
 748
 749   if (getModel()->getUpdateMechanism() == UM_LAZY && getLastUpdate()!=surf_get_clock())
 750     heapRemove(getModel()->getActionHeap());
 751   XBT_OUT();
 752 }
 753
 754 double Action::getStartTime()
 755 {
 756   return m_start;
 757 }
 758
 759 double Action::getFinishTime()
 760 {
 761   /* keep the function behavior, some models (cpu_ti) change the finish time before the action end */
 762   return m_remains == 0 ? m_finish : -1;
 763 }
 764
 765 void Action::setData(void* data)
 766 {
 767   p_data = data;
 768 }
 769
 770 void Action::setCategory(const char *category)
 771 {
 772   XBT_IN("(%p,%s)", this, category);
 773   p_category = xbt_strdup(category);
 774   XBT_OUT();
 775 }
 776
 777 void Action::ref(){
 778   m_refcount++;
 779 }
 780
 781 void Action::setMaxDuration(double duration)
 782 {
 783   XBT_IN("(%p,%g)", this, duration);
 784   m_maxDuration = duration;
 785   if (getModel()->getUpdateMechanism() == UM_LAZY)      // remove action from the heap
 786     heapRemove(getModel()->getActionHeap());
 787   XBT_OUT();
 788 }
 789
 790 void Action::gapRemove() {}
 791
 792 void Action::setPriority(double priority)
 793 {
 794   XBT_IN("(%p,%g)", this, priority);
 795   m_priority = priority;
 796   lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), priority);
 797
 798   if (getModel()->getUpdateMechanism() == UM_LAZY)
 799     heapRemove(getModel()->getActionHeap());
 800   XBT_OUT();
 801 }
 802
 803 void Action::cancel(){
 804   setState(SURF_ACTION_FAILED);
 805   if (getModel()->getUpdateMechanism() == UM_LAZY) {
 806     if (action_lmm_hook.is_linked())
 807       getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
 808     heapRemove(getModel()->getActionHeap());
 809   }
 810 }
 811
 812 int Action::unref(){
 813   m_refcount--;
 814   if (!m_refcount) {
 815     if (action_hook.is_linked())
 816       p_stateSet->erase(p_stateSet->iterator_to(*this));
 817     if (getVariable())
 818       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
 819     if (getModel()->getUpdateMechanism() == UM_LAZY) {
 820       /* remove from heap */
 821       heapRemove(getModel()->getActionHeap());
 822       if (action_lmm_hook.is_linked())
 823         getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
 824     }
 825     delete this;
 826     return 1;
 827   }
 828   return 0;
 829 }
 830
 831 void Action::suspend()
 832 {
 833   XBT_IN("(%p)", this);
 834   if (m_suspended != 2) {
 835     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
 836     m_suspended = 1;
 837     if (getModel()->getUpdateMechanism() == UM_LAZY)
 838       heapRemove(getModel()->getActionHeap());
 839   }
 840   XBT_OUT();
 841 }
 842
 843 void Action::resume()
 844 {
 845   XBT_IN("(%p)", this);
 846   if (m_suspended != 2) {
 847     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), m_priority);
 848     m_suspended = 0;
 849     if (getModel()->getUpdateMechanism() == UM_LAZY)
 850       heapRemove(getModel()->getActionHeap());
 851   }
 852   XBT_OUT();
 853 }
 854
 855 bool Action::isSuspended()
 856 {
 857   return m_suspended == 1;
 858 }
 859 /* insert action on heap using a given key and a hat (heap_action_type)
 860  * a hat can be of three types for communications:
 861  *
 862  * NORMAL = this is a normal heap entry stating the date to finish transmitting
 863  * LATENCY = this is a heap entry to warn us when the latency is payed
 864  * MAX_DURATION =this is a heap entry to warn us when the max_duration limit is reached
 865  */
 866 void Action::heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat)
 867 {
 868   m_hat = hat;
 869   xbt_heap_push(heap, this, key);
 870 }
 871
 872 void Action::heapRemove(xbt_heap_t heap)
 873 {
 874   m_hat = NOTSET;
 875   if (m_indexHeap >= 0) {
 876     xbt_heap_remove(heap, m_indexHeap);
 877   }
 878 }
 879
 880 void Action::heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat)
 881 {
 882   m_hat = hat;
 883   if (m_indexHeap >= 0) {
 884     xbt_heap_update(heap, m_indexHeap, key);
 885   }else{
 886     xbt_heap_push(heap, this, key);
 887   }
 888 }
 889
 890 void Action::updateIndexHeap(int i) {
 891   m_indexHeap = i;
 892 }
 893
 894 double Action::getRemains()
 895 {
 896   XBT_IN("(%p)", this);
 897   /* update remains before return it */
 898   if (getModel()->getUpdateMechanism() == UM_LAZY)      /* update remains before return it */
 899     updateRemainingLazy(surf_get_clock());
 900   XBT_OUT();
 901   return m_remains;
 902 }
 903
 904 double Action::getRemainsNoUpdate()
 905 {
 906   return m_remains;
 907 }
 908
 909 //FIXME split code in the right places
 910 void Action::updateRemainingLazy(double now)
 911 {
 912   double delta = 0.0;
 913
 914   if(getModel() == surf_network_model)
 915   {
 916     if (m_suspended != 0)
 917       return;
 918   }
 919   else
 920   {
 921     xbt_assert(p_stateSet == getModel()->getRunningActionSet(),
 922         "You're updating an action that is not running.");
 923
 924       /* bogus priority, skip it */
 925     xbt_assert(m_priority > 0,
 926         "You're updating an action that seems suspended.");
 927   }
 928
 929   delta = now - m_lastUpdate;
 930
 931   if (m_remains > 0) {
 932     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, m_remains, m_lastUpdate);
 933     double_update(&m_remains, m_lastValue * delta, sg_surf_precision*sg_maxmin_precision);
 934
 935     if (getModel() == surf_cpu_model_pm && TRACE_is_enabled()) {
 936       simgrid::surf::Resource *cpu = static_cast<simgrid::surf::Resource*>(
 937         lmm_constraint_id(lmm_get_cnst_from_var(getModel()->getMaxminSystem(), getVariable(), 0)));
 938       TRACE_surf_host_set_utilization(cpu->getName(), getCategory(), m_lastValue, m_lastUpdate, now - m_lastUpdate);
 939     }
 940     XBT_DEBUG("Updating action(%p): remains is now %f", this, m_remains);
 941   }
 942
 943   if(getModel() == surf_network_model)
 944   {
 945     if (m_maxDuration != NO_MAX_DURATION)
 946       double_update(&m_maxDuration, delta, sg_surf_precision);
 947
 948     //FIXME: duplicated code
 949     if ((m_remains <= 0) &&
 950         (lmm_get_variable_weight(getVariable()) > 0)) {
 951       finish();
 952       setState(SURF_ACTION_DONE);
 953       heapRemove(getModel()->getActionHeap());
 954     } else if (((m_maxDuration != NO_MAX_DURATION)
 955         && (m_maxDuration <= 0))) {
 956       finish();
 957       setState(SURF_ACTION_DONE);
 958       heapRemove(getModel()->getActionHeap());
 959     }
 960   }
 961
 962   m_lastUpdate = now;
 963   m_lastValue = lmm_variable_getvalue(getVariable());
 964 }
 965
 966 }
 967 }