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