2 * @brief Entry point for the model checker.
13 /* global "model" object */
16 #include "snapshot-interface.h"
17 #include "scanalysis.h"
19 static void param_defaults(struct model_params *params)
22 params->maxfuturedelay = 6;
23 params->fairwindow = 0;
24 params->yieldon = false;
25 params->yieldblock = false;
26 params->sc_trace_analysis = false;
27 params->enabledcount = 1;
29 params->maxfuturevalues = 0;
30 params->expireslop = 4;
31 params->verbose = !!DBG_ENABLED();
32 params->uninitvalue = 0;
35 static void print_usage(const char *program_name, struct model_params *params)
37 /* Reset defaults before printing */
38 param_defaults(params);
41 "Copyright (c) 2013 Regents of the University of California. All rights reserved.\n"
42 "Distributed under the GPLv2\n"
43 "Written by Brian Norris and Brian Demsky\n"
45 "Usage: %s [MODEL-CHECKER OPTIONS] -- [PROGRAM ARGS]\n"
47 "MODLE-CHECKER OPTIONS can be any of the model-checker options listed below. Arguments\n"
48 "provided after the `--' (the PROGRAM ARGS) are passed to the user program.\n"
50 "Model-checker options:\n"
51 "-h, --help Display this help message and exit\n"
52 "-m, --liveness=NUM Maximum times a thread can read from the same write\n"
53 " while other writes exist.\n"
55 "-M, --maxfv=NUM Maximum number of future values that can be sent to\n"
58 "-s, --maxfvdelay=NUM Maximum actions that the model checker will wait for\n"
59 " a write from the future past the expected number\n"
62 "-S, --fvslop=NUM Future value expiration sloppiness.\n"
64 "-y, --yield Enable CHESS-like yield-based fairness support.\n"
66 "-Y, --yieldblock Prohibit an execution from running a yield.\n"
68 "-f, --fairness=WINDOW Specify a fairness window in which actions that are\n"
69 " enabled sufficiently many times should receive\n"
70 " priority for execution (not recommended).\n"
72 "-e, --enabled=COUNT Enabled count.\n"
74 "-b, --bound=MAX Upper length bound.\n"
76 "-v, --verbose Print verbose execution information.\n"
77 "-u, --uninitialized=VALUE Return VALUE any load which may read from an\n"
78 " uninitialized atomic.\n"
80 "-c, --analysis Use SC Trace Analysis.\n"
81 " -- Program arguments follow.\n\n",
84 params->maxfuturevalues,
85 params->maxfuturedelay,
87 params->yieldon ? "enabled" : "disabled",
88 params->yieldblock ? "enabled" : "disabled",
96 static void parse_options(struct model_params *params, int argc, char **argv)
98 const char *shortopts = "hyYcm:M:s:S:f:e:b:u:v::";
99 const struct option longopts[] = {
100 {"help", no_argument, NULL, 'h'},
101 {"liveness", required_argument, NULL, 'm'},
102 {"maxfv", required_argument, NULL, 'M'},
103 {"maxfvdelay", required_argument, NULL, 's'},
104 {"fvslop", required_argument, NULL, 'S'},
105 {"fairness", required_argument, NULL, 'f'},
106 {"yield", no_argument, NULL, 'y'},
107 {"yieldblock", no_argument, NULL, 'Y'},
108 {"enabled", required_argument, NULL, 'e'},
109 {"bound", required_argument, NULL, 'b'},
110 {"verbose", optional_argument, NULL, 'v'},
111 {"uninitialized", optional_argument, NULL, 'u'},
112 {"analysis", optional_argument, NULL, 'c'},
113 {0, 0, 0, 0} /* Terminator */
117 while (!error && (opt = getopt_long(argc, argv, shortopts, longopts, &longindex)) != -1) {
120 print_usage(argv[0], params);
123 params->maxfuturedelay = atoi(optarg);
126 params->expireslop = atoi(optarg);
129 params->fairwindow = atoi(optarg);
132 params->enabledcount = atoi(optarg);
135 params->bound = atoi(optarg);
138 params->maxreads = atoi(optarg);
141 params->maxfuturevalues = atoi(optarg);
144 params->verbose = optarg ? atoi(optarg) : 1;
147 params->uninitvalue = atoi(optarg);
150 params->sc_trace_analysis = true;
153 params->yieldon = true;
156 params->yieldblock = true;
164 /* Pass remaining arguments to user program */
165 params->argc = argc - (optind - 1);
166 params->argv = argv + (optind - 1);
168 /* Reset program name */
169 params->argv[0] = argv[0];
171 /* Reset (global) optind for potential use by user program */
175 print_usage(argv[0], params);
181 static void install_trace_analyses(const ModelExecution *execution)
183 if (model->params.sc_trace_analysis)
184 model->add_trace_analysis(new SCAnalysis(execution));
187 /** The model_main function contains the main model checking loop. */
188 static void model_main()
190 struct model_params params;
192 param_defaults(¶ms);
194 parse_options(¶ms, main_argc, main_argv);
196 //Initialize race detector
199 snapshot_stack_init();
201 model = new ModelChecker(params);
202 install_trace_analyses(model->get_execution());
212 * Main function. Just initializes snapshotting library and the
213 * snapshotting library calls the model_main function.
215 int main(int argc, char **argv)
220 /* Configure output redirection for the model-checker */
223 /* Let's jump in quickly and start running stuff */
224 snapshot_system_init(10000, 1024, 1024, 4000, &model_main);