| Message ID | 4268a0203fd6e42a31bde3254ee50dd93fd233ea.1646999762.git.pengfei.xu@intel.com |
|---|---|
| State | New |
| Headers | show |
| Series | Introduce XSAVE feature self-test | expand |
On 3/16/2022 5:40 AM, Pengfei Xu wrote: > > +static inline void check_cpuid_xsave_availability(void) > +{ > + uint32_t eax, ebx, ecx, edx; > + > + /* > + * CPUID.1:ECX.XSAVE[bit 26] enumerates general > + * support for the XSAVE feature set, including > + * XGETBV. > + */ > + __cpuid_count(1, 0, eax, ebx, ecx, edx); > + if (!(ecx & CPUID_LEAF1_ECX_XSAVE_MASK)) > + fatal_error("cpuid: no CPU xsave support"); > + if (!(ecx & CPUID_LEAF1_ECX_OSXSAVE_MASK)) > + fatal_error("cpuid: no OS xsave support"); We need to skip the test when XSAVE is not available. See the point here: https://lore.kernel.org/lkml/8735j8aa9g.ffs@tglx/ Thanks, Chang
On 2022-03-24 at 03:06:50 -0700, Chang S. Bae wrote: > On 3/16/2022 5:40 AM, Pengfei Xu wrote: > > > > +static inline void check_cpuid_xsave_availability(void) > > +{ > > + uint32_t eax, ebx, ecx, edx; > > + > > + /* > > + * CPUID.1:ECX.XSAVE[bit 26] enumerates general > > + * support for the XSAVE feature set, including > > + * XGETBV. > > + */ > > + __cpuid_count(1, 0, eax, ebx, ecx, edx); > > + if (!(ecx & CPUID_LEAF1_ECX_XSAVE_MASK)) > > + fatal_error("cpuid: no CPU xsave support"); > > + if (!(ecx & CPUID_LEAF1_ECX_OSXSAVE_MASK)) > > + fatal_error("cpuid: no OS xsave support"); > > We need to skip the test when XSAVE is not available. See the point here: > https://lore.kernel.org/lkml/8735j8aa9g.ffs@tglx/ > Yes, it's better, will skip and exit if CPU doesn't support XSAVE or OS XSAVE. Thanks for suggestion! BR. -- Pengfei > Thanks, > Chang > >
On 3/16/22 05:40, Pengfei Xu wrote: > +#ifndef __cpuid_count > +#define __cpuid_count(level, count, a, b, c, d) ({ \ > + __asm__ __volatile__ ("cpuid\n\t" \ > + : "=a" (a), "=b" (b), "=c" (c), "=d" (d) \ > + : "0" (level), "2" (count)); \ > +}) > +#endif By the time you post the next revision, I hope these are merged: > https://lore.kernel.org/all/cover.1647360971.git.reinette.chatre@intel.com/ Could you rebase on top of those to avoid duplication, please? > +/* > + * While this function prototype is in the stdlib.h, the header file cannot be > + * included with the -mno-sse option. > + */ > +void *aligned_alloc(size_t alignment, size_t size); That is worrisome. I would serioulsy suspect that if the header can't be included that the code that it references has issues as well. Or, is this just working around a compiler bug? Just googling: https://www.google.com/search?q=stdlib.h+no-sse points to this: https://sourceware.org/bugzilla/show_bug.cgi?id=27600 > +enum supportability { > + NOT_SUPPORT, > + SUPPORT, > +}; > + > +/* It's from arch/x86/kernel/fpu/xstate.c. */ > +static const char * const xfeature_names[] = { > + "x87 floating point registers", > + "SSE registers", > + "AVX registers", > + "MPX bounds registers", > + "MPX CSR", > + "AVX-512 opmask", > + "AVX-512 Hi256", > + "AVX-512 ZMM_Hi256", > + "Processor Trace (unused)", > + "Protection Keys User registers", > + "PASID state", > + "unknown xstate feature", > + "unknown xstate feature", > + "unknown xstate feature", > + "unknown xstate feature", > + "unknown xstate feature", > + "unknown xstate feature", > + "AMX Tile config", > + "AMX Tile data", > + "unknown xstate feature", > +}; > + > +/* List of XSAVE features Linux knows about. */ > +enum xfeature { > + XFEATURE_FP, > + XFEATURE_SSE, > + /* > + * Values above here are "legacy states". > + * Those below are "extended states". > + */ > + XFEATURE_YMM, > + XFEATURE_BNDREGS, > + XFEATURE_BNDCSR, > + XFEATURE_OPMASK, > + XFEATURE_ZMM_Hi256, > + XFEATURE_Hi16_ZMM, > + XFEATURE_PT_UNIMPLEMENTED_SO_FAR, > + XFEATURE_PKRU, > + XFEATURE_PASID, > + XFEATURE_RSRVD_COMP_11, > + XFEATURE_RSRVD_COMP_12, > + XFEATURE_RSRVD_COMP_13, > + XFEATURE_RSRVD_COMP_14, > + XFEATURE_LBR, > + XFEATURE_RSRVD_COMP_16, > + XFEATURE_XTILE_CFG, > + XFEATURE_XTILE_DATA, > + XFEATURE_MAX, > +}; > + > +struct xsave_buffer { > + union { > + struct { > + char legacy[XSAVE_HDR_OFFSET]; > + char header[XSAVE_HDR_SIZE]; > + char extended[0]; > + }; > + char bytes[0]; > + }; > +}; > + > +static struct { > + uint64_t mask; > + uint32_t size[XFEATURE_MAX]; > + uint32_t offset[XFEATURE_MAX]; > +} xstate_info; > + > +static inline void check_cpuid_xsave_availability(void) > +{ > + uint32_t eax, ebx, ecx, edx; > + > + /* > + * CPUID.1:ECX.XSAVE[bit 26] enumerates general > + * support for the XSAVE feature set, including > + * XGETBV. > + */ > + __cpuid_count(1, 0, eax, ebx, ecx, edx); > + if (!(ecx & CPUID_LEAF1_ECX_XSAVE_MASK)) > + fatal_error("cpuid: no CPU xsave support"); > + if (!(ecx & CPUID_LEAF1_ECX_OSXSAVE_MASK)) > + fatal_error("cpuid: no OS xsave support"); > +} Could you please use the standard selftest macros for these fatal errors? Also, do these indicate that the test failed, or that it just was not able to run? > +static inline bool xstate_tested(int xfeature_num) > +{ > + return !!(xstate_info.mask & (1 << xfeature_num)); > +} > + > +static inline int cpu_has_avx2(void) > +{ > + unsigned int eax, ebx, ecx, edx; > + > + /* CPUID.7.0:EBX.AVX2[bit 5]: the support for AVX2 instructions */ > + __cpuid_count(7, 0, eax, ebx, ecx, edx); > + > + return !!(ebx & CPUID_LEAF7_EBX_AVX2_MASK); > +} > + > +static inline int cpu_has_avx512f(void) > +{ > + unsigned int eax, ebx, ecx, edx; > + > + /* CPUID.7.0:EBX.AVX512F[bit 16]: the support for AVX512F instructions */ > + __cpuid_count(7, 0, eax, ebx, ecx, edx); > + > + return !!(ebx & CPUID_LEAF7_EBX_AVX512F_MASK); > +} > + > +static inline int cpu_has_pkeys(void) > +{ > + unsigned int eax, ebx, ecx, edx; > + > + /* CPUID.7.0:ECX.PKU[bit 3]: the support for PKRU instructions */ > + __cpuid_count(7, 0, eax, ebx, ecx, edx); > + if (!(ecx & CPUID_LEAF7_ECX_PKU_MASK)) > + return NOT_SUPPORT; > + /* CPUID.7.0:ECX.OSPKE[bit 4]: the support for OS set CR4.PKE */ > + if (!(ecx & CPUID_LEAF7_ECX_OSPKE_MASK)) > + return NOT_SUPPORT; > + > + return SUPPORT; > +} You don't need that CPUID_LEAF7_ECX_PKU_MASK check. The OSPKE one is sufficient. > +static uint32_t get_xstate_size(void) > +{ > + uint32_t eax, ebx, ecx, edx; > + > + __cpuid_count(CPUID_LEAF_XSTATE, CPUID_SUBLEAF_XSTATE_USER, eax, ebx, > + ecx, edx); > + /* > + * EBX enumerates the size (in bytes) required by the XSAVE > + * instruction for an XSAVE area containing all the user state > + * components corresponding to bits currently set in XCR0. > + */ > + return ebx; > +} > + > +static struct xsave_buffer *alloc_xbuf(uint32_t buf_size) > +{ > + struct xsave_buffer *xbuf; > + > + /* XSAVE buffer should be 64B-aligned. */ > + xbuf = aligned_alloc(64, buf_size); > + if (!xbuf) > + fatal_error("aligned_alloc()"); > + > + return xbuf; > +} > + > +static inline void __xsave(struct xsave_buffer *xbuf, uint64_t rfbm) > +{ > + uint32_t rfbm_lo = rfbm; > + uint32_t rfbm_hi = rfbm >> 32; > + > + asm volatile("xsave (%%rdi)" > + : : "D" (xbuf), "a" (rfbm_lo), "d" (rfbm_hi) > + : "memory"); > +} > + > +static inline void __xrstor(struct xsave_buffer *xbuf, uint64_t rfbm) > +{ > + uint32_t rfbm_lo = rfbm; > + uint32_t rfbm_hi = rfbm >> 32; > + > + asm volatile("xrstor (%%rdi)" > + : : "D" (xbuf), "a" (rfbm_lo), "d" (rfbm_hi)); > +} Could you please move all of these generic functions into a common header? Maybe the same one with __cpuid()? > +static void sethandler(int sig, void (*handler)(int, siginfo_t *, void *), > + int flags) > +{ > + struct sigaction sa; > + > + memset(&sa, 0, sizeof(sa)); > + sa.sa_sigaction = handler; > + sa.sa_flags = SA_SIGINFO | flags; > + sigemptyset(&sa.sa_mask); > + if (sigaction(sig, &sa, 0)) > + fatal_error("sigaction"); > +} > + > +static void clearhandler(int sig) > +{ > + struct sigaction sa; > + > + memset(&sa, 0, sizeof(sa)); > + sa.sa_handler = SIG_DFL; > + sigemptyset(&sa.sa_mask); > + if (sigaction(sig, &sa, 0)) > + fatal_error("sigaction"); > +} > + > +/* Retrieve the offset and size of a specific xstate. */ > +static void retrieve_xstate_size_and_offset(uint32_t xfeature_num) > +{ > + uint32_t eax, ebx, ecx, edx; > + > + __cpuid_count(CPUID_LEAF_XSTATE, xfeature_num, eax, ebx, ecx, edx); > + /* > + * CPUID.(EAX=0xd, ECX=xfeature_num), and output is as follow: > + * eax: xfeature num state component size > + * ebx: xfeature num state component offset in user buffer > + */ > + xstate_info.size[xfeature_num] = eax; > + xstate_info.offset[xfeature_num] = ebx; > +} > + > +static inline void set_xstatebv(struct xsave_buffer *buffer, uint64_t bv) > +{ > + /* XSTATE_BV is at the beginning of xstate header. */ > + *(uint64_t *)(&buffer->header) = bv; > +} > + > +static void check_cpuid_xstate_info(void) > +{ > + /* CPUs that support XSAVE could support FP and SSE by default. */ > + xstate_info.mask = XFEATURE_MASK_FP | XFEATURE_MASK_SSE; > + > + xstate_size = get_xstate_size(); > + if (cpu_has_avx2()) { > + xstate_info.mask |= XFEATURE_MASK_YMM; > + retrieve_xstate_size_and_offset(XFEATURE_YMM); > + } > + > + if (cpu_has_avx512f()) { > + xstate_info.mask |= XFEATURE_MASK_OPMASK | XFEATURE_MASK_ZMM_Hi256 | > + XFEATURE_MASK_Hi16_ZMM; > + retrieve_xstate_size_and_offset(XFEATURE_OPMASK); > + retrieve_xstate_size_and_offset(XFEATURE_ZMM_Hi256); > + retrieve_xstate_size_and_offset(XFEATURE_Hi16_ZMM); > + } > + > + if (cpu_has_pkeys()) { > + xstate_info.mask |= XFEATURE_MASK_PKRU; > + retrieve_xstate_size_and_offset(XFEATURE_PKRU); > + } > +} > + > +static void fill_xstate_buf(uint8_t test_byte, unsigned char *buf, > + int xfeature_num) > +{ > + uint32_t i; > + > + for (i = 0; i < xstate_info.size[xfeature_num]; i++) > + buf[xstate_info.offset[xfeature_num] + i] = test_byte; > +} > + > +/* Fill FP/XMM/YMM/OPMASK and PKRU xstates into buffer. */ > +static void fill_xstates_buf(struct xsave_buffer *buf, uint32_t xsave_mask) > +{ > + uint32_t i; > + /* The data of FP x87 state are as follows. */ OK, but what *is* this? Random data? Or did you put some data in that means something? > + unsigned char fp_data[160] = { > + 0x7f, 0x03, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00, > + 0xf0, 0x19, 0x40, 0x00, 0x00, 0x00, 0x00, 0x00, > + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, > + 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0x00, 0x00, > + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, > + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, > + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, > + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, > + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, > + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, > + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, > + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, > + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, > + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, > + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, > + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, > + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, > + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, > + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, > + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }; > + > + /* Clean the buffer with all 0 first. */ > + memset(buf, 0, xstate_size); > + > + /* Fill fp x87 state: MXCSR and MXCSR_MASK data(0-159 bytes) into buffer. */ > + memcpy(buf, fp_data, FP_SIZE); > + > + /* > + * Fill test byte value into XMM xstate buffer(160-415 bytes). > + * xstate 416-511 bytes are reserved as 0. > + */ > + for (i = 0; i < XMM_SIZE; i++) > + *((unsigned char *)buf + XMM_OFFSET + i) = XSTATE_TESTBYTE; Isn't this just memset()? > + /* > + * Fill xstate-component bitmap(512-519 bytes) into xstate header. > + * xstate header range is 512-575 bytes. > + */ > + set_xstatebv(buf, xsave_mask); > + > + /* Fill test byte value into YMM xstate buffer(YMM offset/size). */ > + if (xstate_tested(XFEATURE_YMM)) > + fill_xstate_buf(XSTATE_TESTBYTE, (unsigned char *)buf, XFEATURE_YMM); > + > + /* > + * Fill test byte value into AVX512 OPMASK/ZMM xstates buffer > + * (AVX512_OPMASK/ZMM_Hi256/Hi16_ZMM offset/size). > + */ > + if (xstate_tested(XFEATURE_OPMASK)) > + fill_xstate_buf(XSTATE_TESTBYTE, (unsigned char *)buf, XFEATURE_OPMASK); > + if (xstate_tested(XFEATURE_ZMM_Hi256)) { > + fill_xstate_buf(XSTATE_TESTBYTE, (unsigned char *)buf, > + XFEATURE_ZMM_Hi256); > + } > + if (xstate_tested(XFEATURE_Hi16_ZMM)) { > + fill_xstate_buf(XSTATE_TESTBYTE, (unsigned char *)buf, > + XFEATURE_Hi16_ZMM); > + } > + > + if (xstate_tested(XFEATURE_PKRU)) { > + /* Only 0-3 bytes of pkru xstates are allowed to be written. */ > + memset((unsigned char *)buf + xstate_info.offset[XFEATURE_PKRU], > + PKRU_TESTBYTE, sizeof(uint32_t)); > + } > +} I have to wonder if we can do this in a bit more structured way: struct xstate_test { bool (*init)(void); bool (*fill_state)(struct xsave_buffer *buf); ... } Yes, that means indirect function calls, but that's OK since we know it will all be compiled with the "no-sse" flag (and friends). Then fill_xstates_buf() just becomes a loop over an xstate_tests[] array. > +/* > + * Because xstate like XMM, YMM registers are not preserved across function > + * calls, so use inline function with assembly code only for fork syscall. > + */ > +static inline long long __fork(void) > +{ > + long long ret, nr = SYS_fork; Are those the right types? 'long long' is 64-bit on 32-bit systems, iirc. > + asm volatile("syscall" > + : "=a" (ret) > + : "a" (nr), "b" (nr) > + : "rcx", "r11", "memory", "cc"); > + > + return ret; > +} > > +/* > + * Because xstate like XMM, YMM registers are not preserved across function > + * calls, so use inline function with assembly code only to raise signal. > + */ > +static inline long long __raise(long long pid_num, long long sig_num) > +{ > + long long ret, nr = SYS_kill; > + > + register long long arg1 asm("rdi") = pid_num; > + register long long arg2 asm("rsi") = sig_num; I really don't like register variables. They're very fragile. Imagine if someone put a printf() right here. Why don't you just do this with inline assembly directives? > + asm volatile("syscall" > + : "=a" (ret) > + : "a" (nr), "b" (nr), "r" (arg1), "r" (arg2) > + : "rcx", "r11", "memory", "cc"); > + > + return ret; > +} > + > +static void sigusr1_handler(int signum, siginfo_t *info, void *__ctxp) > +{ > + sigusr1_done = true; > +} > + > +static void test_xstate_sig_handle(void) > +{ > + pid_t process_pid; > + > + sethandler(SIGUSR1, sigusr1_handler, 0); > + printf("[RUN]\tCheck xstate around signal handling test.\n"); > + process_pid = getpid(); > + > + /* > + * Xrstor the valid_xbuf and call syscall assembly instruction, then > + * save the xstate to compared_xbuf after signal handling for comparison. > + */ > + __xrstor(valid_xbuf, xstate_info.mask); > + __raise(process_pid, SIGUSR1); > + __xsave(compared_xbuf, xstate_info.mask); > + if (sigusr1_done == true) > + printf("[NOTE]\tSIGUSR1 handling is done.\n"); > + else > + fatal_error("Didn't access SIGUSR1 handling after raised SIGUSR1"); > + > + if (memcmp(&valid_xbuf->bytes[0], &compared_xbuf->bytes[0], xstate_size)) > + printf("[FAIL]\tProcess xstate is not same after signal handling\n"); > + else > + printf("[PASS]\tProcess xstate is same after signal handling.\n"); > + > + clearhandler(SIGUSR1); > +} > + > +static void test_xstate_fork(void) > +{ > + pid_t child; > + int status; > + > + printf("[RUN]\tParent pid:%d check xstate around fork test.\n", getpid()); > + memset(compared_xbuf, 0, xstate_size); > + > + /* > + * Xrstor the valid_xbuf and call syscall assembly instruction, then > + * save the xstate to compared_xbuf in child process for comparison. > + */ > + __xrstor(valid_xbuf, xstate_info.mask); > + child = __fork(); > + if (child < 0) { > + /* Fork syscall failed */ > + fatal_error("fork failed"); > + } else if (child == 0) { > + /* Fork syscall succeeded, now in the child. */ > + __xsave(compared_xbuf, xstate_info.mask); > + if (memcmp(&valid_xbuf->bytes[0], &compared_xbuf->bytes[0], > + xstate_size)) { > + printf("[FAIL]\tXstate of child process:%d is not same as xstate of parent\n", > + getpid()); > + } else { > + printf("[PASS]\tXstate of child process:%d is same as xstate of parent.\n", > + getpid()); > + } > + } else { > + if (waitpid(child, &status, 0) != child || !WIFEXITED(status)) > + fatal_error("Child exit with error status"); It also couldn't hurt to check the XSAVE state in the parent.
On 2022-04-08 at 09:58:50 -0700, Dave Hansen wrote: > On 3/16/22 05:40, Pengfei Xu wrote: > > +#ifndef __cpuid_count > > +#define __cpuid_count(level, count, a, b, c, d) ({ \ > > + __asm__ __volatile__ ("cpuid\n\t" \ > > + : "=a" (a), "=b" (b), "=c" (c), "=d" (d) \ > > + : "0" (level), "2" (count)); \ > > +}) > > +#endif > > > By the time you post the next revision, I hope these are merged: > > > https://lore.kernel.org/all/cover.1647360971.git.reinette.chatre@intel.com/ > > Could you rebase on top of those to avoid duplication, please? > Yes, thanks for remind. I would like to use the helper __cpuid_count() based on above fixed patch. And I have a concern with stdlib.h with "-mno-sse" issue, it's a GCC bug, and it will be fixed in GCC11. And I could not use kselftest.h, because kselftest.h used stdlib.h also... > > +/* > > + * While this function prototype is in the stdlib.h, the header file cannot be > > + * included with the -mno-sse option. > > + */ > > +void *aligned_alloc(size_t alignment, size_t size); > > That is worrisome. I would serioulsy suspect that if the header can't > be included that the code that it references has issues as well. > > Or, is this just working around a compiler bug? Just googling: > > https://www.google.com/search?q=stdlib.h+no-sse > > points to this: > > https://sourceware.org/bugzilla/show_bug.cgi?id=27600 > Thanks for the link! From above "id=27600"link, Lu Hongjiu mentioned that: It's a "GCC bug: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=99652" And id=99652 shows that it's fixed in GCC 11. I tried "-mgeneral-regs-only"(it includes "-mno-sse"), it also gcc failed with same error as "-mno-sse": " /usr/include/bits/stdlib-float.h: In function ‘atof’: /usr/include/bits/stdlib-float.h:26:1: error: SSE register return with SSE disabled " And the error shows that: it's related to "stdlib-float.h", seems I didn't use stdlib-float.h related function. In order for this test code to support GCC versions before GCC11, such as GCC8, etc., I used this workaround "avoid stdlib.h" for GCC bug, and add *aligned_alloc() declaration above. Because kselftest.h uses stdlib.h also, so I could not use kselftest.h with "-mno-see" special GCC requirement, and seems I could not use __cpuid_count() patch in kselftest.h from Reinette Chatre. Thanks! > > +enum supportability { > > + NOT_SUPPORT, > > + SUPPORT, > > +}; > > + > > +/* It's from arch/x86/kernel/fpu/xstate.c. */ > > +static const char * const xfeature_names[] = { > > + "x87 floating point registers", > > + "SSE registers", > > + "AVX registers", > > + "MPX bounds registers", > > + "MPX CSR", > > + "AVX-512 opmask", > > + "AVX-512 Hi256", > > + "AVX-512 ZMM_Hi256", > > + "Processor Trace (unused)", > > + "Protection Keys User registers", > > + "PASID state", > > + "unknown xstate feature", > > + "unknown xstate feature", > > + "unknown xstate feature", > > + "unknown xstate feature", > > + "unknown xstate feature", > > + "unknown xstate feature", > > + "AMX Tile config", > > + "AMX Tile data", > > + "unknown xstate feature", > > +}; > > + > > +/* List of XSAVE features Linux knows about. */ > > +enum xfeature { > > + XFEATURE_FP, > > + XFEATURE_SSE, > > + /* > > + * Values above here are "legacy states". > > + * Those below are "extended states". > > + */ > > + XFEATURE_YMM, > > + XFEATURE_BNDREGS, > > + XFEATURE_BNDCSR, > > + XFEATURE_OPMASK, > > + XFEATURE_ZMM_Hi256, > > + XFEATURE_Hi16_ZMM, > > + XFEATURE_PT_UNIMPLEMENTED_SO_FAR, > > + XFEATURE_PKRU, > > + XFEATURE_PASID, > > + XFEATURE_RSRVD_COMP_11, > > + XFEATURE_RSRVD_COMP_12, > > + XFEATURE_RSRVD_COMP_13, > > + XFEATURE_RSRVD_COMP_14, > > + XFEATURE_LBR, > > + XFEATURE_RSRVD_COMP_16, > > + XFEATURE_XTILE_CFG, > > + XFEATURE_XTILE_DATA, > > + XFEATURE_MAX, > > +}; > > + > > +struct xsave_buffer { > > + union { > > + struct { > > + char legacy[XSAVE_HDR_OFFSET]; > > + char header[XSAVE_HDR_SIZE]; > > + char extended[0]; > > + }; > > + char bytes[0]; > > + }; > > +}; > > + > > +static struct { > > + uint64_t mask; > > + uint32_t size[XFEATURE_MAX]; > > + uint32_t offset[XFEATURE_MAX]; > > +} xstate_info; > > + > > +static inline void check_cpuid_xsave_availability(void) > > +{ > > + uint32_t eax, ebx, ecx, edx; > > + > > + /* > > + * CPUID.1:ECX.XSAVE[bit 26] enumerates general > > + * support for the XSAVE feature set, including > > + * XGETBV. > > + */ > > + __cpuid_count(1, 0, eax, ebx, ecx, edx); > > + if (!(ecx & CPUID_LEAF1_ECX_XSAVE_MASK)) > > + fatal_error("cpuid: no CPU xsave support"); > > + if (!(ecx & CPUID_LEAF1_ECX_OSXSAVE_MASK)) > > + fatal_error("cpuid: no OS xsave support"); > > +} > > Could you please use the standard selftest macros for these fatal > errors? Also, do these indicate that the test failed, or that it just > was not able to run? > Due to above reason, I could not use kselftest.h and ksft_exit(condition) in kselftest.h. Yes, my bad, it should not fatal error here, it should skip print because it was not able to run and exit here. Thanks! > > +static inline bool xstate_tested(int xfeature_num) > > +{ > > + return !!(xstate_info.mask & (1 << xfeature_num)); > > +} > > + > > +static inline int cpu_has_avx2(void) > > +{ > > + unsigned int eax, ebx, ecx, edx; > > + > > + /* CPUID.7.0:EBX.AVX2[bit 5]: the support for AVX2 instructions */ > > + __cpuid_count(7, 0, eax, ebx, ecx, edx); > > + > > + return !!(ebx & CPUID_LEAF7_EBX_AVX2_MASK); > > +} > > + > > +static inline int cpu_has_avx512f(void) > > +{ > > + unsigned int eax, ebx, ecx, edx; > > + > > + /* CPUID.7.0:EBX.AVX512F[bit 16]: the support for AVX512F instructions */ > > + __cpuid_count(7, 0, eax, ebx, ecx, edx); > > + > > + return !!(ebx & CPUID_LEAF7_EBX_AVX512F_MASK); > > +} > > + > > +static inline int cpu_has_pkeys(void) > > +{ > > + unsigned int eax, ebx, ecx, edx; > > + > > + /* CPUID.7.0:ECX.PKU[bit 3]: the support for PKRU instructions */ > > + __cpuid_count(7, 0, eax, ebx, ecx, edx); > > + if (!(ecx & CPUID_LEAF7_ECX_PKU_MASK)) > > + return NOT_SUPPORT; > > + /* CPUID.7.0:ECX.OSPKE[bit 4]: the support for OS set CR4.PKE */ > > + if (!(ecx & CPUID_LEAF7_ECX_OSPKE_MASK)) > > + return NOT_SUPPORT; > > + > > + return SUPPORT; > > +} > > You don't need that CPUID_LEAF7_ECX_PKU_MASK check. The OSPKE one is > sufficient. > Thanks for suggestion, it make sense, I will fix it in next version. > > +static uint32_t get_xstate_size(void) > > +{ > > + uint32_t eax, ebx, ecx, edx; > > + > > + __cpuid_count(CPUID_LEAF_XSTATE, CPUID_SUBLEAF_XSTATE_USER, eax, ebx, > > + ecx, edx); > > + /* > > + * EBX enumerates the size (in bytes) required by the XSAVE > > + * instruction for an XSAVE area containing all the user state > > + * components corresponding to bits currently set in XCR0. > > + */ > > + return ebx; > > +} > > + > > +static struct xsave_buffer *alloc_xbuf(uint32_t buf_size) > > +{ > > + struct xsave_buffer *xbuf; > > + > > + /* XSAVE buffer should be 64B-aligned. */ > > + xbuf = aligned_alloc(64, buf_size); > > + if (!xbuf) > > + fatal_error("aligned_alloc()"); > > + > > + return xbuf; > > +} > > + > > +static inline void __xsave(struct xsave_buffer *xbuf, uint64_t rfbm) > > +{ > > + uint32_t rfbm_lo = rfbm; > > + uint32_t rfbm_hi = rfbm >> 32; > > + > > + asm volatile("xsave (%%rdi)" > > + : : "D" (xbuf), "a" (rfbm_lo), "d" (rfbm_hi) > > + : "memory"); > > +} > > + > > +static inline void __xrstor(struct xsave_buffer *xbuf, uint64_t rfbm) > > +{ > > + uint32_t rfbm_lo = rfbm; > > + uint32_t rfbm_hi = rfbm >> 32; > > + > > + asm volatile("xrstor (%%rdi)" > > + : : "D" (xbuf), "a" (rfbm_lo), "d" (rfbm_hi)); > > +} > > Could you please move all of these generic functions into a common > header? Maybe the same one with __cpuid()? > Yes, it looks better, I will move these generic functions to xstate.h. Thanks! > > +static void sethandler(int sig, void (*handler)(int, siginfo_t *, void *), > > + int flags) > > +{ > > + struct sigaction sa; > > + > > + memset(&sa, 0, sizeof(sa)); > > + sa.sa_sigaction = handler; > > + sa.sa_flags = SA_SIGINFO | flags; > > + sigemptyset(&sa.sa_mask); > > + if (sigaction(sig, &sa, 0)) > > + fatal_error("sigaction"); > > +} > > + > > +static void clearhandler(int sig) > > +{ > > + struct sigaction sa; > > + > > + memset(&sa, 0, sizeof(sa)); > > + sa.sa_handler = SIG_DFL; > > + sigemptyset(&sa.sa_mask); > > + if (sigaction(sig, &sa, 0)) > > + fatal_error("sigaction"); > > +} > > + > > +/* Retrieve the offset and size of a specific xstate. */ > > +static void retrieve_xstate_size_and_offset(uint32_t xfeature_num) > > +{ > > + uint32_t eax, ebx, ecx, edx; > > + > > + __cpuid_count(CPUID_LEAF_XSTATE, xfeature_num, eax, ebx, ecx, edx); > > + /* > > + * CPUID.(EAX=0xd, ECX=xfeature_num), and output is as follow: > > + * eax: xfeature num state component size > > + * ebx: xfeature num state component offset in user buffer > > + */ > > + xstate_info.size[xfeature_num] = eax; > > + xstate_info.offset[xfeature_num] = ebx; > > +} > > + > > +static inline void set_xstatebv(struct xsave_buffer *buffer, uint64_t bv) > > +{ > > + /* XSTATE_BV is at the beginning of xstate header. */ > > + *(uint64_t *)(&buffer->header) = bv; > > +} > > + > > +static void check_cpuid_xstate_info(void) > > +{ > > + /* CPUs that support XSAVE could support FP and SSE by default. */ > > + xstate_info.mask = XFEATURE_MASK_FP | XFEATURE_MASK_SSE; > > + > > + xstate_size = get_xstate_size(); > > + if (cpu_has_avx2()) { > > + xstate_info.mask |= XFEATURE_MASK_YMM; > > + retrieve_xstate_size_and_offset(XFEATURE_YMM); > > + } > > + > > + if (cpu_has_avx512f()) { > > + xstate_info.mask |= XFEATURE_MASK_OPMASK | XFEATURE_MASK_ZMM_Hi256 | > > + XFEATURE_MASK_Hi16_ZMM; > > + retrieve_xstate_size_and_offset(XFEATURE_OPMASK); > > + retrieve_xstate_size_and_offset(XFEATURE_ZMM_Hi256); > > + retrieve_xstate_size_and_offset(XFEATURE_Hi16_ZMM); > > + } > > + > > + if (cpu_has_pkeys()) { > > + xstate_info.mask |= XFEATURE_MASK_PKRU; > > + retrieve_xstate_size_and_offset(XFEATURE_PKRU); > > + } > > +} > > + > > +static void fill_xstate_buf(uint8_t test_byte, unsigned char *buf, > > + int xfeature_num) > > +{ > > + uint32_t i; > > + > > + for (i = 0; i < xstate_info.size[xfeature_num]; i++) > > + buf[xstate_info.offset[xfeature_num] + i] = test_byte; > > +} > > + > > +/* Fill FP/XMM/YMM/OPMASK and PKRU xstates into buffer. */ > > +static void fill_xstates_buf(struct xsave_buffer *buf, uint32_t xsave_mask) > > +{ > > + uint32_t i; > > + /* The data of FP x87 state are as follows. */ > > OK, but what *is* this? Random data? Or did you put some data in that > means something? > I learned from filling the fp data by follow functions: fill FPU xstate by fldl instructions, push the source operand onto the FPU register stack and recorded the fp xstate, then used buffer filling way to fill the fpu xstates: Some fp data could be set as random value under the "FP in SDM rules". Shall I add the comment for the fpu data filling like as follow: " /* * The data of FP x87 state has the same effect as pushing source operand * 0x1f2f3f4f1f2f3f4f onto the FPU stack ST0-7. */ unsigned char fp_data[160] = {... " As follow is the pushing source operand 0x1f2f3f4f1f2f3f4f onto the FPU stack ST0-7: " static inline void prepare_fp_buf(uint64_t ui64_fp) { /* Populate ui64_fp value onto FP registers stack ST0-7. */ asm volatile("finit"); asm volatile("fldl %0" : : "m" (ui64_fp)); asm volatile("fldl %0" : : "m" (ui64_fp)); asm volatile("fldl %0" : : "m" (ui64_fp)); asm volatile("fldl %0" : : "m" (ui64_fp)); asm volatile("fldl %0" : : "m" (ui64_fp)); asm volatile("fldl %0" : : "m" (ui64_fp)); asm volatile("fldl %0" : : "m" (ui64_fp)); asm volatile("fldl %0" : : "m" (ui64_fp)); } ... prepare_fp_buf(0x1f2f3f4f); __xsave(buf, xstate_info.mask); " The code to set fp data and display xstate is as follow: https://github.com/xupengfe/xstate_show/blob/0411_fp/x86/xstate.c I found there were 2 different: > > + unsigned char fp_data[160] = { > > + 0x7f, 0x03, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00, > > + 0xf0, 0x19, 0x40, 0x00, 0x00, 0x00, 0x00, 0x00, ^Above function shows "0xff, 0x12" not "0xf0, 0x19" in 0x8/0x9 offset bytes: Bytes 11:8 are used for bits 31:0 of the x87 FPU Instruction Pointer Offset(FIP). It could be impacted if I added "vzeroall" and so on instructions, in order to match with above fpu function result, will change to "0xff, 0x12". > > + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, > > + 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0x00, 0x00, ^Above function shows "0x80, 0x1f" not "0x00, 0x00" in offset 0x18/0x19 bytes: Bytes 27:24 are used for the MXCSR register. XRSTOR and XRSTORS generate general-protection faults (#GP) in response to attempts to set any of the reserved bits of the MXCSR register. It could be set as "0x00, 0x00", in order to match with result of above function, will fill as "0x80, 0x1f". > > + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, > > + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, > > + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, > > + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, > > + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, > > + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, > > + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, > > + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, > > + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, > > + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, > > + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, > > + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, > > + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, > > + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, > > + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, > > + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }; > > + > > + /* Clean the buffer with all 0 first. */ > > + memset(buf, 0, xstate_size); > > + > > + /* Fill fp x87 state: MXCSR and MXCSR_MASK data(0-159 bytes) into buffer. */ > > + memcpy(buf, fp_data, FP_SIZE); > > + > > + /* > > + * Fill test byte value into XMM xstate buffer(160-415 bytes). > > + * xstate 416-511 bytes are reserved as 0. > > + */ > > + for (i = 0; i < XMM_SIZE; i++) > > + *((unsigned char *)buf + XMM_OFFSET + i) = XSTATE_TESTBYTE; > > Isn't this just memset()? > Yes, it's better, thanks! I will fix it as follow: memset((unsigned char *)buf + XMM_OFFSET, XSTATE_TESTBYTE, XMM_SIZE); And fix same issue in fill_xstate_buf(); > > + /* > > + * Fill xstate-component bitmap(512-519 bytes) into xstate header. > > + * xstate header range is 512-575 bytes. > > + */ > > + set_xstatebv(buf, xsave_mask); > > + > > + /* Fill test byte value into YMM xstate buffer(YMM offset/size). */ > > + if (xstate_tested(XFEATURE_YMM)) > > + fill_xstate_buf(XSTATE_TESTBYTE, (unsigned char *)buf, XFEATURE_YMM); > > + > > + /* > > + * Fill test byte value into AVX512 OPMASK/ZMM xstates buffer > > + * (AVX512_OPMASK/ZMM_Hi256/Hi16_ZMM offset/size). > > + */ > > + if (xstate_tested(XFEATURE_OPMASK)) > > + fill_xstate_buf(XSTATE_TESTBYTE, (unsigned char *)buf, XFEATURE_OPMASK); > > + if (xstate_tested(XFEATURE_ZMM_Hi256)) { > > + fill_xstate_buf(XSTATE_TESTBYTE, (unsigned char *)buf, > > + XFEATURE_ZMM_Hi256); > > + } > > + if (xstate_tested(XFEATURE_Hi16_ZMM)) { > > + fill_xstate_buf(XSTATE_TESTBYTE, (unsigned char *)buf, > > + XFEATURE_Hi16_ZMM); > > + } > > + > > + if (xstate_tested(XFEATURE_PKRU)) { > > + /* Only 0-3 bytes of pkru xstates are allowed to be written. */ > > + memset((unsigned char *)buf + xstate_info.offset[XFEATURE_PKRU], > > + PKRU_TESTBYTE, sizeof(uint32_t)); > > + } > > +} > > I have to wonder if we can do this in a bit more structured way: > > struct xstate_test > { > bool (*init)(void); > bool (*fill_state)(struct xsave_buffer *buf); > ... > } > > Yes, that means indirect function calls, but that's OK since we know it > will all be compiled with the "no-sse" flag (and friends). > > Then fill_xstates_buf() just becomes a loop over an xstate_tests[] array. > Yes, it's much better to fill the buf in a loop! Thanks! Because it's special for pkru filling, so I will improve it like as follow: " uint32_t xfeature_num; ... /* Fill test byte value into each tested xstate buffer(offset/size). */ for (xfeature_num = XFEATURE_YMM; xfeature_num < XFEATURE_MAX; xfeature_num++) { if (xstate_tested(xfeature_num)) { if (xfeature_num == XFEATURE_PKRU) { /* Only 0-3 bytes of pkru xstates are allowed to be written. */ memset((unsigned char *)buf + xstate_info.offset[XFEATURE_PKRU], PKRU_TESTBYTE, sizeof(uint32_t)); continue; } memset((unsigned char *)buf + xstate_info.offset[xfeature_num], XSTATE_TESTBYTE, xstate_info.size[xfeature_num]); } } " > > +/* > > + * Because xstate like XMM, YMM registers are not preserved across function > > + * calls, so use inline function with assembly code only for fork syscall. > > + */ > > +static inline long long __fork(void) > > +{ > > + long long ret, nr = SYS_fork; > > Are those the right types? 'long long' is 64-bit on 32-bit systems, iirc. > Thnaks for suggestion, it should be long. Long type is 64bit in 64bit system, and 32bit for 32bit system. > > + asm volatile("syscall" > > + : "=a" (ret) > > + : "a" (nr), "b" (nr) > > + : "rcx", "r11", "memory", "cc"); > > + > > + return ret; > > +} > > > > +/* > > + * Because xstate like XMM, YMM registers are not preserved across function > > + * calls, so use inline function with assembly code only to raise signal. > > + */ > > +static inline long long __raise(long long pid_num, long long sig_num) > > +{ > > + long long ret, nr = SYS_kill; > > + > > + register long long arg1 asm("rdi") = pid_num; > > + register long long arg2 asm("rsi") = sig_num; > > I really don't like register variables. They're very fragile. Imagine > if someone put a printf() right here. Why don't you just do this with > inline assembly directives? > It seems that adding printf() to an inline function is not good. I'm not sure if I understand correctly: should I use inline assembly to assign variables to rdi, rsi and then syscall? It it's right, I will think about how to implement it by inline assembly way and fix it. Thanks! > > + asm volatile("syscall" > > + : "=a" (ret) > > + : "a" (nr), "b" (nr), "r" (arg1), "r" (arg2) > > + : "rcx", "r11", "memory", "cc"); > > + > > + return ret; > > +} > > + > > +static void sigusr1_handler(int signum, siginfo_t *info, void *__ctxp) > > +{ > > + sigusr1_done = true; > > +} > > + > > +static void test_xstate_sig_handle(void) > > +{ > > + pid_t process_pid; > > + > > + sethandler(SIGUSR1, sigusr1_handler, 0); > > + printf("[RUN]\tCheck xstate around signal handling test.\n"); > > + process_pid = getpid(); > > + > > + /* > > + * Xrstor the valid_xbuf and call syscall assembly instruction, then > > + * save the xstate to compared_xbuf after signal handling for comparison. > > + */ > > + __xrstor(valid_xbuf, xstate_info.mask); > > + __raise(process_pid, SIGUSR1); > > + __xsave(compared_xbuf, xstate_info.mask); > > + if (sigusr1_done == true) > > + printf("[NOTE]\tSIGUSR1 handling is done.\n"); > > + else > > + fatal_error("Didn't access SIGUSR1 handling after raised SIGUSR1"); > > + > > + if (memcmp(&valid_xbuf->bytes[0], &compared_xbuf->bytes[0], xstate_size)) > > + printf("[FAIL]\tProcess xstate is not same after signal handling\n"); > > + else > > + printf("[PASS]\tProcess xstate is same after signal handling.\n"); > > + > > + clearhandler(SIGUSR1); > > +} > > + > > +static void test_xstate_fork(void) > > +{ > > + pid_t child; > > + int status; > > + > > + printf("[RUN]\tParent pid:%d check xstate around fork test.\n", getpid()); > > + memset(compared_xbuf, 0, xstate_size); > > + > > + /* > > + * Xrstor the valid_xbuf and call syscall assembly instruction, then > > + * save the xstate to compared_xbuf in child process for comparison. > > + */ > > + __xrstor(valid_xbuf, xstate_info.mask); > > + child = __fork(); > > + if (child < 0) { > > + /* Fork syscall failed */ > > + fatal_error("fork failed"); > > + } else if (child == 0) { > > + /* Fork syscall succeeded, now in the child. */ > > + __xsave(compared_xbuf, xstate_info.mask); > > + if (memcmp(&valid_xbuf->bytes[0], &compared_xbuf->bytes[0], > > + xstate_size)) { > > + printf("[FAIL]\tXstate of child process:%d is not same as xstate of parent\n", > > + getpid()); > > + } else { > > + printf("[PASS]\tXstate of child process:%d is same as xstate of parent.\n", > > + getpid()); > > + } > > + } else { > > + if (waitpid(child, &status, 0) != child || !WIFEXITED(status)) > > + fatal_error("Child exit with error status"); > > It also couldn't hurt to check the XSAVE state in the parent. Thanks for suggestion! I will add the check point back. Thanks! --Pengfei
On 4/11/22 03:14, Pengfei Xu wrote: > On 2022-04-08 at 09:58:50 -0700, Dave Hansen wrote: >> On 3/16/22 05:40, Pengfei Xu wrote: >>> +#ifndef __cpuid_count >>> +#define __cpuid_count(level, count, a, b, c, d) ({ \ >>> + __asm__ __volatile__ ("cpuid\n\t" \ >>> + : "=a" (a), "=b" (b), "=c" (c), "=d" (d) \ >>> + : "0" (level), "2" (count)); \ >>> +}) >>> +#endif >> >> >> By the time you post the next revision, I hope these are merged: >> >>> https://lore.kernel.org/all/cover.1647360971.git.reinette.chatre@intel.com/ >> >> Could you rebase on top of those to avoid duplication, please? >> > Yes, thanks for remind. I would like to use the helper __cpuid_count() based > on above fixed patch. > And I have a concern with stdlib.h with "-mno-sse" issue, it's a GCC bug, > and it will be fixed in GCC11. And I could not use kselftest.h, because > kselftest.h used stdlib.h also... Ugh. What a mess. > Thanks for the link! From above "id=27600"link, Lu Hongjiu mentioned that: > It's a "GCC bug: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=99652" > And id=99652 shows that it's fixed in GCC 11. > I tried "-mgeneral-regs-only"(it includes "-mno-sse"), it also gcc failed > with same error as "-mno-sse": > " > /usr/include/bits/stdlib-float.h: In function ‘atof’: > /usr/include/bits/stdlib-float.h:26:1: error: SSE register return with SSE disabled > " > And the error shows that: it's related to "stdlib-float.h", seems I didn't > use stdlib-float.h related function. > > In order for this test code to support GCC versions before GCC11, such as > GCC8, etc., I used this workaround "avoid stdlib.h" for GCC bug, and add > *aligned_alloc() declaration above. > > Because kselftest.h uses stdlib.h also, so I could not use kselftest.h with > "-mno-see" special GCC requirement, and seems I could not use __cpuid_count() > patch in kselftest.h from Reinette Chatre. > Thanks! Can you break this test up into two pieces which are spread across two .c files? One that *just* does the sequences that need XSAVE and to preserve FPU state with -mno-sse, and then a separate one that uses stdlib.h and also the kselftest infrastructure? For instance, all of the detection and enumeration can be in the nornal .c file. ... >>> +/* Fill FP/XMM/YMM/OPMASK and PKRU xstates into buffer. */ >>> +static void fill_xstates_buf(struct xsave_buffer *buf, uint32_t xsave_mask) >>> +{ >>> + uint32_t i; >>> + /* The data of FP x87 state are as follows. */ >> >> OK, but what *is* this? Random data? Or did you put some data in that >> means something? >> > I learned from filling the fp data by follow functions: fill FPU xstate > by fldl instructions, push the source operand onto the FPU register stack > and recorded the fp xstate, then used buffer filling way > to fill the fpu xstates: > Some fp data could be set as random value under the "FP in SDM rules". > Shall I add the comment for the fpu data filling like as follow: > " > /* > * The data of FP x87 state has the same effect as pushing source operand > * 0x1f2f3f4f1f2f3f4f onto the FPU stack ST0-7. > */ > unsigned char fp_data[160] = {... > " No, that's hideous. If you generated the fp state with code, let's include the *code*. > As follow is the pushing source operand 0x1f2f3f4f1f2f3f4f onto the FPU stack > ST0-7: > " > static inline void prepare_fp_buf(uint64_t ui64_fp) > { > /* Populate ui64_fp value onto FP registers stack ST0-7. */ > asm volatile("finit"); > asm volatile("fldl %0" : : "m" (ui64_fp)); > asm volatile("fldl %0" : : "m" (ui64_fp)); > asm volatile("fldl %0" : : "m" (ui64_fp)); > asm volatile("fldl %0" : : "m" (ui64_fp)); > asm volatile("fldl %0" : : "m" (ui64_fp)); > asm volatile("fldl %0" : : "m" (ui64_fp)); > asm volatile("fldl %0" : : "m" (ui64_fp)); > asm volatile("fldl %0" : : "m" (ui64_fp)); > } > ... > prepare_fp_buf(0x1f2f3f4f); > __xsave(buf, xstate_info.mask); > " > > The code to set fp data and display xstate is as follow: > https://github.com/xupengfe/xstate_show/blob/0411_fp/x86/xstate.c > > I found there were 2 different: >>> + unsigned char fp_data[160] = { >>> + 0x7f, 0x03, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00, >>> + 0xf0, 0x19, 0x40, 0x00, 0x00, 0x00, 0x00, 0x00, > ^Above function shows "0xff, 0x12" not "0xf0, 0x19" in 0x8/0x9 > offset bytes: > Bytes 11:8 are used for bits 31:0 of the x87 FPU Instruction Pointer > Offset(FIP). It could be impacted if I added "vzeroall" and so on instructions, > in order to match with above fpu function result, will change to "0xff, 0x12". > >>> + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, >>> + 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0x00, 0x00, > ^Above function shows "0x80, 0x1f" not "0x00, 0x00" in offset > 0x18/0x19 bytes: > Bytes 27:24 are used for the MXCSR register. XRSTOR and XRSTORS generate > general-protection faults (#GP) in response to attempts to set any of the > reserved bits of the MXCSR register. > It could be set as "0x00, 0x00", in order to match with result of above > function, will fill as "0x80, 0x1f". I'm totally lost with what you are trying to say here. ... >> I have to wonder if we can do this in a bit more structured way: >> >> struct xstate_test >> { >> bool (*init)(void); >> bool (*fill_state)(struct xsave_buffer *buf); >> ... >> } >> >> Yes, that means indirect function calls, but that's OK since we know it >> will all be compiled with the "no-sse" flag (and friends). >> >> Then fill_xstates_buf() just becomes a loop over an xstate_tests[] array. >> > Yes, it's much better to fill the buf in a loop! Thanks! > Because it's special for pkru filling, so I will improve it like as follow: > " > uint32_t xfeature_num; > ... > > /* Fill test byte value into each tested xstate buffer(offset/size). */ > for (xfeature_num = XFEATURE_YMM; xfeature_num < XFEATURE_MAX; > xfeature_num++) { > if (xstate_tested(xfeature_num)) { > if (xfeature_num == XFEATURE_PKRU) { > /* Only 0-3 bytes of pkru xstates are allowed to be written. */ > memset((unsigned char *)buf + xstate_info.offset[XFEATURE_PKRU], > PKRU_TESTBYTE, sizeof(uint32_t)); > continue; > } > > memset((unsigned char *)buf + xstate_info.offset[xfeature_num], > XSTATE_TESTBYTE, xstate_info.size[xfeature_num]); > } > } > " I'm not sure that's an improvement. >>> +/* >>> + * Because xstate like XMM, YMM registers are not preserved across function >>> + * calls, so use inline function with assembly code only to raise signal. >>> + */ >>> +static inline long long __raise(long long pid_num, long long sig_num) >>> +{ >>> + long long ret, nr = SYS_kill; >>> + >>> + register long long arg1 asm("rdi") = pid_num; >>> + register long long arg2 asm("rsi") = sig_num; >> >> I really don't like register variables. They're very fragile. Imagine >> if someone put a printf() right here. Why don't you just do this with >> inline assembly directives? >> > It seems that adding printf() to an inline function is not good. > I'm not sure if I understand correctly: should I use inline assembly to > assign variables to rdi, rsi and then syscall? > It it's right, I will think about how to implement it by inline assembly way > and fix it. Yes, do it with inline assembly.
On 2022-04-11 at 07:42:53 -0700, Dave Hansen wrote: > On 4/11/22 03:14, Pengfei Xu wrote: > > On 2022-04-08 at 09:58:50 -0700, Dave Hansen wrote: > >> On 3/16/22 05:40, Pengfei Xu wrote: > >>> +#ifndef __cpuid_count > >>> +#define __cpuid_count(level, count, a, b, c, d) ({ \ > >>> + __asm__ __volatile__ ("cpuid\n\t" \ > >>> + : "=a" (a), "=b" (b), "=c" (c), "=d" (d) \ > >>> + : "0" (level), "2" (count)); \ > >>> +}) > >>> +#endif > >> > >> > >> By the time you post the next revision, I hope these are merged: > >> > >>> https://lore.kernel.org/all/cover.1647360971.git.reinette.chatre@intel.com/ > >> > >> Could you rebase on top of those to avoid duplication, please? > >> > > Yes, thanks for remind. I would like to use the helper __cpuid_count() based > > on above fixed patch. > > And I have a concern with stdlib.h with "-mno-sse" issue, it's a GCC bug, > > and it will be fixed in GCC11. And I could not use kselftest.h, because > > kselftest.h used stdlib.h also... > > Ugh. What a mess. > I found the solution you mentioned as follow. I will try to fix it. Thanks! > > Thanks for the link! From above "id=27600"link, Lu Hongjiu mentioned that: > > It's a "GCC bug: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=99652" > > And id=99652 shows that it's fixed in GCC 11. > > I tried "-mgeneral-regs-only"(it includes "-mno-sse"), it also gcc failed > > with same error as "-mno-sse": > > " > > /usr/include/bits/stdlib-float.h: In function ‘atof’: > > /usr/include/bits/stdlib-float.h:26:1: error: SSE register return with SSE disabled > > " > > And the error shows that: it's related to "stdlib-float.h", seems I didn't > > use stdlib-float.h related function. > > > > In order for this test code to support GCC versions before GCC11, such as > > GCC8, etc., I used this workaround "avoid stdlib.h" for GCC bug, and add > > *aligned_alloc() declaration above. > > > > Because kselftest.h uses stdlib.h also, so I could not use kselftest.h with > > "-mno-see" special GCC requirement, and seems I could not use __cpuid_count() > > patch in kselftest.h from Reinette Chatre. > > Thanks! > > Can you break this test up into two pieces which are spread across two > .c files? One that *just* does the sequences that need XSAVE and to > preserve FPU state with -mno-sse, and then a separate one that uses > stdlib.h and also the kselftest infrastructure? > > For instance, all of the detection and enumeration can be in the nornal > .c file. > Thanks a lot for suggestion! I will put normal function in "prepare_xstate.c", and there is a "prepare_xstate.h" also. Only keep _xsave, _xrstor, key test function in xstate.c. gcc -xx(some other parm) -c prepare_xstate.c gcc -xx -mno-sse xstate.c prepare_xstate.o > ... > >>> +/* Fill FP/XMM/YMM/OPMASK and PKRU xstates into buffer. */ > >>> +static void fill_xstates_buf(struct xsave_buffer *buf, uint32_t xsave_mask) > >>> +{ > >>> + uint32_t i; > >>> + /* The data of FP x87 state are as follows. */ > >> > >> OK, but what *is* this? Random data? Or did you put some data in that > >> means something? > >> > > I learned from filling the fp data by follow functions: fill FPU xstate > > by fldl instructions, push the source operand onto the FPU register stack > > and recorded the fp xstate, then used buffer filling way > > to fill the fpu xstates: > > Some fp data could be set as random value under the "FP in SDM rules". > > Shall I add the comment for the fpu data filling like as follow: > > " > > /* > > * The data of FP x87 state has the same effect as pushing source operand > > * 0x1f2f3f4f1f2f3f4f onto the FPU stack ST0-7. > > */ > > unsigned char fp_data[160] = {... > > " > > No, that's hideous. If you generated the fp state with code, let's > include the *code*. > Thanks for suggestion. Yes, I could use fp instructions back and xsave inline function to xsave fp xstate into buf. I will think about it. Thanks! > > As follow is the pushing source operand 0x1f2f3f4f1f2f3f4f onto the FPU stack > > ST0-7: > > " > > static inline void prepare_fp_buf(uint64_t ui64_fp) > > { > > /* Populate ui64_fp value onto FP registers stack ST0-7. */ > > asm volatile("finit"); > > asm volatile("fldl %0" : : "m" (ui64_fp)); > > asm volatile("fldl %0" : : "m" (ui64_fp)); > > asm volatile("fldl %0" : : "m" (ui64_fp)); > > asm volatile("fldl %0" : : "m" (ui64_fp)); > > asm volatile("fldl %0" : : "m" (ui64_fp)); > > asm volatile("fldl %0" : : "m" (ui64_fp)); > > asm volatile("fldl %0" : : "m" (ui64_fp)); > > asm volatile("fldl %0" : : "m" (ui64_fp)); > > } > > ... > > prepare_fp_buf(0x1f2f3f4f); > > __xsave(buf, xstate_info.mask); > > " > > > > The code to set fp data and display xstate is as follow: > > https://github.com/xupengfe/xstate_show/blob/0411_fp/x86/xstate.c > > > > I found there were 2 different: > >>> + unsigned char fp_data[160] = { > >>> + 0x7f, 0x03, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00, > >>> + 0xf0, 0x19, 0x40, 0x00, 0x00, 0x00, 0x00, 0x00, > > ^Above function shows "0xff, 0x12" not "0xf0, 0x19" in 0x8/0x9 > > offset bytes: > > Bytes 11:8 are used for bits 31:0 of the x87 FPU Instruction Pointer > > Offset(FIP). It could be impacted if I added "vzeroall" and so on instructions, > > in order to match with above fpu function result, will change to "0xff, 0x12". > > > >>> + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, > >>> + 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0x00, 0x00, > > ^Above function shows "0x80, 0x1f" not "0x00, 0x00" in offset > > 0x18/0x19 bytes: > > Bytes 27:24 are used for the MXCSR register. XRSTOR and XRSTORS generate > > general-protection faults (#GP) in response to attempts to set any of the > > reserved bits of the MXCSR register. > > It could be set as "0x00, 0x00", in order to match with result of above > > function, will fill as "0x80, 0x1f". > > I'm totally lost with what you are trying to say here. > I used above "finit, fldl" instructions way to populate fp xstates as before. Sorry for unclear description. > ... > >> I have to wonder if we can do this in a bit more structured way: > >> > >> struct xstate_test > >> { > >> bool (*init)(void); > >> bool (*fill_state)(struct xsave_buffer *buf); > >> ... > >> } > >> > >> Yes, that means indirect function calls, but that's OK since we know it > >> will all be compiled with the "no-sse" flag (and friends). > >> > >> Then fill_xstates_buf() just becomes a loop over an xstate_tests[] array. > >> > > Yes, it's much better to fill the buf in a loop! Thanks! > > Because it's special for pkru filling, so I will improve it like as follow: > > " > > uint32_t xfeature_num; > > ... > > > > /* Fill test byte value into each tested xstate buffer(offset/size). */ > > for (xfeature_num = XFEATURE_YMM; xfeature_num < XFEATURE_MAX; > > xfeature_num++) { > > if (xstate_tested(xfeature_num)) { > > if (xfeature_num == XFEATURE_PKRU) { > > /* Only 0-3 bytes of pkru xstates are allowed to be written. */ > > memset((unsigned char *)buf + xstate_info.offset[XFEATURE_PKRU], > > PKRU_TESTBYTE, sizeof(uint32_t)); > > continue; > > } > > > > memset((unsigned char *)buf + xstate_info.offset[xfeature_num], > > XSTATE_TESTBYTE, xstate_info.size[xfeature_num]); > > } > > } > > " > > I'm not sure that's an improvement. > Ok. Except FP and xstate_bv, this loop will fill each tested value into xstate buffer. Thanks! > >>> +/* > >>> + * Because xstate like XMM, YMM registers are not preserved across function > >>> + * calls, so use inline function with assembly code only to raise signal. > >>> + */ > >>> +static inline long long __raise(long long pid_num, long long sig_num) > >>> +{ > >>> + long long ret, nr = SYS_kill; > >>> + > >>> + register long long arg1 asm("rdi") = pid_num; > >>> + register long long arg2 asm("rsi") = sig_num; > >> > >> I really don't like register variables. They're very fragile. Imagine > >> if someone put a printf() right here. Why don't you just do this with > >> inline assembly directives? > >> > > It seems that adding printf() to an inline function is not good. > > I'm not sure if I understand correctly: should I use inline assembly to > > assign variables to rdi, rsi and then syscall? > > It it's right, I will think about how to implement it by inline assembly way > > and fix it. > > Yes, do it with inline assembly. > I will move value into rdi rsi register as inline assembly like follow: asm volatile("movq %0, %%rdi" : : "r"(pid_num) : "%rdi"); Thanks! --Pengfei
diff --git a/tools/testing/selftests/x86/Makefile b/tools/testing/selftests/x86/Makefile index 8a1f62ab3c8e..19cc548cdd1e 100644 --- a/tools/testing/selftests/x86/Makefile +++ b/tools/testing/selftests/x86/Makefile @@ -18,7 +18,7 @@ TARGETS_C_32BIT_ONLY := entry_from_vm86 test_syscall_vdso unwind_vdso \ test_FCMOV test_FCOMI test_FISTTP \ vdso_restorer TARGETS_C_64BIT_ONLY := fsgsbase sysret_rip syscall_numbering \ - corrupt_xstate_header amx + corrupt_xstate_header amx xstate # Some selftests require 32bit support enabled also on 64bit systems TARGETS_C_32BIT_NEEDED := ldt_gdt ptrace_syscall @@ -105,3 +105,4 @@ $(OUTPUT)/test_syscall_vdso_32: thunks_32.S # state. $(OUTPUT)/check_initial_reg_state_32: CFLAGS += -Wl,-ereal_start -static $(OUTPUT)/check_initial_reg_state_64: CFLAGS += -Wl,-ereal_start -static +$(OUTPUT)/xstate_64: CFLAGS += -mno-sse -mno-mmx -mno-sse2 -mno-avx -mno-pku diff --git a/tools/testing/selftests/x86/xstate.c b/tools/testing/selftests/x86/xstate.c new file mode 100644 index 000000000000..818769e38a66 --- /dev/null +++ b/tools/testing/selftests/x86/xstate.c @@ -0,0 +1,574 @@ +// SPDX-License-Identifier: GPL-2.0-only +/* + * xstate.c - tests XSAVE feature with fork and signal handling. + * + * The XSAVE feature set supports the saving and restoring of state components. + * It tests "FP, SSE(XMM), AVX2(YMM), AVX512_OPMASK/AVX512_ZMM_Hi256/ + * AVX512_Hi16_ZMM and PKRU parts" xstates with following cases: + * 1. The content of these xstates in the process should not change after the + * signal handling. + * 2. The content of these xstates in the child process should be the same as + * the content of the parent process after the fork syscall. + * + * The regions and reserved bytes of the components tested for XSAVE feature + * are as follows: + * FP (0 - 159 bytes) + * SSE(XMM) (160-415 bytes) + * Reserved (416-511 bytes) + * Header_used (512-527 bytes; XSTATE BV(bitmap vector) mask:512-519 bytes) + * Header_reserved(528-575 bytes must be 00) + * YMM (Offset:CPUID.(EAX=0D,ECX=2).EBX Size:CPUID(EAX=0D,ECX=2).EAX) + * AVX512_OPMASK (Offset:CPUID.(EAX=0D,ECX=5).EBX Size:CPUID(EAX=0D,ECX=5).EAX) + * ZMM_Hi256 (Offset:CPUID.(EAX=0D,ECX=6).EBX Size:CPUID(EAX=0D,ECX=6).EAX) + * Hi16_ZMM (Offset:CPUID.(EAX=0D,ECX=7).EBX Size:CPUID(EAX=0D,ECX=7).EAX) + * PKRU (Offset:CPUID.(EAX=0D,ECX=9).EBX Size:CPUID(EAX=0D,ECX=9).EAX) + * + * Because xstate like XMM will not be preserved across function calls, it uses + * assembly instruction to call a system call of fork or raise signal, and uses + * the "inline" keyword in key test functions. + * To prevent GCC from generating any FP/SSE(XMM)/AVX/PKRU code, add + * "-mno-sse -mno-mmx -mno-sse2 -mno-avx -mno-pku" compiler arguments. stdlib.h + * can not be used because of the "-mno-sse" option. + */ + +#define _GNU_SOURCE +#include <err.h> +#include <stdio.h> +#include <stdint.h> +#include <string.h> +#include <signal.h> +#include <unistd.h> +#include <sched.h> +#include <stdbool.h> +#include <sys/wait.h> +#include <sys/syscall.h> +#include <cpuid.h> +#include <malloc.h> + +struct xsave_buffer *valid_xbuf, *compared_xbuf; +static uint32_t xstate_size; +static bool sigusr1_done; + +#define XSTATE_TESTBYTE 0x8f +/* Bits 0-1 in first byte of PKRU must be 0 for RW access to linear address. */ +#define PKRU_TESTBYTE 0xfc +/* FP xstate(0-159 bytes) offset(0) and size(160 bytes) are fixed. */ +#define FP_SIZE 160 +/* XMM xstate(160-415 bytes) offset(160 byte) and size(256 bytes) are fixed. */ +#define XMM_OFFSET 160 +#define XMM_SIZE 256 +/* + * xstate 416-511 bytes are reserved, XSAVE header offset 512 bytes + * and header size 64 bytes are fixed. + */ +#define XSAVE_HDR_OFFSET 512 +#define XSAVE_HDR_SIZE 64 +/* The following definition is from arch/x86/include/asm/fpu/types.h */ +#define XFEATURE_MASK_FP (1 << XFEATURE_FP) +#define XFEATURE_MASK_SSE (1 << XFEATURE_SSE) +#define XFEATURE_MASK_YMM (1 << XFEATURE_YMM) +#define XFEATURE_MASK_OPMASK (1 << XFEATURE_OPMASK) +#define XFEATURE_MASK_ZMM_Hi256 (1 << XFEATURE_ZMM_Hi256) +#define XFEATURE_MASK_Hi16_ZMM (1 << XFEATURE_Hi16_ZMM) +#define XFEATURE_MASK_PKRU (1 << XFEATURE_PKRU) + +#define CPUID_LEAF1_ECX_XSAVE_MASK (1 << 26) /* XSAVE instructions */ +#define CPUID_LEAF1_ECX_OSXSAVE_MASK (1 << 27) /* OSXSAVE flag */ + +#define CPUID_LEAF7_EBX_AVX2_MASK (1U << 5) /* AVX2 instructions */ +#define CPUID_LEAF7_EBX_AVX512F_MASK (1U << 16) /* AVX-512 Foundation */ + +#define CPUID_LEAF7_ECX_PKU_MASK (1U << 3) /* Protection Keys for Userspace */ +#define CPUID_LEAF7_ECX_OSPKE_MASK (1U << 4) /* OS Protection Keys Enable */ + +#define CPUID_LEAF_XSTATE 0xd +#define CPUID_SUBLEAF_XSTATE_USER 0x0 + +#ifndef __cpuid_count +#define __cpuid_count(level, count, a, b, c, d) ({ \ + __asm__ __volatile__ ("cpuid\n\t" \ + : "=a" (a), "=b" (b), "=c" (c), "=d" (d) \ + : "0" (level), "2" (count)); \ +}) +#endif + +/* err() exits and will not return. */ +#define fatal_error(msg, ...) err(1, "[FAIL]\t" msg, ##__VA_ARGS__) + +/* + * While this function prototype is in the stdlib.h, the header file cannot be + * included with the -mno-sse option. + */ +void *aligned_alloc(size_t alignment, size_t size); + +enum supportability { + NOT_SUPPORT, + SUPPORT, +}; + +/* It's from arch/x86/kernel/fpu/xstate.c. */ +static const char * const xfeature_names[] = { + "x87 floating point registers", + "SSE registers", + "AVX registers", + "MPX bounds registers", + "MPX CSR", + "AVX-512 opmask", + "AVX-512 Hi256", + "AVX-512 ZMM_Hi256", + "Processor Trace (unused)", + "Protection Keys User registers", + "PASID state", + "unknown xstate feature", + "unknown xstate feature", + "unknown xstate feature", + "unknown xstate feature", + "unknown xstate feature", + "unknown xstate feature", + "AMX Tile config", + "AMX Tile data", + "unknown xstate feature", +}; + +/* List of XSAVE features Linux knows about. */ +enum xfeature { + XFEATURE_FP, + XFEATURE_SSE, + /* + * Values above here are "legacy states". + * Those below are "extended states". + */ + XFEATURE_YMM, + XFEATURE_BNDREGS, + XFEATURE_BNDCSR, + XFEATURE_OPMASK, + XFEATURE_ZMM_Hi256, + XFEATURE_Hi16_ZMM, + XFEATURE_PT_UNIMPLEMENTED_SO_FAR, + XFEATURE_PKRU, + XFEATURE_PASID, + XFEATURE_RSRVD_COMP_11, + XFEATURE_RSRVD_COMP_12, + XFEATURE_RSRVD_COMP_13, + XFEATURE_RSRVD_COMP_14, + XFEATURE_LBR, + XFEATURE_RSRVD_COMP_16, + XFEATURE_XTILE_CFG, + XFEATURE_XTILE_DATA, + XFEATURE_MAX, +}; + +struct xsave_buffer { + union { + struct { + char legacy[XSAVE_HDR_OFFSET]; + char header[XSAVE_HDR_SIZE]; + char extended[0]; + }; + char bytes[0]; + }; +}; + +static struct { + uint64_t mask; + uint32_t size[XFEATURE_MAX]; + uint32_t offset[XFEATURE_MAX]; +} xstate_info; + +static inline void check_cpuid_xsave_availability(void) +{ + uint32_t eax, ebx, ecx, edx; + + /* + * CPUID.1:ECX.XSAVE[bit 26] enumerates general + * support for the XSAVE feature set, including + * XGETBV. + */ + __cpuid_count(1, 0, eax, ebx, ecx, edx); + if (!(ecx & CPUID_LEAF1_ECX_XSAVE_MASK)) + fatal_error("cpuid: no CPU xsave support"); + if (!(ecx & CPUID_LEAF1_ECX_OSXSAVE_MASK)) + fatal_error("cpuid: no OS xsave support"); +} + +static inline bool xstate_tested(int xfeature_num) +{ + return !!(xstate_info.mask & (1 << xfeature_num)); +} + +static inline int cpu_has_avx2(void) +{ + unsigned int eax, ebx, ecx, edx; + + /* CPUID.7.0:EBX.AVX2[bit 5]: the support for AVX2 instructions */ + __cpuid_count(7, 0, eax, ebx, ecx, edx); + + return !!(ebx & CPUID_LEAF7_EBX_AVX2_MASK); +} + +static inline int cpu_has_avx512f(void) +{ + unsigned int eax, ebx, ecx, edx; + + /* CPUID.7.0:EBX.AVX512F[bit 16]: the support for AVX512F instructions */ + __cpuid_count(7, 0, eax, ebx, ecx, edx); + + return !!(ebx & CPUID_LEAF7_EBX_AVX512F_MASK); +} + +static inline int cpu_has_pkeys(void) +{ + unsigned int eax, ebx, ecx, edx; + + /* CPUID.7.0:ECX.PKU[bit 3]: the support for PKRU instructions */ + __cpuid_count(7, 0, eax, ebx, ecx, edx); + if (!(ecx & CPUID_LEAF7_ECX_PKU_MASK)) + return NOT_SUPPORT; + /* CPUID.7.0:ECX.OSPKE[bit 4]: the support for OS set CR4.PKE */ + if (!(ecx & CPUID_LEAF7_ECX_OSPKE_MASK)) + return NOT_SUPPORT; + + return SUPPORT; +} + +static uint32_t get_xstate_size(void) +{ + uint32_t eax, ebx, ecx, edx; + + __cpuid_count(CPUID_LEAF_XSTATE, CPUID_SUBLEAF_XSTATE_USER, eax, ebx, + ecx, edx); + /* + * EBX enumerates the size (in bytes) required by the XSAVE + * instruction for an XSAVE area containing all the user state + * components corresponding to bits currently set in XCR0. + */ + return ebx; +} + +static struct xsave_buffer *alloc_xbuf(uint32_t buf_size) +{ + struct xsave_buffer *xbuf; + + /* XSAVE buffer should be 64B-aligned. */ + xbuf = aligned_alloc(64, buf_size); + if (!xbuf) + fatal_error("aligned_alloc()"); + + return xbuf; +} + +static inline void __xsave(struct xsave_buffer *xbuf, uint64_t rfbm) +{ + uint32_t rfbm_lo = rfbm; + uint32_t rfbm_hi = rfbm >> 32; + + asm volatile("xsave (%%rdi)" + : : "D" (xbuf), "a" (rfbm_lo), "d" (rfbm_hi) + : "memory"); +} + +static inline void __xrstor(struct xsave_buffer *xbuf, uint64_t rfbm) +{ + uint32_t rfbm_lo = rfbm; + uint32_t rfbm_hi = rfbm >> 32; + + asm volatile("xrstor (%%rdi)" + : : "D" (xbuf), "a" (rfbm_lo), "d" (rfbm_hi)); +} + +static void sethandler(int sig, void (*handler)(int, siginfo_t *, void *), + int flags) +{ + struct sigaction sa; + + memset(&sa, 0, sizeof(sa)); + sa.sa_sigaction = handler; + sa.sa_flags = SA_SIGINFO | flags; + sigemptyset(&sa.sa_mask); + if (sigaction(sig, &sa, 0)) + fatal_error("sigaction"); +} + +static void clearhandler(int sig) +{ + struct sigaction sa; + + memset(&sa, 0, sizeof(sa)); + sa.sa_handler = SIG_DFL; + sigemptyset(&sa.sa_mask); + if (sigaction(sig, &sa, 0)) + fatal_error("sigaction"); +} + +/* Retrieve the offset and size of a specific xstate. */ +static void retrieve_xstate_size_and_offset(uint32_t xfeature_num) +{ + uint32_t eax, ebx, ecx, edx; + + __cpuid_count(CPUID_LEAF_XSTATE, xfeature_num, eax, ebx, ecx, edx); + /* + * CPUID.(EAX=0xd, ECX=xfeature_num), and output is as follow: + * eax: xfeature num state component size + * ebx: xfeature num state component offset in user buffer + */ + xstate_info.size[xfeature_num] = eax; + xstate_info.offset[xfeature_num] = ebx; +} + +static inline void set_xstatebv(struct xsave_buffer *buffer, uint64_t bv) +{ + /* XSTATE_BV is at the beginning of xstate header. */ + *(uint64_t *)(&buffer->header) = bv; +} + +static void check_cpuid_xstate_info(void) +{ + /* CPUs that support XSAVE could support FP and SSE by default. */ + xstate_info.mask = XFEATURE_MASK_FP | XFEATURE_MASK_SSE; + + xstate_size = get_xstate_size(); + if (cpu_has_avx2()) { + xstate_info.mask |= XFEATURE_MASK_YMM; + retrieve_xstate_size_and_offset(XFEATURE_YMM); + } + + if (cpu_has_avx512f()) { + xstate_info.mask |= XFEATURE_MASK_OPMASK | XFEATURE_MASK_ZMM_Hi256 | + XFEATURE_MASK_Hi16_ZMM; + retrieve_xstate_size_and_offset(XFEATURE_OPMASK); + retrieve_xstate_size_and_offset(XFEATURE_ZMM_Hi256); + retrieve_xstate_size_and_offset(XFEATURE_Hi16_ZMM); + } + + if (cpu_has_pkeys()) { + xstate_info.mask |= XFEATURE_MASK_PKRU; + retrieve_xstate_size_and_offset(XFEATURE_PKRU); + } +} + +static void fill_xstate_buf(uint8_t test_byte, unsigned char *buf, + int xfeature_num) +{ + uint32_t i; + + for (i = 0; i < xstate_info.size[xfeature_num]; i++) + buf[xstate_info.offset[xfeature_num] + i] = test_byte; +} + +/* Fill FP/XMM/YMM/OPMASK and PKRU xstates into buffer. */ +static void fill_xstates_buf(struct xsave_buffer *buf, uint32_t xsave_mask) +{ + uint32_t i; + /* The data of FP x87 state are as follows. */ + unsigned char fp_data[160] = { + 0x7f, 0x03, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00, + 0xf0, 0x19, 0x40, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0x00, 0x00, + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x78, 0xfa, 0x79, 0xf9, 0x78, 0xfa, 0xf9, + 0xf2, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }; + + /* Clean the buffer with all 0 first. */ + memset(buf, 0, xstate_size); + + /* Fill fp x87 state: MXCSR and MXCSR_MASK data(0-159 bytes) into buffer. */ + memcpy(buf, fp_data, FP_SIZE); + + /* + * Fill test byte value into XMM xstate buffer(160-415 bytes). + * xstate 416-511 bytes are reserved as 0. + */ + for (i = 0; i < XMM_SIZE; i++) + *((unsigned char *)buf + XMM_OFFSET + i) = XSTATE_TESTBYTE; + + /* + * Fill xstate-component bitmap(512-519 bytes) into xstate header. + * xstate header range is 512-575 bytes. + */ + set_xstatebv(buf, xsave_mask); + + /* Fill test byte value into YMM xstate buffer(YMM offset/size). */ + if (xstate_tested(XFEATURE_YMM)) + fill_xstate_buf(XSTATE_TESTBYTE, (unsigned char *)buf, XFEATURE_YMM); + + /* + * Fill test byte value into AVX512 OPMASK/ZMM xstates buffer + * (AVX512_OPMASK/ZMM_Hi256/Hi16_ZMM offset/size). + */ + if (xstate_tested(XFEATURE_OPMASK)) + fill_xstate_buf(XSTATE_TESTBYTE, (unsigned char *)buf, XFEATURE_OPMASK); + if (xstate_tested(XFEATURE_ZMM_Hi256)) { + fill_xstate_buf(XSTATE_TESTBYTE, (unsigned char *)buf, + XFEATURE_ZMM_Hi256); + } + if (xstate_tested(XFEATURE_Hi16_ZMM)) { + fill_xstate_buf(XSTATE_TESTBYTE, (unsigned char *)buf, + XFEATURE_Hi16_ZMM); + } + + if (xstate_tested(XFEATURE_PKRU)) { + /* Only 0-3 bytes of pkru xstates are allowed to be written. */ + memset((unsigned char *)buf + xstate_info.offset[XFEATURE_PKRU], + PKRU_TESTBYTE, sizeof(uint32_t)); + } +} + +/* + * Because xstate like XMM, YMM registers are not preserved across function + * calls, so use inline function with assembly code only for fork syscall. + */ +static inline long long __fork(void) +{ + long long ret, nr = SYS_fork; + + asm volatile("syscall" + : "=a" (ret) + : "a" (nr), "b" (nr) + : "rcx", "r11", "memory", "cc"); + + return ret; +} + +/* + * Because xstate like XMM, YMM registers are not preserved across function + * calls, so use inline function with assembly code only to raise signal. + */ +static inline long long __raise(long long pid_num, long long sig_num) +{ + long long ret, nr = SYS_kill; + + register long long arg1 asm("rdi") = pid_num; + register long long arg2 asm("rsi") = sig_num; + + asm volatile("syscall" + : "=a" (ret) + : "a" (nr), "b" (nr), "r" (arg1), "r" (arg2) + : "rcx", "r11", "memory", "cc"); + + return ret; +} + +static void sigusr1_handler(int signum, siginfo_t *info, void *__ctxp) +{ + sigusr1_done = true; +} + +static void test_xstate_sig_handle(void) +{ + pid_t process_pid; + + sethandler(SIGUSR1, sigusr1_handler, 0); + printf("[RUN]\tCheck xstate around signal handling test.\n"); + process_pid = getpid(); + + /* + * Xrstor the valid_xbuf and call syscall assembly instruction, then + * save the xstate to compared_xbuf after signal handling for comparison. + */ + __xrstor(valid_xbuf, xstate_info.mask); + __raise(process_pid, SIGUSR1); + __xsave(compared_xbuf, xstate_info.mask); + if (sigusr1_done == true) + printf("[NOTE]\tSIGUSR1 handling is done.\n"); + else + fatal_error("Didn't access SIGUSR1 handling after raised SIGUSR1"); + + if (memcmp(&valid_xbuf->bytes[0], &compared_xbuf->bytes[0], xstate_size)) + printf("[FAIL]\tProcess xstate is not same after signal handling\n"); + else + printf("[PASS]\tProcess xstate is same after signal handling.\n"); + + clearhandler(SIGUSR1); +} + +static void test_xstate_fork(void) +{ + pid_t child; + int status; + + printf("[RUN]\tParent pid:%d check xstate around fork test.\n", getpid()); + memset(compared_xbuf, 0, xstate_size); + + /* + * Xrstor the valid_xbuf and call syscall assembly instruction, then + * save the xstate to compared_xbuf in child process for comparison. + */ + __xrstor(valid_xbuf, xstate_info.mask); + child = __fork(); + if (child < 0) { + /* Fork syscall failed */ + fatal_error("fork failed"); + } else if (child == 0) { + /* Fork syscall succeeded, now in the child. */ + __xsave(compared_xbuf, xstate_info.mask); + if (memcmp(&valid_xbuf->bytes[0], &compared_xbuf->bytes[0], + xstate_size)) { + printf("[FAIL]\tXstate of child process:%d is not same as xstate of parent\n", + getpid()); + } else { + printf("[PASS]\tXstate of child process:%d is same as xstate of parent.\n", + getpid()); + } + } else { + if (waitpid(child, &status, 0) != child || !WIFEXITED(status)) + fatal_error("Child exit with error status"); + } +} + +static void free_xbuf(void) +{ + free(valid_xbuf); + free(compared_xbuf); +} + +static void prepare_xbuf(void) +{ + valid_xbuf = alloc_xbuf(xstate_size); + compared_xbuf = alloc_xbuf(xstate_size); + /* Populate the specified data into the validate xstate buffer. */ + fill_xstates_buf(valid_xbuf, xstate_info.mask); +} + +static void show_tested_xfeatures(void) +{ + uint32_t i; + const char *feature_name; + + printf("[NOTE]\tTest following xstates with mask:%lx.\n", xstate_info.mask); + for (i = 0; i < XFEATURE_MAX; i++) { + if (!xstate_tested(i)) + continue; + feature_name = xfeature_names[i]; + printf("[NOTE]\tXSAVE feature num %02d: '%s'.\n", i, feature_name); + } +} + +int main(void) +{ + /* Check hardware availability for xsave at first. */ + check_cpuid_xsave_availability(); + /* Check tested xstate by CPU id and retrieve CPU xstate info. */ + check_cpuid_xstate_info(); + show_tested_xfeatures(); + prepare_xbuf(); + + test_xstate_sig_handle(); + test_xstate_fork(); + free_xbuf(); + + return 0; +}