/*      $OpenBSD: asm.h,v 1.10 2022/12/08 02:11:27 guenther Exp $       */
/*      $NetBSD: asm.h,v 1.25 2006/01/20 22:02:40 christos Exp $        */

/*-
 * Copyright (c) 1990 The Regents of the University of California.
 * All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * William Jolitz.
 *
 * 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.
 *
 *      @(#)asm.h       5.5 (Berkeley) 5/7/91
 */

#ifndef _SH_ASM_H_
#define _SH_ASM_H_

#define _C_LABEL(x)     x
#define _ASM_LABEL(x)   x

#ifdef __STDC__
# define __CONCAT(x,y)  x ## y
# define __STRING(x)    #x
#else
# define __CONCAT(x,y)  x/**/y
# define __STRING(x)    "x"
#endif

/* let kernels and others override entrypoint alignment */
#ifndef _ALIGN_TEXT
# define _ALIGN_TEXT .align 2
#endif

#define _ENTRY(x)                                                       \
        .text                                                           ;\
        _ALIGN_TEXT                                                     ;\
        .globl x                                                        ;\
        .type x,@function                                               ;\
        x:

#if defined(PROF) || defined(GPROF)
#define _PROF_PROLOGUE                            \
        mov.l   1f,r1                           ; \
        mova    2f,r0                           ; \
        jmp     @r1                             ; \
         nop                                    ; \
        .align  2                               ; \
1:      .long   __mcount                        ; \
2:
#else  /* !GPROF */
#define _PROF_PROLOGUE
#endif /* !GPROF */

#define ENTRY(y)        _ENTRY(y) _PROF_PROLOGUE
#define NENTRY(y)       _ENTRY(y)
#define ASENTRY(y)      _ENTRY(y) _PROF_PROLOGUE

#define END(y)          .size   y, . - y

#define SET_ENTRY_SIZE(y) \
        .size   y, . - y

#define SET_ASENTRY_SIZE(y) \
        .size   y, . - y

#define ALTENTRY(name)                           \
        .globl name                             ;\
        .type name,@function                    ;\
        name:

/*
 * Hide the gory details of PIC calls vs. normal calls.  Use as in the
 * following example:
 *
 *      sts.l   pr, @-sp
 *      PIC_PROLOGUE(.L_got, r0)        ! saves old r12 on stack
 *      ...
 *      mov.l   .L_function_1, r0
 * 1:   CALL    r0                      ! each call site needs a label
 *       nop
 *      ...
 *      mov.l   .L_function_2, r0
 * 2:   CALL    r0
 *       nop
 *      ...
 *      PIC_EPILOGUE                    ! restores r12 from stack
 *      lds.l   @sp+, pr                !  so call in right order 
 *      rts
 *       nop
 *
 *      .align 2
 * .L_got:
 *      PIC_GOT_DATUM
 * .L_function_1:                       ! if you call the same function twice
 *      CALL_DATUM(function, 1b)        !  provide call datum for each call
 * .L_function_2:
 *      CALL_DATUM(function, 2b)
 */

#ifdef __PIC__

#define PIC_PLT(x)      x@PLT
#define PIC_GOT(x)      x@GOT
#define PIC_GOTOFF(x)   x@GOTOFF

#define PIC_PROLOGUE(got)                       \
                mov.l   r12, @-sp;              \
                PIC_PROLOGUE_NOSAVE(got)

/*
 * Functions that do non local jumps don't need to preserve r12,
 * so we can shave off two instructions to save/restore it.
 */
#define PIC_PROLOGUE_NOSAVE(got)                \
                mov.l   got, r12;               \
                mova    got, r0;                \
                add     r0, r12

#define PIC_EPILOGUE                            \
                mov.l   @sp+, r12

#define PIC_EPILOGUE_SLOT                       \
                PIC_EPILOGUE

#define PIC_GOT_DATUM \
                .long   _GLOBAL_OFFSET_TABLE_

#define CALL    bsrf
#define JUMP    braf

#define CALL_DATUM(function, lpcs) \
                .long   PIC_PLT(function) - ((lpcs) + 4 - (.))

/*
 * This will result in text relocations in the shared library,
 * unless the function is local or has hidden or protected visibility.
 * Does not require PIC prologue.
 */
#define CALL_DATUM_LOCAL(function, lpcs) \
                .long   function - ((lpcs) + 4)

#else  /* !PIC */

#define PIC_PROLOGUE(label)
#define PIC_PROLOGUE_NOSAVE(label)
#define PIC_EPILOGUE
#define PIC_EPILOGUE_SLOT       nop
#define PIC_GOT_DATUM

#define CALL    jsr @
#define JUMP    jmp @

#define CALL_DATUM(function, lpcs) \
                .long   function

#define CALL_DATUM_LOCAL(function, lpcs) \
                .long   function

#endif /* !PIC */

#define STRONG_ALIAS(alias,sym)                                         \
        .global alias;                                                  \
        alias = sym
#define WEAK_ALIAS(alias,sym)                                           \
        .weak alias;                                                    \
        alias = sym

#endif /* !_SH_ASM_H_ */