17c478bd9Sstevel@tonic-gate /*
27c478bd9Sstevel@tonic-gate  * CDDL HEADER START
37c478bd9Sstevel@tonic-gate  *
47c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
57c478bd9Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
67c478bd9Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
77c478bd9Sstevel@tonic-gate  * with the License.
87c478bd9Sstevel@tonic-gate  *
97c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
107c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
117c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
127c478bd9Sstevel@tonic-gate  * and limitations under the License.
137c478bd9Sstevel@tonic-gate  *
147c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
157c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
167c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
177c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
187c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
197c478bd9Sstevel@tonic-gate  *
207c478bd9Sstevel@tonic-gate  * CDDL HEADER END
217c478bd9Sstevel@tonic-gate  */
227c478bd9Sstevel@tonic-gate /*
237c478bd9Sstevel@tonic-gate  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
247c478bd9Sstevel@tonic-gate  * Use is subject to license terms.
257c478bd9Sstevel@tonic-gate  */
267c478bd9Sstevel@tonic-gate 
277c478bd9Sstevel@tonic-gate #ifndef	_DT_IDENT_H
287c478bd9Sstevel@tonic-gate #define	_DT_IDENT_H
297c478bd9Sstevel@tonic-gate 
307c478bd9Sstevel@tonic-gate #include <libctf.h>
317c478bd9Sstevel@tonic-gate #include <dtrace.h>
327c478bd9Sstevel@tonic-gate 
337c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
347c478bd9Sstevel@tonic-gate extern "C" {
357c478bd9Sstevel@tonic-gate #endif
367c478bd9Sstevel@tonic-gate 
377c478bd9Sstevel@tonic-gate #include <dt_list.h>
387c478bd9Sstevel@tonic-gate 
397c478bd9Sstevel@tonic-gate struct dt_node;
407c478bd9Sstevel@tonic-gate struct dt_ident;
417c478bd9Sstevel@tonic-gate struct dt_idhash;
427c478bd9Sstevel@tonic-gate struct dt_irlist;
437c478bd9Sstevel@tonic-gate struct dt_regset;
447c478bd9Sstevel@tonic-gate 
457c478bd9Sstevel@tonic-gate typedef struct dt_idsig {
467c478bd9Sstevel@tonic-gate 	int dis_varargs;	/* argument index of start of varargs (or -1) */
477c478bd9Sstevel@tonic-gate 	int dis_optargs;	/* argument index of start of optargs (or -1) */
487c478bd9Sstevel@tonic-gate 	int dis_argc;		/* number of types in this signature */
497c478bd9Sstevel@tonic-gate 	struct dt_node *dis_args; /* array of nodes representing formal types */
50*30ef842dSbmc 	uint64_t dis_auxinfo;	/* auxiliary signature information, if any */
517c478bd9Sstevel@tonic-gate } dt_idsig_t;
527c478bd9Sstevel@tonic-gate 
537c478bd9Sstevel@tonic-gate typedef struct dt_idnode {
547c478bd9Sstevel@tonic-gate 	struct dt_node *din_list; /* allocation list for parse tree nodes */
557c478bd9Sstevel@tonic-gate 	struct dt_node *din_root; /* root of this identifier's parse tree */
567c478bd9Sstevel@tonic-gate 	struct dt_idhash *din_hash; /* identifiers private to this subtree */
577c478bd9Sstevel@tonic-gate 	struct dt_ident **din_argv; /* identifiers in din_hash for arguments */
587c478bd9Sstevel@tonic-gate 	int din_argc;		  /* length of din_argv[] array */
597c478bd9Sstevel@tonic-gate } dt_idnode_t;
607c478bd9Sstevel@tonic-gate 
617c478bd9Sstevel@tonic-gate typedef struct dt_idops {
627c478bd9Sstevel@tonic-gate 	void (*di_cook)(struct dt_node *, struct dt_ident *,
637c478bd9Sstevel@tonic-gate 	    int, struct dt_node *);
647c478bd9Sstevel@tonic-gate 	void (*di_dtor)(struct dt_ident *);
657c478bd9Sstevel@tonic-gate 	size_t (*di_size)(struct dt_ident *);
667c478bd9Sstevel@tonic-gate } dt_idops_t;
677c478bd9Sstevel@tonic-gate 
687c478bd9Sstevel@tonic-gate typedef struct dt_ident {
697c478bd9Sstevel@tonic-gate 	char *di_name;		/* identifier name */
707c478bd9Sstevel@tonic-gate 	ushort_t di_kind;	/* identifier kind (see below) */
717c478bd9Sstevel@tonic-gate 	ushort_t di_flags;	/* identifier flags (see below) */
727c478bd9Sstevel@tonic-gate 	uint_t di_id;		/* variable or subr id (see <sys/dtrace.h>) */
737c478bd9Sstevel@tonic-gate 	dtrace_attribute_t di_attr; /* identifier stability attributes */
747c478bd9Sstevel@tonic-gate 	uint_t di_vers;		/* identifier version number (dt_version_t) */
757c478bd9Sstevel@tonic-gate 	const dt_idops_t *di_ops; /* identifier's class-specific ops vector */
767c478bd9Sstevel@tonic-gate 	void *di_iarg;		/* initial argument pointer for ops vector */
777c478bd9Sstevel@tonic-gate 	void *di_data;		/* private data pointer for ops vector */
787c478bd9Sstevel@tonic-gate 	ctf_file_t *di_ctfp;	/* CTF container for the variable data type */
797c478bd9Sstevel@tonic-gate 	ctf_id_t di_type;	/* CTF identifier for the variable data type */
807c478bd9Sstevel@tonic-gate 	struct dt_ident *di_next; /* pointer to next ident in hash chain */
817c478bd9Sstevel@tonic-gate 	ulong_t di_gen;		/* generation number (pass that created me) */
827c478bd9Sstevel@tonic-gate 	int di_lineno;		/* line number that defined this identifier */
837c478bd9Sstevel@tonic-gate } dt_ident_t;
847c478bd9Sstevel@tonic-gate 
857c478bd9Sstevel@tonic-gate #define	DT_IDENT_ARRAY	0	/* identifier is an array variable */
867c478bd9Sstevel@tonic-gate #define	DT_IDENT_SCALAR	1	/* identifier is a scalar variable */
877c478bd9Sstevel@tonic-gate #define	DT_IDENT_PTR	2	/* identifier is a magic pointer */
887c478bd9Sstevel@tonic-gate #define	DT_IDENT_FUNC	3	/* identifier is a built-in function */
897c478bd9Sstevel@tonic-gate #define	DT_IDENT_AGG	4	/* identifier is an aggregation */
907c478bd9Sstevel@tonic-gate #define	DT_IDENT_AGGFUNC 5	/* identifier is an aggregating function */
917c478bd9Sstevel@tonic-gate #define	DT_IDENT_ACTFUNC 6	/* identifier is an action function */
927c478bd9Sstevel@tonic-gate #define	DT_IDENT_XLSOU	7	/* identifier is a translated struct or union */
937c478bd9Sstevel@tonic-gate #define	DT_IDENT_XLPTR	8	/* identifier is a translated pointer */
947c478bd9Sstevel@tonic-gate #define	DT_IDENT_SYMBOL	9	/* identifier is an external symbol */
957c478bd9Sstevel@tonic-gate #define	DT_IDENT_ENUM	10	/* identifier is an enumerator */
967c478bd9Sstevel@tonic-gate #define	DT_IDENT_PRAGAT	11	/* identifier is #pragma attributes */
977c478bd9Sstevel@tonic-gate #define	DT_IDENT_PRAGBN	12	/* identifier is #pragma binding */
987c478bd9Sstevel@tonic-gate #define	DT_IDENT_PROBE	13	/* identifier is a probe definition */
997c478bd9Sstevel@tonic-gate 
1007c478bd9Sstevel@tonic-gate #define	DT_IDFLG_TLS	0x0001	/* variable is thread-local storage */
1017c478bd9Sstevel@tonic-gate #define	DT_IDFLG_LOCAL	0x0002	/* variable is local storage */
1027c478bd9Sstevel@tonic-gate #define	DT_IDFLG_WRITE	0x0004	/* variable is writable (can be modified) */
1037c478bd9Sstevel@tonic-gate #define	DT_IDFLG_INLINE	0x0008	/* variable is an inline definition */
1047c478bd9Sstevel@tonic-gate #define	DT_IDFLG_REF	0x0010	/* variable is referenced by this program */
1057c478bd9Sstevel@tonic-gate #define	DT_IDFLG_MOD	0x0020	/* variable is modified by this program */
1067c478bd9Sstevel@tonic-gate #define	DT_IDFLG_DIFR	0x0040	/* variable is referenced by current DIFO */
1077c478bd9Sstevel@tonic-gate #define	DT_IDFLG_DIFW	0x0080	/* variable is modified by current DIFO */
1087c478bd9Sstevel@tonic-gate #define	DT_IDFLG_CGREG	0x0100	/* variable is inlined by code generator */
1097c478bd9Sstevel@tonic-gate #define	DT_IDFLG_USER	0x0200	/* variable is associated with userland */
1107c478bd9Sstevel@tonic-gate #define	DT_IDFLG_PRIM	0x0400	/* variable is associated with primary object */
1117c478bd9Sstevel@tonic-gate #define	DT_IDFLG_DECL	0x0800	/* variable is associated with explicit decl */
1127c478bd9Sstevel@tonic-gate #define	DT_IDFLG_ORPHAN	0x1000	/* variable is in a dt_node and not dt_idhash */
1137c478bd9Sstevel@tonic-gate 
1147c478bd9Sstevel@tonic-gate typedef struct dt_idhash {
1157c478bd9Sstevel@tonic-gate 	dt_list_t dh_list;	/* list prev/next pointers for dt_idstack */
1167c478bd9Sstevel@tonic-gate 	const char *dh_name;	/* name of this hash table */
1177c478bd9Sstevel@tonic-gate 	void (*dh_defer)(struct dt_idhash *, dt_ident_t *); /* defer callback */
1187c478bd9Sstevel@tonic-gate 	const dt_ident_t *dh_tmpl; /* template for initial ident population */
1197c478bd9Sstevel@tonic-gate 	uint_t dh_nextid;	/* next id to be returned by idhash_nextid() */
1207c478bd9Sstevel@tonic-gate 	uint_t dh_minid;	/* min id to be returned by idhash_nextid() */
1217c478bd9Sstevel@tonic-gate 	uint_t dh_maxid;	/* max id to be returned by idhash_nextid() */
1227c478bd9Sstevel@tonic-gate 	ulong_t dh_nelems;	/* number of identifiers in hash table */
1237c478bd9Sstevel@tonic-gate 	ulong_t dh_hashsz;	/* number of entries in dh_buckets array */
1247c478bd9Sstevel@tonic-gate 	dt_ident_t *dh_hash[1];	/* array of hash table bucket pointers */
1257c478bd9Sstevel@tonic-gate } dt_idhash_t;
1267c478bd9Sstevel@tonic-gate 
1277c478bd9Sstevel@tonic-gate typedef struct dt_idstack {
1287c478bd9Sstevel@tonic-gate 	dt_list_t dids_list;	/* list meta-data for dt_idhash_t stack */
1297c478bd9Sstevel@tonic-gate } dt_idstack_t;
1307c478bd9Sstevel@tonic-gate 
1317c478bd9Sstevel@tonic-gate extern const dt_idops_t dt_idops_assc;	/* associative array or aggregation */
1327c478bd9Sstevel@tonic-gate extern const dt_idops_t dt_idops_func;	/* function call built-in */
1337c478bd9Sstevel@tonic-gate extern const dt_idops_t dt_idops_args;	/* args[] built-in */
1347c478bd9Sstevel@tonic-gate extern const dt_idops_t dt_idops_regs;	/* regs[]/uregs[] built-in */
1357c478bd9Sstevel@tonic-gate extern const dt_idops_t dt_idops_type;	/* predefined type name string */
1367c478bd9Sstevel@tonic-gate extern const dt_idops_t dt_idops_thaw;	/* prefrozen type identifier */
1377c478bd9Sstevel@tonic-gate extern const dt_idops_t dt_idops_inline; /* inline variable */
1387c478bd9Sstevel@tonic-gate extern const dt_idops_t dt_idops_probe;	/* probe definition */
1397c478bd9Sstevel@tonic-gate 
1407c478bd9Sstevel@tonic-gate extern dt_idhash_t *dt_idhash_create(const char *, const dt_ident_t *,
1417c478bd9Sstevel@tonic-gate     uint_t, uint_t);
1427c478bd9Sstevel@tonic-gate extern void dt_idhash_destroy(dt_idhash_t *);
1437c478bd9Sstevel@tonic-gate extern void dt_idhash_update(dt_idhash_t *);
1447c478bd9Sstevel@tonic-gate extern dt_ident_t *dt_idhash_lookup(dt_idhash_t *, const char *);
1457c478bd9Sstevel@tonic-gate extern int dt_idhash_nextid(dt_idhash_t *, uint_t *);
1467c478bd9Sstevel@tonic-gate extern ulong_t dt_idhash_size(const dt_idhash_t *);
1477c478bd9Sstevel@tonic-gate extern const char *dt_idhash_name(const dt_idhash_t *);
1487c478bd9Sstevel@tonic-gate 
1497c478bd9Sstevel@tonic-gate extern dt_ident_t *dt_idhash_insert(dt_idhash_t *, const char *, ushort_t,
1507c478bd9Sstevel@tonic-gate     ushort_t, uint_t, dtrace_attribute_t, uint_t,
1517c478bd9Sstevel@tonic-gate     const dt_idops_t *, void *, ulong_t);
1527c478bd9Sstevel@tonic-gate 
1537c478bd9Sstevel@tonic-gate extern void dt_idhash_xinsert(dt_idhash_t *, dt_ident_t *);
1547c478bd9Sstevel@tonic-gate extern void dt_idhash_delete(dt_idhash_t *, dt_ident_t *);
1557c478bd9Sstevel@tonic-gate 
1567c478bd9Sstevel@tonic-gate typedef int dt_idhash_f(dt_idhash_t *, dt_ident_t *, void *);
1577c478bd9Sstevel@tonic-gate extern int dt_idhash_iter(dt_idhash_t *, dt_idhash_f *, void *);
1587c478bd9Sstevel@tonic-gate 
1597c478bd9Sstevel@tonic-gate extern dt_ident_t *dt_idstack_lookup(dt_idstack_t *, const char *);
1607c478bd9Sstevel@tonic-gate extern void dt_idstack_push(dt_idstack_t *, dt_idhash_t *);
1617c478bd9Sstevel@tonic-gate extern void dt_idstack_pop(dt_idstack_t *, dt_idhash_t *);
1627c478bd9Sstevel@tonic-gate 
1637c478bd9Sstevel@tonic-gate extern dt_ident_t *dt_ident_create(const char *, ushort_t, ushort_t, uint_t,
1647c478bd9Sstevel@tonic-gate     dtrace_attribute_t, uint_t, const dt_idops_t *, void *, ulong_t);
1657c478bd9Sstevel@tonic-gate extern void dt_ident_destroy(dt_ident_t *);
1667c478bd9Sstevel@tonic-gate extern void dt_ident_morph(dt_ident_t *, ushort_t, const dt_idops_t *, void *);
1677c478bd9Sstevel@tonic-gate extern dtrace_attribute_t dt_ident_cook(struct dt_node *,
1687c478bd9Sstevel@tonic-gate     dt_ident_t *, struct dt_node **);
1697c478bd9Sstevel@tonic-gate 
1707c478bd9Sstevel@tonic-gate extern void dt_ident_type_assign(dt_ident_t *, ctf_file_t *, ctf_id_t);
1717c478bd9Sstevel@tonic-gate extern dt_ident_t *dt_ident_resolve(dt_ident_t *);
1727c478bd9Sstevel@tonic-gate extern size_t dt_ident_size(dt_ident_t *);
1737c478bd9Sstevel@tonic-gate extern int dt_ident_unref(const dt_ident_t *);
1747c478bd9Sstevel@tonic-gate 
1757c478bd9Sstevel@tonic-gate extern const char *dt_idkind_name(uint_t);
1767c478bd9Sstevel@tonic-gate 
1777c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
1787c478bd9Sstevel@tonic-gate }
1797c478bd9Sstevel@tonic-gate #endif
1807c478bd9Sstevel@tonic-gate 
1817c478bd9Sstevel@tonic-gate #endif	/* _DT_IDENT_H */
182