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_resource_object {
 110   surf_resource_t resource;
 111 } s_surf_resource_object_t, *surf_resource_object_t;
 112
 113 static double NOW = 0;
 114
 115 xbt_dynar_t resource_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_resource_description_size = 3
 129 #ifdef HAVE_GTNETS
 130     + 1
 131 #endif
 132 #ifdef HAVE_SDP
 133     + 1
 134 #endif
 135     ;
 136 s_surf_resource_description_t surf_network_resource_description[] = {
 137   {"CM02", NULL, surf_network_resource_init_CM02},
 138 #ifdef HAVE_GTNETS
 139   {"GTNets", NULL, surf_network_resource_init_GTNETS},
 140 #endif
 141 #ifdef HAVE_SDP
 142   {"SDP", NULL, surf_network_resource_init_SDP},
 143 #endif
 144   {"Reno", NULL, surf_network_resource_init_Reno},
 145   {"Vegas", NULL, surf_network_resource_init_Vegas}
 146 };
 147
 148 int surf_cpu_resource_description_size = 1;
 149 s_surf_resource_description_t surf_cpu_resource_description[] = {
 150   {"Cas01", NULL, surf_cpu_resource_init_Cas01},
 151 };
 152
 153 int surf_workstation_resource_description_size = 4;
 154 s_surf_resource_description_t surf_workstation_resource_description[] = {
 155   {"CLM03", NULL, surf_workstation_resource_init_CLM03},
 156   {"KCCFLN05", NULL, surf_workstation_resource_init_KCCFLN05},
 157   {"compound", NULL, surf_workstation_resource_init_compound},
 158   {"ptask_L07", NULL, surf_workstation_resource_init_ptask_L07}
 159 };
 160
 161 void update_resource_description(s_surf_resource_description_t * table,
 162                                  int table_size,
 163                                  const char *name,
 164                                  surf_resource_t resource)
 165 {
 166   int i = find_resource_description(table, table_size, name);
 167   table[i].resource = resource;
 168 }
 169
 170 int find_resource_description(s_surf_resource_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     min = action->remains / value;
 223     if ((action->max_duration >= 0) && (action->max_duration < min))
 224       min = action->max_duration;
 225   } else
 226     min = action->max_duration;
 227
 228   DEBUG5("Found action (%p: duration = %f, remains = %f, value = %f) ! %f",
 229          action, action->max_duration, action->remains, value, min);
 230
 231   for (action = xbt_swag_getNext(action, running_actions->offset);
 232        action;
 233        action = xbt_swag_getNext(action, running_actions->offset)) {
 234     value = lmm_variable_getvalue(VARIABLE(action));
 235     if (value > 0) {
 236       value = action->remains / value;
 237       if (value < min) {
 238         min = value;
 239         DEBUG2("Updating min (value) with %p: %f", action, min);
 240       }
 241     }
 242     if ((action->max_duration >= 0) && (action->max_duration < min)) {
 243       min = action->max_duration;
 244       DEBUG2("Updating min (duration) with %p: %f", action, min);
 245     }
 246   }
 247   DEBUG1("min value : %f", min);
 248
 249 #undef VARIABLE
 250   return min;
 251 }
 252
 253 e_surf_action_state_t surf_action_get_state(surf_action_t action)
 254 {
 255   surf_action_state_t action_state =
 256       &(action->resource_type->common_public->states);
 257
 258   if (action->state_set == action_state->ready_action_set)
 259     return SURF_ACTION_READY;
 260   if (action->state_set == action_state->running_action_set)
 261     return SURF_ACTION_RUNNING;
 262   if (action->state_set == action_state->failed_action_set)
 263     return SURF_ACTION_FAILED;
 264   if (action->state_set == action_state->done_action_set)
 265     return SURF_ACTION_DONE;
 266   return SURF_ACTION_NOT_IN_THE_SYSTEM;
 267 }
 268
 269 double surf_action_get_start_time(surf_action_t action)
 270 {
 271   return action->start;
 272 }
 273
 274 double surf_action_get_finish_time(surf_action_t action)
 275 {
 276   return action->finish;
 277 }
 278
 279 void surf_action_free(surf_action_t * action)
 280 {
 281   (*action)->resource_type->common_public->action_cancel(*action);
 282   free(*action);
 283   *action = NULL;
 284 }
 285
 286 void surf_action_change_state(surf_action_t action,
 287                               e_surf_action_state_t state)
 288 {
 289   surf_action_state_t action_state =
 290       &(action->resource_type->common_public->states);
 291   XBT_IN2("(%p,%s)", action, surf_action_state_names[state]);
 292   xbt_swag_remove(action, action->state_set);
 293
 294   if (state == SURF_ACTION_READY)
 295     action->state_set = action_state->ready_action_set;
 296   else if (state == SURF_ACTION_RUNNING)
 297     action->state_set = action_state->running_action_set;
 298   else if (state == SURF_ACTION_FAILED)
 299     action->state_set = action_state->failed_action_set;
 300   else if (state == SURF_ACTION_DONE)
 301     action->state_set = action_state->done_action_set;
 302   else
 303     action->state_set = NULL;
 304
 305   if (action->state_set)
 306     xbt_swag_insert(action, action->state_set);
 307   XBT_OUT;
 308 }
 309
 310 void surf_action_set_data(surf_action_t action, void *data)
 311 {
 312   action->data = data;
 313 }
 314
 315 void surf_init(int *argc, char **argv)
 316 {
 317   int i, j;
 318   char *opt;
 319
 320   const char *initial_path;
 321
 322   xbt_init(argc, argv);
 323   if (!surf_path) {
 324
 325     /* retrieves the current directory of the current process */
 326     initial_path = __surf_get_initial_path();
 327
 328     xbt_assert0((initial_path),
 329                 "__surf_get_initial_path() failed! Can't resolves current Windows directory");
 330
 331     surf_path = xbt_dynar_new(sizeof(char *), NULL);
 332     xbt_dynar_push(surf_path, &initial_path);
 333
 334     for (i = 1; i < *argc; i++) {
 335       if (!strncmp(argv[i], "--surf-path=", strlen("--surf-path="))) {
 336         opt = strchr(argv[i], '=');
 337         opt++;
 338         xbt_dynar_push(surf_path, &opt);
 339         /*remove this from argv */
 340         for (j = i + 1; j < *argc; j++) {
 341           argv[j - 1] = argv[j];
 342         }
 343         argv[j - 1] = NULL;
 344         (*argc)--;
 345         i--;                    /* compensate effect of next loop incrementation */
 346       }
 347     }
 348   }
 349   if (!resource_list)
 350     resource_list = xbt_dynar_new(sizeof(surf_resource_private_t), NULL);
 351   if (!history)
 352     history = tmgr_history_new();
 353   if (!maxmin_system)
 354     maxmin_system = lmm_system_new();
 355 }
 356
 357 static char *path_name = NULL;
 358 FILE *surf_fopen(const char *name, const char *mode)
 359 {
 360   int i;
 361   char *path = NULL;
 362   FILE *file = NULL;
 363   int path_name_len = 0;        /* don't count '\0' */
 364
 365   xbt_assert0(name, "Need a non-NULL file name");
 366
 367   xbt_assert0(surf_path,
 368               "surf_init has to be called before using surf_fopen");
 369
 370   if (__surf_is_absolute_file_path(name)) {     /* don't mess with absolute file names */
 371     return fopen(name, mode);
 372
 373   } else {                      /* search relative files in the path */
 374
 375     if (!path_name) {
 376       path_name_len = strlen(name);
 377       path_name = xbt_new0(char, path_name_len + 1);
 378     }
 379
 380     xbt_dynar_foreach(surf_path, i, path) {
 381       if (path_name_len < strlen(path) + strlen(name) + 1) {
 382         path_name_len = strlen(path) + strlen(name) + 1;        /* plus '/' */
 383         path_name = xbt_realloc(path_name, path_name_len + 1);
 384       }
 385       sprintf(path_name, "%s/%s", path, name);
 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   int i;
 397   surf_resource_t resource = NULL;
 398
 399   xbt_dynar_foreach(resource_list, i, resource) {
 400     resource->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 (resource_list)
 412     xbt_dynar_free(&resource_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   xbt_exit();
 424 }
 425
 426 double surf_solve(void)
 427 {
 428   static int first_run = 1;
 429
 430   double min = -1.0;
 431   double next_event_date = -1.0;
 432   double resource_next_action_end = -1.0;
 433   double value = -1.0;
 434   surf_resource_object_t resource_obj = NULL;
 435   surf_resource_t resource = NULL;
 436   tmgr_trace_event_t event = NULL;
 437   int i;
 438
 439   if (first_run) {
 440     DEBUG0
 441         ("First Run! Let's \"purge\" events and put resources in the right state");
 442     while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
 443       if (next_event_date > NOW)
 444         break;
 445       while ((event =
 446               tmgr_history_get_next_event_leq(history, next_event_date,
 447                                               &value,
 448                                               (void **) &resource_obj))) {
 449         resource_obj->resource->common_private->
 450             update_resource_state(resource_obj, event, value);
 451       }
 452     }
 453     xbt_dynar_foreach(resource_list, i, resource) {
 454       resource->common_private->update_actions_state(NOW, 0.0);
 455     }
 456     first_run = 0;
 457     return 0.0;
 458   }
 459
 460   min = -1.0;
 461
 462   DEBUG0("Looking for next action end");
 463   xbt_dynar_foreach(resource_list, i, resource) {
 464     DEBUG1("Running for Resource [%s]", resource->common_public->name);
 465     resource_next_action_end =
 466         resource->common_private->share_resources(NOW);
 467     DEBUG2("Resource [%s] : next action end = %f",
 468            resource->common_public->name, resource_next_action_end);
 469     if (((min < 0.0) || (resource_next_action_end < min))
 470         && (resource_next_action_end >= 0.0))
 471       min = resource_next_action_end;
 472   }
 473   DEBUG1("Next action end : %f", min);
 474
 475   if (min < 0.0)
 476     return -1.0;
 477
 478   DEBUG0("Looking for next event");
 479   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
 480     DEBUG1("Next event : %f", next_event_date);
 481     if (next_event_date > NOW + min)
 482       break;
 483     DEBUG0("Updating resources");
 484     while ((event =
 485             tmgr_history_get_next_event_leq(history, next_event_date,
 486                                             &value,
 487                                             (void **) &resource_obj))) {
 488       if (resource_obj->resource->common_private->
 489           resource_used(resource_obj)) {
 490         min = next_event_date - NOW;
 491         DEBUG1
 492             ("This event will modify resource state. Next event set to %f",
 493              min);
 494       }
 495       /* update state of resource_obj according to new value. Does not touch lmm.
 496          It will be modified if needed when updating actions */
 497       resource_obj->resource->common_private->
 498           update_resource_state(resource_obj, event, value);
 499     }
 500   }
 501
 502   DEBUG1("Duration set to %f", min);
 503
 504   NOW = NOW + min;
 505
 506   xbt_dynar_foreach(resource_list, i, resource) {
 507     resource->common_private->update_actions_state(NOW, min);
 508   }
 509
 510   return min;
 511 }
 512
 513 double surf_get_clock(void)
 514 {
 515   return NOW;
 516 }