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 *)"smatch_generic";
  26 static char *option_db_file = (char *)"smatch_db.sqlite";
  27 enum project_type option_project = PROJ_NONE;
  28 char *bin_dir;
  29 char *data_dir;
  30 int option_no_data = 0;
  31 int option_spammy = 0;
  32 int option_info = 0;
  33 int option_full_path = 0;
  34 int option_param_mapper = 0;
  35 int option_call_tree = 0;
  36 int option_no_db = 0;
  37 int option_enable = 0;
  38 int option_debug_related;
  39 int option_file_output;
  40 int option_time;
  41 int option_mem;
  42 char *option_datadir_str;
  43 FILE *sm_outfd;
  44 FILE *sql_outfd;
  45 FILE *caller_info_fd;
  46
  47 bool __silence_warnings_for_stmt;
  48
  49 typedef void (*reg_func) (int id);
  50 #define CK(_x) {.name = #_x, .func = &_x, .enabled = 0},
  51 static struct reg_func_info {
  52         const char *name;
  53         reg_func func;
  54         int enabled;
  55 } reg_funcs[] = {
  56         {NULL, NULL},
  57 #include "check_list.h"
  58 };
  59 #undef CK
  60 int num_checks = ARRAY_SIZE(reg_funcs) - 1;
  61
  62 const char *check_name(unsigned short id)
  63 {
  64         if (id >= ARRAY_SIZE(reg_funcs))
  65                 return "internal";
  66
  67         return reg_funcs[id].name;
  68 }
  69
  70 int id_from_name(const char *name)
  71 {
  72         int i;
  73
  74         for (i = 1; i < ARRAY_SIZE(reg_funcs); i++) {
  75                 if (!strcmp(name, reg_funcs[i].name))
  76                         return i;
  77         }
  78         return 0;
  79 }
  80
  81 static void show_checks(void)
  82 {
  83         int i;
  84
  85         for (i = 1; i < ARRAY_SIZE(reg_funcs); i++) {
  86                 if (!strncmp(reg_funcs[i].name, "check_", 6))
  87                         printf("%3d. %s\n", i, reg_funcs[i].name);
  88         }
  89         exit(1);
  90 }
  91 static void enable_check(int i)
  92 {
  93         if (1 <= i && i < ARRAY_SIZE(reg_funcs))
  94                 reg_funcs[i].enabled = 1;
  95 }
  96
  97 static void enable_checks(const char *s)
  98 {
  99         int n = 0, lo = -1, i;
 100
 101         do {
 102                 switch (*s) {
 103                 case ',':
 104                 case '\0':
 105                         if (lo < 0)
 106                                 enable_check(n);
 107                         else
 108                                 for (i = lo; i <= n; ++i)
 109                                         enable_check(i);
 110                         lo = -1;
 111                         n = 0;
 112                         break;
 113                 case '-':
 114                         lo = n;
 115                         n = 0;
 116                         break;
 117                 case '0' ... '9':
 118                         n = 10*n + (*s - '0');
 119                         break;
 120                 default:
 121                         fprintf(stderr, "invalid character '%c'\n", *s);
 122                         exit(1);
 123                 }
 124         } while (*s++);
 125 }
 126
 127 static void help(void)
 128 {
 129         printf("Usage:  smatch [smatch arguments][sparse arguments] file.c\n");
 130         printf("--project=<name> or -p=<name>: project specific tests\n");
 131         printf("--spammy:  print superfluous crap.\n");
 132         printf("--info:  print info used to fill smatch_data/.\n");
 133         printf("--debug:  print lots of debug output.\n");
 134         printf("--param-mapper:  enable param_mapper output.\n");
 135         printf("--no-data:  do not use the /smatch_data/ directory.\n");
 136         printf("--data=<dir>: overwrite path to default smatch data directory.\n");
 137         printf("--full-path:  print the full pathname.\n");
 138         printf("--debug-implied:  print debug output about implications.\n");
 139         printf("--assume-loops:  assume loops always go through at least once.\n");
 140         printf("--two-passes:  use a two pass system for each function.\n");
 141         printf("--file-output:  instead of printing stdout, print to \"file.c.smatch_out\".\n");
 142         printf("--help:  print this helpful message.\n");
 143         exit(1);
 144 }
 145
 146 static int match_option(const char *arg, const char *option)
 147 {
 148         char *str;
 149         char *tmp;
 150         int ret = 0;
 151
 152         str = malloc(strlen(option) + 3);
 153         snprintf(str, strlen(option) + 3, "--%s", option);
 154         tmp = str;
 155         while (*tmp) {
 156                 if (*tmp == '_')
 157                         *tmp = '-';
 158                 tmp++;
 159         }
 160         if (!strcmp(arg, str))
 161                 ret = 1;
 162         free(str);
 163         return ret;
 164 }
 165
 166 #define OPTION(_x) do {                                 \
 167         if (!found && match_option((*argvp)[1], #_x)) { \
 168                 found = 1;                              \
 169                 option_##_x = 1;                                        \
 170                 (*argvp)[1] = (*argvp)[0];              \
 171         }                                               \
 172 } while (0)
 173
 174 void parse_args(int *argcp, char ***argvp)
 175 {
 176         while (*argcp >= 2) {
 177                 int found = 0;
 178                 if (!strcmp((*argvp)[1], "--help"))
 179                         help();
 180
 181                 if (!strcmp((*argvp)[1], "--show-checks"))
 182                         show_checks();
 183
 184                 if (!found && !strncmp((*argvp)[1], "--project=", 10)) {
 185                         option_project_str = (*argvp)[1] + 10;
 186                         (*argvp)[1] = (*argvp)[0];
 187                         found = 1;
 188                 }
 189                 if (!found && !strncmp((*argvp)[1], "-p=", 3)) {
 190                         option_project_str = (*argvp)[1] + 3;
 191                         (*argvp)[1] = (*argvp)[0];
 192                         found = 1;
 193                 }
 194                 if (!found && !strncmp((*argvp)[1], "--db-file=", 10)) {
 195                         option_db_file = (*argvp)[1] + 10;
 196                         (*argvp)[1] = (*argvp)[0];
 197                         found = 1;
 198                 }
 199                 if (!found && !strncmp((*argvp)[1], "--data=", 7)) {
 200                         option_datadir_str = (*argvp)[1] + 7;
 201                         (*argvp)[1] = (*argvp)[0];
 202                         found = 1;
 203                 }
 204                 if (!found && !strncmp((*argvp)[1], "--debug=", 8)) {
 205                         option_debug_check = (*argvp)[1] + 8;
 206                         (*argvp)[1] = (*argvp)[0];
 207                         found = 1;
 208                 }
 209                 if (!found && strncmp((*argvp)[1], "--trace=", 8) == 0) {
 210                         trace_variable = (*argvp)[1] + 8;
 211                         (*argvp)[1] = (*argvp)[0];
 212                         found = 1;
 213                 }
 214                 if (!found && strncmp((*argvp)[1], "--enable=", 9) == 0) {
 215                         enable_checks((*argvp)[1] + 9);
 216                         option_enable = 1;
 217                         (*argvp)[1] = (*argvp)[0];
 218                         found = 1;
 219                 }
 220
 221                 OPTION(spammy);
 222                 OPTION(info);
 223                 OPTION(debug);
 224                 OPTION(debug_implied);
 225                 OPTION(debug_related);
 226                 OPTION(assume_loops);
 227                 OPTION(no_data);
 228                 OPTION(two_passes);
 229                 OPTION(full_path);
 230                 OPTION(param_mapper);
 231                 OPTION(call_tree);
 232                 OPTION(file_output);
 233                 OPTION(time);
 234                 OPTION(mem);
 235                 OPTION(no_db);
 236                 if (!found)
 237                         break;
 238                 (*argcp)--;
 239                 (*argvp)++;
 240         }
 241
 242         if (strcmp(option_project_str, "smatch_generic") != 0)
 243                 option_project = PROJ_UNKNOWN;
 244         if (strcmp(option_project_str, "kernel") == 0)
 245                 option_project = PROJ_KERNEL;
 246         if (strcmp(option_project_str, "wine") == 0)
 247                 option_project = PROJ_WINE;
 248 }
 249
 250 static char *read_bin_filename(void)
 251 {
 252         char filename[PATH_MAX] = {};
 253         char proc[PATH_MAX];
 254
 255         pid_t pid = getpid();
 256         sprintf(proc, "/proc/%d/exe", pid);
 257         if (readlink(proc, filename, PATH_MAX) < 0)
 258                 return NULL;
 259         return alloc_string(filename);
 260 }
 261
 262 static char *get_bin_dir(char *arg0)
 263 {
 264         char *orig;
 265
 266         orig = read_bin_filename();
 267         if (!orig)
 268                 orig = alloc_string(arg0);
 269         return dirname(orig);
 270 }
 271
 272 static char *get_data_dir(char *arg0)
 273 {
 274         char buf[256];
 275         char *dir;
 276
 277         if (option_no_data)
 278                 return NULL;
 279
 280         if (option_datadir_str) {
 281                 if (access(option_datadir_str, R_OK))
 282                         printf("Warning: %s is not accessible -- ignore.\n",
 283                                         option_datadir_str);
 284                 else
 285                         return alloc_string(option_datadir_str);
 286         }
 287
 288         strncpy(buf, "smatch_data/", sizeof(buf));
 289         dir = alloc_string(buf);
 290         if (!access(dir, R_OK))
 291                 return dir;
 292
 293         strncpy(buf, bin_dir, 254);
 294
 295         buf[255] = '\0';
 296         strncat(buf, "/smatch_data/", 254 - strlen(buf));
 297         dir = alloc_string(buf);
 298         if (!access(dir, R_OK))
 299                 return dir;
 300         free_string(dir);
 301         snprintf(buf, 254, "%s/smatch_data/", SMATCHDATADIR);
 302         dir = alloc_string(buf);
 303         if (!access(dir, R_OK))
 304                 return dir;
 305
 306         printf("Warning: %s is not accessible.\n", dir);
 307         printf("Use --no-data or --data to suppress this message.\n");
 308         return NULL;
 309 }
 310
 311 int main(int argc, char **argv)
 312 {
 313         int i;
 314         reg_func func;
 315
 316         sm_outfd = stdout;
 317         sql_outfd = stdout;
 318         caller_info_fd = stdout;
 319         parse_args(&argc, &argv);
 320
 321         /* this gets set back to zero when we parse the first function */
 322         final_pass = 1;
 323
 324         bin_dir = get_bin_dir(argv[0]);
 325         data_dir = get_data_dir(argv[0]);
 326
 327         allocate_hook_memory();
 328         create_function_hook_hash();
 329         open_smatch_db(option_db_file);
 330         for (i = 1; i < ARRAY_SIZE(reg_funcs); i++) {
 331                 func = reg_funcs[i].func;
 332                 /* The script IDs start at 1.
 333                    0 is used for internal stuff. */
 334                 if (!option_enable || reg_funcs[i].enabled || !strncmp(reg_funcs[i].name, "register_", 9))
 335                         func(i);
 336         }
 337
 338         smatch(argc, argv);
 339         free_string(data_dir);
 340         return 0;
 341 }