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)
226 label = string[tok[1]]; // Get label name
227 labtyp = tok[2]; // Get label type
228 tok += 3; // Go to next line token
231 // Looks like another label follows the previous one, so handle
232 // the previous one until there aren't any more
233 if (as68_flag && (*tok == SYMBOL && tok[2] == ':'))
235 if (HandleLabel(label, labtyp) != 0)
238 label_defined = label;
244 // EOL is legal here...
248 // First token MUST be a symbol (if we get here, tok didn't advance)
249 if (*tok++ != SYMBOL)
251 error("syntax error; expected symbol");
255 opname = p = string[*tok++];
257 // Check to see if the SYMBOL is a keyword (a mnemonic or directive).
258 // On output, `state' will have one of the values:
259 // -3 there was no symbol (EOL)
260 // -2..-1 the symbol didn't match any keyword
261 // 0..499 vanilla directives (dc, ds, etc.)
262 // 500..999 electric directives (macro, rept, etc.)
263 // 1000..+ mnemonics (move, lsr, etc.)
264 for(state=0; state>=0;)
266 j = mnbase[state] + (int)tolowertab[*p];
268 // Reject, character doesn't match
269 if (mncheck[j] != state)
271 state = -1; // No match
275 // Must accept or reject at EOS
278 state = mnaccept[j]; // (-1 on no terminal match)
285 // Check for ".b" ".w" ".l" after directive, macro or mnemonic.
290 case DOTW: siz = SIZW, tok++; break;
291 case DOTL: siz = SIZL, tok++; break;
292 case DOTB: siz = SIZB, tok++; break;
293 case DOTD: siz = SIZD, tok++; break;
294 case DOTP: siz = SIZP, tok++; break;
295 case DOTQ: siz = SIZQ, tok++; break;
296 case DOTS: siz = SIZS, tok++; break;
297 case DOTX: siz = SIZX, tok++; break;
300 // Do special directives (500..999) (These must be handled in "real time")
301 if (state >= 500 && state < 1000)
317 case MN_IIF: // .iif --- immediate if
318 if (disabled || expr(exprbuf, &eval, &eattr, &esym) != OK)
321 if (!(eattr & DEFINED))
338 case MN_MACRO: // .macro --- macro definition
341 // Label on a macro definition is bad mojo... Warn the user
350 case MN_EXITM: // .exitm --- exit macro
351 case MN_ENDM: // .endm --- same as .exitm
365 // Handle labels on REPT directive lines...
368 if (HandleLabel(label, labtyp) != 0)
371 label_defined = label;
381 error("mis-nested .endr");
388 if (disabled) // Conditionally disabled code
394 // Pick global or local symbol enviroment
395 j = (*equate == '.' ? curenv : 0);
396 sy = lookup(equate, LABEL, j);
400 sy = NewSymbol(equate, LABEL, j);
403 if (equtyp == DEQUALS)
405 // Can't GLOBAL a local symbol
415 else if ((sy->sattr & DEFINED) && equtyp != SET)
417 if ((equtyp == EQUREG) && (sy->sattre & UNDEF_EQUR))
419 sy->sattre &= ~UNDEF_EQUR;
422 else if ((equtyp == CCDEF) && (sy->sattre & UNDEF_CC))
424 sy->sattre &= ~UNDEF_CC;
429 error("multiple equate to '%s'", sy->sname);
434 // Put symbol in "order of definition" list if it's not already there
435 AddToSymbolDeclarationList(sy);
437 // Parse value to equate symbol to;
441 if (equtyp == EQUREG)
443 //Linko's request to issue a warning on labels that equated to the same
444 //register would go here. Not sure how to implement it though. :-/
447 have an array of bools with 64 entries. Whenever a register is equated, set the
448 corresponding register bool to true. Whenever it's undef'ed, set it to false.
449 When checking to see if it's already been equated, issue a warning.
451 // Check that we are in a RISC section
454 error(".equr/.regequ must be defined in .gpu/.dsp section");
458 // Check for register to equate to
459 if ((*tok >= KW_R0) && (*tok <= KW_R31))
461 // sy->sattre = EQUATEDREG | RISCSYM; // Mark as equated register
462 sy->sattre = EQUATEDREG; // Mark as equated register
463 riscreg = (*tok - KW_R0);
464 //is there any reason to do this, since we're putting this in svalue?
465 //i'm thinking, no. Let's test that out! :-D
466 // sy->sattre |= (riscreg << 8); // Store register number
467 //everything seems to build fine without it... We'll leave it here Just In Case(tm)
469 #define DEBODGE_REGBANK
470 #ifdef DEBODGE_REGBANK
471 // Default is current state of "regbank"
472 registerbank = regbank;
474 // Default is no register bank specified
475 registerbank = BANK_N;
478 // Check for ",<bank #>" override notation
479 if ((tok[1] == ',') && (tok[2] == CONST))
481 // Advance token pointer to the constant
484 // Anything other than a 0 or a 1 will result in "No Bank"
485 if (*(uint64_t *)tok == 0)
486 registerbank = BANK_0;
487 else if (*(uint64_t *)tok == 1)
488 registerbank = BANK_1;
490 // Advance half-way through the 64-bit const.
491 // The code below, expecting a regular token,
492 // will advance past the second half.
496 #ifdef DEBODGE_REGBANK
497 sy->sattre |= registerbank; // Store register bank
499 // What needs to happen here is to prime registerbank with regbank, then use
500 // registerbank down below for the bank marking.
501 #warning "!!! regbank <-> registerbank confusion here !!!"
502 // The question here is why, if we're allowed to override the ".regbankN" rules
503 // above, then why is it using the one set by the directive in the extended
504 // attributes and not in what ends up in symbol->svalue?
505 // ".regbankN" is not an original Madmac directive, so it's suspect
506 sy->sattre |= regbank; // Store register bank
508 eattr = ABS | DEFINED | GLOBAL;
512 // Checking for a register symbol
513 else if (tok[0] == SYMBOL)
515 sy2 = lookup(string[tok[1]], LABEL, j);
517 // Make sure symbol is a valid equreg
518 if (!sy2 || !(sy2->sattre & EQUATEDREG))
520 error("invalid GPU/DSP .equr/.regequ definition");
525 eattr = ABS | DEFINED | GLOBAL; // Copy symbols attributes
526 sy->sattre = sy2->sattre;
527 eval = (sy2->svalue & 0xFFFFF0FF);
533 error("invalid GPU/DSP .equr/.regequ definition");
537 else if (equtyp == REG)
539 if (reglist(&rmask) < 0)
542 eval = (uint32_t)rmask;
543 eattr = ABS | DEFINED;
545 else if (equtyp == CCDEF)
547 sy->sattre |= EQUATEDCC;
548 eattr = ABS | DEFINED | GLOBAL;
550 if (tok[0] == SYMBOL)
552 sy2 = lookup(string[tok[1]], LABEL, j);
554 if (!sy2 || !(sy2->sattre & EQUATEDCC))
556 error("invalid gpu/dsp .ccdef definition");
561 eattr = ABS | DEFINED | GLOBAL;
562 sy->sattre = sy2->sattre;
567 else if (expr(exprbuf, &eval, &eattr, &esym) != OK)
571 else if (*tok == SYMBOL)
573 sy2 = lookup(string[tok[1]], LABEL, j);
575 if (sy2 && (sy2->sattre & EQUATEDREG))
577 sy->stype = sy2->stype;
578 sy->sattr = sy2->sattr;
579 sy->sattre = sy2->sattre;
580 sy->svalue = sy2->svalue;
583 else if (expr(exprbuf, &eval, &eattr, &esym) != OK)
586 else if (expr(exprbuf, &eval, &eattr, &esym) != OK)
589 if (!(eattr & DEFINED))
595 sy->sattr |= eattr | EQUATED; // Symbol inherits value and attributes
598 if (list_flag) // Put value in listing
599 listvalue((uint32_t)eval);
601 ErrorIfNotAtEOL(); // Must be at EOL now
608 // Non-zero == error occurred
609 if (HandleLabel(label, labtyp) != 0)
612 label_defined = label;
619 // If we're in 6502 mode and are still in need of a mnemonic, then search
620 // for valid 6502 mnemonic.
621 if (m6502 && (state < 0 || state >= 1000))
624 state = kmatch(opname, mpbase, mpcheck, mptab, mpaccept);
626 for(state=0, p=opname; state>= 0; )
628 j = mpbase[state] + tolowertab[*p];
630 if (mpcheck[j] != state) // Reject, character doesn't match
632 state = -1; // No match
637 { // Must accept or reject at EOS
638 state = mpaccept[j]; // (-1 on no terminal match)
646 // Call 6502 code generator if we found a mnemonic
649 m6502cg(state - 2000);
654 // If we are in GPU or DSP mode and still in need of a mnemonic then search
656 if ((rgpu || rdsp) && (state < 0 || state >= 1000))
658 for(state=0, p=opname; state>=0;)
660 j = mrbase[state] + (int)tolowertab[*p];
662 // Reject, character doesn't match
663 if (mrcheck[j] != state)
665 state = -1; // No match
669 // Must accept or reject at EOS
672 state = mraccept[j]; // (-1 on no terminal match)
679 // Call RISC code generator if we found a mnemonic
682 GenerateRISCCode(state);
687 // If we are in OP mode and still in need of a mnemonic then search for one
688 if (robjproc && ((state < 0) || (state >= 1000)))
690 for(state=0, p=opname; state>=0;)
692 j = mobase[state] + (int)tolowertab[*p];
694 // Reject, character doesn't match
695 if (mocheck[j] != state)
697 state = -1; // No match
701 // Must accept or reject at EOS
704 state = moaccept[j]; // (-1 on no terminal match)
711 // Call OP code generator if we found a mnemonic
714 GenerateOPCode(state);
719 // If we are in 56K mode and still in need of a mnemonic then search for one
720 if (dsp56001 && ((state < 0) || (state >= 1000)))
722 for(state=0, p=opname; state>=0;)
724 j = dspbase[state] + (int)tolowertab[*p];
726 // Reject, character doesn't match
727 if (dspcheck[j] != state)
729 state = -1; // No match
733 // Must accept or reject at EOS
736 state = dspaccept[j]; // (-1 on no terminal match)
743 // Call DSP code generator if we found a mnemonic
748 MNTABDSP * md = &dsp56k_machtab[state - 2000];
749 deposit_extra_ea = 0; // Assume no extra word needed
751 if (md->mnfunc == dsp_mult)
753 // Special case for multiplication instructions: they require
755 if ((operands = dsp_amode(3)) == ERROR)
758 else if ((md->mnattr & PARMOVE) && md->mn0 != M_AM_NONE)
760 if (dsp_amode(2) == ERROR)
763 else if ((md->mnattr & PARMOVE) && md->mn0 == M_AM_NONE)
765 // Instructions that have parallel moves but use no operands
766 // (probably only move). In this case, don't parse addressing
767 // modes--just go straight to parallel parse
768 dsp_am0 = dsp_am1 = M_AM_NONE;
772 // Non parallel move instructions can have up to 4 parameters
773 // (well, only tcc instructions really)
774 if ((operands = dsp_amode(4)) == ERROR)
779 dsp_tcc4(md->mninst);
784 if (md->mnattr & PARMOVE)
786 // Check for parallel moves
787 if ((parcode = parmoves(dsp_a1reg)) == ERROR)
793 error("parallel moves not allowed with this instruction");
798 while ((dsp_am0 & md->mn0) == 0 || (dsp_am1 & md->mn1) == 0)
799 md = &dsp56k_machtab[md->mncont];
801 (*md->mnfunc)(md->mninst | (parcode << 8));
806 // Invoke macro or complain about bad mnemonic
809 if ((sy = lookup(opname, MACRO, 0)) != NULL)
810 InvokeMacro(sy, siz);
812 error("unknown op '%s'", opname);
817 // Call directive handlers
820 (*dirtab[state])(siz);
825 // o can't deposit instrs in BSS or ABS
826 // o do automatic .EVEN for instrs
827 // o allocate space for largest possible instr
828 // o can't do ".b" operations with an address register
831 error("cannot initialize non-storage (BSS) section");
835 if (sloc & 1) // Automatic .even
838 if (challoc - ch_size < 18) // Make sure have space in current chunk
841 m = &machtab[state - 1000];
843 // Call special-mode handler
844 if (m->mnattr & CGSPECIAL)
846 (*m->mnfunc)(m->mninst, siz);
850 if (amode(1) < 0) // Parse 0, 1 or 2 addr modes
853 // Check that we're at EOL
854 // The only exception is ptestr/ptestw instructions
855 // that have 3 or 4 operands and are not handled by
856 // amode(). (yes, we're taking a performance hit here sadly)
857 if (m->mnfunc != m_ptestr && m->mnfunc != m_ptestw)
861 amsk0 = amsktab[am0];
862 amsk1 = amsktab[am1];
864 // Catch attempts to use ".B" with an address register (yes, this check
865 // does work at this level)
866 if (siz == SIZB && (am0 == AREG || am1 == AREG))
868 error("cannot use '.b' with an address register");
872 // Keep a backup of chptr (used for optimisations during codegen)
873 chptr_opcode = chptr;
875 while (!(m->mnattr & siz) || (amsk0 & m->mn0) == 0 || (amsk1 & m->mn1) == 0)
876 m = &machtab[m->mncont];
878 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); }
880 (*m->mnfunc)(m->mninst, siz);
886 // Handle the creation of labels
888 int HandleLabel(char * label, int labelType)
890 // Check for dot in front of label; means this is a local label if present
891 int environment = (*label == '.' ? curenv : 0);
892 SYM * symbol = lookup(label, LABEL, environment);
896 symbol = NewSymbol(label, LABEL, environment);
900 else if (symbol->sattr & DEFINED)
901 return error("multiply-defined label '%s'", label);
903 // Put symbol in "order of definition" list if it's not already in it
904 AddToSymbolDeclarationList(symbol);
908 symbol->svalue = orgaddr;
909 symbol->sattr |= ABS | DEFINED | EQUATED;
913 symbol->svalue = sloc;
914 symbol->sattr |= DEFINED | cursect;
919 // Yes, our CS professors told us to write checks for equality this way,
920 // but damn, it hurts my brain every time I look at it. :-/
921 if (0 == environment)
924 // Make label global if it has a double colon
925 if (labelType == DCOLON)
927 if (environment != 0)
928 return error(locgl_error);
930 symbol->sattr |= GLOBAL;