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