Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
split raw parsing functions from platform parsing, which is somehow similar to the...
[simgrid.git] / src / surf / surfxml_parse.c
index e6732d8..6337923 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
+/* Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
 #include "surf/surfxml_parse_private.h"
 #include "surf/surf_private.h"
 
-host_t struct_host;
-router_t struct_router;
-cluster_t struct_cluster;
-peer_t struct_peer;
-link_t struct_lnk;
-
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_parse, surf,
                                 "Logging specific to the SURF parsing module");
 #undef CLEANUP
@@ -24,48 +18,32 @@ int ETag_surfxml_include_state(void);
 
 #include "simgrid_dtd.c"
 
-char *platform_filename;
-
-/* Initialize the parsing globals */
-xbt_dict_t traces_set_list = NULL;
-xbt_dict_t trace_connect_list_host_avail = NULL;
-xbt_dict_t trace_connect_list_power = NULL;
-xbt_dict_t trace_connect_list_link_avail = NULL;
-xbt_dict_t trace_connect_list_bandwidth = NULL;
-xbt_dict_t trace_connect_list_latency = NULL;
-
-/* This buffer is used to store the original buffer before substituting it by out own buffer. Useful for the foreach tag */
-static xbt_dynar_t surfxml_bufferstack_stack = NULL;
-int surfxml_bufferstack_size = 2048;
-
-static char *old_buff = NULL;
-static void surf_parse_error(char *msg);
-
-unsigned int surfxml_buffer_stack_stack_ptr;
-unsigned int surfxml_buffer_stack_stack[1024];
-
+/*
+ * Helping functions
+ */
+static void surf_parse_error(char *msg) {
+  xbt_die("Parse error on line %d: %s\n", surf_parse_lineno, msg);
+}
 
-void surfxml_bufferstack_push(int new)
-{
-  if (!new)
-    old_buff = surfxml_bufferstack;
-  else {
-    xbt_dynar_push(surfxml_bufferstack_stack, &surfxml_bufferstack);
-    surfxml_bufferstack = xbt_new0(char, surfxml_bufferstack_size);
-  }
+void surf_parse_get_double(double *value, const char *string) {
+  int ret = sscanf(string, "%lg", value);
+  if (ret != 1)
+    surf_parse_error(bprintf("%s is not a double", string));
 }
 
-void surfxml_bufferstack_pop(int new)
-{
-  if (!new)
-    surfxml_bufferstack = old_buff;
-  else {
-    free(surfxml_bufferstack);
-    xbt_dynar_pop(surfxml_bufferstack_stack, &surfxml_bufferstack);
-  }
+void surf_parse_get_int(int *value, const char *string) {
+  int ret = sscanf(string, "%d", value);
+  if (ret != 1)
+    surf_parse_error(bprintf("%s is not an integer", string));
 }
 
-/* make sure these symbols are defined as strong ones in this file so that the linked can resolve them */
+
+/*
+ * All the callback lists that can be overiden anywhere.
+ * (this list should probably be reduced to the bare minimum to allow the models to work)
+ */
+
+/* make sure these symbols are defined as strong ones in this file so that the linker can resolve them */
 xbt_dynar_t STag_surfxml_platform_cb_list = NULL;
 xbt_dynar_t ETag_surfxml_platform_cb_list = NULL;
 xbt_dynar_t STag_surfxml_host_cb_list = NULL;
@@ -105,18 +83,17 @@ xbt_dynar_t ETag_surfxml_config_cb_list = NULL;
 xbt_dynar_t STag_surfxml_include_cb_list = NULL;
 xbt_dynar_t ETag_surfxml_include_cb_list = NULL;
 
-/* store the current property set for any tag */
+/* The default current property receiver. Setup in the corresponding opening callbacks. */
 xbt_dict_t current_property_set = NULL;
 /* dictionary of random generator data */
 xbt_dict_t random_data_list = NULL;
 
+/* Call all the callbacks of a specific SAX event */
 static XBT_INLINE void surfxml_call_cb_functions(xbt_dynar_t);
 
 YY_BUFFER_STATE surf_input_buffer;
 FILE *surf_file_to_parse = NULL;
 
-static void surf_parse_error(char *msg);
-
 static void parse_Stag_trace(void);
 static void parse_Etag_trace(void);
 static void parse_Stag_trace_connect(void);
@@ -124,6 +101,10 @@ static void parse_Stag_trace_connect(void);
 static void init_randomness(void);
 static void add_randomness(void);
 
+/*
+ * Stuff relative to the <include> tag
+ */
+
 static xbt_dynar_t surf_input_buffer_stack = NULL;
 static xbt_dynar_t surf_file_to_parse_stack = NULL;
 
@@ -141,18 +122,21 @@ void STag_surfxml_include(void)
   fflush(NULL);
 }
 
-void ETag_surfxml_include(void)
-{
-//     XBT_INFO("ETag_surfxml_include '%s'",A_surfxml_include_file);
-//     fflush(NULL);
-//     fclose(surf_file_to_parse);
-//     xbt_dynar_pop(surf_file_to_parse_stack, &surf_file_to_parse); // restore old filename
-//     surf_parse_pop_buffer_state();
-//     xbt_dynar_pop(surf_input_buffer_stack,&surf_input_buffer);
+void ETag_surfxml_include(void) {
+/* Nothing to do when done with reading the include tag.
+ * Instead, the handling should be deferred until the EOF of current buffer -- see below */
 }
 
-/*
- * Return 1 if tag include is opened
+/** @brief When reaching EOF, check whether we are in an include tag, and behave accordingly if yes
+ *
+ * This function is called automatically by sedding the parser in buildtools/Cmake/MaintainerMode.cmake
+ * Every FAIL on "Premature EOF" is preceded by a call to this function, which role is to restore the
+ * previous buffer if we reached the EOF /of an include file/. Its return code is used to avoid the
+ * error message in that case.
+ *
+ * Yeah, that's terribly hackish, but it works. A better solution should be dealed with in flexml
+ * directly: a command line flag could instruct it to do the correct thing when #include is encountered
+ * on a line.
  */
 int ETag_surfxml_include_state(void)
 {
@@ -284,9 +268,8 @@ void surf_parse_free_callbacks(void)
 
 void STag_surfxml_platform(void)
 {
-  double version = 0.0;
-
-  sscanf(A_surfxml_platform_version, "%lg", &version);
+  double version;
+  surf_parse_get_double(&version, A_surfxml_platform_version);
 
   xbt_assert((version >= 1.0), "******* BIG FAT WARNING *********\n "
       "You're using an ancient XML file.\n"
@@ -314,7 +297,7 @@ void STag_surfxml_platform(void)
 
 void STag_surfxml_host(void){
 //     XBT_INFO("STag_surfxml_host [%s]",A_surfxml_host_id);
-       struct_host = xbt_new0(s_host_t, 1);
+       struct_host = xbt_new0(s_hostSG_t, 1);
        struct_host->V_host_id = xbt_strdup(A_surfxml_host_id);
        struct_host->V_host_power_peak = get_cpu_power(A_surfxml_host_power);
        surf_parse_get_double(&(struct_host->V_host_power_scale), A_surfxml_host_availability);
@@ -358,6 +341,8 @@ void ETag_surfxml_router(void){
 }
 
 void STag_surfxml_cluster(void){
+  surf_parse_models_setup(); /* ensure that the models are created after the last <config> tag. See comment in simgrid.dtd */
+
        struct_cluster = xbt_new0(s_cluster_t, 1);
        struct_cluster->V_cluster_id = xbt_strdup(A_surfxml_cluster_id);
        struct_cluster->V_cluster_prefix = xbt_strdup(A_surfxml_cluster_prefix);
@@ -401,6 +386,8 @@ void ETag_surfxml_cluster(void){
 }
 
 void STag_surfxml_peer(void){
+  surf_parse_models_setup(); /* ensure that the models are created after the last <config> tag. See comment in simgrid.dtd */
+
        struct_peer = xbt_new0(s_peer_t, 1);
        struct_peer->V_peer_id = xbt_strdup(A_surfxml_peer_id);
        struct_peer->V_peer_power = xbt_strdup(A_surfxml_peer_power);
@@ -528,16 +515,17 @@ void surf_parse_open(const char *file)
   if (!file) {
     if (!warned) {
       XBT_WARN
-          ("Bypassing the XML parser since surf_parse_open received a NULL pointer. If it is not what you want, go fix your code.");
+          ("Bypassing the XML parser since surf_parse_open received a NULL pointer. "
+              "If it is not what you want, go fix your code.");
       warned = 1;
     }
     return;
   }
 
   if (!surf_input_buffer_stack)
-       surf_input_buffer_stack = xbt_dynar_new(sizeof(YY_BUFFER_STATE), NULL);
+    surf_input_buffer_stack = xbt_dynar_new(sizeof(YY_BUFFER_STATE), NULL);
   if (!surf_file_to_parse_stack)
-       surf_file_to_parse_stack = xbt_dynar_new(sizeof(FILE *), NULL);
+    surf_file_to_parse_stack = xbt_dynar_new(sizeof(FILE *), NULL);
 
   surf_file_to_parse = surf_fopen(file, "r");
   xbt_assert((surf_file_to_parse), "Unable to open \"%s\"\n", file);
@@ -549,9 +537,9 @@ void surf_parse_open(const char *file)
 void surf_parse_close(void)
 {
   if (surf_input_buffer_stack)
-       xbt_dynar_free(&surf_input_buffer_stack);
+    xbt_dynar_free(&surf_input_buffer_stack);
   if (surf_file_to_parse_stack)
-       xbt_dynar_free(&surf_file_to_parse_stack);
+    xbt_dynar_free(&surf_file_to_parse_stack);
 
   if (surf_file_to_parse) {
     surf_parse__delete_buffer(surf_input_buffer);
@@ -560,36 +548,13 @@ void surf_parse_close(void)
   }
 }
 
-/* Parse Function */
+/* Call the lexer to parse the currently opened file. This pointer to function enables bypassing of the parser */
 
-static int _surf_parse(void)
-{
+static int _surf_parse(void) {
   return surf_parse_lex();
 }
-
 int_f_void_t surf_parse = _surf_parse;
 
-void surf_parse_error(char *msg)
-{
-  fprintf(stderr, "Parse error on line %d: %s\n", surf_parse_lineno, msg);
-  abort();
-}
-
-void surf_parse_get_double(double *value, const char *string)
-{
-  int ret = 0;
-  ret = sscanf(string, "%lg", value);
-  if (ret != 1)
-    surf_parse_error(bprintf("%s is not a double", string));
-}
-
-void surf_parse_get_int(int *value, const char *string)
-{
-  int ret = 0;
-  ret = sscanf(string, "%d", value);
-  if (ret != 1)
-    surf_parse_error(bprintf("%s is not an integer", string));
-}
 
 /* Aux parse functions */
 
@@ -627,53 +592,6 @@ static XBT_INLINE void surfxml_call_cb_functions(xbt_dynar_t cb_list)
   }
 }
 
-/* Init and free parse data */
-
-static void init_data(void)
-{
-  if (!surfxml_bufferstack_stack)
-    surfxml_bufferstack_stack = xbt_dynar_new(sizeof(char *), NULL);
-
-  traces_set_list = xbt_dict_new();
-  trace_connect_list_host_avail = xbt_dict_new();
-  trace_connect_list_power = xbt_dict_new();
-  trace_connect_list_link_avail = xbt_dict_new();
-  trace_connect_list_bandwidth = xbt_dict_new();
-  trace_connect_list_latency = xbt_dict_new();
-
-  surfxml_add_callback(STag_surfxml_trace_cb_list, &parse_Stag_trace);
-  surfxml_add_callback(ETag_surfxml_trace_cb_list, &parse_Etag_trace);
-  surfxml_add_callback(STag_surfxml_trace_connect_cb_list,
-                                          &parse_Stag_trace_connect);
-}
-
-static void free_data(void)
-{
-  xbt_dict_free(&trace_connect_list_host_avail);
-  xbt_dict_free(&trace_connect_list_power);
-  xbt_dict_free(&trace_connect_list_link_avail);
-  xbt_dict_free(&trace_connect_list_bandwidth);
-  xbt_dict_free(&trace_connect_list_latency);
-  xbt_dict_free(&traces_set_list);
-  xbt_dict_free(&random_data_list);
-  xbt_dynar_free(&surfxml_bufferstack_stack);
-}
-
-/* Here start parse */
-void parse_platform_file(const char *file)
-{
-  int parse_status;
-
-  surfxml_buffer_stack_stack_ptr = 1;
-  surfxml_buffer_stack_stack[0] = 0;
-
-  surf_parse_open(file);
-  init_data();
-  parse_status = surf_parse();
-  free_data();
-  surf_parse_close();
-  xbt_assert(!parse_status, "Parse error in %s", file);
-}
 
 /* Prop tag functions */
 
@@ -681,7 +599,7 @@ void parse_properties(const char* prop_id, const char* prop_value)
 {
     char *value = NULL;
        if (!current_property_set)
-           current_property_set = xbt_dict_new();      // Maybe, it should be make a error
+           current_property_set = xbt_dict_new();      // Maybe, it should raise an error
        if(!strcmp(prop_id,"coordinates")){
                if(!strcmp(prop_value,"yes") && !COORD_HOST_LEVEL)
                  {
@@ -706,85 +624,6 @@ void parse_properties_XML(void)
   parse_properties(A_surfxml_prop_id, A_surfxml_prop_value);
 }
 
-/*
- * With lua console
- */
-void parse_properties_lua(const char* prop_id, const char* prop_value)
-{
-        parse_properties(prop_id, prop_value);
-}
-
-/* Trace management functions */
-
-static double trace_periodicity = -1.0;
-static char *trace_file = NULL;
-static char *trace_id = NULL;
-
-static void parse_Stag_trace(void)
-{
-  trace_id = xbt_strdup(A_surfxml_trace_id);
-  trace_file = xbt_strdup(A_surfxml_trace_file);
-  surf_parse_get_double(&trace_periodicity, A_surfxml_trace_periodicity);
-}
-
-static void parse_Etag_trace(void)
-{
-  tmgr_trace_t trace;
-  if (!trace_file || strcmp(trace_file, "") != 0) {
-    trace = tmgr_trace_new(trace_file);
-  } else {
-    if (strcmp(surfxml_pcdata, "") == 0)
-      trace = NULL;
-    else
-      trace =
-          tmgr_trace_new_from_string(trace_id, surfxml_pcdata,
-                                     trace_periodicity);
-  }
-  xbt_dict_set(traces_set_list, trace_id, (void *) trace, NULL);
-  xbt_free(trace_file);
-  trace_file = NULL;
-  xbt_free(trace_id);
-  trace_id = NULL;
-}
-
-static void parse_Stag_trace_connect(void)
-{
-  xbt_assert(xbt_dict_get_or_null
-              (traces_set_list, A_surfxml_trace_connect_trace),
-              "Cannot connect trace %s to %s: trace unknown",
-              A_surfxml_trace_connect_trace,
-              A_surfxml_trace_connect_element);
-
-  switch (A_surfxml_trace_connect_kind) {
-  case A_surfxml_trace_connect_kind_HOST_AVAIL:
-    xbt_dict_set(trace_connect_list_host_avail,
-                 A_surfxml_trace_connect_trace,
-                 xbt_strdup(A_surfxml_trace_connect_element), free);
-    break;
-  case A_surfxml_trace_connect_kind_POWER:
-    xbt_dict_set(trace_connect_list_power, A_surfxml_trace_connect_trace,
-                 xbt_strdup(A_surfxml_trace_connect_element), free);
-    break;
-  case A_surfxml_trace_connect_kind_LINK_AVAIL:
-    xbt_dict_set(trace_connect_list_link_avail,
-                 A_surfxml_trace_connect_trace,
-                 xbt_strdup(A_surfxml_trace_connect_element), free);
-    break;
-  case A_surfxml_trace_connect_kind_BANDWIDTH:
-    xbt_dict_set(trace_connect_list_bandwidth,
-                 A_surfxml_trace_connect_trace,
-                 xbt_strdup(A_surfxml_trace_connect_element), free);
-    break;
-  case A_surfxml_trace_connect_kind_LATENCY:
-    xbt_dict_set(trace_connect_list_latency, A_surfxml_trace_connect_trace,
-                 xbt_strdup(A_surfxml_trace_connect_element), free);
-    break;
-  default:
-    xbt_die("Cannot connect trace %s to %s: kind of trace unknown",
-            A_surfxml_trace_connect_trace, A_surfxml_trace_connect_element);
-    break;
-  }
-}
 
 /* Random tag functions */