smatch_constraints.c

   1 /*
   2  * Copyright (C) 2017 Oracle.
   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 /*
  19  * Basically I see constraints as a way of saying "x <= some_limit".  The
  20  * problem is that smatch_capped is not granullar enough.
  21  *
  22  * This is mostly for finding out of bounds errors.  So there are different
  23  * types of constraints.  Quite often we have "foo->xxx[i] = 42;" and we want
  24  * to verify that "i" is less than foo->size.
  25  *
  26  * My idea was that we could automatically figure out these constraints.  And we
  27  * could load them in the DB so that they are the same every time.  As in a
  28  * constraint could be "< (struct whatever)->size" and give that in ID that
  29  * would be constant until you completely wiped the DB.  So when you do a normal
  30  * DB rebuild then the first thing it will do is preserve all the constraints.
  31  * I guess the reason to do it this way is to save space...  I sometimes suspect
  32  * that worrying about saving space is premature optimization.
  33  *
  34  * The other thing that I want to do a little bit different here is how I merge
  35  * constraints.  If a constraint is true on both sides, then that's normal.  If
  36  * we merge constraint 23 and 67 then we get constraint 23|67.  If we merge 23
  37  * with &undefined then we get &undefined.  We can also have two constraints
  38  * that are both true so we could have (45&23)|12 which means either both 45 and
  39  * 23 are true or 12 is true.
  40  *
  41  */
  42
  43
  44 #include "smatch.h"
  45 #include "smatch_extra.h"
  46 #include "smatch_slist.h"
  47
  48 static int my_id;
  49
  50 ALLOCATOR(constraint, "constraints");
  51
  52 static void add_constraint(struct constraint_list **list, int op, int constraint)
  53 {
  54         struct constraint *tmp, *new;
  55
  56         FOR_EACH_PTR(*list, tmp) {
  57                 if (tmp->id < constraint)
  58                         continue;
  59                 if (tmp->id == constraint) {
  60                         if (tmp->op == SPECIAL_LTE)
  61                                 return;
  62                         if (op == '<')
  63                                 return;
  64
  65                         new = __alloc_constraint(0);
  66                         new->op = op;
  67                         new->id = constraint;
  68                         REPLACE_CURRENT_PTR(tmp, new);
  69                         return;
  70                 }
  71
  72                 new = __alloc_constraint(0);
  73                 new->op = op;
  74                 new->id = constraint;
  75                 INSERT_CURRENT(new, tmp);
  76                 return;
  77         } END_FOR_EACH_PTR(tmp);
  78
  79         new = __alloc_constraint(0);
  80         new->op = op;
  81         new->id = constraint;
  82         add_ptr_list(list, new);
  83 }
  84
  85 static struct constraint_list *merge_constraint_lists(struct constraint_list *one, struct constraint_list *two)
  86 {
  87         struct constraint_list *ret = NULL;
  88         struct constraint *tmp;
  89
  90         // FIXME: not || but &&
  91         FOR_EACH_PTR(one, tmp) {
  92                 add_constraint(&ret, tmp->op, tmp->id);
  93         } END_FOR_EACH_PTR(tmp);
  94
  95         FOR_EACH_PTR(two, tmp) {
  96                 add_constraint(&ret, tmp->op, tmp->id);
  97         } END_FOR_EACH_PTR(tmp);
  98
  99         return ret;
 100 }
 101
 102 static struct constraint_list *clone_constraint_list(struct constraint_list *list)
 103 {
 104         struct constraint_list *ret = NULL;
 105         struct constraint *tmp;
 106
 107         FOR_EACH_PTR(list, tmp) {
 108                 add_constraint(&ret, tmp->op, tmp->id);
 109         } END_FOR_EACH_PTR(tmp);
 110
 111         return ret;
 112 }
 113
 114 static struct smatch_state *alloc_constraint_state(struct constraint_list *list)
 115 {
 116         struct smatch_state *state;
 117         struct constraint *con;
 118         static char buf[256];
 119         int cnt = 0;
 120
 121         FOR_EACH_PTR(list, con) {
 122                 if (cnt != 0)
 123                         cnt += snprintf(buf + cnt, sizeof(buf) - cnt, ", ");
 124                 cnt += snprintf(buf + cnt, sizeof(buf) - cnt, "%s%d",
 125                                 show_special(con->op), con->id);
 126         } END_FOR_EACH_PTR(con);
 127
 128         state = __alloc_smatch_state(0);
 129         state->name = alloc_string(buf);
 130         state->data = list;
 131         return state;
 132 }
 133
 134 static struct smatch_state *merge_func(struct smatch_state *s1, struct smatch_state *s2)
 135 {
 136         struct constraint_list *list;
 137
 138         // FIXME:  use the dead code below instead
 139         if (strcmp(s1->name, s2->name) == 0)
 140                 return s1;
 141         return &merged;
 142
 143         list = merge_constraint_lists(s1->data, s2->data);
 144         return alloc_constraint_state(list);
 145 }
 146
 147 static int negate_gt(int op)
 148 {
 149         switch (op) {
 150         case '>':
 151         case SPECIAL_UNSIGNED_GT:
 152         case SPECIAL_GTE:
 153         case SPECIAL_UNSIGNED_GTE:
 154                 return negate_comparison(op);
 155         }
 156         return op;
 157 }
 158
 159 static char *get_func_constraint(struct expression *expr)
 160 {
 161         char buf[256];
 162         char *name;
 163
 164         if (is_fake_call(expr))
 165                 return NULL;
 166         name = expr_to_str(expr->fn);
 167         if (!name)
 168                 return NULL;
 169         snprintf(buf, sizeof(buf), "%s()", name);
 170         free_string(name);
 171         return alloc_string(buf);
 172 }
 173
 174 static char *get_toplevel_name(struct expression *expr)
 175 {
 176         struct symbol *sym;
 177         char buf[256];
 178
 179         expr = strip_expr(expr);
 180         if (expr->type != EXPR_SYMBOL || !expr->symbol || !expr->symbol->ident)
 181                 return NULL;
 182
 183         sym = expr->symbol;
 184         if (!(sym->ctype.modifiers & MOD_TOPLEVEL))
 185                 return NULL;
 186
 187         if (sym->ctype.modifiers & MOD_STATIC)
 188                 snprintf(buf, sizeof(buf), "%s %s", get_base_file(), sym->ident->name);
 189         else
 190                 snprintf(buf, sizeof(buf), "extern %s", sym->ident->name);
 191
 192         return alloc_string(buf);
 193 }
 194
 195 char *get_constraint_str(struct expression *expr)
 196 {
 197         char *name;
 198
 199         if (!expr)
 200                 return NULL;
 201         if (expr->type == EXPR_CALL)
 202                 return get_func_constraint(expr);
 203         name = get_toplevel_name(expr);
 204         if (name)
 205                 return name;
 206         return get_member_name(expr);
 207 }
 208
 209 static int save_int_callback(void *_p, int argc, char **argv, char **azColName)
 210 {
 211         int *p = _p;
 212
 213         *p = atoi(argv[0]);
 214         return 0;
 215 }
 216
 217 static int constraint_str_to_id(const char *str)
 218 {
 219         int id = -1;
 220
 221         run_sql(save_int_callback, &id,
 222                 "select id from constraints where str = '%s'", str);
 223
 224         return id;
 225 }
 226
 227 static int save_constraint_str(void *_str, int argc, char **argv, char **azColName)
 228 {
 229         char **str = _str;
 230
 231         *str = alloc_string(argv[0]);
 232         return 0;
 233 }
 234
 235 static char *constraint_id_to_str(int id)
 236 {
 237         char *str = NULL;
 238
 239         run_sql(save_constraint_str, &str,
 240                 "select str from constraints where id = '%d'", id);
 241
 242         return str;
 243 }
 244
 245 static int save_op_callback(void *_p, int argc, char **argv, char **azColName)
 246 {
 247         int *p = _p;
 248
 249         if (argv[0][0] == '<' && argv[0][1] == '=')
 250                 *p = SPECIAL_LTE;
 251         else
 252                 *p = '<';
 253         return 0;
 254 }
 255
 256 static int save_str_callback(void *_p, int argc, char **argv, char **azColName)
 257 {
 258         char **p = _p;
 259
 260         if (!*p) {
 261                 *p = alloc_string(argv[0]);
 262         } else {
 263                 char buf[256];
 264
 265                 snprintf(buf, sizeof(buf), "%s, %s", *p, argv[0]);
 266                 *p = alloc_string(buf);
 267         }
 268         return 0;
 269 }
 270
 271 char *get_required_constraint(const char *data_str)
 272 {
 273         char *required = NULL;
 274
 275         run_sql(save_str_callback, &required,
 276                 "select bound from constraints_required where data = '%s'", data_str);
 277
 278         return required;
 279 }
 280
 281 static int get_required_op(char *data_str, char *con_str)
 282 {
 283         int op = 0;
 284
 285         run_sql(save_op_callback, &op,
 286                 "select op from constraints_required where data = '%s' and bound = '%s'", data_str, con_str);
 287
 288         return op;
 289 }
 290
 291 char *unmet_constraint(struct expression *data, struct expression *offset)
 292 {
 293         struct smatch_state *state;
 294         struct constraint_list *list;
 295         struct constraint *con;
 296         char *data_str;
 297         char *required;
 298         int req_op;
 299         int found = 0;
 300
 301         state = get_state_expr(my_id, offset);
 302         if (!state)
 303                 return NULL;
 304         list = state->data;
 305
 306         data_str = get_constraint_str(data);
 307         if (!data_str)
 308                 return NULL;
 309
 310         required = get_required_constraint(data_str);
 311         if (!required)
 312                 return NULL;
 313
 314         /* check the list of bounds on our index against the list that work */
 315         FOR_EACH_PTR(list, con) {
 316                 char *con_str;
 317
 318                 con_str = constraint_id_to_str(con->id);
 319                 if (!con_str) {
 320                         sm_msg("constraint %d not found", con->id);
 321                         continue;
 322                 }
 323
 324                 req_op = get_required_op(data_str, con_str);
 325                 free_string(con_str);
 326                 if (!req_op)
 327                         continue;
 328                 if (con->op == '<' || con->op == req_op) {
 329                         found = 1;
 330                         goto free_data;
 331                 }
 332         } END_FOR_EACH_PTR(con);
 333
 334 free_data:
 335         if (found) {
 336                 free_string(required);
 337                 required = NULL;
 338         }
 339         free_string(data_str);
 340         return required;
 341 }
 342
 343 struct string_list *saved_constraints;
 344 static void save_new_constraint(const char *con)
 345 {
 346         if (list_has_string(saved_constraints, con))
 347                 return;
 348         insert_string(&saved_constraints, con);
 349         sql_save_constraint(con);
 350 }
 351
 352 static void match_condition(struct expression *expr)
 353 {
 354         struct expression *left, *right;
 355         struct constraint_list *constraints;
 356         struct smatch_state *state;
 357         char *constraint;
 358         int constraint_id;
 359         int op;
 360
 361         if (expr->type != EXPR_COMPARE)
 362                 return;
 363
 364         if (expr->op == SPECIAL_EQUAL ||
 365             expr->op == SPECIAL_NOTEQUAL)
 366                 return;
 367
 368         left = expr->left;
 369         right = expr->right;
 370
 371         constraint = get_constraint_str(right);
 372         if (!constraint)
 373                 return;
 374         constraint_id = constraint_str_to_id(constraint);
 375         if (constraint_id < 0)
 376                 save_new_constraint(constraint);
 377         free_string(constraint);
 378         if (constraint_id < 0)
 379                 return;
 380
 381         constraints = get_constraints(left);
 382         constraints = clone_constraint_list(constraints);
 383         op = negate_gt(expr->op);
 384         add_constraint(&constraints, remove_unsigned_from_comparison(op), constraint_id);
 385         state = alloc_constraint_state(constraints);
 386
 387         if (op == expr->op)
 388                 set_true_false_states_expr(my_id, left, state, NULL);
 389         else
 390                 set_true_false_states_expr(my_id, left, NULL, state);
 391 }
 392
 393 struct constraint_list *get_constraints(struct expression *expr)
 394 {
 395         struct smatch_state *state;
 396
 397         state = get_state_expr(my_id, expr);
 398         if (!state)
 399                 return NULL;
 400         return state->data;
 401 }
 402
 403 static void match_caller_info(struct expression *expr)
 404 {
 405         struct expression *tmp;
 406         struct smatch_state *state;
 407         int i;
 408
 409         i = -1;
 410         FOR_EACH_PTR(expr->args, tmp) {
 411                 i++;
 412                 state = get_state_expr(my_id, tmp);
 413                 if (!state || state == &merged || state == &undefined)
 414                         continue;
 415                 sql_insert_caller_info(expr, CONSTRAINT, i, "$", state->name);
 416         } END_FOR_EACH_PTR(tmp);
 417 }
 418
 419 static void struct_member_callback(struct expression *call, int param, char *printed_name, struct sm_state *sm)
 420 {
 421         if (sm->state == &merged || sm->state == &undefined)
 422                 return;
 423         sql_insert_caller_info(call, CONSTRAINT, param, printed_name, sm->state->name);
 424 }
 425
 426 static void print_return_implies_constrained(int return_id, char *return_ranges, struct expression *expr)
 427 {
 428         struct smatch_state *orig;
 429         struct sm_state *sm;
 430         const char *param_name;
 431         int param;
 432
 433         FOR_EACH_MY_SM(my_id, __get_cur_stree(), sm) {
 434                 if (sm->state == &merged || sm->state == &undefined)
 435                         continue;
 436
 437                 param = get_param_num_from_sym(sm->sym);
 438                 if (param < 0)
 439                         continue;
 440
 441                 orig = get_state_stree(get_start_states(), my_id, sm->name, sm->sym);
 442                 if (orig && strcmp(sm->state->name, orig->name) == 0)
 443                         continue;
 444
 445                 param_name = get_param_name(sm);
 446                 if (!param_name)
 447                         continue;
 448
 449                 sql_insert_return_states(return_id, return_ranges, CONSTRAINT,
 450                                          param, param_name, sm->state->name);
 451         } END_FOR_EACH_SM(sm);
 452 }
 453
 454 static struct smatch_state *constraint_str_to_state(char *value)
 455 {
 456         struct constraint_list *list = NULL;
 457         char *p = value;
 458         int op;
 459         long long id;
 460
 461         while (true) {
 462                 op = '<';
 463                 if (*p != '<')
 464                         return &undefined;
 465                 p++;
 466                 if (*p == '=') {
 467                         op = SPECIAL_LTE;
 468                         p++;
 469                 }
 470                 id = strtoll(p, &p, 10);
 471                 add_constraint(&list, op, id);
 472                 if (*p != ',')
 473                         break;
 474                 p++;
 475                 if (*p != ' ')
 476                         return &undefined;
 477         }
 478
 479         return alloc_constraint_state(list);
 480 }
 481
 482 static void db_returns_constrained(struct expression *expr, int param, char *key, char *value)
 483 {
 484         char *name;
 485         struct symbol *sym;
 486
 487         name = return_state_to_var_sym(expr, param, key, &sym);
 488         if (!name || !sym)
 489                 goto free;
 490
 491         set_state(my_id, name, sym, constraint_str_to_state(value));
 492 free:
 493         free_string(name);
 494 }
 495
 496 void register_constraints(int id)
 497 {
 498         my_id = id;
 499
 500         add_merge_hook(my_id, &merge_func);
 501         add_hook(&match_condition, CONDITION_HOOK);
 502
 503         add_hook(&match_caller_info, FUNCTION_CALL_HOOK);
 504         add_member_info_callback(my_id, struct_member_callback);
 505
 506         add_split_return_callback(print_return_implies_constrained);
 507         select_return_states_hook(CONSTRAINT, &db_returns_constrained);
 508 }