[deliverable/linux.git] / arch / x86 / include / asm / xsave.h

#ifndef __ASM_X86_XSAVE_H
#define __ASM_X86_XSAVE_H

#include <linux/types.h>
#include <asm/processor.h>

#define XSTATE_CPUID		0x0000000d

#define XSTATE_FP		0x1
#define XSTATE_SSE		0x2
#define XSTATE_YMM		0x4
#define XSTATE_BNDREGS		0x8
#define XSTATE_BNDCSR		0x10
#define XSTATE_OPMASK		0x20
#define XSTATE_ZMM_Hi256	0x40
#define XSTATE_Hi16_ZMM		0x80

#define XSTATE_FPSSE	(XSTATE_FP | XSTATE_SSE)
/* Bit 63 of XCR0 is reserved for future expansion */
#define XSTATE_EXTEND_MASK	(~(XSTATE_FPSSE | (1ULL << 63)))

#define FXSAVE_SIZE	512

#define XSAVE_HDR_SIZE	    64
#define XSAVE_HDR_OFFSET    FXSAVE_SIZE

#define XSAVE_YMM_SIZE	    256
#define XSAVE_YMM_OFFSET    (XSAVE_HDR_SIZE + XSAVE_HDR_OFFSET)

/* Supported features which support lazy state saving */
#define XSTATE_LAZY	(XSTATE_FP | XSTATE_SSE | XSTATE_YMM		      \
			| XSTATE_OPMASK | XSTATE_ZMM_Hi256 | XSTATE_Hi16_ZMM)

/* Supported features which require eager state saving */
#define XSTATE_EAGER	(XSTATE_BNDREGS | XSTATE_BNDCSR)

/* All currently supported features */
#define XCNTXT_MASK	(XSTATE_LAZY | XSTATE_EAGER)

#ifdef CONFIG_X86_64
#define REX_PREFIX	"0x48, "
#else
#define REX_PREFIX
#endif

extern unsigned int xstate_size;
extern u64 pcntxt_mask;
extern u64 xstate_fx_sw_bytes[USER_XSTATE_FX_SW_WORDS];
extern struct xsave_struct *init_xstate_buf;

extern void xsave_init(void);
extern void update_regset_xstate_info(unsigned int size, u64 xstate_mask);
extern int init_fpu(struct task_struct *child);

/* These macros all use (%edi)/(%rdi) as the single memory argument. */
#define XSAVE		".byte " REX_PREFIX "0x0f,0xae,0x27"
#define XSAVEOPT	".byte " REX_PREFIX "0x0f,0xae,0x37"
#define XSAVES		".byte " REX_PREFIX "0x0f,0xc7,0x2f"
#define XRSTOR		".byte " REX_PREFIX "0x0f,0xae,0x2f"
#define XRSTORS		".byte " REX_PREFIX "0x0f,0xc7,0x1f"

#define xstate_fault	".section .fixup,\"ax\"\n"	\
			"3:  movl $-1,%[err]\n"		\
			"    jmp  2b\n"			\
			".previous\n"			\
			_ASM_EXTABLE(1b, 3b)		\
			: [err] "=r" (err)

/*
 * This function is called only during boot time when x86 caps are not set
 * up and alternative can not be used yet.
 */
static inline int xsave_state_booting(struct xsave_struct *fx, u64 mask)
{
	u32 lmask = mask;
	u32 hmask = mask >> 32;
	int err = 0;

	WARN_ON(system_state != SYSTEM_BOOTING);

	if (boot_cpu_has(X86_FEATURE_XSAVES))
		asm volatile("1:"XSAVES"\n\t"
			"2:\n\t"
			: : "D" (fx), "m" (*fx), "a" (lmask), "d" (hmask)
			:   "memory");
	else
		asm volatile("1:"XSAVE"\n\t"
			"2:\n\t"
			: : "D" (fx), "m" (*fx), "a" (lmask), "d" (hmask)
			:   "memory");

	asm volatile(xstate_fault
		     : "0" (0)
		     : "memory");

	return err;
}

/*
 * This function is called only during boot time when x86 caps are not set
 * up and alternative can not be used yet.
 */
static inline int xrstor_state_booting(struct xsave_struct *fx, u64 mask)
{
	u32 lmask = mask;
	u32 hmask = mask >> 32;
	int err = 0;

	WARN_ON(system_state != SYSTEM_BOOTING);

	if (boot_cpu_has(X86_FEATURE_XSAVES))
		asm volatile("1:"XRSTORS"\n\t"
			"2:\n\t"
			: : "D" (fx), "m" (*fx), "a" (lmask), "d" (hmask)
			:   "memory");
	else
		asm volatile("1:"XRSTOR"\n\t"
			"2:\n\t"
			: : "D" (fx), "m" (*fx), "a" (lmask), "d" (hmask)
			:   "memory");

	asm volatile(xstate_fault
		     : "0" (0)
		     : "memory");

	return err;
}

/*
 * Save processor xstate to xsave area.
 */
static inline int xsave_state(struct xsave_struct *fx, u64 mask)
{
	u32 lmask = mask;
	u32 hmask = mask >> 32;
	int err = 0;

	/*
	 * If xsaves is enabled, xsaves replaces xsaveopt because
	 * it supports compact format and supervisor states in addition to
	 * modified optimization in xsaveopt.
	 *
	 * Otherwise, if xsaveopt is enabled, xsaveopt replaces xsave
	 * because xsaveopt supports modified optimization which is not
	 * supported by xsave.
	 *
	 * If none of xsaves and xsaveopt is enabled, use xsave.
	 */
	alternative_input_2(
		"1:"XSAVE,
		"1:"XSAVEOPT,
		X86_FEATURE_XSAVEOPT,
		"1:"XSAVES,
		X86_FEATURE_XSAVES,
		[fx] "D" (fx), "a" (lmask), "d" (hmask) :
		"memory");
	asm volatile("2:\n\t"
		     xstate_fault
		     : "0" (0)
		     : "memory");

	return err;
}

/*
 * Restore processor xstate from xsave area.
 */
static inline int xrstor_state(struct xsave_struct *fx, u64 mask)
{
	int err = 0;
	u32 lmask = mask;
	u32 hmask = mask >> 32;

	/*
	 * Use xrstors to restore context if it is enabled. xrstors supports
	 * compacted format of xsave area which is not supported by xrstor.
	 */
	alternative_input(
		"1: " XRSTOR,
		"1: " XRSTORS,
		X86_FEATURE_XSAVES,
		"D" (fx), "m" (*fx), "a" (lmask), "d" (hmask)
		: "memory");

	asm volatile("2:\n"
		     xstate_fault
		     : "0" (0)
		     : "memory");

	return err;
}

/*
 * Save xstate context for old process during context switch.
 */
static inline void fpu_xsave(struct fpu *fpu)
{
	xsave_state(&fpu->state->xsave, -1);
}

/*
 * Restore xstate context for new process during context switch.
 */
static inline int fpu_xrstor_checking(struct xsave_struct *fx)
{
	return xrstor_state(fx, -1);
}

/*
 * Save xstate to user space xsave area.
 *
 * We don't use modified optimization because xrstor/xrstors might track
 * a different application.
 *
 * We don't use compacted format xsave area for
 * backward compatibility for old applications which don't understand
 * compacted format of xsave area.
 */
static inline int xsave_user(struct xsave_struct __user *buf)
{
	int err;

	/*
	 * Clear the xsave header first, so that reserved fields are
	 * initialized to zero.
	 */
	err = __clear_user(&buf->xsave_hdr, sizeof(buf->xsave_hdr));
	if (unlikely(err))
		return -EFAULT;

	__asm__ __volatile__(ASM_STAC "\n"
			     "1:"XSAVE"\n"
			     "2: " ASM_CLAC "\n"
			     xstate_fault
			     : "D" (buf), "a" (-1), "d" (-1), "0" (0)
			     : "memory");
	return err;
}

/*
 * Restore xstate from user space xsave area.
 */
static inline int xrestore_user(struct xsave_struct __user *buf, u64 mask)
{
	int err = 0;
	struct xsave_struct *xstate = ((__force struct xsave_struct *)buf);
	u32 lmask = mask;
	u32 hmask = mask >> 32;

	__asm__ __volatile__(ASM_STAC "\n"
			     "1:"XRSTOR"\n"
			     "2: " ASM_CLAC "\n"
			     xstate_fault
			     : "D" (xstate), "a" (lmask), "d" (hmask), "0" (0)
			     : "memory");	/* memory required? */
	return err;
}

void *get_xsave_addr(struct xsave_struct *xsave, int xstate);
void setup_xstate_comp(void);

#endif
Commit	Line	Data
dc1e35c6 SS	1	#ifndef __ASM_X86_XSAVE_H
	2	#define __ASM_X86_XSAVE_H
	3
6152e4b1	4	#include <linux/types.h>
dc1e35c6	5	#include <asm/processor.h>
dc1e35c6	6
ee813d53	7	#define XSTATE_CPUID 0x0000000d
dc1e35c6	8
c2bc11f1 FY	9	#define XSTATE_FP 0x1
	10	#define XSTATE_SSE 0x2
	11	#define XSTATE_YMM 0x4
	12	#define XSTATE_BNDREGS 0x8
	13	#define XSTATE_BNDCSR 0x10
	14	#define XSTATE_OPMASK 0x20
	15	#define XSTATE_ZMM_Hi256 0x40
	16	#define XSTATE_Hi16_ZMM 0x80
dc1e35c6 SS	17
dc1e35c6 SS	18	#define XSTATE_FPSSE (XSTATE_FP \| XSTATE_SSE)
56c103ec LJ	19	/* Bit 63 of XCR0 is reserved for future expansion */
56c103ec LJ	20	#define XSTATE_EXTEND_MASK (~(XSTATE_FPSSE \| (1ULL << 63)))
dc1e35c6 SS	21
	22	#define FXSAVE_SIZE 512
	23
2d5b5a66 SY	24	#define XSAVE_HDR_SIZE 64
	25	#define XSAVE_HDR_OFFSET FXSAVE_SIZE
	26
	27	#define XSAVE_YMM_SIZE 256
	28	#define XSAVE_YMM_OFFSET (XSAVE_HDR_SIZE + XSAVE_HDR_OFFSET)
5ee481da	29
e7d820a5	30	/* Supported features which support lazy state saving */
c2bc11f1 FY	31	#define XSTATE_LAZY (XSTATE_FP \| XSTATE_SSE \| XSTATE_YMM \
c2bc11f1 FY	32	\| XSTATE_OPMASK \| XSTATE_ZMM_Hi256 \| XSTATE_Hi16_ZMM)
e7d820a5 QR	33
	34	/* Supported features which require eager state saving */
	35	#define XSTATE_EAGER (XSTATE_BNDREGS \| XSTATE_BNDCSR)
	36
	37	/* All currently supported features */
	38	#define XCNTXT_MASK (XSTATE_LAZY \| XSTATE_EAGER)
dc1e35c6	39
b359e8a4 SS	40	#ifdef CONFIG_X86_64
	41	#define REX_PREFIX "0x48, "
	42	#else
	43	#define REX_PREFIX
	44	#endif
	45
6152e4b1 PA	46	extern unsigned int xstate_size;
6152e4b1 PA	47	extern u64 pcntxt_mask;
5b3efd50	48	extern u64 xstate_fx_sw_bytes[USER_XSTATE_FX_SW_WORDS];
304bceda	49	extern struct xsave_struct *init_xstate_buf;
dc1e35c6	50
dc1e35c6	51	extern void xsave_init(void);
5b3efd50	52	extern void update_regset_xstate_info(unsigned int size, u64 xstate_mask);
b359e8a4 SS	53	extern int init_fpu(struct task_struct *child);
b359e8a4 SS	54
c9e5a5a7	55	/* These macros all use (%edi)/(%rdi) as the single memory argument. */
200b08a9 FY	56	#define XSAVE ".byte " REX_PREFIX "0x0f,0xae,0x27"
	57	#define XSAVEOPT ".byte " REX_PREFIX "0x0f,0xae,0x37"
	58	#define XSAVES ".byte " REX_PREFIX "0x0f,0xc7,0x2f"
	59	#define XRSTOR ".byte " REX_PREFIX "0x0f,0xae,0x2f"
	60	#define XRSTORS ".byte " REX_PREFIX "0x0f,0xc7,0x1f"
	61
b84e7055 FY	62	#define xstate_fault ".section .fixup,\"ax\"\n" \
	63	"3: movl $-1,%[err]\n" \
	64	" jmp 2b\n" \
	65	".previous\n" \
	66	_ASM_EXTABLE(1b, 3b) \
	67	: [err] "=r" (err)
	68
adb9d526 FY	69	/*
	70	* This function is called only during boot time when x86 caps are not set
	71	* up and alternative can not be used yet.
	72	*/
d0f2dd18	73	static inline int xsave_state_booting(struct xsave_struct *fx, u64 mask)
adb9d526 FY	74	{
	75	u32 lmask = mask;
	76	u32 hmask = mask >> 32;
	77	int err = 0;
	78
	79	WARN_ON(system_state != SYSTEM_BOOTING);
	80
	81	if (boot_cpu_has(X86_FEATURE_XSAVES))
	82	asm volatile("1:"XSAVES"\n\t"
	83	"2:\n\t"
	84	: : "D" (fx), "m" (*fx), "a" (lmask), "d" (hmask)
	85	: "memory");
	86	else
	87	asm volatile("1:"XSAVE"\n\t"
	88	"2:\n\t"
	89	: : "D" (fx), "m" (*fx), "a" (lmask), "d" (hmask)
	90	: "memory");
	91
	92	asm volatile(xstate_fault
	93	: "0" (0)
	94	: "memory");
	95
	96	return err;
	97	}
	98
	99	/*
	100	* This function is called only during boot time when x86 caps are not set
	101	* up and alternative can not be used yet.
	102	*/
	103	static inline int xrstor_state_booting(struct xsave_struct *fx, u64 mask)
	104	{
	105	u32 lmask = mask;
	106	u32 hmask = mask >> 32;
	107	int err = 0;
	108
	109	WARN_ON(system_state != SYSTEM_BOOTING);
	110
	111	if (boot_cpu_has(X86_FEATURE_XSAVES))
	112	asm volatile("1:"XRSTORS"\n\t"
	113	"2:\n\t"
	114	: : "D" (fx), "m" (*fx), "a" (lmask), "d" (hmask)
	115	: "memory");
	116	else
	117	asm volatile("1:"XRSTOR"\n\t"
	118	"2:\n\t"
	119	: : "D" (fx), "m" (*fx), "a" (lmask), "d" (hmask)
	120	: "memory");
	121
	122	asm volatile(xstate_fault
	123	: "0" (0)
	124	: "memory");
	125
	126	return err;
	127	}
	128
f31a9f7c FY	129	/*
	130	* Save processor xstate to xsave area.
	131	*/
	132	static inline int xsave_state(struct xsave_struct *fx, u64 mask)
	133	{
	134	u32 lmask = mask;
	135	u32 hmask = mask >> 32;
	136	int err = 0;
	137
	138	/*
	139	* If xsaves is enabled, xsaves replaces xsaveopt because
	140	* it supports compact format and supervisor states in addition to
	141	* modified optimization in xsaveopt.
	142	*
	143	* Otherwise, if xsaveopt is enabled, xsaveopt replaces xsave
	144	* because xsaveopt supports modified optimization which is not
	145	* supported by xsave.
	146	*
	147	* If none of xsaves and xsaveopt is enabled, use xsave.
	148	*/
	149	alternative_input_2(
	150	"1:"XSAVE,
	151	"1:"XSAVEOPT,
	152	X86_FEATURE_XSAVEOPT,
	153	"1:"XSAVES,
	154	X86_FEATURE_XSAVES,
	155	[fx] "D" (fx), "a" (lmask), "d" (hmask) :
	156	"memory");
	157	asm volatile("2:\n\t"
	158	xstate_fault
	159	: "0" (0)
	160	: "memory");
	161
	162	return err;
	163	}
	164
	165	/*
	166	* Restore processor xstate from xsave area.
	167	*/
	168	static inline int xrstor_state(struct xsave_struct *fx, u64 mask)
	169	{
	170	int err = 0;
	171	u32 lmask = mask;
	172	u32 hmask = mask >> 32;
	173
	174	/*
	175	* Use xrstors to restore context if it is enabled. xrstors supports
	176	* compacted format of xsave area which is not supported by xrstor.
	177	*/
	178	alternative_input(
	179	"1: " XRSTOR,
	180	"1: " XRSTORS,
	181	X86_FEATURE_XSAVES,
	182	"D" (fx), "m" (*fx), "a" (lmask), "d" (hmask)
	183	: "memory");
	184
	185	asm volatile("2:\n"
	186	xstate_fault
	187	: "0" (0)
	188	: "memory");
	189
	190	return err;
	191	}
	192
f9de314b FY	193	/*
	194	* Save xstate context for old process during context switch.
	195	*/
	196	static inline void fpu_xsave(struct fpu *fpu)
b359e8a4	197	{
f9de314b FY	198	xsave_state(&fpu->state->xsave, -1);
f9de314b FY	199	}
b359e8a4	200
f9de314b FY	201	/*
	202	* Restore xstate context for new process during context switch.
	203	*/
	204	static inline int fpu_xrstor_checking(struct xsave_struct *fx)
	205	{
	206	return xrstor_state(fx, -1);
b359e8a4 SS	207	}
b359e8a4 SS	208
facbf4d9 FY	209	/*
	210	* Save xstate to user space xsave area.
	211	*
	212	* We don't use modified optimization because xrstor/xrstors might track
	213	* a different application.
	214	*
	215	* We don't use compacted format xsave area for
	216	* backward compatibility for old applications which don't understand
	217	* compacted format of xsave area.
	218	*/
c37b5efe	219	static inline int xsave_user(struct xsave_struct __user *buf)
9dc89c0f SS	220	{
9dc89c0f SS	221	int err;
8e221b6d SS	222
	223	/*
	224	* Clear the xsave header first, so that reserved fields are
	225	* initialized to zero.
	226	*/
72a671ce	227	err = __clear_user(&buf->xsave_hdr, sizeof(buf->xsave_hdr));
8e221b6d SS	228	if (unlikely(err))
	229	return -EFAULT;
	230
63bcff2a	231	__asm__ __volatile__(ASM_STAC "\n"
facbf4d9	232	"1:"XSAVE"\n"
63bcff2a	233	"2: " ASM_CLAC "\n"
facbf4d9	234	xstate_fault
9dc89c0f SS	235	: "D" (buf), "a" (-1), "d" (-1), "0" (0)
9dc89c0f SS	236	: "memory");
9dc89c0f SS	237	return err;
	238	}
	239
facbf4d9 FY	240	/*
	241	* Restore xstate from user space xsave area.
	242	*/
6152e4b1	243	static inline int xrestore_user(struct xsave_struct __user *buf, u64 mask)
9dc89c0f	244	{
facbf4d9	245	int err = 0;
9dc89c0f	246	struct xsave_struct xstate = ((__force struct xsave_struct )buf);
6152e4b1 PA	247	u32 lmask = mask;
6152e4b1 PA	248	u32 hmask = mask >> 32;
9dc89c0f	249
63bcff2a	250	__asm__ __volatile__(ASM_STAC "\n"
facbf4d9	251	"1:"XRSTOR"\n"
63bcff2a	252	"2: " ASM_CLAC "\n"
facbf4d9	253	xstate_fault
9dc89c0f SS	254	: "D" (xstate), "a" (lmask), "d" (hmask), "0" (0)
	255	: "memory"); /* memory required? */
	256	return err;
	257	}
	258
7496d645 FY	259	void get_xsave_addr(struct xsave_struct xsave, int xstate);
	260	void setup_xstate_comp(void);
	261
dc1e35c6	262	#endif