extra: write certain returned struct members in terms of parameter math
[smatch.git] / lib.h
blob6b6922bb478fcfe8ac264393ae02586e5cacd763
1 #ifndef LIB_H
2 #define LIB_H
4 #include <stdlib.h>
5 #include <stddef.h>
7 /*
8 * Basic helper routine descriptions for 'sparse'.
10 * Copyright (C) 2003 Transmeta Corp.
11 * 2003 Linus Torvalds
12 * 2004 Christopher Li
14 * Permission is hereby granted, free of charge, to any person obtaining a copy
15 * of this software and associated documentation files (the "Software"), to deal
16 * in the Software without restriction, including without limitation the rights
17 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18 * copies of the Software, and to permit persons to whom the Software is
19 * furnished to do so, subject to the following conditions:
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
27 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
30 * THE SOFTWARE.
33 #include "compat.h"
34 #include "ptrlist.h"
36 #define DO_STRINGIFY(x) #x
37 #define STRINGIFY(x) DO_STRINGIFY(x)
39 #ifndef ARRAY_SIZE
40 #define ARRAY_SIZE(x) (sizeof(x)/sizeof((x)[0]))
41 #endif
43 extern int verbose, optimize, optimize_size, preprocessing;
44 extern int die_if_error;
45 extern int repeat_phase, merge_phi_sources;
46 extern int gcc_major, gcc_minor, gcc_patchlevel;
48 extern unsigned int hexval(unsigned int c);
50 struct position {
51 unsigned int type:6,
52 stream:14,
53 newline:1,
54 whitespace:1,
55 pos:10;
56 unsigned int line:31,
57 noexpand:1;
60 struct ident;
61 struct token;
62 struct symbol;
63 struct statement;
64 struct expression;
65 struct basic_block;
66 struct entrypoint;
67 struct instruction;
68 struct multijmp;
69 struct pseudo;
71 DECLARE_PTR_LIST(symbol_list, struct symbol);
72 DECLARE_PTR_LIST(statement_list, struct statement);
73 DECLARE_PTR_LIST(expression_list, struct expression);
74 DECLARE_PTR_LIST(basic_block_list, struct basic_block);
75 DECLARE_PTR_LIST(instruction_list, struct instruction);
76 DECLARE_PTR_LIST(context_list, struct context);
77 DECLARE_PTR_LIST(multijmp_list, struct multijmp);
78 DECLARE_PTR_LIST(pseudo_list, struct pseudo);
79 DECLARE_PTR_LIST(string_list, char);
81 typedef struct pseudo *pseudo_t;
83 struct token *skip_to(struct token *, int);
84 struct token *expect(struct token *, int, const char *);
85 #ifdef __GNUC__
86 #define FORMAT_ATTR(pos) __attribute__ ((__format__ (__printf__, pos, pos+1)))
87 #define NORETURN_ATTR __attribute__ ((__noreturn__))
88 #define SENTINEL_ATTR __attribute__ ((__sentinel__))
89 #else
90 #define FORMAT_ATTR(pos)
91 #define NORETURN_ATTR
92 #define SENTINEL_ATTR
93 #endif
94 extern void die(const char *, ...) FORMAT_ATTR(1) NORETURN_ATTR;
95 extern void info(struct position, const char *, ...) FORMAT_ATTR(2);
96 extern void warning(struct position, const char *, ...) FORMAT_ATTR(2);
97 extern void sparse_error(struct position, const char *, ...) FORMAT_ATTR(2);
98 extern void error_die(struct position, const char *, ...) FORMAT_ATTR(2) NORETURN_ATTR;
99 extern void expression_error(struct expression *, const char *, ...) FORMAT_ATTR(2);
101 extern void add_pre_buffer(const char *fmt, ...) FORMAT_ATTR(1);
103 extern int preprocess_only;
105 extern int Waddress_space;
106 extern int Wbitwise;
107 extern int Wcast_to_as;
108 extern int Wcast_truncate;
109 extern int Wcontext;
110 extern int Wdecl;
111 extern int Wdeclarationafterstatement;
112 extern int Wdefault_bitfield_sign;
113 extern int Wdesignated_init;
114 extern int Wdo_while;
115 extern int Wenum_mismatch;
116 extern int Winit_cstring;
117 extern int Wnon_pointer_null;
118 extern int Wold_initializer;
119 extern int Wone_bit_signed_bitfield;
120 extern int Wparen_string;
121 extern int Wptr_subtraction_blows;
122 extern int Wreturn_void;
123 extern int Wshadow;
124 extern int Wsizeof_bool;
125 extern int Wtransparent_union;
126 extern int Wtypesign;
127 extern int Wundef;
128 extern int Wuninitialized;
129 extern int Wvla;
131 extern int dbg_entry;
132 extern int dbg_dead;
134 extern int arch_m64;
136 extern void declare_builtin_functions(void);
137 extern void create_builtin_stream(void);
138 extern struct symbol_list *sparse_initialize(int argc, char **argv, struct string_list **files);
139 extern struct symbol_list *__sparse(char *filename);
140 extern struct symbol_list *sparse_keep_tokens(char *filename);
141 extern struct symbol_list *sparse(char *filename);
143 static inline int symbol_list_size(struct symbol_list *list)
145 return ptr_list_size((struct ptr_list *)(list));
148 static inline int statement_list_size(struct statement_list *list)
150 return ptr_list_size((struct ptr_list *)(list));
153 static inline int context_list_size(struct context_list *list)
155 return ptr_list_size((struct ptr_list *)(list));
158 static inline int expression_list_size(struct expression_list *list)
160 return ptr_list_size((struct ptr_list *)(list));
163 static inline int instruction_list_size(struct instruction_list *list)
165 return ptr_list_size((struct ptr_list *)(list));
168 static inline int pseudo_list_size(struct pseudo_list *list)
170 return ptr_list_size((struct ptr_list *)(list));
173 static inline int bb_list_size(struct basic_block_list *list)
175 return ptr_list_size((struct ptr_list *)(list));
178 static inline void free_instruction_list(struct instruction_list **head)
180 free_ptr_list((struct ptr_list **)head);
183 static inline struct instruction * delete_last_instruction(struct instruction_list **head)
185 return undo_ptr_list_last((struct ptr_list **)head);
188 static inline struct basic_block * delete_last_basic_block(struct basic_block_list **head)
190 return delete_ptr_list_last((struct ptr_list **)head);
193 static inline struct basic_block *first_basic_block(struct basic_block_list *head)
195 return first_ptr_list((struct ptr_list *)head);
197 static inline struct instruction *last_instruction(struct instruction_list *head)
199 return last_ptr_list((struct ptr_list *)head);
202 static inline struct instruction *first_instruction(struct instruction_list *head)
204 return first_ptr_list((struct ptr_list *)head);
207 static inline pseudo_t first_pseudo(struct pseudo_list *head)
209 return first_ptr_list((struct ptr_list *)head);
212 static inline void concat_symbol_list(struct symbol_list *from, struct symbol_list **to)
214 concat_ptr_list((struct ptr_list *)from, (struct ptr_list **)to);
217 static inline void concat_basic_block_list(struct basic_block_list *from, struct basic_block_list **to)
219 concat_ptr_list((struct ptr_list *)from, (struct ptr_list **)to);
222 static inline void concat_instruction_list(struct instruction_list *from, struct instruction_list **to)
224 concat_ptr_list((struct ptr_list *)from, (struct ptr_list **)to);
227 static inline void add_symbol(struct symbol_list **list, struct symbol *sym)
229 add_ptr_list(list, sym);
232 static inline void add_statement(struct statement_list **list, struct statement *stmt)
234 add_ptr_list(list, stmt);
237 static inline void add_expression(struct expression_list **list, struct expression *expr)
239 add_ptr_list(list, expr);
242 #define hashval(x) ((unsigned long)(x))
244 #endif