Merge branch 'work.mount' of git://git.kernel.org/pub/scm/linux/kernel/git/viro/vfs
[linux-2.6-block.git] / arch / x86 / mm / mpx.c
1 /*
2  * mpx.c - Memory Protection eXtensions
3  *
4  * Copyright (c) 2014, Intel Corporation.
5  * Qiaowei Ren <qiaowei.ren@intel.com>
6  * Dave Hansen <dave.hansen@intel.com>
7  */
8 #include <linux/kernel.h>
9 #include <linux/slab.h>
10 #include <linux/mm_types.h>
11 #include <linux/syscalls.h>
12 #include <linux/sched/sysctl.h>
13
14 #include <asm/insn.h>
15 #include <asm/mman.h>
16 #include <asm/mmu_context.h>
17 #include <asm/mpx.h>
18 #include <asm/processor.h>
19 #include <asm/fpu/internal.h>
20
21 #define CREATE_TRACE_POINTS
22 #include <asm/trace/mpx.h>
23
24 static inline unsigned long mpx_bd_size_bytes(struct mm_struct *mm)
25 {
26         if (is_64bit_mm(mm))
27                 return MPX_BD_SIZE_BYTES_64;
28         else
29                 return MPX_BD_SIZE_BYTES_32;
30 }
31
32 static inline unsigned long mpx_bt_size_bytes(struct mm_struct *mm)
33 {
34         if (is_64bit_mm(mm))
35                 return MPX_BT_SIZE_BYTES_64;
36         else
37                 return MPX_BT_SIZE_BYTES_32;
38 }
39
40 /*
41  * This is really a simplified "vm_mmap". it only handles MPX
42  * bounds tables (the bounds directory is user-allocated).
43  */
44 static unsigned long mpx_mmap(unsigned long len)
45 {
46         struct mm_struct *mm = current->mm;
47         unsigned long addr, populate;
48
49         /* Only bounds table can be allocated here */
50         if (len != mpx_bt_size_bytes(mm))
51                 return -EINVAL;
52
53         down_write(&mm->mmap_sem);
54         addr = do_mmap(NULL, 0, len, PROT_READ | PROT_WRITE,
55                        MAP_ANONYMOUS | MAP_PRIVATE, VM_MPX, 0, &populate, NULL);
56         up_write(&mm->mmap_sem);
57         if (populate)
58                 mm_populate(addr, populate);
59
60         return addr;
61 }
62
63 enum reg_type {
64         REG_TYPE_RM = 0,
65         REG_TYPE_INDEX,
66         REG_TYPE_BASE,
67 };
68
69 static int get_reg_offset(struct insn *insn, struct pt_regs *regs,
70                           enum reg_type type)
71 {
72         int regno = 0;
73
74         static const int regoff[] = {
75                 offsetof(struct pt_regs, ax),
76                 offsetof(struct pt_regs, cx),
77                 offsetof(struct pt_regs, dx),
78                 offsetof(struct pt_regs, bx),
79                 offsetof(struct pt_regs, sp),
80                 offsetof(struct pt_regs, bp),
81                 offsetof(struct pt_regs, si),
82                 offsetof(struct pt_regs, di),
83 #ifdef CONFIG_X86_64
84                 offsetof(struct pt_regs, r8),
85                 offsetof(struct pt_regs, r9),
86                 offsetof(struct pt_regs, r10),
87                 offsetof(struct pt_regs, r11),
88                 offsetof(struct pt_regs, r12),
89                 offsetof(struct pt_regs, r13),
90                 offsetof(struct pt_regs, r14),
91                 offsetof(struct pt_regs, r15),
92 #endif
93         };
94         int nr_registers = ARRAY_SIZE(regoff);
95         /*
96          * Don't possibly decode a 32-bit instructions as
97          * reading a 64-bit-only register.
98          */
99         if (IS_ENABLED(CONFIG_X86_64) && !insn->x86_64)
100                 nr_registers -= 8;
101
102         switch (type) {
103         case REG_TYPE_RM:
104                 regno = X86_MODRM_RM(insn->modrm.value);
105                 if (X86_REX_B(insn->rex_prefix.value))
106                         regno += 8;
107                 break;
108
109         case REG_TYPE_INDEX:
110                 regno = X86_SIB_INDEX(insn->sib.value);
111                 if (X86_REX_X(insn->rex_prefix.value))
112                         regno += 8;
113                 break;
114
115         case REG_TYPE_BASE:
116                 regno = X86_SIB_BASE(insn->sib.value);
117                 if (X86_REX_B(insn->rex_prefix.value))
118                         regno += 8;
119                 break;
120
121         default:
122                 pr_err("invalid register type");
123                 BUG();
124                 break;
125         }
126
127         if (regno >= nr_registers) {
128                 WARN_ONCE(1, "decoded an instruction with an invalid register");
129                 return -EINVAL;
130         }
131         return regoff[regno];
132 }
133
134 /*
135  * return the address being referenced be instruction
136  * for rm=3 returning the content of the rm reg
137  * for rm!=3 calculates the address using SIB and Disp
138  */
139 static void __user *mpx_get_addr_ref(struct insn *insn, struct pt_regs *regs)
140 {
141         unsigned long addr, base, indx;
142         int addr_offset, base_offset, indx_offset;
143         insn_byte_t sib;
144
145         insn_get_modrm(insn);
146         insn_get_sib(insn);
147         sib = insn->sib.value;
148
149         if (X86_MODRM_MOD(insn->modrm.value) == 3) {
150                 addr_offset = get_reg_offset(insn, regs, REG_TYPE_RM);
151                 if (addr_offset < 0)
152                         goto out_err;
153                 addr = regs_get_register(regs, addr_offset);
154         } else {
155                 if (insn->sib.nbytes) {
156                         base_offset = get_reg_offset(insn, regs, REG_TYPE_BASE);
157                         if (base_offset < 0)
158                                 goto out_err;
159
160                         indx_offset = get_reg_offset(insn, regs, REG_TYPE_INDEX);
161                         if (indx_offset < 0)
162                                 goto out_err;
163
164                         base = regs_get_register(regs, base_offset);
165                         indx = regs_get_register(regs, indx_offset);
166                         addr = base + indx * (1 << X86_SIB_SCALE(sib));
167                 } else {
168                         addr_offset = get_reg_offset(insn, regs, REG_TYPE_RM);
169                         if (addr_offset < 0)
170                                 goto out_err;
171                         addr = regs_get_register(regs, addr_offset);
172                 }
173                 addr += insn->displacement.value;
174         }
175         return (void __user *)addr;
176 out_err:
177         return (void __user *)-1;
178 }
179
180 static int mpx_insn_decode(struct insn *insn,
181                            struct pt_regs *regs)
182 {
183         unsigned char buf[MAX_INSN_SIZE];
184         int x86_64 = !test_thread_flag(TIF_IA32);
185         int not_copied;
186         int nr_copied;
187
188         not_copied = copy_from_user(buf, (void __user *)regs->ip, sizeof(buf));
189         nr_copied = sizeof(buf) - not_copied;
190         /*
191          * The decoder _should_ fail nicely if we pass it a short buffer.
192          * But, let's not depend on that implementation detail.  If we
193          * did not get anything, just error out now.
194          */
195         if (!nr_copied)
196                 return -EFAULT;
197         insn_init(insn, buf, nr_copied, x86_64);
198         insn_get_length(insn);
199         /*
200          * copy_from_user() tries to get as many bytes as we could see in
201          * the largest possible instruction.  If the instruction we are
202          * after is shorter than that _and_ we attempt to copy from
203          * something unreadable, we might get a short read.  This is OK
204          * as long as the read did not stop in the middle of the
205          * instruction.  Check to see if we got a partial instruction.
206          */
207         if (nr_copied < insn->length)
208                 return -EFAULT;
209
210         insn_get_opcode(insn);
211         /*
212          * We only _really_ need to decode bndcl/bndcn/bndcu
213          * Error out on anything else.
214          */
215         if (insn->opcode.bytes[0] != 0x0f)
216                 goto bad_opcode;
217         if ((insn->opcode.bytes[1] != 0x1a) &&
218             (insn->opcode.bytes[1] != 0x1b))
219                 goto bad_opcode;
220
221         return 0;
222 bad_opcode:
223         return -EINVAL;
224 }
225
226 /*
227  * If a bounds overflow occurs then a #BR is generated. This
228  * function decodes MPX instructions to get violation address
229  * and set this address into extended struct siginfo.
230  *
231  * Note that this is not a super precise way of doing this.
232  * Userspace could have, by the time we get here, written
233  * anything it wants in to the instructions.  We can not
234  * trust anything about it.  They might not be valid
235  * instructions or might encode invalid registers, etc...
236  *
237  * The caller is expected to kfree() the returned siginfo_t.
238  */
239 siginfo_t *mpx_generate_siginfo(struct pt_regs *regs)
240 {
241         const struct mpx_bndreg_state *bndregs;
242         const struct mpx_bndreg *bndreg;
243         siginfo_t *info = NULL;
244         struct insn insn;
245         uint8_t bndregno;
246         int err;
247
248         err = mpx_insn_decode(&insn, regs);
249         if (err)
250                 goto err_out;
251
252         /*
253          * We know at this point that we are only dealing with
254          * MPX instructions.
255          */
256         insn_get_modrm(&insn);
257         bndregno = X86_MODRM_REG(insn.modrm.value);
258         if (bndregno > 3) {
259                 err = -EINVAL;
260                 goto err_out;
261         }
262         /* get bndregs field from current task's xsave area */
263         bndregs = get_xsave_field_ptr(XFEATURE_MASK_BNDREGS);
264         if (!bndregs) {
265                 err = -EINVAL;
266                 goto err_out;
267         }
268         /* now go select the individual register in the set of 4 */
269         bndreg = &bndregs->bndreg[bndregno];
270
271         info = kzalloc(sizeof(*info), GFP_KERNEL);
272         if (!info) {
273                 err = -ENOMEM;
274                 goto err_out;
275         }
276         /*
277          * The registers are always 64-bit, but the upper 32
278          * bits are ignored in 32-bit mode.  Also, note that the
279          * upper bounds are architecturally represented in 1's
280          * complement form.
281          *
282          * The 'unsigned long' cast is because the compiler
283          * complains when casting from integers to different-size
284          * pointers.
285          */
286         info->si_lower = (void __user *)(unsigned long)bndreg->lower_bound;
287         info->si_upper = (void __user *)(unsigned long)~bndreg->upper_bound;
288         info->si_addr_lsb = 0;
289         info->si_signo = SIGSEGV;
290         info->si_errno = 0;
291         info->si_code = SEGV_BNDERR;
292         info->si_addr = mpx_get_addr_ref(&insn, regs);
293         /*
294          * We were not able to extract an address from the instruction,
295          * probably because there was something invalid in it.
296          */
297         if (info->si_addr == (void __user *)-1) {
298                 err = -EINVAL;
299                 goto err_out;
300         }
301         trace_mpx_bounds_register_exception(info->si_addr, bndreg);
302         return info;
303 err_out:
304         /* info might be NULL, but kfree() handles that */
305         kfree(info);
306         return ERR_PTR(err);
307 }
308
309 static __user void *mpx_get_bounds_dir(void)
310 {
311         const struct mpx_bndcsr *bndcsr;
312
313         if (!cpu_feature_enabled(X86_FEATURE_MPX))
314                 return MPX_INVALID_BOUNDS_DIR;
315
316         /*
317          * The bounds directory pointer is stored in a register
318          * only accessible if we first do an xsave.
319          */
320         bndcsr = get_xsave_field_ptr(XFEATURE_MASK_BNDCSR);
321         if (!bndcsr)
322                 return MPX_INVALID_BOUNDS_DIR;
323
324         /*
325          * Make sure the register looks valid by checking the
326          * enable bit.
327          */
328         if (!(bndcsr->bndcfgu & MPX_BNDCFG_ENABLE_FLAG))
329                 return MPX_INVALID_BOUNDS_DIR;
330
331         /*
332          * Lastly, mask off the low bits used for configuration
333          * flags, and return the address of the bounds table.
334          */
335         return (void __user *)(unsigned long)
336                 (bndcsr->bndcfgu & MPX_BNDCFG_ADDR_MASK);
337 }
338
339 int mpx_enable_management(void)
340 {
341         void __user *bd_base = MPX_INVALID_BOUNDS_DIR;
342         struct mm_struct *mm = current->mm;
343         int ret = 0;
344
345         /*
346          * runtime in the userspace will be responsible for allocation of
347          * the bounds directory. Then, it will save the base of the bounds
348          * directory into XSAVE/XRSTOR Save Area and enable MPX through
349          * XRSTOR instruction.
350          *
351          * The copy_xregs_to_kernel() beneath get_xsave_field_ptr() is
352          * expected to be relatively expensive. Storing the bounds
353          * directory here means that we do not have to do xsave in the
354          * unmap path; we can just use mm->context.bd_addr instead.
355          */
356         bd_base = mpx_get_bounds_dir();
357         down_write(&mm->mmap_sem);
358
359         /* MPX doesn't support addresses above 47 bits yet. */
360         if (find_vma(mm, DEFAULT_MAP_WINDOW)) {
361                 pr_warn_once("%s (%d): MPX cannot handle addresses "
362                                 "above 47-bits. Disabling.",
363                                 current->comm, current->pid);
364                 ret = -ENXIO;
365                 goto out;
366         }
367         mm->context.bd_addr = bd_base;
368         if (mm->context.bd_addr == MPX_INVALID_BOUNDS_DIR)
369                 ret = -ENXIO;
370 out:
371         up_write(&mm->mmap_sem);
372         return ret;
373 }
374
375 int mpx_disable_management(void)
376 {
377         struct mm_struct *mm = current->mm;
378
379         if (!cpu_feature_enabled(X86_FEATURE_MPX))
380                 return -ENXIO;
381
382         down_write(&mm->mmap_sem);
383         mm->context.bd_addr = MPX_INVALID_BOUNDS_DIR;
384         up_write(&mm->mmap_sem);
385         return 0;
386 }
387
388 static int mpx_cmpxchg_bd_entry(struct mm_struct *mm,
389                 unsigned long *curval,
390                 unsigned long __user *addr,
391                 unsigned long old_val, unsigned long new_val)
392 {
393         int ret;
394         /*
395          * user_atomic_cmpxchg_inatomic() actually uses sizeof()
396          * the pointer that we pass to it to figure out how much
397          * data to cmpxchg.  We have to be careful here not to
398          * pass a pointer to a 64-bit data type when we only want
399          * a 32-bit copy.
400          */
401         if (is_64bit_mm(mm)) {
402                 ret = user_atomic_cmpxchg_inatomic(curval,
403                                 addr, old_val, new_val);
404         } else {
405                 u32 uninitialized_var(curval_32);
406                 u32 old_val_32 = old_val;
407                 u32 new_val_32 = new_val;
408                 u32 __user *addr_32 = (u32 __user *)addr;
409
410                 ret = user_atomic_cmpxchg_inatomic(&curval_32,
411                                 addr_32, old_val_32, new_val_32);
412                 *curval = curval_32;
413         }
414         return ret;
415 }
416
417 /*
418  * With 32-bit mode, a bounds directory is 4MB, and the size of each
419  * bounds table is 16KB. With 64-bit mode, a bounds directory is 2GB,
420  * and the size of each bounds table is 4MB.
421  */
422 static int allocate_bt(struct mm_struct *mm, long __user *bd_entry)
423 {
424         unsigned long expected_old_val = 0;
425         unsigned long actual_old_val = 0;
426         unsigned long bt_addr;
427         unsigned long bd_new_entry;
428         int ret = 0;
429
430         /*
431          * Carve the virtual space out of userspace for the new
432          * bounds table:
433          */
434         bt_addr = mpx_mmap(mpx_bt_size_bytes(mm));
435         if (IS_ERR((void *)bt_addr))
436                 return PTR_ERR((void *)bt_addr);
437         /*
438          * Set the valid flag (kinda like _PAGE_PRESENT in a pte)
439          */
440         bd_new_entry = bt_addr | MPX_BD_ENTRY_VALID_FLAG;
441
442         /*
443          * Go poke the address of the new bounds table in to the
444          * bounds directory entry out in userspace memory.  Note:
445          * we may race with another CPU instantiating the same table.
446          * In that case the cmpxchg will see an unexpected
447          * 'actual_old_val'.
448          *
449          * This can fault, but that's OK because we do not hold
450          * mmap_sem at this point, unlike some of the other part
451          * of the MPX code that have to pagefault_disable().
452          */
453         ret = mpx_cmpxchg_bd_entry(mm, &actual_old_val, bd_entry,
454                                    expected_old_val, bd_new_entry);
455         if (ret)
456                 goto out_unmap;
457
458         /*
459          * The user_atomic_cmpxchg_inatomic() will only return nonzero
460          * for faults, *not* if the cmpxchg itself fails.  Now we must
461          * verify that the cmpxchg itself completed successfully.
462          */
463         /*
464          * We expected an empty 'expected_old_val', but instead found
465          * an apparently valid entry.  Assume we raced with another
466          * thread to instantiate this table and desclare succecss.
467          */
468         if (actual_old_val & MPX_BD_ENTRY_VALID_FLAG) {
469                 ret = 0;
470                 goto out_unmap;
471         }
472         /*
473          * We found a non-empty bd_entry but it did not have the
474          * VALID_FLAG set.  Return an error which will result in
475          * a SEGV since this probably means that somebody scribbled
476          * some invalid data in to a bounds table.
477          */
478         if (expected_old_val != actual_old_val) {
479                 ret = -EINVAL;
480                 goto out_unmap;
481         }
482         trace_mpx_new_bounds_table(bt_addr);
483         return 0;
484 out_unmap:
485         vm_munmap(bt_addr, mpx_bt_size_bytes(mm));
486         return ret;
487 }
488
489 /*
490  * When a BNDSTX instruction attempts to save bounds to a bounds
491  * table, it will first attempt to look up the table in the
492  * first-level bounds directory.  If it does not find a table in
493  * the directory, a #BR is generated and we get here in order to
494  * allocate a new table.
495  *
496  * With 32-bit mode, the size of BD is 4MB, and the size of each
497  * bound table is 16KB. With 64-bit mode, the size of BD is 2GB,
498  * and the size of each bound table is 4MB.
499  */
500 static int do_mpx_bt_fault(void)
501 {
502         unsigned long bd_entry, bd_base;
503         const struct mpx_bndcsr *bndcsr;
504         struct mm_struct *mm = current->mm;
505
506         bndcsr = get_xsave_field_ptr(XFEATURE_MASK_BNDCSR);
507         if (!bndcsr)
508                 return -EINVAL;
509         /*
510          * Mask off the preserve and enable bits
511          */
512         bd_base = bndcsr->bndcfgu & MPX_BNDCFG_ADDR_MASK;
513         /*
514          * The hardware provides the address of the missing or invalid
515          * entry via BNDSTATUS, so we don't have to go look it up.
516          */
517         bd_entry = bndcsr->bndstatus & MPX_BNDSTA_ADDR_MASK;
518         /*
519          * Make sure the directory entry is within where we think
520          * the directory is.
521          */
522         if ((bd_entry < bd_base) ||
523             (bd_entry >= bd_base + mpx_bd_size_bytes(mm)))
524                 return -EINVAL;
525
526         return allocate_bt(mm, (long __user *)bd_entry);
527 }
528
529 int mpx_handle_bd_fault(void)
530 {
531         /*
532          * Userspace never asked us to manage the bounds tables,
533          * so refuse to help.
534          */
535         if (!kernel_managing_mpx_tables(current->mm))
536                 return -EINVAL;
537
538         return do_mpx_bt_fault();
539 }
540
541 /*
542  * A thin wrapper around get_user_pages().  Returns 0 if the
543  * fault was resolved or -errno if not.
544  */
545 static int mpx_resolve_fault(long __user *addr, int write)
546 {
547         long gup_ret;
548         int nr_pages = 1;
549
550         gup_ret = get_user_pages((unsigned long)addr, nr_pages,
551                         write ? FOLL_WRITE : 0, NULL, NULL);
552         /*
553          * get_user_pages() returns number of pages gotten.
554          * 0 means we failed to fault in and get anything,
555          * probably because 'addr' is bad.
556          */
557         if (!gup_ret)
558                 return -EFAULT;
559         /* Other error, return it */
560         if (gup_ret < 0)
561                 return gup_ret;
562         /* must have gup'd a page and gup_ret>0, success */
563         return 0;
564 }
565
566 static unsigned long mpx_bd_entry_to_bt_addr(struct mm_struct *mm,
567                                              unsigned long bd_entry)
568 {
569         unsigned long bt_addr = bd_entry;
570         int align_to_bytes;
571         /*
572          * Bit 0 in a bt_entry is always the valid bit.
573          */
574         bt_addr &= ~MPX_BD_ENTRY_VALID_FLAG;
575         /*
576          * Tables are naturally aligned at 8-byte boundaries
577          * on 64-bit and 4-byte boundaries on 32-bit.  The
578          * documentation makes it appear that the low bits
579          * are ignored by the hardware, so we do the same.
580          */
581         if (is_64bit_mm(mm))
582                 align_to_bytes = 8;
583         else
584                 align_to_bytes = 4;
585         bt_addr &= ~(align_to_bytes-1);
586         return bt_addr;
587 }
588
589 /*
590  * We only want to do a 4-byte get_user() on 32-bit.  Otherwise,
591  * we might run off the end of the bounds table if we are on
592  * a 64-bit kernel and try to get 8 bytes.
593  */
594 static int get_user_bd_entry(struct mm_struct *mm, unsigned long *bd_entry_ret,
595                 long __user *bd_entry_ptr)
596 {
597         u32 bd_entry_32;
598         int ret;
599
600         if (is_64bit_mm(mm))
601                 return get_user(*bd_entry_ret, bd_entry_ptr);
602
603         /*
604          * Note that get_user() uses the type of the *pointer* to
605          * establish the size of the get, not the destination.
606          */
607         ret = get_user(bd_entry_32, (u32 __user *)bd_entry_ptr);
608         *bd_entry_ret = bd_entry_32;
609         return ret;
610 }
611
612 /*
613  * Get the base of bounds tables pointed by specific bounds
614  * directory entry.
615  */
616 static int get_bt_addr(struct mm_struct *mm,
617                         long __user *bd_entry_ptr,
618                         unsigned long *bt_addr_result)
619 {
620         int ret;
621         int valid_bit;
622         unsigned long bd_entry;
623         unsigned long bt_addr;
624
625         if (!access_ok(VERIFY_READ, (bd_entry_ptr), sizeof(*bd_entry_ptr)))
626                 return -EFAULT;
627
628         while (1) {
629                 int need_write = 0;
630
631                 pagefault_disable();
632                 ret = get_user_bd_entry(mm, &bd_entry, bd_entry_ptr);
633                 pagefault_enable();
634                 if (!ret)
635                         break;
636                 if (ret == -EFAULT)
637                         ret = mpx_resolve_fault(bd_entry_ptr, need_write);
638                 /*
639                  * If we could not resolve the fault, consider it
640                  * userspace's fault and error out.
641                  */
642                 if (ret)
643                         return ret;
644         }
645
646         valid_bit = bd_entry & MPX_BD_ENTRY_VALID_FLAG;
647         bt_addr = mpx_bd_entry_to_bt_addr(mm, bd_entry);
648
649         /*
650          * When the kernel is managing bounds tables, a bounds directory
651          * entry will either have a valid address (plus the valid bit)
652          * *OR* be completely empty. If we see a !valid entry *and* some
653          * data in the address field, we know something is wrong. This
654          * -EINVAL return will cause a SIGSEGV.
655          */
656         if (!valid_bit && bt_addr)
657                 return -EINVAL;
658         /*
659          * Do we have an completely zeroed bt entry?  That is OK.  It
660          * just means there was no bounds table for this memory.  Make
661          * sure to distinguish this from -EINVAL, which will cause
662          * a SEGV.
663          */
664         if (!valid_bit)
665                 return -ENOENT;
666
667         *bt_addr_result = bt_addr;
668         return 0;
669 }
670
671 static inline int bt_entry_size_bytes(struct mm_struct *mm)
672 {
673         if (is_64bit_mm(mm))
674                 return MPX_BT_ENTRY_BYTES_64;
675         else
676                 return MPX_BT_ENTRY_BYTES_32;
677 }
678
679 /*
680  * Take a virtual address and turns it in to the offset in bytes
681  * inside of the bounds table where the bounds table entry
682  * controlling 'addr' can be found.
683  */
684 static unsigned long mpx_get_bt_entry_offset_bytes(struct mm_struct *mm,
685                 unsigned long addr)
686 {
687         unsigned long bt_table_nr_entries;
688         unsigned long offset = addr;
689
690         if (is_64bit_mm(mm)) {
691                 /* Bottom 3 bits are ignored on 64-bit */
692                 offset >>= 3;
693                 bt_table_nr_entries = MPX_BT_NR_ENTRIES_64;
694         } else {
695                 /* Bottom 2 bits are ignored on 32-bit */
696                 offset >>= 2;
697                 bt_table_nr_entries = MPX_BT_NR_ENTRIES_32;
698         }
699         /*
700          * We know the size of the table in to which we are
701          * indexing, and we have eliminated all the low bits
702          * which are ignored for indexing.
703          *
704          * Mask out all the high bits which we do not need
705          * to index in to the table.  Note that the tables
706          * are always powers of two so this gives us a proper
707          * mask.
708          */
709         offset &= (bt_table_nr_entries-1);
710         /*
711          * We now have an entry offset in terms of *entries* in
712          * the table.  We need to scale it back up to bytes.
713          */
714         offset *= bt_entry_size_bytes(mm);
715         return offset;
716 }
717
718 /*
719  * How much virtual address space does a single bounds
720  * directory entry cover?
721  *
722  * Note, we need a long long because 4GB doesn't fit in
723  * to a long on 32-bit.
724  */
725 static inline unsigned long bd_entry_virt_space(struct mm_struct *mm)
726 {
727         unsigned long long virt_space;
728         unsigned long long GB = (1ULL << 30);
729
730         /*
731          * This covers 32-bit emulation as well as 32-bit kernels
732          * running on 64-bit hardware.
733          */
734         if (!is_64bit_mm(mm))
735                 return (4ULL * GB) / MPX_BD_NR_ENTRIES_32;
736
737         /*
738          * 'x86_virt_bits' returns what the hardware is capable
739          * of, and returns the full >32-bit address space when
740          * running 32-bit kernels on 64-bit hardware.
741          */
742         virt_space = (1ULL << boot_cpu_data.x86_virt_bits);
743         return virt_space / MPX_BD_NR_ENTRIES_64;
744 }
745
746 /*
747  * Free the backing physical pages of bounds table 'bt_addr'.
748  * Assume start...end is within that bounds table.
749  */
750 static noinline int zap_bt_entries_mapping(struct mm_struct *mm,
751                 unsigned long bt_addr,
752                 unsigned long start_mapping, unsigned long end_mapping)
753 {
754         struct vm_area_struct *vma;
755         unsigned long addr, len;
756         unsigned long start;
757         unsigned long end;
758
759         /*
760          * if we 'end' on a boundary, the offset will be 0 which
761          * is not what we want.  Back it up a byte to get the
762          * last bt entry.  Then once we have the entry itself,
763          * move 'end' back up by the table entry size.
764          */
765         start = bt_addr + mpx_get_bt_entry_offset_bytes(mm, start_mapping);
766         end   = bt_addr + mpx_get_bt_entry_offset_bytes(mm, end_mapping - 1);
767         /*
768          * Move end back up by one entry.  Among other things
769          * this ensures that it remains page-aligned and does
770          * not screw up zap_page_range()
771          */
772         end += bt_entry_size_bytes(mm);
773
774         /*
775          * Find the first overlapping vma. If vma->vm_start > start, there
776          * will be a hole in the bounds table. This -EINVAL return will
777          * cause a SIGSEGV.
778          */
779         vma = find_vma(mm, start);
780         if (!vma || vma->vm_start > start)
781                 return -EINVAL;
782
783         /*
784          * A NUMA policy on a VM_MPX VMA could cause this bounds table to
785          * be split. So we need to look across the entire 'start -> end'
786          * range of this bounds table, find all of the VM_MPX VMAs, and
787          * zap only those.
788          */
789         addr = start;
790         while (vma && vma->vm_start < end) {
791                 /*
792                  * We followed a bounds directory entry down
793                  * here.  If we find a non-MPX VMA, that's bad,
794                  * so stop immediately and return an error.  This
795                  * probably results in a SIGSEGV.
796                  */
797                 if (!(vma->vm_flags & VM_MPX))
798                         return -EINVAL;
799
800                 len = min(vma->vm_end, end) - addr;
801                 zap_page_range(vma, addr, len);
802                 trace_mpx_unmap_zap(addr, addr+len);
803
804                 vma = vma->vm_next;
805                 addr = vma->vm_start;
806         }
807         return 0;
808 }
809
810 static unsigned long mpx_get_bd_entry_offset(struct mm_struct *mm,
811                 unsigned long addr)
812 {
813         /*
814          * There are several ways to derive the bd offsets.  We
815          * use the following approach here:
816          * 1. We know the size of the virtual address space
817          * 2. We know the number of entries in a bounds table
818          * 3. We know that each entry covers a fixed amount of
819          *    virtual address space.
820          * So, we can just divide the virtual address by the
821          * virtual space used by one entry to determine which
822          * entry "controls" the given virtual address.
823          */
824         if (is_64bit_mm(mm)) {
825                 int bd_entry_size = 8; /* 64-bit pointer */
826                 /*
827                  * Take the 64-bit addressing hole in to account.
828                  */
829                 addr &= ((1UL << boot_cpu_data.x86_virt_bits) - 1);
830                 return (addr / bd_entry_virt_space(mm)) * bd_entry_size;
831         } else {
832                 int bd_entry_size = 4; /* 32-bit pointer */
833                 /*
834                  * 32-bit has no hole so this case needs no mask
835                  */
836                 return (addr / bd_entry_virt_space(mm)) * bd_entry_size;
837         }
838         /*
839          * The two return calls above are exact copies.  If we
840          * pull out a single copy and put it in here, gcc won't
841          * realize that we're doing a power-of-2 divide and use
842          * shifts.  It uses a real divide.  If we put them up
843          * there, it manages to figure it out (gcc 4.8.3).
844          */
845 }
846
847 static int unmap_entire_bt(struct mm_struct *mm,
848                 long __user *bd_entry, unsigned long bt_addr)
849 {
850         unsigned long expected_old_val = bt_addr | MPX_BD_ENTRY_VALID_FLAG;
851         unsigned long uninitialized_var(actual_old_val);
852         int ret;
853
854         while (1) {
855                 int need_write = 1;
856                 unsigned long cleared_bd_entry = 0;
857
858                 pagefault_disable();
859                 ret = mpx_cmpxchg_bd_entry(mm, &actual_old_val,
860                                 bd_entry, expected_old_val, cleared_bd_entry);
861                 pagefault_enable();
862                 if (!ret)
863                         break;
864                 if (ret == -EFAULT)
865                         ret = mpx_resolve_fault(bd_entry, need_write);
866                 /*
867                  * If we could not resolve the fault, consider it
868                  * userspace's fault and error out.
869                  */
870                 if (ret)
871                         return ret;
872         }
873         /*
874          * The cmpxchg was performed, check the results.
875          */
876         if (actual_old_val != expected_old_val) {
877                 /*
878                  * Someone else raced with us to unmap the table.
879                  * That is OK, since we were both trying to do
880                  * the same thing.  Declare success.
881                  */
882                 if (!actual_old_val)
883                         return 0;
884                 /*
885                  * Something messed with the bounds directory
886                  * entry.  We hold mmap_sem for read or write
887                  * here, so it could not be a _new_ bounds table
888                  * that someone just allocated.  Something is
889                  * wrong, so pass up the error and SIGSEGV.
890                  */
891                 return -EINVAL;
892         }
893         /*
894          * Note, we are likely being called under do_munmap() already. To
895          * avoid recursion, do_munmap() will check whether it comes
896          * from one bounds table through VM_MPX flag.
897          */
898         return do_munmap(mm, bt_addr, mpx_bt_size_bytes(mm), NULL);
899 }
900
901 static int try_unmap_single_bt(struct mm_struct *mm,
902                unsigned long start, unsigned long end)
903 {
904         struct vm_area_struct *next;
905         struct vm_area_struct *prev;
906         /*
907          * "bta" == Bounds Table Area: the area controlled by the
908          * bounds table that we are unmapping.
909          */
910         unsigned long bta_start_vaddr = start & ~(bd_entry_virt_space(mm)-1);
911         unsigned long bta_end_vaddr = bta_start_vaddr + bd_entry_virt_space(mm);
912         unsigned long uninitialized_var(bt_addr);
913         void __user *bde_vaddr;
914         int ret;
915         /*
916          * We already unlinked the VMAs from the mm's rbtree so 'start'
917          * is guaranteed to be in a hole. This gets us the first VMA
918          * before the hole in to 'prev' and the next VMA after the hole
919          * in to 'next'.
920          */
921         next = find_vma_prev(mm, start, &prev);
922         /*
923          * Do not count other MPX bounds table VMAs as neighbors.
924          * Although theoretically possible, we do not allow bounds
925          * tables for bounds tables so our heads do not explode.
926          * If we count them as neighbors here, we may end up with
927          * lots of tables even though we have no actual table
928          * entries in use.
929          */
930         while (next && (next->vm_flags & VM_MPX))
931                 next = next->vm_next;
932         while (prev && (prev->vm_flags & VM_MPX))
933                 prev = prev->vm_prev;
934         /*
935          * We know 'start' and 'end' lie within an area controlled
936          * by a single bounds table.  See if there are any other
937          * VMAs controlled by that bounds table.  If there are not
938          * then we can "expand" the are we are unmapping to possibly
939          * cover the entire table.
940          */
941         next = find_vma_prev(mm, start, &prev);
942         if ((!prev || prev->vm_end <= bta_start_vaddr) &&
943             (!next || next->vm_start >= bta_end_vaddr)) {
944                 /*
945                  * No neighbor VMAs controlled by same bounds
946                  * table.  Try to unmap the whole thing
947                  */
948                 start = bta_start_vaddr;
949                 end = bta_end_vaddr;
950         }
951
952         bde_vaddr = mm->context.bd_addr + mpx_get_bd_entry_offset(mm, start);
953         ret = get_bt_addr(mm, bde_vaddr, &bt_addr);
954         /*
955          * No bounds table there, so nothing to unmap.
956          */
957         if (ret == -ENOENT) {
958                 ret = 0;
959                 return 0;
960         }
961         if (ret)
962                 return ret;
963         /*
964          * We are unmapping an entire table.  Either because the
965          * unmap that started this whole process was large enough
966          * to cover an entire table, or that the unmap was small
967          * but was the area covered by a bounds table.
968          */
969         if ((start == bta_start_vaddr) &&
970             (end == bta_end_vaddr))
971                 return unmap_entire_bt(mm, bde_vaddr, bt_addr);
972         return zap_bt_entries_mapping(mm, bt_addr, start, end);
973 }
974
975 static int mpx_unmap_tables(struct mm_struct *mm,
976                 unsigned long start, unsigned long end)
977 {
978         unsigned long one_unmap_start;
979         trace_mpx_unmap_search(start, end);
980
981         one_unmap_start = start;
982         while (one_unmap_start < end) {
983                 int ret;
984                 unsigned long next_unmap_start = ALIGN(one_unmap_start+1,
985                                                        bd_entry_virt_space(mm));
986                 unsigned long one_unmap_end = end;
987                 /*
988                  * if the end is beyond the current bounds table,
989                  * move it back so we only deal with a single one
990                  * at a time
991                  */
992                 if (one_unmap_end > next_unmap_start)
993                         one_unmap_end = next_unmap_start;
994                 ret = try_unmap_single_bt(mm, one_unmap_start, one_unmap_end);
995                 if (ret)
996                         return ret;
997
998                 one_unmap_start = next_unmap_start;
999         }
1000         return 0;
1001 }
1002
1003 /*
1004  * Free unused bounds tables covered in a virtual address region being
1005  * munmap()ed. Assume end > start.
1006  *
1007  * This function will be called by do_munmap(), and the VMAs covering
1008  * the virtual address region start...end have already been split if
1009  * necessary, and the 'vma' is the first vma in this range (start -> end).
1010  */
1011 void mpx_notify_unmap(struct mm_struct *mm, struct vm_area_struct *vma,
1012                 unsigned long start, unsigned long end)
1013 {
1014         int ret;
1015
1016         /*
1017          * Refuse to do anything unless userspace has asked
1018          * the kernel to help manage the bounds tables,
1019          */
1020         if (!kernel_managing_mpx_tables(current->mm))
1021                 return;
1022         /*
1023          * This will look across the entire 'start -> end' range,
1024          * and find all of the non-VM_MPX VMAs.
1025          *
1026          * To avoid recursion, if a VM_MPX vma is found in the range
1027          * (start->end), we will not continue follow-up work. This
1028          * recursion represents having bounds tables for bounds tables,
1029          * which should not occur normally. Being strict about it here
1030          * helps ensure that we do not have an exploitable stack overflow.
1031          */
1032         do {
1033                 if (vma->vm_flags & VM_MPX)
1034                         return;
1035                 vma = vma->vm_next;
1036         } while (vma && vma->vm_start < end);
1037
1038         ret = mpx_unmap_tables(mm, start, end);
1039         if (ret)
1040                 force_sig(SIGSEGV, current);
1041 }
1042
1043 /* MPX cannot handle addresses above 47 bits yet. */
1044 unsigned long mpx_unmapped_area_check(unsigned long addr, unsigned long len,
1045                 unsigned long flags)
1046 {
1047         if (!kernel_managing_mpx_tables(current->mm))
1048                 return addr;
1049         if (addr + len <= DEFAULT_MAP_WINDOW)
1050                 return addr;
1051         if (flags & MAP_FIXED)
1052                 return -ENOMEM;
1053
1054         /*
1055          * Requested len is larger than the whole area we're allowed to map in.
1056          * Resetting hinting address wouldn't do much good -- fail early.
1057          */
1058         if (len > DEFAULT_MAP_WINDOW)
1059                 return -ENOMEM;
1060
1061         /* Look for unmap area within DEFAULT_MAP_WINDOW */
1062         return 0;
1063 }