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