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