main.cc

   1 /** @file main.cc
   2  *  @brief Entry point for the model checker.
   3  */
   4
   5 #include <unistd.h>
   6
   7 #include "common.h"
   8 #include "output.h"
   9
  10 #include "datarace.h"
  11
  12 /* global "model" object */
  13 #include "model.h"
  14 #include "snapshot-interface.h"
  15
  16 static void param_defaults(struct model_params *params)
  17 {
  18         params->maxreads = 0;
  19         params->maxfuturedelay = 100;
  20         params->fairwindow = 0;
  21         params->yieldon = false;
  22         params->enabledcount = 1;
  23         params->bound = 0;
  24         params->maxfuturevalues = 0;
  25         params->expireslop = 10;
  26         params->verbose = !!DBG_ENABLED();
  27 }
  28
  29 static void print_usage(struct model_params *params)
  30 {
  31         /* Reset defaults before printing */
  32         param_defaults(params);
  33
  34         model_print(
  35 "Usage: <program name> [MC_OPTIONS] -- [PROGRAM ARGUMENTS]\n"
  36 "\n"
  37 "Options:\n"
  38 "-h                    Display this help message and exit\n"
  39 "-m                    Maximum times a thread can read from the same write\n"
  40 "                      while other writes exist. Default: %d\n"
  41 "-M                    Maximum number of future values that can be sent to\n"
  42 "                      the same read. Default: %d\n"
  43 "-s                    Maximum actions that the model checker will wait for\n"
  44 "                      a write from the future past the expected number of\n"
  45 "                      actions. Default: %d\n"
  46 "-S                    Future value expiration sloppiness. Default: %u\n"
  47 "-f                    Specify a fairness window in which actions that are\n"
  48 "                      enabled sufficiently many times should receive\n"
  49 "                      priority for execution. Default: %d\n"
  50 "-y                    Turn on CHESS yield-based fairness support.\n"
  51 "                      Default: %d\n"
  52 "-e                    Enabled count. Default: %d\n"
  53 "-b                    Upper length bound. Default: %d\n"
  54 "-v                    Print verbose execution information.\n"
  55 "--                    Program arguments follow.\n\n",
  56 params->maxreads, params->maxfuturevalues, params->maxfuturedelay, params->expireslop, params->fairwindow, params->yieldon, params->enabledcount, params->bound);
  57         exit(EXIT_SUCCESS);
  58 }
  59
  60 static void parse_options(struct model_params *params, int argc, char **argv)
  61 {
  62         const char *shortopts = "hym:M:s:S:f:e:b:v";
  63         int opt;
  64         bool error = false;
  65         while (!error && (opt = getopt(argc, argv, shortopts)) != -1) {
  66                 switch (opt) {
  67                 case 'h':
  68                         print_usage(params);
  69                         break;
  70                 case 's':
  71                         params->maxfuturedelay = atoi(optarg);
  72                         break;
  73                 case 'S':
  74                         params->expireslop = atoi(optarg);
  75                         break;
  76                 case 'f':
  77                         params->fairwindow = atoi(optarg);
  78                         break;
  79                 case 'e':
  80                         params->enabledcount = atoi(optarg);
  81                         break;
  82                 case 'b':
  83                         params->bound = atoi(optarg);
  84                         break;
  85                 case 'm':
  86                         params->maxreads = atoi(optarg);
  87                         break;
  88                 case 'M':
  89                         params->maxfuturevalues = atoi(optarg);
  90                         break;
  91                 case 'v':
  92                         params->verbose = 1;
  93                         break;
  94                 case 'y':
  95                         params->yieldon = true;
  96                         break;
  97                 default: /* '?' */
  98                         error = true;
  99                         break;
 100                 }
 101         }
 102
 103         /* Pass remaining arguments to user program */
 104         params->argc = argc - (optind - 1);
 105         params->argv = argv + (optind - 1);
 106
 107         /* Reset program name */
 108         params->argv[0] = argv[0];
 109
 110         /* Reset (global) optind for potential use by user program */
 111         optind = 1;
 112
 113         if (error)
 114                 print_usage(params);
 115 }
 116
 117 int main_argc;
 118 char **main_argv;
 119
 120 /** The model_main function contains the main model checking loop. */
 121 static void model_main()
 122 {
 123         struct model_params params;
 124
 125         param_defaults(&params);
 126
 127         parse_options(&params, main_argc, main_argv);
 128
 129         //Initialize race detector
 130         initRaceDetector();
 131
 132         snapshot_stack_init();
 133
 134         model = new ModelChecker(params);
 135         snapshot_record(0);
 136         model->run();
 137         delete model;
 138
 139         DEBUG("Exiting\n");
 140 }
 141
 142 /**
 143  * Main function.  Just initializes snapshotting library and the
 144  * snapshotting library calls the model_main function.
 145  */
 146 int main(int argc, char **argv)
 147 {
 148         main_argc = argc;
 149         main_argv = argv;
 150
 151         /* Configure output redirection for the model-checker */
 152         redirect_output();
 153
 154         /* Let's jump in quickly and start running stuff */
 155         snapshot_system_init(10000, 1024, 1024, 4000, &model_main);
 156 }