]> Pileus Git - ~andy/linux/blob - arch/x86/mm/pat.c
x86: track memtype for RAM in page struct
[~andy/linux] / arch / x86 / mm / pat.c
1 /*
2  * Handle caching attributes in page tables (PAT)
3  *
4  * Authors: Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
5  *          Suresh B Siddha <suresh.b.siddha@intel.com>
6  *
7  * Loosely based on earlier PAT patchset from Eric Biederman and Andi Kleen.
8  */
9
10 #include <linux/mm.h>
11 #include <linux/kernel.h>
12 #include <linux/gfp.h>
13 #include <linux/fs.h>
14 #include <linux/bootmem.h>
15 #include <linux/debugfs.h>
16 #include <linux/seq_file.h>
17
18 #include <asm/msr.h>
19 #include <asm/tlbflush.h>
20 #include <asm/processor.h>
21 #include <asm/page.h>
22 #include <asm/pgtable.h>
23 #include <asm/pat.h>
24 #include <asm/e820.h>
25 #include <asm/cacheflush.h>
26 #include <asm/fcntl.h>
27 #include <asm/mtrr.h>
28 #include <asm/io.h>
29
30 #ifdef CONFIG_X86_PAT
31 int __read_mostly pat_enabled = 1;
32
33 void __cpuinit pat_disable(char *reason)
34 {
35         pat_enabled = 0;
36         printk(KERN_INFO "%s\n", reason);
37 }
38
39 static int __init nopat(char *str)
40 {
41         pat_disable("PAT support disabled.");
42         return 0;
43 }
44 early_param("nopat", nopat);
45 #endif
46
47
48 static int debug_enable;
49 static int __init pat_debug_setup(char *str)
50 {
51         debug_enable = 1;
52         return 0;
53 }
54 __setup("debugpat", pat_debug_setup);
55
56 #define dprintk(fmt, arg...) \
57         do { if (debug_enable) printk(KERN_INFO fmt, ##arg); } while (0)
58
59
60 static u64 __read_mostly boot_pat_state;
61
62 enum {
63         PAT_UC = 0,             /* uncached */
64         PAT_WC = 1,             /* Write combining */
65         PAT_WT = 4,             /* Write Through */
66         PAT_WP = 5,             /* Write Protected */
67         PAT_WB = 6,             /* Write Back (default) */
68         PAT_UC_MINUS = 7,       /* UC, but can be overriden by MTRR */
69 };
70
71 #define PAT(x, y)       ((u64)PAT_ ## y << ((x)*8))
72
73 void pat_init(void)
74 {
75         u64 pat;
76
77         if (!pat_enabled)
78                 return;
79
80         /* Paranoia check. */
81         if (!cpu_has_pat && boot_pat_state) {
82                 /*
83                  * If this happens we are on a secondary CPU, but
84                  * switched to PAT on the boot CPU. We have no way to
85                  * undo PAT.
86                  */
87                 printk(KERN_ERR "PAT enabled, "
88                        "but not supported by secondary CPU\n");
89                 BUG();
90         }
91
92         /* Set PWT to Write-Combining. All other bits stay the same */
93         /*
94          * PTE encoding used in Linux:
95          *      PAT
96          *      |PCD
97          *      ||PWT
98          *      |||
99          *      000 WB          _PAGE_CACHE_WB
100          *      001 WC          _PAGE_CACHE_WC
101          *      010 UC-         _PAGE_CACHE_UC_MINUS
102          *      011 UC          _PAGE_CACHE_UC
103          * PAT bit unused
104          */
105         pat = PAT(0, WB) | PAT(1, WC) | PAT(2, UC_MINUS) | PAT(3, UC) |
106               PAT(4, WB) | PAT(5, WC) | PAT(6, UC_MINUS) | PAT(7, UC);
107
108         /* Boot CPU check */
109         if (!boot_pat_state)
110                 rdmsrl(MSR_IA32_CR_PAT, boot_pat_state);
111
112         wrmsrl(MSR_IA32_CR_PAT, pat);
113         printk(KERN_INFO "x86 PAT enabled: cpu %d, old 0x%Lx, new 0x%Lx\n",
114                smp_processor_id(), boot_pat_state, pat);
115 }
116
117 #undef PAT
118
119 static char *cattr_name(unsigned long flags)
120 {
121         switch (flags & _PAGE_CACHE_MASK) {
122         case _PAGE_CACHE_UC:            return "uncached";
123         case _PAGE_CACHE_UC_MINUS:      return "uncached-minus";
124         case _PAGE_CACHE_WB:            return "write-back";
125         case _PAGE_CACHE_WC:            return "write-combining";
126         default:                        return "broken";
127         }
128 }
129
130 /*
131  * The global memtype list keeps track of memory type for specific
132  * physical memory areas. Conflicting memory types in different
133  * mappings can cause CPU cache corruption. To avoid this we keep track.
134  *
135  * The list is sorted based on starting address and can contain multiple
136  * entries for each address (this allows reference counting for overlapping
137  * areas). All the aliases have the same cache attributes of course.
138  * Zero attributes are represented as holes.
139  *
140  * Currently the data structure is a list because the number of mappings
141  * are expected to be relatively small. If this should be a problem
142  * it could be changed to a rbtree or similar.
143  *
144  * memtype_lock protects the whole list.
145  */
146
147 struct memtype {
148         u64 start;
149         u64 end;
150         unsigned long type;
151         struct list_head nd;
152 };
153
154 static LIST_HEAD(memtype_list);
155 static DEFINE_SPINLOCK(memtype_lock);   /* protects memtype list */
156
157 /*
158  * Does intersection of PAT memory type and MTRR memory type and returns
159  * the resulting memory type as PAT understands it.
160  * (Type in pat and mtrr will not have same value)
161  * The intersection is based on "Effective Memory Type" tables in IA-32
162  * SDM vol 3a
163  */
164 static unsigned long pat_x_mtrr_type(u64 start, u64 end, unsigned long req_type)
165 {
166         /*
167          * Look for MTRR hint to get the effective type in case where PAT
168          * request is for WB.
169          */
170         if (req_type == _PAGE_CACHE_WB) {
171                 u8 mtrr_type;
172
173                 mtrr_type = mtrr_type_lookup(start, end);
174                 if (mtrr_type == MTRR_TYPE_UNCACHABLE)
175                         return _PAGE_CACHE_UC;
176                 if (mtrr_type == MTRR_TYPE_WRCOMB)
177                         return _PAGE_CACHE_WC;
178         }
179
180         return req_type;
181 }
182
183 static int chk_conflict(struct memtype *new, struct memtype *entry,
184                         unsigned long *type)
185 {
186         if (new->type != entry->type) {
187                 if (type) {
188                         new->type = entry->type;
189                         *type = entry->type;
190                 } else
191                         goto conflict;
192         }
193
194          /* check overlaps with more than one entry in the list */
195         list_for_each_entry_continue(entry, &memtype_list, nd) {
196                 if (new->end <= entry->start)
197                         break;
198                 else if (new->type != entry->type)
199                         goto conflict;
200         }
201         return 0;
202
203  conflict:
204         printk(KERN_INFO "%s:%d conflicting memory types "
205                "%Lx-%Lx %s<->%s\n", current->comm, current->pid, new->start,
206                new->end, cattr_name(new->type), cattr_name(entry->type));
207         return -EBUSY;
208 }
209
210 static struct memtype *cached_entry;
211 static u64 cached_start;
212
213 /*
214  * RED-PEN:  TODO: Add PageReserved() check as well here,
215  * once we add SetPageReserved() to all the drivers using
216  * set_memory_* or set_pages_*.
217  *
218  * This will help prevent accidentally freeing pages
219  * before setting the attribute back to WB.
220  */
221
222 /*
223  * For RAM pages, mark the pages as non WB memory type using
224  * PageNonWB (PG_arch_1). We allow only one set_memory_uc() or
225  * set_memory_wc() on a RAM page at a time before marking it as WB again.
226  * This is ok, because only one driver will be owning the page and
227  * doing set_memory_*() calls.
228  *
229  * For now, we use PageNonWB to track that the RAM page is being mapped
230  * as non WB. In future, we will have to use one more flag
231  * (or some other mechanism in page_struct) to distinguish between
232  * UC and WC mapping.
233  */
234 static int reserve_ram_pages_type(u64 start, u64 end, unsigned long req_type,
235                        unsigned long *new_type)
236 {
237         struct page *page;
238         u64 pfn, end_pfn;
239
240         for (pfn = (start >> PAGE_SHIFT); pfn < (end >> PAGE_SHIFT); ++pfn) {
241                 page = pfn_to_page(pfn);
242                 if (page_mapped(page) || PageNonWB(page))
243                         goto out;
244
245                 SetPageNonWB(page);
246         }
247         return 0;
248
249 out:
250         end_pfn = pfn;
251         for (pfn = (start >> PAGE_SHIFT); pfn < end_pfn; ++pfn) {
252                 page = pfn_to_page(pfn);
253                 ClearPageNonWB(page);
254         }
255
256         return -EINVAL;
257 }
258
259 static int free_ram_pages_type(u64 start, u64 end)
260 {
261         struct page *page;
262         u64 pfn, end_pfn;
263
264         for (pfn = (start >> PAGE_SHIFT); pfn < (end >> PAGE_SHIFT); ++pfn) {
265                 page = pfn_to_page(pfn);
266                 if (page_mapped(page) || !PageNonWB(page))
267                         goto out;
268
269                 ClearPageNonWB(page);
270         }
271         return 0;
272
273 out:
274         end_pfn = pfn;
275         for (pfn = (start >> PAGE_SHIFT); pfn < end_pfn; ++pfn) {
276                 page = pfn_to_page(pfn);
277                 SetPageNonWB(page);
278         }
279         return -EINVAL;
280 }
281
282 /*
283  * req_type typically has one of the:
284  * - _PAGE_CACHE_WB
285  * - _PAGE_CACHE_WC
286  * - _PAGE_CACHE_UC_MINUS
287  * - _PAGE_CACHE_UC
288  *
289  * req_type will have a special case value '-1', when requester want to inherit
290  * the memory type from mtrr (if WB), existing PAT, defaulting to UC_MINUS.
291  *
292  * If new_type is NULL, function will return an error if it cannot reserve the
293  * region with req_type. If new_type is non-NULL, function will return
294  * available type in new_type in case of no error. In case of any error
295  * it will return a negative return value.
296  */
297 int reserve_memtype(u64 start, u64 end, unsigned long req_type,
298                         unsigned long *new_type)
299 {
300         struct memtype *new, *entry;
301         unsigned long actual_type;
302         struct list_head *where;
303         int err = 0;
304         int is_range_ram;
305
306         BUG_ON(start >= end); /* end is exclusive */
307
308         if (!pat_enabled) {
309                 /* This is identical to page table setting without PAT */
310                 if (new_type) {
311                         if (req_type == -1)
312                                 *new_type = _PAGE_CACHE_WB;
313                         else
314                                 *new_type = req_type & _PAGE_CACHE_MASK;
315                 }
316                 return 0;
317         }
318
319         /* Low ISA region is always mapped WB in page table. No need to track */
320         if (is_ISA_range(start, end - 1)) {
321                 if (new_type)
322                         *new_type = _PAGE_CACHE_WB;
323                 return 0;
324         }
325
326         if (req_type == -1) {
327                 /*
328                  * Call mtrr_lookup to get the type hint. This is an
329                  * optimization for /dev/mem mmap'ers into WB memory (BIOS
330                  * tools and ACPI tools). Use WB request for WB memory and use
331                  * UC_MINUS otherwise.
332                  */
333                 u8 mtrr_type = mtrr_type_lookup(start, end);
334
335                 if (mtrr_type == MTRR_TYPE_WRBACK)
336                         actual_type = _PAGE_CACHE_WB;
337                 else
338                         actual_type = _PAGE_CACHE_UC_MINUS;
339         } else
340                 actual_type = pat_x_mtrr_type(start, end,
341                                               req_type & _PAGE_CACHE_MASK);
342
343         is_range_ram = pagerange_is_ram(start, end);
344         if (is_range_ram == 1)
345                 return reserve_ram_pages_type(start, end, req_type, new_type);
346         else if (is_range_ram < 0)
347                 return -EINVAL;
348
349         new  = kmalloc(sizeof(struct memtype), GFP_KERNEL);
350         if (!new)
351                 return -ENOMEM;
352
353         new->start = start;
354         new->end = end;
355         new->type = actual_type;
356
357         if (new_type)
358                 *new_type = actual_type;
359
360         spin_lock(&memtype_lock);
361
362         if (cached_entry && start >= cached_start)
363                 entry = cached_entry;
364         else
365                 entry = list_entry(&memtype_list, struct memtype, nd);
366
367         /* Search for existing mapping that overlaps the current range */
368         where = NULL;
369         list_for_each_entry_continue(entry, &memtype_list, nd) {
370                 if (end <= entry->start) {
371                         where = entry->nd.prev;
372                         cached_entry = list_entry(where, struct memtype, nd);
373                         break;
374                 } else if (start <= entry->start) { /* end > entry->start */
375                         err = chk_conflict(new, entry, new_type);
376                         if (!err) {
377                                 dprintk("Overlap at 0x%Lx-0x%Lx\n",
378                                         entry->start, entry->end);
379                                 where = entry->nd.prev;
380                                 cached_entry = list_entry(where,
381                                                         struct memtype, nd);
382                         }
383                         break;
384                 } else if (start < entry->end) { /* start > entry->start */
385                         err = chk_conflict(new, entry, new_type);
386                         if (!err) {
387                                 dprintk("Overlap at 0x%Lx-0x%Lx\n",
388                                         entry->start, entry->end);
389                                 cached_entry = list_entry(entry->nd.prev,
390                                                         struct memtype, nd);
391
392                                 /*
393                                  * Move to right position in the linked
394                                  * list to add this new entry
395                                  */
396                                 list_for_each_entry_continue(entry,
397                                                         &memtype_list, nd) {
398                                         if (start <= entry->start) {
399                                                 where = entry->nd.prev;
400                                                 break;
401                                         }
402                                 }
403                         }
404                         break;
405                 }
406         }
407
408         if (err) {
409                 printk(KERN_INFO "reserve_memtype failed 0x%Lx-0x%Lx, "
410                        "track %s, req %s\n",
411                        start, end, cattr_name(new->type), cattr_name(req_type));
412                 kfree(new);
413                 spin_unlock(&memtype_lock);
414                 return err;
415         }
416
417         cached_start = start;
418
419         if (where)
420                 list_add(&new->nd, where);
421         else
422                 list_add_tail(&new->nd, &memtype_list);
423
424         spin_unlock(&memtype_lock);
425
426         dprintk("reserve_memtype added 0x%Lx-0x%Lx, track %s, req %s, ret %s\n",
427                 start, end, cattr_name(new->type), cattr_name(req_type),
428                 new_type ? cattr_name(*new_type) : "-");
429
430         return err;
431 }
432
433 int free_memtype(u64 start, u64 end)
434 {
435         struct memtype *entry;
436         int err = -EINVAL;
437         int is_range_ram;
438
439         if (!pat_enabled)
440                 return 0;
441
442         /* Low ISA region is always mapped WB. No need to track */
443         if (is_ISA_range(start, end - 1))
444                 return 0;
445
446         is_range_ram = pagerange_is_ram(start, end);
447         if (is_range_ram == 1)
448                 return free_ram_pages_type(start, end);
449         else if (is_range_ram < 0)
450                 return -EINVAL;
451
452         spin_lock(&memtype_lock);
453         list_for_each_entry(entry, &memtype_list, nd) {
454                 if (entry->start == start && entry->end == end) {
455                         if (cached_entry == entry || cached_start == start)
456                                 cached_entry = NULL;
457
458                         list_del(&entry->nd);
459                         kfree(entry);
460                         err = 0;
461                         break;
462                 }
463         }
464         spin_unlock(&memtype_lock);
465
466         if (err) {
467                 printk(KERN_INFO "%s:%d freeing invalid memtype %Lx-%Lx\n",
468                         current->comm, current->pid, start, end);
469         }
470
471         dprintk("free_memtype request 0x%Lx-0x%Lx\n", start, end);
472         return err;
473 }
474
475
476 pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
477                                 unsigned long size, pgprot_t vma_prot)
478 {
479         return vma_prot;
480 }
481
482 #ifdef CONFIG_STRICT_DEVMEM
483 /* This check is done in drivers/char/mem.c in case of STRICT_DEVMEM*/
484 static inline int range_is_allowed(unsigned long pfn, unsigned long size)
485 {
486         return 1;
487 }
488 #else
489 static inline int range_is_allowed(unsigned long pfn, unsigned long size)
490 {
491         u64 from = ((u64)pfn) << PAGE_SHIFT;
492         u64 to = from + size;
493         u64 cursor = from;
494
495         while (cursor < to) {
496                 if (!devmem_is_allowed(pfn)) {
497                         printk(KERN_INFO
498                 "Program %s tried to access /dev/mem between %Lx->%Lx.\n",
499                                 current->comm, from, to);
500                         return 0;
501                 }
502                 cursor += PAGE_SIZE;
503                 pfn++;
504         }
505         return 1;
506 }
507 #endif /* CONFIG_STRICT_DEVMEM */
508
509 int phys_mem_access_prot_allowed(struct file *file, unsigned long pfn,
510                                 unsigned long size, pgprot_t *vma_prot)
511 {
512         u64 offset = ((u64) pfn) << PAGE_SHIFT;
513         unsigned long flags = -1;
514         int retval;
515
516         if (!range_is_allowed(pfn, size))
517                 return 0;
518
519         if (file->f_flags & O_SYNC) {
520                 flags = _PAGE_CACHE_UC_MINUS;
521         }
522
523 #ifdef CONFIG_X86_32
524         /*
525          * On the PPro and successors, the MTRRs are used to set
526          * memory types for physical addresses outside main memory,
527          * so blindly setting UC or PWT on those pages is wrong.
528          * For Pentiums and earlier, the surround logic should disable
529          * caching for the high addresses through the KEN pin, but
530          * we maintain the tradition of paranoia in this code.
531          */
532         if (!pat_enabled &&
533             !(boot_cpu_has(X86_FEATURE_MTRR) ||
534               boot_cpu_has(X86_FEATURE_K6_MTRR) ||
535               boot_cpu_has(X86_FEATURE_CYRIX_ARR) ||
536               boot_cpu_has(X86_FEATURE_CENTAUR_MCR)) &&
537             (pfn << PAGE_SHIFT) >= __pa(high_memory)) {
538                 flags = _PAGE_CACHE_UC;
539         }
540 #endif
541
542         /*
543          * With O_SYNC, we can only take UC_MINUS mapping. Fail if we cannot.
544          *
545          * Without O_SYNC, we want to get
546          * - WB for WB-able memory and no other conflicting mappings
547          * - UC_MINUS for non-WB-able memory with no other conflicting mappings
548          * - Inherit from confliting mappings otherwise
549          */
550         if (flags != -1) {
551                 retval = reserve_memtype(offset, offset + size, flags, NULL);
552         } else {
553                 retval = reserve_memtype(offset, offset + size, -1, &flags);
554         }
555
556         if (retval < 0)
557                 return 0;
558
559         if (((pfn < max_low_pfn_mapped) ||
560              (pfn >= (1UL<<(32 - PAGE_SHIFT)) && pfn < max_pfn_mapped)) &&
561             ioremap_change_attr((unsigned long)__va(offset), size, flags) < 0) {
562                 free_memtype(offset, offset + size);
563                 printk(KERN_INFO
564                 "%s:%d /dev/mem ioremap_change_attr failed %s for %Lx-%Lx\n",
565                         current->comm, current->pid,
566                         cattr_name(flags),
567                         offset, (unsigned long long)(offset + size));
568                 return 0;
569         }
570
571         *vma_prot = __pgprot((pgprot_val(*vma_prot) & ~_PAGE_CACHE_MASK) |
572                              flags);
573         return 1;
574 }
575
576 void map_devmem(unsigned long pfn, unsigned long size, pgprot_t vma_prot)
577 {
578         u64 addr = (u64)pfn << PAGE_SHIFT;
579         unsigned long flags;
580         unsigned long want_flags = (pgprot_val(vma_prot) & _PAGE_CACHE_MASK);
581
582         reserve_memtype(addr, addr + size, want_flags, &flags);
583         if (flags != want_flags) {
584                 printk(KERN_INFO
585                 "%s:%d /dev/mem expected mapping type %s for %Lx-%Lx, got %s\n",
586                         current->comm, current->pid,
587                         cattr_name(want_flags),
588                         addr, (unsigned long long)(addr + size),
589                         cattr_name(flags));
590         }
591 }
592
593 void unmap_devmem(unsigned long pfn, unsigned long size, pgprot_t vma_prot)
594 {
595         u64 addr = (u64)pfn << PAGE_SHIFT;
596
597         free_memtype(addr, addr + size);
598 }
599
600 #if defined(CONFIG_DEBUG_FS) && defined(CONFIG_X86_PAT)
601
602 /* get Nth element of the linked list */
603 static struct memtype *memtype_get_idx(loff_t pos)
604 {
605         struct memtype *list_node, *print_entry;
606         int i = 1;
607
608         print_entry  = kmalloc(sizeof(struct memtype), GFP_KERNEL);
609         if (!print_entry)
610                 return NULL;
611
612         spin_lock(&memtype_lock);
613         list_for_each_entry(list_node, &memtype_list, nd) {
614                 if (pos == i) {
615                         *print_entry = *list_node;
616                         spin_unlock(&memtype_lock);
617                         return print_entry;
618                 }
619                 ++i;
620         }
621         spin_unlock(&memtype_lock);
622         kfree(print_entry);
623         return NULL;
624 }
625
626 static void *memtype_seq_start(struct seq_file *seq, loff_t *pos)
627 {
628         if (*pos == 0) {
629                 ++*pos;
630                 seq_printf(seq, "PAT memtype list:\n");
631         }
632
633         return memtype_get_idx(*pos);
634 }
635
636 static void *memtype_seq_next(struct seq_file *seq, void *v, loff_t *pos)
637 {
638         ++*pos;
639         return memtype_get_idx(*pos);
640 }
641
642 static void memtype_seq_stop(struct seq_file *seq, void *v)
643 {
644 }
645
646 static int memtype_seq_show(struct seq_file *seq, void *v)
647 {
648         struct memtype *print_entry = (struct memtype *)v;
649
650         seq_printf(seq, "%s @ 0x%Lx-0x%Lx\n", cattr_name(print_entry->type),
651                         print_entry->start, print_entry->end);
652         kfree(print_entry);
653         return 0;
654 }
655
656 static struct seq_operations memtype_seq_ops = {
657         .start = memtype_seq_start,
658         .next  = memtype_seq_next,
659         .stop  = memtype_seq_stop,
660         .show  = memtype_seq_show,
661 };
662
663 static int memtype_seq_open(struct inode *inode, struct file *file)
664 {
665         return seq_open(file, &memtype_seq_ops);
666 }
667
668 static const struct file_operations memtype_fops = {
669         .open    = memtype_seq_open,
670         .read    = seq_read,
671         .llseek  = seq_lseek,
672         .release = seq_release,
673 };
674
675 static int __init pat_memtype_list_init(void)
676 {
677         debugfs_create_file("pat_memtype_list", S_IRUSR, arch_debugfs_dir,
678                                 NULL, &memtype_fops);
679         return 0;
680 }
681
682 late_initcall(pat_memtype_list_init);
683
684 #endif /* CONFIG_DEBUG_FS && CONFIG_X86_PAT */