1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef	_DT_PARSER_H
28*0Sstevel@tonic-gate #define	_DT_PARSER_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #include <sys/types.h>
33*0Sstevel@tonic-gate #include <sys/dtrace.h>
34*0Sstevel@tonic-gate 
35*0Sstevel@tonic-gate #include <libctf.h>
36*0Sstevel@tonic-gate #include <stdarg.h>
37*0Sstevel@tonic-gate #include <stdio.h>
38*0Sstevel@tonic-gate 
39*0Sstevel@tonic-gate #ifdef	__cplusplus
40*0Sstevel@tonic-gate extern "C" {
41*0Sstevel@tonic-gate #endif
42*0Sstevel@tonic-gate 
43*0Sstevel@tonic-gate #include <dt_errtags.h>
44*0Sstevel@tonic-gate #include <dt_ident.h>
45*0Sstevel@tonic-gate #include <dt_decl.h>
46*0Sstevel@tonic-gate #include <dt_xlator.h>
47*0Sstevel@tonic-gate #include <dt_list.h>
48*0Sstevel@tonic-gate 
49*0Sstevel@tonic-gate typedef struct dt_node {
50*0Sstevel@tonic-gate 	ctf_file_t *dn_ctfp;	/* CTF type container for node's type */
51*0Sstevel@tonic-gate 	ctf_id_t dn_type;	/* CTF type reference for node's type */
52*0Sstevel@tonic-gate 	uchar_t dn_kind;	/* node kind (DT_NODE_*, defined below) */
53*0Sstevel@tonic-gate 	uchar_t dn_flags;	/* node flags (DT_NF_*, defined below) */
54*0Sstevel@tonic-gate 	ushort_t dn_op;		/* operator (DT_TOK_*, defined by lex) */
55*0Sstevel@tonic-gate 	int dn_line;		/* line number for error messages */
56*0Sstevel@tonic-gate 	int dn_reg;		/* register allocated by cg */
57*0Sstevel@tonic-gate 	dtrace_attribute_t dn_attr; /* node stability attributes */
58*0Sstevel@tonic-gate 
59*0Sstevel@tonic-gate 	/*
60*0Sstevel@tonic-gate 	 * D compiler nodes, as is the usual style, contain a union of the
61*0Sstevel@tonic-gate 	 * different sub-elements required by the various kinds of nodes.
62*0Sstevel@tonic-gate 	 * These sub-elements are accessed using the macros defined below.
63*0Sstevel@tonic-gate 	 */
64*0Sstevel@tonic-gate 	union {
65*0Sstevel@tonic-gate 		struct {
66*0Sstevel@tonic-gate 			uintmax_t _value;	/* integer value */
67*0Sstevel@tonic-gate 			char *_string;		/* string value */
68*0Sstevel@tonic-gate 		} _const;
69*0Sstevel@tonic-gate 
70*0Sstevel@tonic-gate 		struct {
71*0Sstevel@tonic-gate 			dt_ident_t *_ident;	/* identifier reference */
72*0Sstevel@tonic-gate 			struct dt_node *_links[3]; /* child node pointers */
73*0Sstevel@tonic-gate 		} _nodes;
74*0Sstevel@tonic-gate 
75*0Sstevel@tonic-gate 		struct {
76*0Sstevel@tonic-gate 			struct dt_node *_descs;	/* list of descriptions */
77*0Sstevel@tonic-gate 			struct dt_node *_pred;	/* predicate expression */
78*0Sstevel@tonic-gate 			struct dt_node *_acts;	/* action statement list */
79*0Sstevel@tonic-gate 			dt_idhash_t *_locals;	/* local variable hash */
80*0Sstevel@tonic-gate 			dtrace_attribute_t _attr; /* context attributes */
81*0Sstevel@tonic-gate 		} _clause;
82*0Sstevel@tonic-gate 
83*0Sstevel@tonic-gate 		struct {
84*0Sstevel@tonic-gate 			char *_spec;		/* specifier string (if any) */
85*0Sstevel@tonic-gate 			dtrace_probedesc_t *_desc; /* final probe description */
86*0Sstevel@tonic-gate 		} _pdesc;
87*0Sstevel@tonic-gate 
88*0Sstevel@tonic-gate 		struct {
89*0Sstevel@tonic-gate 			char *_name;		/* string name of member */
90*0Sstevel@tonic-gate 			struct dt_node *_expr;	/* expression node pointer */
91*0Sstevel@tonic-gate 		} _member;
92*0Sstevel@tonic-gate 
93*0Sstevel@tonic-gate 		struct {
94*0Sstevel@tonic-gate 			dt_xlator_t *_xlator;	/* translator reference */
95*0Sstevel@tonic-gate 			struct dt_node *_membs;	/* list of member nodes */
96*0Sstevel@tonic-gate 		} _xlator;
97*0Sstevel@tonic-gate 
98*0Sstevel@tonic-gate 		struct {
99*0Sstevel@tonic-gate 			char *_name;		/* string name of provider */
100*0Sstevel@tonic-gate 			struct dt_provider *_pvp; /* provider references */
101*0Sstevel@tonic-gate 			struct dt_node *_probes;  /* list of probe nodes */
102*0Sstevel@tonic-gate 			int _redecl;		/* provider redeclared */
103*0Sstevel@tonic-gate 		} _provider;
104*0Sstevel@tonic-gate 	} dn_u;
105*0Sstevel@tonic-gate 
106*0Sstevel@tonic-gate 	struct dt_node *dn_list; /* parse tree list link */
107*0Sstevel@tonic-gate 	struct dt_node *dn_link; /* allocation list link */
108*0Sstevel@tonic-gate } dt_node_t;
109*0Sstevel@tonic-gate 
110*0Sstevel@tonic-gate #define	dn_value	dn_u._const._value	/* DT_NODE_INT */
111*0Sstevel@tonic-gate #define	dn_string	dn_u._const._string	/* STRING, IDENT, TYPE */
112*0Sstevel@tonic-gate #define	dn_ident	dn_u._nodes._ident	/* VAR,SYM,FUN,AGG,INL,PROBE */
113*0Sstevel@tonic-gate #define	dn_args		dn_u._nodes._links[0]	/* DT_NODE_VAR, FUNC */
114*0Sstevel@tonic-gate #define	dn_child	dn_u._nodes._links[0]	/* DT_NODE_OP1 */
115*0Sstevel@tonic-gate #define	dn_left		dn_u._nodes._links[0]	/* DT_NODE_OP2, OP3 */
116*0Sstevel@tonic-gate #define	dn_right	dn_u._nodes._links[1]	/* DT_NODE_OP2, OP3 */
117*0Sstevel@tonic-gate #define	dn_expr		dn_u._nodes._links[2]	/* DT_NODE_OP3, DEXPR */
118*0Sstevel@tonic-gate #define	dn_aggfun	dn_u._nodes._links[0]	/* DT_NODE_AGG */
119*0Sstevel@tonic-gate #define	dn_aggtup	dn_u._nodes._links[1]	/* DT_NODE_AGG */
120*0Sstevel@tonic-gate #define	dn_pdescs	dn_u._clause._descs	/* DT_NODE_CLAUSE */
121*0Sstevel@tonic-gate #define	dn_pred		dn_u._clause._pred	/* DT_NODE_CLAUSE */
122*0Sstevel@tonic-gate #define	dn_acts		dn_u._clause._acts	/* DT_NODE_CLAUSE */
123*0Sstevel@tonic-gate #define	dn_locals	dn_u._clause._locals	/* DT_NODE_CLAUSE */
124*0Sstevel@tonic-gate #define	dn_ctxattr	dn_u._clause._attr	/* DT_NODE_CLAUSE */
125*0Sstevel@tonic-gate #define	dn_spec		dn_u._pdesc._spec	/* DT_NODE_PDESC */
126*0Sstevel@tonic-gate #define	dn_desc		dn_u._pdesc._desc	/* DT_NODE_PDESC */
127*0Sstevel@tonic-gate #define	dn_membname	dn_u._member._name	/* DT_NODE_MEMBER */
128*0Sstevel@tonic-gate #define	dn_membexpr	dn_u._member._expr	/* DT_NODE_MEMBER */
129*0Sstevel@tonic-gate #define	dn_xlator	dn_u._xlator._xlator	/* DT_NODE_XLATOR */
130*0Sstevel@tonic-gate #define	dn_members	dn_u._xlator._membs	/* DT_NODE_XLATOR */
131*0Sstevel@tonic-gate #define	dn_provname	dn_u._provider._name	/* DT_NODE_PROVIDER */
132*0Sstevel@tonic-gate #define	dn_provider	dn_u._provider._pvp	/* DT_NODE_PROVIDER */
133*0Sstevel@tonic-gate #define	dn_provred	dn_u._provider._redecl	/* DT_NODE_PROVIDER */
134*0Sstevel@tonic-gate #define	dn_probes	dn_u._provider._probes	/* DT_NODE_PROVIDER */
135*0Sstevel@tonic-gate 
136*0Sstevel@tonic-gate #define	DT_NODE_FREE	0	/* unused node (waiting to be freed) */
137*0Sstevel@tonic-gate #define	DT_NODE_INT	1	/* integer value */
138*0Sstevel@tonic-gate #define	DT_NODE_STRING	2	/* string value */
139*0Sstevel@tonic-gate #define	DT_NODE_IDENT	3	/* identifier */
140*0Sstevel@tonic-gate #define	DT_NODE_VAR	4	/* variable reference */
141*0Sstevel@tonic-gate #define	DT_NODE_SYM	5	/* symbol reference */
142*0Sstevel@tonic-gate #define	DT_NODE_TYPE	6	/* type reference or formal parameter */
143*0Sstevel@tonic-gate #define	DT_NODE_FUNC	7	/* function call */
144*0Sstevel@tonic-gate #define	DT_NODE_OP1	8	/* unary operator */
145*0Sstevel@tonic-gate #define	DT_NODE_OP2	9	/* binary operator */
146*0Sstevel@tonic-gate #define	DT_NODE_OP3	10	/* ternary operator */
147*0Sstevel@tonic-gate #define	DT_NODE_DEXPR	11	/* D expression action */
148*0Sstevel@tonic-gate #define	DT_NODE_DFUNC	12	/* D function action */
149*0Sstevel@tonic-gate #define	DT_NODE_AGG	13	/* aggregation */
150*0Sstevel@tonic-gate #define	DT_NODE_PDESC	14	/* probe description */
151*0Sstevel@tonic-gate #define	DT_NODE_CLAUSE	15	/* clause definition */
152*0Sstevel@tonic-gate #define	DT_NODE_INLINE	16	/* inline definition */
153*0Sstevel@tonic-gate #define	DT_NODE_MEMBER	17	/* member definition */
154*0Sstevel@tonic-gate #define	DT_NODE_XLATOR	18	/* translator definition */
155*0Sstevel@tonic-gate #define	DT_NODE_PROBE	19	/* probe definition */
156*0Sstevel@tonic-gate #define	DT_NODE_PROVIDER 20	/* provider definition */
157*0Sstevel@tonic-gate #define	DT_NODE_PROG	21	/* program translation unit */
158*0Sstevel@tonic-gate 
159*0Sstevel@tonic-gate #define	DT_NF_SIGNED	0x01	/* data is a signed quantity (else unsigned) */
160*0Sstevel@tonic-gate #define	DT_NF_COOKED	0x02	/* data is a known type (else still cooking) */
161*0Sstevel@tonic-gate #define	DT_NF_REF	0x04	/* pass by reference (array, struct, union) */
162*0Sstevel@tonic-gate #define	DT_NF_LVALUE	0x08	/* node is an l-value according to ANSI-C */
163*0Sstevel@tonic-gate #define	DT_NF_WRITABLE	0x10	/* node is writable (can be modified) */
164*0Sstevel@tonic-gate #define	DT_NF_BITFIELD	0x20	/* node is an integer bitfield */
165*0Sstevel@tonic-gate #define	DT_NF_USERLAND	0x40	/* data is a userland address */
166*0Sstevel@tonic-gate 
167*0Sstevel@tonic-gate #define	DT_TYPE_NAMELEN	128	/* reasonable size for ctf_type_name() */
168*0Sstevel@tonic-gate 
169*0Sstevel@tonic-gate extern int dt_node_is_integer(const dt_node_t *);
170*0Sstevel@tonic-gate extern int dt_node_is_float(const dt_node_t *);
171*0Sstevel@tonic-gate extern int dt_node_is_scalar(const dt_node_t *);
172*0Sstevel@tonic-gate extern int dt_node_is_arith(const dt_node_t *);
173*0Sstevel@tonic-gate extern int dt_node_is_vfptr(const dt_node_t *);
174*0Sstevel@tonic-gate extern int dt_node_is_dynamic(const dt_node_t *);
175*0Sstevel@tonic-gate extern int dt_node_is_string(const dt_node_t *);
176*0Sstevel@tonic-gate extern int dt_node_is_strcompat(const dt_node_t *);
177*0Sstevel@tonic-gate extern int dt_node_is_pointer(const dt_node_t *);
178*0Sstevel@tonic-gate extern int dt_node_is_void(const dt_node_t *);
179*0Sstevel@tonic-gate extern int dt_node_is_ptrcompat(const dt_node_t *, const dt_node_t *,
180*0Sstevel@tonic-gate 	ctf_file_t **, ctf_id_t *);
181*0Sstevel@tonic-gate extern int dt_node_is_argcompat(const dt_node_t *, const dt_node_t *);
182*0Sstevel@tonic-gate extern int dt_node_is_posconst(const dt_node_t *);
183*0Sstevel@tonic-gate extern int dt_node_is_actfunc(const dt_node_t *);
184*0Sstevel@tonic-gate 
185*0Sstevel@tonic-gate extern dt_node_t *dt_node_int(uintmax_t);
186*0Sstevel@tonic-gate extern dt_node_t *dt_node_string(char *);
187*0Sstevel@tonic-gate extern dt_node_t *dt_node_ident(char *);
188*0Sstevel@tonic-gate extern dt_node_t *dt_node_type(dt_decl_t *);
189*0Sstevel@tonic-gate extern dt_node_t *dt_node_vatype(void);
190*0Sstevel@tonic-gate extern dt_node_t *dt_node_decl(void);
191*0Sstevel@tonic-gate extern dt_node_t *dt_node_func(dt_node_t *, dt_node_t *);
192*0Sstevel@tonic-gate extern dt_node_t *dt_node_offsetof(dt_decl_t *, char *);
193*0Sstevel@tonic-gate extern dt_node_t *dt_node_op1(int, dt_node_t *);
194*0Sstevel@tonic-gate extern dt_node_t *dt_node_op2(int, dt_node_t *, dt_node_t *);
195*0Sstevel@tonic-gate extern dt_node_t *dt_node_op3(dt_node_t *, dt_node_t *, dt_node_t *);
196*0Sstevel@tonic-gate extern dt_node_t *dt_node_statement(dt_node_t *);
197*0Sstevel@tonic-gate extern dt_node_t *dt_node_pdesc_by_name(char *);
198*0Sstevel@tonic-gate extern dt_node_t *dt_node_pdesc_by_id(uintmax_t);
199*0Sstevel@tonic-gate extern dt_node_t *dt_node_clause(dt_node_t *, dt_node_t *, dt_node_t *);
200*0Sstevel@tonic-gate extern dt_node_t *dt_node_inline(dt_node_t *);
201*0Sstevel@tonic-gate extern dt_node_t *dt_node_member(dt_decl_t *, char *, dt_node_t *);
202*0Sstevel@tonic-gate extern dt_node_t *dt_node_xlator(dt_decl_t *, dt_decl_t *, char *, dt_node_t *);
203*0Sstevel@tonic-gate extern dt_node_t *dt_node_probe(char *, dt_node_t *, dt_node_t *);
204*0Sstevel@tonic-gate extern dt_node_t *dt_node_provider(char *, dt_node_t *);
205*0Sstevel@tonic-gate extern dt_node_t *dt_node_program(dt_node_t *);
206*0Sstevel@tonic-gate 
207*0Sstevel@tonic-gate extern dt_node_t *dt_node_link(dt_node_t *, dt_node_t *);
208*0Sstevel@tonic-gate extern dt_node_t *dt_node_cook(dt_node_t *, uint_t);
209*0Sstevel@tonic-gate 
210*0Sstevel@tonic-gate extern dt_node_t *dt_node_xalloc(dtrace_hdl_t *, int);
211*0Sstevel@tonic-gate extern void dt_node_free(dt_node_t *);
212*0Sstevel@tonic-gate 
213*0Sstevel@tonic-gate extern dtrace_attribute_t dt_node_list_cook(dt_node_t **, uint_t);
214*0Sstevel@tonic-gate extern void dt_node_list_free(dt_node_t **);
215*0Sstevel@tonic-gate extern void dt_node_link_free(dt_node_t **);
216*0Sstevel@tonic-gate 
217*0Sstevel@tonic-gate extern void dt_node_attr_assign(dt_node_t *, dtrace_attribute_t);
218*0Sstevel@tonic-gate extern void dt_node_type_assign(dt_node_t *, ctf_file_t *, ctf_id_t);
219*0Sstevel@tonic-gate extern void dt_node_type_propagate(const dt_node_t *, dt_node_t *);
220*0Sstevel@tonic-gate extern const char *dt_node_type_name(const dt_node_t *, char *, size_t);
221*0Sstevel@tonic-gate extern size_t dt_node_type_size(const dt_node_t *);
222*0Sstevel@tonic-gate 
223*0Sstevel@tonic-gate extern dt_ident_t *dt_node_resolve(const dt_node_t *, uint_t);
224*0Sstevel@tonic-gate extern size_t dt_node_sizeof(const dt_node_t *);
225*0Sstevel@tonic-gate extern void dt_node_promote(dt_node_t *, dt_node_t *, dt_node_t *);
226*0Sstevel@tonic-gate 
227*0Sstevel@tonic-gate extern void dt_node_diftype(const dt_node_t *, dtrace_diftype_t *);
228*0Sstevel@tonic-gate extern void dt_node_printr(dt_node_t *, FILE *, int);
229*0Sstevel@tonic-gate extern const char *dt_node_name(const dt_node_t *, char *, size_t);
230*0Sstevel@tonic-gate extern int dt_node_root(dt_node_t *);
231*0Sstevel@tonic-gate 
232*0Sstevel@tonic-gate struct dtrace_typeinfo;	/* see <dtrace.h> */
233*0Sstevel@tonic-gate struct dt_pcb;		/* see <dt_impl.h> */
234*0Sstevel@tonic-gate 
235*0Sstevel@tonic-gate #define	IS_CHAR(e) \
236*0Sstevel@tonic-gate 	(((e).cte_format & (CTF_INT_CHAR | CTF_INT_SIGNED)) == \
237*0Sstevel@tonic-gate 	(CTF_INT_CHAR | CTF_INT_SIGNED) && (e).cte_bits == NBBY)
238*0Sstevel@tonic-gate 
239*0Sstevel@tonic-gate #define	IS_VOID(e) \
240*0Sstevel@tonic-gate 	((e).cte_offset == 0 && (e).cte_bits == 0)
241*0Sstevel@tonic-gate 
242*0Sstevel@tonic-gate extern int dt_type_lookup(const char *, struct dtrace_typeinfo *);
243*0Sstevel@tonic-gate extern int dt_type_pointer(struct dtrace_typeinfo *);
244*0Sstevel@tonic-gate extern const char *dt_type_name(ctf_file_t *, ctf_id_t, char *, size_t);
245*0Sstevel@tonic-gate 
246*0Sstevel@tonic-gate typedef enum {
247*0Sstevel@tonic-gate 	YYS_CLAUSE,	/* lex/yacc state for finding program clauses */
248*0Sstevel@tonic-gate 	YYS_DEFINE,	/* lex/yacc state for parsing persistent definitions */
249*0Sstevel@tonic-gate 	YYS_EXPR,	/* lex/yacc state for parsing D expressions */
250*0Sstevel@tonic-gate 	YYS_DONE	/* lex/yacc state for indicating parse tree is done */
251*0Sstevel@tonic-gate } yystate_t;
252*0Sstevel@tonic-gate 
253*0Sstevel@tonic-gate extern void dnerror(const dt_node_t *, dt_errtag_t, const char *, ...);
254*0Sstevel@tonic-gate extern void dnwarn(const dt_node_t *, dt_errtag_t, const char *, ...);
255*0Sstevel@tonic-gate 
256*0Sstevel@tonic-gate extern void xyerror(dt_errtag_t, const char *, ...);
257*0Sstevel@tonic-gate extern void xywarn(dt_errtag_t, const char *, ...);
258*0Sstevel@tonic-gate extern void xyvwarn(dt_errtag_t, const char *, va_list);
259*0Sstevel@tonic-gate 
260*0Sstevel@tonic-gate extern void yyerror(const char *, ...);
261*0Sstevel@tonic-gate extern void yywarn(const char *, ...);
262*0Sstevel@tonic-gate extern void yyvwarn(const char *, va_list);
263*0Sstevel@tonic-gate 
264*0Sstevel@tonic-gate extern void yylabel(const char *);
265*0Sstevel@tonic-gate extern void yybegin(yystate_t);
266*0Sstevel@tonic-gate extern void yyinit(struct dt_pcb *);
267*0Sstevel@tonic-gate 
268*0Sstevel@tonic-gate extern int yyparse(void);
269*0Sstevel@tonic-gate extern int yyinput(void);
270*0Sstevel@tonic-gate 
271*0Sstevel@tonic-gate #ifdef	__cplusplus
272*0Sstevel@tonic-gate }
273*0Sstevel@tonic-gate #endif
274*0Sstevel@tonic-gate 
275*0Sstevel@tonic-gate #endif	/* _DT_PARSER_H */
276