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