"I am a person who works hard and plays hard."

---

Yuan Wei
Second Year Graduate Student Department of Computer Science
University of Virginia Charlottesville, VA 22903
Email: yw3f@cs.virginia.edu

---

Source Code Analysis
         

---

eval.h

Go to the documentation of this file.

/*
 * expr.h - expression evaluator interfaces
 *
 * This file is a part of the SimpleScalar tool suite written by
 * Todd M. Austin as a part of the Multiscalar Research Project.
 *  
 * The tool suite is currently maintained by Doug Burger and Todd M. Austin.
 * 
 * Copyright (C) 1994, 1995, 1996, 1997, 1998 by Todd M. Austin
 *
 * This source file is distributed "as is" in the hope that it will be
 * useful.  The tool set comes with no warranty, and no author or
 * distributor accepts any responsibility for the consequences of its
 * use. 
 * 
 * Everyone is granted permission to copy, modify and redistribute
 * this tool set under the following conditions:
 * 
 *    This source code is distributed for non-commercial use only. 
 *    Please contact the maintainer for restrictions applying to 
 *    commercial use.
 *
 *    Permission is granted to anyone to make or distribute copies
 *    of this source code, either as received or modified, in any
 *    medium, provided that all copyright notices, permission and
 *    nonwarranty notices are preserved, and that the distributor
 *    grants the recipient permission for further redistribution as
 *    permitted by this document.
 *
 *    Permission is granted to distribute this file in compiled
 *    or executable form under the same conditions that apply for
 *    source code, provided that either:
 *
 *    A. it is accompanied by the corresponding machine-readable
 *       source code,
 *    B. it is accompanied by a written offer, with no time limit,
 *       to give anyone a machine-readable copy of the corresponding
 *       source code in return for reimbursement of the cost of
 *       distribution.  This written offer must permit verbatim
 *       duplication by anyone, or
 *    C. it is distributed by someone who received only the
 *       executable form, and is accompanied by a copy of the
 *       written offer of source code that they received concurrently.
 *
 * In other words, you are welcome to use, share and improve this
 * source file.  You are forbidden to forbid anyone else to use, share
 * and improve what you give them.
 *
 * INTERNET: dburger@cs.wisc.edu
 * US Mail:  1210 W. Dayton Street, Madison, WI 53706
 *
 * $Id: eval.h,v 1.1.1.1 2000/05/26 15:21:53 taustin Exp $
 *
 * $Log: eval.h,v $
 * Revision 1.1.1.1  2000/05/26 15:21:53  taustin
 * SimpleScalar Tool Set
 *
 *
 * Revision 1.3  1999/12/31 18:36:51  taustin
 * cross-endian execution support added
 *
 * Revision 1.2  1998/08/27 08:27:01  taustin
 * implemented host interface description in host.h
 * added target interface support
 * added support for qword's
 *
 * Revision 1.1  1997/03/11  01:31:15  taustin
 * Initial revision
 *
 *
 */

#ifndef EVAL_H
#define EVAL_H

#include <stdio.h>
#include "host.h"
#include "misc.h"
#include "machine.h"

/* forward declarations */
struct eval_state_t;
struct eval_value_t;

/* an identifier evaluator, when an evaluator is instantiated, the user
   must supply a function of this type that returns the value of identifiers
   encountered in expressions */
typedef struct eval_value_t               /* value of the identifier */
(*eval_ident_t)(struct eval_state_t *es); /* ident string in es->tok_buf */

/* expression tokens */
enum eval_token_t {
  tok_ident,            /* user-valued identifiers */
  tok_const,            /* numeric literals */
  tok_plus,             /* `+' */
  tok_minus,            /* `-' */
  tok_mult,             /* `*' */
  tok_div,              /* `/' */
  tok_oparen,           /* `(' */
  tok_cparen,           /* `)' */
  tok_eof,              /* end of file */
  tok_whitespace,       /* ` ', `\t', `\n' */
  tok_invalid           /* unrecognized token */
};

/* an evaluator state record */
struct eval_state_t {
  char *p;                      /* ptr to next char to consume from expr */
  char *lastp;                  /* save space for token peeks */
  eval_ident_t f_eval_ident;    /* identifier evaluator */
  void *user_ptr;               /* user-supplied argument pointer */
  char tok_buf[512];            /* text of last token returned */
  enum eval_token_t peek_tok;   /* peek buffer, for one token look-ahead */
};

/* evaluation errors */
enum eval_err_t {
  ERR_NOERR,                    /* no error */
  ERR_UPAREN,                   /* unmatched parenthesis */
  ERR_NOTERM,                   /* expression term is missing */
  ERR_DIV0,                     /* divide by zero */
  ERR_BADCONST,                 /* badly formed constant */
  ERR_BADEXPR,                  /* badly formed constant */
  ERR_UNDEFVAR,                 /* variable is undefined */
  ERR_EXTRA,                    /* extra characters at end of expression */
  ERR_NUM
};

/* expression evaluation error, this must be a global */
extern enum eval_err_t eval_error /* = ERR_NOERR */;

/* enum eval_err_t -> error description string map */
extern char *eval_err_str[ERR_NUM];

/* expression value types */
enum eval_type_t {
  et_int,                       /* signed integer result */
  et_uint,                      /* unsigned integer result */
  et_addr,                      /* address value */
#ifdef HOST_HAS_QWORD
  et_qword,                     /* unsigned qword length integer result */
  et_sqword,                    /* signed qword length integer result */
#endif /* HOST_HAS_QWORD */
  et_float,                     /* single-precision floating point value */
  et_double,                    /* double-precision floating point value */
  et_symbol,                    /* non-numeric result (!allowed in exprs)*/
  et_NUM
};

/* non-zero if type is an integral type */
#ifdef HOST_HAS_QWORD
#define EVAL_INTEGRAL(TYPE)                                             \
  ((TYPE) == et_int || (TYPE) == et_uint || (TYPE) == et_addr           \
   || (TYPE) == et_qword || (TYPE) == et_sqword)
#else /* !HOST_HAS_QWORD */
#define EVAL_INTEGRAL(TYPE)                                             \
  ((TYPE) == et_int || (TYPE) == et_uint || (TYPE) == et_addr)
#endif /* HOST_HAS_QWORD */

/* enum eval_type_t -> expression type description string map */
extern char *eval_type_str[et_NUM];

/* an expression value */
struct eval_value_t {
  enum eval_type_t type;                /* type of expression value */
  union {
    int as_int;                         /* value for type == et_int */
    unsigned int as_uint;               /* value for type == et_uint */
    md_addr_t as_addr;                  /* value for type == et_addr */
#ifdef HOST_HAS_QWORD
    qword_t as_qword;                   /* value for type == ec_qword */
    sqword_t as_sqword;                 /* value for type == ec_sqword */
#endif /* HOST_HAS_QWORD */
    float as_float;                     /* value for type == et_float */
    double as_double;                   /* value for type == et_double */
    char *as_symbol;                    /* value for type == et_symbol */
  } value;
};

/*
 * expression value arithmetic conversions
 */

/* eval_value_t (any numeric type) -> double */
double eval_as_double(struct eval_value_t val);

/* eval_value_t (any numeric type) -> float */
float eval_as_float(struct eval_value_t val);

#ifdef HOST_HAS_QWORD
/* eval_value_t (any numeric type) -> qword_t */
qword_t eval_as_qword(struct eval_value_t val);

/* eval_value_t (any numeric type) -> sqword_t */
sqword_t eval_as_sqword(struct eval_value_t val);
#endif /* HOST_HAS_QWORD */

/* eval_value_t (any numeric type) -> md_addr_t */
md_addr_t eval_as_addr(struct eval_value_t val);

/* eval_value_t (any numeric type) -> unsigned int */
unsigned int eval_as_uint(struct eval_value_t val);

/* eval_value_t (any numeric type) -> int */
int eval_as_int(struct eval_value_t val);

/* create an evaluator */
struct eval_state_t *                   /* expression evaluator */
eval_new(eval_ident_t f_eval_ident,     /* user ident evaluator */
         void *user_ptr);               /* user ptr passed to ident fn */

/* delete an evaluator */
void
eval_delete(struct eval_state_t *es);   /* evaluator to delete */

/* evaluate an expression, if an error occurs during evaluation, the
   global variable eval_error will be set to a value other than ERR_NOERR */
struct eval_value_t                     /* value of the expression */
eval_expr(struct eval_state_t *es,      /* expression evaluator */
          char *p,                      /* ptr to expression string */
          char **endp);                 /* returns ptr to 1st unused char */

/* print an expression value */
void
eval_print(FILE *stream,                /* output stream */
           struct eval_value_t val);    /* expression value to print */

#endif /* EVAL_H */

	Department of Computer Science School of Engineering, University of Virginia 151 Engineer's Way, P.O. Box 400740 Charlottesville, Virginia 22904-4740 (434) 982-2200  Fax: (434) 982-2214