git.sur5r.net Git - cc65/blob - doc/cc65-intern.sgml

   1 <!doctype linuxdoc system>
   2
   3 <article>
   4 <title>cc65 internals
   5 <author><url url="mailto:bbbradsmith@users.noreply.github.com" name="Brad Smith">
   6
   7 <abstract>
   8 Internal details of cc65 code generation,
   9 such as calling assembly functions from C.
  10 </abstract>
  11
  12 <!-- Table of contents -->
  13 <toc>
  14
  15 <!-- Begin the document -->
  16
  17
  18
  19 <sect>Calling assembly functions from C<p>
  20
  21 <sect1>Calling conventions<p>
  22
  23 There are two calling conventions used in cc65:
  24
  25 <itemize>
  26   <item><tt/cdecl/ - passes all parameters on the C-stack.
  27   <p>
  28   <item><tt/fastcall/ - passes the rightmost parameter in
  29   registers <tt>A/X/sreg</tt> and all others on the C-stack.
  30   <p>
  31 </itemize>
  32
  33 The default convention is <tt/fastcall/, but this can be changed with
  34 the <tt/--all-cdecl/ command line option. If a convention is specified in
  35 the function's declaration, that convention will be used instead.
  36 Variadic functions will always use <tt/cdecl/ convention.
  37
  38 If the <tt/--standard/ command line option is used,
  39 the <tt/cdecl/ and <tt/fastcall/ keywords will not be available.
  40 The standard compliant variations <tt/__cdecl__/ and <tt/__fastcall__/ are always available.
  41
  42 If a function has a prototype, parameters are pushed to the C-stack as their respective types
  43 (i.e. a <tt/char/ parameter will push 1 byte), but if a function has no prototype, default
  44 promotions will apply. This means that with no prototype, <tt/char/ will be promoted
  45 to <tt/int/ and be pushed as 2 bytes. K &amp; R style function prototypes may be used,
  46 but they will function the same as if no prototype was used.
  47
  48 <sect1>Prologue, before the function call<p>
  49
  50 If the function is declared as fastcall, the rightmost argument will be loaded into
  51 the <tt>A/X/sreg</tt> registers:
  52
  53 <itemize>
  54   <item><tt/A/ - 8-bit parameter, or low byte of larger types<p>
  55   <item><tt/X/ - 16-bit high byte, or second byte of 32-bits<p>
  56   <item><tt/sreg/ - Zeropage pseudo-register including high 2 bytes of 32-bit parameter<p>
  57 </itemize>
  58
  59 All other parameters will be pushed to the C-stack from left to right.
  60 The rightmost parameter will have the lowest address on the stack,
  61 and multi-byte parameters will have their least significant byte at the lower address.
  62
  63 The <tt/sp/ pseudo-register is a zeropage pointer to the base of the C-stack.
  64 If the function has no prototype or is variadic
  65 the <tt/Y/ register will contain the number of bytes pushed to the stack for this function.
  66
  67 Example:
  68 <tscreen><verb>
  69 // C prototype
  70 void cdecl foo(unsigned bar, unsigned char baz);
  71
  72 ; C-stack layout within the function:
  73 ;
  74 ;            +------------------+
  75 ;            | High byte of bar |
  76 ; Offset 2 ->+------------------+
  77 ;            | Low byte of bar  |
  78 ; Offset 1 ->+------------------+
  79 ;            | baz              |
  80 ; Offset 0 ->+------------------+
  81
  82 ; Example code for accessing bar. The variable is in A/X after this code snippet:
  83 ;
  84     ldy     #2      ; Offset of high byte of bar
  85     lda     (sp),y  ; High byte now in A
  86     tax             ; High byte now in X
  87     dey             ; Offset of low byte of bar
  88     lda     (sp),y  ; Low byte now in A
  89 </verb></tscreen>
  90
  91 <sect1>Epilogue, after the function call<p>
  92
  93 <sect2>Return requirements<p>
  94
  95 If the function has a return value, it will appear in the <tt>A/X/sreg</tt> registers.
  96
  97 Functions with an 8-bit return value (<tt/char/ or <tt/unsigned char/) are expected
  98 to promote this value to a 16-bit integer on return, and store the high byte in <tt/X/.
  99 The compiler will depend on the promoted value in some cases (e.g. implicit conversion to <tt/int/),
 100 and failure to return the high byte in <tt/X/ will cause unexpected errors.
 101 This problem does not apply to the <tt/sreg/ pseudo-register, which is only
 102 used if the return type is 32-bit.
 103
 104 If the function has a void return type, the compiler will not depend on the result
 105 of <tt>A/X/sreg</tt>, so these may be clobbered by the function.
 106
 107 The C-stack pointer <tt/sp/ must be restored by the function to its value before the
 108 function call prologue. It may pop all of its parameters from the C-stack
 109 (e.g. using the <tt/runtime/ function <tt/popa/),
 110 or it could adjust <tt/sp/ directly.
 111 If the function has no prototype, or is variadic the <tt/Y/ register contains the
 112 number of bytes pushed to the stack on entry, which may be added to <tt/sp/ to restore its original state.
 113
 114 The internal pseudo-register <tt/regbank/ must not be changed by the function.
 115
 116 <sect2>Clobbered state<p>
 117
 118 The <tt/Y/ register may be clobbered by the function.
 119 The compiler will not depend on its state after a function call.
 120
 121 The <tt>A/X/sreg</tt> registers may be clobbered if any of them
 122 are not used by the return value (see above).
 123
 124 Many of the internal pseudo-registers used by cc65 are available for
 125 free use by any function called by C, and do not need to be preserved.
 126 Note that if another C function is called from your assembly function,
 127 it may clobber any of these itself:
 128
 129 <itemize>
 130   <item><tt>tmp1 .. tmp4</tt><p>
 131   <item><tt>ptr1 .. ptr4</tt><p>
 132   <item><tt>regsave</tt><p>
 133   <item><tt>sreg</tt> (if unused by return)<p>
 134 </itemize>
 135
 136
 137
 138 </article>
 139