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