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