root/arch/sparc/include/asm/thread_info_64.h
/* SPDX-License-Identifier: GPL-2.0 */
/* thread_info.h: sparc64 low-level thread information
 *
 * Copyright (C) 2002  David S. Miller (davem@redhat.com)
 */

#ifndef _ASM_THREAD_INFO_H
#define _ASM_THREAD_INFO_H

#ifdef __KERNEL__

#define NSWINS          7

#define TI_FLAG_BYTE_FAULT_CODE         0
#define TI_FLAG_FAULT_CODE_SHIFT        56
#define TI_FLAG_BYTE_WSTATE             1
#define TI_FLAG_WSTATE_SHIFT            48
#define TI_FLAG_BYTE_NOERROR            2
#define TI_FLAG_BYTE_NOERROR_SHIFT      40
#define TI_FLAG_BYTE_FPDEPTH            3
#define TI_FLAG_FPDEPTH_SHIFT           32
#define TI_FLAG_BYTE_CWP                4
#define TI_FLAG_CWP_SHIFT               24
#define TI_FLAG_BYTE_WSAVED             5
#define TI_FLAG_WSAVED_SHIFT            16

#include <asm/page.h>

#ifndef __ASSEMBLER__

#include <asm/ptrace.h>
#include <asm/types.h>

struct task_struct;

struct thread_info {
        /* D$ line 1 */
        struct task_struct      *task;
        unsigned long           flags;
        __u8                    fpsaved[7];
        __u8                    status;
        unsigned long           ksp;

        /* D$ line 2 */
        unsigned long           fault_address;
        struct pt_regs          *kregs;
        int                     preempt_count;  /* 0 => preemptable, <0 => BUG */
        __u8                    new_child;
        __u8                    __pad;
        __u16                   cpu;

        unsigned long           *utraps;

        struct reg_window       reg_window[NSWINS];
        unsigned long           rwbuf_stkptrs[NSWINS];

        unsigned long           gsr[7];
        unsigned long           xfsr[7];

        struct pt_regs          *kern_una_regs;
        unsigned int            kern_una_insn;

        unsigned long           fpregs[(7 * 256) / sizeof(unsigned long)]
                __attribute__ ((aligned(64)));
};

#endif /* !(__ASSEMBLER__) */

/* offsets into the thread_info struct for assembly code access */
#define TI_TASK         0x00000000
#define TI_FLAGS        0x00000008
#define TI_FAULT_CODE   (TI_FLAGS + TI_FLAG_BYTE_FAULT_CODE)
#define TI_WSTATE       (TI_FLAGS + TI_FLAG_BYTE_WSTATE)
#define TI_CWP          (TI_FLAGS + TI_FLAG_BYTE_CWP)
#define TI_FPDEPTH      (TI_FLAGS + TI_FLAG_BYTE_FPDEPTH)
#define TI_WSAVED       (TI_FLAGS + TI_FLAG_BYTE_WSAVED)
#define TI_SYS_NOERROR  (TI_FLAGS + TI_FLAG_BYTE_NOERROR)
#define TI_FPSAVED      0x00000010
#define TI_KSP          0x00000018
#define TI_FAULT_ADDR   0x00000020
#define TI_KREGS        0x00000028
#define TI_PRE_COUNT    0x00000030
#define TI_NEW_CHILD    0x00000034
#define TI_CPU          0x00000036
#define TI_UTRAPS       0x00000038
#define TI_REG_WINDOW   0x00000040
#define TI_RWIN_SPTRS   0x000003c0
#define TI_GSR          0x000003f8
#define TI_XFSR         0x00000430
#define TI_KUNA_REGS    0x00000468
#define TI_KUNA_INSN    0x00000470
#define TI_FPREGS       0x00000480

/* We embed this in the uppermost byte of thread_info->flags */
#define FAULT_CODE_WRITE        0x01    /* Write access, implies D-TLB     */
#define FAULT_CODE_DTLB         0x02    /* Miss happened in D-TLB          */
#define FAULT_CODE_ITLB         0x04    /* Miss happened in I-TLB          */
#define FAULT_CODE_WINFIXUP     0x08    /* Miss happened during spill/fill */
#define FAULT_CODE_BLKCOMMIT    0x10    /* Use blk-commit ASI in copy_page */
#define FAULT_CODE_BAD_RA       0x20    /* Bad RA for sun4v                */

#if PAGE_SHIFT == 13
#define THREAD_SIZE (2*PAGE_SIZE)
#define THREAD_SHIFT (PAGE_SHIFT + 1)
#else /* PAGE_SHIFT == 13 */
#define THREAD_SIZE PAGE_SIZE
#define THREAD_SHIFT PAGE_SHIFT
#endif /* PAGE_SHIFT == 13 */

/*
 * macros/functions for gaining access to the thread information structure
 */
#ifndef __ASSEMBLER__

#define INIT_THREAD_INFO(tsk)                           \
{                                                       \
        .task           =       &tsk,                   \
        .preempt_count  =       INIT_PREEMPT_COUNT,     \
        .kregs          =       (struct pt_regs *)(init_stack+THREAD_SIZE)-1 \
}

/* how to get the thread information struct from C */
#ifndef BUILD_VDSO
register struct thread_info *current_thread_info_reg asm("g6");
#define current_thread_info()   (current_thread_info_reg)
#else
extern struct thread_info *current_thread_info(void);
#endif

/* thread information allocation */
#if PAGE_SHIFT == 13
#define THREAD_SIZE_ORDER       1
#else /* PAGE_SHIFT == 13 */
#define THREAD_SIZE_ORDER       0
#endif /* PAGE_SHIFT == 13 */

#define __thread_flag_byte_ptr(ti)      \
        ((unsigned char *)(&((ti)->flags)))
#define __cur_thread_flag_byte_ptr      __thread_flag_byte_ptr(current_thread_info())

#define get_thread_fault_code()         (__cur_thread_flag_byte_ptr[TI_FLAG_BYTE_FAULT_CODE])
#define set_thread_fault_code(val)      (__cur_thread_flag_byte_ptr[TI_FLAG_BYTE_FAULT_CODE] = (val))
#define get_thread_wstate()             (__cur_thread_flag_byte_ptr[TI_FLAG_BYTE_WSTATE])
#define set_thread_wstate(val)          (__cur_thread_flag_byte_ptr[TI_FLAG_BYTE_WSTATE] = (val))
#define get_thread_cwp()                (__cur_thread_flag_byte_ptr[TI_FLAG_BYTE_CWP])
#define set_thread_cwp(val)             (__cur_thread_flag_byte_ptr[TI_FLAG_BYTE_CWP] = (val))
#define get_thread_noerror()            (__cur_thread_flag_byte_ptr[TI_FLAG_BYTE_NOERROR])
#define set_thread_noerror(val)         (__cur_thread_flag_byte_ptr[TI_FLAG_BYTE_NOERROR] = (val))
#define get_thread_fpdepth()            (__cur_thread_flag_byte_ptr[TI_FLAG_BYTE_FPDEPTH])
#define set_thread_fpdepth(val)         (__cur_thread_flag_byte_ptr[TI_FLAG_BYTE_FPDEPTH] = (val))
#define get_thread_wsaved()             (__cur_thread_flag_byte_ptr[TI_FLAG_BYTE_WSAVED])
#define set_thread_wsaved(val)          (__cur_thread_flag_byte_ptr[TI_FLAG_BYTE_WSAVED] = (val))
#endif /* !(__ASSEMBLER__) */

/*
 * Thread information flags, only 16 bits are available as we encode
 * other values into the upper 6 bytes.
 *
 * On trap return we need to test several values:
 *
 * user:        need_resched, notify_resume, sigpending, wsaved
 * kernel:      fpdepth
 *
 * So to check for work in the kernel case we simply load the fpdepth
 * byte out of the flags and test it.  For the user case we encode the
 * lower 3 bytes of flags as follows:
 *      ----------------------------------------
 *      | wsaved | flags byte 1 | flags byte 2 |
 *      ----------------------------------------
 * This optimizes the user test into:
 *      ldx             [%g6 + TI_FLAGS], REG1
 *      sethi           %hi(_TIF_USER_WORK_MASK), REG2
 *      or              REG2, %lo(_TIF_USER_WORK_MASK), REG2
 *      andcc           REG1, REG2, %g0
 *      be,pt           no_work_to_do
 *       nop
 */
#define TIF_SYSCALL_TRACE       0       /* syscall trace active */
#define TIF_NOTIFY_RESUME       1       /* callback before returning to user */
#define TIF_SIGPENDING          2       /* signal pending */
#define TIF_NEED_RESCHED        3       /* rescheduling necessary */
#define TIF_NOTIFY_SIGNAL       4       /* signal notifications exist */
#define TIF_UNALIGNED           5       /* allowed to do unaligned accesses */
#define TIF_UPROBE              6       /* breakpointed or singlestepped */
#define TIF_32BIT               7       /* 32-bit binary */
#define TIF_NOHZ                8       /* in adaptive nohz mode */
#define TIF_SECCOMP             9       /* secure computing */
#define TIF_SYSCALL_AUDIT       10      /* syscall auditing active */
#define TIF_SYSCALL_TRACEPOINT  11      /* syscall tracepoint instrumentation */
/* NOTE: Thread flags >= 12 should be ones we have no interest
 *       in using in assembly, else we can't use the mask as
 *       an immediate value in instructions such as andcc.
 */
#define TIF_MCDPER              12      /* Precise MCD exception */
#define TIF_MEMDIE              13      /* is terminating due to OOM killer */
#define TIF_POLLING_NRFLAG      14

#define _TIF_SYSCALL_TRACE      (1<<TIF_SYSCALL_TRACE)
#define _TIF_NOTIFY_RESUME      (1<<TIF_NOTIFY_RESUME)
#define _TIF_SIGPENDING         (1<<TIF_SIGPENDING)
#define _TIF_NEED_RESCHED       (1<<TIF_NEED_RESCHED)
#define _TIF_NOTIFY_SIGNAL      (1<<TIF_NOTIFY_SIGNAL)
#define _TIF_UNALIGNED          (1<<TIF_UNALIGNED)
#define _TIF_UPROBE             (1<<TIF_UPROBE)
#define _TIF_32BIT              (1<<TIF_32BIT)
#define _TIF_NOHZ               (1<<TIF_NOHZ)
#define _TIF_SECCOMP            (1<<TIF_SECCOMP)
#define _TIF_SYSCALL_AUDIT      (1<<TIF_SYSCALL_AUDIT)
#define _TIF_SYSCALL_TRACEPOINT (1<<TIF_SYSCALL_TRACEPOINT)
#define _TIF_POLLING_NRFLAG     (1<<TIF_POLLING_NRFLAG)

#define _TIF_USER_WORK_MASK     ((0xff << TI_FLAG_WSAVED_SHIFT) | \
                                 _TIF_DO_NOTIFY_RESUME_MASK | \
                                 _TIF_NEED_RESCHED)
#define _TIF_DO_NOTIFY_RESUME_MASK      (_TIF_NOTIFY_RESUME | \
                                         _TIF_SIGPENDING | _TIF_UPROBE | \
                                         _TIF_NOTIFY_SIGNAL)

#define is_32bit_task() (test_thread_flag(TIF_32BIT))

/*
 * Thread-synchronous status.
 *
 * This is different from the flags in that nobody else
 * ever touches our thread-synchronous status, so we don't
 * have to worry about atomic accesses.
 *
 * Note that there are only 8 bits available.
 */

#ifndef __ASSEMBLER__

#define thread32_stack_is_64bit(__SP) (((__SP) & 0x1) != 0)
#define test_thread_64bit_stack(__SP) \
        ((test_thread_flag(TIF_32BIT) && !thread32_stack_is_64bit(__SP)) ? \
         false : true)

#endif  /* !__ASSEMBLER__ */

#endif /* __KERNEL__ */

#endif /* _ASM_THREAD_INFO_H */