add support for analysis with options
[model-checker.git] / main.cc
diff --git a/main.cc b/main.cc
index e456ac6b326469a85383af6a97a422e9a2c65f92..d2d8d4ab835a5d44d35789f1075f8f7d55a09063 100644 (file)
--- a/main.cc
+++ b/main.cc
-#include "libthreads.h"
+/** @file main.cc
+ *  @brief Entry point for the model checker.
+ */
+
+#include <unistd.h>
+#include <getopt.h>
+#include <string.h>
+
 #include "common.h"
-#include "threads.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"
 
-/*
- * Return 1 if found next thread, 0 otherwise
- */
-int num;
-int num1;
-int num2;
+static void param_defaults(struct model_params *params)
+{
+       params->maxreads = 0;
+       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 int thread_system_next(void)
+static void print_usage(const char *program_name, struct model_params *params)
 {
-       Thread *curr, *next;
-
-       curr = thread_current();
-       if (curr) {
-               if (curr->get_state() == THREAD_READY) {
-                       model->check_current_action();
-                       model->scheduler->add_thread(curr);
-               } else if (curr->get_state() == THREAD_RUNNING)
-                       /* Stopped while running; i.e., completed */
-                       curr->complete();
-               else
-                       ASSERT(false);
+       /* 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"
+"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"
+"-o, --options=NAME          Options.\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);
+}
+
+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;
+               }
        }
-       next = model->scheduler->next_thread();
-       if (next)
-               next->set_state(THREAD_RUNNING);
-       DEBUG("(%d, %d)\n", curr ? curr->get_id() : -1, next ? next->get_id() : -1);
-       if (!next)
-               return 1;
-       return Thread::swap(model->get_system_context(), next);
+       model_print("Analysis %s Not Found\n", name);
+       return true;
 }
 
-static void thread_wait_finish(void)
+static void parse_options(struct model_params *params, int argc, char **argv)
 {
+       const char *shortopts = "hyYt:o: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'},
+               {"options", optional_argument, NULL, 'o'},
+               {0, 0, 0, 0} /* Terminator */
+       };
+       int opt, longindex;
+       bool error = false;
+       while (!error && (opt = getopt_long(argc, argv, shortopts, longopts, &longindex)) != -1) {
+               switch (opt) {
+               case 'h':
+                       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;
+               case 'e':
+                       params->enabledcount = atoi(optarg);
+                       break;
+               case 'b':
+                       params->bound = atoi(optarg);
+                       break;
+               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 'o':
+                       {
+                               ModelVector<TraceAnalysis *> * analyses = getInstalledTraceAnalysis();
+                               if ( analyses->size() == 0 || (*analyses)[analyses->size()-1]->option(optarg))
+                                       error = true;
+                       }
+                       break;
+               case 'Y':
+                       params->yieldblock = true;
+                       break;
+               default: /* '?' */
+                       error = true;
+                       break;
+               }
+       }
+
+       /* Pass remaining arguments to user program */
+       params->argc = argc - (optind - 1);
+       params->argv = argv + (optind - 1);
 
-       DBG();
+       /* Reset program name */
+       params->argv[0] = argv[0];
 
-       while (!thread_system_next());
+       /* Reset (global) optind for potential use by user program */
+       optind = 1;
+
+       if (error)
+               print_usage(argv[0], params);
 }
 
-/*
- * Main system function
- */
-int main()
+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);
+       }
+}
+
+/** The model_main function contains the main model checking loop. */
+static void model_main()
 {
-       thrd_t user_thread;
-       ucontext_t main_context;
+       struct model_params params;
 
-       model = new ModelChecker();
+       param_defaults(&params);
+       register_plugins();
 
-       if (getcontext(&main_context))
-               return 1;
+       parse_options(&params, main_argc, main_argv);
 
-       model->set_system_context(&main_context);
+       //Initialize race detector
+       initRaceDetector();
 
-       do {
-               /* Start user program */
-               model->add_thread(new Thread(&user_thread, &user_main, NULL));
+       snapshot_stack_init();
 
-               /* Wait for all threads to complete */
-               thread_wait_finish();
-       } while (model->next_execution());
+       model = new ModelChecker(params);
+       install_trace_analyses(model->get_execution());
 
+       snapshot_record(0);
+       model->run();
        delete model;
 
        DEBUG("Exiting\n");
-       return 0;
+}
+
+/**
+ * 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;
+
+       /* 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);
 }