xref: /titanic_41/usr/src/lib/libdtrace/common/dt_decl.h (revision 7c478bd95313f5f23a4c958a745db2134aa03244)
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_DECL_H
28 #define	_DT_DECL_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #include <sys/types.h>
33 #include <libctf.h>
34 #include <dtrace.h>
35 #include <stdio.h>
36 
37 #ifdef	__cplusplus
38 extern "C" {
39 #endif
40 
41 struct dt_node;				/* forward declaration of dt_node_t */
42 
43 typedef struct dt_decl {
44 	ushort_t dd_kind;		/* declaration kind (CTF_K_* kind) */
45 	ushort_t dd_attr;		/* attributes (DT_DA_* flags) */
46 	ctf_file_t *dd_ctfp;		/* CTF container for decl's type */
47 	ctf_id_t dd_type;		/* CTF identifier for decl's type */
48 	char *dd_name;			/* string name of this decl (or NULL) */
49 	struct dt_node *dd_node;	/* node for array size or parm list */
50 	struct dt_decl *dd_next;	/* next declaration in list */
51 } dt_decl_t;
52 
53 #define	DT_DA_SIGNED	0x0001		/* signed integer value */
54 #define	DT_DA_UNSIGNED	0x0002		/* unsigned integer value */
55 #define	DT_DA_SHORT	0x0004		/* short integer value */
56 #define	DT_DA_LONG	0x0008		/* long integer or double */
57 #define	DT_DA_LONGLONG	0x0010		/* long long integer value */
58 #define	DT_DA_CONST	0x0020		/* qualify type as const */
59 #define	DT_DA_RESTRICT	0x0040		/* qualify type as restrict */
60 #define	DT_DA_VOLATILE	0x0080		/* qualify type as volatile */
61 #define	DT_DA_PAREN	0x0100		/* parenthesis tag */
62 
63 typedef enum dt_dclass {
64 	DT_DC_DEFAULT,			/* no storage class specified */
65 	DT_DC_AUTO,			/* automatic storage */
66 	DT_DC_REGISTER,			/* register storage */
67 	DT_DC_STATIC,			/* static storage */
68 	DT_DC_EXTERN,			/* extern storage */
69 	DT_DC_TYPEDEF,			/* type definition */
70 	DT_DC_SELF,			/* thread-local storage */
71 	DT_DC_THIS			/* clause-local storage */
72 } dt_dclass_t;
73 
74 typedef struct dt_scope {
75 	dt_decl_t *ds_decl;		/* pointer to top of decl stack */
76 	struct dt_scope *ds_next;	/* pointer to next scope */
77 	char *ds_ident;			/* identifier for this scope (if any) */
78 	ctf_file_t *ds_ctfp;		/* CTF container for this scope */
79 	ctf_id_t ds_type;		/* CTF id of enclosing type */
80 	dt_dclass_t ds_class;		/* declaration class for this scope */
81 	int ds_enumval;			/* most recent enumerator value */
82 } dt_scope_t;
83 
84 extern dt_decl_t *dt_decl_alloc(ushort_t, char *);
85 extern void dt_decl_free(dt_decl_t *);
86 extern void dt_decl_reset(void);
87 extern dt_decl_t *dt_decl_push(dt_decl_t *);
88 extern dt_decl_t *dt_decl_pop(void);
89 extern dt_decl_t *dt_decl_pop_param(char **);
90 extern dt_decl_t *dt_decl_top(void);
91 
92 extern dt_decl_t *dt_decl_ident(char *);
93 extern void dt_decl_class(dt_dclass_t);
94 
95 #define	DT_DP_VARARGS	0x1		/* permit varargs in prototype */
96 #define	DT_DP_DYNAMIC	0x2		/* permit dynamic type in prototype */
97 #define	DT_DP_VOID	0x4		/* permit void type in prototype */
98 #define	DT_DP_ANON	0x8		/* permit anonymous parameters */
99 
100 extern int dt_decl_prototype(struct dt_node *, struct dt_node *,
101     const char *, uint_t);
102 
103 extern dt_decl_t *dt_decl_spec(ushort_t, char *);
104 extern dt_decl_t *dt_decl_attr(ushort_t);
105 extern dt_decl_t *dt_decl_array(struct dt_node *);
106 extern dt_decl_t *dt_decl_func(dt_decl_t *, struct dt_node *);
107 extern dt_decl_t *dt_decl_ptr(void);
108 
109 extern dt_decl_t *dt_decl_sou(uint_t, char *);
110 extern void dt_decl_member(struct dt_node *);
111 
112 extern dt_decl_t *dt_decl_enum(char *);
113 extern void dt_decl_enumerator(char *, struct dt_node *);
114 
115 extern int dt_decl_type(dt_decl_t *, dtrace_typeinfo_t *);
116 
117 extern void dt_scope_create(dt_scope_t *);
118 extern void dt_scope_destroy(dt_scope_t *);
119 extern void dt_scope_push(ctf_file_t *, ctf_id_t);
120 extern dt_decl_t *dt_scope_pop(void);
121 
122 #ifdef	__cplusplus
123 }
124 #endif
125 
126 #endif	/* _DT_DECL_H */
127