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