xref: /titanic_50/usr/src/lib/libdtrace/common/dt_decl.c (revision 654b400c387942fc00d4f6869539adbd7b25fbce)
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 /*
23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24  */
25 
26 #include <strings.h>
27 #include <stdlib.h>
28 #include <limits.h>
29 #include <alloca.h>
30 #include <assert.h>
31 
32 #include <dt_decl.h>
33 #include <dt_parser.h>
34 #include <dt_module.h>
35 #include <dt_impl.h>
36 
37 static dt_decl_t *
38 dt_decl_check(dt_decl_t *ddp)
39 {
40 	if (ddp->dd_kind == CTF_K_UNKNOWN)
41 		return (ddp); /* nothing to check if the type is not yet set */
42 
43 	if (ddp->dd_name != NULL && strcmp(ddp->dd_name, "char") == 0 &&
44 	    (ddp->dd_attr & (DT_DA_SHORT | DT_DA_LONG | DT_DA_LONGLONG))) {
45 		xyerror(D_DECL_CHARATTR, "invalid type declaration: short and "
46 		    "long may not be used with char type\n");
47 	}
48 
49 	if (ddp->dd_name != NULL && strcmp(ddp->dd_name, "void") == 0 &&
50 	    (ddp->dd_attr & (DT_DA_SHORT | DT_DA_LONG | DT_DA_LONGLONG |
51 	    (DT_DA_SIGNED | DT_DA_UNSIGNED)))) {
52 		xyerror(D_DECL_VOIDATTR, "invalid type declaration: attributes "
53 		    "may not be used with void type\n");
54 	}
55 
56 	if (ddp->dd_kind != CTF_K_INTEGER &&
57 	    (ddp->dd_attr & (DT_DA_SIGNED | DT_DA_UNSIGNED))) {
58 		xyerror(D_DECL_SIGNINT, "invalid type declaration: signed and "
59 		    "unsigned may only be used with integer type\n");
60 	}
61 
62 	if (ddp->dd_kind != CTF_K_INTEGER && ddp->dd_kind != CTF_K_FLOAT &&
63 	    (ddp->dd_attr & (DT_DA_LONG | DT_DA_LONGLONG))) {
64 		xyerror(D_DECL_LONGINT, "invalid type declaration: long and "
65 		    "long long may only be used with integer or "
66 		    "floating-point type\n");
67 	}
68 
69 	return (ddp);
70 }
71 
72 dt_decl_t *
73 dt_decl_alloc(ushort_t kind, char *name)
74 {
75 	dt_decl_t *ddp = malloc(sizeof (dt_decl_t));
76 
77 	if (ddp == NULL)
78 		longjmp(yypcb->pcb_jmpbuf, EDT_NOMEM);
79 
80 	ddp->dd_kind = kind;
81 	ddp->dd_attr = 0;
82 	ddp->dd_ctfp = NULL;
83 	ddp->dd_type = CTF_ERR;
84 	ddp->dd_name = name;
85 	ddp->dd_node = NULL;
86 	ddp->dd_next = NULL;
87 
88 	return (ddp);
89 }
90 
91 void
92 dt_decl_free(dt_decl_t *ddp)
93 {
94 	dt_decl_t *ndp;
95 
96 	for (; ddp != NULL; ddp = ndp) {
97 		ndp = ddp->dd_next;
98 		free(ddp->dd_name);
99 		dt_node_list_free(&ddp->dd_node);
100 		free(ddp);
101 	}
102 }
103 
104 void
105 dt_decl_reset(void)
106 {
107 	dt_scope_t *dsp = &yypcb->pcb_dstack;
108 	dt_decl_t *ddp = dsp->ds_decl;
109 
110 	while (ddp->dd_next != NULL) {
111 		dsp->ds_decl = ddp->dd_next;
112 		ddp->dd_next = NULL;
113 		dt_decl_free(ddp);
114 		ddp = dsp->ds_decl;
115 	}
116 }
117 
118 dt_decl_t *
119 dt_decl_push(dt_decl_t *ddp)
120 {
121 	dt_scope_t *dsp = &yypcb->pcb_dstack;
122 	dt_decl_t *top = dsp->ds_decl;
123 
124 	if (top != NULL &&
125 	    top->dd_kind == CTF_K_UNKNOWN && top->dd_name == NULL) {
126 		top->dd_kind = CTF_K_INTEGER;
127 		(void) dt_decl_check(top);
128 	}
129 
130 	assert(ddp->dd_next == NULL);
131 	ddp->dd_next = top;
132 	dsp->ds_decl = ddp;
133 
134 	return (ddp);
135 }
136 
137 dt_decl_t *
138 dt_decl_pop(void)
139 {
140 	dt_scope_t *dsp = &yypcb->pcb_dstack;
141 	dt_decl_t *ddp = dt_decl_top();
142 
143 	dsp->ds_decl = NULL;
144 	free(dsp->ds_ident);
145 	dsp->ds_ident = NULL;
146 	dsp->ds_ctfp = NULL;
147 	dsp->ds_type = CTF_ERR;
148 	dsp->ds_class = DT_DC_DEFAULT;
149 	dsp->ds_enumval = -1;
150 
151 	return (ddp);
152 }
153 
154 dt_decl_t *
155 dt_decl_pop_param(char **idp)
156 {
157 	dt_scope_t *dsp = &yypcb->pcb_dstack;
158 
159 	if (dsp->ds_class != DT_DC_DEFAULT && dsp->ds_class != DT_DC_REGISTER) {
160 		xyerror(D_DECL_PARMCLASS, "inappropriate storage class "
161 		    "for function or associative array parameter\n");
162 	}
163 
164 	if (idp != NULL && dt_decl_top() != NULL) {
165 		*idp = dsp->ds_ident;
166 		dsp->ds_ident = NULL;
167 	}
168 
169 	return (dt_decl_pop());
170 }
171 
172 dt_decl_t *
173 dt_decl_top(void)
174 {
175 	dt_decl_t *ddp = yypcb->pcb_dstack.ds_decl;
176 
177 	if (ddp == NULL)
178 		longjmp(yypcb->pcb_jmpbuf, EDT_NODECL);
179 
180 	if (ddp->dd_kind == CTF_K_UNKNOWN && ddp->dd_name == NULL) {
181 		ddp->dd_kind = CTF_K_INTEGER;
182 		(void) dt_decl_check(ddp);
183 	}
184 
185 	return (ddp);
186 }
187 
188 dt_decl_t *
189 dt_decl_ident(char *name)
190 {
191 	dt_scope_t *dsp = &yypcb->pcb_dstack;
192 	dt_decl_t *ddp = dsp->ds_decl;
193 
194 	if (dsp->ds_ident != NULL) {
195 		free(name);
196 		xyerror(D_DECL_IDENT, "old-style declaration or "
197 		    "incorrect type specified\n");
198 	}
199 
200 	dsp->ds_ident = name;
201 
202 	if (ddp == NULL)
203 		ddp = dt_decl_push(dt_decl_alloc(CTF_K_UNKNOWN, NULL));
204 
205 	return (ddp);
206 }
207 
208 void
209 dt_decl_class(dt_dclass_t class)
210 {
211 	dt_scope_t *dsp = &yypcb->pcb_dstack;
212 
213 	if (dsp->ds_class != DT_DC_DEFAULT) {
214 		xyerror(D_DECL_CLASS, "only one storage class allowed "
215 		    "in a declaration\n");
216 	}
217 
218 	dsp->ds_class = class;
219 }
220 
221 /*
222  * Set the kind and name of the current declaration.  If none is allocated,
223  * make a new decl and push it on to the top of our stack.  If the name or kind
224  * is already set for the current decl, then we need to fail this declaration.
225  * This can occur because too many types were given (e.g. "int int"), etc.
226  */
227 dt_decl_t *
228 dt_decl_spec(ushort_t kind, char *name)
229 {
230 	dt_decl_t *ddp = yypcb->pcb_dstack.ds_decl;
231 
232 	if (ddp == NULL)
233 		return (dt_decl_push(dt_decl_alloc(kind, name)));
234 
235 	/*
236 	 * If we already have a type name specified and we see another type
237 	 * name, this is an error if the declaration is a typedef.  If the
238 	 * declaration is not a typedef, then the user may be trying to declare
239 	 * a variable whose name has been returned by lex as a TNAME token:
240 	 * call dt_decl_ident() as if the grammar's IDENT rule was matched.
241 	 */
242 	if (ddp->dd_name != NULL && kind == CTF_K_TYPEDEF) {
243 		if (yypcb->pcb_dstack.ds_class != DT_DC_TYPEDEF)
244 			return (dt_decl_ident(name));
245 		xyerror(D_DECL_IDRED, "identifier redeclared: %s\n", name);
246 	}
247 
248 	if (ddp->dd_name != NULL || ddp->dd_kind != CTF_K_UNKNOWN)
249 		xyerror(D_DECL_COMBO, "invalid type combination\n");
250 
251 	ddp->dd_kind = kind;
252 	ddp->dd_name = name;
253 
254 	if (name != NULL && strchr(name, '`') != NULL) {
255 		xyerror(D_DECL_SCOPE, "D scoping operator may not be used "
256 		    "in a type name\n");
257 	}
258 
259 	return (dt_decl_check(ddp));
260 }
261 
262 dt_decl_t *
263 dt_decl_attr(ushort_t attr)
264 {
265 	dt_decl_t *ddp = yypcb->pcb_dstack.ds_decl;
266 
267 	if (ddp == NULL) {
268 		ddp = dt_decl_push(dt_decl_alloc(CTF_K_UNKNOWN, NULL));
269 		ddp->dd_attr = attr;
270 		return (ddp);
271 	}
272 
273 	if (attr == DT_DA_LONG && (ddp->dd_attr & DT_DA_LONG)) {
274 		ddp->dd_attr &= ~DT_DA_LONG;
275 		attr = DT_DA_LONGLONG;
276 	}
277 
278 	ddp->dd_attr |= attr;
279 	return (dt_decl_check(ddp));
280 }
281 
282 /*
283  * Examine the list of formal parameters 'flist' and determine if the formal
284  * name fnp->dn_string is defined in this list (B_TRUE) or not (B_FALSE).
285  * If 'fnp' is in 'flist', do not search beyond 'fnp' itself in 'flist'.
286  */
287 static int
288 dt_decl_protoform(dt_node_t *fnp, dt_node_t *flist)
289 {
290 	dt_node_t *dnp;
291 
292 	for (dnp = flist; dnp != fnp && dnp != NULL; dnp = dnp->dn_list) {
293 		if (dnp->dn_string != NULL &&
294 		    strcmp(dnp->dn_string, fnp->dn_string) == 0)
295 			return (B_TRUE);
296 	}
297 
298 	return (B_FALSE);
299 }
300 
301 /*
302  * Common code for parsing array, function, and probe definition prototypes.
303  * The prototype node list is specified as 'plist'.  The formal prototype
304  * against which to compare the prototype is specified as 'flist'.  If plist
305  * and flist are the same, we require that named parameters are unique.  If
306  * plist and flist are different, we require that named parameters in plist
307  * match a name that is present in flist.
308  */
309 int
310 dt_decl_prototype(dt_node_t *plist,
311     dt_node_t *flist, const char *kind, uint_t flags)
312 {
313 	char n[DT_TYPE_NAMELEN];
314 	int is_void, v = 0, i = 1;
315 	int form = plist != flist;
316 	dt_node_t *dnp;
317 
318 	for (dnp = plist; dnp != NULL; dnp = dnp->dn_list, i++) {
319 
320 		if (dnp->dn_type == CTF_ERR && !(flags & DT_DP_VARARGS)) {
321 			dnerror(dnp, D_DECL_PROTO_VARARGS, "%s prototype may "
322 			    "not use a variable-length argument list\n", kind);
323 		}
324 
325 		if (dt_node_is_dynamic(dnp) && !(flags & DT_DP_DYNAMIC)) {
326 			dnerror(dnp, D_DECL_PROTO_TYPE, "%s prototype may not "
327 			    "use parameter of type %s: %s, parameter #%d\n",
328 			    kind, dt_node_type_name(dnp, n, sizeof (n)),
329 			    dnp->dn_string ? dnp->dn_string : "(anonymous)", i);
330 		}
331 
332 		is_void = dt_node_is_void(dnp);
333 		v += is_void;
334 
335 		if (is_void && !(flags & DT_DP_VOID)) {
336 			dnerror(dnp, D_DECL_PROTO_TYPE, "%s prototype may not "
337 			    "use parameter of type %s: %s, parameter #%d\n",
338 			    kind, dt_node_type_name(dnp, n, sizeof (n)),
339 			    dnp->dn_string ? dnp->dn_string : "(anonymous)", i);
340 		}
341 
342 		if (is_void && dnp->dn_string != NULL) {
343 			dnerror(dnp, D_DECL_PROTO_NAME, "void parameter may "
344 			    "not have a name: %s\n", dnp->dn_string);
345 		}
346 
347 		if (dnp->dn_string != NULL &&
348 		    dt_decl_protoform(dnp, flist) != form) {
349 			dnerror(dnp, D_DECL_PROTO_FORM, "parameter is "
350 			    "%s declared in %s prototype: %s, parameter #%d\n",
351 			    form ? "not" : "already", kind, dnp->dn_string, i);
352 		}
353 
354 		if (dnp->dn_string == NULL &&
355 		    !is_void && !(flags & DT_DP_ANON)) {
356 			dnerror(dnp, D_DECL_PROTO_NAME, "parameter declaration "
357 			    "requires a name: parameter #%d\n", i);
358 		}
359 	}
360 
361 	if (v != 0 && plist->dn_list != NULL)
362 		xyerror(D_DECL_PROTO_VOID, "void must be sole parameter\n");
363 
364 	return (v ? 0 : i - 1); /* return zero if sole parameter is 'void' */
365 }
366 
367 dt_decl_t *
368 dt_decl_array(dt_node_t *dnp)
369 {
370 	dt_decl_t *ddp = dt_decl_push(dt_decl_alloc(CTF_K_ARRAY, NULL));
371 	dt_scope_t *dsp = &yypcb->pcb_dstack;
372 	dt_decl_t *ndp = ddp;
373 
374 	/*
375 	 * After pushing the array on to the decl stack, scan ahead for multi-
376 	 * dimensional array declarations and push the current decl to the
377 	 * bottom to match the resulting CTF type tree and data layout.  Refer
378 	 * to the comments in dt_decl_type() and ISO C 6.5.2.1 for more info.
379 	 */
380 	while (ndp->dd_next != NULL && ndp->dd_next->dd_kind == CTF_K_ARRAY)
381 		ndp = ndp->dd_next; /* skip to bottom-most array declaration */
382 
383 	if (ndp != ddp) {
384 		if (dnp != NULL && dnp->dn_kind == DT_NODE_TYPE) {
385 			xyerror(D_DECL_DYNOBJ,
386 			    "cannot declare array of associative arrays\n");
387 		}
388 		dsp->ds_decl = ddp->dd_next;
389 		ddp->dd_next = ndp->dd_next;
390 		ndp->dd_next = ddp;
391 	}
392 
393 	if (ddp->dd_next->dd_name != NULL &&
394 	    strcmp(ddp->dd_next->dd_name, "void") == 0)
395 		xyerror(D_DECL_VOIDOBJ, "cannot declare array of void\n");
396 
397 	if (dnp != NULL && dnp->dn_kind != DT_NODE_TYPE) {
398 		dnp = ddp->dd_node = dt_node_cook(dnp, DT_IDFLG_REF);
399 
400 		if (dt_node_is_posconst(dnp) == 0) {
401 			xyerror(D_DECL_ARRSUB, "positive integral constant "
402 			    "expression or tuple signature expected as "
403 			    "array declaration subscript\n");
404 		}
405 
406 		if (dnp->dn_value > UINT_MAX)
407 			xyerror(D_DECL_ARRBIG, "array dimension too big\n");
408 
409 	} else if (dnp != NULL) {
410 		ddp->dd_node = dnp;
411 		(void) dt_decl_prototype(dnp, dnp, "array", DT_DP_ANON);
412 	}
413 
414 	return (ddp);
415 }
416 
417 /*
418  * When a function is declared, we need to fudge the decl stack a bit if the
419  * declaration uses the function pointer (*)() syntax.  In this case, the
420  * dt_decl_func() call occurs *after* the dt_decl_ptr() call, even though the
421  * resulting type is "pointer to function".  To make the pointer land on top,
422  * we check to see if 'pdp' is non-NULL and a pointer.  If it is, we search
423  * backward for a decl tagged with DT_DA_PAREN, and if one is found, the func
424  * decl is inserted behind this node in the decl list instead of at the top.
425  * In all cases, the func decl's dd_next pointer is set to the decl chain
426  * for the function's return type and the function parameter list is discarded.
427  */
428 dt_decl_t *
429 dt_decl_func(dt_decl_t *pdp, dt_node_t *dnp)
430 {
431 	dt_decl_t *ddp = dt_decl_alloc(CTF_K_FUNCTION, NULL);
432 
433 	ddp->dd_node = dnp;
434 
435 	(void) dt_decl_prototype(dnp, dnp, "function",
436 	    DT_DP_VARARGS | DT_DP_VOID | DT_DP_ANON);
437 
438 	if (pdp == NULL || pdp->dd_kind != CTF_K_POINTER)
439 		return (dt_decl_push(ddp));
440 
441 	while (pdp->dd_next != NULL && !(pdp->dd_next->dd_attr & DT_DA_PAREN))
442 		pdp = pdp->dd_next;
443 
444 	if (pdp->dd_next == NULL)
445 		return (dt_decl_push(ddp));
446 
447 	ddp->dd_next = pdp->dd_next;
448 	pdp->dd_next = ddp;
449 
450 	return (pdp);
451 }
452 
453 dt_decl_t *
454 dt_decl_ptr(void)
455 {
456 	return (dt_decl_push(dt_decl_alloc(CTF_K_POINTER, NULL)));
457 }
458 
459 dt_decl_t *
460 dt_decl_sou(uint_t kind, char *name)
461 {
462 	dt_decl_t *ddp = dt_decl_spec(kind, name);
463 	char n[DT_TYPE_NAMELEN];
464 	ctf_file_t *ctfp;
465 	ctf_id_t type;
466 	uint_t flag;
467 
468 	if (yypcb->pcb_idepth != 0)
469 		ctfp = yypcb->pcb_hdl->dt_cdefs->dm_ctfp;
470 	else
471 		ctfp = yypcb->pcb_hdl->dt_ddefs->dm_ctfp;
472 
473 	if (yypcb->pcb_dstack.ds_next != NULL)
474 		flag = CTF_ADD_NONROOT;
475 	else
476 		flag = CTF_ADD_ROOT;
477 
478 	(void) snprintf(n, sizeof (n), "%s %s",
479 	    kind == CTF_K_STRUCT ? "struct" : "union",
480 	    name == NULL ? "(anon)" : name);
481 
482 	if (name != NULL && (type = ctf_lookup_by_name(ctfp, n)) != CTF_ERR &&
483 	    ctf_type_kind(ctfp, type) != CTF_K_FORWARD)
484 		xyerror(D_DECL_TYPERED, "type redeclared: %s\n", n);
485 
486 	if (kind == CTF_K_STRUCT)
487 		type = ctf_add_struct(ctfp, flag, name);
488 	else
489 		type = ctf_add_union(ctfp, flag, name);
490 
491 	if (type == CTF_ERR || ctf_update(ctfp) == CTF_ERR) {
492 		xyerror(D_UNKNOWN, "failed to define %s: %s\n",
493 		    n, ctf_errmsg(ctf_errno(ctfp)));
494 	}
495 
496 	ddp->dd_ctfp = ctfp;
497 	ddp->dd_type = type;
498 
499 	dt_scope_push(ctfp, type);
500 	return (ddp);
501 }
502 
503 void
504 dt_decl_member(dt_node_t *dnp)
505 {
506 	dt_scope_t *dsp = yypcb->pcb_dstack.ds_next;
507 	dt_decl_t *ddp = yypcb->pcb_dstack.ds_decl;
508 	char *ident = yypcb->pcb_dstack.ds_ident;
509 
510 	const char *idname = ident ? ident : "(anon)";
511 	char n[DT_TYPE_NAMELEN];
512 
513 	dtrace_typeinfo_t dtt;
514 	ctf_encoding_t cte;
515 	ctf_id_t base;
516 	uint_t kind;
517 	ssize_t size;
518 
519 	if (dsp == NULL)
520 		longjmp(yypcb->pcb_jmpbuf, EDT_NOSCOPE);
521 
522 	if (ddp == NULL)
523 		longjmp(yypcb->pcb_jmpbuf, EDT_NODECL);
524 
525 	if (dnp == NULL && ident == NULL)
526 		xyerror(D_DECL_MNAME, "member declaration requires a name\n");
527 
528 	if (ddp->dd_kind == CTF_K_UNKNOWN && ddp->dd_name == NULL) {
529 		ddp->dd_kind = CTF_K_INTEGER;
530 		(void) dt_decl_check(ddp);
531 	}
532 
533 	if (dt_decl_type(ddp, &dtt) != 0)
534 		longjmp(yypcb->pcb_jmpbuf, EDT_COMPILER);
535 
536 	if (ident != NULL && strchr(ident, '`') != NULL) {
537 		xyerror(D_DECL_SCOPE, "D scoping operator may not be used "
538 		    "in a member name (%s)\n", ident);
539 	}
540 
541 	if (dtt.dtt_ctfp == DT_DYN_CTFP(yypcb->pcb_hdl) &&
542 	    dtt.dtt_type == DT_DYN_TYPE(yypcb->pcb_hdl)) {
543 		xyerror(D_DECL_DYNOBJ,
544 		    "cannot have dynamic member: %s\n", ident);
545 	}
546 
547 	base = ctf_type_resolve(dtt.dtt_ctfp, dtt.dtt_type);
548 	kind = ctf_type_kind(dtt.dtt_ctfp, base);
549 	size = ctf_type_size(dtt.dtt_ctfp, base);
550 
551 	if (kind == CTF_K_FORWARD || ((kind == CTF_K_STRUCT ||
552 	    kind == CTF_K_UNION) && size == 0)) {
553 		xyerror(D_DECL_INCOMPLETE, "incomplete struct/union/enum %s: "
554 		    "%s\n", dt_type_name(dtt.dtt_ctfp, dtt.dtt_type,
555 		    n, sizeof (n)), ident);
556 	}
557 
558 	if (size == 0)
559 		xyerror(D_DECL_VOIDOBJ, "cannot have void member: %s\n", ident);
560 
561 	/*
562 	 * If a bit-field qualifier was part of the member declaration, create
563 	 * a new integer type of the same name and attributes as the base type
564 	 * and size equal to the specified number of bits.  We reset 'dtt' to
565 	 * refer to this new bit-field type and continue on to add the member.
566 	 */
567 	if (dnp != NULL) {
568 		dnp = dt_node_cook(dnp, DT_IDFLG_REF);
569 
570 		/*
571 		 * A bit-field member with no declarator is permitted to have
572 		 * size zero and indicates that no more fields are to be packed
573 		 * into the current storage unit.  We ignore these directives
574 		 * as the underlying ctf code currently does so for all fields.
575 		 */
576 		if (ident == NULL && dnp->dn_kind == DT_NODE_INT &&
577 		    dnp->dn_value == 0) {
578 			dt_node_free(dnp);
579 			goto done;
580 		}
581 
582 		if (dt_node_is_posconst(dnp) == 0) {
583 			xyerror(D_DECL_BFCONST, "positive integral constant "
584 			    "expression expected as bit-field size\n");
585 		}
586 
587 		if (ctf_type_kind(dtt.dtt_ctfp, base) != CTF_K_INTEGER ||
588 		    ctf_type_encoding(dtt.dtt_ctfp, base, &cte) == CTF_ERR ||
589 		    IS_VOID(cte)) {
590 			xyerror(D_DECL_BFTYPE, "invalid type for "
591 			    "bit-field: %s\n", idname);
592 		}
593 
594 		if (dnp->dn_value > cte.cte_bits) {
595 			xyerror(D_DECL_BFSIZE, "bit-field too big "
596 			    "for type: %s\n", idname);
597 		}
598 
599 		cte.cte_offset = 0;
600 		cte.cte_bits = (uint_t)dnp->dn_value;
601 
602 		dtt.dtt_type = ctf_add_integer(dsp->ds_ctfp,
603 		    CTF_ADD_NONROOT, ctf_type_name(dtt.dtt_ctfp,
604 		    dtt.dtt_type, n, sizeof (n)), &cte);
605 
606 		if (dtt.dtt_type == CTF_ERR ||
607 		    ctf_update(dsp->ds_ctfp) == CTF_ERR) {
608 			xyerror(D_UNKNOWN, "failed to create type for "
609 			    "member '%s': %s\n", idname,
610 			    ctf_errmsg(ctf_errno(dsp->ds_ctfp)));
611 		}
612 
613 		dtt.dtt_ctfp = dsp->ds_ctfp;
614 		dt_node_free(dnp);
615 	}
616 
617 	/*
618 	 * If the member type is not defined in the same CTF container as the
619 	 * one associated with the current scope (i.e. the container for the
620 	 * struct or union itself) or its parent, copy the member type into
621 	 * this container and reset dtt to refer to the copied type.
622 	 */
623 	if (dtt.dtt_ctfp != dsp->ds_ctfp &&
624 	    dtt.dtt_ctfp != ctf_parent_file(dsp->ds_ctfp)) {
625 
626 		dtt.dtt_type = ctf_add_type(dsp->ds_ctfp,
627 		    dtt.dtt_ctfp, dtt.dtt_type);
628 		dtt.dtt_ctfp = dsp->ds_ctfp;
629 
630 		if (dtt.dtt_type == CTF_ERR ||
631 		    ctf_update(dtt.dtt_ctfp) == CTF_ERR) {
632 			xyerror(D_UNKNOWN, "failed to copy type of '%s': %s\n",
633 			    idname, ctf_errmsg(ctf_errno(dtt.dtt_ctfp)));
634 		}
635 	}
636 
637 	if (ctf_add_member(dsp->ds_ctfp, dsp->ds_type,
638 	    ident, dtt.dtt_type) == CTF_ERR) {
639 		xyerror(D_UNKNOWN, "failed to define member '%s': %s\n",
640 		    idname, ctf_errmsg(ctf_errno(dsp->ds_ctfp)));
641 	}
642 
643 done:
644 	free(ident);
645 	yypcb->pcb_dstack.ds_ident = NULL;
646 	dt_decl_reset();
647 }
648 
649 /*ARGSUSED*/
650 static int
651 dt_decl_hasmembers(const char *name, int value, void *private)
652 {
653 	return (1); /* abort search and return true if a member exists */
654 }
655 
656 dt_decl_t *
657 dt_decl_enum(char *name)
658 {
659 	dt_decl_t *ddp = dt_decl_spec(CTF_K_ENUM, name);
660 	char n[DT_TYPE_NAMELEN];
661 	ctf_file_t *ctfp;
662 	ctf_id_t type;
663 	uint_t flag;
664 
665 	if (yypcb->pcb_idepth != 0)
666 		ctfp = yypcb->pcb_hdl->dt_cdefs->dm_ctfp;
667 	else
668 		ctfp = yypcb->pcb_hdl->dt_ddefs->dm_ctfp;
669 
670 	if (yypcb->pcb_dstack.ds_next != NULL)
671 		flag = CTF_ADD_NONROOT;
672 	else
673 		flag = CTF_ADD_ROOT;
674 
675 	(void) snprintf(n, sizeof (n), "enum %s", name ? name : "(anon)");
676 
677 	if (name != NULL && (type = ctf_lookup_by_name(ctfp, n)) != CTF_ERR) {
678 		if (ctf_enum_iter(ctfp, type, dt_decl_hasmembers, NULL))
679 			xyerror(D_DECL_TYPERED, "type redeclared: %s\n", n);
680 	} else if ((type = ctf_add_enum(ctfp, flag, name)) == CTF_ERR) {
681 		xyerror(D_UNKNOWN, "failed to define %s: %s\n",
682 		    n, ctf_errmsg(ctf_errno(ctfp)));
683 	}
684 
685 	ddp->dd_ctfp = ctfp;
686 	ddp->dd_type = type;
687 
688 	dt_scope_push(ctfp, type);
689 	return (ddp);
690 }
691 
692 void
693 dt_decl_enumerator(char *s, dt_node_t *dnp)
694 {
695 	dt_scope_t *dsp = yypcb->pcb_dstack.ds_next;
696 	dtrace_hdl_t *dtp = yypcb->pcb_hdl;
697 
698 	dt_idnode_t *inp;
699 	dt_ident_t *idp;
700 	char *name;
701 	int value;
702 
703 	name = strdupa(s);
704 	free(s);
705 
706 	if (dsp == NULL)
707 		longjmp(yypcb->pcb_jmpbuf, EDT_NOSCOPE);
708 
709 	assert(dsp->ds_decl->dd_kind == CTF_K_ENUM);
710 	value = dsp->ds_enumval + 1; /* default is previous value plus one */
711 
712 	if (strchr(name, '`') != NULL) {
713 		xyerror(D_DECL_SCOPE, "D scoping operator may not be used in "
714 		    "an enumerator name (%s)\n", name);
715 	}
716 
717 	/*
718 	 * If the enumerator is being assigned a value, cook and check the node
719 	 * and then free it after we get the value.  We also permit references
720 	 * to identifiers which are previously defined enumerators in the type.
721 	 */
722 	if (dnp != NULL) {
723 		if (dnp->dn_kind != DT_NODE_IDENT || ctf_enum_value(
724 		    dsp->ds_ctfp, dsp->ds_type, dnp->dn_string, &value) != 0) {
725 			dnp = dt_node_cook(dnp, DT_IDFLG_REF);
726 
727 			if (dnp->dn_kind != DT_NODE_INT) {
728 				xyerror(D_DECL_ENCONST, "enumerator '%s' must "
729 				    "be assigned to an integral constant "
730 				    "expression\n", name);
731 			}
732 
733 			if ((intmax_t)dnp->dn_value > INT_MAX ||
734 			    (intmax_t)dnp->dn_value < INT_MIN) {
735 				xyerror(D_DECL_ENOFLOW, "enumerator '%s' value "
736 				    "overflows INT_MAX (%d)\n", name, INT_MAX);
737 			}
738 
739 			value = (int)dnp->dn_value;
740 		}
741 		dt_node_free(dnp);
742 	}
743 
744 	if (ctf_add_enumerator(dsp->ds_ctfp, dsp->ds_type,
745 	    name, value) == CTF_ERR || ctf_update(dsp->ds_ctfp) == CTF_ERR) {
746 		xyerror(D_UNKNOWN, "failed to define enumerator '%s': %s\n",
747 		    name, ctf_errmsg(ctf_errno(dsp->ds_ctfp)));
748 	}
749 
750 	dsp->ds_enumval = value; /* save most recent value */
751 
752 	/*
753 	 * If the enumerator name matches an identifier in the global scope,
754 	 * flag this as an error.  We only do this for "D" enumerators to
755 	 * prevent "C" header file enumerators from conflicting with the ever-
756 	 * growing list of D built-in global variables and inlines.  If a "C"
757 	 * enumerator conflicts with a global identifier, we add the enumerator
758 	 * but do not insert a corresponding inline (i.e. the D variable wins).
759 	 */
760 	if (dt_idstack_lookup(&yypcb->pcb_globals, name) != NULL) {
761 		if (dsp->ds_ctfp == dtp->dt_ddefs->dm_ctfp) {
762 			xyerror(D_DECL_IDRED,
763 			    "identifier redeclared: %s\n", name);
764 		} else
765 			return;
766 	}
767 
768 	dt_dprintf("add global enumerator %s = %d\n", name, value);
769 
770 	idp = dt_idhash_insert(dtp->dt_globals, name, DT_IDENT_ENUM,
771 	    DT_IDFLG_INLINE | DT_IDFLG_REF, 0, _dtrace_defattr, 0,
772 	    &dt_idops_inline, NULL, dtp->dt_gen);
773 
774 	if (idp == NULL)
775 		longjmp(yypcb->pcb_jmpbuf, EDT_NOMEM);
776 
777 	yyintprefix = 0;
778 	yyintsuffix[0] = '\0';
779 	yyintdecimal = 0;
780 
781 	dnp = dt_node_int(value);
782 	dt_node_type_assign(dnp, dsp->ds_ctfp, dsp->ds_type);
783 
784 	if ((inp = malloc(sizeof (dt_idnode_t))) == NULL)
785 		longjmp(yypcb->pcb_jmpbuf, EDT_NOMEM);
786 
787 	/*
788 	 * Remove the INT node from the node allocation list and store it in
789 	 * din_list and din_root so it persists with and is freed by the ident.
790 	 */
791 	assert(yypcb->pcb_list == dnp);
792 	yypcb->pcb_list = dnp->dn_link;
793 	dnp->dn_link = NULL;
794 
795 	bzero(inp, sizeof (dt_idnode_t));
796 	inp->din_list = dnp;
797 	inp->din_root = dnp;
798 
799 	idp->di_iarg = inp;
800 	idp->di_ctfp = dsp->ds_ctfp;
801 	idp->di_type = dsp->ds_type;
802 }
803 
804 /*
805  * Look up the type corresponding to the specified decl stack.  The scoping of
806  * the underlying type names is handled by dt_type_lookup().  We build up the
807  * name from the specified string and prefixes and then lookup the type.  If
808  * we fail, an errmsg is saved and the caller must abort with EDT_COMPILER.
809  */
810 int
811 dt_decl_type(dt_decl_t *ddp, dtrace_typeinfo_t *tip)
812 {
813 	dtrace_hdl_t *dtp = yypcb->pcb_hdl;
814 
815 	dt_module_t *dmp;
816 	ctf_arinfo_t r;
817 	ctf_id_t type;
818 
819 	char n[DT_TYPE_NAMELEN];
820 	uint_t flag;
821 	char *name;
822 	int rv;
823 
824 	/*
825 	 * Based on our current #include depth and decl stack depth, determine
826 	 * which dynamic CTF module and scope to use when adding any new types.
827 	 */
828 	dmp = yypcb->pcb_idepth ? dtp->dt_cdefs : dtp->dt_ddefs;
829 	flag = yypcb->pcb_dstack.ds_next ? CTF_ADD_NONROOT : CTF_ADD_ROOT;
830 
831 	/*
832 	 * If we have already cached a CTF type for this decl, then we just
833 	 * return the type information for the cached type.
834 	 */
835 	if (ddp->dd_ctfp != NULL &&
836 	    (dmp = dt_module_lookup_by_ctf(dtp, ddp->dd_ctfp)) != NULL) {
837 		tip->dtt_object = dmp->dm_name;
838 		tip->dtt_ctfp = ddp->dd_ctfp;
839 		tip->dtt_type = ddp->dd_type;
840 		return (0);
841 	}
842 
843 	/*
844 	 * Currently CTF treats all function pointers identically.  We cache a
845 	 * representative ID of kind CTF_K_FUNCTION and just return that type.
846 	 * If we want to support full function declarations, dd_next refers to
847 	 * the declaration of the function return type, and the parameter list
848 	 * should be parsed and hung off a new pointer inside of this decl.
849 	 */
850 	if (ddp->dd_kind == CTF_K_FUNCTION) {
851 		tip->dtt_object = dtp->dt_ddefs->dm_name;
852 		tip->dtt_ctfp = DT_FUNC_CTFP(dtp);
853 		tip->dtt_type = DT_FUNC_TYPE(dtp);
854 		return (0);
855 	}
856 
857 	/*
858 	 * If the decl is a pointer, resolve the rest of the stack by calling
859 	 * dt_decl_type() recursively and then compute a pointer to the result.
860 	 * Similar to the code above, we return a cached id for function ptrs.
861 	 */
862 	if (ddp->dd_kind == CTF_K_POINTER) {
863 		if (ddp->dd_next->dd_kind == CTF_K_FUNCTION) {
864 			tip->dtt_object = dtp->dt_ddefs->dm_name;
865 			tip->dtt_ctfp = DT_FPTR_CTFP(dtp);
866 			tip->dtt_type = DT_FPTR_TYPE(dtp);
867 			return (0);
868 		}
869 
870 		if ((rv = dt_decl_type(ddp->dd_next, tip)) == 0 &&
871 		    (rv = dt_type_pointer(tip)) != 0) {
872 			xywarn(D_UNKNOWN, "cannot find type: %s*: %s\n",
873 			    dt_type_name(tip->dtt_ctfp, tip->dtt_type,
874 			    n, sizeof (n)), ctf_errmsg(dtp->dt_ctferr));
875 		}
876 
877 		return (rv);
878 	}
879 
880 	/*
881 	 * If the decl is an array, we must find the base type and then call
882 	 * dt_decl_type() recursively and then build an array of the result.
883 	 * The C and D multi-dimensional array syntax requires that consecutive
884 	 * array declarations be processed from right-to-left (i.e. top-down
885 	 * from the perspective of the declaration stack).  For example, an
886 	 * array declaration such as int x[3][5] is stored on the stack as:
887 	 *
888 	 * (bottom) NULL <- ( INT "int" ) <- ( ARR [3] ) <- ( ARR [5] ) (top)
889 	 *
890 	 * but means that x is declared to be an array of 3 objects each of
891 	 * which is an array of 5 integers, or in CTF representation:
892 	 *
893 	 * type T1:( content=int, nelems=5 ) type T2:( content=T1, nelems=3 )
894 	 *
895 	 * For more details, refer to K&R[5.7] and ISO C 6.5.2.1.  Rather than
896 	 * overcomplicate the implementation of dt_decl_type(), we push array
897 	 * declarations down into the stack in dt_decl_array(), above, so that
898 	 * by the time dt_decl_type() is called, the decl stack looks like:
899 	 *
900 	 * (bottom) NULL <- ( INT "int" ) <- ( ARR [5] ) <- ( ARR [3] ) (top)
901 	 *
902 	 * which permits a straightforward recursive descent of the decl stack
903 	 * to build the corresponding CTF type tree in the appropriate order.
904 	 */
905 	if (ddp->dd_kind == CTF_K_ARRAY) {
906 		/*
907 		 * If the array decl has a parameter list associated with it,
908 		 * this is an associative array declaration: return <DYN>.
909 		 */
910 		if (ddp->dd_node != NULL &&
911 		    ddp->dd_node->dn_kind == DT_NODE_TYPE) {
912 			tip->dtt_object = dtp->dt_ddefs->dm_name;
913 			tip->dtt_ctfp = DT_DYN_CTFP(dtp);
914 			tip->dtt_type = DT_DYN_TYPE(dtp);
915 			return (0);
916 		}
917 
918 		if ((rv = dt_decl_type(ddp->dd_next, tip)) != 0)
919 			return (rv);
920 
921 		/*
922 		 * If the array base type is not defined in the target
923 		 * container or its parent, copy the type to the target
924 		 * container and reset dtt_ctfp and dtt_type to the copy.
925 		 */
926 		if (tip->dtt_ctfp != dmp->dm_ctfp &&
927 		    tip->dtt_ctfp != ctf_parent_file(dmp->dm_ctfp)) {
928 
929 			tip->dtt_type = ctf_add_type(dmp->dm_ctfp,
930 			    tip->dtt_ctfp, tip->dtt_type);
931 			tip->dtt_ctfp = dmp->dm_ctfp;
932 
933 			if (tip->dtt_type == CTF_ERR ||
934 			    ctf_update(tip->dtt_ctfp) == CTF_ERR) {
935 				xywarn(D_UNKNOWN, "failed to copy type: %s\n",
936 				    ctf_errmsg(ctf_errno(tip->dtt_ctfp)));
937 				return (-1);
938 			}
939 		}
940 
941 		/*
942 		 * The array index type is irrelevant in C and D: just set it
943 		 * to "long" for all array types that we create on-the-fly.
944 		 */
945 		r.ctr_contents = tip->dtt_type;
946 		r.ctr_index = ctf_lookup_by_name(tip->dtt_ctfp, "long");
947 		r.ctr_nelems = ddp->dd_node ?
948 		    (uint_t)ddp->dd_node->dn_value : 0;
949 
950 		tip->dtt_object = dmp->dm_name;
951 		tip->dtt_ctfp = dmp->dm_ctfp;
952 		tip->dtt_type = ctf_add_array(dmp->dm_ctfp, CTF_ADD_ROOT, &r);
953 
954 		if (tip->dtt_type == CTF_ERR ||
955 		    ctf_update(tip->dtt_ctfp) == CTF_ERR) {
956 			xywarn(D_UNKNOWN, "failed to create array type: %s\n",
957 			    ctf_errmsg(ctf_errno(tip->dtt_ctfp)));
958 			return (-1);
959 		}
960 
961 		return (0);
962 	}
963 
964 	/*
965 	 * Allocate space for the type name and enough space for the maximum
966 	 * additional text ("unsigned long long \0" requires 20 more bytes).
967 	 */
968 	name = alloca(ddp->dd_name ? strlen(ddp->dd_name) + 20 : 20);
969 	name[0] = '\0';
970 
971 	switch (ddp->dd_kind) {
972 	case CTF_K_INTEGER:
973 	case CTF_K_FLOAT:
974 		if (ddp->dd_attr & DT_DA_SIGNED)
975 			(void) strcat(name, "signed ");
976 		if (ddp->dd_attr & DT_DA_UNSIGNED)
977 			(void) strcat(name, "unsigned ");
978 		if (ddp->dd_attr & DT_DA_SHORT)
979 			(void) strcat(name, "short ");
980 		if (ddp->dd_attr & DT_DA_LONG)
981 			(void) strcat(name, "long ");
982 		if (ddp->dd_attr & DT_DA_LONGLONG)
983 			(void) strcat(name, "long long ");
984 		if (ddp->dd_attr == 0 && ddp->dd_name == NULL)
985 			(void) strcat(name, "int");
986 		break;
987 	case CTF_K_STRUCT:
988 		(void) strcpy(name, "struct ");
989 		break;
990 	case CTF_K_UNION:
991 		(void) strcpy(name, "union ");
992 		break;
993 	case CTF_K_ENUM:
994 		(void) strcpy(name, "enum ");
995 		break;
996 	case CTF_K_TYPEDEF:
997 		break;
998 	default:
999 		xywarn(D_UNKNOWN, "internal error -- "
1000 		    "bad decl kind %u\n", ddp->dd_kind);
1001 		return (-1);
1002 	}
1003 
1004 	/*
1005 	 * Add dd_name unless a short, long, or long long is explicitly
1006 	 * suffixed by int.  We use the C/CTF canonical names for integers.
1007 	 */
1008 	if (ddp->dd_name != NULL && (ddp->dd_kind != CTF_K_INTEGER ||
1009 	    (ddp->dd_attr & (DT_DA_SHORT | DT_DA_LONG | DT_DA_LONGLONG)) == 0))
1010 		(void) strcat(name, ddp->dd_name);
1011 
1012 	/*
1013 	 * Lookup the type.  If we find it, we're done.  Otherwise create a
1014 	 * forward tag for the type if it is a struct, union, or enum.  If
1015 	 * we can't find it and we can't create a tag, return failure.
1016 	 */
1017 	if ((rv = dt_type_lookup(name, tip)) == 0)
1018 		return (rv);
1019 
1020 	switch (ddp->dd_kind) {
1021 	case CTF_K_STRUCT:
1022 	case CTF_K_UNION:
1023 	case CTF_K_ENUM:
1024 		type = ctf_add_forward(dmp->dm_ctfp, flag,
1025 		    ddp->dd_name, ddp->dd_kind);
1026 		break;
1027 	default:
1028 		xywarn(D_UNKNOWN, "failed to resolve type %s: %s\n", name,
1029 		    dtrace_errmsg(dtp, dtrace_errno(dtp)));
1030 		return (rv);
1031 	}
1032 
1033 	if (type == CTF_ERR || ctf_update(dmp->dm_ctfp) == CTF_ERR) {
1034 		xywarn(D_UNKNOWN, "failed to add forward tag for %s: %s\n",
1035 		    name, ctf_errmsg(ctf_errno(dmp->dm_ctfp)));
1036 		return (-1);
1037 	}
1038 
1039 	ddp->dd_ctfp = dmp->dm_ctfp;
1040 	ddp->dd_type = type;
1041 
1042 	tip->dtt_object = dmp->dm_name;
1043 	tip->dtt_ctfp = dmp->dm_ctfp;
1044 	tip->dtt_type = type;
1045 
1046 	return (0);
1047 }
1048 
1049 void
1050 dt_scope_create(dt_scope_t *dsp)
1051 {
1052 	dsp->ds_decl = NULL;
1053 	dsp->ds_next = NULL;
1054 	dsp->ds_ident = NULL;
1055 	dsp->ds_ctfp = NULL;
1056 	dsp->ds_type = CTF_ERR;
1057 	dsp->ds_class = DT_DC_DEFAULT;
1058 	dsp->ds_enumval = -1;
1059 }
1060 
1061 void
1062 dt_scope_destroy(dt_scope_t *dsp)
1063 {
1064 	dt_scope_t *nsp;
1065 
1066 	for (; dsp != NULL; dsp = nsp) {
1067 		dt_decl_free(dsp->ds_decl);
1068 		free(dsp->ds_ident);
1069 		nsp = dsp->ds_next;
1070 		if (dsp != &yypcb->pcb_dstack)
1071 			free(dsp);
1072 	}
1073 }
1074 
1075 void
1076 dt_scope_push(ctf_file_t *ctfp, ctf_id_t type)
1077 {
1078 	dt_scope_t *rsp = &yypcb->pcb_dstack;
1079 	dt_scope_t *dsp = malloc(sizeof (dt_scope_t));
1080 
1081 	if (dsp == NULL)
1082 		longjmp(yypcb->pcb_jmpbuf, EDT_NOMEM);
1083 
1084 	dsp->ds_decl = rsp->ds_decl;
1085 	dsp->ds_next = rsp->ds_next;
1086 	dsp->ds_ident = rsp->ds_ident;
1087 	dsp->ds_ctfp = ctfp;
1088 	dsp->ds_type = type;
1089 	dsp->ds_class = rsp->ds_class;
1090 	dsp->ds_enumval = rsp->ds_enumval;
1091 
1092 	dt_scope_create(rsp);
1093 	rsp->ds_next = dsp;
1094 }
1095 
1096 dt_decl_t *
1097 dt_scope_pop(void)
1098 {
1099 	dt_scope_t *rsp = &yypcb->pcb_dstack;
1100 	dt_scope_t *dsp = rsp->ds_next;
1101 
1102 	if (dsp == NULL)
1103 		longjmp(yypcb->pcb_jmpbuf, EDT_NOSCOPE);
1104 
1105 	if (dsp->ds_ctfp != NULL && ctf_update(dsp->ds_ctfp) == CTF_ERR) {
1106 		xyerror(D_UNKNOWN, "failed to update type definitions: %s\n",
1107 		    ctf_errmsg(ctf_errno(dsp->ds_ctfp)));
1108 	}
1109 
1110 	dt_decl_free(rsp->ds_decl);
1111 	free(rsp->ds_ident);
1112 
1113 	rsp->ds_decl = dsp->ds_decl;
1114 	rsp->ds_next = dsp->ds_next;
1115 	rsp->ds_ident = dsp->ds_ident;
1116 	rsp->ds_ctfp = dsp->ds_ctfp;
1117 	rsp->ds_type = dsp->ds_type;
1118 	rsp->ds_class = dsp->ds_class;
1119 	rsp->ds_enumval = dsp->ds_enumval;
1120 
1121 	free(dsp);
1122 	return (rsp->ds_decl);
1123 }
1124