xref: /netbsd/usr.bin/xlint/lint1/lint1.h (revision bf9ec67e)
1 /* $NetBSD: lint1.h,v 1.13 2002/02/05 03:04:29 thorpej Exp $ */
2 
3 /*
4  * Copyright (c) 1996 Christopher G. Demetriou.  All Rights Reserved.
5  * Copyright (c) 1994, 1995 Jochen Pohl
6  * All Rights Reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *      This product includes software developed by Jochen Pohl for
19  *	The NetBSD Project.
20  * 4. The name of the author may not be used to endorse or promote products
21  *    derived from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #include "lint.h"
36 #include "op.h"
37 
38 /* XXX - works for most systems, but the whole ALIGN thing needs to go away */
39 #ifndef ALIGN
40 #define ALIGN(x) (((x) + 7) & ~7)
41 #endif
42 
43 /*
44  * Describes the position of a declaration or anything else.
45  */
46 typedef struct {
47 	int	p_line;
48 	const	char *p_file;
49 	int	p_uniq;			/* uniquifier */
50 } pos_t;
51 
52 /* Copies curr_pos, keeping things unique. */
53 #define UNIQUE_CURR_POS(pos)						\
54     do {								\
55     	STRUCT_ASSIGN((pos), curr_pos);					\
56 	curr_pos.p_uniq++;						\
57 	if (curr_pos.p_file == csrc_pos.p_file)				\
58 	    csrc_pos.p_uniq++;						\
59     } while (0)
60 
61 /*
62  * Strings cannot be referenced to simply by a pointer to its first
63  * char. This is because strings can contain NUL characters other than the
64  * trailing NUL.
65  *
66  * Strings are stored with a trailing NUL.
67  */
68 typedef	struct strg {
69 	tspec_t	st_tspec;		/* CHAR or WCHAR */
70 	size_t	st_len;			/* length without trailing NUL */
71 	union {
72 		u_char	*_st_cp;
73 		wchar_t	*_st_wcp;
74 	} st_u;
75 } strg_t;
76 
77 #define st_cp	st_u._st_cp
78 #define	st_wcp	st_u._st_wcp
79 
80 /*
81  * qualifiers (only for lex/yacc interface)
82  */
83 typedef enum {
84 	CONST, VOLATILE
85 } tqual_t;
86 
87 /*
88  * Integer and floating point values are stored in this structure
89  */
90 typedef struct {
91 	tspec_t	v_tspec;
92 	int	v_ansiu;		/* set if an integer constant is
93 					   unsigned in ANSI C */
94 	union {
95 		int64_t	_v_quad;	/* integers */
96 		ldbl_t	_v_ldbl;	/* floats */
97 	} v_u;
98 } val_t;
99 
100 #define v_quad	v_u._v_quad
101 #define v_ldbl	v_u._v_ldbl
102 
103 /*
104  * Structures of type str_t uniqely identify structures. This can't
105  * be done in structures of type type_t, because these are copied
106  * if they must be modified. So it would not be possible to check
107  * if to structures are identical by comparing the pointers to
108  * the type structures.
109  *
110  * The typename is used if the structure is unnamed to identify
111  * the structure type in pass 2.
112  */
113 typedef	struct {
114 	u_int	size;		/* size in bit */
115 	u_int	align : 15;	/* alignment in bit */
116 	u_int	sincompl : 1;	/* set if incomplete type */
117 	struct	sym *memb;	/* list of members */
118 	struct	sym *stag;	/* symbol table entry of tag */
119 	struct	sym *stdef;	/* symbol table entry of first typename */
120 } str_t;
121 
122 /*
123  * same as above for enums
124  */
125 typedef	struct {
126 	u_int	eincompl : 1;	/* incomplete enum type */
127 	struct	sym *elem;	/* list of enumerators */
128 	struct	sym *etag;	/* symbol table entry of tag */
129 	struct	sym *etdef;	/* symbol table entry of first typename */
130 } enum_t;
131 
132 /*
133  * Types are represented by concatenation of structures of type type_t
134  * via t_subt.
135  */
136 typedef	struct type {
137 	tspec_t	t_tspec;	/* type specifier */
138 	u_int	t_aincompl : 1;	/* incomplete array type */
139 	u_int	t_const : 1;	/* const modifier */
140 	u_int	t_volatile : 1;	/* volatile modifier */
141 	u_int	t_proto : 1;	/* function prototype (t_args valid) */
142 	u_int	t_vararg : 1;	/* protoype with ... */
143 	u_int	t_typedef : 1;	/* type defined with typedef */
144 	u_int	t_isfield : 1;	/* type is bitfield */
145 	u_int	t_isenum : 1;	/* type is (or was) enum (t_enum valid) */
146 	union {
147 		int	_t_dim;		/* dimension */
148 		str_t	*_t_str;	/* struct/union tag */
149 		enum_t	*_t_enum;	/* enum tag */
150 		struct	sym *_t_args;	/* arguments (if t_proto) */
151 	} t_u;
152 	struct {
153 		u_int	_t_flen : 8;	/* length of bit-field */
154 		u_int	_t_foffs : 24;	/* offset of bit-field */
155 	} t_b;
156 	struct	type *t_subt;	/* element type (arrays), return value
157 				   (functions), or type pointer points to */
158 } type_t;
159 
160 #define	t_dim	t_u._t_dim
161 #define	t_str	t_u._t_str
162 #define	t_field	t_u._t_field
163 #define	t_enum	t_u._t_enum
164 #define	t_args	t_u._t_args
165 #define	t_flen	t_b._t_flen
166 #define	t_foffs	t_b._t_foffs
167 
168 /*
169  * types of symbols
170  */
171 typedef	enum {
172 	FVFT,		/* variables, functions, type names, enums */
173 	FMOS,		/* members of structs or unions */
174 	FTAG,		/* tags */
175 	FLAB		/* labels */
176 } symt_t;
177 
178 /*
179  * storage classes
180  */
181 typedef enum {
182 	NOSCL,
183 	EXTERN,		/* external symbols (indep. of decl_t) */
184 	STATIC,		/* static symbols (local and global) */
185 	AUTO,		/* automatic symbols (except register) */
186 	REG,		/* register */
187 	TYPEDEF,	/* typedef */
188 	STRTAG,
189 	UNIONTAG,
190 	ENUMTAG,
191 	MOS,		/* member of struct */
192 	MOU,		/* member of union */
193 	ENUMCON,	/* enumerator */
194 	ABSTRACT,	/* abstract symbol (sizeof, casts, unnamed argument) */
195 	ARG,		/* argument */
196 	PARG,		/* used in declaration stack during prototype
197 			   declaration */
198 	INLINE		/* only used by the parser */
199 } scl_t;
200 
201 /*
202  * symbol table entry
203  */
204 typedef	struct sym {
205 	const	char *s_name;	/* name */
206 	const	char *s_rename;	/* renamed symbol's given name */
207 	pos_t	s_dpos;		/* position of last (prototype)definition,
208 				   prototypedeclaration, no-prototype-def.,
209 				   tentative definition or declaration,
210 				   in this order */
211 	pos_t	s_spos;		/* position of first initialisation */
212 	pos_t	s_upos;		/* position of first use */
213 	symt_t	s_kind;		/* type of symbol */
214 	u_int	s_keyw : 1;	/* keyword */
215 	u_int	s_field : 1;	/* bit-field */
216 	u_int	s_set : 1;	/* variable set, label defined */
217 	u_int	s_used : 1;	/* variable/label used */
218 	u_int	s_arg : 1;	/* symbol is function argument */
219 	u_int	s_reg : 1;	/* symbol is register variable */
220 	u_int	s_defarg : 1;	/* undefined symbol in old style function
221 				   definition */
222 	u_int	s_rimpl : 1;	/* return value of function implizit decl. */
223 	u_int	s_osdef : 1;	/* symbol stems from old style function def. */
224 	u_int	s_inline : 1;	/* true if this is a inline function */
225 	struct	sym *s_xsym;	/* for local declared external symbols pointer
226 				   to external symbol with same name */
227 	def_t	s_def;		/* declared, tentative defined, defined */
228 	scl_t	s_scl;		/* storage class */
229 	int	s_blklev;	/* level of declaration, -1 if not in symbol
230 				   table */
231 	type_t	*s_type;	/* type */
232 	val_t	s_value;	/* value (if enumcon) */
233 	union {
234 		str_t	*_s_st;	/* tag, if it is a struct/union member */
235 		enum_t	*_s_et;	/* tag, if it is a enumerator */
236 		tspec_t	_s_tsp;	/* type (only for keywords) */
237 		tqual_t	_s_tqu;	/* qualifier (only for keywords) */
238 		struct	sym *_s_args; /* arguments in old style function
239 					 definitions */
240 	} u;
241 	struct	sym *s_link;	/* next symbol with same hash value */
242 	struct	sym **s_rlink;	/* pointer to s_link of prev. symbol */
243 	struct	sym *s_nxt;	/* next struct/union member, enumerator,
244 				   argument */
245 	struct	sym *s_dlnxt; 	/* next symbol declared on same level */
246 } sym_t;
247 
248 #define	s_styp	u._s_st
249 #define	s_etyp	u._s_et
250 #define	s_tspec	u._s_tsp
251 #define	s_tqual	u._s_tqu
252 #define	s_args	u._s_args
253 
254 /*
255  * Used to keep some informations about symbols before they are entered
256  * into the symbol table.
257  */
258 typedef	struct sbuf {
259 	const	char *sb_name;		/* name of symbol */
260 	size_t	sb_len;			/* length (without '\0') */
261 	int	sb_hash;		/* hash value */
262 	sym_t	*sb_sym;		/* symbol table entry */
263 	struct	sbuf *sb_nxt;		/* for freelist */
264 } sbuf_t;
265 
266 
267 /*
268  * tree node
269  */
270 typedef	struct tnode {
271 	op_t	tn_op;		/* operator */
272 	type_t	*tn_type;	/* type */
273 	u_int	tn_lvalue : 1;	/* node is lvalue */
274 	u_int	tn_cast : 1;	/* if tn_op == CVT its an explizit cast */
275 	u_int	tn_parn : 1;	/* node parenthesized */
276 	union {
277 		struct {
278 			struct	tnode *_tn_left;	/* (left) operand */
279 			struct	tnode *_tn_right;	/* right operand */
280 		} tn_s;
281 		sym_t	*_tn_sym;	/* symbol if op == NAME */
282 		val_t	*_tn_val;	/* value if op == CON */
283 		strg_t	*_tn_strg;	/* string if op == STRING */
284 	} tn_u;
285 } tnode_t;
286 
287 #define	tn_left	tn_u.tn_s._tn_left
288 #define tn_right tn_u.tn_s._tn_right
289 #define tn_sym	tn_u._tn_sym
290 #define	tn_val	tn_u._tn_val
291 #define	tn_strg	tn_u._tn_strg
292 
293 /*
294  * For nested declarations a stack exists, which holds all information
295  * needed for the current level. dcs points to the top element of this
296  * stack.
297  *
298  * ctx describes the context of the current declaration. Its value is
299  * one of
300  *	EXTERN	global declarations
301  *	MOS oder MOU declarations of struct or union members
302  *	ENUMCON	declarations of enums
303  *	ARG	declaration of arguments in old style function definitions
304  *	PARG	declaration of arguments in function prototypes
305  *	AUTO	declaration of local symbols
306  *	ABSTRACT abstract declarations (sizeof, casts)
307  *
308  */
309 typedef	struct dinfo {
310 	tspec_t	d_atyp;		/* VOID, CHAR, INT, FLOAT or DOUBLE */
311 	tspec_t	d_smod;		/* SIGNED or UNSIGN */
312 	tspec_t	d_lmod;		/* SHORT, LONG or QUAD */
313 	scl_t	d_scl;		/* storage class */
314 	type_t	*d_type;	/* after deftyp() pointer to the type used
315 				   for all declarators */
316 	sym_t	*d_rdcsym;	/* redeclared symbol */
317 	int	d_offset;	/* offset of next structure member */
318 	int	d_stralign;	/* alignment required for current structure */
319 	scl_t	d_ctx;		/* context of declaration */
320 	u_int	d_const : 1;	/* const in declaration specifiers */
321 	u_int	d_volatile : 1;	/* volatile in declaration specifiers */
322 	u_int	d_inline : 1;	/* inline in declaration specifiers */
323 	u_int	d_mscl : 1;	/* multiple storage classes */
324 	u_int	d_terr : 1;	/* invalid type combination */
325 	u_int	d_nedecl : 1;	/* 1 if at least a tag is declared */
326 	u_int	d_vararg : 1;	/* ... in in current function decl. */
327 	u_int	d_proto : 1;	/* current funct. decl. is prototype */
328 	u_int	d_notyp : 1;	/* set if no type specifier was present */
329 	u_int	d_asm : 1;	/* set if d_ctx == AUTO and asm() present */
330 	type_t	*d_tagtyp;	/* tag during member declaration */
331 	sym_t	*d_fargs;	/* list of arguments during function def. */
332 	pos_t	d_fdpos;	/* position of function definition */
333 	sym_t	*d_dlsyms;	/* first symbol declared at this level */
334 	sym_t	**d_ldlsym;	/* points to s_dlnxt in last symbol decl.
335 				   at this level */
336 	sym_t	*d_fpsyms;	/* symbols defined in prototype */
337 	struct	dinfo *d_nxt;	/* next level */
338 } dinfo_t;
339 
340 /*
341  * Type of stack which is used for initialisation of aggregate types.
342  */
343 typedef	struct	istk {
344 	type_t	*i_type;		/* type of initialisation */
345 	type_t	*i_subt;		/* type of next level */
346 	u_int	i_brace : 1;		/* need } for pop */
347 	u_int	i_nolimit : 1;		/* incomplete array type */
348 	sym_t	*i_mem;			/* next structure member */
349 	int	i_cnt;			/* # of remaining elements */
350 	struct	istk *i_nxt;		/* previous level */
351 } istk_t;
352 
353 /*
354  * Used to collect information about pointers and qualifiers in
355  * declarators.
356  */
357 typedef	struct pqinf {
358 	int	p_pcnt;			/* number of asterisks */
359 	u_int	p_const : 1;
360 	u_int	p_volatile : 1;
361 	struct	pqinf *p_nxt;
362 } pqinf_t;
363 
364 /*
365  * Case values are stored in a list of type clst_t.
366  */
367 typedef	struct clst {
368 	val_t	cl_val;
369 	struct	clst *cl_nxt;
370 } clst_t;
371 
372 /*
373  * Used to keep informations about nested control statements.
374  */
375 typedef struct cstk {
376 	int	c_env;			/* type of statement (T_IF, ...) */
377 	u_int	c_loop : 1;		/* continue && break are valid */
378 	u_int	c_switch : 1;		/* case && break are valid */
379 	u_int	c_break : 1;		/* loop/switch has break */
380 	u_int	c_cont : 1;		/* loop has continue */
381 	u_int	c_default : 1;		/* switch has default */
382 	u_int	c_infinite : 1;		/* break condition always false
383 					   (for (;;), while (1)) */
384 	u_int	c_rchif : 1;		/* end of if-branch reached */
385 	u_int	c_noretval : 1;		/* had "return;" */
386 	u_int	c_retval : 1;		/* had "return (e);" */
387 	type_t	*c_swtype;		/* type of switch expression */
388 	clst_t	*c_clst;		/* list of case values */
389 	struct	mbl *c_fexprm;		/* saved memory for end of loop
390 					   expression in for() */
391 	tnode_t	*c_f3expr;		/* end of loop expr in for() */
392 	pos_t	c_fpos;			/* position of end of loop expr */
393 	pos_t	c_cfpos;	        /* same for csrc_pos */
394 	struct	cstk *c_nxt;		/* outer control statement */
395 } cstk_t;
396 
397 #include "externs1.h"
398 
399 #define	ERR_SETSIZE	1024
400 #define __NERRBITS (sizeof(unsigned int))
401 
402 typedef	struct err_set {
403 	unsigned int	errs_bits[(ERR_SETSIZE + __NERRBITS-1) / __NERRBITS];
404 } err_set;
405 
406 #define	ERR_SET(n, p)	\
407     ((p)->errs_bits[(n)/__NERRBITS] |= (1 << ((n) % __NERRBITS)))
408 #define	ERR_CLR(n, p)	\
409     ((p)->errs_bits[(n)/__NERRBITS] &= ~(1 << ((n) % __NERRBITS)))
410 #define	ERR_ISSET(n, p)	\
411     ((p)->errs_bits[(n)/__NERRBITS] & (1 << ((n) % __NERRBITS)))
412 #define	ERR_ZERO(p)	(void)memset((p), 0, sizeof(*(p)))
413 
414 extern err_set	msgset;
415