smatch_hooks.c

   1 /*
   2  * sparse/smatch_hooks.c
   3  *
   4  * Copyright (C) 2006 Dan Carpenter.
   5  *
   6  *  Licensed under the Open Software License version 1.1
   7  *
   8  */
   9
  10 #include "smatch.h"
  11
  12 enum data_type {
  13         EXPR_PTR,
  14         STMT_PTR,
  15         SYMBOL_PTR,
  16 };
  17
  18 struct hook_container {
  19         int hook_type;
  20         enum data_type data_type;
  21         void *fn;
  22 };
  23 ALLOCATOR(hook_container, "hook functions");
  24 DECLARE_PTR_LIST(hook_func_list, struct hook_container);
  25 static struct hook_func_list *hook_funcs;
  26 static struct hook_func_list *merge_funcs;
  27 static struct hook_func_list *unmatched_state_funcs;
  28
  29 struct scope_container {
  30         void *fn;
  31         void *data;
  32 };
  33 ALLOCATOR(scope_container, "scope hook functions");
  34 DECLARE_PTR_LIST(scope_hook_list, struct scope_container);
  35 DECLARE_PTR_LIST(scope_hook_stack, struct scope_hook_list);
  36 static struct scope_hook_stack *scope_hooks;
  37
  38 void add_hook(void *func, enum hook_type type)
  39 {
  40         struct hook_container *container = __alloc_hook_container(0);
  41         container->hook_type = type;
  42         container->fn = func;
  43         switch (type) {
  44         case EXPR_HOOK:
  45                 container->data_type = EXPR_PTR;
  46                 break;
  47         case STMT_HOOK:
  48                 container->data_type = STMT_PTR;
  49                 break;
  50         case SYM_HOOK:
  51                 container->data_type = EXPR_PTR;
  52                 break;
  53         case STRING_HOOK:
  54                 container->data_type = EXPR_PTR;
  55                 break;
  56         case DECLARATION_HOOK:
  57                 container->data_type = SYMBOL_PTR;
  58                 break;
  59         case ASSIGNMENT_HOOK:
  60                 container->data_type = EXPR_PTR;
  61                 break;
  62         case RAW_ASSIGNMENT_HOOK:
  63                 container->data_type = EXPR_PTR;
  64                 break;
  65         case CALL_ASSIGNMENT_HOOK:
  66                 container->data_type = EXPR_PTR;
  67                 break;
  68         case MACRO_ASSIGNMENT_HOOK:
  69                 container->data_type = EXPR_PTR;
  70                 break;
  71         case BINOP_HOOK:
  72                 container->data_type = EXPR_PTR;
  73                 break;
  74         case OP_HOOK:
  75                 container->data_type = EXPR_PTR;
  76                 break;
  77         case LOGIC_HOOK:
  78                 container->data_type = EXPR_PTR;
  79                 break;
  80         case PRELOOP_HOOK:
  81                 container->data_type = STMT_PTR;
  82                 break;
  83         case CONDITION_HOOK:
  84                 container->data_type = EXPR_PTR;
  85                 break;
  86         case SELECT_HOOK:
  87                 container->data_type = EXPR_PTR;
  88                 break;
  89         case WHOLE_CONDITION_HOOK:
  90                 container->data_type = EXPR_PTR;
  91                 break;
  92         case FUNCTION_CALL_HOOK:
  93                 container->data_type = EXPR_PTR;
  94                 break;
  95         case DEREF_HOOK:
  96                 container->data_type = EXPR_PTR;
  97                 break;
  98         case CASE_HOOK:
  99                 /* nothing needed */
 100                 break;
 101         case ASM_HOOK:
 102                 container->data_type = STMT_PTR;
 103                 break;
 104         case CAST_HOOK:
 105                 container->data_type = EXPR_PTR;
 106                 break;
 107         case BASE_HOOK:
 108                 container->data_type = SYMBOL_PTR;
 109                 break;
 110         case FUNC_DEF_HOOK:
 111                 container->data_type = SYMBOL_PTR;
 112                 break;
 113         case END_FUNC_HOOK:
 114                 container->data_type = SYMBOL_PTR;
 115                 break;
 116         case RETURN_HOOK:
 117                 container->data_type = EXPR_PTR;
 118                 break;
 119         case END_FILE_HOOK:
 120                 /* nothing needed... */
 121                 break;
 122         }
 123         add_ptr_list(&hook_funcs, container);
 124 }
 125
 126 void add_merge_hook(int client_id, merge_func_t *func)
 127 {
 128         struct hook_container *container = __alloc_hook_container(0);
 129         container->data_type = client_id;
 130         container->fn = func;
 131         add_ptr_list(&merge_funcs, container);
 132 }
 133
 134 void add_unmatched_state_hook(int client_id, unmatched_func_t *func)
 135 {
 136         struct hook_container *container = __alloc_hook_container(0);
 137         container->data_type = client_id;
 138         container->fn = func;
 139         add_ptr_list(&unmatched_state_funcs, container);
 140 }
 141
 142 static void pass_to_client(void *fn)
 143 {
 144         typedef void (expr_func)();
 145         ((expr_func *) fn)();
 146 }
 147
 148 static void pass_expr_to_client(void *fn, void *data)
 149 {
 150         typedef void (expr_func)(struct expression *expr);
 151         ((expr_func *) fn)((struct expression *) data);
 152 }
 153
 154 static void pass_stmt_to_client(void *fn, void *data)
 155 {
 156         typedef void (stmt_func)(struct statement *stmt);
 157         ((stmt_func *) fn)((struct statement *) data);
 158 }
 159
 160 static void pass_sym_to_client(void *fn, void *data)
 161 {
 162         typedef void (sym_func)(struct symbol *sym);
 163         ((sym_func *) fn)((struct symbol *) data);
 164 }
 165
 166 void __pass_to_client(void *data, enum hook_type type)
 167 {
 168         struct hook_container *container;
 169
 170         FOR_EACH_PTR(hook_funcs, container) {
 171                 if (container->hook_type == type) {
 172                         switch (container->data_type) {
 173                         case EXPR_PTR:
 174                                 pass_expr_to_client(container->fn, data);
 175                                 break;
 176                         case STMT_PTR:
 177                                 pass_stmt_to_client(container->fn, data);
 178                                 break;
 179                         case SYMBOL_PTR:
 180                                 pass_sym_to_client(container->fn, data);
 181                                 break;
 182                         }
 183                 }
 184         } END_FOR_EACH_PTR(container);
 185 }
 186
 187 void __pass_to_client_no_data(enum hook_type type)
 188 {
 189         struct hook_container *container;
 190
 191         FOR_EACH_PTR(hook_funcs, container) {
 192                 if (container->hook_type == type)
 193                         pass_to_client(container->fn);
 194         } END_FOR_EACH_PTR(container);
 195 }
 196
 197 void __pass_case_to_client(struct expression *switch_expr,
 198                            struct expression *case_expr)
 199 {
 200         typedef void (case_func)(struct expression *switch_expr,
 201                                  struct expression *case_expr);
 202         struct hook_container *container;
 203
 204         FOR_EACH_PTR(hook_funcs, container) {
 205                 if (container->hook_type == CASE_HOOK)
 206                         ((case_func *) container->fn)(switch_expr, case_expr);
 207         } END_FOR_EACH_PTR(container);
 208 }
 209
 210 int __has_merge_function(int client_id)
 211 {
 212         struct hook_container *tmp;
 213
 214         FOR_EACH_PTR(merge_funcs, tmp) {
 215                 if (tmp->data_type == client_id)
 216                         return 1;
 217         } END_FOR_EACH_PTR(tmp);
 218         return 0;
 219 }
 220
 221 struct smatch_state *__client_merge_function(int owner,
 222                                              struct smatch_state *s1,
 223                                              struct smatch_state *s2)
 224 {
 225         struct smatch_state *tmp_state;
 226         struct hook_container *tmp;
 227
 228         /* Pass NULL states first and the rest alphabetically by name */
 229         if (!s2 || (s1 && strcmp(s2->name, s1->name) < 0)) {
 230                 tmp_state = s1;
 231                 s1 = s2;
 232                 s2 = tmp_state;
 233         }
 234
 235         FOR_EACH_PTR(merge_funcs, tmp) {
 236                 if (tmp->data_type == owner)
 237                         return ((merge_func_t *) tmp->fn)(s1, s2);
 238         } END_FOR_EACH_PTR(tmp);
 239         return &undefined;
 240 }
 241
 242 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm)
 243 {
 244         struct hook_container *tmp;
 245
 246         FOR_EACH_PTR(unmatched_state_funcs, tmp) {
 247                 if (tmp->data_type == sm->owner)
 248                         return ((unmatched_func_t *) tmp->fn)(sm);
 249         } END_FOR_EACH_PTR(tmp);
 250         return &undefined;
 251 }
 252
 253 static struct scope_hook_list *pop_scope_hook_list(struct scope_hook_stack **stack)
 254 {
 255         struct scope_hook_list *hook_list;
 256
 257         hook_list = last_ptr_list((struct ptr_list *)*stack);
 258         delete_ptr_list_last((struct ptr_list **)stack);
 259         return hook_list;
 260 }
 261
 262 static void push_scope_hook_list(struct scope_hook_stack **stack, struct scope_hook_list *l)
 263 {
 264         add_ptr_list(stack, l);
 265 }
 266
 267 void add_scope_hook(scope_hook *fn, void *data)
 268 {
 269         struct scope_hook_list *hook_list;
 270         struct scope_container *new;
 271
 272         if (!scope_hooks)
 273                 return;
 274         hook_list = pop_scope_hook_list(&scope_hooks);
 275         new = __alloc_scope_container(0);
 276         new->fn = fn;
 277         new->data = data;
 278         add_ptr_list(&hook_list, new);
 279         push_scope_hook_list(&scope_hooks, hook_list);
 280 }
 281
 282 void __push_scope_hooks(void)
 283 {
 284         push_scope_hook_list(&scope_hooks, NULL);
 285 }
 286
 287 void __call_scope_hooks(void)
 288 {
 289         struct scope_hook_list *hook_list;
 290         struct scope_container *tmp;
 291
 292         if (!scope_hooks)
 293                 return;
 294
 295         hook_list = pop_scope_hook_list(&scope_hooks);
 296         FOR_EACH_PTR(hook_list, tmp) {
 297                 ((scope_hook *) tmp->fn)(tmp->data);
 298                 __free_scope_container(tmp);
 299         } END_FOR_EACH_PTR(tmp);
 300 }