edits
[c11tester.git] / main.cc
diff --git a/main.cc b/main.cc
index dc3f6f4dca002d6e763e5bbf25068260d3edc828..df8b8776610a40a83ffc7b04540ccdc400586b70 100644 (file)
--- a/main.cc
+++ b/main.cc
@@ -3,6 +3,8 @@
  */
 
 #include <unistd.h>
+#include <getopt.h>
+#include <string.h>
 
 #include "common.h"
 #include "output.h"
 
 /* global "model" object */
 #include "model.h"
+#include "params.h"
 #include "snapshot-interface.h"
+#include "plugins.h"
 
 static void param_defaults(struct model_params *params)
 {
-       params->maxreads = 0;
-       params->maxfuturedelay = 100;
-       params->fairwindow = 0;
-       params->enabledcount = 1;
-       params->bound = 0;
-       params->maxfuturevalues = 0;
-       params->expireslop = 10;
-       params->verbose = 0;
+       params->verbose = !!DBG_ENABLED();
+       params->uninitvalue = 0;
+       params->maxexecutions = 10;
+       params->nofork = false;
 }
 
-static void print_usage(struct model_params *params)
+static void print_usage(const char *program_name, struct model_params *params)
 {
+       ModelVector<TraceAnalysis *> * registeredanalysis=getRegisteredTraceAnalysis();
        /* Reset defaults before printing */
        param_defaults(params);
 
        model_print(
-"Usage: <program name> [MC_OPTIONS] -- [PROGRAM ARGUMENTS]\n"
-"\n"
-"Options:\n"
-"-h                    Display this help message and exit\n"
-"-m                    Maximum times a thread can read from the same write\n"
-"                      while other writes exist. Default: %d\n"
-"-M                    Maximum number of future values that can be sent to\n"
-"                      the same read. Default: %d\n"
-"-s                    Maximum actions that the model checker will wait for\n"
-"                      a write from the future past the expected number of\n"
-"                      actions. Default: %d\n"
-"-S                    Future value expiration sloppiness. Default: %u\n"
-"-f                    Specify a fairness window in which actions that are\n"
-"                      enabled sufficiently many times should receive\n"
-"                      priority for execution. Default: %d\n"
-"-e                    Enabled count. Default: %d\n"
-"-b                    Upper length bound. Default: %d\n"
-"-v                    Print verbose execution information.\n"
-"--                    Program arguments follow.\n\n",
-params->maxreads, params->maxfuturevalues, params->maxfuturedelay, params->expireslop, params->fairwindow, params->enabledcount, params->bound);
+               "Copyright (c) 2013 Regents of the University of California. All rights reserved.\n"
+               "Distributed under the GPLv2\n"
+               "Written by Brian Norris and Brian Demsky\n"
+               "\n"
+               "Usage: %s [MODEL-CHECKER OPTIONS] -- [PROGRAM ARGS]\n"
+               "\n"
+               "MODEL-CHECKER OPTIONS can be any of the model-checker options listed below. Arguments\n"
+               "provided after the `--' (the PROGRAM ARGS) are passed to the user program.\n"
+               "\n"
+               "Model-checker options:\n"
+               "-h, --help                  Display this help message and exit\n"
+               "-v[NUM], --verbose[=NUM]    Print verbose execution information. NUM is optional:\n"
+               "                              0 is quiet; 1 shows valid executions; 2 is noisy;\n"
+               "                              3 is noisier.\n"
+               "                              Default: %d\n"
+               "-u, --uninitialized=VALUE   Return VALUE any load which may read from an\n"
+               "                              uninitialized atomic.\n"
+               "                              Default: %u\n"
+               "-t, --analysis=NAME         Use Analysis Plugin.\n"
+               "-o, --options=NAME          Option for previous analysis plugin.  \n"
+               "-x, --maxexec=NUM           Maximum number of executions.\n"
+               "                            Default: %u\n"
+               "                            -o help for a list of options\n"
+               "-n                          No fork\n"
+               " --                         Program arguments follow.\n\n",
+               program_name,
+               params->verbose,
+               params->uninitvalue,
+               params->maxexecutions);
+       model_print("Analysis plugins:\n");
+       for(unsigned int i=0;i<registeredanalysis->size();i++) {
+               TraceAnalysis * analysis=(*registeredanalysis)[i];
+               model_print("%s\n", analysis->name());
+       }
        exit(EXIT_SUCCESS);
 }
 
+bool install_plugin(char * name) {
+       ModelVector<TraceAnalysis *> * registeredanalysis=getRegisteredTraceAnalysis();
+       ModelVector<TraceAnalysis *> * installedanalysis=getInstalledTraceAnalysis();
+
+       for(unsigned int i=0;i<registeredanalysis->size();i++) {
+               TraceAnalysis * analysis=(*registeredanalysis)[i];
+               if (strcmp(name, analysis->name())==0) {
+                       installedanalysis->push_back(analysis);
+                       return false;
+               }
+       }
+       model_print("Analysis %s Not Found\n", name);
+       return true;
+}
+
 static void parse_options(struct model_params *params, int argc, char **argv)
 {
-       const char *shortopts = "hm:M:s:S:f:e:b:v";
-       int opt;
+       const char *shortopts = "hnt:o:u:x:v::";
+       const struct option longopts[] = {
+               {"help", no_argument, NULL, 'h'},
+               {"verbose", optional_argument, NULL, 'v'},
+               {"uninitialized", required_argument, NULL, 'u'},
+               {"analysis", required_argument, NULL, 't'},
+               {"options", required_argument, NULL, 'o'},
+               {"maxexecutions", required_argument, NULL, 'x'},
+               {0, 0, 0, 0}    /* Terminator */
+       };
+       int opt, longindex;
        bool error = false;
-       while (!error && (opt = getopt(argc, argv, shortopts)) != -1) {
+       while (!error && (opt = getopt_long(argc, argv, shortopts, longopts, &longindex)) != -1) {
                switch (opt) {
                case 'h':
-                       print_usage(params);
-                       break;
-               case 's':
-                       params->maxfuturedelay = atoi(optarg);
-                       break;
-               case 'S':
-                       params->expireslop = atoi(optarg);
-                       break;
-               case 'f':
-                       params->fairwindow = atoi(optarg);
-                       break;
-               case 'e':
-                       params->enabledcount = atoi(optarg);
+                       print_usage(argv[0], params);
                        break;
-               case 'b':
-                       params->bound = atoi(optarg);
+               case 'n':
+                 params->nofork = true;
+                 break;
+               case 'x':
+                       params->maxexecutions = atoi(optarg);
                        break;
-               case 'm':
-                       params->maxreads = atoi(optarg);
+               case 'v':
+                       params->verbose = optarg ? atoi(optarg) : 1;
                        break;
-               case 'M':
-                       params->maxfuturevalues = atoi(optarg);
+               case 'u':
+                       params->uninitvalue = atoi(optarg);
                        break;
-               case 'v':
-                       params->verbose = 1;
+               case 't':
+                       if (install_plugin(optarg))
+                               error = true;
                        break;
-               default: /* '?' */
+               case 'o':
+               {
+                       ModelVector<TraceAnalysis *> * analyses = getInstalledTraceAnalysis();
+                       if ( analyses->size() == 0 || (*analyses)[analyses->size()-1]->option(optarg))
+                               error = true;
+               }
+               break;
+               default:        /* '?' */
                        error = true;
                        break;
                }
@@ -105,18 +143,31 @@ static void parse_options(struct model_params *params, int argc, char **argv)
        optind = 1;
 
        if (error)
-               print_usage(params);
+               print_usage(argv[0], params);
 }
 
 int main_argc;
 char **main_argv;
 
+static void install_trace_analyses(ModelExecution *execution)
+{
+       ModelVector<TraceAnalysis *> * installedanalysis=getInstalledTraceAnalysis();
+       for(unsigned int i=0;i<installedanalysis->size();i++) {
+               TraceAnalysis * ta=(*installedanalysis)[i];
+               ta->setExecution(execution);
+               model->add_trace_analysis(ta);
+               /** Call the installation event for each installed plugin */
+               ta->actionAtInstallation();
+       }
+}
+
 /** The model_main function contains the main model checking loop. */
 static void model_main()
 {
        struct model_params params;
 
        param_defaults(&params);
+       register_plugins();
 
        parse_options(&params, main_argc, main_argv);
 
@@ -125,7 +176,11 @@ static void model_main()
 
        snapshot_stack_init();
 
-       model = new ModelChecker(params);
+       if (!model)
+               model = new ModelChecker();
+       model->setParams(params);
+       install_trace_analyses(model->get_execution());
+
        snapshot_record(0);
        model->run();
        delete model;
@@ -142,9 +197,21 @@ int main(int argc, char **argv)
        main_argc = argc;
        main_argv = argv;
 
+       /*
+        * If this printf statement is removed, CDSChecker will fail on an
+        * assert on some versions of glibc.  The first time printf is
+        * called, it allocated internal buffers.  We can't easily snapshot
+        * libc since we also use it.
+        */
+
+       printf("CDSChecker\n"
+                                "Copyright (c) 2013 Regents of the University of California. All rights reserved.\n"
+                                "Distributed under the GPLv2\n"
+                                "Written by Brian Norris and Brian Demsky\n\n");
+
        /* Configure output redirection for the model-checker */
        redirect_output();
 
        /* Let's jump in quickly and start running stuff */
-       snapshot_system_init(10000, 1024, 1024, 4000, &model_main);
+       snapshot_system_init(10000, 1024, 1024, 40000, &model_main);
 }