root/lib/libc/arch/sparc64/SYS.h
/*      $OpenBSD: SYS.h,v 1.18 2023/12/10 16:45:52 deraadt 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.
 *
 * 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.
 *
 *      @(#)SYS.h       8.1 (Berkeley) 6/4/93
 *
 *      from: Header: SYS.h,v 1.2 92/07/03 18:57:00 torek Exp
 *      $NetBSD: SYS.h,v 1.6 2001/07/23 07:26:50 thorpej Exp $
 */

#include "DEFS.h"
#include <sys/syscall.h>
#include <machine/trap.h>

/* offsetof(struct tib, tib_errno) - offsetof(struct tib, __tib_tcb) */
#define TCB_OFFSET_ERRNO        24

#define _CAT(x,y) x##y

#define __ENTRY(p,x)            ENTRY(_CAT(p,x)) ; .weak x; x = _CAT(p,x)
#define __ENTRY_HIDDEN(p,x)     ENTRY(_CAT(p,x))

#define __END_HIDDEN(p,x)       END(_CAT(p,x));                 \
                                _HIDDEN_FALIAS(x, _CAT(p,x));   \
                                END(_HIDDEN(x))
#define __END(p,x)              __END_HIDDEN(p,x); END(x)

/*
 * ERROR sets the thread's errno and returns
 */
#define ERROR()                                                 \
        st      %o0, [%g7 + TCB_OFFSET_ERRNO];                  \
        retl;                                                   \
         mov    -1, %o0

/*
 * SYSCALL is used when further action must be taken before returning.
 * Note that it adds a `nop' over what we could do, if we only knew what
 * came at label 1....
 */
#define _SYSCALL(p,x,y)                                         \
        __ENTRY(p,x);                                           \
        mov _CAT(SYS_,y),%g1;                                   \
97:     t ST_SYSCALL;                                           \
        PINSYSCALL(_CAT(SYS_,y), 97b);                          \
        bcc 1f;                                                 \
        nop;                                                    \
        ERROR();                                                \
1:

#define _SYSCALL_HIDDEN(p,x,y)                                  \
        __ENTRY_HIDDEN(p,x);                                    \
        mov _CAT(SYS_,y),%g1;                                   \
97:     t ST_SYSCALL;                                           \
        PINSYSCALL(_CAT(SYS_,y), 97b);                          \
        bcc 1f;                                                 \
        nop;                                                    \
        ERROR();                                                \
1:

#define __SYSCALL(p,x)                                          \
        _SYSCALL(p,x,x)

#define __SYSCALL_HIDDEN(p,x)                                   \
        _SYSCALL_HIDDEN(p,x,x)

/*
 * RSYSCALL is used when the system call should just return.  Here
 * we use the SYSCALL_G2RFLAG to put the `success' return address in %g2
 * and avoid a branch.
 */
#define __RSYSCALL(p,x)                                         \
        __ENTRY(p,x);                                           \
        mov (_CAT(SYS_,x))|SYSCALL_G2RFLAG,%g1;                 \
        add %o7,8,%g2;                                          \
97:     t ST_SYSCALL;                                           \
        PINSYSCALL(_CAT(SYS_,x), 97b);                          \
        ERROR();                                                \
        __END(p,x)
#define __RSYSCALL_HIDDEN(p,x)                                  \
        __ENTRY_HIDDEN(p,x);                                    \
        mov (_CAT(SYS_,x))|SYSCALL_G2RFLAG,%g1;                 \
        add %o7,8,%g2;                                          \
97:     t ST_SYSCALL;                                           \
        PINSYSCALL(_CAT(SYS_,x), 97b);                          \
        ERROR();                                                \
        __END_HIDDEN(p,x)

/*
 * PSEUDO(x,y) is like RSYSCALL(y) except that the name is x.
 */
#define __PSEUDO(p,x,y)                                         \
        __ENTRY(p,x);                                           \
        mov (_CAT(SYS_,y))|SYSCALL_G2RFLAG,%g1;                 \
        add %o7,8,%g2;                                          \
97:     t ST_SYSCALL;                                           \
        PINSYSCALL(_CAT(SYS_,y), 97b);                          \
        ERROR();                                                \
        __END(p,x)

/*
 * SYSCALL_NOERROR is like SYSCALL, except it's used for syscalls 
 * that never fail.
 *
 * XXX - This should be optimized.
 */
#define __SYSCALL_NOERROR(p,x)                                  \
        __ENTRY(p,x);                                           \
        mov _CAT(SYS_,x),%g1;                                   \
97:     t ST_SYSCALL;                                           \
        PINSYSCALL(_CAT(SYS_,x), 97b)

/*
 * RSYSCALL_NOERROR is like RSYSCALL, except it's used for syscalls 
 * that never fail.
 *
 * XXX - This should be optimized.
 */
#define __RSYSCALL_NOERROR(p,x)                                 \
        __ENTRY(p,x);                                           \
        mov (_CAT(SYS_,x))|SYSCALL_G2RFLAG,%g1;                 \
        add %o7,8,%g2;                                          \
97:     t ST_SYSCALL;                                           \
        PINSYSCALL(_CAT(SYS_,x), 97b);                          \
        __END(p,x)

/*
 * PSEUDO_NOERROR(x,y) is like RSYSCALL_NOERROR(y) except that the name is x.
 */
#define __PSEUDO_NOERROR(p,x,y)                                 \
        __ENTRY(p,x);                                           \
        mov (_CAT(SYS_,y))|SYSCALL_G2RFLAG,%g1;                 \
        add %o7,8,%g2;                                          \
97:     t ST_SYSCALL;                                           \
        PINSYSCALL(_CAT(SYS_,y), 97b);                          \
        __END(p,x)

/*
 * SYSENTRY is for functions that pretend to be syscalls.
 */
#define SYSCALL(x)              __SYSCALL(_thread_sys_,x)
#define RSYSCALL(x)             __RSYSCALL(_thread_sys_,x)
#define RSYSCALL_HIDDEN(x)      __RSYSCALL_HIDDEN(_thread_sys_,x)
#define RSYSCALL_NOERROR(x,y)   __RSYSCALL_NOERROR(_thread_sys_,x,y)
#define PSEUDO(x,y)             __PSEUDO(_thread_sys_,x,y)
#define PSEUDO_NOERROR(x,y)     __PSEUDO_NOERROR(_thread_sys_,x,y)
#define SYSENTRY(x)             __ENTRY(_thread_sys_,x)
#define SYSENTRY_HIDDEN(x)      __ENTRY_HIDDEN(_thread_sys_,x)
#define SYSCALL_END(x)          __END(_thread_sys_,x)
#define SYSCALL_END_HIDDEN(x)   __END_HIDDEN(_thread_sys_,x)