cc65 internals

Brad Smith

2016-02-27
Internal details of cc65 code generation, such as calling assembly functions from C.

1. Calling assembly functions from C


1. Calling assembly functions from C

1.1 Calling conventions

There are two calling conventions used in cc65:

The default convention is fastcall, but this can be changed with the --all-cdecl command line option. If a convention is specified in the function's declaration, that convention will be used instead. Variadic functions will always use cdecl convention.

If the --standard command line option is used, the cdecl and fastcall keywords will not be available. The standard compliant variations __cdecl__ and __fastcall__ are always available.

If a function has a prototype, parameters are pushed to the C-stack as their respective types (i.e. a char parameter will push 1 byte), but if a function has no prototype, default promotions will apply. This means that with no prototype, char will be promoted to int and be pushed as 2 bytes. K & R style function prototypes may be used, but they will function the same as if no prototype was used.

1.2 Prologue, before the function call

If the function is declared as fastcall, the rightmost argument will be loaded into the A/X/sreg registers:

All other parameters will be pushed to the C-stack from left to right. The rightmost parameter will have the lowest address on the stack, and multi-byte parameters will have their least significant byte at the lower address.

The sp pseudo-register is a zeropage pointer to the base of the C-stack. If the function has no prototype or is variadic the Y register will contain the number of bytes pushed to the stack for this function.

Example:

// C prototype
void cdecl foo(unsigned bar, unsigned char baz);

; C-stack layout within the function:
;
;            +------------------+
;            | High byte of bar |
; Offset 2 ->+------------------+
;            | Low byte of bar  |
; Offset 1 ->+------------------+
;            | baz              |
; Offset 0 ->+------------------+

; Example code for accessing bar. The variable is in A/X after this code snippet:
;
    ldy     #2      ; Offset of high byte of bar
    lda     (sp),y  ; High byte now in A
    tax             ; High byte now in X
    dey             ; Offset of low byte of bar
    lda     (sp),y  ; Low byte now in A

1.3 Epilogue, after the function call

Return requirements

If the function has a return value, it will appear in the A/X/sreg registers.

Functions with an 8-bit return value (char or unsigned char) are expected to promote this value to a 16-bit integer on return, and store the high byte in X. The compiler will depend on the promoted value in some cases (e.g. implicit conversion to int), and failure to return the high byte in X will cause unexpected errors. This problem does not apply to the sreg pseudo-register, which is only used if the return type is 32-bit.

If the function has a void return type, the compiler will not depend on the result of A/X/sreg, so these may be clobbered by the function.

The C-stack pointer sp must be restored by the function to its value before the function call prologue. It may pop all of its parameters from the C-stack (e.g. using the runtime function popa), or it could adjust sp directly. If the function has no prototype, or is variadic the Y register contains the number of bytes pushed to the stack on entry, which may be added to sp to restore its original state.

The internal pseudo-register regbank must not be changed by the function.

Clobbered state

The Y register may be clobbered by the function. The compiler will not depend on its state after a function call.

The A/X/sreg registers may be clobbered if any of them are not used by the return value (see above).

Many of the internal pseudo-registers used by cc65 are available for free use by any function called by C, and do not need to be preserved. Note that if another C function is called from your assembly function, it may clobber any of these itself: