xref: /openbmc/linux/arch/x86/include/asm/desc.h (revision 05911c5d)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _ASM_X86_DESC_H
3 #define _ASM_X86_DESC_H
4 
5 #include <asm/desc_defs.h>
6 #include <asm/ldt.h>
7 #include <asm/mmu.h>
8 #include <asm/fixmap.h>
9 #include <asm/irq_vectors.h>
10 #include <asm/cpu_entry_area.h>
11 
12 #include <linux/debug_locks.h>
13 #include <linux/smp.h>
14 #include <linux/percpu.h>
15 
16 static inline void fill_ldt(struct desc_struct *desc, const struct user_desc *info)
17 {
18 	desc->limit0		= info->limit & 0x0ffff;
19 
20 	desc->base0		= (info->base_addr & 0x0000ffff);
21 	desc->base1		= (info->base_addr & 0x00ff0000) >> 16;
22 
23 	desc->type		= (info->read_exec_only ^ 1) << 1;
24 	desc->type	       |= info->contents << 2;
25 	/* Set the ACCESS bit so it can be mapped RO */
26 	desc->type	       |= 1;
27 
28 	desc->s			= 1;
29 	desc->dpl		= 0x3;
30 	desc->p			= info->seg_not_present ^ 1;
31 	desc->limit1		= (info->limit & 0xf0000) >> 16;
32 	desc->avl		= info->useable;
33 	desc->d			= info->seg_32bit;
34 	desc->g			= info->limit_in_pages;
35 
36 	desc->base2		= (info->base_addr & 0xff000000) >> 24;
37 	/*
38 	 * Don't allow setting of the lm bit. It would confuse
39 	 * user_64bit_mode and would get overridden by sysret anyway.
40 	 */
41 	desc->l			= 0;
42 }
43 
44 struct gdt_page {
45 	struct desc_struct gdt[GDT_ENTRIES];
46 } __attribute__((aligned(PAGE_SIZE)));
47 
48 DECLARE_PER_CPU_PAGE_ALIGNED(struct gdt_page, gdt_page);
49 
50 /* Provide the original GDT */
51 static inline struct desc_struct *get_cpu_gdt_rw(unsigned int cpu)
52 {
53 	return per_cpu(gdt_page, cpu).gdt;
54 }
55 
56 /* Provide the current original GDT */
57 static inline struct desc_struct *get_current_gdt_rw(void)
58 {
59 	return this_cpu_ptr(&gdt_page)->gdt;
60 }
61 
62 /* Provide the fixmap address of the remapped GDT */
63 static inline struct desc_struct *get_cpu_gdt_ro(int cpu)
64 {
65 	return (struct desc_struct *)&get_cpu_entry_area(cpu)->gdt;
66 }
67 
68 /* Provide the current read-only GDT */
69 static inline struct desc_struct *get_current_gdt_ro(void)
70 {
71 	return get_cpu_gdt_ro(smp_processor_id());
72 }
73 
74 /* Provide the physical address of the GDT page. */
75 static inline phys_addr_t get_cpu_gdt_paddr(unsigned int cpu)
76 {
77 	return per_cpu_ptr_to_phys(get_cpu_gdt_rw(cpu));
78 }
79 
80 static inline void pack_gate(gate_desc *gate, unsigned type, unsigned long func,
81 			     unsigned dpl, unsigned ist, unsigned seg)
82 {
83 	gate->offset_low	= (u16) func;
84 	gate->bits.p		= 1;
85 	gate->bits.dpl		= dpl;
86 	gate->bits.zero		= 0;
87 	gate->bits.type		= type;
88 	gate->offset_middle	= (u16) (func >> 16);
89 #ifdef CONFIG_X86_64
90 	gate->segment		= __KERNEL_CS;
91 	gate->bits.ist		= ist;
92 	gate->reserved		= 0;
93 	gate->offset_high	= (u32) (func >> 32);
94 #else
95 	gate->segment		= seg;
96 	gate->bits.ist		= 0;
97 #endif
98 }
99 
100 static inline int desc_empty(const void *ptr)
101 {
102 	const u32 *desc = ptr;
103 
104 	return !(desc[0] | desc[1]);
105 }
106 
107 #ifdef CONFIG_PARAVIRT_XXL
108 #include <asm/paravirt.h>
109 #else
110 #define load_TR_desc()				native_load_tr_desc()
111 #define load_gdt(dtr)				native_load_gdt(dtr)
112 #define load_idt(dtr)				native_load_idt(dtr)
113 #define load_tr(tr)				asm volatile("ltr %0"::"m" (tr))
114 #define load_ldt(ldt)				asm volatile("lldt %0"::"m" (ldt))
115 
116 #define store_gdt(dtr)				native_store_gdt(dtr)
117 #define store_tr(tr)				(tr = native_store_tr())
118 
119 #define load_TLS(t, cpu)			native_load_tls(t, cpu)
120 #define set_ldt					native_set_ldt
121 
122 #define write_ldt_entry(dt, entry, desc)	native_write_ldt_entry(dt, entry, desc)
123 #define write_gdt_entry(dt, entry, desc, type)	native_write_gdt_entry(dt, entry, desc, type)
124 #define write_idt_entry(dt, entry, g)		native_write_idt_entry(dt, entry, g)
125 
126 static inline void paravirt_alloc_ldt(struct desc_struct *ldt, unsigned entries)
127 {
128 }
129 
130 static inline void paravirt_free_ldt(struct desc_struct *ldt, unsigned entries)
131 {
132 }
133 #endif	/* CONFIG_PARAVIRT_XXL */
134 
135 #define store_ldt(ldt) asm("sldt %0" : "=m"(ldt))
136 
137 static inline void native_write_idt_entry(gate_desc *idt, int entry, const gate_desc *gate)
138 {
139 	memcpy(&idt[entry], gate, sizeof(*gate));
140 }
141 
142 static inline void native_write_ldt_entry(struct desc_struct *ldt, int entry, const void *desc)
143 {
144 	memcpy(&ldt[entry], desc, 8);
145 }
146 
147 static inline void
148 native_write_gdt_entry(struct desc_struct *gdt, int entry, const void *desc, int type)
149 {
150 	unsigned int size;
151 
152 	switch (type) {
153 	case DESC_TSS:	size = sizeof(tss_desc);	break;
154 	case DESC_LDT:	size = sizeof(ldt_desc);	break;
155 	default:	size = sizeof(*gdt);		break;
156 	}
157 
158 	memcpy(&gdt[entry], desc, size);
159 }
160 
161 static inline void set_tssldt_descriptor(void *d, unsigned long addr,
162 					 unsigned type, unsigned size)
163 {
164 	struct ldttss_desc *desc = d;
165 
166 	memset(desc, 0, sizeof(*desc));
167 
168 	desc->limit0		= (u16) size;
169 	desc->base0		= (u16) addr;
170 	desc->base1		= (addr >> 16) & 0xFF;
171 	desc->type		= type;
172 	desc->p			= 1;
173 	desc->limit1		= (size >> 16) & 0xF;
174 	desc->base2		= (addr >> 24) & 0xFF;
175 #ifdef CONFIG_X86_64
176 	desc->base3		= (u32) (addr >> 32);
177 #endif
178 }
179 
180 static inline void __set_tss_desc(unsigned cpu, unsigned int entry, struct x86_hw_tss *addr)
181 {
182 	struct desc_struct *d = get_cpu_gdt_rw(cpu);
183 	tss_desc tss;
184 
185 	set_tssldt_descriptor(&tss, (unsigned long)addr, DESC_TSS,
186 			      __KERNEL_TSS_LIMIT);
187 	write_gdt_entry(d, entry, &tss, DESC_TSS);
188 }
189 
190 #define set_tss_desc(cpu, addr) __set_tss_desc(cpu, GDT_ENTRY_TSS, addr)
191 
192 static inline void native_set_ldt(const void *addr, unsigned int entries)
193 {
194 	if (likely(entries == 0))
195 		asm volatile("lldt %w0"::"q" (0));
196 	else {
197 		unsigned cpu = smp_processor_id();
198 		ldt_desc ldt;
199 
200 		set_tssldt_descriptor(&ldt, (unsigned long)addr, DESC_LDT,
201 				      entries * LDT_ENTRY_SIZE - 1);
202 		write_gdt_entry(get_cpu_gdt_rw(cpu), GDT_ENTRY_LDT,
203 				&ldt, DESC_LDT);
204 		asm volatile("lldt %w0"::"q" (GDT_ENTRY_LDT*8));
205 	}
206 }
207 
208 static inline void native_load_gdt(const struct desc_ptr *dtr)
209 {
210 	asm volatile("lgdt %0"::"m" (*dtr));
211 }
212 
213 static __always_inline void native_load_idt(const struct desc_ptr *dtr)
214 {
215 	asm volatile("lidt %0"::"m" (*dtr));
216 }
217 
218 static inline void native_store_gdt(struct desc_ptr *dtr)
219 {
220 	asm volatile("sgdt %0":"=m" (*dtr));
221 }
222 
223 static inline void store_idt(struct desc_ptr *dtr)
224 {
225 	asm volatile("sidt %0":"=m" (*dtr));
226 }
227 
228 /*
229  * The LTR instruction marks the TSS GDT entry as busy. On 64-bit, the GDT is
230  * a read-only remapping. To prevent a page fault, the GDT is switched to the
231  * original writeable version when needed.
232  */
233 #ifdef CONFIG_X86_64
234 static inline void native_load_tr_desc(void)
235 {
236 	struct desc_ptr gdt;
237 	int cpu = raw_smp_processor_id();
238 	bool restore = 0;
239 	struct desc_struct *fixmap_gdt;
240 
241 	native_store_gdt(&gdt);
242 	fixmap_gdt = get_cpu_gdt_ro(cpu);
243 
244 	/*
245 	 * If the current GDT is the read-only fixmap, swap to the original
246 	 * writeable version. Swap back at the end.
247 	 */
248 	if (gdt.address == (unsigned long)fixmap_gdt) {
249 		load_direct_gdt(cpu);
250 		restore = 1;
251 	}
252 	asm volatile("ltr %w0"::"q" (GDT_ENTRY_TSS*8));
253 	if (restore)
254 		load_fixmap_gdt(cpu);
255 }
256 #else
257 static inline void native_load_tr_desc(void)
258 {
259 	asm volatile("ltr %w0"::"q" (GDT_ENTRY_TSS*8));
260 }
261 #endif
262 
263 static inline unsigned long native_store_tr(void)
264 {
265 	unsigned long tr;
266 
267 	asm volatile("str %0":"=r" (tr));
268 
269 	return tr;
270 }
271 
272 static inline void native_load_tls(struct thread_struct *t, unsigned int cpu)
273 {
274 	struct desc_struct *gdt = get_cpu_gdt_rw(cpu);
275 	unsigned int i;
276 
277 	for (i = 0; i < GDT_ENTRY_TLS_ENTRIES; i++)
278 		gdt[GDT_ENTRY_TLS_MIN + i] = t->tls_array[i];
279 }
280 
281 DECLARE_PER_CPU(bool, __tss_limit_invalid);
282 
283 static inline void force_reload_TR(void)
284 {
285 	struct desc_struct *d = get_current_gdt_rw();
286 	tss_desc tss;
287 
288 	memcpy(&tss, &d[GDT_ENTRY_TSS], sizeof(tss_desc));
289 
290 	/*
291 	 * LTR requires an available TSS, and the TSS is currently
292 	 * busy.  Make it be available so that LTR will work.
293 	 */
294 	tss.type = DESC_TSS;
295 	write_gdt_entry(d, GDT_ENTRY_TSS, &tss, DESC_TSS);
296 
297 	load_TR_desc();
298 	this_cpu_write(__tss_limit_invalid, false);
299 }
300 
301 /*
302  * Call this if you need the TSS limit to be correct, which should be the case
303  * if and only if you have TIF_IO_BITMAP set or you're switching to a task
304  * with TIF_IO_BITMAP set.
305  */
306 static inline void refresh_tss_limit(void)
307 {
308 	DEBUG_LOCKS_WARN_ON(preemptible());
309 
310 	if (unlikely(this_cpu_read(__tss_limit_invalid)))
311 		force_reload_TR();
312 }
313 
314 /*
315  * If you do something evil that corrupts the cached TSS limit (I'm looking
316  * at you, VMX exits), call this function.
317  *
318  * The optimization here is that the TSS limit only matters for Linux if the
319  * IO bitmap is in use.  If the TSS limit gets forced to its minimum value,
320  * everything works except that IO bitmap will be ignored and all CPL 3 IO
321  * instructions will #GP, which is exactly what we want for normal tasks.
322  */
323 static inline void invalidate_tss_limit(void)
324 {
325 	DEBUG_LOCKS_WARN_ON(preemptible());
326 
327 	if (unlikely(test_thread_flag(TIF_IO_BITMAP)))
328 		force_reload_TR();
329 	else
330 		this_cpu_write(__tss_limit_invalid, true);
331 }
332 
333 /* This intentionally ignores lm, since 32-bit apps don't have that field. */
334 #define LDT_empty(info)					\
335 	((info)->base_addr		== 0	&&	\
336 	 (info)->limit			== 0	&&	\
337 	 (info)->contents		== 0	&&	\
338 	 (info)->read_exec_only		== 1	&&	\
339 	 (info)->seg_32bit		== 0	&&	\
340 	 (info)->limit_in_pages		== 0	&&	\
341 	 (info)->seg_not_present	== 1	&&	\
342 	 (info)->useable		== 0)
343 
344 /* Lots of programs expect an all-zero user_desc to mean "no segment at all". */
345 static inline bool LDT_zero(const struct user_desc *info)
346 {
347 	return (info->base_addr		== 0 &&
348 		info->limit		== 0 &&
349 		info->contents		== 0 &&
350 		info->read_exec_only	== 0 &&
351 		info->seg_32bit		== 0 &&
352 		info->limit_in_pages	== 0 &&
353 		info->seg_not_present	== 0 &&
354 		info->useable		== 0);
355 }
356 
357 static inline void clear_LDT(void)
358 {
359 	set_ldt(NULL, 0);
360 }
361 
362 static inline unsigned long get_desc_base(const struct desc_struct *desc)
363 {
364 	return (unsigned)(desc->base0 | ((desc->base1) << 16) | ((desc->base2) << 24));
365 }
366 
367 static inline void set_desc_base(struct desc_struct *desc, unsigned long base)
368 {
369 	desc->base0 = base & 0xffff;
370 	desc->base1 = (base >> 16) & 0xff;
371 	desc->base2 = (base >> 24) & 0xff;
372 }
373 
374 static inline unsigned long get_desc_limit(const struct desc_struct *desc)
375 {
376 	return desc->limit0 | (desc->limit1 << 16);
377 }
378 
379 static inline void set_desc_limit(struct desc_struct *desc, unsigned long limit)
380 {
381 	desc->limit0 = limit & 0xffff;
382 	desc->limit1 = (limit >> 16) & 0xf;
383 }
384 
385 void alloc_intr_gate(unsigned int n, const void *addr);
386 
387 static inline void init_idt_data(struct idt_data *data, unsigned int n,
388 				 const void *addr)
389 {
390 	BUG_ON(n > 0xFF);
391 
392 	memset(data, 0, sizeof(*data));
393 	data->vector	= n;
394 	data->addr	= addr;
395 	data->segment	= __KERNEL_CS;
396 	data->bits.type	= GATE_INTERRUPT;
397 	data->bits.p	= 1;
398 }
399 
400 static inline void idt_init_desc(gate_desc *gate, const struct idt_data *d)
401 {
402 	unsigned long addr = (unsigned long) d->addr;
403 
404 	gate->offset_low	= (u16) addr;
405 	gate->segment		= (u16) d->segment;
406 	gate->bits		= d->bits;
407 	gate->offset_middle	= (u16) (addr >> 16);
408 #ifdef CONFIG_X86_64
409 	gate->offset_high	= (u32) (addr >> 32);
410 	gate->reserved		= 0;
411 #endif
412 }
413 
414 extern unsigned long system_vectors[];
415 
416 extern void load_current_idt(void);
417 extern void idt_setup_early_handler(void);
418 extern void idt_setup_early_traps(void);
419 extern void idt_setup_traps(void);
420 extern void idt_setup_apic_and_irq_gates(void);
421 extern bool idt_is_f00f_address(unsigned long address);
422 
423 #ifdef CONFIG_X86_64
424 extern void idt_setup_early_pf(void);
425 extern void idt_setup_ist_traps(void);
426 #else
427 static inline void idt_setup_early_pf(void) { }
428 static inline void idt_setup_ist_traps(void) { }
429 #endif
430 
431 extern void idt_invalidate(void *addr);
432 
433 #endif /* _ASM_X86_DESC_H */
434