1*0Sstevel@tonic-gate /* 2*0Sstevel@tonic-gate * CDDL HEADER START 3*0Sstevel@tonic-gate * 4*0Sstevel@tonic-gate * The contents of this file are subject to the terms of the 5*0Sstevel@tonic-gate * Common Development and Distribution License, Version 1.0 only 6*0Sstevel@tonic-gate * (the "License"). You may not use this file except in compliance 7*0Sstevel@tonic-gate * with the License. 8*0Sstevel@tonic-gate * 9*0Sstevel@tonic-gate * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10*0Sstevel@tonic-gate * or http://www.opensolaris.org/os/licensing. 11*0Sstevel@tonic-gate * See the License for the specific language governing permissions 12*0Sstevel@tonic-gate * and limitations under the License. 13*0Sstevel@tonic-gate * 14*0Sstevel@tonic-gate * When distributing Covered Code, include this CDDL HEADER in each 15*0Sstevel@tonic-gate * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16*0Sstevel@tonic-gate * If applicable, add the following below this CDDL HEADER, with the 17*0Sstevel@tonic-gate * fields enclosed by brackets "[]" replaced with your own identifying 18*0Sstevel@tonic-gate * information: Portions Copyright [yyyy] [name of copyright owner] 19*0Sstevel@tonic-gate * 20*0Sstevel@tonic-gate * CDDL HEADER END 21*0Sstevel@tonic-gate */ 22*0Sstevel@tonic-gate /* 23*0Sstevel@tonic-gate * Copyright 2005 Sun Microsystems, Inc. All rights reserved. 24*0Sstevel@tonic-gate * Use is subject to license terms. 25*0Sstevel@tonic-gate */ 26*0Sstevel@tonic-gate 27*0Sstevel@tonic-gate #ifndef _DT_IDENT_H 28*0Sstevel@tonic-gate #define _DT_IDENT_H 29*0Sstevel@tonic-gate 30*0Sstevel@tonic-gate #pragma ident "%Z%%M% %I% %E% SMI" 31*0Sstevel@tonic-gate 32*0Sstevel@tonic-gate #include <libctf.h> 33*0Sstevel@tonic-gate #include <dtrace.h> 34*0Sstevel@tonic-gate 35*0Sstevel@tonic-gate #ifdef __cplusplus 36*0Sstevel@tonic-gate extern "C" { 37*0Sstevel@tonic-gate #endif 38*0Sstevel@tonic-gate 39*0Sstevel@tonic-gate #include <dt_list.h> 40*0Sstevel@tonic-gate 41*0Sstevel@tonic-gate struct dt_node; 42*0Sstevel@tonic-gate struct dt_ident; 43*0Sstevel@tonic-gate struct dt_idhash; 44*0Sstevel@tonic-gate struct dt_irlist; 45*0Sstevel@tonic-gate struct dt_regset; 46*0Sstevel@tonic-gate 47*0Sstevel@tonic-gate typedef struct dt_idsig { 48*0Sstevel@tonic-gate int dis_varargs; /* argument index of start of varargs (or -1) */ 49*0Sstevel@tonic-gate int dis_optargs; /* argument index of start of optargs (or -1) */ 50*0Sstevel@tonic-gate int dis_argc; /* number of types in this signature */ 51*0Sstevel@tonic-gate struct dt_node *dis_args; /* array of nodes representing formal types */ 52*0Sstevel@tonic-gate } dt_idsig_t; 53*0Sstevel@tonic-gate 54*0Sstevel@tonic-gate typedef struct dt_idnode { 55*0Sstevel@tonic-gate struct dt_node *din_list; /* allocation list for parse tree nodes */ 56*0Sstevel@tonic-gate struct dt_node *din_root; /* root of this identifier's parse tree */ 57*0Sstevel@tonic-gate struct dt_idhash *din_hash; /* identifiers private to this subtree */ 58*0Sstevel@tonic-gate struct dt_ident **din_argv; /* identifiers in din_hash for arguments */ 59*0Sstevel@tonic-gate int din_argc; /* length of din_argv[] array */ 60*0Sstevel@tonic-gate } dt_idnode_t; 61*0Sstevel@tonic-gate 62*0Sstevel@tonic-gate typedef struct dt_idops { 63*0Sstevel@tonic-gate void (*di_cook)(struct dt_node *, struct dt_ident *, 64*0Sstevel@tonic-gate int, struct dt_node *); 65*0Sstevel@tonic-gate void (*di_dtor)(struct dt_ident *); 66*0Sstevel@tonic-gate size_t (*di_size)(struct dt_ident *); 67*0Sstevel@tonic-gate } dt_idops_t; 68*0Sstevel@tonic-gate 69*0Sstevel@tonic-gate typedef struct dt_ident { 70*0Sstevel@tonic-gate char *di_name; /* identifier name */ 71*0Sstevel@tonic-gate ushort_t di_kind; /* identifier kind (see below) */ 72*0Sstevel@tonic-gate ushort_t di_flags; /* identifier flags (see below) */ 73*0Sstevel@tonic-gate uint_t di_id; /* variable or subr id (see <sys/dtrace.h>) */ 74*0Sstevel@tonic-gate dtrace_attribute_t di_attr; /* identifier stability attributes */ 75*0Sstevel@tonic-gate uint_t di_vers; /* identifier version number (dt_version_t) */ 76*0Sstevel@tonic-gate const dt_idops_t *di_ops; /* identifier's class-specific ops vector */ 77*0Sstevel@tonic-gate void *di_iarg; /* initial argument pointer for ops vector */ 78*0Sstevel@tonic-gate void *di_data; /* private data pointer for ops vector */ 79*0Sstevel@tonic-gate ctf_file_t *di_ctfp; /* CTF container for the variable data type */ 80*0Sstevel@tonic-gate ctf_id_t di_type; /* CTF identifier for the variable data type */ 81*0Sstevel@tonic-gate struct dt_ident *di_next; /* pointer to next ident in hash chain */ 82*0Sstevel@tonic-gate ulong_t di_gen; /* generation number (pass that created me) */ 83*0Sstevel@tonic-gate int di_lineno; /* line number that defined this identifier */ 84*0Sstevel@tonic-gate } dt_ident_t; 85*0Sstevel@tonic-gate 86*0Sstevel@tonic-gate #define DT_IDENT_ARRAY 0 /* identifier is an array variable */ 87*0Sstevel@tonic-gate #define DT_IDENT_SCALAR 1 /* identifier is a scalar variable */ 88*0Sstevel@tonic-gate #define DT_IDENT_PTR 2 /* identifier is a magic pointer */ 89*0Sstevel@tonic-gate #define DT_IDENT_FUNC 3 /* identifier is a built-in function */ 90*0Sstevel@tonic-gate #define DT_IDENT_AGG 4 /* identifier is an aggregation */ 91*0Sstevel@tonic-gate #define DT_IDENT_AGGFUNC 5 /* identifier is an aggregating function */ 92*0Sstevel@tonic-gate #define DT_IDENT_ACTFUNC 6 /* identifier is an action function */ 93*0Sstevel@tonic-gate #define DT_IDENT_XLSOU 7 /* identifier is a translated struct or union */ 94*0Sstevel@tonic-gate #define DT_IDENT_XLPTR 8 /* identifier is a translated pointer */ 95*0Sstevel@tonic-gate #define DT_IDENT_SYMBOL 9 /* identifier is an external symbol */ 96*0Sstevel@tonic-gate #define DT_IDENT_ENUM 10 /* identifier is an enumerator */ 97*0Sstevel@tonic-gate #define DT_IDENT_PRAGAT 11 /* identifier is #pragma attributes */ 98*0Sstevel@tonic-gate #define DT_IDENT_PRAGBN 12 /* identifier is #pragma binding */ 99*0Sstevel@tonic-gate #define DT_IDENT_PROBE 13 /* identifier is a probe definition */ 100*0Sstevel@tonic-gate 101*0Sstevel@tonic-gate #define DT_IDFLG_TLS 0x0001 /* variable is thread-local storage */ 102*0Sstevel@tonic-gate #define DT_IDFLG_LOCAL 0x0002 /* variable is local storage */ 103*0Sstevel@tonic-gate #define DT_IDFLG_WRITE 0x0004 /* variable is writable (can be modified) */ 104*0Sstevel@tonic-gate #define DT_IDFLG_INLINE 0x0008 /* variable is an inline definition */ 105*0Sstevel@tonic-gate #define DT_IDFLG_REF 0x0010 /* variable is referenced by this program */ 106*0Sstevel@tonic-gate #define DT_IDFLG_MOD 0x0020 /* variable is modified by this program */ 107*0Sstevel@tonic-gate #define DT_IDFLG_DIFR 0x0040 /* variable is referenced by current DIFO */ 108*0Sstevel@tonic-gate #define DT_IDFLG_DIFW 0x0080 /* variable is modified by current DIFO */ 109*0Sstevel@tonic-gate #define DT_IDFLG_CGREG 0x0100 /* variable is inlined by code generator */ 110*0Sstevel@tonic-gate #define DT_IDFLG_USER 0x0200 /* variable is associated with userland */ 111*0Sstevel@tonic-gate #define DT_IDFLG_PRIM 0x0400 /* variable is associated with primary object */ 112*0Sstevel@tonic-gate #define DT_IDFLG_DECL 0x0800 /* variable is associated with explicit decl */ 113*0Sstevel@tonic-gate #define DT_IDFLG_ORPHAN 0x1000 /* variable is in a dt_node and not dt_idhash */ 114*0Sstevel@tonic-gate 115*0Sstevel@tonic-gate typedef struct dt_idhash { 116*0Sstevel@tonic-gate dt_list_t dh_list; /* list prev/next pointers for dt_idstack */ 117*0Sstevel@tonic-gate const char *dh_name; /* name of this hash table */ 118*0Sstevel@tonic-gate void (*dh_defer)(struct dt_idhash *, dt_ident_t *); /* defer callback */ 119*0Sstevel@tonic-gate const dt_ident_t *dh_tmpl; /* template for initial ident population */ 120*0Sstevel@tonic-gate uint_t dh_nextid; /* next id to be returned by idhash_nextid() */ 121*0Sstevel@tonic-gate uint_t dh_minid; /* min id to be returned by idhash_nextid() */ 122*0Sstevel@tonic-gate uint_t dh_maxid; /* max id to be returned by idhash_nextid() */ 123*0Sstevel@tonic-gate ulong_t dh_nelems; /* number of identifiers in hash table */ 124*0Sstevel@tonic-gate ulong_t dh_hashsz; /* number of entries in dh_buckets array */ 125*0Sstevel@tonic-gate dt_ident_t *dh_hash[1]; /* array of hash table bucket pointers */ 126*0Sstevel@tonic-gate } dt_idhash_t; 127*0Sstevel@tonic-gate 128*0Sstevel@tonic-gate typedef struct dt_idstack { 129*0Sstevel@tonic-gate dt_list_t dids_list; /* list meta-data for dt_idhash_t stack */ 130*0Sstevel@tonic-gate } dt_idstack_t; 131*0Sstevel@tonic-gate 132*0Sstevel@tonic-gate extern const dt_idops_t dt_idops_assc; /* associative array or aggregation */ 133*0Sstevel@tonic-gate extern const dt_idops_t dt_idops_func; /* function call built-in */ 134*0Sstevel@tonic-gate extern const dt_idops_t dt_idops_args; /* args[] built-in */ 135*0Sstevel@tonic-gate extern const dt_idops_t dt_idops_regs; /* regs[]/uregs[] built-in */ 136*0Sstevel@tonic-gate extern const dt_idops_t dt_idops_type; /* predefined type name string */ 137*0Sstevel@tonic-gate extern const dt_idops_t dt_idops_thaw; /* prefrozen type identifier */ 138*0Sstevel@tonic-gate extern const dt_idops_t dt_idops_inline; /* inline variable */ 139*0Sstevel@tonic-gate extern const dt_idops_t dt_idops_probe; /* probe definition */ 140*0Sstevel@tonic-gate 141*0Sstevel@tonic-gate extern dt_idhash_t *dt_idhash_create(const char *, const dt_ident_t *, 142*0Sstevel@tonic-gate uint_t, uint_t); 143*0Sstevel@tonic-gate extern void dt_idhash_destroy(dt_idhash_t *); 144*0Sstevel@tonic-gate extern void dt_idhash_update(dt_idhash_t *); 145*0Sstevel@tonic-gate extern dt_ident_t *dt_idhash_lookup(dt_idhash_t *, const char *); 146*0Sstevel@tonic-gate extern int dt_idhash_nextid(dt_idhash_t *, uint_t *); 147*0Sstevel@tonic-gate extern ulong_t dt_idhash_size(const dt_idhash_t *); 148*0Sstevel@tonic-gate extern const char *dt_idhash_name(const dt_idhash_t *); 149*0Sstevel@tonic-gate 150*0Sstevel@tonic-gate extern dt_ident_t *dt_idhash_insert(dt_idhash_t *, const char *, ushort_t, 151*0Sstevel@tonic-gate ushort_t, uint_t, dtrace_attribute_t, uint_t, 152*0Sstevel@tonic-gate const dt_idops_t *, void *, ulong_t); 153*0Sstevel@tonic-gate 154*0Sstevel@tonic-gate extern void dt_idhash_xinsert(dt_idhash_t *, dt_ident_t *); 155*0Sstevel@tonic-gate extern void dt_idhash_delete(dt_idhash_t *, dt_ident_t *); 156*0Sstevel@tonic-gate 157*0Sstevel@tonic-gate typedef int dt_idhash_f(dt_idhash_t *, dt_ident_t *, void *); 158*0Sstevel@tonic-gate extern int dt_idhash_iter(dt_idhash_t *, dt_idhash_f *, void *); 159*0Sstevel@tonic-gate 160*0Sstevel@tonic-gate extern dt_ident_t *dt_idstack_lookup(dt_idstack_t *, const char *); 161*0Sstevel@tonic-gate extern void dt_idstack_push(dt_idstack_t *, dt_idhash_t *); 162*0Sstevel@tonic-gate extern void dt_idstack_pop(dt_idstack_t *, dt_idhash_t *); 163*0Sstevel@tonic-gate 164*0Sstevel@tonic-gate extern dt_ident_t *dt_ident_create(const char *, ushort_t, ushort_t, uint_t, 165*0Sstevel@tonic-gate dtrace_attribute_t, uint_t, const dt_idops_t *, void *, ulong_t); 166*0Sstevel@tonic-gate extern void dt_ident_destroy(dt_ident_t *); 167*0Sstevel@tonic-gate extern void dt_ident_morph(dt_ident_t *, ushort_t, const dt_idops_t *, void *); 168*0Sstevel@tonic-gate extern dtrace_attribute_t dt_ident_cook(struct dt_node *, 169*0Sstevel@tonic-gate dt_ident_t *, struct dt_node **); 170*0Sstevel@tonic-gate 171*0Sstevel@tonic-gate extern void dt_ident_type_assign(dt_ident_t *, ctf_file_t *, ctf_id_t); 172*0Sstevel@tonic-gate extern dt_ident_t *dt_ident_resolve(dt_ident_t *); 173*0Sstevel@tonic-gate extern size_t dt_ident_size(dt_ident_t *); 174*0Sstevel@tonic-gate extern int dt_ident_unref(const dt_ident_t *); 175*0Sstevel@tonic-gate 176*0Sstevel@tonic-gate extern const char *dt_idkind_name(uint_t); 177*0Sstevel@tonic-gate 178*0Sstevel@tonic-gate #ifdef __cplusplus 179*0Sstevel@tonic-gate } 180*0Sstevel@tonic-gate #endif 181*0Sstevel@tonic-gate 182*0Sstevel@tonic-gate #endif /* _DT_IDENT_H */ 183