83bc7b5a5736706cdbcd2f849e5e6b27ef1fbed3
[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-2018 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 #define NSECTS       16                 // Max. number of sections
58
59 // Tunable (storage) definitions
60 #define CH_THRESHOLD    32              // Minimum amount of space in code chunk
61 #define CH_CODE_SIZE    4096    // Code chunk normal allocation (4K)
62
63 // Section attributes (.scattr)
64 #define SUSED        0x8000             // Section is used (really, valid)
65 #define SBSS         0x4000             // Section can contain no data
66 #define SABS         0x2000             // Section is absolute
67 #define SPIC         0x1000             // Section is position-independent code
68
69 // FIXUP attributes
70 #define FUMASK       0x000F             // Mask for fixup cases:
71 #define FU_QUICK     0x0000             // Fixup 3-bit quick instruction field
72 #define FU_BYTE      0x0001             // Fixup byte
73 #define FU_WORD      0x0002             // Fixup word
74 #define FU_WBYTE     0x0003             // Fixup byte (at loc+1)
75 #define FU_LONG      0x0004             // Fixup long
76 #define FU_BBRA      0x0005             // Fixup byte branch
77 #define FU_6BRA      0x0007             // Fixup 6502-format branch offset
78 #define FU_BYTEH     0x0008             // Fixup 6502 high byte of immediate word
79 #define FU_BYTEL     0x0009             // Fixup 6502 low byte of immediate word
80 #define FU_QUAD      0x000A             // Fixup quad-word (8 bytes)
81 #define FU_56001     0x000B             // Generic fixup code for all 56001 modes
82 #define FU_56001_B   0x000C             // Generic fixup code for all 56001 modes (ggn: I have no shame)
83
84 #define FU_SEXT      0x0010             // Ok to sign extend
85 #define FU_PCREL     0x0020             // Subtract PC first
86 #define FU_EXPR      0x0040             // Expression (not symbol) follows
87
88 #define FU_GLOBAL    0x0080             // Mark global symbol
89
90 #define FUMASKRISC   0x0F00             // Mask for RISC fixup cases
91 #define FU_MOVEI     0x0100
92 #define FU_JR        0x0200
93 #define FU_REGONE    0x0400
94 #define FU_NUM15     0x0500
95 #define FU_NUM31     0x0600
96 #define FU_NUM32     0x0700
97 #define FU_REGTWO    0x0800
98
99 #define FU_SUB32     0x1000
100 #define FU_ISBRA     0x2000             // Word forward fixup is a BRA or DBRA
101 #define FU_LBRA      0x4000             // Long branch, for short branch detect
102 #define FU_DONE      0x8000             // Fixup has been done
103
104 // FPU fixups
105 #define FU_FLOATSING 0x000D             // Fixup 32-bit float
106 #define FU_FLOATDOUB 0x000E             // Fixup 64-bit float
107 #define FU_FLOATEXT  0x000F             // Fixup 96-bit float
108
109 // OP fixups
110 #define FU_OBJLINK   0x10000    // Fixup OL link addr (bits 24-42, drop last 3)
111 #define FU_OBJDATA   0x20000    // Fixup OL data addr (bits 43-63, drop last 3)
112
113 // DSP56001 fixups
114 // TODO: Sadly we don't have any spare bits left inside a 16-bit word
115 // so we use the 2nd nibble as control code and
116 // stick $B or $C in the lower nibble - then it's picked up as
117 // FU_56001 by the fixup routine and then a second switch
118 // selects fixup mode. Since we now have 32 bits, we can fix this!
119 // [N.B.: This isn't true anymore, we now have 32 bits! :-P]
120 #define FU_DSPIMM5    0x090B    // Fixup  5-bit immediate
121 #define FU_DSPADR12   0x0A0B    // Fixup 12-bit address
122 #define FU_DSPADR24   0x0B0B    // Fixup 24-bit address
123 #define FU_DSPADR16   0x0C0B    // Fixup 24-bit address
124 #define FU_DSPIMM12   0x0D0B    // Fixup 12-bit immediate
125 #define FU_DSPIMM24   0x0E0B    // Fixup 24-bit immediate
126 #define FU_DSPIMM8    0x0F0B    // Fixup  8-bit immediate
127 #define FU_DSPADR06   0x090C    // Fixup  6-bit address
128 #define FU_DSPPP06    0x0A0C    // Fixup  6 bit pp address
129 #define FU_DSPIMMFL8  0x0B0C    // Fixup  8-bit immediate float
130 #define FU_DSPIMMFL16 0x0C0C    // Fixup 16-bit immediate float
131 #define FU_DSPIMMFL24 0x0D0C    // Fixup 24-bit immediate float
132
133
134 // Chunks are used to hold generated code and fixup records
135 #define CHUNK  struct _chunk
136 CHUNK {
137         CHUNK *   chnext;       // Next, previous chunks in section
138         CHUNK *   chprev;
139         uint32_t  chloc;        // Base addr of this chunk
140         uint32_t  challoc;      // # bytes allocated for chunk
141         uint32_t  ch_size;      // # bytes chunk actually uses
142         uint8_t * chptr;        // Data for this chunk
143 };
144
145 // Fixup records can also hold an expression (if any)
146 #define FIXUP struct _fixup
147 FIXUP {
148         FIXUP *  next;          // Pointer to next FIXUP
149         uint32_t attr;          // Fixup type
150         uint32_t loc;           // Location in section
151         uint16_t fileno;        // ID of current file
152         uint32_t lineno;        // Current line
153         TOKEN *  expr;          // Pointer to stored expression (if any)
154         SYM *    symbol;        // Pointer to symbol (if any)
155         uint32_t orgaddr;       // Fixup origin address (used for FU_JR)
156 };
157
158 // Section descriptor
159 #define SECT   struct _sect
160 SECT {
161         uint16_t scattr;        // Section attributes
162         uint32_t sloc;          // Current loc-in / size-of section
163         uint32_t relocs;        // # of relocations for this section
164         uint32_t orgaddr;       // Current org'd address ***NEW***
165         CHUNK *  sfcode;        // First chunk in section
166         CHUNK *  scode;         // Last chunk in section
167         FIXUP *  sffix;         // First fixup
168         FIXUP *  sfix;          // Last fixup ***NEW***
169 };
170
171 // 680x0 defines
172 #define CPU_68000 1
173 #define CPU_68020 2
174 #define CPU_68030 4
175 #define CPU_68040 8
176 #define CPU_68060 16
177 #define FPU_NONE  0
178 #define FPU_68881 1
179 #define FPU_68882 2
180 #define FPU_68040 4
181 #define FPU_68060 8
182
183 // Helper macros to test for active CPU
184 #define CHECK00 if (activecpu == CPU_68000) return error(unsupport)
185 #define CHECK20 if (activecpu == CPU_68020) return error(unsupport)
186 #define CHECK30 if (activecpu == CPU_68030) return error(unsupport)
187 #define CHECK40 if (activecpu == CPU_68040) return error(unsupport)
188 #define CHECK60 if (activecpu == CPU_68060) return error(unsupport)
189 #define CHECKNO00 if (activecpu != CPU_68000) return error(unsupport)
190 #define CHECKNO20 if (activecpu != CPU_68020) return error(unsupport)
191 #define CHECKNO30 if (activecpu != CPU_68030) return error(unsupport)
192 #define CHECKNO40 if (activecpu != CPU_68040) return error(unsupport)
193 #define CHECKNO60 if (activecpu != CPU_68060) return error(unsupport)
194 #define CHECKNOFPU if (!activefpu) return error(unsupport)
195
196 // Globals, external etc
197 extern uint32_t sloc;
198 extern uint16_t scattr;
199 extern uint8_t * chptr;
200 extern uint8_t * chptr_opcode;
201 extern uint32_t ch_size;
202 extern int cursect;
203 extern SECT sect[];
204 extern uint32_t challoc;
205 extern CHUNK * scode;
206
207 // Prototypes
208 void InitSection(void);
209 void SwitchSection(int);
210 void SaveSection(void);
211 int fixtest(int, uint32_t);
212 void chcheck(uint32_t);
213 int AddFixup(uint32_t, uint32_t, TOKEN *);
214 int ResolveAllFixups(void);
215
216 #endif // __SECT_H__
217