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