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