/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef _DT_XLATOR_H
#define _DT_XLATOR_H

#include <libctf.h>
#include <dtrace.h>
#include <dt_ident.h>
#include <dt_list.h>

#ifdef  __cplusplus
extern "C" {
#endif

struct dt_node;

typedef struct dt_xlator {
        dt_list_t dx_list;              /* list forward/back pointers */
        dt_idhash_t *dx_locals;         /* hash of local scope identifiers */
        dt_ident_t *dx_ident;           /* identifier ref for input param */
        dt_ident_t dx_souid;            /* fake identifier for sou output */
        dt_ident_t dx_ptrid;            /* fake identifier for ptr output */
        ctf_file_t *dx_src_ctfp;        /* CTF container for input type */
        ctf_id_t dx_src_type;           /* CTF reference for input type */
        ctf_id_t dx_src_base;           /* CTF reference for input base */
        ctf_file_t *dx_dst_ctfp;        /* CTF container for output type */
        ctf_id_t dx_dst_type;           /* CTF reference for output type */
        ctf_id_t dx_dst_base;           /* CTF reference for output base */
        struct dt_node *dx_members;     /* list of member translations */
        uint_t dx_nmembers;             /* length of dx_members list */
        dtrace_difo_t **dx_membdif;     /* DIF for member expressions */
        struct dt_node *dx_nodes;       /* list of parse tree nodes */
        dtrace_hdl_t *dx_hdl;           /* back pointer to containing handle */
        ulong_t dx_gen;                 /* generation number that created me */
        id_t dx_id;                     /* global translator id */
        int dx_arg;                     /* dynamic argument index */
} dt_xlator_t;

extern dt_xlator_t *dt_xlator_create(dtrace_hdl_t *,
    const dtrace_typeinfo_t *, const dtrace_typeinfo_t *,
    const char *, struct dt_node *, struct dt_node *);

extern void dt_xlator_destroy(dtrace_hdl_t *, dt_xlator_t *);

#define DT_XLATE_FUZZY  0x0             /* lookup any matching translator */
#define DT_XLATE_EXACT  0x1             /* lookup only exact type matches */
#define DT_XLATE_EXTERN 0x2             /* extern translator if none exists */

extern dt_xlator_t *dt_xlator_lookup(dtrace_hdl_t *,
    struct dt_node *, struct dt_node *, int);

extern dt_xlator_t *dt_xlator_lookup_id(dtrace_hdl_t *, id_t);
extern dt_ident_t *dt_xlator_ident(dt_xlator_t *, ctf_file_t *, ctf_id_t);
extern struct dt_node *dt_xlator_member(dt_xlator_t *, const char *);
extern int dt_xlator_dynamic(const dt_xlator_t *);

#ifdef  __cplusplus
}
#endif

#endif  /* _DT_XLATOR_H */