Partial fix for bug #108 (Fixup cleanups).
[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
14 // Macros to deposit code in the current section (in Big Endian)
15 // D_rword deposits a "6502" format (low, high) word (01).
16 #define D_byte(b)       {*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)      {*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)      {*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 #define D_rword(w)      {*chptr++=(uint8_t)(w); *chptr++=(uint8_t)((w)>>8); \
36                                                 sloc+=2; ch_size+=2;if(orgactive) orgaddr += 2;}
37
38 // Macro for the 56001. Word size on this device is 24 bits wide. I hope that
39 // orgaddr += 1 means that the addresses in the device reflect this.
40 #define D_dsp(w)    {chcheck(3);*chptr++=(uint8_t)(w>>16); \
41         *chptr++=(uint8_t)(w>>8); *chptr++=(uint8_t)w; \
42         sloc+=1; ch_size += 3; if(orgactive) orgaddr += 1; \
43         dsp_written_data_in_current_org=1;}
44
45 // This macro expects to get an array of uint8_ts with the hi bits in a[0] and
46 // the low bits in a[11] (Big Endian).
47 #define D_extend(a) {memcpy(chptr, a, 12); chptr+=12; sloc+=12, ch_size+=12;\
48                                         if (orgactive) orgaddr+=12;}
49
50 // Fill n bytes with zeroes
51 #define D_ZEROFILL(n)   {memset(chptr, 0, n); chptr+=n; sloc+=n; ch_size+=n;\
52                                                 if (orgactive) orgaddr+=n;}
53
54 #define NSECTS       16                 // Max. number of sections
55
56 // Tunable (storage) definitions
57 #define CH_THRESHOLD    64              // Minimum amount of space in code chunk
58 #define CH_CODE_SIZE    2048    // Code chunk normal allocation
59 #define CH_FIXUP_SIZE   1024    // Fixup chunk normal allocation
60
61 // Section attributes (.scattr)
62 #define SUSED        0x8000             // Section is used (really, valid)
63 #define SBSS         0x4000             // Section can contain no data
64 #define SABS         0x2000             // Section is absolute
65 #define SPIC         0x1000             // Section is position-independent code
66
67 // N.B.: THIS IS NO LONGER TRUE
68 // Fixup record a WORD of these bits, followed by a loc and then a pointer
69 // to a symbol or an ENDEXPR-terminated postfix expression.
70 //
71 // SYMBOL               EXPRESSION
72 // ------               ----------
73 // ~FU_EXPR    FU_EXPR     fixup type
74 // loc.L       loc.L       location in section
75 // fileno.W    fileno.W    file number fixup occurred in
76 // lineno.W    lineno.W    line number fixup occurred in
77 // symbol.L    size.W      &symbol  /  size of expression
78 // token.L     expression list
79 // (etc)
80 // ENDEXPR.L    (end of expression)
81 #define FUMASK       0x000F             // Mask for fixup cases:
82 #define FU_QUICK     0x0000             // Fixup 3-bit quick instruction field
83 #define FU_BYTE      0x0001             // Fixup byte
84 #define FU_WORD      0x0002             // Fixup word
85 #define FU_WBYTE     0x0003             // Fixup byte (at loc+1)
86 #define FU_LONG      0x0004             // Fixup long
87 #define FU_BBRA      0x0005             // Fixup byte branch
88 #define FU_6BRA      0x0007             // Fixup 6502-format branch offset
89 #define FU_BYTEH     0x0008             // Fixup 6502 high byte of immediate word
90 #define FU_BYTEL     0x0009             // Fixup 6502 low byte of immediate word
91
92 #define FU_SEXT      0x0010             // Ok to sign extend
93 #define FU_PCREL     0x0020             // Subtract PC first
94 #define FU_EXPR      0x0040             // Expression (not symbol) follows
95
96 #define FU_GLOBAL    0x0080             // Mark global symbol
97
98 #define FUMASKRISC   0x0F00             // Mask for RISC fixup cases
99 #define FU_MOVEI     0x0100
100 #define FU_JR        0x0200
101 #define FU_REGONE    0x0400
102 #define FU_NUM15     0x0500
103 #define FU_NUM31     0x0600
104 #define FU_NUM32     0x0700
105 #define FU_REGTWO    0x0800
106
107 #define FU_SUB32     0x1000
108 #define FU_ISBRA     0x2000             // Word forward fixup is a BRA or DBRA
109 #define FU_LBRA      0x4000             // Long branch, for short branch detect
110 #define FU_DONE      0x8000             // Fixup has been done
111
112 // FPU fixups
113 // TODO: these are obviously bogus for now!
114 #define FU_FLOATSING 0x0D0B             // Fixup 32-bit float
115 #define FU_FLOATDOUB 0x0E0B             // Fixup 64-bit float
116 #define FU_FLOATEXT  0x0F0B             // Fixup 96-bit float
117
118 // Chunks are used to hold generated code and fixup records
119 #define CHUNK  struct _chunk
120 CHUNK {
121         CHUNK *   chnext;       // Next, previous chunks in section
122         CHUNK *   chprev;
123         uint32_t  chloc;        // Base addr of this chunk
124         uint32_t  challoc;      // # bytes allocated for chunk
125         uint32_t  ch_size;      // # bytes chunk actually uses
126         uint8_t * chptr;        // Data for this chunk
127 };
128
129 // Fixup records can also hold an expression (if any)
130 #define FIXUP struct _fixup
131 FIXUP {
132         FIXUP *  next;          // Pointer to next FIXUP
133         uint32_t attr;          // Fixup type
134         uint32_t loc;           // Location in section
135         uint16_t fileno;        // ID of current file
136         uint32_t lineno;        // Current line
137         TOKEN *  expr;          // Pointer to stored expression (if any)
138         SYM *    symbol;        // Pointer to symbol (if any)
139         uint32_t orgaddr;       // Fixup origin address (used for FU_JR)
140 };
141
142 // Section descriptor
143 #define SECT   struct _sect
144 SECT {
145         uint16_t scattr;        // Section attributes
146         uint32_t sloc;          // Current loc-in / size-of section
147         uint32_t relocs;        // # of relocations for this section
148         uint32_t orgaddr;       // Current org'd address ***NEW***
149         CHUNK *  sfcode;        // First chunk in section
150         CHUNK *  scode;         // Last chunk in section
151         FIXUP *  sffix;         // First fixup
152         FIXUP *  sfix;          // Last fixup ***NEW***
153 };
154
155 // 680x0 defines
156 #define CPU_68000 1
157 #define CPU_68020 2
158 #define CPU_68030 4
159 #define CPU_68040 8
160 #define CPU_68060 16
161 #define FPU_NONE  0
162 #define FPU_68881 1
163 #define FPU_68882 2
164 #define FPU_68040 4
165 #define FPU_68060 8
166
167 // Helper macros to test for active CPU
168 #define CHECK00 if (activecpu == CPU_68000) return error(unsupport)
169 #define CHECK20 if (activecpu == CPU_68020) return error(unsupport)
170 #define CHECK30 if (activecpu == CPU_68030) return error(unsupport)
171 #define CHECK40 if (activecpu == CPU_68040) return error(unsupport)
172 #define CHECK60 if (activecpu == CPU_68060) return error(unsupport)
173 #define CHECKNO00 if (activecpu != CPU_68000) return error(unsupport)
174 #define CHECKNO20 if (activecpu != CPU_68020) return error(unsupport)
175 #define CHECKNO30 if (activecpu != CPU_68030) return error(unsupport)
176 #define CHECKNO40 if (activecpu != CPU_68040) return error(unsupport)
177 #define CHECKNO60 if (activecpu != CPU_68060) return error(unsupport)
178 #define CHECKNOFPU if (!activefpu) return error(unsupport)
179
180 // Globals, external etc
181 extern uint32_t sloc;
182 extern uint16_t scattr;
183 extern uint8_t * chptr;
184 extern uint8_t * chptr_opcode;
185 extern uint32_t ch_size;
186 extern int cursect;
187 extern SECT sect[];
188 extern uint32_t challoc;
189 extern CHUNK * scode;
190
191 // Prototypes
192 void InitSection(void);
193 void SwitchSection(int);
194 void SaveSection(void);
195 int fixtest(int, uint32_t);
196 int chcheck(uint32_t);
197 int AddFixup(uint32_t, uint32_t, TOKEN *);
198 int ResolveAllFixups(void);
199
200 #endif // __SECT_H__
201