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