Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Finish the tutorial for new model and api
[simgrid.git] / src / surf / surf_config.c
index 1a77903..6108c02 100644 (file)
 
 /* surf_config: configuration infrastructure for the simulation world       */
 
+#include "xbt/misc.h"
 #include "xbt/config.h"
+#include "xbt/log.h"
 #include "xbt/str.h"
 #include "surf/surf_private.h"
-#include "surf/surf_routing.h" /* COORD_HOST_LEVEL and COORD_ASR_LEVEL */
-#include "simix/context.h"
+#include "surf/surf_routing.h"  /* COORD_HOST_LEVEL and COORD_ASR_LEVEL */
+#include "simgrid/simix.h"
+#include "mc/mc.h" /* configuration callbacks of model-checking */
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf,
                                 "About the configuration of surf (and the rest of the simulation)");
 
 xbt_cfg_t _surf_cfg_set = NULL;
 
-static void LOG_help(void)
-{
-  printf(
-"Description of the logging output:\n"
-"\n"
-"   Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
-"      CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
-"      PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
-"         -> trace: enter and return of some functions\n"
-"         -> debug: crufty output\n"
-"         -> verbose: verbose output for the user wanting more\n"
-"         -> info: output about the regular functionning\n"
-"         -> warning: minor issue encountered\n"
-"         -> error: issue encountered\n"
-"         -> critical: major issue encountered\n"
-"\n"
-"   Format configuration: --log=CATEGORY_NAME.fmt:OPTIONS\n"
-"      OPTIONS may be:\n"
-"         -> %%%%: the %% char\n"
-"         -> %%n: platform-dependent line separator (LOG4J compatible)\n"
-"         -> %%e: plain old space (SimGrid extension)\n"
-"\n"
-"         -> %%m: user-provided message\n"
-"\n"
-"         -> %%c: Category name (LOG4J compatible)\n"
-"         -> %%p: Priority name (LOG4J compatible)\n"
-"\n"
-"         -> %%h: Hostname (SimGrid extension)\n"
-"         -> %%P: Process name (SimGrid extension)\n"
-"         -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
-"         -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
-"\n"
-"         -> %%F: file name where the log event was raised (LOG4J compatible)\n"
-"         -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)\n"
-"         -> %%L: line number where the log event was raised (LOG4J compatible)\n"
-"         -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
-"                 Defined only when using gcc because there is no __FUNCTION__ elsewhere.\n"
-"\n"
-"         -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the GNU libc because\n"
-"                 backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not mac ones for example.\n"
-"         -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; defined where %%b is.\n"
-"\n"
-"         -> %%d: date (UNIX-like epoch)\n"
-"         -> %%r: application age (time elapsed since the beginning of the application)\n"
-    );
-}
-
 /* Parse the command line, looking for options */
 static void surf_config_cmd_line(int *argc, char **argv)
 {
+  int shall_exit = 0;
   int i, j;
   char *opt;
 
-  for (i = 1; i < *argc; i++) {
-    int remove_it = 0;
+  for (j = i = 1; i < *argc; i++) {
     if (!strncmp(argv[i], "--cfg=", strlen("--cfg="))) {
       opt = strchr(argv[i], '=');
       opt++;
 
       xbt_cfg_set_parse(_surf_cfg_set, opt);
       XBT_DEBUG("Did apply '%s' as config setting", opt);
-      remove_it = 1;
-    } else if (!strncmp(argv[i], "--cfg-help", strlen("--cfg-help") + 1) ||
-               !strncmp(argv[i], "--help", strlen("--help") + 1)) {
+    } else if (!strcmp(argv[i], "--cfg-help") || !strcmp(argv[i], "--help")) {
       printf
           ("Description of the configuration accepted by this simulator:\n");
       xbt_cfg_help(_surf_cfg_set);
       printf(
 "\n"
+"Each of these configurations can be used by adding\n"
+"    --cfg=<option name>:<option value>\n"
+"to the command line.\n"
 "You can also use --help-models to see the details of all models known by this simulator.\n"
 #ifdef HAVE_TRACING
 "\n"
 "You can also use --help-tracing to see the details of all tracing options known by this simulator.\n"
 #endif
 "\n"
-"You can also use --help-logs to see the details of logging output.\n"
+"You can also use --help-logs and --help-log-categories to see the details of logging output.\n"
 "\n"
         );
-      exit(0);
-    } else if (!strncmp(argv[i], "--help-models", strlen("--help-models") + 1)) {
+      shall_exit = 1;
+    } else if (!strcmp(argv[i], "--help-models")) {
+      int k;
+
       model_help("workstation", surf_workstation_model_description);
       printf("\n");
       model_help("CPU", surf_cpu_model_description);
       printf("\n");
       model_help("network", surf_network_model_description);
       printf("\nLong description of all optimization levels accepted by the models of this simulator:\n");
-      for (i = 0; surf_optimization_mode_description[i].name; i++)
-        printf("  %s: %s\n", surf_optimization_mode_description[i].name, surf_optimization_mode_description[i].description);
-      printf("Both network and CPU models have 'Lazy' as default optimization level\n");
-      exit(0);
-    } else if (!strncmp(argv[i], "--help-logs", strlen("--help-logs") + 1)) {
-      LOG_help ();
-      exit(0);
+      for (k = 0; surf_optimization_mode_description[k].name; k++)
+        printf("  %s: %s\n",
+               surf_optimization_mode_description[k].name,
+               surf_optimization_mode_description[k].description);
+      printf("Both network and CPU models have 'Lazy' as default optimization level\n\n");
+      shall_exit = 1;
 #ifdef HAVE_TRACING
-    } else if (!strncmp(argv[i], "--help-tracing", strlen("--help-tracing") + 1)) {
+    } else if (!strcmp(argv[i], "--help-tracing")) {
       TRACE_help (1);
-      exit(0);
+      shall_exit = 1;
 #endif
-    }
-    if (remove_it) {            /*remove this from argv */
-      for (j = i + 1; j < *argc; j++) {
-        argv[j - 1] = argv[j];
-      }
-
-      argv[j - 1] = NULL;
-      (*argc)--;
-      i--;                      /* compensate effect of next loop incrementation */
+    } else {
+      argv[j++] = argv[i];
     }
   }
+  if (j < *argc) {
+    argv[j] = NULL;
+    *argc = j;
+  }
+  if (shall_exit)
+    exit(0);
 }
 
 
@@ -276,6 +233,9 @@ static void _surf_cfg_cb_model_check(const char *name, int pos)
   _surf_do_model_check = xbt_cfg_get_int(_surf_cfg_set, name);
 
   if (_surf_do_model_check) {
+#ifndef HAVE_MC
+    xbt_die("You tried to activate the model-checking from the command line, but it was not compiled in. Change your settings in cmake, recompile and try again");
+#endif
     /* Tell modules using mallocators that they shouldn't. MC don't like them */
     xbt_fifo_preinit();
     xbt_dict_preinit();
@@ -290,8 +250,7 @@ static void _surf_cfg_cb_verbose_exit(const char *name, int pos)
 }
 
 
-static void _surf_cfg_cb_context_factory(const char *name, int pos)
-{
+static void _surf_cfg_cb_context_factory(const char *name, int pos) {
   smx_context_factory_name = xbt_cfg_get_string(_surf_cfg_set, name);
 }
 
@@ -379,8 +338,6 @@ void surf_config_init(int *argc, char **argv)
 
   /* Create the configuration support */
   if (_surf_init_status == 0) { /* Only create stuff if not already inited */
-    _surf_init_status = 1;
-
     sprintf(description,
             "The model to use for the CPU. Possible values: ");
     p = description;
@@ -421,6 +378,23 @@ void surf_config_init(int *argc, char **argv)
                      &default_value, 1, 1, &_surf_cfg_cb__storage_mode,
                      NULL);
 
+    /* ********************************************************************* */
+    /* TUTORIAL: New model                                                   */
+    sprintf(description,
+            "The model to use for the New model. Possible values: ");
+    p = description;
+    while (*(++p) != '\0');
+    for (i = 0; surf_new_model_description[i].name; i++)
+      p += sprintf(p, "%s%s", (i == 0 ? "" : ", "),
+                   surf_new_model_description[i].name);
+    sprintf(p,
+            ".\n       (use 'help' as a value to see the long description of each model)");
+    default_value = xbt_strdup("default");
+    xbt_cfg_register(&_surf_cfg_set, "new_model/model", description, xbt_cfgelm_string,
+                     &default_value, 1, 1, &_surf_cfg_cb__storage_mode,
+                     NULL);
+    /* ********************************************************************* */
+
     sprintf(description,
             "The model to use for the network. Possible values: ");
     p = description;
@@ -516,18 +490,36 @@ void surf_config_init(int *argc, char **argv)
                      xbt_cfgelm_int, &default_value_int, 0, 1,
                      NULL, NULL);
 
-    /* do model-check */
+#ifdef HAVE_MC
+    /* do model-checking */
     default_value_int = 0;
     xbt_cfg_register(&_surf_cfg_set, "model-check",
-                     "Activate the model-checking of the \"simulated\" system (EXPERIMENTAL -- msg only for now)",
+                     "Verify the system through model-checking instead of simulating it (EXPERIMENTAL)",
                      xbt_cfgelm_int, &default_value_int, 0, 1,
                      _surf_cfg_cb_model_check, NULL);
+
+    /* do stateful model-checking */
+    default_value_int = 0;
+    xbt_cfg_register(&_surf_cfg_set, "model-check/checkpoint",
+                     "Specify the amount of steps between checkpoints during stateful model-checking (default: 0 => stateless verification). "
+                     "If value=1, one checkpoint is saved for each step => faster verification, but huge memory consumption; higher values are good compromises between speed and memory consumption.",
+                     xbt_cfgelm_int, &default_value_int, 0, 1,
+                     _mc_cfg_cb_checkpoint, NULL);
     
-    /*
-       FIXME: this function is not setting model-check to it's default value because
-       internally it calls to variable->cb_set that in this case is the function 
-       _surf_cfg_cb_model_check which sets it's value to 1 (instead of the default value 0)
-       xbt_cfg_set_int(_surf_cfg_set, "model-check", default_value_int); */
+    /* do liveness model-checking */
+    default_value = xbt_strdup("");
+    xbt_cfg_register(&_surf_cfg_set, "model-check/property",
+                     "Specify the name of the file containing the property. It must be the result of the ltl2ba program.",
+                     xbt_cfgelm_string, &default_value, 0, 1,
+                     _mc_cfg_cb_property, NULL);
+
+    /* Specify the kind of model-checking reduction */
+    default_value = xbt_strdup("unset");
+    xbt_cfg_register(&_surf_cfg_set, "model-check/reduction",
+                     "Specify the kind of exploration reduction (either none or DPOR)",
+                     xbt_cfgelm_string, &default_value, 0, 1,
+                     _mc_cfg_cb_reduce, NULL);
+#endif
 
     /* do verbose-exit */
     default_value_int = 1;
@@ -636,11 +628,17 @@ void surf_config_init(int *argc, char **argv)
                      xbt_cfgelm_double, &default_threshold, 1, 1, NULL,
                      NULL);
 
+    int default_small_messages_threshold = 0;
+    xbt_cfg_register(&_surf_cfg_set, "smpi/async_small_thres",
+                     "Maximal size of messages that are to be sent asynchronously, without waiting for the receiver",
+                     xbt_cfgelm_int, &default_small_messages_threshold, 1, 1, NULL,
+                     NULL);
+
     //For smpi/bw_factor and smpi/lat_factor
     //Default value have to be "threshold0:value0;threshold1:value1;...;thresholdN:valueN"
     //test is if( size >= thresholdN ) return valueN;
     //Values can be modified with command line --cfg=smpi/bw_factor:"threshold0:value0;threshold1:value1;...;thresholdN:valueN"
-    // or with tag config put line <prop id="smpi/bw_factor" value="threshold0:value0;threshold1:value1;...;thresholdN:valueN"></prop>
+    //  or with tag config put line <prop id="smpi/bw_factor" value="threshold0:value0;threshold1:value1;...;thresholdN:valueN"></prop>
     xbt_cfg_register(&_surf_cfg_set, "smpi/bw_factor",
                      "Bandwidth factors for smpi.",
                      xbt_cfgelm_string, NULL, 1, 1, NULL,
@@ -667,6 +665,8 @@ void surf_config_init(int *argc, char **argv)
 
 
     surf_config_cmd_line(argc, argv);
+
+    _surf_init_status = 1;
   } else {
     XBT_WARN("Call to surf_config_init() after initialization ignored");
   }
@@ -703,14 +703,14 @@ void surf_config_models_setup()
    */
 
   if((!xbt_cfg_is_default_value(_surf_cfg_set, "network/model") ||
-         !xbt_cfg_is_default_value(_surf_cfg_set, "cpu/model")) &&
-         xbt_cfg_is_default_value(_surf_cfg_set, "workstation/model"))
+    !xbt_cfg_is_default_value(_surf_cfg_set, "cpu/model")) &&
+    xbt_cfg_is_default_value(_surf_cfg_set, "workstation/model"))
   {
-           const char *val = "compound";
-           XBT_INFO
-               ("Switching workstation model to compound since you changed the network and/or cpu model(s)");
-           xbt_cfg_set_string(_surf_cfg_set, "workstation/model", val);
-           workstation_model_name = (char *) "compound";
+      const char *val = "compound";
+      XBT_INFO
+          ("Switching workstation model to compound since you changed the network and/or cpu model(s)");
+      xbt_cfg_set_string(_surf_cfg_set, "workstation/model", val);
+      workstation_model_name = (char *) "compound";
   }
 
   XBT_DEBUG("Workstation model: %s", workstation_model_name);
@@ -743,4 +743,14 @@ void surf_config_models_setup()
   XBT_DEBUG("Call storage_model_init");
   storage_id = find_model_description(surf_storage_model_description, storage_model_name);
   surf_storage_model_description[storage_id].model_init_preparse();
+
+  /* ********************************************************************* */
+  /* TUTORIAL: New model                                                   */
+  int new_model_id = -1;
+  char *new_model_name = NULL;
+  new_model_name = xbt_cfg_get_string(_surf_cfg_set, "new_model/model");
+  XBT_DEBUG("Call new model_init");
+  new_model_id = find_model_description(surf_new_model_description, new_model_name);
+  surf_new_model_description[new_model_id].model_init_preparse();
+  /* ********************************************************************* */
 }