smatch.c

   1 /*
   2  * sparse/smatch.c
   3  *
   4  * Copyright (C) 2006 Dan Carpenter.
   5  *
   6  * Licensed under the Open Software License version 1.1
   7  *
   8  */
   9
  10 #include <stdio.h>
  11 #include <unistd.h>
  12 #include <libgen.h>
  13 #include "smatch.h"
  14
  15 char *option_project_str = (char *)"";
  16 enum project_type option_project = PROJ_NONE;
  17 char *data_dir;
  18 int option_no_data = 0;
  19 int option_spammy = 0;
  20 int option_full_path = 0;
  21
  22 typedef void (*reg_func) (int id);
  23 void register_smatch_extra(int id);
  24 void register_smatch_ignore(int id);
  25 void register_implications(int id);
  26 void register_function_hooks(int id);
  27 void register_modification_hooks(int id);
  28 void register_containers(int id);
  29 void check_debug(int id);
  30 void check_assigned_expr(int id);
  31 void check_null_deref(int id);
  32 void check_overflow(int id);
  33 void check_locking(int id);
  34 void check_memory(int id);
  35 void check_frees_argument(int id);
  36 void check_puts_argument(int id);
  37 void check_leaks(int id);
  38 void check_type(int id);
  39 void check_allocation_funcs(int id);
  40 void check_err_ptr(int id);
  41 void check_err_ptr_deref(int id);
  42 void check_balanced(int id);
  43 void check_deref_check(int id);
  44 void check_hold_dev(int id);
  45 void check_redundant_null_check(int id);
  46 void check_signed(int id);
  47 void check_precedence(int id);
  48 void check_format_string(int id);
  49 void check_unused_ret(int id);
  50 /* <- your test goes here */
  51
  52 /* may as well put wine scripts all together */
  53 void check_wine(int id);
  54 void check_wine_filehandles(int id);
  55 void check_wine_WtoA(int id);
  56
  57 /* void register_template(int id); */
  58
  59 #define CK(_x) {.name = #_x, .func = &_x}
  60 static struct reg_func_info {
  61         const char *name;
  62         reg_func func;
  63 } reg_funcs[] = {
  64         CK(register_smatch_extra), /* smatch_extra always has to be first */
  65         CK(register_smatch_ignore),
  66         CK(check_debug),
  67         CK(check_assigned_expr),
  68
  69         CK(check_null_deref),
  70         CK(check_overflow),
  71         CK(check_memory),
  72         CK(check_type),
  73         CK(check_allocation_funcs),
  74         CK(check_leaks),
  75         CK(check_frees_argument),
  76         CK(check_balanced),
  77         CK(check_deref_check),
  78         CK(check_redundant_null_check),
  79         CK(check_signed),
  80         CK(check_precedence),
  81         CK(check_format_string),
  82         CK(check_unused_ret),
  83
  84         /* <- your test goes here */
  85         /* CK(register_template), */
  86
  87         /* kernel specific */
  88         CK(check_locking),
  89         CK(check_puts_argument),
  90         CK(check_err_ptr),
  91         CK(check_err_ptr_deref),
  92         CK(check_hold_dev),
  93
  94         /* wine specific stuff */
  95         CK(check_wine),
  96         CK(check_wine_filehandles),
  97         CK(check_wine_WtoA),
  98
  99         CK(register_modification_hooks),
 100         CK(register_containers),
 101         CK(register_implications), /* implications always has to be last */
 102 };
 103
 104 const char *check_name(unsigned short id)
 105 {
 106         if (id > ARRAY_SIZE(reg_funcs)) {
 107                 return "internal";
 108         }
 109         return reg_funcs[id - 1].name;
 110 }
 111
 112 int id_from_name(const char *name)
 113 {
 114         int i;
 115
 116         for(i = 0; i < ARRAY_SIZE(reg_funcs); i++){
 117                 if (!strcmp(name, reg_funcs[i].name))
 118                         return i + 1;
 119         }
 120         return 0;
 121 }
 122
 123 struct smatch_state *default_state[ARRAY_SIZE(reg_funcs)];
 124
 125 static void help(void)
 126 {
 127         printf("Usage:  smatch [smatch arguments][sparse arguments] file.c\n");
 128         printf("--project=<name> or -p=<name>: project specific tests\n");
 129         printf("--spammy:  print superfluous crap.\n");
 130         printf("--debug:  print lots of debug output.\n");
 131         printf("--no-data:  do not use the /smatch_data/ directory.\n");
 132         printf("--full-path:  print the full pathname.\n");
 133         printf("--debug-implied:  print debug output about implications.\n");
 134         printf("--oom <num>:  number of mB memory to use before giving up.\n");
 135         printf("--no-implied:  ignore implications.\n");
 136         printf("--assume-loops:  assume loops always go through at least once.\n");
 137         printf("--known-conditions:  don't branch for known conditions.\n");
 138         printf("--two-passes:  use a two pass system for each function.\n");
 139         printf("--help:  print this helpfull message.\n");
 140         exit(1);
 141 }
 142
 143 void parse_args(int *argcp, char ***argvp)
 144 {
 145         while(*argcp >= 2) {
 146                 if (!strncmp((*argvp)[1], "--project=", 10)) {
 147                         option_project_str = (*argvp)[1] + 10;
 148                         (*argvp)[1] = (*argvp)[0];
 149                 } else if (!strncmp((*argvp)[1], "-p=", 3)) {
 150                         option_project_str = (*argvp)[1] + 3;
 151                         (*argvp)[1] = (*argvp)[0];
 152                 } else if (!strcmp((*argvp)[1], "--debug")) {
 153                         debug_states = 1;
 154                         (*argvp)[1] = (*argvp)[0];
 155                 } else if (!strcmp((*argvp)[1], "--debug-implied")) {
 156                         debug_implied_states = 1;
 157                         (*argvp)[1] = (*argvp)[0];
 158                 } else if (!strcmp((*argvp)[1], "--oom")) {
 159                         option_oom_kb = atoi((*argvp)[2]) * 1000;
 160                         (*argvp)[2] = (*argvp)[0];
 161                         (*argcp)--;
 162                         (*argvp)++;
 163                 } else if (!strcmp((*argvp)[1], "--no-implied")) {
 164                         option_no_implied = 1;
 165                         (*argvp)[1] = (*argvp)[0];
 166                 } else if (!strcmp((*argvp)[1], "--assume-loops")) {
 167                         option_assume_loops = 1;
 168                         (*argvp)[1] = (*argvp)[0];
 169                 } else if (!strcmp((*argvp)[1], "--known-conditions")) {
 170                         option_known_conditions = 1;
 171                         (*argvp)[1] = (*argvp)[0];
 172                 } else if (!strcmp((*argvp)[1], "--no-data")) {
 173                         option_no_data = 1;
 174                         (*argvp)[1] = (*argvp)[0];
 175                 } else if (!strcmp((*argvp)[1], "--spammy")) {
 176                         option_spammy = 1;
 177                         (*argvp)[1] = (*argvp)[0];
 178                 } else if (!strcmp((*argvp)[1], "--two-passes")) {
 179                         option_two_passes = 1;
 180                         (*argvp)[1] = (*argvp)[0];
 181                 } else if (!strcmp((*argvp)[1], "--full-path")) {
 182                         option_full_path = 1;
 183                         (*argvp)[1] = (*argvp)[0];
 184                 } else if (!strcmp((*argvp)[1], "--help")) {
 185                         help();
 186                 } else {
 187                         break;
 188                 }
 189                 (*argcp)--;
 190                 (*argvp)++;
 191         }
 192
 193         if (!strcmp(option_project_str, "kernel"))
 194                 option_project = PROJ_KERNEL;
 195         if (!strcmp(option_project_str, "wine"))
 196                 option_project = PROJ_WINE;
 197 }
 198
 199 static char *get_data_dir(char *arg0)
 200 {
 201         char *bin_dir;
 202         char buf[256];
 203         char *dir;
 204
 205         if (option_no_data) {
 206                 return NULL;
 207         }
 208         bin_dir = dirname(alloc_string(arg0));
 209         strncpy(buf, bin_dir, 254);
 210         buf[255] = '\0';
 211         strncat(buf, "/smatch_data/", 254 - strlen(buf));
 212         dir = alloc_string(buf);
 213         if (!access(dir, R_OK))
 214                 return dir;
 215         printf("Warning: %s is not accessible.\n", dir);
 216         printf("Use --no-data to suppress this message.\n");
 217         return NULL;
 218 }
 219
 220 int main(int argc, char **argv)
 221 {
 222         int i;
 223         reg_func func;
 224
 225         parse_args(&argc, &argv);
 226
 227         data_dir = get_data_dir(argv[0]);
 228
 229         create_function_hash();
 230         for(i = 0; i < ARRAY_SIZE(reg_funcs); i++){
 231                 func = reg_funcs[i].func;
 232                 /* The script IDs start at 1.
 233                    0 is used for internal stuff. */
 234                 func(i + 1);
 235         }
 236         register_function_hooks(-1);
 237
 238         smatch(argc, argv);
 239         free_string(data_dir);
 240         return 0;
 241 }