check_or_vs_and.c

   1 /*
   2  * sparse/check_or_vs_and.c
   3  *
   4  * Copyright (C) 2012 Oracle.
   5  *
   6  * Licensed under the Open Software License version 1.1
   7  *
   8  */
   9
  10 #include "smatch.h"
  11 #include "smatch_function_hashtable.h"
  12
  13 static int my_id;
  14
  15 DEFINE_STRING_HASHTABLE_STATIC(unconstant_macros);
  16
  17 static int does_inc_dec(struct expression *expr)
  18 {
  19         if (expr->type == EXPR_PREOP || expr->type == EXPR_POSTOP) {
  20                 if (expr->op == SPECIAL_INCREMENT || expr->op == SPECIAL_DECREMENT)
  21                         return 1;
  22                 return does_inc_dec(expr->unop);
  23         }
  24         return 0;
  25 }
  26
  27 static int expr_equiv(struct expression *one, struct expression *two)
  28 {
  29         struct symbol *one_sym, *two_sym;
  30         char *one_name = NULL;
  31         char *two_name = NULL;
  32         int ret = 0;
  33
  34         if (does_inc_dec(one) || does_inc_dec(two))
  35                 return 0;
  36
  37         one_name = get_variable_from_expr_complex(one, &one_sym);
  38         if (!one_name || !one_sym)
  39                 goto free;
  40         two_name = get_variable_from_expr_complex(two, &two_sym);
  41         if (!two_name || !two_sym)
  42                 goto free;
  43         if (one_sym != two_sym)
  44                 goto free;
  45         if (strcmp(one_name, two_name) == 0)
  46                 ret = 1;
  47 free:
  48         free_string(one_name);
  49         free_string(two_name);
  50         return ret;
  51 }
  52
  53 static int inconsistent_check(struct expression *left, struct expression *right)
  54 {
  55         sval_t sval;
  56
  57         if (get_value_sval(left->left, &sval)) {
  58                 if (get_value_sval(right->left, &sval))
  59                         return expr_equiv(left->right, right->right);
  60                 if (get_value_sval(right->right, &sval))
  61                         return expr_equiv(left->right, right->left);
  62                 return 0;
  63         }
  64         if (get_value_sval(left->right, &sval)) {
  65                 if (get_value_sval(right->left, &sval))
  66                         return expr_equiv(left->left, right->right);
  67                 if (get_value_sval(right->right, &sval))
  68                         return expr_equiv(left->left, right->left);
  69                 return 0;
  70         }
  71
  72         return 0;
  73 }
  74
  75 static void check_or(struct expression *expr)
  76 {
  77         if (expr->left->type != EXPR_COMPARE ||
  78                         expr->left->op != SPECIAL_NOTEQUAL)
  79                 return;
  80         if (expr->right->type != EXPR_COMPARE ||
  81                         expr->right->op != SPECIAL_NOTEQUAL)
  82                 return;
  83         if (!inconsistent_check(expr->left, expr->right))
  84                 return;
  85
  86         sm_msg("warn: was && intended here instead of ||?");
  87 }
  88
  89 static void check_and(struct expression *expr)
  90 {
  91         if (expr->left->type != EXPR_COMPARE ||
  92                         expr->left->op != SPECIAL_EQUAL)
  93                 return;
  94         if (expr->right->type != EXPR_COMPARE ||
  95                         expr->right->op != SPECIAL_EQUAL)
  96                 return;
  97         if (!inconsistent_check(expr->left, expr->right))
  98                 return;
  99
 100         sm_msg("warn: was || intended here instead of &&?");
 101 }
 102
 103 static void match_logic(struct expression *expr)
 104 {
 105         if (expr->type != EXPR_LOGICAL)
 106                 return;
 107
 108         if (expr->op == SPECIAL_LOGICAL_OR)
 109                 check_or(expr);
 110         if (expr->op == SPECIAL_LOGICAL_AND)
 111                 check_and(expr);
 112 }
 113
 114 static int is_unconstant_macro(struct expression *expr)
 115 {
 116         char *macro;
 117
 118         macro = get_macro_name(expr->pos);
 119         if (!macro)
 120                 return 0;
 121         if (search_unconstant_macros(unconstant_macros, macro))
 122                 return 1;
 123         return 0;
 124 }
 125
 126 static void match_condition(struct expression *expr)
 127 {
 128         sval_t sval;
 129
 130         if (expr->type != EXPR_BINOP)
 131                 return;
 132         if (expr->op == '|') {
 133                 if (get_value_sval(expr->left, &sval) || get_value_sval(expr->right, &sval))
 134                         sm_msg("warn: suspicious bitop condition");
 135                 return;
 136         }
 137
 138         if (expr->op != '&')
 139                 return;
 140
 141         if (get_macro_name(expr->pos))
 142                 return;
 143         if (is_unconstant_macro(expr->left) || is_unconstant_macro(expr->right))
 144                 return;
 145
 146         if ((get_value_sval(expr->left, &sval) && sval.value == 0) ||
 147             (get_value_sval(expr->right, &sval) && sval.value == 0))
 148                 sm_msg("warn: bitwise AND condition is false here");
 149 }
 150
 151 static void match_binop(struct expression *expr)
 152 {
 153         sval_t left, right, sval;
 154
 155         if (expr->op != '&')
 156                 return;
 157         if (!get_value_sval(expr, &sval) || sval.value != 0)
 158                 return;
 159         if (get_macro_name(expr->pos))
 160                 return;
 161         if (!get_value_sval(expr->left, &left) || !get_value_sval(expr->right, &right))
 162                 return;
 163         sm_msg("warn: odd binop '0x%llx & 0x%llx'", left.uvalue, right.uvalue);
 164 }
 165
 166 void check_or_vs_and(int id)
 167 {
 168         my_id = id;
 169
 170         unconstant_macros = create_function_hashtable(100);
 171         load_strings("unconstant_macros", unconstant_macros);
 172
 173         add_hook(&match_logic, LOGIC_HOOK);
 174         add_hook(&match_condition, CONDITION_HOOK);
 175         if (option_spammy)
 176                 add_hook(&match_binop, BINOP_HOOK);
 177 }