/*      $NetBSD: frame.h,v 1.11 2022/02/15 20:35:37 palle Exp $ */

/*
* Copyright (c) 1992, 1993
*      The Regents of the University of California.  All rights reserved.
*
* This software was developed by the Computer Systems Engineering group
* at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
* contributed to Berkeley.
*
* All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
*      This product includes software developed by the University of
*      California, Lawrence Berkeley Laboratory.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
*    notice, this list of conditions and the following disclaimer in the
*    documentation and/or other materials provided with the distribution.
* 3. Neither the name of the University nor the names of its contributors
*    may be used to endorse or promote products derived from this software
*    without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
*      @(#)frame.h     8.1 (Berkeley) 6/11/93
*/

#ifndef _SPARC_FRAME_H_
#define _SPARC_FRAME_H_

#if defined(_KERNEL_OPT)
#include "opt_sparc_arch.h"
#endif

/*
* Sparc stack frame format.
*
* Note that the contents of each stack frame may be held only in
* machine register windows.  In order to get an accurate picture
* of the frame, you must first force the kernel to write any such
* windows to the stack.
*/
#ifndef _LOCORE
#ifndef __sparc_v9__
struct frame {
       int32_t fr_local[8];    /* space to save locals (%l0..%l7) */
       int32_t fr_arg[6];      /* space to save arguments (%i0..%i5) */
       struct  frame *fr_fp;   /* space to save frame pointer (%i6) */
       int32_t fr_pc;          /* space to save return pc (%i7) */
       /*
        * SunOS reserves another 8 words here; this is pointless
        * but we do it for compatibility.
        */
       int32_t fr_xxx;         /* `structure return pointer' (unused) */
       int32_t fr_argd[6];     /* `arg dump area' (lunacy) */
       int32_t fr_argx[1];     /* arg extension (args 7..n; variable size) */
};
#else
struct frame32 {
       int32_t fr_local[8];    /* space to save locals (%l0..%l7) */
       int32_t fr_arg[6];      /* space to save arguments (%i0..%i5) */
       uint32_t        fr_fp;  /* space to save frame pointer (%i6) */
       uint32_t        fr_pc;  /* space to save return pc (%i7) */
       /*
        * SunOS reserves another 8 words here; this is pointless
        * but we do it for compatibility.
        */
       int32_t fr_xxx;         /* `structure return pointer' (unused) */
       int32_t fr_argd[6];     /* `arg dump area' (lunacy) */
       int32_t fr_argx[1];     /* arg extension (args 7..n; variable size) */
};
#endif
#endif

/*
* CCFSZ (C Compiler Frame SiZe) is the size of a stack frame required if
* a function is to call C code.  It should be just 64, but Sun defined
* their frame with space to hold arguments 0 through 5 (plus some junk),
* and varargs routines (such as kprintf) demand this, and gcc uses this
* area at times anyway.
*/
#define CCFSZ           96

/*
* Sparc v9 stack frame format.
*
* Note that the contents of each stack frame may be held only in
* machine register windows.  In order to get an accurate picture
* of the frame, you must first force the kernel to write any such
* windows to the stack.
*
* V9 frames have an odd bias, so you can tell a v9 frame from
* a v8 frame by testing the stack pointer's lsb.
*/
#if !defined(_LOCORE) && !defined(_LIBC)
struct frame64 {
       int64_t fr_local[8];    /* space to save locals (%l0..%l7) */
       int64_t fr_arg[6];      /* space to save arguments (%i0..%i5) */
       uint64_t        fr_fp;          /* space to save frame pointer (%i6) */
       uint64_t        fr_pc;          /* space to save return pc (%i7) */
       /*
        * SVR4 reserves a bunch of extra stuff.
        */
       int64_t fr_argd[6];     /* `register save area' (lunacy) */
       int64_t fr_argx[0];     /* arg extension (args 7..n; variable size) */
};

#define v9next_frame(f)         ((struct frame64*)(f->fr_fp+BIAS))
#endif

/*
* CC64FSZ (C Compiler 64-bit Frame SiZe) is the size of a stack frame used
* by the compiler in 64-bit mode (see struct frame64 above).
* It is 8*8 + 6*8 + 8 + 8 + 6*8 + 0*8 = 176 bytes.
*/
#define CC64FSZ         176

/*
* v9 stacks all have a bias of 2047 added to the %sp and %fp, so you can easily
* detect it by testing the register for an odd value.  Why 2K-1 I don't know.
*/
#define BIAS    (2048-1)

#endif /* _SPARC_FRAME_H_ */