Mercurial > hg > forks > dxa
annotate structures.h @ 11:fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
| author | Matti Hamalainen <ccr@tnsp.org> |
|---|---|
| date | Thu, 14 May 2020 20:35:40 +0300 |
| parents | 0990d9322fc8 |
| children | 84c0facfc43c |
| rev | line source |
|---|---|
| 0 | 1 /*\ |
| 2 * dxa v0.1.1 -- symbolic 65xx disassembler | |
| 3 * | |
| 4 * Copyright (C) 1993, 1994 Marko M\"akel\"a | |
| 5 * | |
| 6 * This program is free software; you can redistribute it and/or modify | |
| 7 * it under the terms of the GNU General Public License as published by | |
| 8 * the Free Software Foundation; either version 2 of the License, or | |
| 9 * (at your option) any later version. | |
| 10 * | |
| 11 * This program is distributed in the hope that it will be useful, | |
| 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 14 * GNU General Public License for more details. | |
| 15 * | |
| 16 * You should have received a copy of the GNU General Public License | |
| 17 * along with this program; if not, write to the Free Software | |
| 18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. | |
| 19 * | |
| 20 * Contacting the author: | |
| 21 * | |
| 22 * Via Internet E-mail: | |
| 23 * <Marko.Makela@FTP.FUNET.FI> | |
| 24 * | |
| 25 * Via Snail Mail: | |
| 26 * Marko M\"akel\"a | |
| 27 * Sillitie 10 A | |
| 28 * FIN-01480 VANTAA | |
| 29 * Finland | |
| 30 \*/ | |
| 31 | |
| 32 /* structures.h - memory structures and related constants and macros */ | |
| 33 #ifndef _STRUCTURES_H_ | |
| 34 #define _STRUCTURES_H_ | |
| 35 | |
| 36 #ifndef FALSE | |
| 37 #define FALSE 0 | |
| 38 #define TRUE !FALSE | |
| 39 #endif | |
| 40 | |
| 41 #ifndef NULL | |
| 42 #define NULL (void *)0 | |
| 43 #endif | |
| 44 | |
| 45 #define MAXLINE 50 /* maximum amount of bytes used when reading a label in */ | |
| 46 | |
| 47 typedef unsigned short int ADDR_T; /* 16-bit unsigned integer */ | |
| 48 typedef unsigned char DATA_T; /* 8-bit unsigned integer */ | |
| 49 | |
| 50 /********************\ | |
| 51 * Program code table * | |
| 52 \********************/ | |
| 53 | |
| 54 #ifndef _MAIN_C_ | |
| 55 extern | |
| 56 #endif | |
| 57 DATA_T Memory[1 << 16]; | |
| 58 | |
| 59 /*************************\ | |
| 60 * Memory place type table * | |
| 61 \*************************/ | |
| 62 | |
| 63 #ifndef _MAIN_C_ | |
| 64 extern | |
| 65 #endif | |
| 66 unsigned MemType[(1 << 14) / sizeof(unsigned)]; | |
| 67 | |
| 68 #define GetMemType(address) \ | |
| 69 ((MemType[((ADDR_T)address) / (4 * sizeof *MemType)] >> \ | |
| 70 ((address % (4 * sizeof *MemType)) << 1)) & 3) | |
| 71 | |
| 72 #define SetMemType(address, type) \ | |
| 73 (MemType[((ADDR_T)address) / (4 * sizeof *MemType)] = \ | |
| 74 (MemType[((ADDR_T)address) / (4 * sizeof *MemType)] & \ | |
| 75 ~(3 << ((address % (4 * sizeof *MemType)) << 1))) | \ | |
| 76 (type << ((address % (4 * sizeof *MemType)) << 1))) | |
| 77 | |
| 78 /* The table consists of bit pairs with the following values: */ | |
| 79 | |
| 80 #define MEM_UNPROCESSED 0 /* the memory place has not been processed yet */ | |
| 81 #define MEM_INSTRUCTION 1 /* a machine language instruction starts at | |
| 82 this memory place */ | |
| 83 #define MEM_DATA 2 /* the memory place contains data */ | |
| 84 #define MEM_PARAMETER 3 /* a parameter of a machine language | |
| 85 instruction is at this place */ | |
| 86 | |
| 87 /*************************\ | |
| 88 * Memory place flag table * | |
| 89 \*************************/ | |
| 90 | |
| 91 #ifndef _MAIN_C_ | |
| 92 extern | |
| 93 #endif | |
| 94 unsigned | |
| 95 MemFlag[(1 << 13) / sizeof(unsigned)], | |
| 96 MemLabel[(1 << 13) / sizeof(unsigned)], | |
| 97 LowByte[(1 << 8) / sizeof(unsigned)], | |
| 98 HighByte[(1 << 8) / sizeof(unsigned)]; | |
| 99 | |
|
11
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
100 |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
101 #ifndef _MAIN_C_ |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
102 extern |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
103 #endif |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
104 unsigned char MemReferenced[1 << 16]; |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
105 |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
106 |
| 0 | 107 #define GetMemFlag(address) \ |
| 108 ((MemFlag[((ADDR_T)address) / (8 * sizeof *MemFlag)] >> \ | |
| 109 (address % (8 * sizeof *MemFlag))) & 1) | |
| 110 | |
| 111 #define SetMemFlag(address) \ | |
| 112 (MemFlag[((ADDR_T)address) / (8 * sizeof *MemFlag)] |= \ | |
| 113 (1 << (address % (8 * sizeof *MemFlag)))) | |
| 114 | |
| 115 /* The flag table indicates if there may be a valid routine at the address. | |
| 116 If a flag is set, there cannot be valid routines at the address. */ | |
| 117 | |
| 118 #define IsLabeled(address) \ | |
| 119 ((MemLabel[((ADDR_T)address) / (8 * sizeof *MemLabel)] >> \ | |
| 120 (address % (8 * sizeof *MemLabel))) & 1) | |
| 121 | |
|
11
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
122 #define PutLabel(address) DOPutLabel(address, __func__, __LINE__) |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
123 |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
124 |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
125 static inline void DOPutLabel(unsigned int address, const char *name, const int line) |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
126 { |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
127 MemLabel[((ADDR_T)address) / (8 * sizeof *MemLabel)] |= (1 << (address % (8 * sizeof *MemLabel))); |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
128 } |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
129 |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
130 static inline unsigned char IsReferenced(unsigned int address) |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
131 { |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
132 return MemReferenced[address]; |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
133 } |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
134 |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
135 |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
136 static inline void DOPutReference(unsigned int address, const char *name, const int line) |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
137 { |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
138 MemReferenced[address]++; |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
139 } |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
140 |
|
fe4d840c13eb
Implement reference checking to reduce outputting of useless labels.
Matti Hamalainen <ccr@tnsp.org>
parents:
4
diff
changeset
|
141 #define PutReference(address) DOPutReference(address, __func__, __LINE__) |
| 0 | 142 |
| 143 /* These macros tell if there is a label for a given address, or cause a | |
| 144 label to be produced for an address. */ | |
| 145 | |
| 146 #define IsLowByte(address) \ | |
| 147 ((LowByte[((unsigned char)address) / (8 * sizeof *LowByte)] >> \ | |
| 148 (address % (8 * sizeof *LowByte))) & 1) | |
| 149 | |
| 150 #define PutLowByte(address) \ | |
| 151 (LowByte[((unsigned char)address) / (8 * sizeof *LowByte)] |= \ | |
| 152 (1 << (address % (8 * sizeof *LowByte)))) | |
| 153 | |
| 154 /* Corresponding macros for the low byte address table. */ | |
| 155 | |
| 156 #define IsHighByte(address) \ | |
| 157 ((HighByte[(address >> 8) / (8 * sizeof *HighByte)] >> \ | |
| 158 ((address >> 8) % (8 * sizeof *HighByte))) & 1) | |
| 159 | |
| 160 #define PutHighByte(address) \ | |
| 161 (HighByte[(address >> 8) / (8 * sizeof *HighByte)] |= \ | |
| 162 (1 << ((address >> 8) % (8 * sizeof *HighByte)))) | |
| 163 | |
| 164 /* Corresponding macros for the high byte address table. */ | |
| 165 | |
| 166 /***************************************\ | |
| 167 * Routine/warning address table entries * | |
| 168 \***************************************/ | |
| 169 | |
| 170 typedef struct table | |
| 171 { | |
| 172 ADDR_T address; | |
| 173 ADDR_T parent; | |
| 174 unsigned char type; | |
| 175 } table; | |
| 176 | |
| 177 /* The table.type byte has the following format: */ | |
| 178 | |
| 179 #define RTN_SURE 0x80 /* address must point to a valid subprogram */ | |
| 180 #define RTN_POTENTIAL 0x81 /* address may point to a valid subprogram (an | |
| 181 address following a conditional branch | |
| 182 instruction) */ | |
| 183 #define RTN_SUSPECTED 0x82 /* address might point to a valid subprogram | |
| 184 (an address encountered during processing | |
| 185 an RTN_POTENTIAL entry) */ | |
| 186 #define RTN_SUSP_POT 0x83 /* address might point to a subprogram (an | |
| 187 address following a conditional branch | |
| 188 instruction that was encountered during | |
| 189 processing an RTN_SUSPECTED or | |
| 190 RTN_POTENTIAL entry) */ | |
| 191 #define RTN_B_TEMPORARY 0x10 /* declares the entry as temporary */ | |
| 192 #define RTN_B_PROCESSED 0x20 /* address seems to point to a valid | |
| 193 subprogram (a successfully processed | |
| 194 RTN_SUSPECTED entry is | |
| 195 RTN_SUSPECTED | RTN_B_PROCESSED) */ | |
| 196 | |
| 197 #define MASK_ANY 0xc0 /* mask for determining the type of the entry */ | |
| 198 | |
| 199 #define RTN_ANY 0x80 /* mask for determining if an entry is a | |
| 200 routine or not */ | |
| 201 | |
| 202 #define WRN_PARAM_WRITTEN_TO 0x40 /* the parameter of the instruction is | |
| 203 written to */ | |
| 204 #define WRN_INSTR_WRITTEN_TO 0x41 /* the instruction is modified by the | |
| 205 program */ | |
| 206 | |
| 207 #define WRN_PARAM_JUMPED_TO 0x42 /* a jump occurs in the middle of the | |
| 208 instruction, e.g. BIT $01A9 */ | |
| 209 #define WRN_RTN_TRUNCATED 0x43 /* the routine is truncated, the rest of | |
| 210 the instructions are retrieved outside | |
| 211 the loaded file (very fatal error) */ | |
| 212 #define WRN_I_ACCESSED 0x44 /* not an actual warning: an unprocessed | |
| 213 memory place is accessed by an | |
| 214 RTN_POTENTIAL or RTN_SUSPECTED routine */ | |
| 215 #define WRN_I_LABEL_NEEDED 0x45 /* not an actual warning: a label will be | |
| 216 needed for this memory place */ | |
| 217 | |
| 218 #define WRN_B_TEMPORARY 0x20 /* mask for determining whether a warning | |
| 219 is temporary and may be deleted later */ | |
| 220 | |
| 221 #define WRN_ANY 0x40 /* mask for determining whether an | |
| 222 entry is a warning or not */ | |
| 223 | |
| 224 #define TBL_DELETED 0 /* the entry may be reused */ | |
| 225 | |
| 226 /*********************\ | |
| 227 * Label table entries * | |
| 228 \*********************/ | |
| 229 | |
| 230 typedef struct label | |
| 231 { | |
|
4
0990d9322fc8
Implement address-ranged labels. Breaks compatibility of label files.
Matti Hamalainen <ccr@tnsp.org>
parents:
0
diff
changeset
|
232 int is_range; |
|
0990d9322fc8
Implement address-ranged labels. Breaks compatibility of label files.
Matti Hamalainen <ccr@tnsp.org>
parents:
0
diff
changeset
|
233 ADDR_T address, len; |
| 0 | 234 char *name; |
| 235 } label; | |
| 236 | |
| 237 /********************\ | |
| 238 * Word table entries * | |
| 239 \********************/ | |
| 240 | |
| 241 typedef struct words | |
| 242 { | |
| 243 ADDR_T start, end; | |
| 244 } words; | |
| 245 | |
| 246 #ifndef _MAIN_C_ | |
| 247 extern char *prog; | |
| 248 extern ADDR_T StartAddress, EndAddress; | |
| 249 extern int fVerbose; | |
| 250 #else | |
| 251 char *prog; | |
| 252 ADDR_T StartAddress, EndAddress; | |
| 253 int fVerbose = FALSE; | |
| 254 #endif /* _MAIN_C_ */ | |
| 255 | |
| 256 #ifndef _TABLE_C_ | |
| 257 extern unsigned int entrycount; | |
| 258 extern table *scantable; /* table of all warnings generated or routines | |
| 259 encountered */ | |
| 260 #else | |
| 261 unsigned int entrycount = 0; | |
| 262 table *scantable = NULL; | |
| 263 #endif /* _TABLE_C_ */ | |
| 264 | |
| 265 #ifndef _DUMP_C_ | |
| 266 extern int listwidth; /* maximum amount of bytes dumped on a source line */ | |
| 267 #else | |
| 268 int listwidth = 0; | |
| 269 #endif /* _DUMP_C_ */ | |
| 270 | |
| 271 #endif /* _STRUCTURES_H_ */ |