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