smatch.c

   1 /*
   2  * Copyright (C) 2006 Dan Carpenter.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, see http://www.gnu.org/copyleft/gpl.txt
  16  */
  17
  18 #include <stdio.h>
  19 #include <unistd.h>
  20 #include <libgen.h>
  21 #include "smatch.h"
  22 #include "check_list.h"
  23
  24 char *option_debug_check = (char *)"";
  25 char *option_project_str = (char *)"";
  26 enum project_type option_project = PROJ_NONE;
  27 char *data_dir;
  28 int option_no_data = 0;
  29 int option_spammy = 0;
  30 int option_info = 0;
  31 int option_full_path = 0;
  32 int option_param_mapper = 0;
  33 int option_call_tree = 0;
  34 int option_no_db = 0;
  35 int option_debug_related;
  36 int option_file_output;
  37 int option_time;
  38 char *option_datadir_str;
  39 FILE *sm_outfd;
  40
  41 typedef void (*reg_func) (int id);
  42 #define CK(_x) {.name = #_x, .func = &_x},
  43 static struct reg_func_info {
  44         const char *name;
  45         reg_func func;
  46 } reg_funcs[] = {
  47 #include "check_list.h"
  48 };
  49 #undef CK
  50 int num_checks = ARRAY_SIZE(reg_funcs);
  51
  52 const char *check_name(unsigned short id)
  53 {
  54         if (id > ARRAY_SIZE(reg_funcs))
  55                 return "internal";
  56
  57         return reg_funcs[id - 1].name;
  58 }
  59
  60 int id_from_name(const char *name)
  61 {
  62         int i;
  63
  64         for (i = 0; i < ARRAY_SIZE(reg_funcs); i++) {
  65                 if (!strcmp(name, reg_funcs[i].name))
  66                         return i + 1;
  67         }
  68         return 0;
  69 }
  70
  71 static void help(void)
  72 {
  73         printf("Usage:  smatch [smatch arguments][sparse arguments] file.c\n");
  74         printf("--project=<name> or -p=<name>: project specific tests\n");
  75         printf("--spammy:  print superfluous crap.\n");
  76         printf("--info:  print info used to fill smatch_data/.\n");
  77         printf("--debug:  print lots of debug output.\n");
  78         printf("--param-mapper:  enable param_mapper output.\n");
  79         printf("--no-data:  do not use the /smatch_data/ directory.\n");
  80         printf("--data=<dir>: overwrite path to default smatch data directory.\n");
  81         printf("--full-path:  print the full pathname.\n");
  82         printf("--debug-implied:  print debug output about implications.\n");
  83         printf("--no-implied:  ignore implications.\n");
  84         printf("--assume-loops:  assume loops always go through at least once.\n");
  85         printf("--known-conditions:  don't branch for known conditions.\n");
  86         printf("--two-passes:  use a two pass system for each function.\n");
  87         printf("--file-output:  instead of printing stdout, print to \"file.c.smatch_out\".\n");
  88         printf("--help:  print this helpful message.\n");
  89         exit(1);
  90 }
  91
  92 static int match_option(const char *arg, const char *option)
  93 {
  94         char *str;
  95         char *tmp;
  96         int ret = 0;
  97
  98         str = malloc(strlen(option) + 3);
  99         snprintf(str, strlen(option) + 3, "--%s", option);
 100         tmp = str;
 101         while (*tmp) {
 102                 if (*tmp == '_')
 103                         *tmp = '-';
 104                 tmp++;
 105         }
 106         if (!strcmp(arg, str))
 107                 ret = 1;
 108         free(str);
 109         return ret;
 110 }
 111
 112 #define OPTION(_x) do {                                 \
 113         if (!found && match_option((*argvp)[1], #_x)) { \
 114                 found = 1;                              \
 115                 option_##_x = 1;                                        \
 116                 (*argvp)[1] = (*argvp)[0];              \
 117         }                                               \
 118 } while (0)
 119
 120 void parse_args(int *argcp, char ***argvp)
 121 {
 122         while (*argcp >= 2) {
 123                 int found = 0;
 124                 if (!strcmp((*argvp)[1], "--help"))
 125                         help();
 126
 127                 if (!found && !strncmp((*argvp)[1], "--project=", 10)) {
 128                         option_project_str = (*argvp)[1] + 10;
 129                         (*argvp)[1] = (*argvp)[0];
 130                         found = 1;
 131                 }
 132                 if (!found && !strncmp((*argvp)[1], "-p=", 3)) {
 133                         option_project_str = (*argvp)[1] + 3;
 134                         (*argvp)[1] = (*argvp)[0];
 135                         found = 1;
 136                 }
 137                 if (!found && !strncmp((*argvp)[1], "--data=", 7)) {
 138                         option_datadir_str = (*argvp)[1] + 7;
 139                         (*argvp)[1] = (*argvp)[0];
 140                         found = 1;
 141                 }
 142                 if (!found && !strncmp((*argvp)[1], "--debug=", 8)) {
 143                         option_debug_check = (*argvp)[1] + 8;
 144                         (*argvp)[1] = (*argvp)[0];
 145                         found = 1;
 146                 }
 147
 148                 OPTION(spammy);
 149                 OPTION(info);
 150                 OPTION(debug);
 151                 OPTION(debug_implied);
 152                 OPTION(debug_related);
 153                 OPTION(no_implied);
 154                 OPTION(assume_loops);
 155                 OPTION(known_conditions);
 156                 OPTION(no_data);
 157                 OPTION(two_passes);
 158                 OPTION(full_path);
 159                 OPTION(param_mapper);
 160                 OPTION(call_tree);
 161                 OPTION(file_output);
 162                 OPTION(time);
 163                 if (!found)
 164                         break;
 165                 (*argcp)--;
 166                 (*argvp)++;
 167         }
 168
 169         if (!strcmp(option_project_str, "kernel"))
 170                 option_project = PROJ_KERNEL;
 171         if (!strcmp(option_project_str, "wine"))
 172                 option_project = PROJ_WINE;
 173 }
 174
 175 static char *get_data_dir(char *arg0)
 176 {
 177         char *bin_dir;
 178         char *orig;
 179         char buf[256];
 180         char *dir;
 181
 182         if (option_no_data)
 183                 return NULL;
 184
 185         if (option_datadir_str) {
 186                 if (access(option_datadir_str, R_OK))
 187                         printf("Warning: %s is not accessible -- ignore.\n",
 188                                         option_datadir_str);
 189                 else
 190                         return alloc_string(option_datadir_str);
 191         }
 192
 193         orig = alloc_string(arg0);
 194         bin_dir = dirname(orig);
 195         strncpy(buf, bin_dir, 254);
 196         free_string(orig);
 197
 198         buf[255] = '\0';
 199         strncat(buf, "/smatch_data/", 254 - strlen(buf));
 200         dir = alloc_string(buf);
 201         if (!access(dir, R_OK))
 202                 return dir;
 203         free_string(dir);
 204         snprintf(buf, 254, "%s/smatch_data/", SMATCHDATADIR);
 205         dir = alloc_string(buf);
 206         if (!access(dir, R_OK))
 207                 return dir;
 208
 209         printf("Warning: %s is not accessible.\n", dir);
 210         printf("Use --no-data or --data to suppress this message.\n");
 211         return NULL;
 212 }
 213
 214 int main(int argc, char **argv)
 215 {
 216         int i;
 217         reg_func func;
 218
 219         sm_outfd = stdout;
 220         parse_args(&argc, &argv);
 221
 222         /* this gets set back to zero when we parse the first function */
 223         final_pass = 1;
 224
 225         data_dir = get_data_dir(argv[0]);
 226
 227         create_function_hook_hash();
 228         open_smatch_db();
 229         for (i = 0; i < ARRAY_SIZE(reg_funcs); i++) {
 230                 func = reg_funcs[i].func;
 231                 /* The script IDs start at 1.
 232                    0 is used for internal stuff. */
 233                 func(i + 1);
 234         }
 235
 236         smatch(argc, argv);
 237         free_string(data_dir);
 238         return 0;
 239 }