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