src/surf/surf_interface.cpp

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