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 int surf_network_model_description_size = 3
 129 #ifdef HAVE_GTNETS
 130     + 1
 131 #endif
 132 #ifdef HAVE_SDP
 133     + 1
 134 #endif
 135     ;
 136 s_surf_model_description_t surf_network_model_description[] = {
 137   {"CM02", NULL, surf_network_model_init_CM02},
 138 #ifdef HAVE_GTNETS
 139   {"GTNets", NULL, surf_network_model_init_GTNETS},
 140 #endif
 141 #ifdef HAVE_SDP
 142   {"SDP", NULL, surf_network_model_init_SDP},
 143 #endif
 144   {"Reno", NULL, surf_network_model_init_Reno},
 145   {"Vegas", NULL, surf_network_model_init_Vegas}
 146 };
 147
 148 int surf_cpu_model_description_size = 1;
 149 s_surf_model_description_t surf_cpu_model_description[] = {
 150   {"Cas01", NULL, surf_cpu_model_init_Cas01},
 151 };
 152
 153 int surf_workstation_model_description_size = 4;
 154 s_surf_model_description_t surf_workstation_model_description[] = {
 155   {"CLM03", NULL, surf_workstation_model_init_CLM03, create_workstations},
 156   {"compound", NULL, surf_workstation_model_init_compound, NULL},
 157   {"ptask_L07", NULL, surf_workstation_model_init_ptask_L07, NULL}
 158 };
 159
 160 void update_model_description(s_surf_model_description_t * table,
 161                                  int table_size,
 162                                  const char *name,
 163                                  surf_model_t model)
 164 {
 165   int i = find_model_description(table, table_size, name);
 166   table[i].model = model;
 167 }
 168
 169 int find_model_description(s_surf_model_description_t * table,
 170                               int table_size, const char *name)
 171 {
 172   int i;
 173   char *name_list = NULL;
 174
 175   for (i = 0; i < table_size; i++)
 176     if (!strcmp(name, table[i].name)) {
 177       return i;
 178     }
 179   name_list = strdup(table[0].name);
 180   for (i = 1; i < table_size; i++) {
 181     name_list =
 182         xbt_realloc(name_list,
 183                     strlen(name_list) + strlen(table[i].name) + 2);
 184     strcat(name_list, ", ");
 185     strcat(name_list, table[i].name);
 186   }
 187   xbt_assert2(0, "Model '%s' is invalid! Valid models are: %s.", name,
 188               name_list);
 189 }
 190
 191 double generic_maxmin_share_resources(xbt_swag_t running_actions,
 192                                       size_t offset,
 193                                       lmm_system_t sys,
 194                                       void (*solve) (lmm_system_t))
 195 {
 196   surf_action_t action = NULL;
 197   double min = -1;
 198   double value = -1;
 199 #define VARIABLE(action) (*((lmm_variable_t*)(((char *) (action)) + (offset))))
 200
 201   xbt_assert0(solve, "Give me a real solver function!");
 202   solve(sys);
 203
 204   xbt_swag_foreach(action, running_actions) {
 205     value = lmm_variable_getvalue(VARIABLE(action));
 206     if ((value > 0) || (action->max_duration >= 0))
 207       break;
 208   }
 209
 210   if (!action)
 211     return -1.0;
 212
 213   if (value > 0) {
 214     if(action->remains>0)
 215       min = action->remains / value;
 216     else
 217       min = 0.0;
 218     if ((action->max_duration >= 0) && (action->max_duration < min))
 219       min = action->max_duration;
 220   } else
 221     min = action->max_duration;
 222
 223   DEBUG5("Found action (%p: duration = %f, remains = %f, value = %f) ! %f",
 224          action, action->max_duration, action->remains, value, min);
 225
 226   for (action = xbt_swag_getNext(action, running_actions->offset);
 227        action;
 228        action = xbt_swag_getNext(action, running_actions->offset)) {
 229     value = lmm_variable_getvalue(VARIABLE(action));
 230     if (value > 0) {
 231       if(action->remains>0)
 232         value = action->remains / value;
 233       else
 234         value = 0.0;
 235       if (value < min) {
 236         min = value;
 237         DEBUG2("Updating min (value) with %p: %f", action, min);
 238       }
 239     }
 240     if ((action->max_duration >= 0) && (action->max_duration < min)) {
 241       min = action->max_duration;
 242       DEBUG2("Updating min (duration) with %p: %f", action, min);
 243     }
 244   }
 245   DEBUG1("min value : %f", min);
 246
 247 #undef VARIABLE
 248   return min;
 249 }
 250
 251 e_surf_action_state_t surf_action_get_state(surf_action_t action)
 252 {
 253   surf_action_state_t action_state =
 254       &(action->model_type->common_public->states);
 255
 256   if (action->state_set == action_state->ready_action_set)
 257     return SURF_ACTION_READY;
 258   if (action->state_set == action_state->running_action_set)
 259     return SURF_ACTION_RUNNING;
 260   if (action->state_set == action_state->failed_action_set)
 261     return SURF_ACTION_FAILED;
 262   if (action->state_set == action_state->done_action_set)
 263     return SURF_ACTION_DONE;
 264   return SURF_ACTION_NOT_IN_THE_SYSTEM;
 265 }
 266
 267 double surf_action_get_start_time(surf_action_t action)
 268 {
 269   return action->start;
 270 }
 271
 272 double surf_action_get_finish_time(surf_action_t action)
 273 {
 274   return action->finish;
 275 }
 276
 277 void surf_action_free(surf_action_t * action)
 278 {
 279   (*action)->model_type->common_public->action_cancel(*action);
 280   free(*action);
 281   *action = NULL;
 282 }
 283
 284 void surf_action_change_state(surf_action_t action,
 285                               e_surf_action_state_t state)
 286 {
 287   surf_action_state_t action_state =
 288       &(action->model_type->common_public->states);
 289   XBT_IN2("(%p,%s)", action, surf_action_state_names[state]);
 290   xbt_swag_remove(action, action->state_set);
 291
 292   if (state == SURF_ACTION_READY)
 293     action->state_set = action_state->ready_action_set;
 294   else if (state == SURF_ACTION_RUNNING)
 295     action->state_set = action_state->running_action_set;
 296   else if (state == SURF_ACTION_FAILED)
 297     action->state_set = action_state->failed_action_set;
 298   else if (state == SURF_ACTION_DONE)
 299     action->state_set = action_state->done_action_set;
 300   else
 301     action->state_set = NULL;
 302
 303   if (action->state_set)
 304     xbt_swag_insert(action, action->state_set);
 305   XBT_OUT;
 306 }
 307
 308 void surf_action_set_data(surf_action_t action, void *data)
 309 {
 310   action->data = data;
 311 }
 312
 313 void surf_init(int *argc, char **argv)
 314 {
 315   int i, j;
 316   char *opt;
 317
 318   const char *initial_path;
 319
 320   xbt_init(argc, argv);
 321   if (!surf_path) {
 322
 323     /* retrieves the current directory of the current process */
 324     initial_path = __surf_get_initial_path();
 325
 326     xbt_assert0((initial_path),
 327                 "__surf_get_initial_path() failed! Can't resolves current Windows directory");
 328
 329     surf_path = xbt_dynar_new(sizeof(char *), NULL);
 330     xbt_dynar_push(surf_path, &initial_path);
 331
 332     for (i = 1; i < *argc; i++) {
 333       if (!strncmp(argv[i], "--surf-path=", strlen("--surf-path="))) {
 334         opt = strchr(argv[i], '=');
 335         opt++;
 336         xbt_dynar_push(surf_path, &opt);
 337         /*remove this from argv */
 338         for (j = i + 1; j < *argc; j++) {
 339           argv[j - 1] = argv[j];
 340         }
 341         argv[j - 1] = NULL;
 342         (*argc)--;
 343         i--;                    /* compensate effect of next loop incrementation */
 344       }
 345     }
 346   }
 347   if (!model_list)
 348     model_list = xbt_dynar_new(sizeof(surf_model_private_t), NULL);
 349   if (!history)
 350     history = tmgr_history_new();
 351 }
 352
 353 static char *path_name = NULL;
 354 FILE *surf_fopen(const char *name, const char *mode)
 355 {
 356   unsigned int iter;
 357   char *path = NULL;
 358   FILE *file = NULL;
 359   unsigned int path_name_len = 0;       /* don't count '\0' */
 360
 361   xbt_assert0(name, "Need a non-NULL file name");
 362
 363   xbt_assert0(surf_path,
 364               "surf_init has to be called before using surf_fopen");
 365
 366   if (__surf_is_absolute_file_path(name)) {     /* don't mess with absolute file names */
 367     return fopen(name, mode);
 368
 369   } else {                      /* search relative files in the path */
 370
 371     if (!path_name) {
 372       path_name_len = strlen(name);
 373       path_name = xbt_new0(char, path_name_len + 1);
 374     }
 375
 376     xbt_dynar_foreach(surf_path, iter, path) {
 377       if (path_name_len < strlen(path) + strlen(name) + 1) {
 378         path_name_len = strlen(path) + strlen(name) + 1;        /* plus '/' */
 379         path_name = xbt_realloc(path_name, path_name_len + 1);
 380       }
 381       #ifdef WIN32
 382       sprintf(path_name, "%s\\%s", path, name);
 383       #else
 384       sprintf(path_name, "%s/%s", path, name);
 385       #endif
 386       file = fopen(path_name, mode);
 387       if (file)
 388         return file;
 389     }
 390   }
 391   return file;
 392 }
 393
 394 void surf_exit(void)
 395 {
 396   unsigned int iter;
 397   surf_model_t model = NULL;
 398
 399   xbt_dynar_foreach(model_list, iter, model) {
 400     model->common_private->finalize();
 401   }
 402
 403   if (maxmin_system) {
 404     lmm_system_free(maxmin_system);
 405     maxmin_system = NULL;
 406   }
 407   if (history) {
 408     tmgr_history_free(history);
 409     history = NULL;
 410   }
 411   if (model_list)
 412     xbt_dynar_free(&model_list);
 413
 414   if (surf_path)
 415     xbt_dynar_free(&surf_path);
 416
 417   tmgr_finalize();
 418   surf_parse_lex_destroy();
 419   if (path_name) {
 420     free(path_name);
 421     path_name = NULL;
 422   }
 423   surf_parse_free_callbacks();
 424   xbt_dict_free(&route_table);
 425   NOW=0; /* Just in case the user plans to restart the simulation afterward */
 426   xbt_exit();
 427 }
 428
 429 double surf_solve(void)
 430 {
 431   static int first_run = 1;
 432
 433   double min = -1.0;
 434   double next_event_date = -1.0;
 435   double model_next_action_end = -1.0;
 436   double value = -1.0;
 437   surf_model_object_t model_obj = NULL;
 438   surf_model_t model = NULL;
 439   tmgr_trace_event_t event = NULL;
 440   unsigned int iter;
 441
 442   if (first_run) {
 443     DEBUG0
 444         ("First Run! Let's \"purge\" events and put models in the right state");
 445     while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
 446       if (next_event_date > NOW)
 447         break;
 448       while ((event =
 449               tmgr_history_get_next_event_leq(history, next_event_date,
 450                                               &value,
 451                                               (void **) &model_obj))) {
 452         model_obj->model->common_private->
 453             update_resource_state(model_obj, event, value);
 454       }
 455     }
 456     xbt_dynar_foreach(model_list, iter, model) {
 457       model->common_private->update_actions_state(NOW, 0.0);
 458     }
 459     first_run = 0;
 460     return 0.0;
 461   }
 462
 463   min = -1.0;
 464
 465   DEBUG0("Looking for next action end");
 466   xbt_dynar_foreach(model_list, iter, model) {
 467     DEBUG1("Running for Resource [%s]", model->common_public->name);
 468     model_next_action_end =
 469         model->common_private->share_resources(NOW);
 470     DEBUG2("Resource [%s] : next action end = %f",
 471            model->common_public->name, model_next_action_end);
 472     if (((min < 0.0) || (model_next_action_end < min))
 473         && (model_next_action_end >= 0.0))
 474       min = model_next_action_end;
 475   }
 476   DEBUG1("Next action end : %f", min);
 477
 478   if (min < 0.0)
 479     return -1.0;
 480
 481   DEBUG0("Looking for next event");
 482   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
 483     DEBUG1("Next event : %f", next_event_date);
 484     if (next_event_date > NOW + min)
 485       break;
 486     DEBUG0("Updating models");
 487     while ((event =
 488             tmgr_history_get_next_event_leq(history, next_event_date,
 489                                             &value,
 490                                             (void **) &model_obj))) {
 491       if (model_obj->model->common_private->
 492           resource_used(model_obj)) {
 493         min = next_event_date - NOW;
 494         DEBUG1
 495             ("This event will modify model state. Next event set to %f",
 496              min);
 497       }
 498       /* update state of model_obj according to new value. Does not touch lmm.
 499          It will be modified if needed when updating actions */
 500       model_obj->model->common_private->
 501           update_resource_state(model_obj, event, value);
 502     }
 503   }
 504
 505   DEBUG1("Duration set to %f", min);
 506
 507   NOW = NOW + min;
 508
 509   xbt_dynar_foreach(model_list, iter, model) {
 510     model->common_private->update_actions_state(NOW, min);
 511   }
 512
 513   return min;
 514 }
 515
 516 double surf_get_clock(void)
 517 {
 518   return NOW;
 519 }