src/surf/surf_interface.cpp

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