Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
try a bit harder to get the simulated time without any function call
[simgrid.git] / src / surf / surf.c
index a4e1d75..a37608e 100644 (file)
@@ -1,6 +1,5 @@
-/*     $Id$     */
-
-/* Copyright (c) 2004 Arnaud Legrand. All rights reserved.                  */
+/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
+ * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -9,20 +8,18 @@
 
 #include "surf_private.h"
 #include "xbt/module.h"
+#include "mc/mc.h"
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf,
                                 "Logging specific to SURF (kernel)");
 
-int use_sdp_solver = 0;
-int use_lagrange_solver = 0;
-
 /* Additional declarations for Windows potability. */
 
 #ifndef MAX_DRIVE
 #define MAX_DRIVE 26
 #endif
 
-#ifdef _WIN32
+#ifdef _XBT_WIN32
 #include <windows.h>
 static const char *disk_drives_letter_table[MAX_DRIVE] = {
   "A:\\",
@@ -52,7 +49,7 @@ static const char *disk_drives_letter_table[MAX_DRIVE] = {
   "Y:\\",
   "Z:\\"
 };
-#endif /* #ifdef _WIN32 */
+#endif                          /* #ifdef _XBT_WIN32 */
 
 /*
  * Returns the initial path. On Windows the initial path is
@@ -64,7 +61,7 @@ static const char *disk_drives_letter_table[MAX_DRIVE] = {
 const char *__surf_get_initial_path(void)
 {
 
-#ifdef _WIN32
+#ifdef _XBT_WIN32
   unsigned i;
   char current_directory[MAX_PATH + 1] = { 0 };
   unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
@@ -92,7 +89,7 @@ const char *__surf_get_initial_path(void)
  */
 int __surf_is_absolute_file_path(const char *file_path)
 {
-#ifdef _WIN32
+#ifdef _XBT_WIN32
   WIN32_FIND_DATA wfd = { 0 };
   HANDLE hFile = FindFirstFile(file_path, &wfd);
 
@@ -106,53 +103,66 @@ int __surf_is_absolute_file_path(const char *file_path)
 #endif
 }
 
-typedef struct surf_model_object {
-  surf_model_t model;
-} s_surf_model_object_t, *surf_model_object_t;
-
-static double NOW = 0;
+double NOW = 0;
 
 xbt_dynar_t model_list = NULL;
 tmgr_history_t history = NULL;
 lmm_system_t maxmin_system = NULL;
 xbt_dynar_t surf_path = NULL;
-const char *surf_action_state_names[6] = {
-  "SURF_ACTION_READY",
-  "SURF_ACTION_RUNNING",
-  "SURF_ACTION_FAILED",
-  "SURF_ACTION_DONE",
-  "SURF_ACTION_TO_FREE",
-  "SURF_ACTION_NOT_IN_THE_SYSTEM"
-};
 
 /* Don't forget to update the option description in smx_config when you change this */
 s_surf_model_description_t surf_network_model_description[] = {
-  {"Constant", NULL, surf_network_model_init_Constant},
-  {"CM02", NULL, surf_network_model_init_CM02},
-  {"LegrandVelho", NULL, surf_network_model_init_LegrandVelho},
+  {"Constant",
+   "Simplistic network model where all communication take a constant time (one second)",
+   NULL, surf_network_model_init_Constant},
+  {"CM02",
+   "Realistic network model with lmm_solve and no correction factors",
+   NULL, surf_network_model_init_CM02},
+  {"LV08",
+   "Realistic network model with lmm_solve and these correction factors: latency*=10.4, bandwidth*=.92, S=8775",
+   NULL, surf_network_model_init_LegrandVelho},
+  {"SMPI",
+   "Realistic network model with lmm_solve and correction factors on three intervals (< 1KiB, < 64 KiB, >= 64 KiB)",
+   NULL, surf_network_model_init_SMPI},
 #ifdef HAVE_GTNETS
-  {"GTNets", NULL, surf_network_model_init_GTNETS},
+  {"GTNets",
+   "Network Pseudo-model using the GTNets simulator instead of an analytic model",
+   NULL, surf_network_model_init_GTNETS},
 #endif
-#ifdef HAVE_SDP
-  {"SDP", NULL, surf_network_model_init_SDP},
-#endif
-  {"Reno", NULL, surf_network_model_init_Reno},
-  {"Reno2", NULL, surf_network_model_init_Reno2},
-  {"Vegas", NULL, surf_network_model_init_Vegas},
-  {NULL, NULL, NULL}            /* this array must be NULL terminated */
+  {"Reno",
+   "Model using lagrange_solve instead of lmm_solve (experts only)", NULL,
+   surf_network_model_init_Reno},
+  {"Reno2",
+   "Model using lagrange_solve instead of lmm_solve (experts only)", NULL,
+   surf_network_model_init_Reno2},
+  {"Vegas",
+   "Model using lagrange_solve instead of lmm_solve (experts only)", NULL,
+   surf_network_model_init_Vegas},
+  {NULL, NULL, NULL, NULL}      /* this array must be NULL terminated */
 };
 
 s_surf_model_description_t surf_cpu_model_description[] = {
-  {"Cas01", NULL, surf_cpu_model_init_Cas01},
-  {NULL, NULL, NULL}            /* this array must be NULL terminated */
+  {"Cas01_fullupdate", "CPU classical model time=size/power", NULL,
+   surf_cpu_model_init_Cas01},
+  {"Cas01",
+   "Variation of Cas01_fullupdate with partial invalidation optimization of lmm system. Should produce the same values, only faster",
+   NULL, surf_cpu_model_init_Cas01_im},
+  {"CpuTI",
+   "Variation of Cas01 with also trace integration. Should produce the same values, only faster if you use availability traces",
+   NULL, surf_cpu_model_init_ti},
+  {NULL, NULL, NULL, NULL}      /* this array must be NULL terminated */
 };
 
 s_surf_model_description_t surf_workstation_model_description[] = {
-  {"CLM03", NULL, surf_workstation_model_init_CLM03, create_workstations},
-  {"compound", NULL, surf_workstation_model_init_compound,
-   create_workstations},
-  {"ptask_L07", NULL, surf_workstation_model_init_ptask_L07, NULL},
-  {NULL, NULL, NULL}            /* this array must be NULL terminated */
+  {"CLM03",
+   "Default workstation model, using LV08 and CM02 as network and CPU",
+   NULL, surf_workstation_model_init_CLM03, create_workstations},
+  {"compound",
+   "Workstation model allowing you to use other network and CPU models",
+   NULL, surf_workstation_model_init_compound, create_workstations},
+  {"ptask_L07", "Workstation model with better parallel task modeling",
+   NULL, surf_workstation_model_init_ptask_L07, NULL},
+  {NULL, NULL, NULL, NULL}      /* this array must be NULL terminated */
 };
 
 void update_model_description(s_surf_model_description_t * table,
@@ -162,6 +172,16 @@ void update_model_description(s_surf_model_description_t * table,
   table[i].model = model;
 }
 
+/** Displays the long description of all registered models, and quit */
+void model_help(const char *category, s_surf_model_description_t * table)
+{
+  int i;
+  printf("Long description of the %s models accepted by this simulator:\n",
+         category);
+  for (i = 0; table[i].name; i++)
+    printf("  %s: %s\n", table[i].name, table[i].description);
+}
+
 int find_model_description(s_surf_model_description_t * table,
                            const char *name)
 {
@@ -175,7 +195,8 @@ int find_model_description(s_surf_model_description_t * table,
   name_list = strdup(table[0].name);
   for (i = 1; table[i].name; i++) {
     name_list =
-      xbt_realloc(name_list, strlen(name_list) + strlen(table[i].name) + 2);
+        xbt_realloc(name_list,
+                    strlen(name_list) + strlen(table[i].name) + 2);
     strcat(name_list, ", ");
     strcat(name_list, table[i].name);
   }
@@ -217,7 +238,8 @@ double generic_maxmin_share_resources(xbt_swag_t running_actions,
 
 
   for (action = xbt_swag_getNext(action, running_actions->offset);
-       action; action = xbt_swag_getNext(action, running_actions->offset)) {
+       action;
+       action = xbt_swag_getNext(action, running_actions->offset)) {
     value = lmm_variable_getvalue(VARIABLE(action));
     if (value > 0) {
       if (action->remains > 0)
@@ -240,84 +262,19 @@ double generic_maxmin_share_resources(xbt_swag_t running_actions,
   return min;
 }
 
-e_surf_action_state_t surf_action_get_state(surf_action_t action)
-{
-  surf_action_state_t action_state =
-    &(action->model_type->common_public->states);
-
-  if (action->state_set == action_state->ready_action_set)
-    return SURF_ACTION_READY;
-  if (action->state_set == action_state->running_action_set)
-    return SURF_ACTION_RUNNING;
-  if (action->state_set == action_state->failed_action_set)
-    return SURF_ACTION_FAILED;
-  if (action->state_set == action_state->done_action_set)
-    return SURF_ACTION_DONE;
-  return SURF_ACTION_NOT_IN_THE_SYSTEM;
-}
-
-double surf_action_get_start_time(surf_action_t action)
-{
-  return action->start;
-}
-
-double surf_action_get_finish_time(surf_action_t action)
-{
-  return action->finish;
-}
-
-void surf_action_free(surf_action_t * action)
-{
-  (*action)->model_type->common_public->action_cancel(*action);
-  free(*action);
-  *action = NULL;
-}
-
-void surf_action_change_state(surf_action_t action,
-                              e_surf_action_state_t state)
-{
-  surf_action_state_t action_state =
-    &(action->model_type->common_public->states);
-  XBT_IN2("(%p,%s)", action, surf_action_state_names[state]);
-  xbt_swag_remove(action, action->state_set);
-
-  if (state == SURF_ACTION_READY)
-    action->state_set = action_state->ready_action_set;
-  else if (state == SURF_ACTION_RUNNING)
-    action->state_set = action_state->running_action_set;
-  else if (state == SURF_ACTION_FAILED)
-    action->state_set = action_state->failed_action_set;
-  else if (state == SURF_ACTION_DONE)
-    action->state_set = action_state->done_action_set;
-  else
-    action->state_set = NULL;
-
-  if (action->state_set)
-    xbt_swag_insert(action, action->state_set);
-  XBT_OUT;
-}
-
-void surf_action_set_data(surf_action_t action, void *data)
-{
-  action->data = data;
-}
-
 XBT_LOG_EXTERNAL_CATEGORY(surf_cpu);
 XBT_LOG_EXTERNAL_CATEGORY(surf_kernel);
 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange);
 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange_dichotomy);
 XBT_LOG_EXTERNAL_CATEGORY(surf_maxmin);
 XBT_LOG_EXTERNAL_CATEGORY(surf_network);
+XBT_LOG_EXTERNAL_CATEGORY(surf_trace);
 XBT_LOG_EXTERNAL_CATEGORY(surf_parse);
 XBT_LOG_EXTERNAL_CATEGORY(surf_timer);
 XBT_LOG_EXTERNAL_CATEGORY(surf_workstation);
 XBT_LOG_EXTERNAL_CATEGORY(surf_config);
+XBT_LOG_EXTERNAL_CATEGORY(surf_route);
 
-
-#ifdef HAVE_SDP
-XBT_LOG_EXTERNAL_CATEGORY(surf_sdp_out);
-XBT_LOG_EXTERNAL_CATEGORY(surf_sdp);
-#endif
 #ifdef HAVE_GTNETS
 XBT_LOG_EXTERNAL_CATEGORY(surf_network_gtnets);
 #endif
@@ -331,15 +288,13 @@ void surf_init(int *argc, char **argv)
   XBT_LOG_CONNECT(surf_lagrange_dichotomy, surf_lagrange);
   XBT_LOG_CONNECT(surf_maxmin, surf);
   XBT_LOG_CONNECT(surf_network, surf);
+  XBT_LOG_CONNECT(surf_trace, surf);
   XBT_LOG_CONNECT(surf_parse, surf);
   XBT_LOG_CONNECT(surf_timer, surf);
   XBT_LOG_CONNECT(surf_workstation, surf);
   XBT_LOG_CONNECT(surf_config, surf);
+  XBT_LOG_CONNECT(surf_route, surf);
 
-#ifdef HAVE_SDP
-  XBT_LOG_CONNECT(surf_sdp_out, surf);
-  XBT_LOG_CONNECT(surf_sdp, surf);
-#endif
 #ifdef HAVE_GTNETS
   XBT_LOG_CONNECT(surf_network_gtnets, surf);
 #endif
@@ -350,48 +305,39 @@ void surf_init(int *argc, char **argv)
   if (!history)
     history = tmgr_history_new();
 
-  surf_config_init(argc,argv);
+  surf_config_init(argc, argv);
+  if (MC_IS_ENABLED)
+    MC_memory_init();
 }
 
-static char *path_name = NULL;
+#ifdef _XBT_WIN32
+# define FILE_DELIM "\\"
+#else
+# define FILE_DELIM "/"         /* FIXME: move to better location */
+#endif
+
 FILE *surf_fopen(const char *name, const char *mode)
 {
-  unsigned int iter;
-  char *path = NULL;
+  unsigned int cpt;
+  char *path_elm = NULL;
+  char *buff;
   FILE *file = NULL;
-  unsigned int path_name_len = 0;       /* don't count '\0' */
 
-  xbt_assert0(name, "Need a non-NULL file name");
+  xbt_assert(name);
 
-  xbt_assert0(surf_path,
-              "surf_init has to be called before using surf_fopen");
-
-  if (__surf_is_absolute_file_path(name)) {     /* don't mess with absolute file names */
+  if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
     return fopen(name, mode);
 
-  } else {                      /* search relative files in the path */
+  /* search relative files in the path */
+  xbt_dynar_foreach(surf_path, cpt, path_elm) {
+    buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
+    file = fopen(buff, mode);
+    free(buff);
 
-    if (!path_name) {
-      path_name_len = strlen(name);
-      path_name = xbt_new0(char, path_name_len + 1);
-    }
-
-    xbt_dynar_foreach(surf_path, iter, path) {
-      if (path_name_len < strlen(path) + strlen(name) + 1) {
-        path_name_len = strlen(path) + strlen(name) + 1;        /* plus '/' */
-        path_name = xbt_realloc(path_name, path_name_len + 1);
-      }
-#ifdef WIN32
-      sprintf(path_name, "%s\\%s", path, name);
-#else
-      sprintf(path_name, "%s/%s", path, name);
-#endif
-      file = fopen(path_name, mode);
-      if (file)
-        return file;
-    }
+    if (file)
+      return file;
   }
-  return file;
+  return NULL;
 }
 
 void surf_exit(void)
@@ -401,9 +347,9 @@ void surf_exit(void)
 
   surf_config_finalize();
 
-  xbt_dynar_foreach(model_list, iter, model) {
-    model->common_private->finalize();
-  }
+  xbt_dynar_foreach(model_list, iter, model)
+      model->model_private->finalize();
+  xbt_dynar_free(&model_list);
 
   if (maxmin_system) {
     lmm_system_free(maxmin_system);
@@ -413,22 +359,14 @@ void surf_exit(void)
     tmgr_history_free(history);
     history = NULL;
   }
-  if (model_list)
-    xbt_dynar_free(&model_list);
 
   if (surf_path)
     xbt_dynar_free(&surf_path);
 
   tmgr_finalize();
   surf_parse_lex_destroy();
-  if (path_name) {
-    free(path_name);
-    path_name = NULL;
-  }
   surf_parse_free_callbacks();
-  xbt_dict_free(&route_table);
   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
-  xbt_exit();
 }
 
 void surf_presolve(void)
@@ -436,90 +374,99 @@ void surf_presolve(void)
   double next_event_date = -1.0;
   tmgr_trace_event_t event = NULL;
   double value = -1.0;
-  surf_model_object_t model_obj = NULL;
+  surf_resource_t resource = NULL;
   surf_model_t model = NULL;
   unsigned int iter;
 
   DEBUG0
-    ("First Run! Let's \"purge\" events and put models in the right state");
+      ("First Run! Let's \"purge\" events and put models in the right state");
   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
     if (next_event_date > NOW)
       break;
     while ((event =
             tmgr_history_get_next_event_leq(history, next_event_date,
-                                            &value, (void **) &model_obj))) {
-      model_obj->model->common_private->update_resource_state(model_obj,
-                                                              event, value,
-                                                              NOW);
+                                            &value,
+                                            (void **) &resource))) {
+      resource->model->model_private->update_resource_state(resource,
+                                                            event, value,
+                                                            NOW);
     }
   }
-  xbt_dynar_foreach(model_list, iter, model) {
-    model->common_private->update_actions_state(NOW, 0.0);
-  }
+  xbt_dynar_foreach(model_list, iter, model)
+      model->model_private->update_actions_state(NOW, 0.0);
 }
 
-double surf_solve(void)
+double surf_solve(double max_date)
 {
-  double min = -1.0;
+  double min = -1.0; /* duration */
   double next_event_date = -1.0;
   double model_next_action_end = -1.0;
   double value = -1.0;
-  surf_model_object_t model_obj = NULL;
+  surf_resource_t resource = NULL;
   surf_model_t model = NULL;
   tmgr_trace_event_t event = NULL;
   unsigned int iter;
 
-  min = -1.0;
+  if (max_date != -1.0 && max_date != NOW) {
+    min = max_date - NOW;
+  }
 
   DEBUG0("Looking for next action end");
   xbt_dynar_foreach(model_list, iter, model) {
-    DEBUG1("Running for Resource [%s]", model->common_public->name);
-    model_next_action_end = model->common_private->share_resources(NOW);
+    DEBUG1("Running for Resource [%s]", model->name);
+    model_next_action_end = model->model_private->share_resources(NOW);
     DEBUG2("Resource [%s] : next action end = %f",
-           model->common_public->name, model_next_action_end);
+           model->name, model_next_action_end);
     if (((min < 0.0) || (model_next_action_end < min))
         && (model_next_action_end >= 0.0))
       min = model_next_action_end;
   }
   DEBUG1("Next action end : %f", min);
 
-  if (min < 0.0)
-    return -1.0;
-
   DEBUG0("Looking for next event");
   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
-    DEBUG1("Next event : %f", next_event_date);
-    if (next_event_date > NOW + min)
+    DEBUG1("Next TRACE event : %f", next_event_date);
+    if ((min != -1.0) && (next_event_date > NOW + min))
       break;
     DEBUG0("Updating models");
     while ((event =
             tmgr_history_get_next_event_leq(history, next_event_date,
-                                            &value, (void **) &model_obj))) {
-      if (model_obj->model->common_private->resource_used(model_obj)) {
+                                            &value,
+                                            (void **) &resource))) {
+      if (resource->model->model_private->resource_used(resource)) {
         min = next_event_date - NOW;
         DEBUG1
-          ("This event will modify model state. Next event set to %f", min);
+            ("This event will modify model state. Next event set to %f",
+             min);
       }
       /* update state of model_obj according to new value. Does not touch lmm.
          It will be modified if needed when updating actions */
-      model_obj->model->common_private->update_resource_state(model_obj,
-                                                              event, value,
-                                                              NOW + min);
+      DEBUG2("Calling update_resource_state for resource %s with min %lf",
+             resource->model->name, min);
+      resource->model->model_private->update_resource_state(resource,
+                                                            event, value,
+                                                            NOW + min);
     }
   }
 
+
+  /* FIXME: Moved this test to here to avoid stoping simulation if there are actions running on cpus and all cpus are with availability = 0. 
+   * This may cause an infinite loop if one cpu has a trace with periodicity = 0 and the other a trace with periodicity > 0.
+   * The options are: all traces with same periodicity(0 or >0) or we need to change the way how the events are managed */
+  if (min < 0.0)
+    return -1.0;
+
   DEBUG1("Duration set to %f", min);
 
   NOW = NOW + min;
 
-  xbt_dynar_foreach(model_list, iter, model) {
-    model->common_private->update_actions_state(NOW, min);
-  }
+  xbt_dynar_foreach(model_list, iter, model)
+      model->model_private->update_actions_state(NOW, min);
 
   return min;
 }
 
-double surf_get_clock(void)
+XBT_INLINE double surf_get_clock(void)
 {
   return NOW;
 }