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