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