small changes
[c11tester.git] / main.cc
diff --git a/main.cc b/main.cc
index fb4acbe75d6b530feabc4e76b111cc0f4bf4b29d..b0931f757e860a778c46e347dde08f87e978abe0 100644 (file)
--- a/main.cc
+++ b/main.cc
  */
 
 #include <unistd.h>
+#include <getopt.h>
+#include <string.h>
 
-#include <threads.h>
 #include "common.h"
-#include "threads-model.h"
+#include "output.h"
 
 #include "datarace.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;
+void param_defaults(struct model_params *params)
+{
+       params->verbose = !!DBG_ENABLED();
+       params->maxexecutions = 10;
+       params->traceminsize = 0;
+       params->checkthreshold = 500000;
+       params->removevisible = false;
+       params->nofork = false;
 }
 
-static void print_usage(struct model_params *params) {
+static void print_usage(struct model_params *params)
+{
+       ModelVector<TraceAnalysis *> * registeredanalysis=getRegisteredTraceAnalysis();
        /* Reset defaults before printing */
        param_defaults(params);
 
-       printf(
-"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"
-"--                    Program arguments follow.\n\n",
-params->maxreads, params->maxfuturevalues, params->maxfuturedelay, params->expireslop, params->fairwindow, params->enabledcount, params->bound);
+       model_print(
+               "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: C11TESTER=[MODEL-CHECKER OPTIONS]\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"
+               "-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"
+               "-m, --minsize=NUM           Minimum number of actions to keep\n"
+               "                            Default: %u\n"
+               "-f, --freqfree=NUM          Frequency to free actions\n"
+               "                            Default: %u\n"
+               "-r, --removevisible         Free visible writes\n",
+               params->verbose,
+               params->maxexecutions,
+               params->traceminsize,
+               params->checkthreshold);
+       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);
 }
 
-static void parse_options(struct model_params *params, int *argc, char ***argv) {
-       const char *shortopts = "hm:M:s:S:f:e:b:";
-       int opt;
+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;
+}
+
+void parse_options(struct model_params *params) {
+       const char *shortopts = "hrnt:o:x:v:m:f:";
+       const struct option longopts[] = {
+               {"help", no_argument, NULL, 'h'},
+               {"removevisible", no_argument, NULL, 'r'},
+               {"analysis", required_argument, NULL, 't'},
+               {"options", required_argument, NULL, 'o'},
+               {"maxexecutions", required_argument, NULL, 'x'},
+               {"verbose", optional_argument, NULL, 'v'},
+               {"minsize", required_argument, NULL, 'm'},
+               {"freqfree", required_argument, NULL, 'f'},
+               {0, 0, 0, 0}    /* Terminator */
+       };
+       int opt, longindex;
        bool error = false;
-       while (!error && (opt = getopt(*argc, *argv, shortopts)) != -1) {
+       char * options = getenv("C11TESTER");
+
+       if (options == NULL)
+               return;
+       int argc = 1;
+       int index;
+       for(index = 0;options[index]!=0;index++) {
+               if (options[index] == ' ')
+                       argc++;
+       }
+       argc++; //first parameter is executable name
+       char optcpy[index + 1];
+       memcpy(optcpy, options, index+1);
+       char * argv[argc + 1];
+       argv[0] = NULL;
+       argv[1] = optcpy;
+       int count = 2;
+       for(index = 0;optcpy[index]!=0;index++) {
+               if (optcpy[index] == ' ') {
+                       argv[count++] = &optcpy[index+1];
+                       optcpy[index] = 0;
+               }
+       }
+
+       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);
+               case 'n':
+                       params->nofork = true;
                        break;
-               case 'S':
-                       params->expireslop = atoi(optarg);
-                       break;
-               case 'f':
-                       params->fairwindow = atoi(optarg);
+               case 'x':
+                       params->maxexecutions = atoi(optarg);
                        break;
-               case 'e':
-                       params->enabledcount = atoi(optarg);
+               case 'v':
+                       params->verbose = optarg ? atoi(optarg) : 1;
                        break;
-               case 'b':
-                       params->bound = atoi(optarg);
+               case 't':
+                       if (install_plugin(optarg))
+                               error = true;
                        break;
                case 'm':
-                       params->maxreads = atoi(optarg);
+                       params->traceminsize = atoi(optarg);
                        break;
-               case 'M':
-                       params->maxfuturevalues = atoi(optarg);
+               case 'f':
+                       params->checkthreshold = atoi(optarg);
+                       break;
+               case 'r':
+                       params->removevisible = 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;
                }
        }
-       (*argv)[optind - 1] = (*argv)[0];
-       (*argc) -= (optind - 1);
-       (*argv) += (optind - 1);
-       optind = 1;
+
+       /* Special value to reset implementation as described by Linux man page.  */
+       optind = 0;
 
        if (error)
                print_usage(params);
 }
 
-int main_argc;
-char **main_argv;
-
-/** Wrapper to run the user's main function, with appropriate arguments */
-void wrapper_user_main(void *)
-{
-       user_main(main_argc, main_argv);
-}
-
-/** The model_main function contains the main model checking loop. */
-static void model_main() {
-       thrd_t user_thread;
-       struct model_params params;
-
-       param_defaults(&params);
-
-       parse_options(&params, &main_argc, &main_argv);
-
-       //Initialize race detector
-       initRaceDetector();
-
-       //Create the singleton SnapshotStack object
-       snapshotObject = new SnapshotStack();
-
-       model = new ModelChecker(params);
-
-       snapshotObject->snapshotStep(0);
-       do {
-               /* Start user program */
-               model->add_thread(new Thread(&user_thread, &wrapper_user_main, NULL));
-
-               /* Wait for all threads to complete */
-               model->finish_execution();
-       } while (model->next_execution());
-
-       delete model;
-
-       DEBUG("Exiting\n");
-}
-
-/**
- * Main function.  Just initializes snapshotting library and the
- * snapshotting library calls the model_main function.
- */
-int main(int argc, char ** argv) {
-       main_argc = argc;
-       main_argv = argv;
-
-       /* Let's jump in quickly and start running stuff */
-       initSnapshotLibrary(10000, 1024, 1024, 4000, &model_main);
+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();
+       }
 }