git.sur5r.net Git - cc65/blob - src/cc65/function.c

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                function.c                                 */
   4 /*                                                                           */
   5 /*                      Parse function entry/body/exit                       */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2000-2012, 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 /* common */
  37 #include "check.h"
  38 #include "xmalloc.h"
  39
  40 /* cc65 */
  41 #include "asmcode.h"
  42 #include "asmlabel.h"
  43 #include "codegen.h"
  44 #include "error.h"
  45 #include "funcdesc.h"
  46 #include "global.h"
  47 #include "litpool.h"
  48 #include "locals.h"
  49 #include "scanner.h"
  50 #include "stackptr.h"
  51 #include "standard.h"
  52 #include "stmt.h"
  53 #include "symtab.h"
  54 #include "function.h"
  55
  56
  57
  58 /*****************************************************************************/
  59 /*                                   Data                                    */
  60 /*****************************************************************************/
  61
  62
  63
  64 /* Enumeration for function flags */
  65 typedef enum {
  66     FF_NONE             = 0x0000,
  67     FF_HAS_RETURN       = 0x0001,       /* Function has a return statement */
  68     FF_IS_MAIN          = 0x0002,       /* This is the main function */
  69     FF_VOID_RETURN      = 0x0004,       /* Function returning void */
  70 } funcflags_t;
  71
  72 /* Structure that holds all data needed for function activation */
  73 struct Function {
  74     struct SymEntry*    FuncEntry;      /* Symbol table entry */
  75     Type*               ReturnType;     /* Function return type */
  76     FuncDesc*           Desc;           /* Function descriptor */
  77     int                 Reserved;       /* Reserved local space */
  78     unsigned            RetLab;         /* Return code label */
  79     int                 TopLevelSP;     /* SP at function top level */
  80     unsigned            RegOffs;        /* Register variable space offset */
  81     funcflags_t         Flags;          /* Function flags */
  82 };
  83
  84 /* Pointer to current function */
  85 Function* CurrentFunc = 0;
  86
  87
  88
  89 /*****************************************************************************/
  90 /*                 Subroutines working with struct Function                  */
  91 /*****************************************************************************/
  92
  93
  94
  95 static Function* NewFunction (struct SymEntry* Sym)
  96 /* Create a new function activation structure and return it */
  97 {
  98     /* Allocate a new structure */
  99     Function* F = (Function*) xmalloc (sizeof (Function));
 100
 101     /* Initialize the fields */
 102     F->FuncEntry  = Sym;
 103     F->ReturnType = GetFuncReturn (Sym->Type);
 104     F->Desc       = GetFuncDesc (Sym->Type);
 105     F->Reserved   = 0;
 106     F->RetLab     = GetLocalLabel ();
 107     F->TopLevelSP = 0;
 108     F->RegOffs    = RegisterSpace;
 109     F->Flags      = IsTypeVoid (F->ReturnType) ? FF_VOID_RETURN : FF_NONE;
 110
 111     /* Return the new structure */
 112     return F;
 113 }
 114
 115
 116
 117 static void FreeFunction (Function* F)
 118 /* Free a function activation structure */
 119 {
 120     xfree (F);
 121 }
 122
 123
 124
 125 const char* F_GetFuncName (const Function* F)
 126 /* Return the name of the current function */
 127 {
 128     return F->FuncEntry->Name;
 129 }
 130
 131
 132
 133 unsigned F_GetParamCount (const Function* F)
 134 /* Return the parameter count for the current function */
 135 {
 136     return F->Desc->ParamCount;
 137 }
 138
 139
 140
 141 unsigned F_GetParamSize (const Function* F)
 142 /* Return the parameter size for the current function */
 143 {
 144     return F->Desc->ParamSize;
 145 }
 146
 147
 148
 149 Type* F_GetReturnType (Function* F)
 150 /* Get the return type for the function */
 151 {
 152     return F->ReturnType;
 153 }
 154
 155
 156
 157 int F_HasVoidReturn (const Function* F)
 158 /* Return true if the function does not have a return value */
 159 {
 160     return (F->Flags & FF_VOID_RETURN) != 0;
 161 }
 162
 163
 164
 165 void F_ReturnFound (Function* F)
 166 /* Mark the function as having a return statement */
 167 {
 168     F->Flags |= FF_HAS_RETURN;
 169 }
 170
 171
 172
 173 int F_HasReturn (const Function* F)
 174 /* Return true if the function contains a return statement*/
 175 {
 176     return (F->Flags & FF_HAS_RETURN) != 0;
 177 }
 178
 179
 180
 181 int F_IsMainFunc (const Function* F)
 182 /* Return true if this is the main function */
 183 {
 184     return (F->Flags & FF_IS_MAIN) != 0;
 185 }
 186
 187
 188
 189 int F_IsVariadic (const Function* F)
 190 /* Return true if this is a variadic function */
 191 {
 192     return (F->Desc->Flags & FD_VARIADIC) != 0;
 193 }
 194
 195
 196
 197 int F_IsOldStyle (const Function* F)
 198 /* Return true if this is an old style (K&R) function */
 199 {
 200     return (F->Desc->Flags & FD_OLDSTYLE) != 0;
 201 }
 202
 203
 204
 205 int F_HasOldStyleIntRet (const Function* F)
 206 /* Return true if this is an old style (K&R) function with an implicit int return */
 207 {
 208     return (F->Desc->Flags & FD_OLDSTYLE_INTRET) != 0;
 209 }
 210
 211
 212
 213 unsigned F_GetRetLab (const Function* F)
 214 /* Return the return jump label */
 215 {
 216     return F->RetLab;
 217 }
 218
 219
 220
 221 int F_GetTopLevelSP (const Function* F)
 222 /* Get the value of the stack pointer on function top level */
 223 {
 224     return F->TopLevelSP;
 225 }
 226
 227
 228
 229 int F_ReserveLocalSpace (Function* F, unsigned Size)
 230 /* Reserve (but don't allocate) the given local space and return the stack
 231  * offset.
 232  */
 233 {
 234     F->Reserved += Size;
 235     return StackPtr - F->Reserved;
 236 }
 237
 238
 239
 240 int F_GetStackPtr (const Function* F)
 241 /* Return the current stack pointer including reserved (but not allocated)
 242  * space on the stack.
 243  */
 244 {
 245     return StackPtr - F->Reserved;
 246 }
 247
 248
 249
 250 void F_AllocLocalSpace (Function* F)
 251 /* Allocate any local space previously reserved. The function will do
 252  * nothing if there is no reserved local space.
 253  */
 254 {
 255     if (F->Reserved > 0) {
 256
 257         /* Create space on the stack */
 258         g_space (F->Reserved);
 259
 260         /* Correct the stack pointer */
 261         StackPtr -= F->Reserved;
 262
 263         /* Nothing more reserved */
 264         F->Reserved = 0;
 265     }
 266 }
 267
 268
 269
 270 int F_AllocRegVar (Function* F, const Type* Type)
 271 /* Allocate a register variable for the given variable type. If the allocation
 272  * was successful, return the offset of the register variable in the register
 273  * bank (zero page storage). If there is no register space left, return -1.
 274  */
 275 {
 276     /* Allow register variables only on top level and if enabled */
 277     if (IS_Get (&EnableRegVars) && GetLexicalLevel () == LEX_LEVEL_FUNCTION) {
 278
 279         /* Get the size of the variable */
 280         unsigned Size = CheckedSizeOf (Type);
 281
 282         /* Do we have space left? */
 283         if (F->RegOffs >= Size) {
 284             /* Space left. We allocate the variables from high to low addresses,
 285              * so the adressing is compatible with the saved values on stack.
 286              * This allows shorter code when saving/restoring the variables.
 287              */
 288             F->RegOffs -= Size;
 289             return F->RegOffs;
 290         }
 291     }
 292
 293     /* No space left or no allocation */
 294     return -1;
 295 }
 296
 297
 298
 299 static void F_RestoreRegVars (Function* F)
 300 /* Restore the register variables for the local function if there are any. */
 301 {
 302     const SymEntry* Sym;
 303
 304     /* If we don't have register variables in this function, bail out early */
 305     if (F->RegOffs == RegisterSpace) {
 306         return;
 307     }
 308
 309     /* Save the accumulator if needed */
 310     if (!F_HasVoidReturn (F)) {
 311         g_save (CF_CHAR | CF_FORCECHAR);
 312     }
 313
 314     /* Get the first symbol from the function symbol table */
 315     Sym = F->FuncEntry->V.F.Func->SymTab->SymHead;
 316
 317     /* Walk through all symbols checking for register variables */
 318     while (Sym) {
 319         if (SymIsRegVar (Sym)) {
 320
 321             /* Check for more than one variable */
 322             int Offs       = Sym->V.R.SaveOffs;
 323             unsigned Bytes = CheckedSizeOf (Sym->Type);
 324
 325             while (1) {
 326
 327                 /* Find next register variable */
 328                 const SymEntry* NextSym = Sym->NextSym;
 329                 while (NextSym && !SymIsRegVar (NextSym)) {
 330                     NextSym = NextSym->NextSym;
 331                 }
 332
 333                 /* If we have a next one, compare the stack offsets */
 334                 if (NextSym) {
 335
 336                     /* We have a following register variable. Get the size */
 337                     int Size = CheckedSizeOf (NextSym->Type);
 338
 339                     /* Adjacent variable? */
 340                     if (NextSym->V.R.SaveOffs + Size != Offs) {
 341                         /* No */
 342                         break;
 343                     }
 344
 345                     /* Adjacent variable */
 346                     Bytes += Size;
 347                     Offs  -= Size;
 348                     Sym   = NextSym;
 349
 350                 } else {
 351                     break;
 352                 }
 353             }
 354
 355             /* Restore the memory range */
 356             g_restore_regvars (Offs, Sym->V.R.RegOffs, Bytes);
 357
 358         }
 359
 360         /* Check next symbol */
 361         Sym = Sym->NextSym;
 362     }
 363
 364     /* Restore the accumulator if needed */
 365     if (!F_HasVoidReturn (F)) {
 366         g_restore (CF_CHAR | CF_FORCECHAR);
 367     }
 368 }
 369
 370
 371
 372 static void F_EmitDebugInfo (void)
 373 /* Emit debug infos for the current function */
 374 {
 375     if (DebugInfo) {
 376         /* Get the current function */
 377         const SymEntry* Sym = CurrentFunc->FuncEntry;
 378
 379         /* Output info for the function itself */
 380         AddTextLine ("\t.dbg\tfunc, \"%s\", \"00\", %s, \"%s\"",
 381                      Sym->Name,
 382                      (Sym->Flags & SC_EXTERN)? "extern" : "static",
 383                      Sym->AsmName);
 384     }
 385 }
 386
 387
 388
 389 /*****************************************************************************/
 390 /*                                   code                                    */
 391 /*****************************************************************************/
 392
 393
 394
 395 void NewFunc (SymEntry* Func)
 396 /* Parse argument declarations and function body. */
 397 {
 398     int         C99MainFunc = 0;/* Flag for C99 main function returning int */
 399     SymEntry*   Param;
 400
 401     /* Get the function descriptor from the function entry */
 402     FuncDesc* D = Func->V.F.Func;
 403
 404     /* Allocate the function activation record for the function */
 405     CurrentFunc = NewFunction (Func);
 406
 407     /* Reenter the lexical level */
 408     ReenterFunctionLevel (D);
 409
 410     /* Check if the function header contains unnamed parameters. These are
 411      * only allowed in cc65 mode.
 412      */
 413     if ((D->Flags & FD_UNNAMED_PARAMS) != 0 && (IS_Get (&Standard) != STD_CC65)) {
 414         Error ("Parameter name omitted");
 415     }
 416
 417     /* Declare two special functions symbols: __fixargs__ and __argsize__.
 418      * The latter is different depending on the type of the function (variadic
 419      * or not).
 420      */
 421     AddConstSym ("__fixargs__", type_uint, SC_DEF | SC_CONST, D->ParamSize);
 422     if (D->Flags & FD_VARIADIC) {
 423         /* Variadic function. The variable must be const. */
 424         static const Type T[] = { TYPE(T_UCHAR | T_QUAL_CONST), TYPE(T_END) };
 425         AddLocalSym ("__argsize__", T, SC_DEF | SC_REF | SC_AUTO, 0);
 426     } else {
 427         /* Non variadic */
 428         AddConstSym ("__argsize__", type_uchar, SC_DEF | SC_CONST, D->ParamSize);
 429     }
 430
 431     /* Function body now defined */
 432     Func->Flags |= SC_DEF;
 433
 434     /* Special handling for main() */
 435     if (strcmp (Func->Name, "main") == 0) {
 436
 437         /* Mark this as the main function */
 438         CurrentFunc->Flags |= FF_IS_MAIN;
 439
 440         /* Main cannot be a fastcall function */
 441         if (IsQualFastcall (Func->Type)) {
 442             Error ("`main' cannot be declared as __fastcall__");
 443         }
 444
 445         /* If cc65 extensions aren't enabled, don't allow a main function that
 446          * doesn't return an int.
 447          */
 448         if (IS_Get (&Standard) != STD_CC65 && CurrentFunc->ReturnType[0].C != T_INT) {
 449             Error ("`main' must always return an int");
 450         }
 451
 452         /* Add a forced import of a symbol that is contained in the startup
 453          * code. This will force the startup code to be linked in.
 454          */
 455         g_importstartup ();
 456
 457         /* If main() takes parameters, generate a forced import to a function
 458          * that will setup these parameters. This way, programs that do not
 459          * need the additional code will not get it.
 460          */
 461         if (D->ParamCount > 0 || (D->Flags & FD_VARIADIC) != 0) {
 462             g_importmainargs ();
 463         }
 464
 465         /* Determine if this is a main function in a C99 environment that
 466          * returns an int.
 467          */
 468         if (IsTypeInt (F_GetReturnType (CurrentFunc)) &&
 469             IS_Get (&Standard) == STD_C99) {
 470             C99MainFunc = 1;
 471         }
 472     }
 473
 474     /* Allocate code and data segments for this function */
 475     Func->V.F.Seg = PushSegments (Func);
 476
 477     /* Allocate a new literal pool */
 478     PushLiteralPool (Func);
 479
 480     /* If this is a fastcall function, push the last parameter onto the stack */
 481     if (IsQualFastcall (Func->Type) && D->ParamCount > 0) {
 482
 483         unsigned Flags;
 484
 485         /* Fastcall functions may never have an ellipsis or the compiler is buggy */
 486         CHECK ((D->Flags & FD_VARIADIC) == 0);
 487
 488         /* Generate the push */
 489         if (IsTypeFunc (D->LastParam->Type)) {
 490             /* Pointer to function */
 491             Flags = CF_PTR;
 492         } else {
 493             Flags = TypeOf (D->LastParam->Type) | CF_FORCECHAR;
 494         }
 495         g_push (Flags, 0);
 496     }
 497
 498     /* Generate function entry code if needed */
 499     g_enter (TypeOf (Func->Type), F_GetParamSize (CurrentFunc));
 500
 501     /* If stack checking code is requested, emit a call to the helper routine */
 502     if (IS_Get (&CheckStack)) {
 503         g_stackcheck ();
 504     }
 505
 506     /* Setup the stack */
 507     StackPtr = 0;
 508
 509     /* Walk through the parameter list and allocate register variable space
 510      * for parameters declared as register. Generate code to swap the contents
 511      * of the register bank with the save area on the stack.
 512      */
 513     Param = D->SymTab->SymHead;
 514     while (Param && (Param->Flags & SC_PARAM) != 0) {
 515
 516         /* Check for a register variable */
 517         if (SymIsRegVar (Param)) {
 518
 519             /* Allocate space */
 520             int Reg = F_AllocRegVar (CurrentFunc, Param->Type);
 521
 522             /* Could we allocate a register? */
 523             if (Reg < 0) {
 524                 /* No register available: Convert parameter to auto */
 525                 CvtRegVarToAuto (Param);
 526             } else {
 527                 /* Remember the register offset */
 528                 Param->V.R.RegOffs = Reg;
 529
 530                 /* Generate swap code */
 531                 g_swap_regvars (Param->V.R.SaveOffs, Reg, CheckedSizeOf (Param->Type));
 532             }
 533         }
 534
 535         /* Next parameter */
 536         Param = Param->NextSym;
 537     }
 538
 539     /* Need a starting curly brace */
 540     ConsumeLCurly ();
 541
 542     /* Parse local variable declarations if any */
 543     DeclareLocals ();
 544
 545     /* Remember the current stack pointer. All variables allocated elsewhere
 546      * must be dropped when doing a return from an inner block.
 547      */
 548     CurrentFunc->TopLevelSP = StackPtr;
 549
 550     /* Now process statements in this block */
 551     while (CurTok.Tok != TOK_RCURLY && CurTok.Tok != TOK_CEOF) {
 552         Statement (0);
 553     }
 554
 555     /* If this is not a void function, and not the main function in a C99
 556      * environment returning int, output a warning if we didn't see a return
 557      * statement.
 558      */
 559     if (!F_HasVoidReturn (CurrentFunc) && !F_HasReturn (CurrentFunc) && !C99MainFunc) {
 560         Warning ("Control reaches end of non-void function");
 561     }
 562
 563     /* If this is the main function in a C99 environment returning an int, let
 564      * it always return zero. Note: Actual return statements jump to the return
 565      * label defined below.
 566      * The code is removed by the optimizer if unused.
 567      */
 568     if (C99MainFunc) {
 569         g_getimmed (CF_INT | CF_CONST, 0, 0);
 570     }
 571
 572     /* Output the function exit code label */
 573     g_defcodelabel (F_GetRetLab (CurrentFunc));
 574
 575     /* Restore the register variables */
 576     F_RestoreRegVars (CurrentFunc);
 577
 578     /* Generate the exit code */
 579     g_leave ();
 580
 581     /* Emit references to imports/exports */
 582     EmitExternals ();
 583
 584     /* Emit function debug info */
 585     F_EmitDebugInfo ();
 586     EmitDebugInfo ();
 587
 588     /* Leave the lexical level */
 589     LeaveFunctionLevel ();
 590
 591     /* Eat the closing brace */
 592     ConsumeRCurly ();
 593
 594     /* Restore the old literal pool, remembering the one for the function */
 595     Func->V.F.LitPool = PopLiteralPool ();
 596
 597     /* Switch back to the old segments */
 598     PopSegments ();
 599
 600     /* Reset the current function pointer */
 601     FreeFunction (CurrentFunc);
 602     CurrentFunc = 0;
 603 }
 604
 605
 606