smatch_hooks.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 "smatch.h"
  19
  20 enum data_type {
  21         NO_DATA,
  22         EXPR_PTR,
  23         STMT_PTR,
  24         SYMBOL_PTR,
  25         SYM_LIST_PTR,
  26 };
  27
  28 struct hook_container {
  29         int hook_type;
  30         int owner;
  31         void *fn;
  32 };
  33 ALLOCATOR(hook_container, "hook functions");
  34 DECLARE_PTR_LIST(hook_func_list, struct hook_container);
  35
  36 typedef void (sym_list_func)(struct symbol_list *sym_list);
  37 typedef void (array_init_hook)(struct expression *array, int nr);
  38
  39 static struct hook_func_list *merge_funcs;
  40 static struct hook_func_list *unmatched_state_funcs;
  41 static struct hook_func_list *array_init_hooks;
  42 static struct hook_func_list *hook_array[NUM_HOOKS] = {};
  43 static const enum data_type data_types[NUM_HOOKS] = {
  44         [EXPR_HOOK] = EXPR_PTR,
  45         [EXPR_HOOK_AFTER] = EXPR_PTR,
  46         [STMT_HOOK] = STMT_PTR,
  47         [STMT_HOOK_AFTER] = STMT_PTR,
  48         [SYM_HOOK] = EXPR_PTR,
  49         [STRING_HOOK] = EXPR_PTR,
  50         [DECLARATION_HOOK] = SYMBOL_PTR,
  51         [DECLARATION_HOOK_AFTER] = SYMBOL_PTR,
  52         [ASSIGNMENT_HOOK] = EXPR_PTR,
  53         [ASSIGNMENT_HOOK_AFTER] = EXPR_PTR,
  54         [RAW_ASSIGNMENT_HOOK] = EXPR_PTR,
  55         [GLOBAL_ASSIGNMENT_HOOK] = EXPR_PTR,
  56         [CALL_ASSIGNMENT_HOOK] = EXPR_PTR,
  57         [MACRO_ASSIGNMENT_HOOK] = EXPR_PTR,
  58         [BINOP_HOOK] = EXPR_PTR,
  59         [OP_HOOK] = EXPR_PTR,
  60         [LOGIC_HOOK] = EXPR_PTR,
  61         [PRELOOP_HOOK] = STMT_PTR,
  62         [AFTER_LOOP_NO_BREAKS] = STMT_PTR,
  63         [CONDITION_HOOK] = EXPR_PTR,
  64         [SELECT_HOOK] = EXPR_PTR,
  65         [WHOLE_CONDITION_HOOK] = EXPR_PTR,
  66         [FUNCTION_CALL_HOOK] = EXPR_PTR,
  67         [CALL_HOOK_AFTER_INLINE] = EXPR_PTR,
  68         [FUNCTION_CALL_HOOK_AFTER_DB] = EXPR_PTR,
  69         [DEREF_HOOK] = EXPR_PTR,
  70         [CASE_HOOK] = NO_DATA,
  71         [ASM_HOOK] = STMT_PTR,
  72         [CAST_HOOK] = EXPR_PTR,
  73         [SIZEOF_HOOK] = EXPR_PTR,
  74         [BASE_HOOK] = SYMBOL_PTR,
  75         [FUNC_DEF_HOOK] = SYMBOL_PTR,
  76         [AFTER_DEF_HOOK] = SYMBOL_PTR,
  77         [END_FUNC_HOOK] = SYMBOL_PTR,
  78         [AFTER_FUNC_HOOK] = SYMBOL_PTR,
  79         [RETURN_HOOK] = EXPR_PTR,
  80         [INLINE_FN_START] = EXPR_PTR,
  81         [INLINE_FN_END] = EXPR_PTR,
  82         [END_FILE_HOOK] = SYM_LIST_PTR,
  83 };
  84
  85 void (**pre_merge_hooks)(struct sm_state *cur, struct sm_state *other);
  86
  87 struct scope_container {
  88         void *fn;
  89         void *data;
  90 };
  91 ALLOCATOR(scope_container, "scope hook functions");
  92 DECLARE_PTR_LIST(scope_hook_list, struct scope_container);
  93 DECLARE_PTR_LIST(scope_hook_stack, struct scope_hook_list);
  94 static struct scope_hook_stack *scope_hooks;
  95
  96 void add_hook(void *func, enum hook_type type)
  97 {
  98         struct hook_container *container = __alloc_hook_container(0);
  99
 100         container->hook_type = type;
 101         container->fn = func;
 102
 103         add_ptr_list(&hook_array[type], container);
 104 }
 105
 106 void add_merge_hook(int client_id, merge_func_t *func)
 107 {
 108         struct hook_container *container = __alloc_hook_container(0);
 109         container->owner = client_id;
 110         container->fn = func;
 111         add_ptr_list(&merge_funcs, container);
 112 }
 113
 114 void add_unmatched_state_hook(int client_id, unmatched_func_t *func)
 115 {
 116         struct hook_container *container = __alloc_hook_container(0);
 117         container->owner = client_id;
 118         container->fn = func;
 119         add_ptr_list(&unmatched_state_funcs, container);
 120 }
 121
 122 void add_pre_merge_hook(int client_id, void (*hook)(struct sm_state *cur, struct sm_state *other))
 123 {
 124         pre_merge_hooks[client_id] = hook;
 125 }
 126
 127 static void pass_expr_to_client(void *fn, void *data)
 128 {
 129         ((expr_func *)fn)((struct expression *)data);
 130 }
 131
 132 static void pass_stmt_to_client(void *fn, void *data)
 133 {
 134         ((stmt_func *)fn)((struct statement *)data);
 135 }
 136
 137 static void pass_sym_to_client(void *fn, void *data)
 138 {
 139         ((sym_func *)fn)((struct symbol *)data);
 140 }
 141
 142 static void pass_sym_list_to_client(void *fn, void *data)
 143 {
 144         ((sym_list_func *)fn)((struct symbol_list *)data);
 145 }
 146
 147 void __pass_to_client(void *data, enum hook_type type)
 148 {
 149         struct hook_container *container;
 150
 151         FOR_EACH_PTR(hook_array[type], container) {
 152                 switch (data_types[type]) {
 153                 case EXPR_PTR:
 154                         pass_expr_to_client(container->fn, data);
 155                         break;
 156                 case STMT_PTR:
 157                         pass_stmt_to_client(container->fn, data);
 158                         break;
 159                 case SYMBOL_PTR:
 160                         pass_sym_to_client(container->fn, data);
 161                         break;
 162                 case SYM_LIST_PTR:
 163                         pass_sym_list_to_client(container->fn, data);
 164                         break;
 165                 }
 166         } END_FOR_EACH_PTR(container);
 167 }
 168
 169 void __pass_case_to_client(struct expression *switch_expr,
 170                            struct range_list *rl)
 171 {
 172         typedef void (case_func)(struct expression *switch_expr,
 173                                  struct range_list *rl);
 174         struct hook_container *container;
 175
 176         FOR_EACH_PTR(hook_array[CASE_HOOK], container) {
 177                 ((case_func *)container->fn)(switch_expr, rl);
 178         } END_FOR_EACH_PTR(container);
 179 }
 180
 181 int __has_merge_function(int client_id)
 182 {
 183         struct hook_container *tmp;
 184
 185         FOR_EACH_PTR(merge_funcs, tmp) {
 186                 if (tmp->owner == client_id)
 187                         return 1;
 188         } END_FOR_EACH_PTR(tmp);
 189         return 0;
 190 }
 191
 192 struct smatch_state *__client_merge_function(int owner,
 193                                              struct smatch_state *s1,
 194                                              struct smatch_state *s2)
 195 {
 196         struct smatch_state *tmp_state;
 197         struct hook_container *tmp;
 198
 199         /* Pass NULL states first and the rest alphabetically by name */
 200         if (!s2 || (s1 && strcmp(s2->name, s1->name) < 0)) {
 201                 tmp_state = s1;
 202                 s1 = s2;
 203                 s2 = tmp_state;
 204         }
 205
 206         FOR_EACH_PTR(merge_funcs, tmp) {
 207                 if (tmp->owner == owner)
 208                         return ((merge_func_t *)tmp->fn)(s1, s2);
 209         } END_FOR_EACH_PTR(tmp);
 210         return &undefined;
 211 }
 212
 213 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm)
 214 {
 215         struct hook_container *tmp;
 216
 217         FOR_EACH_PTR(unmatched_state_funcs, tmp) {
 218                 if (tmp->owner == sm->owner)
 219                         return ((unmatched_func_t *)tmp->fn)(sm);
 220         } END_FOR_EACH_PTR(tmp);
 221         return &undefined;
 222 }
 223
 224 void call_pre_merge_hook(struct sm_state *cur, struct sm_state *other)
 225 {
 226         if (cur->owner >= num_checks)
 227                 return;
 228
 229         if (pre_merge_hooks[cur->owner])
 230                 pre_merge_hooks[cur->owner](cur, other);
 231 }
 232
 233 static struct scope_hook_list *pop_scope_hook_list(struct scope_hook_stack **stack)
 234 {
 235         struct scope_hook_list *hook_list;
 236
 237         hook_list = last_ptr_list((struct ptr_list *)*stack);
 238         delete_ptr_list_last((struct ptr_list **)stack);
 239         return hook_list;
 240 }
 241
 242 static void push_scope_hook_list(struct scope_hook_stack **stack, struct scope_hook_list *l)
 243 {
 244         add_ptr_list(stack, l);
 245 }
 246
 247 void add_scope_hook(scope_hook *fn, void *data)
 248 {
 249         struct scope_hook_list *hook_list;
 250         struct scope_container *new;
 251
 252         if (!scope_hooks)
 253                 return;
 254         hook_list = pop_scope_hook_list(&scope_hooks);
 255         new = __alloc_scope_container(0);
 256         new->fn = fn;
 257         new->data = data;
 258         add_ptr_list(&hook_list, new);
 259         push_scope_hook_list(&scope_hooks, hook_list);
 260 }
 261
 262 void __push_scope_hooks(void)
 263 {
 264         push_scope_hook_list(&scope_hooks, NULL);
 265 }
 266
 267 void __call_scope_hooks(void)
 268 {
 269         struct scope_hook_list *hook_list;
 270         struct scope_container *tmp;
 271
 272         if (!scope_hooks)
 273                 return;
 274
 275         hook_list = pop_scope_hook_list(&scope_hooks);
 276         FOR_EACH_PTR(hook_list, tmp) {
 277                 ((scope_hook *)tmp->fn)(tmp->data);
 278                 __free_scope_container(tmp);
 279         } END_FOR_EACH_PTR(tmp);
 280 }
 281
 282 void add_array_initialized_hook(void (*hook)(struct expression *array, int nr))
 283 {
 284         struct hook_container *container = __alloc_hook_container(0);
 285
 286         container->fn = hook;
 287
 288         add_ptr_list(&array_init_hooks, container);
 289 }
 290
 291 void __call_array_initialized_hooks(struct expression *array, int nr)
 292 {
 293         struct hook_container *tmp;
 294
 295         FOR_EACH_PTR(array_init_hooks, tmp) {
 296                 ((array_init_hook *)tmp->fn)(array, nr);
 297         } END_FOR_EACH_PTR(tmp);
 298 }
 299
 300 void allocate_hook_memory(void)
 301 {
 302         pre_merge_hooks = malloc(num_checks * sizeof(*pre_merge_hooks));
 303         memset(pre_merge_hooks, 0, num_checks * sizeof(*pre_merge_hooks));
 304 }
 305
 306 void call_void_fns(struct void_fn_list *list)
 307 {
 308         void_fn *fn;
 309
 310         FOR_EACH_PTR(list, fn) {
 311                 (fn)();
 312         } END_FOR_EACH_PTR(fn);
 313 }
 314
 315 void call_expr_fns(struct expr_fn_list *list, struct expression *expr)
 316 {
 317         expr_func *fn;
 318
 319         FOR_EACH_PTR(list, fn) {
 320                 (fn)(expr);
 321         } END_FOR_EACH_PTR(fn);
 322 }
 323
 324 void call_stmt_fns(struct stmt_fn_list *list, struct statement *stmt)
 325 {
 326         stmt_func *fn;
 327
 328         FOR_EACH_PTR(list, fn) {
 329                 (fn)(stmt);
 330         } END_FOR_EACH_PTR(fn);
 331 }
 332
 333 void call_sym_fns(struct sym_fn_list *list, struct symbol *sym)
 334 {
 335         sym_func *fn;
 336
 337         FOR_EACH_PTR(list, fn) {
 338                 (fn)(sym);
 339         } END_FOR_EACH_PTR(fn);
 340 }
 341
 342 void call_name_sym_fns(struct name_sym_fn_list *list, struct expression *expr, const char *name, struct symbol *sym)
 343 {
 344         name_sym_hook *fn;
 345
 346         FOR_EACH_PTR(list, fn) {
 347                 (fn)(expr, name, sym);
 348         } END_FOR_EACH_PTR(fn);
 349 }
 350
 351 void call_string_hooks(struct string_hook_list *list, struct expression *expr, const char *str)
 352 {
 353         string_hook *fn;
 354
 355         FOR_EACH_PTR(list, fn) {
 356                 (fn)(expr, str);
 357         } END_FOR_EACH_PTR(fn);
 358 }
 359