smatch_estate.c

   1 /*
   2  * Copyright (C) 2010 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 /*
  19  * smatch_dinfo.c has helper functions for handling data_info structs
  20  *
  21  */
  22
  23 #include <stdlib.h>
  24 #ifndef __USE_ISOC99
  25 #define __USE_ISOC99
  26 #endif
  27 #include <limits.h>
  28 #include "parse.h"
  29 #include "smatch.h"
  30 #include "smatch_slist.h"
  31 #include "smatch_extra.h"
  32
  33 struct smatch_state *merge_estates(struct smatch_state *s1, struct smatch_state *s2)
  34 {
  35         struct smatch_state *tmp;
  36         struct range_list *value_ranges;
  37         struct related_list *rlist;
  38
  39         if (estates_equiv(s1, s2))
  40                 return s1;
  41
  42         value_ranges = rl_union(estate_rl(s1), estate_rl(s2));
  43         tmp = alloc_estate_rl(value_ranges);
  44         rlist = get_shared_relations(estate_related(s1), estate_related(s2));
  45         set_related(tmp, rlist);
  46         if (estate_has_hard_max(s1) && estate_has_hard_max(s2))
  47                 estate_set_hard_max(tmp);
  48
  49         estate_set_fuzzy_max(tmp, sval_max(estate_get_fuzzy_max(s1), estate_get_fuzzy_max(s2)));
  50
  51         return tmp;
  52 }
  53
  54 struct data_info *get_dinfo(struct smatch_state *state)
  55 {
  56         if (!state)
  57                 return NULL;
  58         return (struct data_info *)state->data;
  59 }
  60
  61 struct range_list *estate_rl(struct smatch_state *state)
  62 {
  63         if (!state)
  64                 return NULL;
  65         return get_dinfo(state)->value_ranges;
  66 }
  67
  68 struct related_list *estate_related(struct smatch_state *state)
  69 {
  70         if (!state)
  71                 return NULL;
  72         return get_dinfo(state)->related;
  73 }
  74
  75 sval_t estate_get_fuzzy_max(struct smatch_state *state)
  76 {
  77         sval_t empty = {};
  78
  79         if (!state || !get_dinfo(state))
  80                 return empty;
  81         return get_dinfo(state)->fuzzy_max;
  82 }
  83
  84 int estate_has_fuzzy_max(struct smatch_state *state)
  85 {
  86         if (estate_get_fuzzy_max(state).type)
  87                 return 1;
  88         return 0;
  89 }
  90
  91 void estate_set_fuzzy_max(struct smatch_state *state, sval_t fuzzy_max)
  92 {
  93         if (!rl_has_sval(estate_rl(state), fuzzy_max))
  94                 return;
  95         get_dinfo(state)->fuzzy_max = fuzzy_max;
  96 }
  97
  98 void estate_copy_fuzzy_max(struct smatch_state *new, struct smatch_state *old)
  99 {
 100         if (!estate_has_fuzzy_max(old))
 101                 return;
 102         estate_set_fuzzy_max(new, estate_get_fuzzy_max(old));
 103 }
 104
 105 void estate_clear_fuzzy_max(struct smatch_state *state)
 106 {
 107         sval_t empty = {};
 108
 109         get_dinfo(state)->fuzzy_max = empty;
 110 }
 111
 112 int estate_has_hard_max(struct smatch_state *state)
 113 {
 114         if (!state)
 115                 return 0;
 116         return get_dinfo(state)->hard_max;
 117 }
 118
 119 void estate_set_hard_max(struct smatch_state *state)
 120 {
 121          get_dinfo(state)->hard_max = 1;
 122 }
 123
 124 void estate_clear_hard_max(struct smatch_state *state)
 125 {
 126          get_dinfo(state)->hard_max = 0;
 127 }
 128
 129 int estate_get_hard_max(struct smatch_state *state, sval_t *sval)
 130 {
 131         if (!state || !get_dinfo(state)->hard_max || !estate_rl(state))
 132                 return 0;
 133         *sval = rl_max(estate_rl(state));
 134         return 1;
 135 }
 136
 137 sval_t estate_min(struct smatch_state *state)
 138 {
 139         return rl_min(estate_rl(state));
 140 }
 141
 142 sval_t estate_max(struct smatch_state *state)
 143 {
 144         return rl_max(estate_rl(state));
 145 }
 146
 147 struct symbol *estate_type(struct smatch_state *state)
 148 {
 149         return rl_max(estate_rl(state)).type;
 150 }
 151
 152 static int rlists_equiv(struct related_list *one, struct related_list *two)
 153 {
 154         struct relation *one_rel;
 155         struct relation *two_rel;
 156
 157         PREPARE_PTR_LIST(one, one_rel);
 158         PREPARE_PTR_LIST(two, two_rel);
 159         for (;;) {
 160                 if (!one_rel && !two_rel)
 161                         return 1;
 162                 if (!one_rel || !two_rel)
 163                         return 0;
 164                 if (one_rel->sym != two_rel->sym)
 165                         return 0;
 166                 if (strcmp(one_rel->name, two_rel->name))
 167                         return 0;
 168                 NEXT_PTR_LIST(one_rel);
 169                 NEXT_PTR_LIST(two_rel);
 170         }
 171         FINISH_PTR_LIST(two_rel);
 172         FINISH_PTR_LIST(one_rel);
 173
 174         return 1;
 175 }
 176
 177 int estates_equiv(struct smatch_state *one, struct smatch_state *two)
 178 {
 179         if (!one || !two)
 180                 return 0;
 181         if (one == two)
 182                 return 1;
 183         if (!rlists_equiv(estate_related(one), estate_related(two)))
 184                 return 0;
 185         if (strcmp(one->name, two->name) == 0)
 186                 return 1;
 187         return 0;
 188 }
 189
 190 int estate_is_whole(struct smatch_state *state)
 191 {
 192         return is_whole_rl(estate_rl(state));
 193 }
 194
 195 int estate_is_unknown(struct smatch_state *state)
 196 {
 197         if (!estate_is_whole(state))
 198                 return 0;
 199         if (estate_related(state))
 200                 return 0;
 201         if (estate_has_fuzzy_max(state))
 202                 return 0;
 203         return 1;
 204 }
 205
 206 int estate_get_single_value(struct smatch_state *state, sval_t *sval)
 207 {
 208         sval_t min, max;
 209
 210         min = rl_min(estate_rl(state));
 211         max = rl_max(estate_rl(state));
 212         if (sval_cmp(min, max) != 0)
 213                 return 0;
 214         *sval = min;
 215         return 1;
 216 }
 217
 218 static struct data_info *alloc_dinfo(void)
 219 {
 220         struct data_info *ret;
 221
 222         ret = __alloc_data_info(0);
 223         memset(ret, 0, sizeof(*ret));
 224         return ret;
 225 }
 226
 227 static struct data_info *alloc_dinfo_range(sval_t min, sval_t max)
 228 {
 229         struct data_info *ret;
 230
 231         ret = alloc_dinfo();
 232         add_range(&ret->value_ranges, min, max);
 233         return ret;
 234 }
 235
 236 static struct data_info *alloc_dinfo_range_list(struct range_list *rl)
 237 {
 238         struct data_info *ret;
 239
 240         ret = alloc_dinfo();
 241         ret->value_ranges = rl;
 242         return ret;
 243 }
 244
 245 static struct data_info *clone_dinfo(struct data_info *dinfo)
 246 {
 247         struct data_info *ret;
 248
 249         ret = alloc_dinfo();
 250         ret->related = clone_related_list(dinfo->related);
 251         ret->value_ranges = clone_rl(dinfo->value_ranges);
 252         ret->hard_max = dinfo->hard_max;
 253         ret->fuzzy_max = dinfo->fuzzy_max;
 254         return ret;
 255 }
 256
 257 struct smatch_state *clone_estate(struct smatch_state *state)
 258 {
 259         struct smatch_state *ret;
 260
 261         if (!state)
 262                 return NULL;
 263
 264         ret = __alloc_smatch_state(0);
 265         ret->name = state->name;
 266         ret->data = clone_dinfo(get_dinfo(state));
 267         return ret;
 268 }
 269
 270 struct smatch_state *alloc_estate_empty(void)
 271 {
 272         struct smatch_state *state;
 273         struct data_info *dinfo;
 274
 275         dinfo = alloc_dinfo();
 276         state = __alloc_smatch_state(0);
 277         state->data = dinfo;
 278         state->name = "";
 279         return state;
 280 }
 281
 282 struct smatch_state *alloc_estate_whole(struct symbol *type)
 283 {
 284         return alloc_estate_rl(alloc_whole_rl(type));
 285 }
 286
 287 struct smatch_state *extra_empty(void)
 288 {
 289         struct smatch_state *ret;
 290
 291         ret = __alloc_smatch_state(0);
 292         ret->name = "empty";
 293         ret->data = alloc_dinfo();
 294         return ret;
 295 }
 296
 297 struct smatch_state *alloc_estate_sval(sval_t sval)
 298 {
 299         struct smatch_state *state;
 300
 301         state = __alloc_smatch_state(0);
 302         state->data = alloc_dinfo_range(sval, sval);
 303         state->name = show_rl(get_dinfo(state)->value_ranges);
 304         estate_set_hard_max(state);
 305         estate_set_fuzzy_max(state, sval);
 306         return state;
 307 }
 308
 309 struct smatch_state *alloc_estate_range(sval_t min, sval_t max)
 310 {
 311         struct smatch_state *state;
 312
 313         state = __alloc_smatch_state(0);
 314         state->data = alloc_dinfo_range(min, max);
 315         state->name = show_rl(get_dinfo(state)->value_ranges);
 316         return state;
 317 }
 318
 319 struct smatch_state *alloc_estate_rl(struct range_list *rl)
 320 {
 321         struct smatch_state *state;
 322
 323         if (!rl)
 324                 return extra_empty();
 325
 326         state = __alloc_smatch_state(0);
 327         state->data = alloc_dinfo_range_list(rl);
 328         state->name = show_rl(rl);
 329         return state;
 330 }
 331
 332 struct smatch_state *clone_estate_cast(struct symbol *type, struct smatch_state *state)
 333 {
 334         struct smatch_state *ret;
 335         struct data_info *dinfo;
 336
 337         if (!state)
 338                 return NULL;
 339
 340         dinfo = alloc_dinfo();
 341         dinfo->value_ranges = clone_rl(cast_rl(type, estate_rl(state)));
 342
 343         ret = __alloc_smatch_state(0);
 344         ret->name = show_rl(dinfo->value_ranges);
 345         ret->data = dinfo;
 346
 347         return ret;
 348 }
 349
 350 struct smatch_state *get_implied_estate(struct expression *expr)
 351 {
 352         struct smatch_state *state;
 353         struct range_list *rl;
 354
 355         state = get_state_expr(SMATCH_EXTRA, expr);
 356         if (state)
 357                 return state;
 358         if (!get_implied_rl(expr, &rl))
 359                 rl = alloc_whole_rl(get_type(expr));
 360         return alloc_estate_rl(rl);
 361 }
 362
 363 struct smatch_state *estate_filter_range(struct smatch_state *orig,
 364                                  sval_t filter_min, sval_t filter_max)
 365 {
 366         struct range_list *rl;
 367         struct smatch_state *state;
 368
 369         if (!orig)
 370                 orig = alloc_estate_whole(filter_min.type);
 371
 372         rl = remove_range(estate_rl(orig), filter_min, filter_max);
 373         state = alloc_estate_rl(rl);
 374         if (estate_has_hard_max(orig))
 375                 estate_set_hard_max(state);
 376         if (estate_has_fuzzy_max(orig))
 377                 estate_set_fuzzy_max(state, estate_get_fuzzy_max(orig));
 378         return state;
 379 }
 380
 381 struct smatch_state *estate_filter_sval(struct smatch_state *orig, sval_t sval)
 382 {
 383         return estate_filter_range(orig, sval, sval);
 384 }
 385
 386 /*
 387  * One of the complications is that smatch tries to free a bunch of data at the
 388  * end of every function.
 389  */
 390 struct data_info *clone_dinfo_perm(struct data_info *dinfo)
 391 {
 392         struct data_info *ret;
 393
 394         ret = malloc(sizeof(*ret));
 395         memset(ret, 0, sizeof(*ret));
 396         ret->related = NULL;
 397         ret->value_ranges = clone_rl_permanent(dinfo->value_ranges);
 398         ret->hard_max = 0;
 399         ret->fuzzy_max = dinfo->fuzzy_max;
 400         return ret;
 401 }
 402
 403 struct smatch_state *clone_estate_perm(struct smatch_state *state)
 404 {
 405         struct smatch_state *ret;
 406
 407         ret = malloc(sizeof(*ret));
 408         ret->name = alloc_string(state->name);
 409         ret->data = clone_dinfo_perm(get_dinfo(state));
 410         return ret;
 411 }
 412
 413