smatch.h

   1 /*
   2  * sparse/smatch.h
   3  *
   4  * Copyright (C) 2006 Dan Carpenter.
   5  *
   6  *  Licensed under the Open Software License version 1.1
   7  *
   8  */
   9
  10 #ifndef         SMATCH_H_
  11 # define        SMATCH_H_
  12
  13 #include <stdio.h>
  14 #include <string.h>
  15 #include <limits.h>
  16 #include "lib.h"
  17 #include "allocate.h"
  18 #include "parse.h"
  19 #include "expression.h"
  20
  21 #define KERNEL
  22 struct smatch_state {
  23         const char *name;
  24         void *data;
  25 };
  26 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
  27 extern struct smatch_state undefined;
  28 extern struct smatch_state merged;
  29 extern struct smatch_state true_state;
  30 extern struct smatch_state false_state;
  31
  32 enum hook_type {
  33         EXPR_HOOK,
  34         STMT_HOOK,
  35         SYM_HOOK,
  36         DECLARATION_HOOK,
  37         ASSIGNMENT_HOOK,
  38         ASSIGNMENT_AFTER_HOOK,
  39         CONDITION_HOOK,
  40         WHOLE_CONDITION_HOOK,
  41         FUNCTION_CALL_HOOK,
  42         FUNCTION_CALL_AFTER_HOOK,
  43         OP_HOOK,
  44         DEREF_HOOK,
  45         BASE_HOOK,
  46         FUNC_DEF_HOOK,
  47         END_FUNC_HOOK,
  48         RETURN_HOOK,
  49         END_FILE_HOOK,
  50 };
  51 void add_hook(void *func, enum hook_type type);
  52 typedef struct smatch_state *(merge_func_t)(const char *name,
  53                                             struct symbol *sym,
  54                                             struct smatch_state *s1,
  55                                             struct smatch_state *s2);
  56 void add_merge_hook(int client_id, merge_func_t *func);
  57
  58 #define smatch_msg(msg...) \
  59 do {                                                          \
  60         printf("%s +%d %s(%d) ", get_filename(), get_lineno(), \
  61                get_function(), get_func_pos());               \
  62         printf(msg);                                          \
  63         printf("\n");                                         \
  64 } while (0)
  65
  66 #define SM_DEBUG(msg...) do { if (debug_states) printf(msg); } while (0)
  67
  68 #define UNDEFINED INT_MIN
  69
  70 struct smatch_state *get_state(const char *name, int owner, struct symbol *sym);
  71 struct state_list *get_possible_states(const char *name, int owner,
  72                                        struct symbol *sym);
  73 void set_state(const char *name, int owner, struct symbol *sym,
  74                struct smatch_state *state);
  75 void delete_state(const char *name, int owner, struct symbol *sym);
  76 void set_true_false_states(const char *name, int owner, struct symbol *sym,
  77                            struct smatch_state *true_state,
  78                            struct smatch_state *false_state);
  79
  80 struct state_list *get_all_states(int id);
  81 char *get_filename();
  82 char *get_function();
  83 int get_lineno();
  84 int get_func_pos();
  85
  86 /* smatch_helper.c */
  87 char *alloc_string(char *str);
  88 void free_string(char *str);
  89 struct expression *get_argument_from_call_expr(struct expression_list *args,
  90                                                int num);
  91 char *get_variable_from_expr_complex(struct expression *expr,
  92                                      struct symbol **sym_ptr);
  93 char *get_variable_from_expr(struct expression *expr,
  94                              struct symbol **sym_ptr);
  95 int sym_name_is(const char *name, struct expression *expr);
  96 int get_value(struct expression *expr);
  97 int is_zero(struct expression *expr);
  98 const char *show_state(struct smatch_state *state);
  99 struct expression *strip_expr(struct expression *expr);
 100
 101 /* smatch_ignore.c */
 102 struct tracker {
 103         const char *name;
 104         int owner;
 105         struct symbol *sym;
 106 };
 107 DECLARE_PTR_LIST(tracker_list, struct tracker);
 108
 109 void add_ignore(const char *name, int owner, struct symbol *sym);
 110 int is_ignored(const char *name, int owner, struct symbol *sym);
 111
 112 /* smatch_tracker */
 113 void add_tracker(struct tracker_list **list, const char *name, int owner,
 114                 struct symbol *sym);
 115 int in_tracker_list(struct tracker_list *list, const char *name, int owner,
 116                 struct symbol *sym);
 117
 118
 119 /* smatch_conditions */
 120 int in_condition();
 121
 122 /* ----------------------------------------------------------------
 123    The stuff below is all used internally and shouldn't
 124    be called from other programs
 125  -----------------------------------------------------------------*/
 126
 127 /* smatch_flow.c */
 128
 129 void smatch (int argc, char **argv);
 130 void __split_expr(struct expression *expr);
 131
 132 /* smatch_conditions */
 133 void __split_whole_condition(struct expression *expr);
 134
 135 /* smatch_implied.c */
 136 void __implied_states_hook(struct expression *expr);
 137
 138 /* smatch_extras.c */
 139 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
 140 int known_condition_true(struct expression *expr);
 141
 142 /* smatch_states.c */
 143 extern int debug_states;
 144
 145 struct state_list *__get_cur_slist();
 146 void nullify_path();
 147 void __unnullify_path();
 148 int __path_is_null();
 149 void clear_all_states();
 150
 151 struct sm_state *__get_sm_state(const char *name, int owner,
 152                                 struct symbol *sym);
 153 void __use_false_only_stack();
 154 void __pop_false_only_stack();
 155 void __push_true_states();
 156 void __use_false_states();
 157 void __pop_false_states();
 158 void __merge_false_states();
 159 void __merge_true_states();
 160
 161 void __negate_cond_stacks();
 162 void __save_false_states_for_later();
 163 void __use_previously_stored_false_states();
 164 void __use_cond_true_states();
 165 void __use_cond_false_states();
 166 void __push_cond_stacks();
 167 void __and_cond_states();
 168 void __or_cond_states();
 169 void __save_pre_cond_states();
 170 void __pop_pre_cond_states();
 171 void __use_cond_states();
 172
 173 void __push_continues();
 174 void __pop_continues();
 175 void __process_continues();
 176 void __merge_continues();
 177
 178 void __push_breaks();
 179 void __process_breaks();
 180 void __merge_breaks();
 181 void __use_breaks();
 182
 183 void __save_switch_states();
 184 void __pop_switches();
 185 void __merge_switches();
 186 void __push_default();
 187 void __set_default();
 188 int __pop_default();
 189
 190 void __push_conditions();
 191 void __pop_conditions();
 192
 193 void __save_gotos(const char *name);
 194 void __merge_gotos(const char *name);
 195
 196 void __print_cur_slist();
 197
 198 /* smatch_hooks.c */
 199 void __pass_to_client(void *data, enum hook_type type);
 200 void __pass_to_client_no_data(enum hook_type type);
 201 void __pass_declarations_to_client(struct symbol_list *sym_list);
 202 int __has_merge_function(int client_id);
 203 struct smatch_state *__client_merge_function(int owner, const char *name, struct symbol *sym,
 204                             struct smatch_state *s1, struct smatch_state *s2);
 205
 206 #endif      /* !SMATCH_H_ */