1178479Sjb/* 2178479Sjb * CDDL HEADER START 3178479Sjb * 4178479Sjb * The contents of this file are subject to the terms of the 5178479Sjb * Common Development and Distribution License (the "License"). 6178479Sjb * You may not use this file except in compliance with the License. 7178479Sjb * 8178479Sjb * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9178479Sjb * or http://www.opensolaris.org/os/licensing. 10178479Sjb * See the License for the specific language governing permissions 11178479Sjb * and limitations under the License. 12178479Sjb * 13178479Sjb * When distributing Covered Code, include this CDDL HEADER in each 14178479Sjb * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15178479Sjb * If applicable, add the following below this CDDL HEADER, with the 16178479Sjb * fields enclosed by brackets "[]" replaced with your own identifying 17178479Sjb * information: Portions Copyright [yyyy] [name of copyright owner] 18178479Sjb * 19178479Sjb * CDDL HEADER END 20178479Sjb */ 21178479Sjb/* 22178479Sjb * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 23178479Sjb * Use is subject to license terms. 24178479Sjb */ 25268578Srpaulo/* 26268578Srpaulo * Copyright (c) 2013 by Delphix. All rights reserved. 27268578Srpaulo * Copyright (c) 2013 Joyent, Inc. All rights reserved. 28268578Srpaulo */ 29178479Sjb 30178479Sjb#ifndef _DT_PARSER_H 31178479Sjb#define _DT_PARSER_H 32178479Sjb 33178479Sjb#include <sys/types.h> 34178479Sjb#include <sys/dtrace.h> 35178479Sjb 36178479Sjb#include <libctf.h> 37178479Sjb#include <stdarg.h> 38178479Sjb#include <stdio.h> 39178479Sjb 40178479Sjb#ifdef __cplusplus 41178479Sjbextern "C" { 42178479Sjb#endif 43178479Sjb 44178479Sjb#include <dt_errtags.h> 45178479Sjb#include <dt_ident.h> 46178479Sjb#include <dt_decl.h> 47178479Sjb#include <dt_xlator.h> 48178479Sjb#include <dt_list.h> 49178479Sjb 50178479Sjbtypedef struct dt_node { 51178479Sjb ctf_file_t *dn_ctfp; /* CTF type container for node's type */ 52178479Sjb ctf_id_t dn_type; /* CTF type reference for node's type */ 53178479Sjb uchar_t dn_kind; /* node kind (DT_NODE_*, defined below) */ 54178479Sjb uchar_t dn_flags; /* node flags (DT_NF_*, defined below) */ 55178479Sjb ushort_t dn_op; /* operator (DT_TOK_*, defined by lex) */ 56178479Sjb int dn_line; /* line number for error messages */ 57178479Sjb int dn_reg; /* register allocated by cg */ 58178479Sjb dtrace_attribute_t dn_attr; /* node stability attributes */ 59178479Sjb 60178479Sjb /* 61178479Sjb * D compiler nodes, as is the usual style, contain a union of the 62178479Sjb * different sub-elements required by the various kinds of nodes. 63178479Sjb * These sub-elements are accessed using the macros defined below. 64178479Sjb */ 65178479Sjb union { 66178479Sjb struct { 67178479Sjb uintmax_t _value; /* integer value */ 68178479Sjb char *_string; /* string value */ 69178479Sjb } _const; 70178479Sjb 71178479Sjb struct { 72178479Sjb dt_ident_t *_ident; /* identifier reference */ 73178479Sjb struct dt_node *_links[3]; /* child node pointers */ 74178479Sjb } _nodes; 75178479Sjb 76178479Sjb struct { 77178479Sjb struct dt_node *_descs; /* list of descriptions */ 78178479Sjb struct dt_node *_pred; /* predicate expression */ 79178479Sjb struct dt_node *_acts; /* action statement list */ 80178479Sjb dt_idhash_t *_locals; /* local variable hash */ 81178479Sjb dtrace_attribute_t _attr; /* context attributes */ 82178479Sjb } _clause; 83178479Sjb 84178479Sjb struct { 85178479Sjb char *_spec; /* specifier string (if any) */ 86178479Sjb dtrace_probedesc_t *_desc; /* final probe description */ 87178479Sjb } _pdesc; 88178479Sjb 89178479Sjb struct { 90178479Sjb char *_name; /* string name of member */ 91178479Sjb struct dt_node *_expr; /* expression node pointer */ 92178479Sjb dt_xlator_t *_xlator; /* translator reference */ 93178479Sjb uint_t _id; /* member identifier */ 94178479Sjb } _member; 95178479Sjb 96178479Sjb struct { 97178479Sjb dt_xlator_t *_xlator; /* translator reference */ 98178479Sjb struct dt_node *_xmemb; /* individual xlator member */ 99178479Sjb struct dt_node *_membs; /* list of member nodes */ 100178479Sjb } _xlator; 101178479Sjb 102178479Sjb struct { 103178479Sjb char *_name; /* string name of provider */ 104178479Sjb struct dt_provider *_pvp; /* provider references */ 105178479Sjb struct dt_node *_probes; /* list of probe nodes */ 106178479Sjb int _redecl; /* provider redeclared */ 107178479Sjb } _provider; 108178479Sjb } dn_u; 109178479Sjb 110178479Sjb struct dt_node *dn_list; /* parse tree list link */ 111178479Sjb struct dt_node *dn_link; /* allocation list link */ 112178479Sjb} dt_node_t; 113178479Sjb 114178479Sjb#define dn_value dn_u._const._value /* DT_NODE_INT */ 115178479Sjb#define dn_string dn_u._const._string /* STRING, IDENT, TYPE */ 116178479Sjb#define dn_ident dn_u._nodes._ident /* VAR,SYM,FUN,AGG,INL,PROBE */ 117178479Sjb#define dn_args dn_u._nodes._links[0] /* DT_NODE_VAR, FUNC */ 118178479Sjb#define dn_child dn_u._nodes._links[0] /* DT_NODE_OP1 */ 119178479Sjb#define dn_left dn_u._nodes._links[0] /* DT_NODE_OP2, OP3 */ 120178479Sjb#define dn_right dn_u._nodes._links[1] /* DT_NODE_OP2, OP3 */ 121178479Sjb#define dn_expr dn_u._nodes._links[2] /* DT_NODE_OP3, DEXPR */ 122178479Sjb#define dn_aggfun dn_u._nodes._links[0] /* DT_NODE_AGG */ 123178479Sjb#define dn_aggtup dn_u._nodes._links[1] /* DT_NODE_AGG */ 124178479Sjb#define dn_pdescs dn_u._clause._descs /* DT_NODE_CLAUSE */ 125178479Sjb#define dn_pred dn_u._clause._pred /* DT_NODE_CLAUSE */ 126178479Sjb#define dn_acts dn_u._clause._acts /* DT_NODE_CLAUSE */ 127178479Sjb#define dn_locals dn_u._clause._locals /* DT_NODE_CLAUSE */ 128178479Sjb#define dn_ctxattr dn_u._clause._attr /* DT_NODE_CLAUSE */ 129178479Sjb#define dn_spec dn_u._pdesc._spec /* DT_NODE_PDESC */ 130178479Sjb#define dn_desc dn_u._pdesc._desc /* DT_NODE_PDESC */ 131178479Sjb#define dn_membname dn_u._member._name /* DT_NODE_MEMBER */ 132178479Sjb#define dn_membexpr dn_u._member._expr /* DT_NODE_MEMBER */ 133178479Sjb#define dn_membxlator dn_u._member._xlator /* DT_NODE_MEMBER */ 134178479Sjb#define dn_membid dn_u._member._id /* DT_NODE_MEMBER */ 135178479Sjb#define dn_xlator dn_u._xlator._xlator /* DT_NODE_XLATOR */ 136178479Sjb#define dn_xmember dn_u._xlator._xmemb /* DT_NODE_XLATOR */ 137178479Sjb#define dn_members dn_u._xlator._membs /* DT_NODE_XLATOR */ 138178479Sjb#define dn_provname dn_u._provider._name /* DT_NODE_PROVIDER */ 139178479Sjb#define dn_provider dn_u._provider._pvp /* DT_NODE_PROVIDER */ 140178479Sjb#define dn_provred dn_u._provider._redecl /* DT_NODE_PROVIDER */ 141178479Sjb#define dn_probes dn_u._provider._probes /* DT_NODE_PROVIDER */ 142178479Sjb 143178479Sjb#define DT_NODE_FREE 0 /* unused node (waiting to be freed) */ 144178479Sjb#define DT_NODE_INT 1 /* integer value */ 145178479Sjb#define DT_NODE_STRING 2 /* string value */ 146178479Sjb#define DT_NODE_IDENT 3 /* identifier */ 147178479Sjb#define DT_NODE_VAR 4 /* variable reference */ 148178479Sjb#define DT_NODE_SYM 5 /* symbol reference */ 149178479Sjb#define DT_NODE_TYPE 6 /* type reference or formal parameter */ 150178479Sjb#define DT_NODE_FUNC 7 /* function call */ 151178479Sjb#define DT_NODE_OP1 8 /* unary operator */ 152178479Sjb#define DT_NODE_OP2 9 /* binary operator */ 153178479Sjb#define DT_NODE_OP3 10 /* ternary operator */ 154178479Sjb#define DT_NODE_DEXPR 11 /* D expression action */ 155178479Sjb#define DT_NODE_DFUNC 12 /* D function action */ 156178479Sjb#define DT_NODE_AGG 13 /* aggregation */ 157178479Sjb#define DT_NODE_PDESC 14 /* probe description */ 158178479Sjb#define DT_NODE_CLAUSE 15 /* clause definition */ 159178479Sjb#define DT_NODE_INLINE 16 /* inline definition */ 160178479Sjb#define DT_NODE_MEMBER 17 /* member definition */ 161178479Sjb#define DT_NODE_XLATOR 18 /* translator definition */ 162178479Sjb#define DT_NODE_PROBE 19 /* probe definition */ 163178479Sjb#define DT_NODE_PROVIDER 20 /* provider definition */ 164178479Sjb#define DT_NODE_PROG 21 /* program translation unit */ 165178479Sjb 166178479Sjb#define DT_NF_SIGNED 0x01 /* data is a signed quantity (else unsigned) */ 167178479Sjb#define DT_NF_COOKED 0x02 /* data is a known type (else still cooking) */ 168178479Sjb#define DT_NF_REF 0x04 /* pass by reference (array, struct, union) */ 169178479Sjb#define DT_NF_LVALUE 0x08 /* node is an l-value according to ANSI-C */ 170178479Sjb#define DT_NF_WRITABLE 0x10 /* node is writable (can be modified) */ 171178479Sjb#define DT_NF_BITFIELD 0x20 /* node is an integer bitfield */ 172178479Sjb#define DT_NF_USERLAND 0x40 /* data is a userland address */ 173178479Sjb 174178479Sjb#define DT_TYPE_NAMELEN 128 /* reasonable size for ctf_type_name() */ 175178479Sjb 176178479Sjbextern int dt_node_is_integer(const dt_node_t *); 177178479Sjbextern int dt_node_is_float(const dt_node_t *); 178178479Sjbextern int dt_node_is_scalar(const dt_node_t *); 179178479Sjbextern int dt_node_is_arith(const dt_node_t *); 180178479Sjbextern int dt_node_is_vfptr(const dt_node_t *); 181178479Sjbextern int dt_node_is_dynamic(const dt_node_t *); 182178479Sjbextern int dt_node_is_stack(const dt_node_t *); 183178479Sjbextern int dt_node_is_symaddr(const dt_node_t *); 184178479Sjbextern int dt_node_is_usymaddr(const dt_node_t *); 185178479Sjbextern int dt_node_is_string(const dt_node_t *); 186178479Sjbextern int dt_node_is_strcompat(const dt_node_t *); 187178479Sjbextern int dt_node_is_pointer(const dt_node_t *); 188178479Sjbextern int dt_node_is_void(const dt_node_t *); 189178479Sjbextern int dt_node_is_ptrcompat(const dt_node_t *, const dt_node_t *, 190178479Sjb ctf_file_t **, ctf_id_t *); 191178479Sjbextern int dt_node_is_argcompat(const dt_node_t *, const dt_node_t *); 192178479Sjbextern int dt_node_is_posconst(const dt_node_t *); 193178479Sjbextern int dt_node_is_actfunc(const dt_node_t *); 194178479Sjb 195178479Sjbextern dt_node_t *dt_node_int(uintmax_t); 196178479Sjbextern dt_node_t *dt_node_string(char *); 197178479Sjbextern dt_node_t *dt_node_ident(char *); 198178479Sjbextern dt_node_t *dt_node_type(dt_decl_t *); 199178479Sjbextern dt_node_t *dt_node_vatype(void); 200178479Sjbextern dt_node_t *dt_node_decl(void); 201178479Sjbextern dt_node_t *dt_node_func(dt_node_t *, dt_node_t *); 202178479Sjbextern dt_node_t *dt_node_offsetof(dt_decl_t *, char *); 203178479Sjbextern dt_node_t *dt_node_op1(int, dt_node_t *); 204178479Sjbextern dt_node_t *dt_node_op2(int, dt_node_t *, dt_node_t *); 205178479Sjbextern dt_node_t *dt_node_op3(dt_node_t *, dt_node_t *, dt_node_t *); 206178479Sjbextern dt_node_t *dt_node_statement(dt_node_t *); 207178479Sjbextern dt_node_t *dt_node_pdesc_by_name(char *); 208178479Sjbextern dt_node_t *dt_node_pdesc_by_id(uintmax_t); 209178479Sjbextern dt_node_t *dt_node_clause(dt_node_t *, dt_node_t *, dt_node_t *); 210178479Sjbextern dt_node_t *dt_node_inline(dt_node_t *); 211178479Sjbextern dt_node_t *dt_node_member(dt_decl_t *, char *, dt_node_t *); 212178479Sjbextern dt_node_t *dt_node_xlator(dt_decl_t *, dt_decl_t *, char *, dt_node_t *); 213178479Sjbextern dt_node_t *dt_node_probe(char *, int, dt_node_t *, dt_node_t *); 214178479Sjbextern dt_node_t *dt_node_provider(char *, dt_node_t *); 215178479Sjbextern dt_node_t *dt_node_program(dt_node_t *); 216178479Sjb 217178479Sjbextern dt_node_t *dt_node_link(dt_node_t *, dt_node_t *); 218178479Sjbextern dt_node_t *dt_node_cook(dt_node_t *, uint_t); 219178479Sjb 220178479Sjbextern dt_node_t *dt_node_xalloc(dtrace_hdl_t *, int); 221178479Sjbextern void dt_node_free(dt_node_t *); 222178479Sjb 223178479Sjbextern dtrace_attribute_t dt_node_list_cook(dt_node_t **, uint_t); 224178479Sjbextern void dt_node_list_free(dt_node_t **); 225178479Sjbextern void dt_node_link_free(dt_node_t **); 226178479Sjb 227178479Sjbextern void dt_node_attr_assign(dt_node_t *, dtrace_attribute_t); 228268578Srpauloextern void dt_node_type_assign(dt_node_t *, ctf_file_t *, ctf_id_t, boolean_t); 229178479Sjbextern void dt_node_type_propagate(const dt_node_t *, dt_node_t *); 230178479Sjbextern const char *dt_node_type_name(const dt_node_t *, char *, size_t); 231178479Sjbextern size_t dt_node_type_size(const dt_node_t *); 232178479Sjb 233178479Sjbextern dt_ident_t *dt_node_resolve(const dt_node_t *, uint_t); 234178479Sjbextern size_t dt_node_sizeof(const dt_node_t *); 235178479Sjbextern void dt_node_promote(dt_node_t *, dt_node_t *, dt_node_t *); 236178479Sjb 237178479Sjbextern void dt_node_diftype(dtrace_hdl_t *, 238178479Sjb const dt_node_t *, dtrace_diftype_t *); 239178479Sjbextern void dt_node_printr(dt_node_t *, FILE *, int); 240178479Sjbextern const char *dt_node_name(const dt_node_t *, char *, size_t); 241178479Sjbextern int dt_node_root(dt_node_t *); 242178479Sjb 243178479Sjbstruct dtrace_typeinfo; /* see <dtrace.h> */ 244178479Sjbstruct dt_pcb; /* see <dt_impl.h> */ 245178479Sjb 246178479Sjb#define IS_CHAR(e) \ 247178479Sjb (((e).cte_format & (CTF_INT_CHAR | CTF_INT_SIGNED)) == \ 248178479Sjb (CTF_INT_CHAR | CTF_INT_SIGNED) && (e).cte_bits == NBBY) 249178479Sjb 250178479Sjb#define IS_VOID(e) \ 251178479Sjb ((e).cte_offset == 0 && (e).cte_bits == 0) 252178479Sjb 253178479Sjbextern int dt_type_lookup(const char *, struct dtrace_typeinfo *); 254178479Sjbextern int dt_type_pointer(struct dtrace_typeinfo *); 255178479Sjbextern const char *dt_type_name(ctf_file_t *, ctf_id_t, char *, size_t); 256178479Sjb 257178479Sjbtypedef enum { 258178479Sjb YYS_CLAUSE, /* lex/yacc state for finding program clauses */ 259178479Sjb YYS_DEFINE, /* lex/yacc state for parsing persistent definitions */ 260178479Sjb YYS_EXPR, /* lex/yacc state for parsing D expressions */ 261178479Sjb YYS_DONE, /* lex/yacc state for indicating parse tree is done */ 262178479Sjb YYS_CONTROL /* lex/yacc state for parsing control lines */ 263178479Sjb} yystate_t; 264178479Sjb 265178479Sjbextern void dnerror(const dt_node_t *, dt_errtag_t, const char *, ...); 266178479Sjbextern void dnwarn(const dt_node_t *, dt_errtag_t, const char *, ...); 267178479Sjb 268178479Sjbextern void xyerror(dt_errtag_t, const char *, ...); 269178479Sjbextern void xywarn(dt_errtag_t, const char *, ...); 270178479Sjbextern void xyvwarn(dt_errtag_t, const char *, va_list); 271178479Sjb 272178479Sjbextern void yyerror(const char *, ...); 273178479Sjbextern void yywarn(const char *, ...); 274178479Sjbextern void yyvwarn(const char *, va_list); 275178479Sjb 276178479Sjbextern void yylabel(const char *); 277178479Sjbextern void yybegin(yystate_t); 278178479Sjbextern void yyinit(struct dt_pcb *); 279178479Sjb 280178479Sjbextern int yyparse(void); 281178479Sjbextern int yyinput(void); 282178479Sjb 283178479Sjb#ifdef __cplusplus 284178479Sjb} 285178479Sjb#endif 286178479Sjb 287178479Sjb#endif /* _DT_PARSER_H */ 288