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