1 /* eval.c expression evaluator for the Netwide Assembler
3 * The Netwide Assembler is copyright (C) 1996 Simon Tatham and
4 * Julian Hall. All rights reserved. The software is
5 * redistributable under the licence given in the file "Licence"
6 * distributed in the NASM archive.
8 * initial version 27/iii/95 by Simon Tatham
22 #define TEMPEXPRS_DELTA 128
23 #define TEMPEXPR_DELTA 8
25 static scanner scan
; /* Address of scanner routine */
26 static efunc error
; /* Address of error reporting routine */
27 static lfunc labelfunc
; /* Address of label routine */
29 static struct ofmt
*outfmt
; /* Structure of addresses of output routines */
31 static expr
**tempexprs
= NULL
;
32 static int ntempexprs
;
33 static int tempexprs_size
= 0;
35 static expr
*tempexpr
;
37 static int tempexpr_size
;
39 static struct tokenval
*tokval
; /* The current token */
40 static int i
; /* The t_type of tokval */
43 static loc_t
*location
; /* Pointer to current line's segment,offset */
46 static struct eval_hints
*hint
;
49 * Unimportant cleanup is done to avoid confusing people who are trying
50 * to debug real memory leaks
52 void eval_cleanup(void)
55 nasm_free (tempexprs
[--ntempexprs
]);
56 nasm_free (tempexprs
);
60 * Construct a temporary expression.
62 static void begintemp(void)
65 tempexpr_size
= ntempexpr
= 0;
68 static void addtotemp(long type
, long value
)
70 while (ntempexpr
>= tempexpr_size
) {
71 tempexpr_size
+= TEMPEXPR_DELTA
;
72 tempexpr
= nasm_realloc(tempexpr
,
73 tempexpr_size
*sizeof(*tempexpr
));
75 tempexpr
[ntempexpr
].type
= type
;
76 tempexpr
[ntempexpr
++].value
= value
;
79 static expr
*finishtemp(void)
81 addtotemp (0L, 0L); /* terminate */
82 while (ntempexprs
>= tempexprs_size
) {
83 tempexprs_size
+= TEMPEXPRS_DELTA
;
84 tempexprs
= nasm_realloc(tempexprs
,
85 tempexprs_size
*sizeof(*tempexprs
));
87 return tempexprs
[ntempexprs
++] = tempexpr
;
91 * Add two vector datatypes. We have some bizarre behaviour on far-
92 * absolute segment types: we preserve them during addition _only_
93 * if one of the segments is a truly pure scalar.
95 static expr
*add_vectors(expr
*p
, expr
*q
)
99 preserve
= is_really_simple(p
) || is_really_simple(q
);
103 while (p
->type
&& q
->type
&&
104 p
->type
< EXPR_SEGBASE
+SEG_ABS
&&
105 q
->type
< EXPR_SEGBASE
+SEG_ABS
)
109 if (p
->type
> q
->type
) {
110 addtotemp(q
->type
, q
->value
);
111 lasttype
= q
++->type
;
112 } else if (p
->type
< q
->type
) {
113 addtotemp(p
->type
, p
->value
);
114 lasttype
= p
++->type
;
115 } else { /* *p and *q have same type */
116 long sum
= p
->value
+ q
->value
;
118 addtotemp(p
->type
, sum
);
122 if (lasttype
== EXPR_UNKNOWN
) {
127 (preserve
|| p
->type
< EXPR_SEGBASE
+SEG_ABS
))
129 addtotemp(p
->type
, p
->value
);
133 (preserve
|| q
->type
< EXPR_SEGBASE
+SEG_ABS
))
135 addtotemp(q
->type
, q
->value
);
143 * Multiply a vector by a scalar. Strip far-absolute segment part
146 * Explicit treatment of UNKNOWN is not required in this routine,
147 * since it will silently do the Right Thing anyway.
149 * If `affect_hints' is set, we also change the hint type to
150 * NOTBASE if a MAKEBASE hint points at a register being
151 * multiplied. This allows [eax*1+ebx] to hint EBX rather than EAX
152 * as the base register.
154 static expr
*scalar_mult(expr
*vect
, long scalar
, int affect_hints
)
158 while (p
->type
&& p
->type
< EXPR_SEGBASE
+SEG_ABS
) {
159 p
->value
= scalar
* (p
->value
);
160 if (hint
&& hint
->type
== EAH_MAKEBASE
&&
161 p
->type
== hint
->base
&& affect_hints
)
162 hint
->type
= EAH_NOTBASE
;
170 static expr
*scalarvect (long scalar
)
173 addtotemp(EXPR_SIMPLE
, scalar
);
177 static expr
*unknown_expr (void)
180 addtotemp(EXPR_UNKNOWN
, 1L);
185 * The SEG operator: calculate the segment part of a relocatable
186 * value. Return NULL, as usual, if an error occurs. Report the
189 static expr
*segment_part (expr
*e
)
194 return unknown_expr();
197 error(ERR_NONFATAL
, "cannot apply SEG to a non-relocatable value");
203 error(ERR_NONFATAL
, "cannot apply SEG to a non-relocatable value");
205 } else if (seg
& SEG_ABS
) {
206 return scalarvect(seg
& ~SEG_ABS
);
207 } else if (seg
& 1) {
208 error(ERR_NONFATAL
, "SEG applied to something which"
209 " is already a segment base");
213 long base
= outfmt
->segbase(seg
+1);
216 addtotemp((base
== NO_SEG
? EXPR_UNKNOWN
: EXPR_SEGBASE
+base
), 1L);
222 * Recursive-descent parser. Called with a single boolean operand,
223 * which is TRUE if the evaluation is critical (i.e. unresolved
224 * symbols are an error condition). Must update the global `i' to
225 * reflect the token after the parsed string. May return NULL.
227 * evaluate() should report its own errors: on return it is assumed
228 * that if NULL has been returned, the error has already been
235 * expr : bexpr [ WRT expr6 ]
236 * bexpr : rexp0 or expr0 depending on relative-mode setting
237 * rexp0 : rexp1 [ {||} rexp1...]
238 * rexp1 : rexp2 [ {^^} rexp2...]
239 * rexp2 : rexp3 [ {&&} rexp3...]
240 * rexp3 : expr0 [ {=,==,<>,!=,<,>,<=,>=} expr0 ]
241 * expr0 : expr1 [ {|} expr1...]
242 * expr1 : expr2 [ {^} expr2...]
243 * expr2 : expr3 [ {&} expr3...]
244 * expr3 : expr4 [ {<<,>>} expr4...]
245 * expr4 : expr5 [ {+,-} expr5...]
246 * expr5 : expr6 [ {*,/,%,//,%%} expr6...]
247 * expr6 : { ~,+,-,SEG } expr6
254 static expr
*rexp0(int), *rexp1(int), *rexp2(int), *rexp3(int);
256 static expr
*expr0(int), *expr1(int), *expr2(int), *expr3(int);
257 static expr
*expr4(int), *expr5(int), *expr6(int);
259 static expr
*(*bexpr
)(int);
261 static expr
*rexp0(int critical
)
269 while (i
== TOKEN_DBL_OR
)
271 i
= scan(scpriv
, tokval
);
275 if (!(is_simple(e
) || is_just_unknown(e
)) ||
276 !(is_simple(f
) || is_just_unknown(f
)))
278 error(ERR_NONFATAL
, "`|' operator may only be applied to"
282 if (is_just_unknown(e
) || is_just_unknown(f
))
285 e
= scalarvect ((long) (reloc_value(e
) || reloc_value(f
)));
290 static expr
*rexp1(int critical
)
298 while (i
== TOKEN_DBL_XOR
)
300 i
= scan(scpriv
, tokval
);
304 if (!(is_simple(e
) || is_just_unknown(e
)) ||
305 !(is_simple(f
) || is_just_unknown(f
)))
307 error(ERR_NONFATAL
, "`^' operator may only be applied to"
311 if (is_just_unknown(e
) || is_just_unknown(f
))
314 e
= scalarvect ((long) (!reloc_value(e
) ^ !reloc_value(f
)));
319 static expr
*rexp2(int critical
)
326 while (i
== TOKEN_DBL_AND
)
328 i
= scan(scpriv
, tokval
);
332 if (!(is_simple(e
) || is_just_unknown(e
)) ||
333 !(is_simple(f
) || is_just_unknown(f
)))
335 error(ERR_NONFATAL
, "`&' operator may only be applied to"
338 if (is_just_unknown(e
) || is_just_unknown(f
))
341 e
= scalarvect ((long) (reloc_value(e
) && reloc_value(f
)));
346 static expr
*rexp3(int critical
)
355 while (i
== TOKEN_EQ
|| i
== TOKEN_LT
|| i
== TOKEN_GT
||
356 i
== TOKEN_NE
|| i
== TOKEN_LE
|| i
== TOKEN_GE
)
359 i
= scan(scpriv
, tokval
);
364 e
= add_vectors (e
, scalar_mult(f
, -1L, FALSE
));
368 case TOKEN_EQ
: case TOKEN_NE
:
370 v
= -1; /* means unknown */
371 else if (!is_really_simple(e
) || reloc_value(e
) != 0)
372 v
= (j
== TOKEN_NE
); /* unequal, so return TRUE if NE */
374 v
= (j
== TOKEN_EQ
); /* equal, so return TRUE if EQ */
378 v
= -1; /* means unknown */
379 else if (!is_really_simple(e
)) {
380 error(ERR_NONFATAL
, "`%s': operands differ by a non-scalar",
381 (j
== TOKEN_LE
? "<=" : j
== TOKEN_LT
? "<" :
382 j
== TOKEN_GE
? ">=" : ">"));
383 v
= 0; /* must set it to _something_ */
385 int vv
= reloc_value(e
);
387 v
= (j
== TOKEN_LE
|| j
== TOKEN_GE
);
389 v
= (j
== TOKEN_GE
|| j
== TOKEN_GT
);
391 v
= (j
== TOKEN_LE
|| j
== TOKEN_LT
);
404 static expr
*expr0(int critical
)
414 i
= scan(scpriv
, tokval
);
418 if (!(is_simple(e
) || is_just_unknown(e
)) ||
419 !(is_simple(f
) || is_just_unknown(f
)))
421 error(ERR_NONFATAL
, "`|' operator may only be applied to"
424 if (is_just_unknown(e
) || is_just_unknown(f
))
427 e
= scalarvect (reloc_value(e
) | reloc_value(f
));
432 static expr
*expr1(int critical
)
441 i
= scan(scpriv
, tokval
);
445 if (!(is_simple(e
) || is_just_unknown(e
)) ||
446 !(is_simple(f
) || is_just_unknown(f
)))
448 error(ERR_NONFATAL
, "`^' operator may only be applied to"
451 if (is_just_unknown(e
) || is_just_unknown(f
))
454 e
= scalarvect (reloc_value(e
) ^ reloc_value(f
));
459 static expr
*expr2(int critical
)
468 i
= scan(scpriv
, tokval
);
472 if (!(is_simple(e
) || is_just_unknown(e
)) ||
473 !(is_simple(f
) || is_just_unknown(f
)))
475 error(ERR_NONFATAL
, "`&' operator may only be applied to"
478 if (is_just_unknown(e
) || is_just_unknown(f
))
481 e
= scalarvect (reloc_value(e
) & reloc_value(f
));
486 static expr
*expr3(int critical
)
494 while (i
== TOKEN_SHL
|| i
== TOKEN_SHR
)
497 i
= scan(scpriv
, tokval
);
501 if (!(is_simple(e
) || is_just_unknown(e
)) ||
502 !(is_simple(f
) || is_just_unknown(f
)))
504 error(ERR_NONFATAL
, "shift operator may only be applied to"
506 } else if (is_just_unknown(e
) || is_just_unknown(f
)) {
510 e
= scalarvect (reloc_value(e
) << reloc_value(f
));
513 e
= scalarvect (((unsigned long)reloc_value(e
)) >>
521 static expr
*expr4(int critical
)
528 while (i
== '+' || i
== '-')
531 i
= scan(scpriv
, tokval
);
537 e
= add_vectors (e
, f
);
540 e
= add_vectors (e
, scalar_mult(f
, -1L, FALSE
));
547 static expr
*expr5(int critical
)
554 while (i
== '*' || i
== '/' || i
== '%' ||
555 i
== TOKEN_SDIV
|| i
== TOKEN_SMOD
)
558 i
= scan(scpriv
, tokval
);
562 if (j
!= '*' && (!(is_simple(e
) || is_just_unknown(e
)) ||
563 !(is_simple(f
) || is_just_unknown(f
))))
565 error(ERR_NONFATAL
, "division operator may only be applied to"
569 if (j
!= '*' && !is_unknown(f
) && reloc_value(f
) == 0) {
570 error(ERR_NONFATAL
, "division by zero");
576 e
= scalar_mult (f
, reloc_value(e
), TRUE
);
577 else if (is_simple(f
))
578 e
= scalar_mult (e
, reloc_value(f
), TRUE
);
579 else if (is_just_unknown(e
) && is_just_unknown(f
))
582 error(ERR_NONFATAL
, "unable to multiply two "
583 "non-scalar objects");
588 if (is_just_unknown(e
) || is_just_unknown(f
))
591 e
= scalarvect (((unsigned long)reloc_value(e
)) /
592 ((unsigned long)reloc_value(f
)));
595 if (is_just_unknown(e
) || is_just_unknown(f
))
598 e
= scalarvect (((unsigned long)reloc_value(e
)) %
599 ((unsigned long)reloc_value(f
)));
602 if (is_just_unknown(e
) || is_just_unknown(f
))
605 e
= scalarvect (((signed long)reloc_value(e
)) /
606 ((signed long)reloc_value(f
)));
609 if (is_just_unknown(e
) || is_just_unknown(f
))
612 e
= scalarvect (((signed long)reloc_value(e
)) %
613 ((signed long)reloc_value(f
)));
620 static expr
*expr6(int critical
)
624 long label_seg
, label_ofs
;
627 i
= scan(scpriv
, tokval
);
631 return scalar_mult (e
, -1L, FALSE
);
632 } else if (i
== '+') {
633 i
= scan(scpriv
, tokval
);
634 return expr6(critical
);
635 } else if (i
== '~') {
636 i
= scan(scpriv
, tokval
);
640 if (is_just_unknown(e
))
641 return unknown_expr();
642 else if (!is_simple(e
)) {
643 error(ERR_NONFATAL
, "`~' operator may only be applied to"
647 return scalarvect(~reloc_value(e
));
648 } else if (i
== TOKEN_SEG
) {
649 i
= scan(scpriv
, tokval
);
654 if (is_unknown(e
) && critical
) {
655 error(ERR_NONFATAL
, "unable to determine segment base");
659 } else if (i
== '(') {
660 i
= scan(scpriv
, tokval
);
665 error(ERR_NONFATAL
, "expecting `)'");
668 i
= scan(scpriv
, tokval
);
671 else if (i
== TOKEN_NUM
|| i
== TOKEN_REG
|| i
== TOKEN_ID
||
672 i
== TOKEN_HERE
|| i
== TOKEN_BASE
)
677 addtotemp(EXPR_SIMPLE
, tokval
->t_integer
);
680 addtotemp(tokval
->t_integer
, 1L);
681 if (hint
&& hint
->type
== EAH_NOHINT
)
682 hint
->base
= tokval
->t_integer
, hint
->type
= EAH_MAKEBASE
;
688 * If !location->known, this indicates that no
689 * symbol, Here or Base references are valid because we
690 * are in preprocess-only mode.
692 if (!location
->known
) {
694 "%s not supported in preprocess-only mode",
695 (i
== TOKEN_ID
? "symbol references" :
696 i
== TOKEN_HERE
? "`$'" : "`$$'"));
697 addtotemp(EXPR_UNKNOWN
, 1L);
702 * Since the whole line is parsed before the label it
703 * defines is given to the label manager, we have
704 * problems with lines such as
706 * end: TIMES 512-(end-start) DB 0
708 * where `end' is not known on pass one, despite not
709 * really being a forward reference, and due to
710 * criticality it is _needed_. Hence we check our label
711 * against the currently defined one, and do our own
712 * resolution of it if we have to.
714 type
= EXPR_SIMPLE
; /* might get overridden by UNKNOWN */
715 if (i
== TOKEN_BASE
) {
716 label_seg
= location
->segment
;
718 } else if (i
== TOKEN_HERE
) {
719 label_seg
= location
->segment
;
720 label_ofs
= location
->offset
;
721 } else if (!labelfunc(tokval
->t_charptr
,&label_seg
,&label_ofs
)) {
723 error (ERR_NONFATAL
, "symbol `%s' undefined",
726 } else if (critical
== 1) {
727 error (ERR_NONFATAL
, "symbol `%s' not defined before use",
738 addtotemp(type
, label_ofs
);
739 if (label_seg
!=NO_SEG
) {
740 addtotemp(EXPR_SEGBASE
+ label_seg
, 1L);
741 if (opflags
&& is_extern (tokval
->t_charptr
))
742 *opflags
|= OPFLAG_EXTERN
;
746 i
= scan(scpriv
, tokval
);
749 error(ERR_NONFATAL
, "expression syntax error");
754 void eval_global_info (struct ofmt
*output
, lfunc lookup_label
, loc_t
*locp
)
757 labelfunc
= lookup_label
;
761 expr
*evaluate (scanner sc
, void *scprivate
, struct tokenval
*tv
,
762 int *fwref
, int critical
, efunc report_error
,
763 struct eval_hints
*hints
)
770 hint
->type
= EAH_NOHINT
;
772 if (critical
& 0x10) {
781 error
= report_error
;
784 if (tokval
->t_type
== TOKEN_INVALID
)
785 i
= scan(scpriv
, tokval
);
789 while (ntempexprs
) /* initialise temporary storage */
790 nasm_free (tempexprs
[--ntempexprs
]);
792 e
= bexpr (critical
);
796 if (i
== TOKEN_WRT
) {
797 i
= scan(scpriv
, tokval
); /* eat the WRT */
798 f
= expr6 (critical
);
802 e
= scalar_mult (e
, 1L, FALSE
); /* strip far-absolute segment part */
805 if (is_just_unknown(f
))
811 error(ERR_NONFATAL
, "invalid right-hand operand to WRT");
814 value
= reloc_seg(f
);
816 value
= reloc_value(f
) | SEG_ABS
;
817 else if (!(value
& SEG_ABS
) && !(value
% 2) && critical
)
819 error(ERR_NONFATAL
, "invalid right-hand operand to WRT");
822 addtotemp(EXPR_WRT
, value
);
825 e
= add_vectors (e
, g
);