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 CALL_ASSIGNMENT_HOOK:
  63                 container->data_type = EXPR_PTR;
  64                 break;
  65         case MACRO_ASSIGNMENT_HOOK:
  66                 container->data_type = EXPR_PTR;
  67                 break;
  68         case BINOP_HOOK:
  69                 container->data_type = EXPR_PTR;
  70                 break;
  71         case OP_HOOK:
  72                 container->data_type = EXPR_PTR;
  73                 break;
  74         case LOGIC_HOOK:
  75                 container->data_type = EXPR_PTR;
  76                 break;
  77         case CONDITION_HOOK:
  78                 container->data_type = EXPR_PTR;
  79                 break;
  80         case WHOLE_CONDITION_HOOK:
  81                 container->data_type = EXPR_PTR;
  82                 break;
  83         case FUNCTION_CALL_HOOK:
  84                 container->data_type = EXPR_PTR;
  85                 break;
  86         case DEREF_HOOK:
  87                 container->data_type = EXPR_PTR;
  88                 break;
  89         case CASE_HOOK:
  90                 /* nothing needed */
  91                 break;
  92         case ASM_HOOK:
  93                 container->data_type = STMT_PTR;
  94                 break;
  95         case BASE_HOOK:
  96                 container->data_type = SYMBOL_PTR;
  97                 break;
  98         case FUNC_DEF_HOOK:
  99                 container->data_type = SYMBOL_PTR;
 100                 break;
 101         case END_FUNC_HOOK:
 102                 container->data_type = SYMBOL_PTR;
 103                 break;
 104         case RETURN_HOOK:
 105                 container->data_type = EXPR_PTR;
 106                 break;
 107         case END_FILE_HOOK:
 108                 /* nothing needed... */
 109                 break;
 110         }
 111         add_ptr_list(&hook_funcs, container);
 112 }
 113
 114 void add_merge_hook(int client_id, merge_func_t *func)
 115 {
 116         struct hook_container *container = __alloc_hook_container(0);
 117         container->data_type = client_id;
 118         container->fn = func;
 119         add_ptr_list(&merge_funcs, container);
 120 }
 121
 122 void add_unmatched_state_hook(int client_id, unmatched_func_t *func)
 123 {
 124         struct hook_container *container = __alloc_hook_container(0);
 125         container->data_type = client_id;
 126         container->fn = func;
 127         add_ptr_list(&unmatched_state_funcs, container);
 128 }
 129
 130 static void pass_to_client(void * fn)
 131 {
 132         typedef void (expr_func)();
 133         ((expr_func *) fn)();
 134 }
 135
 136 static void pass_expr_to_client(void * fn, void * data)
 137 {
 138         typedef void (expr_func)(struct expression *expr);
 139         ((expr_func *) fn)((struct expression *) data);
 140 }
 141
 142 static void pass_stmt_to_client(void * fn, void * data)
 143 {
 144         typedef void (stmt_func)(struct statement *stmt);
 145         ((stmt_func *) fn)((struct statement *) data);
 146 }
 147
 148 static void pass_sym_to_client(void * fn, void * data)
 149 {
 150         typedef void (sym_func)(struct symbol *sym);
 151         ((sym_func *) fn)((struct symbol *) data);
 152 }
 153
 154 void __pass_to_client(void *data, enum hook_type type)
 155 {
 156         struct hook_container *container;
 157
 158 //      if (!data)
 159 //              return;
 160
 161         FOR_EACH_PTR(hook_funcs, container) {
 162                 if (container->hook_type == type) {
 163                         switch (container->data_type) {
 164                         case EXPR_PTR:
 165                                 pass_expr_to_client(container->fn, data);
 166                                 break;
 167                         case STMT_PTR:
 168                                 pass_stmt_to_client(container->fn, data);
 169                                 break;
 170                         case SYMBOL_PTR:
 171                                 pass_sym_to_client(container->fn, data);
 172                                 break;
 173                         }
 174                 }
 175         } END_FOR_EACH_PTR(container);
 176 }
 177
 178 void __pass_to_client_no_data(enum hook_type type)
 179 {
 180         struct hook_container *container;
 181
 182         FOR_EACH_PTR(hook_funcs, container) {
 183                 if (container->hook_type == type)
 184                         pass_to_client(container->fn);
 185         } END_FOR_EACH_PTR(container);
 186 }
 187
 188 void __pass_case_to_client(struct expression *switch_expr,
 189                            struct expression *case_expr)
 190 {
 191         typedef void (case_func)(struct expression *switch_expr,
 192                                  struct expression *case_expr);
 193         struct hook_container *container;
 194
 195         FOR_EACH_PTR(hook_funcs, container) {
 196                 if (container->hook_type == CASE_HOOK) {
 197                         ((case_func *) container->fn)(switch_expr, case_expr);
 198                 }
 199         } END_FOR_EACH_PTR(container);
 200 }
 201
 202 int __has_merge_function(int client_id)
 203 {
 204         struct hook_container *tmp;
 205
 206         FOR_EACH_PTR(merge_funcs, tmp) {
 207                 if (tmp->data_type == client_id)
 208                         return 1;
 209         } END_FOR_EACH_PTR(tmp);
 210         return 0;
 211 }
 212
 213 struct smatch_state *__client_merge_function(int owner, const char *name,
 214                                              struct symbol *sym,
 215                                              struct smatch_state *s1,
 216                                              struct smatch_state *s2)
 217 {
 218         struct smatch_state *tmp_state;
 219         struct hook_container *tmp;
 220
 221         /* Pass NULL states first and the rest alphabetically by name */
 222         if (!s2 || (s1 && strcmp(s2->name, s1->name) < 0)) {
 223                 tmp_state = s1;
 224                 s1 = s2;
 225                 s2 = tmp_state;
 226         }
 227
 228         FOR_EACH_PTR(merge_funcs, tmp) {
 229                 if (tmp->data_type == owner)
 230                         return ((merge_func_t *) tmp->fn)(name, sym, s1, s2);
 231         } END_FOR_EACH_PTR(tmp);
 232         return &undefined;
 233 }
 234
 235 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm)
 236 {
 237         struct hook_container *tmp;
 238
 239         FOR_EACH_PTR(unmatched_state_funcs, tmp) {
 240                 if (tmp->data_type == sm->owner)
 241                         return ((unmatched_func_t *) tmp->fn)(sm);
 242         } END_FOR_EACH_PTR(tmp);
 243         return &undefined;
 244 }
 245
 246 static struct scope_hook_list *pop_scope_hook_list(struct scope_hook_stack **stack)
 247 {
 248         struct scope_hook_list *hook_list;
 249
 250         hook_list = last_ptr_list((struct ptr_list *)*stack);
 251         delete_ptr_list_last((struct ptr_list **)stack);
 252         return hook_list;
 253 }
 254
 255 static void push_scope_hook_list(struct scope_hook_stack **stack, struct scope_hook_list *l)
 256 {
 257         add_ptr_list(stack, l);
 258 }
 259
 260 void add_scope_hook(scope_hook *fn, void *data)
 261 {
 262         struct scope_hook_list *hook_list;
 263         struct scope_container *new;
 264
 265         if (!scope_hooks)
 266                 return;
 267         hook_list = pop_scope_hook_list(&scope_hooks);
 268         new = __alloc_scope_container(0);
 269         new->fn = fn;
 270         new->data = data;
 271         add_ptr_list(&hook_list, new);
 272         push_scope_hook_list(&scope_hooks, hook_list);
 273 }
 274
 275 void __push_scope_hooks(void)
 276 {
 277         push_scope_hook_list(&scope_hooks, NULL);
 278 }
 279
 280 void __call_scope_hooks(void)
 281 {
 282         struct scope_hook_list *hook_list;
 283         struct scope_container *tmp;
 284
 285         if (!scope_hooks)
 286                 return;
 287
 288         hook_list = pop_scope_hook_list(&scope_hooks);
 289         FOR_EACH_PTR(hook_list, tmp) {
 290                 ((scope_hook *) tmp->fn)(tmp->data);
 291                 __free_scope_container(tmp);
 292         } END_FOR_EACH_PTR(tmp);
 293 }