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