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 #include "plugins.h"
  19
  20 void param_defaults(struct model_params *params)
  21 {
  22         params->verbose = !!DBG_ENABLED();
  23         params->uninitvalue = 0;
  24         params->maxexecutions = 10;
  25         params->nofork = false;
  26 }
  27
  28 static void print_usage(struct model_params *params)
  29 {
  30         ModelVector<TraceAnalysis *> * registeredanalysis=getRegisteredTraceAnalysis();
  31         /* Reset defaults before printing */
  32         param_defaults(params);
  33
  34         model_print(
  35                 "Copyright (c) 2013 Regents of the University of California. All rights reserved.\n"
  36                 "Distributed under the GPLv2\n"
  37                 "Written by Brian Norris and Brian Demsky\n"
  38                 "\n"
  39                 "Usage: C11TESTER=[MODEL-CHECKER OPTIONS]\n"
  40                 "\n"
  41                 "MODEL-CHECKER OPTIONS can be any of the model-checker options listed below. Arguments\n"
  42                 "provided after the `--' (the PROGRAM ARGS) are passed to the user program.\n"
  43                 "\n"
  44                 "Model-checker options:\n"
  45                 "-h, --help                  Display this help message and exit\n"
  46                 "-v[NUM], --verbose[=NUM]    Print verbose execution information. NUM is optional:\n"
  47                 "                              0 is quiet; 1 shows valid executions; 2 is noisy;\n"
  48                 "                              3 is noisier.\n"
  49                 "                              Default: %d\n"
  50                 "-u, --uninitialized=VALUE   Return VALUE any load which may read from an\n"
  51                 "                              uninitialized atomic.\n"
  52                 "                              Default: %u\n"
  53                 "-t, --analysis=NAME         Use Analysis Plugin.\n"
  54                 "-o, --options=NAME          Option for previous analysis plugin.  \n"
  55                 "-x, --maxexec=NUM           Maximum number of executions.\n"
  56                 "                            Default: %u\n"
  57                 "                            -o help for a list of options\n"
  58                 "-n                          No fork\n\n",
  59                 params->verbose,
  60                 params->uninitvalue,
  61                 params->maxexecutions);
  62         model_print("Analysis plugins:\n");
  63         for(unsigned int i=0;i<registeredanalysis->size();i++) {
  64                 TraceAnalysis * analysis=(*registeredanalysis)[i];
  65                 model_print("%s\n", analysis->name());
  66         }
  67         exit(EXIT_SUCCESS);
  68 }
  69
  70 bool install_plugin(char * name) {
  71         ModelVector<TraceAnalysis *> * registeredanalysis=getRegisteredTraceAnalysis();
  72         ModelVector<TraceAnalysis *> * installedanalysis=getInstalledTraceAnalysis();
  73
  74         for(unsigned int i=0;i<registeredanalysis->size();i++) {
  75                 TraceAnalysis * analysis=(*registeredanalysis)[i];
  76                 if (strcmp(name, analysis->name())==0) {
  77                         installedanalysis->push_back(analysis);
  78                         return false;
  79                 }
  80         }
  81         model_print("Analysis %s Not Found\n", name);
  82         return true;
  83 }
  84
  85 void parse_options(struct model_params *params) {
  86         const char *shortopts = "hnt:o:u:x:v::";
  87         const struct option longopts[] = {
  88                 {"help", no_argument, NULL, 'h'},
  89                 {"verbose", optional_argument, NULL, 'v'},
  90                 {"uninitialized", required_argument, NULL, 'u'},
  91                 {"analysis", required_argument, NULL, 't'},
  92                 {"options", required_argument, NULL, 'o'},
  93                 {"maxexecutions", required_argument, NULL, 'x'},
  94                 {0, 0, 0, 0}    /* Terminator */
  95         };
  96         int opt, longindex;
  97         int tmpoptind = optind;
  98         bool error = false;
  99         char * options = getenv("C11TESTER");
 100
 101         if (options == NULL)
 102                 return;
 103         int argc = 1;
 104         int index;
 105         for(index = 0;options[index]!=0;index++) {
 106                 if (options[index] == ' ')
 107                         argc++;
 108         }
 109         argc++; //first parameter is executable name
 110         char optcpy[index + 1];
 111         memcpy(optcpy, options, index+1);
 112         char * argv[argc + 1];
 113         argv[0] = NULL;
 114         argv[1] = optcpy;
 115         int count = 2;
 116         for(index = 0;optcpy[index]!=0;index++) {
 117                 if (optcpy[index] == ' ') {
 118                         argv[count++] = &optcpy[index+1];
 119                         optcpy[index] = 0;
 120                 }
 121         }
 122
 123         while (!error && (opt = getopt_long(argc, argv, shortopts, longopts, &longindex)) != -1) {
 124                 switch (opt) {
 125                 case 'h':
 126                         print_usage(params);
 127                         break;
 128                 case 'n':
 129                         params->nofork = true;
 130                         break;
 131                 case 'x':
 132                         params->maxexecutions = atoi(optarg);
 133                         break;
 134                 case 'v':
 135                         params->verbose = optarg ? atoi(optarg) : 1;
 136                         break;
 137                 case 'u':
 138                         params->uninitvalue = atoi(optarg);
 139                         break;
 140                 case 't':
 141                         if (install_plugin(optarg))
 142                                 error = true;
 143                         break;
 144                 case 'o':
 145                 {
 146                         ModelVector<TraceAnalysis *> * analyses = getInstalledTraceAnalysis();
 147                         if ( analyses->size() == 0 || (*analyses)[analyses->size()-1]->option(optarg))
 148                                 error = true;
 149                 }
 150                 break;
 151                 default:        /* '?' */
 152                         error = true;
 153                         break;
 154                 }
 155         }
 156
 157         /* Restore (global) optind for potential use by user program */
 158         optind = tmpoptind;
 159
 160         if (error)
 161                 print_usage(params);
 162 }
 163
 164 void install_trace_analyses(ModelExecution *execution) {
 165         ModelVector<TraceAnalysis *> * installedanalysis=getInstalledTraceAnalysis();
 166         for(unsigned int i=0;i<installedanalysis->size();i++) {
 167                 TraceAnalysis * ta=(*installedanalysis)[i];
 168                 ta->setExecution(execution);
 169                 model->add_trace_analysis(ta);
 170                 /** Call the installation event for each installed plugin */
 171                 ta->actionAtInstallation();
 172         }
 173 }