git.sur5r.net Git - cc65/blob - src/cc65/codegen.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 codegen.h                                 */
   4 /*                                                                           */
   5 /*                            6502 code generator                            */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998-2003 Ullrich von Bassewitz                                       */
  10 /*               Römerstrasse 52                                             */
  11 /*               D-70794 Filderstadt                                         */
  12 /* EMail:        uz@cc65.org                                                 */
  13 /*                                                                           */
  14 /*                                                                           */
  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.                                    */
  18 /*                                                                           */
  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:                            */
  22 /*                                                                           */
  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              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #ifndef CODEGEN_H
  37 #define CODEGEN_H
  38
  39
  40
  41 /* common */
  42 #include "coll.h"
  43
  44 /* cc65 */
  45 #include "segments.h"
  46
  47
  48
  49 /*****************************************************************************/
  50 /*                                   Data                                    */
  51 /*****************************************************************************/
  52
  53
  54
  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.
  58  */
  59 #define CF_NONE         0x0000  /* No special flags */
  60
  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
  67 #define CF_NOKEEP       0x0008  /* Value may get destroyed when storing */
  68
  69 #define CF_UNSIGNED     0x0010  /* Value is unsigned */
  70 #define CF_CONST        0x0020  /* Constant value available */
  71 #define CF_CONSTADDR    0x0040  /* Constant address value available */
  72 #define CF_TEST         0x0080  /* Test value */
  73 #define CF_FIXARGC      0x0100  /* Function has fixed arg count */
  74 #define CF_FORCECHAR    0x0200  /* Handle chars as chars, not ints */
  75 #define CF_REG          0x0800  /* Value is in primary register */
  76
  77 /* Type of static address */
  78 #define CF_ADDRMASK     0xF000  /* Type of address */
  79 #define CF_STATIC       0x0000  /* Static local */
  80 #define CF_EXTERNAL     0x1000  /* Static external */
  81 #define CF_ABSOLUTE     0x2000  /* Numeric absolute address */
  82 #define CF_LOCAL        0x4000  /* Auto variable */
  83 #define CF_REGVAR       0x8000  /* Register variable */
  84
  85
  86
  87 /* Compiler relative stackpointer */
  88 extern int oursp;
  89
  90 /* Forward */
  91 struct StrBuf;
  92
  93
  94
  95 /*****************************************************************************/
  96 /*                         Files, pre- and postamble                         */
  97 /*****************************************************************************/
  98
  99
 100
 101 void g_preamble (void);
 102 /* Generate the assembler code preamble */
 103
 104 void g_fileinfo (const char* Name, unsigned long Size, unsigned long MTime);
 105 /* If debug info is enabled, place a file info into the source */
 106
 107
 108
 109 /*****************************************************************************/
 110 /*                              Segment support                              */
 111 /*****************************************************************************/
 112
 113
 114
 115 void g_userodata (void);
 116 /* Switch to the read only data segment */
 117
 118 void g_usedata (void);
 119 /* Switch to the data segment */
 120
 121 void g_usebss (void);
 122 /* Switch to the bss segment */
 123
 124 void g_segname (segment_t Seg, const char* Name);
 125 /* Set the name of a segment */
 126
 127
 128
 129 /*****************************************************************************/
 130 /*                      Functions handling local labels                      */
 131 /*****************************************************************************/
 132
 133
 134
 135 void g_defcodelabel (unsigned label);
 136 /* Define a local code label */
 137
 138 void g_defdatalabel (unsigned label);
 139 /* Define a local data label */
 140
 141
 142
 143 /*****************************************************************************/
 144 /*                     Functions handling global labels                      */
 145 /*****************************************************************************/
 146
 147
 148
 149 void g_defgloblabel (const char* Name);
 150 /* Define a global label with the given name */
 151
 152 void g_defexport (const char* Name, int ZP);
 153 /* Export the given label */
 154
 155 void g_defimport (const char* Name, int ZP);
 156 /* Import the given label */
 157
 158 void g_importmainargs (void);
 159 /* Forced import of a special symbol that handles arguments to main */
 160
 161
 162
 163 /*****************************************************************************/
 164 /*                                   stack                                   */
 165 /*****************************************************************************/
 166
 167
 168
 169 int pop (unsigned flags);
 170 /* Pop an argument of the given size */
 171
 172 int push (unsigned flags);
 173 /* Push an argument of the given size */
 174
 175 unsigned sizeofarg (unsigned flags);
 176 /* Return the size of a function argument type that is encoded in flags */
 177
 178
 179
 180 /*****************************************************************************/
 181 /*                    type conversion and similiar stuff                     */
 182 /*****************************************************************************/
 183
 184
 185
 186 void g_toslong (unsigned flags);
 187 /* Make sure, the value on TOS is a long. Convert if necessary */
 188
 189 void g_tosint (unsigned flags);
 190 /* Make sure, the value on TOS is an int. Convert if necessary */
 191
 192 void g_regint (unsigned Flags);
 193 /* Make sure, the value in the primary register an int. Convert if necessary */
 194
 195 void g_reglong (unsigned Flags);
 196 /* Make sure, the value in the primary register a long. Convert if necessary */
 197
 198 unsigned g_typeadjust (unsigned lhs, unsigned rhs);
 199 /* Adjust the integer operands before doing a binary operation. lhs is a flags
 200  * value, that corresponds to the value on TOS, rhs corresponds to the value
 201  *  in (e)ax. The return value is the the flags value for the resulting type.
 202  */
 203
 204 unsigned g_typecast (unsigned lhs, unsigned rhs);
 205 /* Cast the value in the primary register to the operand size that is flagged
 206  * by the lhs value. Return the result value.
 207  */
 208
 209 void g_scale (unsigned flags, long val);
 210 /* Scale the value in the primary register by the given value. If val is positive,
 211  * scale up, is val is negative, scale down. This function is used to scale
 212  * the operands or results of pointer arithmetic by the size of the type, the
 213  * pointer points to.
 214  */
 215
 216
 217
 218 /*****************************************************************************/
 219 /*                          Function entry and exit                          */
 220 /*****************************************************************************/
 221
 222
 223
 224 void g_enter (unsigned flags, unsigned argsize);
 225 /* Function prologue */
 226
 227 void g_leave (void);
 228 /* Function epilogue */
 229
 230
 231
 232 /*****************************************************************************/
 233 /*                            Register variables                             */
 234 /*****************************************************************************/
 235
 236
 237
 238 void g_swap_regvars (int StackOffs, int RegOffs, unsigned Bytes);
 239 /* Swap a register variable with a location on the stack */
 240
 241 void g_save_regvars (int RegOffs, unsigned Bytes);
 242 /* Save register variables */
 243
 244 void g_restore_regvars (int StackOffs, int RegOffs, unsigned Bytes);
 245 /* Restore register variables */
 246
 247
 248
 249 /*****************************************************************************/
 250 /*                           Fetching memory cells                           */
 251 /*****************************************************************************/
 252
 253
 254
 255 void g_getimmed (unsigned Flags, unsigned long Val, long Offs);
 256 /* Load a constant into the primary register */
 257
 258 void g_getstatic (unsigned Flags, unsigned long Label, long Offs);
 259 /* Fetch an static memory cell into the primary register */
 260
 261 void g_getlocal (unsigned Flags, int Offs);
 262 /* Fetch specified local object (local var). */
 263
 264 void g_getind (unsigned Flags, unsigned Offs);
 265 /* Fetch the specified object type indirect through the primary register
 266  * into the primary register
 267  */
 268
 269 void g_leasp (int Offs);
 270 /* Fetch the address of the specified symbol into the primary register */
 271
 272 void g_leavariadic (int Offs);
 273 /* Fetch the address of a parameter in a variadic function into the primary
 274  * register
 275  */
 276
 277
 278
 279 /*****************************************************************************/
 280 /*                             Store into memory                             */
 281 /*****************************************************************************/
 282
 283
 284
 285 void g_putstatic (unsigned flags, unsigned long label, long offs);
 286 /* Store the primary register into the specified static memory cell */
 287
 288 void g_putlocal (unsigned Flags, int Offs, long Val);
 289 /* Put data into local object. */
 290
 291 void g_putind (unsigned flags, unsigned offs);
 292 /* Store the specified object type in the primary register at the address
 293  * on the top of the stack
 294  */
 295
 296
 297
 298 /*****************************************************************************/
 299 /*              Adds and subs of variables fix a fixed address               */
 300 /*****************************************************************************/
 301
 302
 303
 304 void g_addlocal (unsigned flags, int offs);
 305 /* Add a local variable to ax */
 306
 307 void g_addstatic (unsigned flags, unsigned long label, long offs);
 308 /* Add a static variable to ax */
 309
 310
 311
 312 /*****************************************************************************/
 313 /*                           Special op= functions                           */
 314 /*****************************************************************************/
 315
 316
 317
 318 void g_addeqstatic (unsigned flags, unsigned long label, long offs,
 319                     unsigned long val);
 320 /* Emit += for a static variable */
 321
 322 void g_addeqlocal (unsigned flags, int offs, unsigned long val);
 323 /* Emit += for a local variable */
 324
 325 void g_addeqind (unsigned flags, unsigned offs, unsigned long val);
 326 /* Emit += for the location with address in ax */
 327
 328 void g_subeqstatic (unsigned flags, unsigned long label, long offs,
 329                     unsigned long val);
 330 /* Emit -= for a static variable */
 331
 332 void g_subeqlocal (unsigned flags, int offs, unsigned long val);
 333 /* Emit -= for a local variable */
 334
 335 void g_subeqind (unsigned flags, unsigned offs, unsigned long val);
 336 /* Emit -= for the location with address in ax */
 337
 338
 339
 340 /*****************************************************************************/
 341 /*                 Add a variable address to the value in ax                 */
 342 /*****************************************************************************/
 343
 344
 345
 346 void g_addaddr_local (unsigned flags, int offs);
 347 /* Add the address of a local variable to ax */
 348
 349 void g_addaddr_static (unsigned flags, unsigned long label, long offs);
 350 /* Add the address of a static variable to ax */
 351
 352
 353
 354 /*****************************************************************************/
 355 /*                                                                           */
 356 /*****************************************************************************/
 357
 358
 359
 360 void g_save (unsigned flags);
 361 /* Copy primary register to hold register. */
 362
 363 void g_restore (unsigned flags);
 364 /* Copy hold register to primary. */
 365
 366 void g_cmp (unsigned flags, unsigned long val);
 367 /* Immidiate compare. The primary register will not be changed, Z flag
 368  * will be set.
 369  */
 370
 371 void g_test (unsigned flags);
 372 /* Test the value in the primary and set the condition codes */
 373
 374 void g_push (unsigned flags, unsigned long val);
 375 /* Push the primary register or a constant value onto the stack */
 376
 377 void g_swap (unsigned flags);
 378 /* Swap the primary register and the top of the stack. flags give the type
 379  * of *both* values (must have same size).
 380  */
 381
 382 void g_call (unsigned Flags, const char* Label, unsigned ArgSize);
 383 /* Call the specified subroutine name */
 384
 385 void g_callind (unsigned Flags, unsigned ArgSize, int Offs);
 386 /* Call subroutine indirect */
 387
 388 void g_jump (unsigned Label);
 389 /* Jump to specified internal label number */
 390
 391 void g_truejump (unsigned flags, unsigned label);
 392 /* Jump to label if zero flag clear */
 393
 394 void g_falsejump (unsigned flags, unsigned label);
 395 /* Jump to label if zero flag set */
 396
 397 void g_space (int space);
 398 /* Create or drop space on the stack */
 399
 400 void g_cstackcheck (void);
 401 /* Check for a C stack overflow */
 402
 403 void g_stackcheck (void);
 404 /* Check for a stack overflow */
 405
 406 void g_add (unsigned flags, unsigned long val);
 407 void g_sub (unsigned flags, unsigned long val);
 408 void g_rsub (unsigned flags, unsigned long val);
 409 void g_mul (unsigned flags, unsigned long val);
 410 void g_div (unsigned flags, unsigned long val);
 411 void g_mod (unsigned flags, unsigned long val);
 412 void g_or (unsigned flags, unsigned long val);
 413 void g_xor (unsigned flags, unsigned long val);
 414 void g_and (unsigned flags, unsigned long val);
 415 void g_asr (unsigned flags, unsigned long val);
 416 void g_asl (unsigned flags, unsigned long val);
 417 void g_neg (unsigned flags);
 418 void g_bneg (unsigned flags);
 419 void g_com (unsigned flags);
 420 void g_inc (unsigned flags, unsigned long n);
 421 void g_dec (unsigned flags, unsigned long n);
 422 void g_eq (unsigned flags, unsigned long val);
 423 void g_ne (unsigned flags, unsigned long val);
 424 void g_lt (unsigned flags, unsigned long val);
 425 void g_le (unsigned flags, unsigned long val);
 426 void g_gt (unsigned flags, unsigned long val);
 427 void g_ge (unsigned flags, unsigned long val);
 428
 429 void g_res (unsigned n);
 430 /* Reserve static storage, n bytes */
 431
 432 void g_defdata (unsigned flags, unsigned long val, long offs);
 433 /* Define data with the size given in flags */
 434
 435 void g_defbytes (const void* bytes, unsigned count);
 436 /* Output a row of bytes as a constant */
 437
 438 void g_zerobytes (unsigned Count);
 439 /* Output Count bytes of data initialized with zero */
 440
 441 void g_initregister (unsigned Label, unsigned Reg, unsigned Size);
 442 /* Initialize a register variable from static initialization data */
 443
 444 void g_initauto (unsigned Label, unsigned Size);
 445 /* Initialize a local variable at stack offset zero from static data */
 446
 447 void g_initstatic (unsigned InitLabel, unsigned VarLabel, unsigned Size);
 448 /* Initialize a static local variable from static initialization data */
 449
 450
 451
 452 /*****************************************************************************/
 453 /*                             Switch statement                              */
 454 /*****************************************************************************/
 455
 456
 457
 458 void g_switch (Collection* Nodes, unsigned DefaultLabel, unsigned Depth);
 459 /* Generate code for a switch statement */
 460
 461
 462
 463 /*****************************************************************************/
 464 /*                       User supplied assembler code                        */
 465 /*****************************************************************************/
 466
 467
 468
 469 void g_asmcode (struct StrBuf* B);
 470 /* Output one line of assembler code. */
 471
 472
 473
 474 /*****************************************************************************/
 475 /*                          Inlined known functions                          */
 476 /*****************************************************************************/
 477
 478
 479
 480 void g_strlen (unsigned flags, unsigned long val, long offs);
 481 /* Inline the strlen() function */
 482
 483
 484
 485 /* End of codegen.h */
 486 #endif
 487
 488