arch/x86/include/asm/thread_info.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /* thread_info.h: low-level thread information
   3  *
   4  * Copyright (C) 2002  David Howells (dhowells@redhat.com)
   5  * - Incorporating suggestions made by Linus Torvalds and Dave Miller
   6  */
   7
   8 #ifndef _ASM_X86_THREAD_INFO_H
   9 #define _ASM_X86_THREAD_INFO_H
  10
  11 #include <linux/compiler.h>
  12 #include <asm/page.h>
  13 #include <asm/percpu.h>
  14 #include <asm/types.h>
  15
  16 /*
  17  * TOP_OF_KERNEL_STACK_PADDING is a number of unused bytes that we
  18  * reserve at the top of the kernel stack.  We do it because of a nasty
  19  * 32-bit corner case.  On x86_32, the hardware stack frame is
  20  * variable-length.  Except for vm86 mode, struct pt_regs assumes a
  21  * maximum-length frame.  If we enter from CPL 0, the top 8 bytes of
  22  * pt_regs don't actually exist.  Ordinarily this doesn't matter, but it
  23  * does in at least one case:
  24  *
  25  * If we take an NMI early enough in SYSENTER, then we can end up with
  26  * pt_regs that extends above sp0.  On the way out, in the espfix code,
  27  * we can read the saved SS value, but that value will be above sp0.
  28  * Without this offset, that can result in a page fault.  (We are
  29  * careful that, in this case, the value we read doesn't matter.)
  30  *
  31  * In vm86 mode, the hardware frame is much longer still, so add 16
  32  * bytes to make room for the real-mode segments.
  33  *
  34  * x86_64 has a fixed-length stack frame.
  35  */
  36 #ifdef CONFIG_X86_32
  37 # ifdef CONFIG_VM86
  38 #  define TOP_OF_KERNEL_STACK_PADDING 16
  39 # else
  40 #  define TOP_OF_KERNEL_STACK_PADDING 8
  41 # endif
  42 #else
  43 # define TOP_OF_KERNEL_STACK_PADDING 0
  44 #endif
  45
  46 /*
  47  * low level task data that entry.S needs immediate access to
  48  * - this struct should fit entirely inside of one cache line
  49  * - this struct shares the supervisor stack pages
  50  */
  51 #ifndef __ASSEMBLY__
  52 struct task_struct;
  53 #include <asm/cpufeature.h>
  54 #include <linux/atomic.h>
  55
  56 struct thread_info {
  57         unsigned long           flags;          /* low level flags */
  58         unsigned long           syscall_work;   /* SYSCALL_WORK_ flags */
  59         u32                     status;         /* thread synchronous flags */
  60         int                     preempt_lazy_count;     /* 0 => lazy preemptable
  61                                                            <0 => BUG */
  62 };
  63
  64 #define INIT_THREAD_INFO(tsk)                   \
  65 {                                               \
  66         .flags          = 0,                    \
  67         .preempt_lazy_count     = 0,            \
  68 }
  69
  70 #else /* !__ASSEMBLY__ */
  71
  72 #include <asm/asm-offsets.h>
  73
  74 #endif
  75
  76 /*
  77  * thread information flags
  78  * - these are process state flags that various assembly files
  79  *   may need to access
  80  */
  81 #define TIF_NOTIFY_RESUME       1       /* callback before returning to user */
  82 #define TIF_SIGPENDING          2       /* signal pending */
  83 #define TIF_NEED_RESCHED        3       /* rescheduling necessary */
  84 #define TIF_SINGLESTEP          4       /* reenable singlestep on user return*/
  85 #define TIF_SSBD                5       /* Speculative store bypass disable */
  86 #define TIF_SPEC_IB             9       /* Indirect branch speculation mitigation */
  87 #define TIF_SPEC_L1D_FLUSH      10      /* Flush L1D on mm switches (processes) */
  88 #define TIF_USER_RETURN_NOTIFY  11      /* notify kernel of userspace return */
  89 #define TIF_UPROBE              12      /* breakpointed or singlestepping */
  90 #define TIF_PATCH_PENDING       13      /* pending live patching update */
  91 #define TIF_NEED_FPU_LOAD       14      /* load FPU on return to userspace */
  92 #define TIF_NOCPUID             15      /* CPUID is not accessible in userland */
  93 #define TIF_NOTSC               16      /* TSC is not accessible in userland */
  94 #define TIF_NOTIFY_SIGNAL       17      /* signal notifications exist */
  95 #define TIF_SLD                 18      /* Restore split lock detection on context switch */
  96 #define TIF_NEED_RESCHED_LAZY   19      /* lazy rescheduling necessary */
  97 #define TIF_MEMDIE              20      /* is terminating due to OOM killer */
  98 #define TIF_POLLING_NRFLAG      21      /* idle is polling for TIF_NEED_RESCHED */
  99 #define TIF_IO_BITMAP           22      /* uses I/O bitmap */
 100 #define TIF_SPEC_FORCE_UPDATE   23      /* Force speculation MSR update in context switch */
 101 #define TIF_FORCED_TF           24      /* true if TF in eflags artificially */
 102 #define TIF_BLOCKSTEP           25      /* set when we want DEBUGCTLMSR_BTF */
 103 #define TIF_LAZY_MMU_UPDATES    27      /* task is updating the mmu lazily */
 104 #define TIF_ADDR32              29      /* 32-bit address space on 64 bits */
 105
 106 #define _TIF_NOTIFY_RESUME      (1 << TIF_NOTIFY_RESUME)
 107 #define _TIF_SIGPENDING         (1 << TIF_SIGPENDING)
 108 #define _TIF_NEED_RESCHED       (1 << TIF_NEED_RESCHED)
 109 #define _TIF_SINGLESTEP         (1 << TIF_SINGLESTEP)
 110 #define _TIF_SSBD               (1 << TIF_SSBD)
 111 #define _TIF_SPEC_IB            (1 << TIF_SPEC_IB)
 112 #define _TIF_SPEC_L1D_FLUSH     (1 << TIF_SPEC_L1D_FLUSH)
 113 #define _TIF_USER_RETURN_NOTIFY (1 << TIF_USER_RETURN_NOTIFY)
 114 #define _TIF_UPROBE             (1 << TIF_UPROBE)
 115 #define _TIF_PATCH_PENDING      (1 << TIF_PATCH_PENDING)
 116 #define _TIF_NEED_FPU_LOAD      (1 << TIF_NEED_FPU_LOAD)
 117 #define _TIF_NOCPUID            (1 << TIF_NOCPUID)
 118 #define _TIF_NOTSC              (1 << TIF_NOTSC)
 119 #define _TIF_NOTIFY_SIGNAL      (1 << TIF_NOTIFY_SIGNAL)
 120 #define _TIF_SLD                (1 << TIF_SLD)
 121 #define _TIF_NEED_RESCHED_LAZY  (1 << TIF_NEED_RESCHED_LAZY)
 122 #define _TIF_POLLING_NRFLAG     (1 << TIF_POLLING_NRFLAG)
 123 #define _TIF_IO_BITMAP          (1 << TIF_IO_BITMAP)
 124 #define _TIF_SPEC_FORCE_UPDATE  (1 << TIF_SPEC_FORCE_UPDATE)
 125 #define _TIF_FORCED_TF          (1 << TIF_FORCED_TF)
 126 #define _TIF_BLOCKSTEP          (1 << TIF_BLOCKSTEP)
 127 #define _TIF_LAZY_MMU_UPDATES   (1 << TIF_LAZY_MMU_UPDATES)
 128 #define _TIF_ADDR32             (1 << TIF_ADDR32)
 129
 130 /* flags to check in __switch_to() */
 131 #define _TIF_WORK_CTXSW_BASE                                    \
 132         (_TIF_NOCPUID | _TIF_NOTSC | _TIF_BLOCKSTEP |           \
 133          _TIF_SSBD | _TIF_SPEC_FORCE_UPDATE | _TIF_SLD)
 134
 135 /*
 136  * Avoid calls to __switch_to_xtra() on UP as STIBP is not evaluated.
 137  */
 138 #ifdef CONFIG_SMP
 139 # define _TIF_WORK_CTXSW        (_TIF_WORK_CTXSW_BASE | _TIF_SPEC_IB)
 140 #else
 141 # define _TIF_WORK_CTXSW        (_TIF_WORK_CTXSW_BASE)
 142 #endif
 143
 144 #ifdef CONFIG_X86_IOPL_IOPERM
 145 # define _TIF_WORK_CTXSW_PREV   (_TIF_WORK_CTXSW| _TIF_USER_RETURN_NOTIFY | \
 146                                  _TIF_IO_BITMAP)
 147 #else
 148 # define _TIF_WORK_CTXSW_PREV   (_TIF_WORK_CTXSW| _TIF_USER_RETURN_NOTIFY)
 149 #endif
 150
 151 #define _TIF_WORK_CTXSW_NEXT    (_TIF_WORK_CTXSW)
 152
 153 #define STACK_WARN              (THREAD_SIZE/8)
 154
 155 /*
 156  * macros/functions for gaining access to the thread information structure
 157  *
 158  * preempt_count needs to be 1 initially, until the scheduler is functional.
 159  */
 160 #ifndef __ASSEMBLY__
 161
 162 /*
 163  * Walks up the stack frames to make sure that the specified object is
 164  * entirely contained by a single stack frame.
 165  *
 166  * Returns:
 167  *      GOOD_FRAME      if within a frame
 168  *      BAD_STACK       if placed across a frame boundary (or outside stack)
 169  *      NOT_STACK       unable to determine (no frame pointers, etc)
 170  */
 171 static inline int arch_within_stack_frames(const void * const stack,
 172                                            const void * const stackend,
 173                                            const void *obj, unsigned long len)
 174 {
 175 #if defined(CONFIG_FRAME_POINTER)
 176         const void *frame = NULL;
 177         const void *oldframe;
 178
 179         oldframe = __builtin_frame_address(1);
 180         if (oldframe)
 181                 frame = __builtin_frame_address(2);
 182         /*
 183          * low ----------------------------------------------> high
 184          * [saved bp][saved ip][args][local vars][saved bp][saved ip]
 185          *                     ^----------------^
 186          *               allow copies only within here
 187          */
 188         while (stack <= frame && frame < stackend) {
 189                 /*
 190                  * If obj + len extends past the last frame, this
 191                  * check won't pass and the next frame will be 0,
 192                  * causing us to bail out and correctly report
 193                  * the copy as invalid.
 194                  */
 195                 if (obj + len <= frame)
 196                         return obj >= oldframe + 2 * sizeof(void *) ?
 197                                 GOOD_FRAME : BAD_STACK;
 198                 oldframe = frame;
 199                 frame = *(const void * const *)frame;
 200         }
 201         return BAD_STACK;
 202 #else
 203         return NOT_STACK;
 204 #endif
 205 }
 206
 207 #endif  /* !__ASSEMBLY__ */
 208
 209 /*
 210  * Thread-synchronous status.
 211  *
 212  * This is different from the flags in that nobody else
 213  * ever touches our thread-synchronous status, so we don't
 214  * have to worry about atomic accesses.
 215  */
 216 #define TS_COMPAT               0x0002  /* 32bit syscall active (64BIT)*/
 217
 218 #ifndef __ASSEMBLY__
 219 #ifdef CONFIG_COMPAT
 220 #define TS_I386_REGS_POKED      0x0004  /* regs poked by 32-bit ptracer */
 221
 222 #define arch_set_restart_data(restart)  \
 223         do { restart->arch_data = current_thread_info()->status; } while (0)
 224
 225 #endif
 226
 227 #ifdef CONFIG_X86_32
 228 #define in_ia32_syscall() true
 229 #else
 230 #define in_ia32_syscall() (IS_ENABLED(CONFIG_IA32_EMULATION) && \
 231                            current_thread_info()->status & TS_COMPAT)
 232 #endif
 233
 234 extern void arch_task_cache_init(void);
 235 extern int arch_dup_task_struct(struct task_struct *dst, struct task_struct *src);
 236 extern void arch_release_task_struct(struct task_struct *tsk);
 237 extern void arch_setup_new_exec(void);
 238 #define arch_setup_new_exec arch_setup_new_exec
 239 #endif  /* !__ASSEMBLY__ */
 240
 241 #endif /* _ASM_X86_THREAD_INFO_H */