Version bump for last commit; now at v2.0.23.
[rmac] / sect.h
1 //
2 // RMAC - Reboot's Macro Assembler for all Atari computers
3 // SECT.H - Code Generation, Fixups and Section Management
4 // Copyright (C) 199x Landon Dyer, 2011-2020 Reboot and Friends
5 // RMAC derived from MADMAC v1.07 Written by Landon Dyer, 1986
6 // Source utilized with the kind permission of Landon Dyer
7 //
8
9 #ifndef __SECT_H__
10 #define __SECT_H__
11
12 #include "rmac.h"
13 #include "riscasm.h"
14
15 // Macros to deposit code in the current section (in Big Endian)
16 #define D_byte(b)       {chcheck(1);*chptr++=(uint8_t)(b); sloc++; ch_size++; \
17         if(orgactive) orgaddr++;}
18 #define D_word(w)       {chcheck(2);*chptr++=(uint8_t)((w)>>8); \
19         *chptr++=(uint8_t)(w); \
20         sloc += 2; ch_size += 2; if(orgactive) orgaddr += 2;}
21 #define D_long(lw)      {chcheck(4);*chptr++=(uint8_t)((lw)>>24); \
22         *chptr++=(uint8_t)((lw)>>16);\
23         *chptr++=(uint8_t)((lw)>>8); \
24         *chptr++=(uint8_t)(lw); \
25         sloc += 4; ch_size += 4; if(orgactive) orgaddr += 4;}
26 #define D_quad(qw)      {chcheck(8);*chptr++=(uint8_t)((qw)>>56); \
27         *chptr++=(uint8_t)((qw)>>48);\
28         *chptr++=(uint8_t)((qw)>>40);\
29         *chptr++=(uint8_t)((qw)>>32);\
30         *chptr++=(uint8_t)((qw)>>24);\
31         *chptr++=(uint8_t)((qw)>>16);\
32         *chptr++=(uint8_t)((qw)>>8); \
33         *chptr++=(uint8_t)(qw); \
34         sloc += 8; ch_size += 8; if(orgactive) orgaddr += 8;}
35
36 // D_rword deposits a "6502" format (low, high) word (01).
37 #define D_rword(w)      {chcheck(2);*chptr++=(uint8_t)(w); \
38         *chptr++=(uint8_t)((w)>>8); \
39         sloc+=2; ch_size+=2;if(orgactive) orgaddr += 2;}
40
41 // Macro for the 56001. Word size on this device is 24 bits wide. I hope that
42 // orgaddr += 1 means that the addresses in the device reflect this. [A: Yes.]
43 #define D_dsp(w)        {chcheck(3);*chptr++=(uint8_t)(w>>16); \
44         *chptr++=(uint8_t)(w>>8); *chptr++=(uint8_t)w; \
45         sloc+=1; ch_size += 3; if(orgactive) orgaddr += 1; \
46         dsp_written_data_in_current_org=1;}
47
48 // This macro expects to get an array of uint8_ts with the hi bits in a[0] and
49 // the low bits in a[11] (Big Endian).
50 #define D_extend(a)     {chcheck(12); memcpy(chptr, a, 12); chptr+=12; sloc+=12, \
51         ch_size+=12; if (orgactive) orgaddr+=12;}
52
53 // Fill n bytes with zeroes
54 #define D_ZEROFILL(n)   {chcheck(n); memset(chptr, 0, n); chptr+=n; sloc+=n; \
55         ch_size+=n; if (orgactive) orgaddr+=n;}
56
57 //OK, this is bad, mmkay? The constants defined in rmac.h are used as indices into an array which means that this was never meant to be defined this way--at least if it was, it was a compromise that has come home to bite us all in the ass.  !!! FIX !!!
58 //#define NSECTS       16                       // Max. number of sections
59 #define NSECTS       256                        // Max. number of sections
60
61 // Tunable (storage) definitions
62 #define CH_THRESHOLD    32              // Minimum amount of space in code chunk
63 #define CH_CODE_SIZE    4096    // Code chunk normal allocation (4K)
64
65 // Section attributes (.scattr)
66 #define SUSED        0x8000             // Section is used (really, valid)
67 #define SBSS         0x4000             // Section can contain no data
68 #define SABS         0x2000             // Section is absolute
69 #define SPIC         0x1000             // Section is position-independent code
70
71 // FIXUP attributes
72 #define FUMASK       0x000F             // Mask for fixup cases:
73 #define FU_QUICK     0x0000             // Fixup 3-bit quick instruction field
74 #define FU_BYTE      0x0001             // Fixup byte
75 #define FU_WORD      0x0002             // Fixup word
76 #define FU_WBYTE     0x0003             // Fixup byte (at loc+1)
77 #define FU_LONG      0x0004             // Fixup long
78 #define FU_BBRA      0x0005             // Fixup byte branch
79 #define FU_6BRA      0x0007             // Fixup 6502-format branch offset
80 #define FU_BYTEH     0x0008             // Fixup 6502 high byte of immediate word
81 #define FU_BYTEL     0x0009             // Fixup 6502 low byte of immediate word
82 #define FU_QUAD      0x000A             // Fixup quad-word (8 bytes, typically OP)
83 #define FU_56001     0x000B             // Fixup code for all 56001 modes
84
85 #define FU_SEXT      0x0010             // Ok to sign extend
86 #define FU_PCREL     0x0020             // Subtract PC first
87 #define FU_PCRELX    0x1000000  // 030 variant
88 #define FU_EXPR      0x0040             // Expression (not symbol) follows
89
90 #define FU_GLOBAL    0x0080             // Mark global symbol
91
92 #define FUMASKRISC   0x0F00             // Mask for RISC fixup cases
93 #define FU_MOVEI     0x0100
94 #define FU_JR        0x0200
95 #define FU_REGONE    0x0400
96 #define FU_NUM15     0x0500
97 #define FU_NUM31     0x0600
98 #define FU_NUM32     0x0700
99 #define FU_REGTWO    0x0800
100
101 #define FU_SUB32     0x1000
102 #define FU_ISBRA     0x2000             // Word forward fixup is a BRA or DBRA
103 #define FU_LBRA      0x4000             // Long branch, for short branch detect
104 #define FU_DONE      0x8000             // Fixup has been done
105
106 // FPU fixups
107 #define FU_FLOATSING 0x000D             // Fixup 32-bit float
108 #define FU_FLOATDOUB 0x000E             // Fixup 64-bit float
109 #define FU_FLOATEXT  0x000F             // Fixup 96-bit float
110
111 // OP fixups
112 #define FU_OBJLINK   0x10000    // Fixup OL link addr (bits 24-42, drop last 3)
113 #define FU_OBJDATA   0x20000    // Fixup OL data addr (bits 43-63, drop last 3)
114
115 // DSP56001 fixups
116 #define FUMASKDSP     0xF00000  // Mask for DSP56001 fuckups^Wfixups
117 #define FU_DSPIMM5    0x100000  // Fixup  5-bit immediate
118 #define FU_DSPADR12   0x200000  // Fixup 12-bit address
119 #define FU_DSPADR24   0x300000  // Fixup 24-bit address
120 #define FU_DSPADR16   0x400000  // Fixup 16-bit address
121 #define FU_DSPIMM12   0x500000  // Fixup 12-bit immediate
122 #define FU_DSPIMM24   0x600000  // Fixup 24-bit immediate
123 #define FU_DSPIMM8    0x700000  // Fixup  8-bit immediate
124 #define FU_DSPADR06   0x800000  // Fixup  6-bit address
125 #define FU_DSPPP06    0x900000  // Fixup  6 bit pp address
126 #define FU_DSPIMMFL8  0xA00000  // Fixup  8-bit immediate float
127 #define FU_DSPIMMFL16 0xB00000  // Fixup 16-bit immediate float
128 #define FU_DSPIMMFL24 0xC00000  // Fixup 24-bit immediate float
129
130
131 // Chunks are used to hold generated code and fixup records
132 #define CHUNK  struct _chunk
133 CHUNK {
134         CHUNK *   chnext;       // Next, previous chunks in section
135         CHUNK *   chprev;
136         uint32_t  chloc;        // Base addr of this chunk
137         uint32_t  challoc;      // # bytes allocated for chunk
138         uint32_t  ch_size;      // # bytes chunk actually uses
139         uint8_t * chptr;        // Data for this chunk
140 };
141
142 // Fixup records can also hold an expression (if any)
143 #define FIXUP struct _fixup
144 FIXUP {
145         FIXUP *  next;          // Pointer to next FIXUP
146         uint32_t attr;          // Fixup type
147         uint32_t loc;           // Location in section
148         uint16_t fileno;        // ID of current file
149         uint32_t lineno;        // Current line
150         TOKEN *  expr;          // Pointer to stored expression (if any)
151         SYM *    symbol;        // Pointer to symbol (if any)
152         uint32_t orgaddr;       // Fixup origin address (used for FU_JR)
153 };
154
155 // Section descriptor
156 #define SECT   struct _sect
157 SECT {
158         uint16_t scattr;        // Section attributes
159         uint32_t sloc;          // Current loc-in / size-of section
160         uint32_t relocs;        // # of relocations for this section
161         uint32_t orgaddr;       // Current org'd address ***NEW***
162         CHUNK *  sfcode;        // First chunk in section
163         CHUNK *  scode;         // Last chunk in section
164         FIXUP *  sffix;         // First fixup
165         FIXUP *  sfix;          // Last fixup ***NEW***
166 };
167
168 // 680x0 defines
169 #define CPU_68000 1
170 #define CPU_68020 2
171 #define CPU_68030 4
172 #define CPU_68040 8
173 #define CPU_68060 16
174 #define FPU_NONE  0
175 #define FPU_68881 1
176 #define FPU_68882 2
177 #define FPU_68040 4
178 #define FPU_68060 8
179
180 // Helper macros to test for active CPU
181 #define CHECK00 if (activecpu == CPU_68000) return error(unsupport)
182 #define CHECK20 if (activecpu == CPU_68020) return error(unsupport)
183 #define CHECK30 if (activecpu == CPU_68030) return error(unsupport)
184 #define CHECK40 if (activecpu == CPU_68040) return error(unsupport)
185 #define CHECK60 if (activecpu == CPU_68060) return error(unsupport)
186 #define CHECKNO00 if (activecpu != CPU_68000) return error(unsupport)
187 #define CHECKNO20 if (activecpu != CPU_68020) return error(unsupport)
188 #define CHECKNO30 if (activecpu != CPU_68030) return error(unsupport)
189 #define CHECKNO40 if (activecpu != CPU_68040) return error(unsupport)
190 #define CHECKNO60 if (activecpu != CPU_68060) return error(unsupport)
191 #define CHECKNOFPU if (!activefpu) return error(unsupport)
192
193 // Globals, external etc
194 extern uint32_t sloc;
195 extern uint16_t scattr;
196 extern uint8_t * chptr;
197 extern uint8_t * chptr_opcode;
198 extern uint32_t ch_size;
199 extern int cursect;
200 extern SECT sect[];
201 extern uint32_t challoc;
202 extern CHUNK * scode;
203
204 // Prototypes
205 void InitSection(void);
206 void SwitchSection(int);
207 void SaveSection(void);
208 int fixtest(int, uint32_t);
209 void chcheck(uint32_t);
210 int AddFixup(uint32_t, uint32_t, TOKEN *);
211 int ResolveAllFixups(void);
212
213 #endif // __SECT_H__
214