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