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
 198 double surf_get_clock(void)
 199 {
 200   return NOW;
 201 }
 202
 203 #ifdef _XBT_WIN32
 204 # define FILE_DELIM "\\"
 205 #else
 206 # define FILE_DELIM "/"         /* FIXME: move to better location */
 207 #endif
 208
 209 FILE *surf_fopen(const char *name, const char *mode)
 210 {
 211   unsigned int cpt;
 212   char *path_elm = NULL;
 213   char *buff;
 214   FILE *file = NULL;
 215
 216   xbt_assert(name);
 217
 218   if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
 219     return fopen(name, mode);
 220
 221   /* search relative files in the path */
 222   xbt_dynar_foreach(surf_path, cpt, path_elm) {
 223     buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
 224     file = fopen(buff, mode);
 225     free(buff);
 226
 227     if (file)
 228       return file;
 229   }
 230   return NULL;
 231 }
 232
 233 #ifdef _XBT_WIN32
 234 #include <windows.h>
 235 #define MAX_DRIVE 26
 236 static const char *disk_drives_letter_table[MAX_DRIVE] = {
 237   "A:\\","B:\\","C:\\","D:\\","E:\\","F:\\","G:\\","H:\\","I:\\","J:\\","K:\\","L:\\","M:\\",
 238   "N:\\","O:\\","P:\\","Q:\\","R:\\","S:\\","T:\\","U:\\","V:\\","W:\\","X:\\","Y:\\","Z:\\"
 239 };
 240 #endif
 241
 242 /*
 243  * Returns the initial path. On Windows the initial path is
 244  * the current directory for the current process in the other
 245  * case the function returns "./" that represents the current
 246  * directory on Unix/Linux platforms.
 247  */
 248
 249 const char *__surf_get_initial_path(void)
 250 {
 251
 252 #ifdef _XBT_WIN32
 253   unsigned i;
 254   char current_directory[MAX_PATH + 1] = { 0 };
 255   unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
 256   char root[4] = { 0 };
 257
 258   if (!len)
 259     return NULL;
 260
 261   strncpy(root, current_directory, 3);
 262
 263   for (i = 0; i < MAX_DRIVE; i++) {
 264     if (toupper(root[0]) == disk_drives_letter_table[i][0])
 265       return disk_drives_letter_table[i];
 266   }
 267
 268   return NULL;
 269 #else
 270   return "./";
 271 #endif
 272 }
 273
 274 /* The __surf_is_absolute_file_path() returns 1 if
 275  * file_path is a absolute file path, in the other
 276  * case the function returns 0.
 277  */
 278 int __surf_is_absolute_file_path(const char *file_path)
 279 {
 280 #ifdef _XBT_WIN32
 281   WIN32_FIND_DATA wfd = { 0 };
 282   HANDLE hFile = FindFirstFile(file_path, &wfd);
 283
 284   if (INVALID_HANDLE_VALUE == hFile)
 285     return 0;
 286
 287   FindClose(hFile);
 288   return 1;
 289 #else
 290   return (file_path[0] == '/');
 291 #endif
 292 }
 293
 294 /** Displays the long description of all registered models, and quit */
 295 void model_help(const char *category, s_surf_model_description_t * table)
 296 {
 297   int i;
 298   printf("Long description of the %s models accepted by this simulator:\n",
 299          category);
 300   for (i = 0; table[i].name; i++)
 301     printf("  %s: %s\n", table[i].name, table[i].description);
 302 }
 303
 304 int find_model_description(s_surf_model_description_t * table,
 305                            const char *name)
 306 {
 307   int i;
 308   char *name_list = NULL;
 309
 310   for (i = 0; table[i].name; i++)
 311     if (!strcmp(name, table[i].name)) {
 312       return i;
 313     }
 314   if (!table[0].name)
 315     xbt_die("No model is valid! This is a bug.");
 316   name_list = xbt_strdup(table[0].name);
 317   for (i = 1; table[i].name; i++) {
 318     name_list = (char *) xbt_realloc(name_list, strlen(name_list) + strlen(table[i].name) + 3);
 319     strcat(name_list, ", ");
 320     strcat(name_list, table[i].name);
 321   }
 322   xbt_die("Model '%s' is invalid! Valid models are: %s.", name, name_list);
 323   return -1;
 324 }
 325
 326 static XBT_INLINE void routing_asr_prop_free(void *p)
 327 {
 328   //xbt_dict_t elm = (xbt_dict_t) p;
 329   //xbt_dict_free(&elm); FIXME: leaking in some case? That's a sometimes double-free with AsCluster::~AsCluster
 330 }
 331
 332 static XBT_INLINE void surf_host_free(void *r)
 333 {
 334   delete static_cast<Host*>(r);
 335 }
 336
 337 static XBT_INLINE void surf_storage_free(void *r)
 338 {
 339   delete static_cast<Storage*>(r);
 340 }
 341
 342 void sg_version_check(int lib_version_major,int lib_version_minor,int lib_version_patch) {
 343     if ((lib_version_major != SIMGRID_VERSION_MAJOR) || (lib_version_minor != SIMGRID_VERSION_MINOR)) {
 344       fprintf(stderr,
 345                   "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
 346                   "and then linked against SimGrid %d.%d.%d. Please fix this.\n",
 347               SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH,
 348                           lib_version_major,lib_version_minor,lib_version_patch);
 349       abort();
 350     }
 351     if (lib_version_patch != SIMGRID_VERSION_PATCH) {
 352         fprintf(stderr,
 353                   "Warning: Your program was compiled with SimGrid version %d.%d.%d, "
 354                   "and then linked against SimGrid %d.%d.%d. Proceeding anyway.\n",
 355                 SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH,
 356                           lib_version_major,lib_version_minor,lib_version_patch);
 357     }
 358 }
 359
 360 void sg_version(int *ver_major,int *ver_minor,int *ver_patch) {
 361   *ver_major = SIMGRID_VERSION_MAJOR;
 362   *ver_minor = SIMGRID_VERSION_MINOR;
 363   *ver_patch = SIMGRID_VERSION_PATCH;
 364 }
 365
 366 void surf_init(int *argc, char **argv)
 367 {
 368   XBT_DEBUG("Create all Libs");
 369   host_lib = xbt_lib_new();
 370   as_router_lib = xbt_lib_new();
 371   storage_lib = xbt_lib_new();
 372   storage_type_lib = xbt_lib_new();
 373   file_lib = xbt_lib_new();
 374   watched_hosts_lib = xbt_dict_new_homogeneous(NULL);
 375
 376   sg_host_init();
 377
 378   XBT_DEBUG("Add routing levels");
 379   ROUTING_PROP_ASR_LEVEL = xbt_lib_add_level(as_router_lib,routing_asr_prop_free);
 380
 381   XBT_DEBUG("Add SURF levels");
 382   SURF_HOST_LEVEL = xbt_lib_add_level(host_lib,surf_host_free);
 383   SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_free);
 384
 385   xbt_init(argc, argv);
 386   if (!model_list)
 387     model_list = xbt_dynar_new(sizeof(Model*), NULL);
 388   if (!model_list_invoke)
 389     model_list_invoke = xbt_dynar_new(sizeof(Model*), NULL);
 390   if (!history)
 391     history = tmgr_history_new();
 392
 393   TRACE_add_start_function(TRACE_surf_alloc);
 394   TRACE_add_end_function(TRACE_surf_release);
 395
 396   sg_config_init(argc, argv);
 397
 398   if (MC_is_active())
 399     MC_memory_init();
 400 }
 401
 402 void surf_exit(void)
 403 {
 404   unsigned int iter;
 405   Model *model = NULL;
 406
 407   TRACE_end();                  /* Just in case it was not called by the upper
 408                                  * layer (or there is no upper layer) */
 409
 410   sg_config_finalize();
 411
 412   xbt_dynar_free(&host_that_restart);
 413   xbt_dynar_free(&surf_path);
 414
 415   xbt_lib_free(&host_lib);
 416   xbt_lib_free(&as_router_lib);
 417   xbt_lib_free(&storage_lib);
 418   sg_link_exit();
 419   xbt_lib_free(&storage_type_lib);
 420   xbt_lib_free(&file_lib);
 421   xbt_dict_free(&watched_hosts_lib);
 422
 423   xbt_dynar_foreach(model_list, iter, model)
 424     delete model;
 425   xbt_dynar_free(&model_list);
 426   xbt_dynar_free(&model_list_invoke);
 427   routing_exit();
 428
 429   surf_callback_emit(surfExitCallbacks);
 430
 431   if (maxmin_system) {
 432     lmm_system_free(maxmin_system);
 433     maxmin_system = NULL;
 434   }
 435   if (history) {
 436     tmgr_history_free(history);
 437     history = NULL;
 438   }
 439
 440 #ifdef CONTEXT_THREADS
 441   xbt_parmap_destroy(surf_parmap);
 442 #endif
 443
 444   tmgr_finalize();
 445   surf_parse_lex_destroy();
 446   surf_parse_free_callbacks();
 447
 448   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
 449 }
 450
 451 /*********
 452  * Model *
 453  *********/
 454
 455 Model::Model()
 456   : p_maxminSystem(NULL)
 457 {
 458   p_readyActionSet = new ActionList();
 459   p_runningActionSet = new ActionList();
 460   p_failedActionSet = new ActionList();
 461   p_doneActionSet = new ActionList();
 462
 463   p_modifiedSet = NULL;
 464   p_actionHeap = NULL;
 465   p_updateMechanism = UM_UNDEFINED;
 466   m_selectiveUpdate = 0;
 467 }
 468
 469 Model::~Model(){
 470   delete p_readyActionSet;
 471   delete p_runningActionSet;
 472   delete p_failedActionSet;
 473   delete p_doneActionSet;
 474 }
 475
 476 double Model::shareResources(double now)
 477 {
 478   //FIXME: set the good function once and for all
 479   if (p_updateMechanism == UM_LAZY)
 480     return shareResourcesLazy(now);
 481   else if (p_updateMechanism == UM_FULL)
 482     return shareResourcesFull(now);
 483   else
 484     xbt_die("Invalid cpu update mechanism!");
 485 }
 486
 487 double Model::shareResourcesLazy(double now)
 488 {
 489   Action *action = NULL;
 490   double min = -1;
 491   double share;
 492
 493   XBT_DEBUG
 494       ("Before share resources, the size of modified actions set is %zd",
 495        p_modifiedSet->size());
 496
 497   lmm_solve(p_maxminSystem);
 498
 499   XBT_DEBUG
 500       ("After share resources, The size of modified actions set is %zd",
 501        p_modifiedSet->size());
 502
 503   while(!p_modifiedSet->empty()) {
 504     action = &(p_modifiedSet->front());
 505     p_modifiedSet->pop_front();
 506     int max_dur_flag = 0;
 507
 508     if (action->getStateSet() != p_runningActionSet)
 509       continue;
 510
 511     /* bogus priority, skip it */
 512     if (action->getPriority() <= 0 || action->getHat()==LATENCY)
 513       continue;
 514
 515     action->updateRemainingLazy(now);
 516
 517     min = -1;
 518     share = lmm_variable_getvalue(action->getVariable());
 519
 520     if (share > 0) {
 521       double time_to_completion;
 522       if (action->getRemains() > 0) {
 523         time_to_completion = action->getRemainsNoUpdate() / share;
 524       } else {
 525         time_to_completion = 0.0;
 526       }
 527       min = now + time_to_completion; // when the task will complete if nothing changes
 528     }
 529
 530     if ((action->getMaxDuration() != NO_MAX_DURATION)
 531         && (min == -1
 532             || action->getStartTime() +
 533             action->getMaxDuration() < min)) {
 534       min = action->getStartTime() +
 535           action->getMaxDuration();  // when the task will complete anyway because of the deadline if any
 536       max_dur_flag = 1;
 537     }
 538
 539
 540     XBT_DEBUG("Action(%p) corresponds to variable %d", action, action->getVariable()->id_int);
 541
 542     XBT_DEBUG("Action(%p) Start %f. May finish at %f (got a share of %f). Max_duration %f", action,
 543         action->getStartTime(), min, share,
 544         action->getMaxDuration());
 545
 546     if (min != -1) {
 547       action->heapUpdate(p_actionHeap, min, max_dur_flag ? MAX_DURATION : NORMAL);
 548       XBT_DEBUG("Insert at heap action(%p) min %f now %f", action, min,
 549                 now);
 550     } else DIE_IMPOSSIBLE;
 551   }
 552
 553   //hereafter must have already the min value for this resource model
 554   if (xbt_heap_size(p_actionHeap) > 0)
 555     min = xbt_heap_maxkey(p_actionHeap) - now;
 556   else
 557     min = -1;
 558
 559   XBT_DEBUG("The minimum with the HEAP %f", min);
 560
 561   return min;
 562 }
 563
 564 double Model::shareResourcesFull(double /*now*/) {
 565   THROW_UNIMPLEMENTED;
 566 }
 567
 568 double Model::shareResourcesMaxMin(ActionList *running_actions,
 569                           lmm_system_t sys,
 570                           void (*solve) (lmm_system_t))
 571 {
 572   Action *action = NULL;
 573   double min = -1;
 574   double value = -1;
 575
 576   solve(sys);
 577
 578   ActionList::iterator it(running_actions->begin()), itend(running_actions->end());
 579   for(; it != itend ; ++it) {
 580     action = &*it;
 581     value = lmm_variable_getvalue(action->getVariable());
 582     if ((value > 0) || (action->getMaxDuration() >= 0))
 583       break;
 584   }
 585
 586   if (!action)
 587     return -1.0;
 588
 589   if (value > 0) {
 590     if (action->getRemains() > 0)
 591       min = action->getRemainsNoUpdate() / value;
 592     else
 593       min = 0.0;
 594     if ((action->getMaxDuration() >= 0) && (action->getMaxDuration() < min))
 595       min = action->getMaxDuration();
 596   } else
 597     min = action->getMaxDuration();
 598
 599
 600   for (++it; it != itend; ++it) {
 601         action = &*it;
 602     value = lmm_variable_getvalue(action->getVariable());
 603     if (value > 0) {
 604       if (action->getRemains() > 0)
 605         value = action->getRemainsNoUpdate() / value;
 606       else
 607         value = 0.0;
 608       if (value < min) {
 609         min = value;
 610         XBT_DEBUG("Updating min (value) with %p: %f", action, min);
 611       }
 612     }
 613     if ((action->getMaxDuration() >= 0) && (action->getMaxDuration() < min)) {
 614       min = action->getMaxDuration();
 615       XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
 616     }
 617   }
 618   XBT_DEBUG("min value : %f", min);
 619
 620   return min;
 621 }
 622
 623 void Model::updateActionsState(double now, double delta)
 624 {
 625   if (p_updateMechanism == UM_FULL)
 626         updateActionsStateFull(now, delta);
 627   else if (p_updateMechanism == UM_LAZY)
 628         updateActionsStateLazy(now, delta);
 629   else
 630         xbt_die("Invalid cpu update mechanism!");
 631 }
 632
 633 void Model::updateActionsStateLazy(double /*now*/, double /*delta*/)
 634 {
 635  THROW_UNIMPLEMENTED;
 636 }
 637
 638 void Model::updateActionsStateFull(double /*now*/, double /*delta*/)
 639 {
 640   THROW_UNIMPLEMENTED;
 641 }
 642
 643 /************
 644  * Resource *
 645  ************/
 646
 647 Resource::Resource()
 648 : p_name(NULL), p_properties(NULL), p_model(NULL)
 649 {}
 650
 651 Resource::Resource(Model *model, const char *name, xbt_dict_t props)
 652   : p_name(xbt_strdup(name)), p_properties(props), p_model(model)
 653   , m_running(true), m_stateCurrent(SURF_RESOURCE_ON)
 654 {}
 655
 656 Resource::Resource(Model *model, const char *name, xbt_dict_t props, lmm_constraint_t constraint)
 657   : p_name(xbt_strdup(name)), p_properties(props), p_model(model)
 658   , m_running(true), m_stateCurrent(SURF_RESOURCE_ON), p_constraint(constraint)
 659 {}
 660
 661 Resource::Resource(Model *model, const char *name, xbt_dict_t props, e_surf_resource_state_t stateInit)
 662   : p_name(xbt_strdup(name)), p_properties(props), p_model(model)
 663   , m_running(true), m_stateCurrent(stateInit)
 664 {}
 665
 666 Resource::~Resource() {
 667   xbt_free((void*)p_name);
 668   xbt_dict_free(&p_properties);
 669 }
 670
 671 e_surf_resource_state_t Resource::getState()
 672 {
 673   return m_stateCurrent;
 674 }
 675
 676 void Resource::setState(e_surf_resource_state_t state)
 677 {
 678   m_stateCurrent = state;
 679 }
 680
 681 bool Resource::isOn()
 682 {
 683   return m_running;
 684 }
 685
 686 void Resource::turnOn()
 687 {
 688   if (!m_running) {
 689     m_running = true;
 690   }
 691 }
 692
 693 void Resource::turnOff()
 694 {
 695   if (m_running) {
 696     m_running = false;
 697   }
 698 }
 699
 700 Model *Resource::getModel() {
 701   return p_model;
 702 }
 703
 704 const char *Resource::getName() {
 705   return p_name;
 706 }
 707
 708 xbt_dict_t Resource::getProperties() {
 709   if (p_properties==NULL)
 710     p_properties = xbt_dict_new();
 711   return p_properties;
 712 }
 713
 714 lmm_constraint_t Resource::getConstraint() {
 715   return p_constraint;
 716 }
 717
 718 /**********
 719  * Action *
 720  **********/
 721
 722 const char *surf_action_state_names[6] = {
 723   "SURF_ACTION_READY",
 724   "SURF_ACTION_RUNNING",
 725   "SURF_ACTION_FAILED",
 726   "SURF_ACTION_DONE",
 727   "SURF_ACTION_TO_FREE",
 728   "SURF_ACTION_NOT_IN_THE_SYSTEM"
 729 };
 730
 731 void Action::initialize(Model *model, double cost, bool failed,
 732                         lmm_variable_t var)
 733 {
 734   m_priority = 1.0;
 735   m_refcount = 1;
 736   m_remains = cost;
 737   m_maxDuration = NO_MAX_DURATION;
 738   m_finish = -1.0;
 739   m_start = surf_get_clock();
 740   m_cost = cost;
 741   p_model = model;
 742   p_data = NULL;
 743   p_variable = var;
 744   m_lastValue = 0;
 745   m_lastUpdate = 0;
 746   m_suspended = false;
 747   m_hat = NOTSET;
 748   p_category = NULL;
 749   p_stateHookup.prev = 0;
 750   p_stateHookup.next = 0;
 751   if (failed)
 752     p_stateSet = getModel()->getFailedActionSet();
 753   else
 754     p_stateSet = getModel()->getRunningActionSet();
 755
 756   p_stateSet->push_back(*this);
 757 }
 758
 759 Action::Action(Model *model, double cost, bool failed)
 760 {
 761   initialize(model, cost, failed);
 762 }
 763
 764 Action::Action(Model *model, double cost, bool failed, lmm_variable_t var)
 765 {
 766   initialize(model, cost, failed, var);
 767 }
 768
 769 Action::~Action() {
 770   xbt_free(p_category);
 771 }
 772
 773 void Action::finish() {
 774     m_finish = surf_get_clock();
 775 }
 776
 777 e_surf_action_state_t Action::getState()
 778 {
 779   if (p_stateSet ==  getModel()->getReadyActionSet())
 780     return SURF_ACTION_READY;
 781   if (p_stateSet ==  getModel()->getRunningActionSet())
 782     return SURF_ACTION_RUNNING;
 783   if (p_stateSet ==  getModel()->getFailedActionSet())
 784     return SURF_ACTION_FAILED;
 785   if (p_stateSet ==  getModel()->getDoneActionSet())
 786     return SURF_ACTION_DONE;
 787   return SURF_ACTION_NOT_IN_THE_SYSTEM;
 788 }
 789
 790 void Action::setState(e_surf_action_state_t state)
 791 {
 792   //surf_action_state_t action_state = &(action->model_type->states);
 793   XBT_IN("(%p,%s)", this, surf_action_state_names[state]);
 794   p_stateSet->erase(p_stateSet->iterator_to(*this));
 795   if (state == SURF_ACTION_READY)
 796     p_stateSet = getModel()->getReadyActionSet();
 797   else if (state == SURF_ACTION_RUNNING)
 798     p_stateSet = getModel()->getRunningActionSet();
 799   else if (state == SURF_ACTION_FAILED)
 800     p_stateSet = getModel()->getFailedActionSet();
 801   else if (state == SURF_ACTION_DONE)
 802     p_stateSet = getModel()->getDoneActionSet();
 803   else
 804     p_stateSet = NULL;
 805
 806   if (p_stateSet)
 807     p_stateSet->push_back(*this);
 808   XBT_OUT();
 809 }
 810
 811 double Action::getBound()
 812 {
 813   return (p_variable) ? lmm_variable_getbound(p_variable) : 0;
 814 }
 815
 816 void Action::setBound(double bound)
 817 {
 818   XBT_IN("(%p,%g)", this, bound);
 819   if (p_variable)
 820     lmm_update_variable_bound(getModel()->getMaxminSystem(), p_variable, bound);
 821
 822   if (getModel()->getUpdateMechanism() == UM_LAZY && getLastUpdate()!=surf_get_clock())
 823     heapRemove(getModel()->getActionHeap());
 824   XBT_OUT();
 825 }
 826
 827 double Action::getStartTime()
 828 {
 829   return m_start;
 830 }
 831
 832 double Action::getFinishTime()
 833 {
 834   /* keep the function behavior, some models (cpu_ti) change the finish time before the action end */
 835   return m_remains == 0 ? m_finish : -1;
 836 }
 837
 838 void Action::setData(void* data)
 839 {
 840   p_data = data;
 841 }
 842
 843 void Action::setCategory(const char *category)
 844 {
 845   XBT_IN("(%p,%s)", this, category);
 846   p_category = xbt_strdup(category);
 847   XBT_OUT();
 848 }
 849
 850 void Action::ref(){
 851   m_refcount++;
 852 }
 853
 854 void Action::setMaxDuration(double duration)
 855 {
 856   XBT_IN("(%p,%g)", this, duration);
 857   m_maxDuration = duration;
 858   if (getModel()->getUpdateMechanism() == UM_LAZY)      // remove action from the heap
 859     heapRemove(getModel()->getActionHeap());
 860   XBT_OUT();
 861 }
 862
 863 void Action::gapRemove() {}
 864
 865 void Action::setPriority(double priority)
 866 {
 867   XBT_IN("(%p,%g)", this, priority);
 868   m_priority = priority;
 869   lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), priority);
 870
 871   if (getModel()->getUpdateMechanism() == UM_LAZY)
 872         heapRemove(getModel()->getActionHeap());
 873   XBT_OUT();
 874 }
 875
 876 void Action::cancel(){
 877   setState(SURF_ACTION_FAILED);
 878   if (getModel()->getUpdateMechanism() == UM_LAZY) {
 879     if (actionLmmHook::is_linked())
 880       getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
 881     heapRemove(getModel()->getActionHeap());
 882   }
 883 }
 884
 885 int Action::unref(){
 886   m_refcount--;
 887   if (!m_refcount) {
 888     if (actionHook::is_linked())
 889       p_stateSet->erase(p_stateSet->iterator_to(*this));
 890     if (getVariable())
 891       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
 892     if (getModel()->getUpdateMechanism() == UM_LAZY) {
 893       /* remove from heap */
 894       heapRemove(getModel()->getActionHeap());
 895       if (actionLmmHook::is_linked())
 896         getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
 897     }
 898     delete this;
 899     return 1;
 900   }
 901   return 0;
 902 }
 903
 904 void Action::suspend()
 905 {
 906   XBT_IN("(%p)", this);
 907   if (m_suspended != 2) {
 908     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
 909     m_suspended = 1;
 910     if (getModel()->getUpdateMechanism() == UM_LAZY)
 911       heapRemove(getModel()->getActionHeap());
 912   }
 913   XBT_OUT();
 914 }
 915
 916 void Action::resume()
 917 {
 918   XBT_IN("(%p)", this);
 919   if (m_suspended != 2) {
 920     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), m_priority);
 921     m_suspended = 0;
 922     if (getModel()->getUpdateMechanism() == UM_LAZY)
 923       heapRemove(getModel()->getActionHeap());
 924   }
 925   XBT_OUT();
 926 }
 927
 928 bool Action::isSuspended()
 929 {
 930   return m_suspended == 1;
 931 }
 932 /* insert action on heap using a given key and a hat (heap_action_type)
 933  * a hat can be of three types for communications:
 934  *
 935  * NORMAL = this is a normal heap entry stating the date to finish transmitting
 936  * LATENCY = this is a heap entry to warn us when the latency is payed
 937  * MAX_DURATION =this is a heap entry to warn us when the max_duration limit is reached
 938  */
 939 void Action::heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat)
 940 {
 941   m_hat = hat;
 942   xbt_heap_push(heap, this, key);
 943 }
 944
 945 void Action::heapRemove(xbt_heap_t heap)
 946 {
 947   m_hat = NOTSET;
 948   if (m_indexHeap >= 0) {
 949     xbt_heap_remove(heap, m_indexHeap);
 950   }
 951 }
 952
 953 void Action::heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat)
 954 {
 955   m_hat = hat;
 956   if (m_indexHeap >= 0) {
 957     xbt_heap_update(heap, m_indexHeap, key);
 958   }else{
 959     xbt_heap_push(heap, this, key);
 960   }
 961 }
 962
 963 /* added to manage the communication action's heap */
 964 void surf_action_lmm_update_index_heap(void *action, int i) {
 965   static_cast<Action*>(action)->updateIndexHeap(i);
 966 }
 967
 968 void Action::updateIndexHeap(int i) {
 969   m_indexHeap = i;
 970 }
 971
 972 double Action::getRemains()
 973 {
 974   XBT_IN("(%p)", this);
 975   /* update remains before return it */
 976   if (getModel()->getUpdateMechanism() == UM_LAZY)      /* update remains before return it */
 977     updateRemainingLazy(surf_get_clock());
 978   XBT_OUT();
 979   return m_remains;
 980 }
 981
 982 double Action::getRemainsNoUpdate()
 983 {
 984   return m_remains;
 985 }
 986
 987 //FIXME split code in the right places
 988 void Action::updateRemainingLazy(double now)
 989 {
 990   double delta = 0.0;
 991
 992   if(getModel() == surf_network_model)
 993   {
 994     if (m_suspended != 0)
 995       return;
 996   }
 997   else
 998   {
 999     xbt_assert(p_stateSet == getModel()->getRunningActionSet(),
1000         "You're updating an action that is not running.");
1001
1002       /* bogus priority, skip it */
1003     xbt_assert(m_priority > 0,
1004         "You're updating an action that seems suspended.");
1005   }
1006
1007   delta = now - m_lastUpdate;
1008
1009   if (m_remains > 0) {
1010     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, m_remains, m_lastUpdate);
1011     double_update(&m_remains, m_lastValue * delta, sg_surf_precision*sg_maxmin_precision);
1012
1013     if (getModel() == surf_cpu_model_pm && TRACE_is_enabled()) {
1014       Resource *cpu = static_cast<Resource*>(lmm_constraint_id(lmm_get_cnst_from_var(getModel()->getMaxminSystem(), getVariable(), 0)));
1015       TRACE_surf_host_set_utilization(cpu->getName(), getCategory(), m_lastValue, m_lastUpdate, now - m_lastUpdate);
1016     }
1017     XBT_DEBUG("Updating action(%p): remains is now %f", this, m_remains);
1018   }
1019
1020   if(getModel() == surf_network_model)
1021   {
1022     if (m_maxDuration != NO_MAX_DURATION)
1023       double_update(&m_maxDuration, delta, sg_surf_precision);
1024
1025     //FIXME: duplicated code
1026     if ((m_remains <= 0) &&
1027         (lmm_get_variable_weight(getVariable()) > 0)) {
1028       finish();
1029       setState(SURF_ACTION_DONE);
1030       heapRemove(getModel()->getActionHeap());
1031     } else if (((m_maxDuration != NO_MAX_DURATION)
1032         && (m_maxDuration <= 0))) {
1033       finish();
1034       setState(SURF_ACTION_DONE);
1035       heapRemove(getModel()->getActionHeap());
1036     }
1037   }
1038
1039   m_lastUpdate = now;
1040   m_lastValue = lmm_variable_getvalue(getVariable());
1041 }