/* expr.c -- arithmetic expression evaluation. */ /* Copyright (C) 1990-2002 Free Software Foundation, Inc. This file is part of GNU Bash, the Bourne Again SHell. Bash is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. Bash is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Bash; see the file COPYING. If not, write to the Free Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */ /* All arithmetic is done as intmax_t integers with no checking for overflow (though division by 0 is caught and flagged as an error). The following operators are handled, grouped into a set of levels in order of decreasing precedence. "id++", "id--" [post-increment and post-decrement] "++id", "--id" [pre-increment and pre-decrement] "-", "+" [(unary operators)] "!", "~" "**" [(exponentiation)] "*", "/", "%" "+", "-" "<<", ">>" "<=", ">=", "<", ">" "==", "!=" "&" "^" "|" "&&" "||" "expr ? expr : expr" "=", "*=", "/=", "%=", "+=", "-=", "<<=", ">>=", "&=", "^=", "|=" (Note that most of these operators have special meaning to bash, and an entire expression should be quoted, e.g. "a=$a+1" or "a=a+1" to ensure that it is passed intact to the evaluator when using `let'. When using the $[] or $(( )) forms, the text between the `[' and `]' or `((' and `))' is treated as if in double quotes.) Sub-expressions within parentheses have a precedence level greater than all of the above levels and are evaluated first. Within a single prece- dence group, evaluation is left-to-right, except for the arithmetic assignment operator (`='), which is evaluated right-to-left (as in C). The expression evaluator returns the value of the expression (assignment statements have as a value what is returned by the RHS). The `let' builtin, on the other hand, returns 0 if the last expression evaluates to a non-zero, and 1 otherwise. Implementation is a recursive-descent parser. Chet Ramey chet@ins.CWRU.Edu */ #include "config.h" #include #include "bashansi.h" #if defined (HAVE_UNISTD_H) # ifdef _MINIX # include # endif # include #endif #include "chartypes.h" #include "shell.h" /* Because of the $((...)) construct, expressions may include newlines. Here is a macro which accepts newlines, tabs and spaces as whitespace. */ #define cr_whitespace(c) (whitespace(c) || ((c) == '\n')) /* Size be which the expression stack grows when neccessary. */ #define EXPR_STACK_GROW_SIZE 10 /* Maximum amount of recursion allowed. This prevents a non-integer variable such as "num=num+2" from infinitely adding to itself when "let num=num+2" is given. */ #define MAX_EXPR_RECURSION_LEVEL 1024 /* The Tokens. Singing "The Lion Sleeps Tonight". */ #define EQEQ 1 /* "==" */ #define NEQ 2 /* "!=" */ #define LEQ 3 /* "<=" */ #define GEQ 4 /* ">=" */ #define STR 5 /* string */ #define NUM 6 /* number */ #define LAND 7 /* "&&" Logical AND */ #define LOR 8 /* "||" Logical OR */ #define LSH 9 /* "<<" Left SHift */ #define RSH 10 /* ">>" Right SHift */ #define OP_ASSIGN 11 /* op= expassign as in Posix.2 */ #define COND 12 /* exp1 ? exp2 : exp3 */ #define POWER 13 /* exp1**exp2 */ #define PREINC 14 /* ++var */ #define PREDEC 15 /* --var */ #define POSTINC 16 /* var++ */ #define POSTDEC 17 /* var-- */ #define EQ '=' #define GT '>' #define LT '<' #define PLUS '+' #define MINUS '-' #define MUL '*' #define DIV '/' #define MOD '%' #define NOT '!' #define LPAR '(' #define RPAR ')' #define BAND '&' /* Bitwise AND */ #define BOR '|' /* Bitwise OR. */ #define BXOR '^' /* Bitwise eXclusive OR. */ #define BNOT '~' /* Bitwise NOT; Two's complement. */ #define QUES '?' #define COL ':' #define COMMA ',' /* This should be the function corresponding to the operator with the highest precedence. */ #define EXP_HIGHEST expcomma static char *expression; /* The current expression */ static char *tp; /* token lexical position */ static char *lasttp; /* pointer to last token position */ static int curtok; /* the current token */ static int lasttok; /* the previous token */ static int assigntok; /* the OP in OP= */ static char *tokstr; /* current token string */ static intmax_t tokval; /* current token value */ static int noeval; /* set to 1 if no assignment to be done */ static procenv_t evalbuf; static void readtok __P((void)); /* lexical analyzer */ static intmax_t expr_streval __P((char *, int)); static intmax_t strlong __P((char *)); static void evalerror __P((char *)); static void pushexp __P((void)); static void popexp __P((void)); static void expr_unwind __P((void)); static intmax_t subexpr __P((char *)); static intmax_t expcomma __P((void)); static intmax_t expassign __P((void)); static intmax_t expcond __P((void)); static intmax_t explor __P((void)); static intmax_t expland __P((void)); static intmax_t expbor __P((void)); static intmax_t expbxor __P((void)); static intmax_t expband __P((void)); static intmax_t exp5 __P((void)); static intmax_t exp4 __P((void)); static intmax_t expshift __P((void)); static intmax_t exp3 __P((void)); static intmax_t exp2 __P((void)); static intmax_t exppower __P((void)); static intmax_t exp1 __P((void)); static intmax_t exp0 __P((void)); /* A structure defining a single expression context. */ typedef struct { int curtok, lasttok; char *expression, *tp, *lasttp; intmax_t tokval; char *tokstr; int noeval; } EXPR_CONTEXT; #ifdef INCLUDE_UNUSED /* Not used yet. */ typedef struct { char *tokstr; intmax_t tokval; } LVALUE; #endif /* Global var which contains the stack of expression contexts. */ static EXPR_CONTEXT **expr_stack; static int expr_depth; /* Location in the stack. */ static int expr_stack_size; /* Number of slots already allocated. */ extern char *this_command_name; extern int unbound_vars_is_error; #define SAVETOK(X) \ do { \ (X)->curtok = curtok; \ (X)->lasttok = lasttok; \ (X)->tp = tp; \ (X)->lasttp = lasttp; \ (X)->tokval = tokval; \ (X)->tokstr = tokstr; \ (X)->noeval = noeval; \ } while (0) #define RESTORETOK(X) \ do { \ curtok = (X)->curtok; \ lasttok = (X)->lasttok; \ tp = (X)->tp; \ lasttp = (X)->lasttp; \ tokval = (X)->tokval; \ tokstr = (X)->tokstr; \ noeval = (X)->noeval; \ } while (0) /* Push and save away the contents of the globals describing the current expression context. */ static void pushexp () { EXPR_CONTEXT *context; if (expr_depth >= MAX_EXPR_RECURSION_LEVEL) evalerror ("expression recursion level exceeded"); if (expr_depth >= expr_stack_size) { expr_stack_size += EXPR_STACK_GROW_SIZE; expr_stack = (EXPR_CONTEXT **)xrealloc (expr_stack, expr_stack_size * sizeof (EXPR_CONTEXT *)); } context = (EXPR_CONTEXT *)xmalloc (sizeof (EXPR_CONTEXT)); context->expression = expression; SAVETOK(context); expr_stack[expr_depth++] = context; } /* Pop the the contents of the expression context stack into the globals describing the current expression context. */ static void popexp () { EXPR_CONTEXT *context; if (expr_depth == 0) evalerror ("recursion stack underflow"); context = expr_stack[--expr_depth]; expression = context->expression; RESTORETOK (context); free (context); } static void expr_unwind () { while (--expr_depth > 0) { if (expr_stack[expr_depth]->tokstr) free (expr_stack[expr_depth]->tokstr); if (expr_stack[expr_depth]->expression) free (expr_stack[expr_depth]->expression); free (expr_stack[expr_depth]); } free (expr_stack[expr_depth]); /* free the allocated EXPR_CONTEXT */ } /* Evaluate EXPR, and return the arithmetic result. If VALIDP is non-null, a zero is stored into the location to which it points if the expression is invalid, non-zero otherwise. If a non-zero value is returned in *VALIDP, the return value of evalexp() may be used. The `while' loop after the longjmp is caught relies on the above implementation of pushexp and popexp leaving in expr_stack[0] the values that the variables had when the program started. That is, the first things saved are the initial values of the variables that were assigned at program startup or by the compiler. Therefore, it is safe to let the loop terminate when expr_depth == 0, without freeing up any of the expr_depth[0] stuff. */ intmax_t evalexp (expr, validp) char *expr; int *validp; { intmax_t val; val = 0; if (setjmp (evalbuf)) { FREE (tokstr); FREE (expression); tokstr = expression = (char *)NULL; expr_unwind (); if (validp) *validp = 0; return (0); } val = subexpr (expr); if (validp) *validp = 1; return (val); } static intmax_t subexpr (expr) char *expr; { intmax_t val; char *p; for (p = expr; p && *p && cr_whitespace (*p); p++) ; if (p == NULL || *p == '\0') return (0); pushexp (); curtok = lasttok = 0; expression = savestring (expr); tp = expression; tokstr = (char *)NULL; tokval = 0; readtok (); val = EXP_HIGHEST (); if (curtok != 0) evalerror ("syntax error in expression"); FREE (tokstr); FREE (expression); popexp (); return val; } static intmax_t expcomma () { register intmax_t value; value = expassign (); while (curtok == COMMA) { readtok (); value = expassign (); } return value; } static intmax_t expassign () { register intmax_t value; char *lhs, *rhs; value = expcond (); if (curtok == EQ || curtok == OP_ASSIGN) { int special, op; intmax_t lvalue; special = curtok == OP_ASSIGN; if (lasttok != STR) evalerror ("attempted assignment to non-variable"); if (special) { op = assigntok; /* a OP= b */ lvalue = value; } lhs = savestring (tokstr); readtok (); value = expassign (); if (special) { switch (op) { case MUL: lvalue *= value; break; case DIV: if (value == 0) evalerror ("division by 0"); lvalue /= value; break; case MOD: if (value == 0) evalerror ("division by 0"); lvalue %= value; break; case PLUS: lvalue += value; break; case MINUS: lvalue -= value; break; case LSH: lvalue <<= value; break; case RSH: lvalue >>= value; break; case BAND: lvalue &= value; break; case BOR: lvalue |= value; break; case BXOR: lvalue ^= value; break; default: free (lhs); evalerror ("bug: bad expassign token"); break; } value = lvalue; } rhs = itos (value); if (noeval == 0) (void)bind_int_variable (lhs, rhs); free (rhs); free (lhs); FREE (tokstr); tokstr = (char *)NULL; /* For freeing on errors. */ } return (value); } /* Conditional expression (expr?expr:expr) */ static intmax_t expcond () { intmax_t cval, val1, val2, rval; int set_noeval; set_noeval = 0; rval = cval = explor (); if (curtok == QUES) /* found conditional expr */ { readtok (); if (curtok == 0 || curtok == COL) evalerror ("expression expected"); if (cval == 0) { set_noeval = 1; noeval++; } val1 = EXP_HIGHEST (); if (set_noeval) noeval--; if (curtok != COL) evalerror ("`:' expected for conditional expression"); readtok (); if (curtok == 0) evalerror ("expression expected"); set_noeval = 0; if (cval) { set_noeval = 1; noeval++; } val2 = explor (); if (set_noeval) noeval--; rval = cval ? val1 : val2; lasttok = COND; } return rval; } /* Logical OR. */ static intmax_t explor () { register intmax_t val1, val2; int set_noeval; val1 = expland (); while (curtok == LOR) { set_noeval = 0; if (val1 != 0) { noeval++; set_noeval = 1; } readtok (); val2 = expland (); if (set_noeval) noeval--; val1 = val1 || val2; lasttok = LOR; } return (val1); } /* Logical AND. */ static intmax_t expland () { register intmax_t val1, val2; int set_noeval; val1 = expbor (); while (curtok == LAND) { set_noeval = 0; if (val1 == 0) { set_noeval = 1; noeval++; } readtok (); val2 = expbor (); if (set_noeval) noeval--; val1 = val1 && val2; lasttok = LAND; } return (val1); } /* Bitwise OR. */ static intmax_t expbor () { register intmax_t val1, val2; val1 = expbxor (); while (curtok == BOR) { readtok (); val2 = expbxor (); val1 = val1 | val2; } return (val1); } /* Bitwise XOR. */ static intmax_t expbxor () { register intmax_t val1, val2; val1 = expband (); while (curtok == BXOR) { readtok (); val2 = expband (); val1 = val1 ^ val2; } return (val1); } /* Bitwise AND. */ static intmax_t expband () { register intmax_t val1, val2; val1 = exp5 (); while (curtok == BAND) { readtok (); val2 = exp5 (); val1 = val1 & val2; } return (val1); } static intmax_t exp5 () { register intmax_t val1, val2; val1 = exp4 (); while ((curtok == EQEQ) || (curtok == NEQ)) { int op = curtok; readtok (); val2 = exp4 (); if (op == EQEQ) val1 = (val1 == val2); else if (op == NEQ) val1 = (val1 != val2); } return (val1); } static intmax_t exp4 () { register intmax_t val1, val2; val1 = expshift (); while ((curtok == LEQ) || (curtok == GEQ) || (curtok == LT) || (curtok == GT)) { int op = curtok; readtok (); val2 = expshift (); if (op == LEQ) val1 = val1 <= val2; else if (op == GEQ) val1 = val1 >= val2; else if (op == LT) val1 = val1 < val2; else /* (op == GT) */ val1 = val1 > val2; } return (val1); } /* Left and right shifts. */ static intmax_t expshift () { register intmax_t val1, val2; val1 = exp3 (); while ((curtok == LSH) || (curtok == RSH)) { int op = curtok; readtok (); val2 = exp3 (); if (op == LSH) val1 = val1 << val2; else val1 = val1 >> val2; } return (val1); } static intmax_t exp3 () { register intmax_t val1, val2; val1 = exp2 (); while ((curtok == PLUS) || (curtok == MINUS)) { int op = curtok; readtok (); val2 = exp2 (); if (op == PLUS) val1 += val2; else if (op == MINUS) val1 -= val2; } return (val1); } static intmax_t exp2 () { register intmax_t val1, val2; val1 = exppower (); while ((curtok == MUL) || (curtok == DIV) || (curtok == MOD)) { int op = curtok; readtok (); val2 = exppower (); if (((op == DIV) || (op == MOD)) && (val2 == 0)) evalerror ("division by 0"); if (op == MUL) val1 *= val2; else if (op == DIV) val1 /= val2; else if (op == MOD) val1 %= val2; } return (val1); } static intmax_t exppower () { register intmax_t val1, val2, c; val1 = exp1 (); if (curtok == POWER) { readtok (); val2 = exp1 (); if (val2 == 0) return (1); if (val2 < 0) evalerror ("exponent less than 0"); for (c = 1; val2--; c *= val1) ; val1 = c; } return (val1); } static intmax_t exp1 () { register intmax_t val; if (curtok == NOT) { readtok (); val = !exp1 (); } else if (curtok == BNOT) { readtok (); val = ~exp1 (); } else val = exp0 (); return (val); } static intmax_t exp0 () { register intmax_t val = 0, v2; char *vincdec; int stok; /* XXX - might need additional logic here to decide whether or not pre-increment or pre-decrement is legal at this point. */ if (curtok == PREINC || curtok == PREDEC) { stok = lasttok = curtok; readtok (); if (curtok != STR) /* readtok() catches this */ evalerror ("identifier expected after pre-increment or pre-decrement"); v2 = tokval + ((stok == PREINC) ? 1 : -1); vincdec = itos (v2); if (noeval == 0) (void)bind_int_variable (tokstr, vincdec); free (vincdec); val = v2; curtok = NUM; /* make sure --x=7 is flagged as an error */ readtok (); } else if (curtok == MINUS) { readtok (); val = - exp0 (); } else if (curtok == PLUS) { readtok (); val = exp0 (); } else if (curtok == LPAR) { readtok (); val = EXP_HIGHEST (); if (curtok != RPAR) evalerror ("missing `)'"); /* Skip over closing paren. */ readtok (); } else if ((curtok == NUM) || (curtok == STR)) { val = tokval; if (curtok == STR && (*tp == '+' || *tp == '-') && tp[1] == *tp && (tp[2] == '\0' || (ISALNUM ((unsigned char)tp[2]) == 0))) { /* post-increment or post-decrement */ v2 = val + ((*tp == '+') ? 1 : -1); vincdec = itos (v2); if (noeval == 0) (void)bind_int_variable (tokstr, vincdec); free (vincdec); tp += 2; curtok = NUM; /* make sure x++=7 is flagged as an error */ } readtok (); } else evalerror ("syntax error: operand expected"); return (val); } static intmax_t expr_streval (tok, e) char *tok; int e; { SHELL_VAR *v; char *value; intmax_t tval; /* [[[[[ */ #if defined (ARRAY_VARS) v = (e == ']') ? array_variable_part (tok, (char **)0, (int *)0) : find_variable (tok); #else v = find_variable (tok); #endif if ((v == 0 || invisible_p (v)) && unbound_vars_is_error) { #if defined (ARRAY_VARS) value = (e == ']') ? array_variable_name (tok, (char **)0, (int *)0) : tok; #else value = tok; #endif err_unboundvar (value); #if defined (ARRAY_VARS) if (e == ']') FREE (value); /* array_variable_name returns new memory */ #endif if (interactive_shell) { expr_unwind (); jump_to_top_level (DISCARD); } else jump_to_top_level (FORCE_EOF); } #if defined (ARRAY_VARS) /* Second argument of 0 to get_array_value means that we don't allow references like array[@]. In this case, get_array_value is just like get_variable_value in that it does not return newly-allocated memory or quote the results. */ value = (e == ']') ? get_array_value (tok, 0, (int *)NULL) : get_variable_value (v); #else value = get_variable_value (v); #endif tval = (value && *value) ? subexpr (value) : 0; return (tval); } /* Lexical analyzer/token reader for the expression evaluator. Reads the next token and puts its value into curtok, while advancing past it. Updates value of tp. May also set tokval (for number) or tokstr (for string). */ static void readtok () { register char *cp; register unsigned char c, c1; register int e; /* Skip leading whitespace. */ cp = tp; c = e = 0; while (cp && (c = *cp) && (cr_whitespace (c))) cp++; if (c) cp++; lasttp = tp = cp - 1; if (c == '\0') { lasttok = curtok; curtok = 0; tp = cp; return; } if (legal_variable_starter (c)) { /* variable names not preceded with a dollar sign are shell variables. */ char *savecp; EXPR_CONTEXT ec; int peektok; while (legal_variable_char (c)) c = *cp++; c = *--cp; #if defined (ARRAY_VARS) if (c == '[') { e = skipsubscript (cp, 0); if (cp[e] == ']') { cp += e + 1; c = *cp; e = ']'; } else evalerror ("bad array subscript"); } #endif /* ARRAY_VARS */ *cp = '\0'; FREE (tokstr); tokstr = savestring (tp); *cp = c; SAVETOK (&ec); tokstr = (char *)NULL; /* keep it from being freed */ tp = savecp = cp; noeval = 1; readtok (); peektok = curtok; if (peektok == STR) /* free new tokstr before old one is restored */ FREE (tokstr); RESTORETOK (&ec); cp = savecp; /* The tests for PREINC and PREDEC aren't strictly correct, but they preserve old behavior if a construct like --x=9 is given. */ if (lasttok == PREINC || lasttok == PREDEC || peektok != EQ) tokval = expr_streval (tokstr, e); else tokval = 0; lasttok = curtok; curtok = STR; } else if (DIGIT(c)) { while (ISALNUM (c) || c == '#' || c == '@' || c == '_') c = *cp++; c = *--cp; *cp = '\0'; tokval = strlong (tp); *cp = c; lasttok = curtok; curtok = NUM; } else { c1 = *cp++; if ((c == EQ) && (c1 == EQ)) c = EQEQ; else if ((c == NOT) && (c1 == EQ)) c = NEQ; else if ((c == GT) && (c1 == EQ)) c = GEQ; else if ((c == LT) && (c1 == EQ)) c = LEQ; else if ((c == LT) && (c1 == LT)) { if (*cp == '=') /* a <<= b */ { assigntok = LSH; c = OP_ASSIGN; cp++; } else c = LSH; } else if ((c == GT) && (c1 == GT)) { if (*cp == '=') { assigntok = RSH; /* a >>= b */ c = OP_ASSIGN; cp++; } else c = RSH; } else if ((c == BAND) && (c1 == BAND)) c = LAND; else if ((c == BOR) && (c1 == BOR)) c = LOR; else if ((c == '*') && (c1 == '*')) c = POWER; else if ((c == '-') && (c1 == '-') && legal_variable_starter ((unsigned char)*cp)) c = PREDEC; else if ((c == '+') && (c1 == '+') && legal_variable_starter ((unsigned char)*cp)) c = PREINC; else if (c1 == EQ && member (c, "*/%+-&^|")) { assigntok = c; /* a OP= b */ c = OP_ASSIGN; } else cp--; /* `unget' the character */ lasttok = curtok; curtok = c; } tp = cp; } static void evalerror (msg) char *msg; { char *name, *t; name = this_command_name; for (t = expression; whitespace (*t); t++) ; internal_error ("%s%s%s: %s (error token is \"%s\")", name ? name : "", name ? ": " : "", t, msg, (lasttp && *lasttp) ? lasttp : ""); longjmp (evalbuf, 1); } /* Convert a string to an intmax_t integer, with an arbitrary base. 0nnn -> base 8 0[Xx]nn -> base 16 Anything else: [base#]number (this is implemented to match ksh93) Base may be >=2 and <=64. If base is <= 36, the numbers are drawn from [0-9][a-zA-Z], and lowercase and uppercase letters may be used interchangably. If base is > 36 and <= 64, the numbers are drawn from [0-9][a-z][A-Z]_@ (a = 10, z = 35, A = 36, Z = 61, _ = 62, @ = 63 -- you get the picture). */ static intmax_t strlong (num) char *num; { register char *s; register unsigned char c; int base, foundbase; intmax_t val; s = num; base = 10; foundbase = 0; if (*s == '0') { s++; if (*s == '\0') return 0; /* Base 16? */ if (*s == 'x' || *s == 'X') { base = 16; s++; } else base = 8; foundbase++; } val = 0; for (c = *s++; c; c = *s++) { if (c == '#') { if (foundbase) evalerror ("bad number"); /* Illegal base specifications raise an evaluation error. */ if (val < 2 || val > 64) evalerror ("illegal arithmetic base"); base = val; val = 0; foundbase++; } else if (ISALNUM(c) || (c == '_') || (c == '@')) { if (DIGIT(c)) c = TODIGIT(c); else if (c >= 'a' && c <= 'z') c -= 'a' - 10; else if (c >= 'A' && c <= 'Z') c -= 'A' - ((base <= 36) ? 10 : 36); else if (c == '@') c = 62; else if (c == '_') c = 63; if (c >= base) evalerror ("value too great for base"); val = (val * base) + c; } else break; } return (val); } #if defined (EXPR_TEST) void * xmalloc (n) int n; { return (malloc (n)); } void * xrealloc (s, n) char *s; int n; { return (realloc (s, n)); } SHELL_VAR *find_variable () { return 0;} SHELL_VAR *bind_variable () { return 0; } char *get_string_value () { return 0; } procenv_t top_level; main (argc, argv) int argc; char **argv; { register int i; intmax_t v; int expok; if (setjmp (top_level)) exit (0); for (i = 1; i < argc; i++) { v = evalexp (argv[i], &expok); if (expok == 0) fprintf (stderr, "%s: expression error\n", argv[i]); else printf ("'%s' -> %ld\n", argv[i], v); } exit (0); } int builtin_error (format, arg1, arg2, arg3, arg4, arg5) char *format; { fprintf (stderr, "expr: "); fprintf (stderr, format, arg1, arg2, arg3, arg4, arg5); fprintf (stderr, "\n"); return 0; } char * itos (n) intmax_t n; { return ("42"); } #endif /* EXPR_TEST */