rom/exec/newstackswap.c

   1 /*
   2     Copyright © 1995-2015, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: NewStackSwap() - Call a function with swapped stack.
   6     Lang: english
   7 */
   8
   9 /*****************************************************************************
  10
  11     NAME */
  12 #include <exec/tasks.h>
  13 #include <proto/exec.h>
  14
  15         AROS_LH3(IPTR, NewStackSwap,
  16
  17 /*  SYNOPSIS */
  18         AROS_LHA(struct StackSwapStruct *, sss, A0),
  19         AROS_LHA(LONG_FUNC, entry, A1),
  20         AROS_LHA(struct StackSwapArgs *, args, A2),
  21
  22 /*  LOCATION */
  23         struct ExecBase *, SysBase, 134, Exec)
  24
  25 /*  FUNCTION
  26         Calls a function with a new stack.
  27
  28     INPUTS
  29         sss     -   A structure containing the values for the upper, lower
  30                     and current bounds of the stack you wish to use.
  31         entry   -   Address of the function to call.
  32         args    -   A structure (actually an array) containing up to 8
  33                     function arguments. May be NULL.
  34
  35     RESULT
  36         The value returned by your function.
  37
  38     NOTES
  39         This function is mostly compatible with MorphOS's NewPPCStackSwap()
  40         function.
  41
  42     EXAMPLE
  43
  44     BUGS
  45         Do not attempt to pass in a prebuilt stack - it will be erased.
  46
  47     SEE ALSO
  48         StackSwap()
  49
  50     INTERNALS
  51         This function MUST be replaced in $(KERNEL) or $(ARCH).
  52
  53 ******************************************************************************/
  54 {
  55     AROS_LIBFUNC_INIT
  56
  57     /* For an example see the NewStackSwap() function in either i386 or
  58        m68k-native.
  59
  60        Note that you must save any state information on the stack that is
  61        used in the current process, for example you should really save
  62        return addresses.
  63
  64        Note that even if you do save that information, it is not a good
  65        idea to return from the procedure that StackSwap() was invoked in
  66        as the stack will be quite incorrect.
  67     */
  68
  69 #ifndef __CXREF__
  70 #error The function NewStackSwap() has not been implemented in the kernel.
  71 #endif
  72
  73     return 0;
  74
  75     AROS_LIBFUNC_EXIT
  76 } /* NewStackSwap() */