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