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