add traceanalysis support
[model-checker.git] / main.cc
diff --git a/main.cc b/main.cc
index 635b8da70bc213e3db6524c964e78301b1b28ebf..c8417c027666219b9fdaa6da21d256ad4ebdf42c 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 "scanalysis.h"
+#include "plugins.h"
 
-static void param_defaults(struct model_params * params) {
+static void param_defaults(struct model_params *params)
+{
        params->maxreads = 0;
-       params->maxfuturedelay = 100;
+       params->maxfuturedelay = 6;
        params->fairwindow = 0;
+       params->yieldon = false;
+       params->yieldblock = false;
        params->enabledcount = 1;
        params->bound = 0;
+       params->maxfuturevalues = 0;
+       params->expireslop = 4;
+       params->verbose = !!DBG_ENABLED();
+       params->uninitvalue = 0;
 }
 
-static void print_usage(struct model_params *params) {
-       printf(
-"Usage: <program name> [MC_OPTIONS] -- [PROGRAM ARGUMENTS]\n"
+static void print_usage(const char *program_name, struct model_params *params)
+{
+       /* Reset defaults before printing */
+       param_defaults(params);
+
+       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: %s [MODEL-CHECKER OPTIONS] -- [PROGRAM ARGS]\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"
-"-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"
-"-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->maxfuturedelay, params->fairwindow, params->enabledcount, params->bound);
+"MODLE-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"
+"-m, --liveness=NUM          Maximum times a thread can read from the same write\n"
+"                              while other writes exist.\n"
+"                              Default: %d\n"
+"-M, --maxfv=NUM             Maximum number of future values that can be sent to\n"
+"                              the same read.\n"
+"                              Default: %d\n"
+"-s, --maxfvdelay=NUM        Maximum actions that the model checker will wait for\n"
+"                              a write from the future past the expected number\n"
+"                              of actions.\n"
+"                              Default: %d\n"
+"-S, --fvslop=NUM            Future value expiration sloppiness.\n"
+"                              Default: %u\n"
+"-y, --yield                 Enable CHESS-like yield-based fairness support.\n"
+"                              Default: %s\n"
+"-Y, --yieldblock            Prohibit an execution from running a yield.\n"
+"                              Default: %s\n"
+"-f, --fairness=WINDOW       Specify a fairness window in which actions that are\n"
+"                              enabled sufficiently many times should receive\n"
+"                              priority for execution (not recommended).\n"
+"                              Default: %d\n"
+"-e, --enabled=COUNT         Enabled count.\n"
+"                              Default: %d\n"
+"-b, --bound=MAX             Upper length bound.\n"
+"                              Default: %d\n"
+"-v, --verbose               Print verbose execution information.\n"
+"-u, --uninitialized=VALUE   Return VALUE any load which may read from an\n"
+"                              uninitialized atomic.\n"
+"                              Default: %u\n"
+"-t, --analysis=NAME         Use Trace Analysis.\n"
+" --                         Program arguments follow.\n\n",
+               program_name,
+               params->maxreads,
+               params->maxfuturevalues,
+               params->maxfuturedelay,
+               params->expireslop,
+               params->yieldon ? "enabled" : "disabled",
+               params->yieldblock ? "enabled" : "disabled",
+               params->fairwindow,
+               params->enabledcount,
+               params->bound,
+               params->uninitvalue);
        exit(EXIT_SUCCESS);
 }
 
-static void parse_options(struct model_params *params, int *argc, char ***argv) {
-       const char *shortopts = "hm: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;
+}
+
+static void parse_options(struct model_params *params, int argc, char **argv)
+{
+       const char *shortopts = "hyYt:m:M:s:S:f:e:b:u:v::";
+       const struct option longopts[] = {
+               {"help", no_argument, NULL, 'h'},
+               {"liveness", required_argument, NULL, 'm'},
+               {"maxfv", required_argument, NULL, 'M'},
+               {"maxfvdelay", required_argument, NULL, 's'},
+               {"fvslop", required_argument, NULL, 'S'},
+               {"fairness", required_argument, NULL, 'f'},
+               {"yield", no_argument, NULL, 'y'},
+               {"yieldblock", no_argument, NULL, 'Y'},
+               {"enabled", required_argument, NULL, 'e'},
+               {"bound", required_argument, NULL, 'b'},
+               {"verbose", optional_argument, NULL, 'v'},
+               {"uninitialized", optional_argument, NULL, 'u'},
+               {"analysis", optional_argument, NULL, 't'},
+               {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);
+                       print_usage(argv[0], params);
                        break;
                case 's':
                        params->maxfuturedelay = atoi(optarg);
                        break;
+               case 'S':
+                       params->expireslop = atoi(optarg);
+                       break;
                case 'f':
                        params->fairwindow = atoi(optarg);
                        break;
@@ -67,55 +153,78 @@ static void parse_options(struct model_params *params, int *argc, char ***argv)
                case 'm':
                        params->maxreads = atoi(optarg);
                        break;
+               case 'M':
+                       params->maxfuturevalues = atoi(optarg);
+                       break;
+               case 'v':
+                       params->verbose = optarg ? atoi(optarg) : 1;
+                       break;
+               case 'u':
+                       params->uninitvalue = atoi(optarg);
+                       break;
+               case 'y':
+                       params->yieldon = true;
+                       break;
+               case 't':
+                       if (install_plugin(optarg))
+                               error = true;
+                       break;
+               case 'Y':
+                       params->yieldblock = true;
+                       break;
                default: /* '?' */
                        error = true;
                        break;
                }
        }
-       (*argv)[optind - 1] = (*argv)[0];
-       (*argc) -= (optind - 1);
-       (*argv) += (optind - 1);
+
+       /* Pass remaining arguments to user program */
+       params->argc = argc - (optind - 1);
+       params->argv = argv + (optind - 1);
+
+       /* Reset program name */
+       params->argv[0] = argv[0];
+
+       /* Reset (global) optind for potential use by user program */
        optind = 1;
 
        if (error)
-               print_usage(params);
+               print_usage(argv[0], params);
 }
 
 int main_argc;
 char **main_argv;
 
-/** Wrapper to run the user's main function, with appropriate arguments */
-void wrapper_user_main(void *)
+static void install_trace_analyses(ModelExecution *execution)
 {
-       user_main(main_argc, main_argv);
+       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);
+       }
 }
 
 /** The model_main function contains the main model checking loop. */
-static void model_main() {
-       thrd_t user_thread;
+static void model_main()
+{
        struct model_params params;
 
        param_defaults(&params);
+       register_plugins();
 
-       parse_options(&params, &main_argc, &main_argv);
+       parse_options(&params, main_argc, main_argv);
 
        //Initialize race detector
        initRaceDetector();
 
-       //Create the singleton SnapshotStack object
-       snapshotObject = new SnapshotStack();
+       snapshot_stack_init();
 
        model = new ModelChecker(params);
+       install_trace_analyses(model->get_execution());
 
-       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());
-
+       snapshot_record(0);
+       model->run();
        delete model;
 
        DEBUG("Exiting\n");
@@ -125,10 +234,14 @@ static void model_main() {
  * Main function.  Just initializes snapshotting library and the
  * snapshotting library calls the model_main function.
  */
-int main(int argc, char ** argv) {
+int main(int argc, char **argv)
+{
        main_argc = argc;
        main_argv = argv;
 
+       /* Configure output redirection for the model-checker */
+       redirect_output();
+
        /* Let's jump in quickly and start running stuff */
-       initSnapshotLibrary(10000, 1024, 1024, 4000, &model_main);
+       snapshot_system_init(10000, 1024, 1024, 4000, &model_main);
 }