main.cc

   1 /** @file main.cc
   2  *  @brief Entry point for the model checker.
   3  */
   4
   5 #include <unistd.h>
   6 #include <getopt.h>
   7 #include <string.h>
   8
   9 #include "common.h"
  10 #include "output.h"
  11
  12 #include "datarace.h"
  13
  14 /* global "model" object */
  15 #include "model.h"
  16 #include "params.h"
  17 #include "snapshot-interface.h"
  18
  19 static void param_defaults(struct model_params *params)
  20 {
  21         params->maxreads = 0;
  22         params->maxfuturedelay = 6;
  23         params->fairwindow = 0;
  24         params->yieldon = false;
  25         params->yieldblock = false;
  26         params->enabledcount = 1;
  27         params->bound = 0;
  28         params->maxfuturevalues = 0;
  29         params->expireslop = 4;
  30         params->verbose = !!DBG_ENABLED();
  31         params->uninitvalue = 0;
  32         params->maxexecutions = 0;
  33 }
  34
  35 static void print_usage(const char *program_name, struct model_params *params)
  36 {
  37         /* Reset defaults before printing */
  38         param_defaults(params);
  39
  40         model_print(
  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"
  44 "\n"
  45 "Usage: %s [MODEL-CHECKER OPTIONS] -- [PROGRAM ARGS]\n"
  46 "\n"
  47 "MODEL-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"
  49 "\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"
  54 "                              Default: %d\n"
  55 "-M, --maxfv=NUM             Maximum number of future values that can be sent to\n"
  56 "                              the same read.\n"
  57 "                              Default: %d\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"
  60 "                              of actions.\n"
  61 "                              Default: %d\n"
  62 "-S, --fvslop=NUM            Future value expiration sloppiness.\n"
  63 "                              Default: %u\n"
  64 "-y, --yield                 Enable CHESS-like yield-based fairness support\n"
  65 "                              (requires thrd_yield() in test program).\n"
  66 "                              Default: %s\n"
  67 "-Y, --yieldblock            Prohibit an execution from running a yield.\n"
  68 "                              Default: %s\n"
  69 "-f, --fairness=WINDOW       Specify a fairness window in which actions that are\n"
  70 "                              enabled sufficiently many times should receive\n"
  71 "                              priority for execution (not recommended).\n"
  72 "                              Default: %d\n"
  73 "-e, --enabled=COUNT         Enabled count.\n"
  74 "                              Default: %d\n"
  75 "-b, --bound=MAX             Upper length bound.\n"
  76 "                              Default: %d\n"
  77 "-v[NUM], --verbose[=NUM]    Print verbose execution information. NUM is optional:\n"
  78 "                              0 is quiet; 1 shows valid executions; 2 is noisy;\n"
  79 "                              3 is noisier.\n"
  80 "                              Default: %d\n"
  81 "-u, --uninitialized=VALUE   Return VALUE any load which may read from an\n"
  82 "                              uninitialized atomic.\n"
  83 "                              Default: %u\n"
  84 "-t, --analysis=NAME         Use Analysis Plugin.\n"
  85 "-o, --options=NAME          Option for previous analysis plugin.  \n"
  86 "-x, --maxexec=NUM           Maximum number of executions.\n"
  87 "                            Default: %u\n"
  88 "                            -o help for a list of options\n"
  89 " --                         Program arguments follow.\n\n",
  90                 program_name,
  91                 params->maxreads,
  92                 params->maxfuturevalues,
  93                 params->maxfuturedelay,
  94                 params->expireslop,
  95                 params->yieldon ? "enabled" : "disabled",
  96                 params->yieldblock ? "enabled" : "disabled",
  97                 params->fairwindow,
  98                 params->enabledcount,
  99                 params->bound,
 100                 params->verbose,
 101     params->uninitvalue,
 102                 params->maxexecutions);
 103
 104         exit(EXIT_SUCCESS);
 105 }
 106
 107 static void parse_options(struct model_params *params, int argc, char **argv)
 108 {
 109         const char *shortopts = "hyYt:o:m:M:s:S:f:e:b:u:x:v::";
 110         const struct option longopts[] = {
 111                 {"help", no_argument, NULL, 'h'},
 112                 {"liveness", required_argument, NULL, 'm'},
 113                 {"maxfv", required_argument, NULL, 'M'},
 114                 {"maxfvdelay", required_argument, NULL, 's'},
 115                 {"fvslop", required_argument, NULL, 'S'},
 116                 {"fairness", required_argument, NULL, 'f'},
 117                 {"yield", no_argument, NULL, 'y'},
 118                 {"yieldblock", no_argument, NULL, 'Y'},
 119                 {"enabled", required_argument, NULL, 'e'},
 120                 {"bound", required_argument, NULL, 'b'},
 121                 {"verbose", optional_argument, NULL, 'v'},
 122                 {"uninitialized", required_argument, NULL, 'u'},
 123                 {"analysis", required_argument, NULL, 't'},
 124                 {"options", required_argument, NULL, 'o'},
 125                 {"maxexecutions", required_argument, NULL, 'x'},
 126                 {0, 0, 0, 0} /* Terminator */
 127         };
 128         int opt, longindex;
 129         bool error = false;
 130         while (!error && (opt = getopt_long(argc, argv, shortopts, longopts, &longindex)) != -1) {
 131                 switch (opt) {
 132                 case 'h':
 133                         print_usage(argv[0], params);
 134                         break;
 135                 case 'x':
 136                         params->maxexecutions = atoi(optarg);
 137                         break;
 138                 case 's':
 139                         params->maxfuturedelay = atoi(optarg);
 140                         break;
 141                 case 'S':
 142                         params->expireslop = atoi(optarg);
 143                         break;
 144                 case 'f':
 145                         params->fairwindow = atoi(optarg);
 146                         break;
 147                 case 'e':
 148                         params->enabledcount = atoi(optarg);
 149                         break;
 150                 case 'b':
 151                         params->bound = atoi(optarg);
 152                         break;
 153                 case 'm':
 154                         params->maxreads = atoi(optarg);
 155                         break;
 156                 case 'M':
 157                         params->maxfuturevalues = atoi(optarg);
 158                         break;
 159                 case 'v':
 160                         params->verbose = optarg ? atoi(optarg) : 1;
 161                         break;
 162                 case 'u':
 163                         params->uninitvalue = atoi(optarg);
 164                         break;
 165                 case 'y':
 166                         params->yieldon = true;
 167                         break;
 168 /**             case 't':
 169                         if (install_plugin(optarg))
 170                                 error = true;
 171                         break;
 172                 case 'o':
 173                         {
 174                                 ModelVector<TraceAnalysis *> * analyses = getInstalledTraceAnalysis();
 175                                 if ( analyses->size() == 0 || (*analyses)[analyses->size()-1]->option(optarg))
 176                                         error = true;
 177                         }
 178                         break;
 179 */
 180                 case 'Y':
 181                         params->yieldblock = true;
 182                         break;
 183                 default: /* '?' */
 184                         error = true;
 185                         break;
 186                 }
 187         }
 188
 189         /* Pass remaining arguments to user program */
 190         params->argc = argc - (optind - 1);
 191         params->argv = argv + (optind - 1);
 192
 193         /* Reset program name */
 194         params->argv[0] = argv[0];
 195
 196         /* Reset (global) optind for potential use by user program */
 197         optind = 1;
 198
 199         if (error)
 200                 print_usage(argv[0], params);
 201 }
 202
 203 int main_argc;
 204 char **main_argv;
 205
 206 /** The model_main function contains the main model checking loop. */
 207 static void model_main()
 208 {
 209         struct model_params params;
 210
 211         param_defaults(&params);
 212
 213         parse_options(&params, main_argc, main_argv);
 214
 215         //Initialize race detector
 216         initRaceDetector();
 217
 218         snapshot_stack_init();
 219
 220         model = new ModelChecker(params);       // L: Model thread is created
 221 //      install_trace_analyses(model->get_execution());         L: disable plugin
 222
 223         snapshot_record(0);
 224         model->run();
 225         delete model;
 226
 227         DEBUG("Exiting\n");
 228 }
 229
 230 /**
 231  * Main function.  Just initializes snapshotting library and the
 232  * snapshotting library calls the model_main function.
 233  */
 234 int main(int argc, char **argv)
 235 {
 236         main_argc = argc;
 237         main_argv = argv;
 238
 239         /*
 240          * If this printf statement is removed, CDSChecker will fail on an
 241          * assert on some versions of glibc.  The first time printf is
 242          * called, it allocated internal buffers.  We can't easily snapshot
 243          * libc since we also use it.
 244          */
 245
 246         printf("CDSChecker\n"
 247                                  "Copyright (c) 2013 Regents of the University of California. All rights reserved.\n"
 248                                  "Distributed under the GPLv2\n"
 249                                  "Written by Brian Norris and Brian Demsky\n\n");
 250
 251         /* Configure output redirection for the model-checker */
 252         redirect_output();
 253
 254         /* Let's jump in quickly and start running stuff */
 255         snapshot_system_init(10000, 1024, 1024, 4000, &model_main);
 256 }