src/surf/surf.c

   1 /*      $Id$     */
   2
   3 /* Copyright (c) 2004 Arnaud Legrand. All rights reserved.                  */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #include <ctype.h>
   9
  10 #include "surf_private.h"
  11 #include "xbt/module.h"
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf,
  14                                 "Logging specific to SURF (kernel)");
  15
  16 int use_sdp_solver = 0;
  17 int use_lagrange_solver = 0;
  18
  19 extern double alpha_legrandvelho;
  20 extern double beta_legrandvelho;
  21
  22 /* Additional declarations for Windows potability. */
  23
  24 #ifndef MAX_DRIVE
  25 #define MAX_DRIVE 26
  26 #endif
  27
  28 #ifdef _WIN32
  29 #include <windows.h>
  30 static const char *disk_drives_letter_table[MAX_DRIVE] = {
  31   "A:\\",
  32   "B:\\",
  33   "C:\\",
  34   "D:\\",
  35   "E:\\",
  36   "F:\\",
  37   "G:\\",
  38   "H:\\",
  39   "I:\\",
  40   "J:\\",
  41   "K:\\",
  42   "L:\\",
  43   "M:\\",
  44   "N:\\",
  45   "O:\\",
  46   "P:\\",
  47   "Q:\\",
  48   "R:\\",
  49   "S:\\",
  50   "T:\\",
  51   "U:\\",
  52   "V:\\",
  53   "W:\\",
  54   "X:\\",
  55   "Y:\\",
  56   "Z:\\"
  57 };
  58 #endif                          /* #ifdef _WIN32 */
  59
  60 /*
  61  * Returns the initial path. On Windows the initial path is
  62  * the current directory for the current process in the other
  63  * case the function returns "./" that represents the current
  64  * directory on Unix/Linux platforms.
  65  */
  66
  67 const char *__surf_get_initial_path(void)
  68 {
  69
  70 #ifdef _WIN32
  71   unsigned i;
  72   char current_directory[MAX_PATH + 1] = { 0 };
  73   unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
  74   char root[4] = { 0 };
  75
  76   if (!len)
  77     return NULL;
  78
  79   strncpy(root, current_directory, 3);
  80
  81   for (i = 0; i < MAX_DRIVE; i++) {
  82     if (toupper(root[0]) == disk_drives_letter_table[i][0])
  83       return disk_drives_letter_table[i];
  84   }
  85
  86   return NULL;
  87 #else
  88   return "./";
  89 #endif
  90 }
  91
  92 /* The __surf_is_absolute_file_path() returns 1 if
  93  * file_path is a absolute file path, in the other
  94  * case the function returns 0.
  95  */
  96 int __surf_is_absolute_file_path(const char *file_path)
  97 {
  98 #ifdef _WIN32
  99   WIN32_FIND_DATA wfd = { 0 };
 100   HANDLE hFile = FindFirstFile(file_path, &wfd);
 101
 102   if (INVALID_HANDLE_VALUE == hFile)
 103     return 0;
 104
 105   FindClose(hFile);
 106   return 1;
 107 #else
 108   return (file_path[0] == '/');
 109 #endif
 110 }
 111
 112 typedef struct surf_model_object {
 113   surf_model_t model;
 114 } s_surf_model_object_t, *surf_model_object_t;
 115
 116 static double NOW = 0;
 117
 118 xbt_dynar_t model_list = NULL;
 119 tmgr_history_t history = NULL;
 120 lmm_system_t maxmin_system = NULL;
 121 xbt_dynar_t surf_path = NULL;
 122 const char *surf_action_state_names[6] = {
 123   "SURF_ACTION_READY",
 124   "SURF_ACTION_RUNNING",
 125   "SURF_ACTION_FAILED",
 126   "SURF_ACTION_DONE",
 127   "SURF_ACTION_TO_FREE",
 128   "SURF_ACTION_NOT_IN_THE_SYSTEM"
 129 };
 130
 131
 132 s_surf_model_description_t surf_network_model_description[] = {
 133   {"Constant", NULL, surf_network_model_init_Constant},
 134   {"CM02", NULL, surf_network_model_init_CM02},
 135   {"LegrandVelho", NULL, surf_network_model_init_LegrandVelho},
 136 #ifdef HAVE_GTNETS
 137   {"GTNets", NULL, surf_network_model_init_GTNETS},
 138 #endif
 139 #ifdef HAVE_SDP
 140   {"SDP", NULL, surf_network_model_init_SDP},
 141 #endif
 142   {"Reno", NULL, surf_network_model_init_Reno},
 143   {"Reno2", NULL, surf_network_model_init_Reno2},
 144   {"Vegas", NULL, surf_network_model_init_Vegas},
 145   { NULL,NULL,NULL} /* this array must be NULL terminated */
 146 };
 147
 148 s_surf_model_description_t surf_cpu_model_description[] = {
 149   {"Cas01", NULL, surf_cpu_model_init_Cas01},
 150   { NULL,NULL,NULL} /* this array must be NULL terminated */
 151 };
 152
 153 s_surf_model_description_t surf_workstation_model_description[] = {
 154   {"CLM03", NULL, surf_workstation_model_init_CLM03, create_workstations},
 155   {"compound", NULL, surf_workstation_model_init_compound, create_workstations},
 156   {"ptask_L07", NULL, surf_workstation_model_init_ptask_L07, NULL},
 157   { NULL,NULL,NULL} /* this array must be NULL terminated */
 158 };
 159
 160 void update_model_description(s_surf_model_description_t * table,
 161                               const char *name,
 162                               surf_model_t model)
 163 {
 164   int i = find_model_description(table, name);
 165   table[i].model = model;
 166 }
 167
 168 int find_model_description(s_surf_model_description_t * table,
 169                            const char *name)
 170 {
 171   int i;
 172   char *name_list = NULL;
 173
 174   for (i = 0; table[i].name; i++)
 175     if (!strcmp(name, table[i].name)) {
 176       return i;
 177     }
 178   name_list = strdup(table[0].name);
 179   for (i = 1; table[i].name; i++) {
 180     name_list =
 181         xbt_realloc(name_list,
 182                     strlen(name_list) + strlen(table[i].name) + 2);
 183     strcat(name_list, ", ");
 184     strcat(name_list, table[i].name);
 185   }
 186   xbt_assert2(0, "Model '%s' is invalid! Valid models are: %s.", name,
 187               name_list);
 188 }
 189
 190 double generic_maxmin_share_resources(xbt_swag_t running_actions,
 191                                       size_t offset,
 192                                       lmm_system_t sys,
 193                                       void (*solve) (lmm_system_t))
 194 {
 195   surf_action_t action = NULL;
 196   double min = -1;
 197   double value = -1;
 198 #define VARIABLE(action) (*((lmm_variable_t*)(((char *) (action)) + (offset))))
 199
 200   xbt_assert0(solve, "Give me a real solver function!");
 201   solve(sys);
 202
 203   xbt_swag_foreach(action, running_actions) {
 204     value = lmm_variable_getvalue(VARIABLE(action));
 205     if ((value > 0) || (action->max_duration >= 0))
 206       break;
 207   }
 208
 209   if (!action)
 210     return -1.0;
 211
 212   double action_latency= lmm_variable_getdf(VARIABLE(action));
 213
 214   if (value > 0) {
 215     if(action->remains>0)
 216       min = (action->remains / (value*alpha_legrandvelho)) + beta_legrandvelho*action_latency;
 217     else
 218       min = 0.0;
 219     if ((action->max_duration >= 0) && (action->max_duration < min))
 220       min = action->max_duration;
 221   } else
 222     min = action->max_duration;
 223
 224
 225   for (action = xbt_swag_getNext(action, running_actions->offset);
 226        action;
 227        action = xbt_swag_getNext(action, running_actions->offset)) {
 228     value = lmm_variable_getvalue(VARIABLE(action));
 229     if (value > 0) {
 230       if(action->remains>0)
 231         value = (action->remains / (value*alpha_legrandvelho)) + beta_legrandvelho*action_latency;
 232       else
 233         value = 0.0;
 234       if (value < min) {
 235         min = value;
 236         DEBUG2("Updating min (value) with %p: %f", action, min);
 237       }
 238     }
 239     if ((action->max_duration >= 0) && (action->max_duration < min)) {
 240       min = action->max_duration;
 241       DEBUG2("Updating min (duration) with %p: %f", action, min);
 242     }
 243   }
 244   DEBUG1("min value : %f", min);
 245
 246 #undef VARIABLE
 247   return min;
 248 }
 249
 250 e_surf_action_state_t surf_action_get_state(surf_action_t action)
 251 {
 252   surf_action_state_t action_state =
 253       &(action->model_type->common_public->states);
 254
 255   if (action->state_set == action_state->ready_action_set)
 256     return SURF_ACTION_READY;
 257   if (action->state_set == action_state->running_action_set)
 258     return SURF_ACTION_RUNNING;
 259   if (action->state_set == action_state->failed_action_set)
 260     return SURF_ACTION_FAILED;
 261   if (action->state_set == action_state->done_action_set)
 262     return SURF_ACTION_DONE;
 263   return SURF_ACTION_NOT_IN_THE_SYSTEM;
 264 }
 265
 266 double surf_action_get_start_time(surf_action_t action)
 267 {
 268   return action->start;
 269 }
 270
 271 double surf_action_get_finish_time(surf_action_t action)
 272 {
 273   return action->finish;
 274 }
 275
 276 void surf_action_free(surf_action_t * action)
 277 {
 278   (*action)->model_type->common_public->action_cancel(*action);
 279   free(*action);
 280   *action = NULL;
 281 }
 282
 283 void surf_action_change_state(surf_action_t action,
 284                               e_surf_action_state_t state)
 285 {
 286   surf_action_state_t action_state =
 287       &(action->model_type->common_public->states);
 288   XBT_IN2("(%p,%s)", action, surf_action_state_names[state]);
 289   xbt_swag_remove(action, action->state_set);
 290
 291   if (state == SURF_ACTION_READY)
 292     action->state_set = action_state->ready_action_set;
 293   else if (state == SURF_ACTION_RUNNING)
 294     action->state_set = action_state->running_action_set;
 295   else if (state == SURF_ACTION_FAILED)
 296     action->state_set = action_state->failed_action_set;
 297   else if (state == SURF_ACTION_DONE)
 298     action->state_set = action_state->done_action_set;
 299   else
 300     action->state_set = NULL;
 301
 302   if (action->state_set)
 303     xbt_swag_insert(action, action->state_set);
 304   XBT_OUT;
 305 }
 306
 307 void surf_action_set_data(surf_action_t action, void *data)
 308 {
 309   action->data = data;
 310 }
 311
 312 XBT_LOG_EXTERNAL_CATEGORY(surf_cpu);
 313 XBT_LOG_EXTERNAL_CATEGORY(surf_kernel);
 314 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange);
 315 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange_dichotomy);
 316 XBT_LOG_EXTERNAL_CATEGORY(surf_maxmin);
 317 XBT_LOG_EXTERNAL_CATEGORY(surf_network);
 318 XBT_LOG_EXTERNAL_CATEGORY(surf_parse);
 319 XBT_LOG_EXTERNAL_CATEGORY(surf_timer);
 320 XBT_LOG_EXTERNAL_CATEGORY(surf_workstation);
 321
 322 #ifdef HAVE_SDP
 323   XBT_LOG_EXTERNAL_CATEGORY(surf_sdp_out);
 324   XBT_LOG_EXTERNAL_CATEGORY(surf_sdp);
 325 #endif
 326 #ifdef HAVE_GTNETS
 327   XBT_LOG_EXTERNAL_CATEGORY(surf_network_gtnets);
 328 #endif
 329
 330 void surf_init(int *argc, char **argv)
 331 {
 332   int i, j;
 333   char *opt;
 334
 335   const char *initial_path;
 336
 337   /* Connect our log channels: that must be done manually under windows */
 338   XBT_LOG_CONNECT(surf_cpu, surf);
 339   XBT_LOG_CONNECT(surf_kernel, surf);
 340   XBT_LOG_CONNECT(surf_lagrange, surf);
 341     XBT_LOG_CONNECT(surf_lagrange_dichotomy, surf_lagrange);
 342   XBT_LOG_CONNECT(surf_maxmin, surf);
 343   XBT_LOG_CONNECT(surf_network, surf);
 344   XBT_LOG_CONNECT(surf_parse, surf);
 345   XBT_LOG_CONNECT(surf_timer, surf);
 346   XBT_LOG_CONNECT(surf_workstation, surf);
 347
 348 #ifdef HAVE_SDP
 349   XBT_LOG_CONNECT(surf_sdp_out, surf);
 350   XBT_LOG_CONNECT(surf_sdp, surf);
 351 #endif
 352 #ifdef HAVE_GTNETS
 353   XBT_LOG_CONNECT(surf_network_gtnets, surf);
 354 #endif
 355
 356   xbt_init(argc, argv);
 357   if (!surf_path) {
 358
 359     /* retrieves the current directory of the current process */
 360     initial_path = __surf_get_initial_path();
 361
 362     xbt_assert0((initial_path),
 363                 "__surf_get_initial_path() failed! Can't resolves current Windows directory");
 364
 365     surf_path = xbt_dynar_new(sizeof(char *), NULL);
 366     xbt_dynar_push(surf_path, &initial_path);
 367
 368     for (i = 1; i < *argc; i++) {
 369       if (!strncmp(argv[i], "--surf-path=", strlen("--surf-path="))) {
 370         opt = strchr(argv[i], '=');
 371         opt++;
 372         xbt_dynar_push(surf_path, &opt);
 373         /*remove this from argv */
 374         for (j = i + 1; j < *argc; j++) {
 375           argv[j - 1] = argv[j];
 376         }
 377         argv[j - 1] = NULL;
 378         (*argc)--;
 379         i--;                    /* compensate effect of next loop incrementation */
 380       }
 381     }
 382   }
 383   if (!model_list)
 384     model_list = xbt_dynar_new(sizeof(surf_model_private_t), NULL);
 385   if (!history)
 386     history = tmgr_history_new();
 387 }
 388
 389 static char *path_name = NULL;
 390 FILE *surf_fopen(const char *name, const char *mode)
 391 {
 392   unsigned int iter;
 393   char *path = NULL;
 394   FILE *file = NULL;
 395   unsigned int path_name_len = 0;       /* don't count '\0' */
 396
 397   xbt_assert0(name, "Need a non-NULL file name");
 398
 399   xbt_assert0(surf_path,
 400               "surf_init has to be called before using surf_fopen");
 401
 402   if (__surf_is_absolute_file_path(name)) {     /* don't mess with absolute file names */
 403     return fopen(name, mode);
 404
 405   } else {                      /* search relative files in the path */
 406
 407     if (!path_name) {
 408       path_name_len = strlen(name);
 409       path_name = xbt_new0(char, path_name_len + 1);
 410     }
 411
 412     xbt_dynar_foreach(surf_path, iter, path) {
 413       if (path_name_len < strlen(path) + strlen(name) + 1) {
 414         path_name_len = strlen(path) + strlen(name) + 1;        /* plus '/' */
 415         path_name = xbt_realloc(path_name, path_name_len + 1);
 416       }
 417       #ifdef WIN32
 418       sprintf(path_name, "%s\\%s", path, name);
 419       #else
 420       sprintf(path_name, "%s/%s", path, name);
 421       #endif
 422       file = fopen(path_name, mode);
 423       if (file)
 424         return file;
 425     }
 426   }
 427   return file;
 428 }
 429
 430 void surf_exit(void)
 431 {
 432   unsigned int iter;
 433   surf_model_t model = NULL;
 434
 435   xbt_dynar_foreach(model_list, iter, model) {
 436     model->common_private->finalize();
 437   }
 438
 439   if (maxmin_system) {
 440     lmm_system_free(maxmin_system);
 441     maxmin_system = NULL;
 442   }
 443   if (history) {
 444     tmgr_history_free(history);
 445     history = NULL;
 446   }
 447   if (model_list)
 448     xbt_dynar_free(&model_list);
 449
 450   if (surf_path)
 451     xbt_dynar_free(&surf_path);
 452
 453   tmgr_finalize();
 454   surf_parse_lex_destroy();
 455   if (path_name) {
 456     free(path_name);
 457     path_name = NULL;
 458   }
 459   surf_parse_free_callbacks();
 460   xbt_dict_free(&route_table);
 461   NOW=0; /* Just in case the user plans to restart the simulation afterward */
 462   xbt_exit();
 463 }
 464
 465 void surf_presolve(void) {
 466   double next_event_date = -1.0;
 467   tmgr_trace_event_t event = NULL;
 468   double value = -1.0;
 469   surf_model_object_t model_obj = NULL;
 470   surf_model_t model = NULL;
 471   unsigned int iter;
 472
 473     DEBUG0
 474         ("First Run! Let's \"purge\" events and put models in the right state");
 475     while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
 476       if (next_event_date > NOW)
 477         break;
 478       while ((event =
 479               tmgr_history_get_next_event_leq(history, next_event_date,
 480                                               &value,
 481                                               (void **) &model_obj))) {
 482         model_obj->model->common_private->
 483           update_resource_state(model_obj, event, value,NOW);
 484       }
 485     }
 486     xbt_dynar_foreach(model_list, iter, model) {
 487       model->common_private->update_actions_state(NOW, 0.0);
 488     }
 489 }
 490
 491 double surf_solve(void)
 492 {
 493   double min = -1.0;
 494   double next_event_date = -1.0;
 495   double model_next_action_end = -1.0;
 496   double value = -1.0;
 497   surf_model_object_t model_obj = NULL;
 498   surf_model_t model = NULL;
 499   tmgr_trace_event_t event = NULL;
 500   unsigned int iter;
 501
 502   min = -1.0;
 503
 504   DEBUG0("Looking for next action end");
 505   xbt_dynar_foreach(model_list, iter, model) {
 506     DEBUG1("Running for Resource [%s]", model->common_public->name);
 507     model_next_action_end =
 508         model->common_private->share_resources(NOW);
 509     DEBUG2("Resource [%s] : next action end = %f",
 510            model->common_public->name, model_next_action_end);
 511     if (((min < 0.0) || (model_next_action_end < min))
 512         && (model_next_action_end >= 0.0))
 513       min = model_next_action_end;
 514   }
 515   DEBUG1("Next action end : %f", min);
 516
 517   if (min < 0.0)
 518     return -1.0;
 519
 520   DEBUG0("Looking for next event");
 521   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
 522     DEBUG1("Next event : %f", next_event_date);
 523     if (next_event_date > NOW + min)
 524       break;
 525     DEBUG0("Updating models");
 526     while ((event =
 527             tmgr_history_get_next_event_leq(history, next_event_date,
 528                                             &value,
 529                                             (void **) &model_obj))) {
 530       if (model_obj->model->common_private->
 531           resource_used(model_obj)) {
 532         min = next_event_date - NOW;
 533         DEBUG1
 534             ("This event will modify model state. Next event set to %f",
 535              min);
 536       }
 537       /* update state of model_obj according to new value. Does not touch lmm.
 538          It will be modified if needed when updating actions */
 539       model_obj->model->common_private->
 540         update_resource_state(model_obj, event, value,NOW+min);
 541     }
 542   }
 543
 544   DEBUG1("Duration set to %f", min);
 545
 546   NOW = NOW + min;
 547
 548   xbt_dynar_foreach(model_list, iter, model) {
 549     model->common_private->update_actions_state(NOW, min);
 550   }
 551
 552   return min;
 553 }
 554
 555 double surf_get_clock(void)
 556 {
 557   return NOW;
 558 }