src/surf/surf.cpp

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