2 // RMAC - Renamed Macro Assembler for all Atari computers
3 // PROCLN.C - Line Processing
4 // Copyright (C) 199x Landon Dyer, 2011-2021 Reboot and Friends
5 // RMAC derived from MADMAC v1.07 Written by Landon Dyer, 1986
6 // Source utilised with the kind permission of Landon Dyer
13 #include "dsp56k_amode.h"
14 #include "dsp56k_mach.h"
25 #define DEF_KW // Declare keyword values
26 #include "kwtab.h" // Incl generated keyword tables & defs
28 #define DEF_MN // Incl 68k keyword definitions
29 #define DECL_MN // Incl 68k keyword state machine tables
36 #define DEF_MP // Include 6502 keyword definitions
37 #define DECL_MP // Include 6502 keyword state machine tables
40 #define DEF_MO // Include OP keyword definitions
41 #define DECL_MO // Include OP keyword state machine tables
44 #define DEF_DSP // Include DSP56K keywords definitions
45 #define DECL_DSP // Include DSP56K keyword state machine tables
49 IFENT * ifent; // Current ifent
50 static IFENT ifent0; // Root ifent
51 IFENT * f_ifent; // Freelist of ifents
52 int disabled; // Assembly conditionally disabled
53 int just_bss; // 1, ds.b in microprocessor mode
54 uint32_t pcloc; // Value of "PC" at beginning of line
55 SYM * lab_sym; // Label on line (or NULL)
56 char * label_defined; // The name of the last label defined in current line (if any)
58 const char extra_stuff[] = "extra (unexpected) text found after addressing mode";
59 const char comma_error[] = "missing comma";
60 const char syntax_error[] = "syntax error";
61 const char locgl_error[] = "cannot GLOBL local symbol";
62 const char lab_ignored[] = "label ignored";
64 // Table to convert an addressing-mode number to a bitmask.
65 LONG amsktab[0124] = {
66 M_DREG, M_DREG, M_DREG, M_DREG,
67 M_DREG, M_DREG, M_DREG, M_DREG,
69 M_AREG, M_AREG, M_AREG, M_AREG,
70 M_AREG, M_AREG, M_AREG, M_AREG,
72 M_AIND, M_AIND, M_AIND, M_AIND,
73 M_AIND, M_AIND, M_AIND, M_AIND,
75 M_APOSTINC, M_APOSTINC, M_APOSTINC, M_APOSTINC,
76 M_APOSTINC, M_APOSTINC, M_APOSTINC, M_APOSTINC,
78 M_APREDEC, M_APREDEC, M_APREDEC, M_APREDEC,
79 M_APREDEC, M_APREDEC, M_APREDEC, M_APREDEC,
81 M_ADISP, M_ADISP, M_ADISP, M_ADISP,
82 M_ADISP, M_ADISP, M_ADISP, M_ADISP,
84 M_AINDEXED, M_AINDEXED, M_AINDEXED, M_AINDEXED,
85 M_AINDEXED, M_AINDEXED, M_AINDEXED, M_AINDEXED,
118 // Function prototypes
119 int HandleLabel(char *, int);
123 // Initialize line processor
125 void InitLineProcessor(void)
129 f_ifent = ifent0.if_prev = NULL;
139 int state; // Keyword machine state (output)
140 int j; // Random int, must be fast
141 char * p; // Random char ptr, must be fast
142 TOKEN * tk; // First token in line
143 char * label; // Symbol (or NULL)
144 char * equate; // Symbol (or NULL)
145 int labtyp = 0; // Label type (':', DCOLON)
146 int equtyp = 0; // Equ type ('=', DEQUALS)
147 uint64_t eval; // Expression value
148 WORD eattr; // Expression attributes
149 SYM * esym; // External symbol involved in expr.
150 WORD siz = 0; // Size suffix to mnem/diretve/macro
151 LONG amsk0, amsk1; // Address-type masks for ea0, ea1
152 MNTAB * m; // Code generation table pointer
153 SYM * sy, * sy2; // Symbol (temp usage)
154 char * opname = NULL; // Name of dirctve/mnemonic/macro
155 int listflag; // 0: Don't call listeol()
156 WORD rmask; // Register list, for REG
157 int registerbank; // RISC register bank
158 int riscreg; // RISC register
159 listflag = 0; // Initialise listing flag
161 loop: // Line processing loop label
163 // Get another line of tokens
164 if (TokenizeLine() == TKEOF)
166 DEBUG { printf("Assemble: Found TKEOF flag...\n"); }
167 if (list_flag && listflag) // Flush last line of source
170 if (ifent->if_prev != NULL) // Check conditional token
171 error("hit EOF without finding matching .endif");
176 DEBUG { DumpTokenBuffer(); }
180 if (listflag && listing > 0)
181 listeol(); // Tell listing generator about EOL
183 lstout((char)(disabled ? '-' : lntag)); // Prepare new line for listing
184 listflag = 1; // OK to call `listeol' now
185 just_bss = 0; // Reset just_bss mode
188 state = -3; // No keyword (just EOL)
189 label = NULL; // No label
190 label_defined = NULL; // No label defined yet
191 lab_sym = NULL; // No (exported) label
192 equate = NULL; // No equate
193 tk = tok; // Save first token in line
194 pcloc = (uint32_t)sloc; // Set beginning-of-line PC
196 loop1: // Internal line processing loop
198 if (*tok == EOL) // Restart loop if end-of-line
201 // First token MUST be a symbol (Shamus: not sure why :-/)
204 if ((*tok >= KW_D0) && (*tok <= KW_R31))
205 error("cannot use reserved keyword as label name or .equ");
207 error("syntax error; expected symbol");
212 j = (int)tok[2]; // Skip equates (normal statements)
214 if (j == '=' || j == DEQUALS || j == SET || j == REG || j == EQUREG || j == CCDEF)
216 equate = string[tok[1]];
222 // Skip past label (but record it)
223 if (j == ':' || j == DCOLON)
225 label = string[tok[1]]; // Get label name
226 labtyp = tok[2]; // Get label type
227 tok += 3; // Go to next line token
230 // EOL is legal here...
234 // First token MUST be a symbol (if we get here, tok didn't advance)
235 if (*tok++ != SYMBOL)
237 error("syntax error; expected symbol");
241 opname = p = string[*tok++];
243 // Check to see if the SYMBOL is a keyword (a mnemonic or directive).
244 // On output, `state' will have one of the values:
245 // -3 there was no symbol (EOL)
246 // -2..-1 the symbol didn't match any keyword
247 // 0..499 vanilla directives (dc, ds, etc.)
248 // 500..999 electric directives (macro, rept, etc.)
249 // 1000..+ mnemonics (move, lsr, etc.)
250 for(state=0; state>=0;)
252 j = mnbase[state] + (int)tolowertab[*p];
254 // Reject, character doesn't match
255 if (mncheck[j] != state)
257 state = -1; // No match
261 // Must accept or reject at EOS
264 state = mnaccept[j]; // (-1 on no terminal match)
271 // Check for ".b" ".w" ".l" after directive, macro or mnemonic.
276 case DOTW: siz = SIZW, tok++; break;
277 case DOTL: siz = SIZL, tok++; break;
278 case DOTB: siz = SIZB, tok++; break;
279 case DOTD: siz = SIZD, tok++; break;
280 case DOTP: siz = SIZP, tok++; break;
281 case DOTQ: siz = SIZQ, tok++; break;
282 case DOTS: siz = SIZS, tok++; break;
283 case DOTX: siz = SIZX, tok++; break;
286 // Do special directives (500..999) (These must be handled in "real time")
287 if (state >= 500 && state < 1000)
303 case MN_IIF: // .iif --- immediate if
304 if (disabled || expr(exprbuf, &eval, &eattr, &esym) != OK)
307 if (!(eattr & DEFINED))
324 case MN_MACRO: // .macro --- macro definition
327 // Label on a macro definition is bad mojo... Warn the user
336 case MN_EXITM: // .exitm --- exit macro
337 case MN_ENDM: // .endm --- same as .exitm
351 // Handle labels on REPT directive lines...
354 if (HandleLabel(label, labtyp) != 0)
357 label_defined = label;
367 error("mis-nested .endr");
374 if (disabled) // Conditionally disabled code
380 // Pick global or local symbol enviroment
381 j = (*equate == '.' ? curenv : 0);
382 sy = lookup(equate, LABEL, j);
386 sy = NewSymbol(equate, LABEL, j);
389 if (equtyp == DEQUALS)
391 // Can't GLOBAL a local symbol
401 else if ((sy->sattr & DEFINED) && equtyp != SET)
403 if ((equtyp == EQUREG) && (sy->sattre & UNDEF_EQUR))
405 sy->sattre &= ~UNDEF_EQUR;
408 else if ((equtyp == CCDEF) && (sy->sattre & UNDEF_CC))
410 sy->sattre &= ~UNDEF_CC;
415 error("multiple equate to '%s'", sy->sname);
420 // Put symbol in "order of definition" list if it's not already there
421 AddToSymbolDeclarationList(sy);
423 // Parse value to equate symbol to;
427 if (equtyp == EQUREG)
429 //Linko's request to issue a warning on labels that equated to the same
430 //register would go here. Not sure how to implement it though. :-/
433 have an array of bools with 64 entries. Whenever a register is equated, set the
434 corresponding register bool to true. Whenever it's undef'ed, set it to false.
435 When checking to see if it's already been equated, issue a warning.
437 // Check that we are in a RISC section
440 error(".equr/.regequ must be defined in .gpu/.dsp section");
444 // Check for register to equate to
445 if ((*tok >= KW_R0) && (*tok <= KW_R31))
447 // sy->sattre = EQUATEDREG | RISCSYM; // Mark as equated register
448 sy->sattre = EQUATEDREG; // Mark as equated register
449 riscreg = (*tok - KW_R0);
450 //is there any reason to do this, since we're putting this in svalue?
451 //i'm thinking, no. Let's test that out! :-D
452 // sy->sattre |= (riscreg << 8); // Store register number
453 //everything seems to build fine without it... We'll leave it here Just In Case(tm)
455 #define DEBODGE_REGBANK
456 #ifdef DEBODGE_REGBANK
457 // Default is current state of "regbank"
458 registerbank = regbank;
460 // Default is no register bank specified
461 registerbank = BANK_N;
464 // Check for ",<bank #>" override notation
465 if ((tok[1] == ',') && (tok[2] == CONST))
467 // Advance token pointer to the constant
470 // Anything other than a 0 or a 1 will result in "No Bank"
471 if (*(uint64_t *)tok == 0)
472 registerbank = BANK_0;
473 else if (*(uint64_t *)tok == 1)
474 registerbank = BANK_1;
476 // Advance half-way through the 64-bit const.
477 // The code below, expecting a regular token,
478 // will advance past the second half.
482 #ifdef DEBODGE_REGBANK
483 sy->sattre |= registerbank; // Store register bank
485 // What needs to happen here is to prime registerbank with regbank, then use
486 // registerbank down below for the bank marking.
487 #warning "!!! regbank <-> registerbank confusion here !!!"
488 // The question here is why, if we're allowed to override the ".regbankN" rules
489 // above, then why is it using the one set by the directive in the extended
490 // attributes and not in what ends up in symbol->svalue?
491 // ".regbankN" is not an original Madmac directive, so it's suspect
492 sy->sattre |= regbank; // Store register bank
494 eattr = ABS | DEFINED | GLOBAL;
498 // Checking for a register symbol
499 else if (tok[0] == SYMBOL)
501 sy2 = lookup(string[tok[1]], LABEL, j);
503 // Make sure symbol is a valid equreg
504 if (!sy2 || !(sy2->sattre & EQUATEDREG))
506 error("invalid GPU/DSP .equr/.regequ definition");
511 eattr = ABS | DEFINED | GLOBAL; // Copy symbols attributes
512 sy->sattre = sy2->sattre;
513 eval = (sy2->svalue & 0xFFFFF0FF);
519 error("invalid GPU/DSP .equr/.regequ definition");
523 else if (equtyp == REG)
525 if (reglist(&rmask) < 0)
528 eval = (uint32_t)rmask;
529 eattr = ABS | DEFINED;
531 else if (equtyp == CCDEF)
533 sy->sattre |= EQUATEDCC;
534 eattr = ABS | DEFINED | GLOBAL;
536 if (tok[0] == SYMBOL)
538 sy2 = lookup(string[tok[1]], LABEL, j);
540 if (!sy2 || !(sy2->sattre & EQUATEDCC))
542 error("invalid gpu/dsp .ccdef definition");
547 eattr = ABS | DEFINED | GLOBAL;
548 sy->sattre = sy2->sattre;
553 else if (expr(exprbuf, &eval, &eattr, &esym) != OK)
557 else if (*tok == SYMBOL)
559 sy2 = lookup(string[tok[1]], LABEL, j);
561 if (sy2 && (sy2->sattre & EQUATEDREG))
563 sy->stype = sy2->stype;
564 sy->sattr = sy2->sattr;
565 sy->sattre = sy2->sattre;
566 sy->svalue = sy2->svalue;
569 else if (expr(exprbuf, &eval, &eattr, &esym) != OK)
572 else if (expr(exprbuf, &eval, &eattr, &esym) != OK)
575 if (!(eattr & DEFINED))
581 sy->sattr |= eattr | EQUATED; // Symbol inherits value and attributes
584 if (list_flag) // Put value in listing
585 listvalue((uint32_t)eval);
587 ErrorIfNotAtEOL(); // Must be at EOL now
594 // Non-zero == error occurred
595 if (HandleLabel(label, labtyp) != 0)
598 label_defined = label;
605 // If we're in 6502 mode and are still in need of a mnemonic, then search
606 // for valid 6502 mnemonic.
607 if (m6502 && (state < 0 || state >= 1000))
610 state = kmatch(opname, mpbase, mpcheck, mptab, mpaccept);
612 for(state=0, p=opname; state>= 0; )
614 j = mpbase[state] + tolowertab[*p];
616 if (mpcheck[j] != state) // Reject, character doesn't match
618 state = -1; // No match
623 { // Must accept or reject at EOS
624 state = mpaccept[j]; // (-1 on no terminal match)
632 // Call 6502 code generator if we found a mnemonic
635 m6502cg(state - 2000);
640 // If we are in GPU or DSP mode and still in need of a mnemonic then search
642 if ((rgpu || rdsp) && (state < 0 || state >= 1000))
644 for(state=0, p=opname; state>=0;)
646 j = mrbase[state] + (int)tolowertab[*p];
648 // Reject, character doesn't match
649 if (mrcheck[j] != state)
651 state = -1; // No match
655 // Must accept or reject at EOS
658 state = mraccept[j]; // (-1 on no terminal match)
665 // Call RISC code generator if we found a mnemonic
668 GenerateRISCCode(state);
673 // If we are in OP mode and still in need of a mnemonic then search for one
674 if (robjproc && ((state < 0) || (state >= 1000)))
676 for(state=0, p=opname; state>=0;)
678 j = mobase[state] + (int)tolowertab[*p];
680 // Reject, character doesn't match
681 if (mocheck[j] != state)
683 state = -1; // No match
687 // Must accept or reject at EOS
690 state = moaccept[j]; // (-1 on no terminal match)
697 // Call OP code generator if we found a mnemonic
700 GenerateOPCode(state);
705 // If we are in 56K mode and still in need of a mnemonic then search for one
706 if (dsp56001 && ((state < 0) || (state >= 1000)))
708 for(state=0, p=opname; state>=0;)
710 j = dspbase[state] + (int)tolowertab[*p];
712 // Reject, character doesn't match
713 if (dspcheck[j] != state)
715 state = -1; // No match
719 // Must accept or reject at EOS
722 state = dspaccept[j]; // (-1 on no terminal match)
729 // Call DSP code generator if we found a mnemonic
734 MNTABDSP * md = &dsp56k_machtab[state - 2000];
735 deposit_extra_ea = 0; // Assume no extra word needed
737 if (md->mnfunc == dsp_mult)
739 // Special case for multiplication instructions: they require
741 if ((operands = dsp_amode(3)) == ERROR)
744 else if ((md->mnattr & PARMOVE) && md->mn0 != M_AM_NONE)
746 if (dsp_amode(2) == ERROR)
749 else if ((md->mnattr & PARMOVE) && md->mn0 == M_AM_NONE)
751 // Instructions that have parallel moves but use no operands
752 // (probably only move). In this case, don't parse addressing
753 // modes--just go straight to parallel parse
754 dsp_am0 = dsp_am1 = M_AM_NONE;
758 // Non parallel move instructions can have up to 4 parameters
759 // (well, only tcc instructions really)
760 if ((operands = dsp_amode(4)) == ERROR)
765 dsp_tcc4(md->mninst);
770 if (md->mnattr & PARMOVE)
772 // Check for parallel moves
773 if ((parcode = parmoves(dsp_a1reg)) == ERROR)
779 error("parallel moves not allowed with this instruction");
784 while ((dsp_am0 & md->mn0) == 0 || (dsp_am1 & md->mn1) == 0)
785 md = &dsp56k_machtab[md->mncont];
787 (*md->mnfunc)(md->mninst | (parcode << 8));
792 // Invoke macro or complain about bad mnemonic
795 if ((sy = lookup(opname, MACRO, 0)) != NULL)
796 InvokeMacro(sy, siz);
798 error("unknown op '%s'", opname);
803 // Call directive handlers
806 (*dirtab[state])(siz);
811 // o can't deposit instrs in BSS or ABS
812 // o do automatic .EVEN for instrs
813 // o allocate space for largest possible instr
814 // o can't do ".b" operations with an address register
817 error("cannot initialize non-storage (BSS) section");
821 if (sloc & 1) // Automatic .even
824 if (challoc - ch_size < 18) // Make sure have space in current chunk
827 m = &machtab[state - 1000];
829 // Call special-mode handler
830 if (m->mnattr & CGSPECIAL)
832 (*m->mnfunc)(m->mninst, siz);
836 if (amode(1) < 0) // Parse 0, 1 or 2 addr modes
839 // Check that we're at EOL
840 // The only exception is ptestr/ptestw instructions
841 // that have 3 or 4 operands and are not handled by
842 // amode(). (yes, we're taking a performance hit here sadly)
843 if (m->mnfunc != m_ptestr && m->mnfunc != m_ptestw)
847 amsk0 = amsktab[am0];
848 amsk1 = amsktab[am1];
850 // Catch attempts to use ".B" with an address register (yes, this check
851 // does work at this level)
852 if (siz == SIZB && (am0 == AREG || am1 == AREG))
854 error("cannot use '.b' with an address register");
858 // Keep a backup of chptr (used for optimisations during codegen)
859 chptr_opcode = chptr;
861 while (!(m->mnattr & siz) || (amsk0 & m->mn0) == 0 || (amsk1 & m->mn1) == 0)
862 m = &machtab[m->mncont];
864 DEBUG { printf(" 68K: mninst=$%X, siz=$%X, mnattr=$%X, amsk0=$%X, mn0=$%X, amsk1=$%X, mn1=$%X\n", m->mninst, siz, m->mnattr, amsk0, m->mn0, amsk1, m->mn1); }
866 (*m->mnfunc)(m->mninst, siz);
872 // Handle the creation of labels
874 int HandleLabel(char * label, int labelType)
876 // Check for dot in front of label; means this is a local label if present
877 int environment = (*label == '.' ? curenv : 0);
878 SYM * symbol = lookup(label, LABEL, environment);
882 symbol = NewSymbol(label, LABEL, environment);
886 else if (symbol->sattr & DEFINED)
887 return error("multiply-defined label '%s'", label);
889 // Put symbol in "order of definition" list if it's not already in it
890 AddToSymbolDeclarationList(symbol);
894 symbol->svalue = orgaddr;
895 symbol->sattr |= ABS | DEFINED | EQUATED;
899 symbol->svalue = sloc;
900 symbol->sattr |= DEFINED | cursect;
905 // Yes, our CS professors told us to write checks for equality this way,
906 // but damn, it hurts my brain every time I look at it. :-/
907 if (0 == environment)
910 // Make label global if it has a double colon
911 if (labelType == DCOLON)
913 if (environment != 0)
914 return error(locgl_error);
916 symbol->sattr |= GLOBAL;