1 /*****************************************************************************/
5 /* 6502 code generator */
9 /* (C) 1998-2004 Ullrich von Bassewitz */
10 /* Römerstrasse 52 */
11 /* D-70794 Filderstadt */
12 /* EMail: uz@cc65.org */
15 /* This software is provided 'as-is', without any expressed or implied */
16 /* warranty. In no event will the authors be held liable for any damages */
17 /* arising from the use of this software. */
19 /* Permission is granted to anyone to use this software for any purpose, */
20 /* including commercial applications, and to alter it and redistribute it */
21 /* freely, subject to the following restrictions: */
23 /* 1. The origin of this software must not be misrepresented; you must not */
24 /* claim that you wrote the original software. If you use this software */
25 /* in a product, an acknowledgment in the product documentation would be */
26 /* appreciated but is not required. */
27 /* 2. Altered source versions must be plainly marked as such, and must not */
28 /* be misrepresented as being the original software. */
29 /* 3. This notice may not be removed or altered from any source */
32 /*****************************************************************************/
49 /*****************************************************************************/
51 /*****************************************************************************/
55 /* Code generator flags.
56 * Note: The type flags are designed so that a smaller type may override a
57 * larger one by or'ing it into the existing one.
59 #define CF_NONE 0x0000 /* No special flags */
61 #define CF_TYPE 0x0007 /* Mask for operand type */
62 #define CF_CHAR 0x0003 /* Operation on characters */
63 #define CF_INT 0x0001 /* Operation on ints */
64 #define CF_PTR CF_INT /* Alias for readability */
65 #define CF_LONG 0x0000 /* Operation on longs */
66 #define CF_FLOAT 0x0004 /* Operation on a float */
68 #define CF_NOKEEP 0x0008 /* Value may get destroyed when storing */
70 #define CF_UNSIGNED 0x0010 /* Value is unsigned */
71 #define CF_CONST 0x0020 /* Constant value available */
72 #define CF_CONSTADDR 0x0040 /* Constant address value available */
73 #define CF_TEST 0x0080 /* Test value */
74 #define CF_FIXARGC 0x0100 /* Function has fixed arg count */
75 #define CF_FORCECHAR 0x0200 /* Handle chars as chars, not ints */
76 #define CF_REG 0x0800 /* Value is in primary register */
78 /* Type of static address */
79 #define CF_ADDRMASK 0xF000 /* Type of address */
80 #define CF_STATIC 0x0000 /* Static local */
81 #define CF_EXTERNAL 0x1000 /* Static external */
82 #define CF_ABSOLUTE 0x2000 /* Numeric absolute address */
83 #define CF_LOCAL 0x4000 /* Auto variable */
84 #define CF_REGVAR 0x8000 /* Register variable */
93 /*****************************************************************************/
94 /* Files, pre- and postamble */
95 /*****************************************************************************/
99 void g_preamble (void);
100 /* Generate the assembler code preamble */
102 void g_fileinfo (const char* Name, unsigned long Size, unsigned long MTime);
103 /* If debug info is enabled, place a file info into the source */
107 /*****************************************************************************/
108 /* Segment support */
109 /*****************************************************************************/
113 void g_userodata (void);
114 /* Switch to the read only data segment */
116 void g_usedata (void);
117 /* Switch to the data segment */
119 void g_usebss (void);
120 /* Switch to the bss segment */
122 void g_segname (segment_t Seg);
123 /* Emit the name of a segment if necessary */
127 /*****************************************************************************/
128 /* Functions handling local labels */
129 /*****************************************************************************/
133 void g_defcodelabel (unsigned label);
134 /* Define a local code label */
136 void g_defdatalabel (unsigned label);
137 /* Define a local data label */
141 /*****************************************************************************/
142 /* Functions handling global labels */
143 /*****************************************************************************/
147 void g_defgloblabel (const char* Name);
148 /* Define a global label with the given name */
150 void g_defexport (const char* Name, int ZP);
151 /* Export the given label */
153 void g_defimport (const char* Name, int ZP);
154 /* Import the given label */
156 void g_importstartup (void);
157 /* Forced import of the startup segment */
159 void g_importmainargs (void);
160 /* Forced import of a special symbol that handles arguments to main */
164 /*****************************************************************************/
166 /*****************************************************************************/
170 int pop (unsigned flags);
171 /* Pop an argument of the given size */
173 int push (unsigned flags);
174 /* Push an argument of the given size */
176 unsigned sizeofarg (unsigned flags);
177 /* Return the size of a function argument type that is encoded in flags */
181 /*****************************************************************************/
182 /* type conversion and similiar stuff */
183 /*****************************************************************************/
187 void g_toslong (unsigned flags);
188 /* Make sure, the value on TOS is a long. Convert if necessary */
190 void g_tosint (unsigned flags);
191 /* Make sure, the value on TOS is an int. Convert if necessary */
193 void g_regint (unsigned Flags);
194 /* Make sure, the value in the primary register an int. Convert if necessary */
196 void g_reglong (unsigned Flags);
197 /* Make sure, the value in the primary register a long. Convert if necessary */
199 unsigned g_typeadjust (unsigned lhs, unsigned rhs);
200 /* Adjust the integer operands before doing a binary operation. lhs is a flags
201 * value, that corresponds to the value on TOS, rhs corresponds to the value
202 * in (e)ax. The return value is the the flags value for the resulting type.
205 unsigned g_typecast (unsigned lhs, unsigned rhs);
206 /* Cast the value in the primary register to the operand size that is flagged
207 * by the lhs value. Return the result value.
210 void g_scale (unsigned flags, long val);
211 /* Scale the value in the primary register by the given value. If val is positive,
212 * scale up, is val is negative, scale down. This function is used to scale
213 * the operands or results of pointer arithmetic by the size of the type, the
219 /*****************************************************************************/
220 /* Function entry and exit */
221 /*****************************************************************************/
225 void g_enter (unsigned flags, unsigned argsize);
226 /* Function prologue */
229 /* Function epilogue */
233 /*****************************************************************************/
234 /* Register variables */
235 /*****************************************************************************/
239 void g_swap_regvars (int StackOffs, int RegOffs, unsigned Bytes);
240 /* Swap a register variable with a location on the stack */
242 void g_save_regvars (int RegOffs, unsigned Bytes);
243 /* Save register variables */
245 void g_restore_regvars (int StackOffs, int RegOffs, unsigned Bytes);
246 /* Restore register variables */
250 /*****************************************************************************/
251 /* Fetching memory cells */
252 /*****************************************************************************/
256 void g_getimmed (unsigned Flags, unsigned long Val, long Offs);
257 /* Load a constant into the primary register */
259 void g_getstatic (unsigned Flags, unsigned long Label, long Offs);
260 /* Fetch an static memory cell into the primary register */
262 void g_getlocal (unsigned Flags, int Offs);
263 /* Fetch specified local object (local var). */
265 void g_getind (unsigned Flags, unsigned Offs);
266 /* Fetch the specified object type indirect through the primary register
267 * into the primary register
270 void g_leasp (int Offs);
271 /* Fetch the address of the specified symbol into the primary register */
273 void g_leavariadic (int Offs);
274 /* Fetch the address of a parameter in a variadic function into the primary
280 /*****************************************************************************/
281 /* Store into memory */
282 /*****************************************************************************/
286 void g_putstatic (unsigned flags, unsigned long label, long offs);
287 /* Store the primary register into the specified static memory cell */
289 void g_putlocal (unsigned Flags, int Offs, long Val);
290 /* Put data into local object. */
292 void g_putind (unsigned flags, unsigned offs);
293 /* Store the specified object type in the primary register at the address
294 * on the top of the stack
299 /*****************************************************************************/
300 /* Adds and subs of variables fix a fixed address */
301 /*****************************************************************************/
305 void g_addlocal (unsigned flags, int offs);
306 /* Add a local variable to ax */
308 void g_addstatic (unsigned flags, unsigned long label, long offs);
309 /* Add a static variable to ax */
313 /*****************************************************************************/
314 /* Special op= functions */
315 /*****************************************************************************/
319 void g_addeqstatic (unsigned flags, unsigned long label, long offs,
321 /* Emit += for a static variable */
323 void g_addeqlocal (unsigned flags, int offs, unsigned long val);
324 /* Emit += for a local variable */
326 void g_addeqind (unsigned flags, unsigned offs, unsigned long val);
327 /* Emit += for the location with address in ax */
329 void g_subeqstatic (unsigned flags, unsigned long label, long offs,
331 /* Emit -= for a static variable */
333 void g_subeqlocal (unsigned flags, int offs, unsigned long val);
334 /* Emit -= for a local variable */
336 void g_subeqind (unsigned flags, unsigned offs, unsigned long val);
337 /* Emit -= for the location with address in ax */
341 /*****************************************************************************/
342 /* Add a variable address to the value in ax */
343 /*****************************************************************************/
347 void g_addaddr_local (unsigned flags, int offs);
348 /* Add the address of a local variable to ax */
350 void g_addaddr_static (unsigned flags, unsigned long label, long offs);
351 /* Add the address of a static variable to ax */
355 /*****************************************************************************/
357 /*****************************************************************************/
361 void g_save (unsigned flags);
362 /* Copy primary register to hold register. */
364 void g_restore (unsigned flags);
365 /* Copy hold register to primary. */
367 void g_cmp (unsigned flags, unsigned long val);
368 /* Immidiate compare. The primary register will not be changed, Z flag
372 void g_test (unsigned flags);
373 /* Test the value in the primary and set the condition codes */
375 void g_push (unsigned flags, unsigned long val);
376 /* Push the primary register or a constant value onto the stack */
378 void g_swap (unsigned flags);
379 /* Swap the primary register and the top of the stack. flags give the type
380 * of *both* values (must have same size).
383 void g_call (unsigned Flags, const char* Label, unsigned ArgSize);
384 /* Call the specified subroutine name */
386 void g_callind (unsigned Flags, unsigned ArgSize, int Offs);
387 /* Call subroutine indirect */
389 void g_jump (unsigned Label);
390 /* Jump to specified internal label number */
392 void g_truejump (unsigned flags, unsigned label);
393 /* Jump to label if zero flag clear */
395 void g_falsejump (unsigned flags, unsigned label);
396 /* Jump to label if zero flag set */
398 void g_space (int space);
399 /* Create or drop space on the stack */
401 void g_cstackcheck (void);
402 /* Check for a C stack overflow */
404 void g_stackcheck (void);
405 /* Check for a stack overflow */
407 void g_add (unsigned flags, unsigned long val);
408 void g_sub (unsigned flags, unsigned long val);
409 void g_rsub (unsigned flags, unsigned long val);
410 void g_mul (unsigned flags, unsigned long val);
411 void g_div (unsigned flags, unsigned long val);
412 void g_mod (unsigned flags, unsigned long val);
413 void g_or (unsigned flags, unsigned long val);
414 void g_xor (unsigned flags, unsigned long val);
415 void g_and (unsigned flags, unsigned long val);
416 void g_asr (unsigned flags, unsigned long val);
417 void g_asl (unsigned flags, unsigned long val);
418 void g_neg (unsigned flags);
419 void g_bneg (unsigned flags);
420 void g_com (unsigned flags);
421 void g_inc (unsigned flags, unsigned long n);
422 void g_dec (unsigned flags, unsigned long n);
423 void g_eq (unsigned flags, unsigned long val);
424 void g_ne (unsigned flags, unsigned long val);
425 void g_lt (unsigned flags, unsigned long val);
426 void g_le (unsigned flags, unsigned long val);
427 void g_gt (unsigned flags, unsigned long val);
428 void g_ge (unsigned flags, unsigned long val);
430 void g_res (unsigned n);
431 /* Reserve static storage, n bytes */
433 void g_defdata (unsigned flags, unsigned long val, long offs);
434 /* Define data with the size given in flags */
436 void g_defbytes (const void* bytes, unsigned count);
437 /* Output a row of bytes as a constant */
439 void g_zerobytes (unsigned Count);
440 /* Output Count bytes of data initialized with zero */
442 void g_initregister (unsigned Label, unsigned Reg, unsigned Size);
443 /* Initialize a register variable from static initialization data */
445 void g_initauto (unsigned Label, unsigned Size);
446 /* Initialize a local variable at stack offset zero from static data */
448 void g_initstatic (unsigned InitLabel, unsigned VarLabel, unsigned Size);
449 /* Initialize a static local variable from static initialization data */
453 /*****************************************************************************/
454 /* Switch statement */
455 /*****************************************************************************/
459 void g_switch (Collection* Nodes, unsigned DefaultLabel, unsigned Depth);
460 /* Generate code for a switch statement */
464 /*****************************************************************************/
465 /* User supplied assembler code */
466 /*****************************************************************************/
470 void g_asmcode (struct StrBuf* B);
471 /* Output one line of assembler code. */
475 /* End of codegen.h */