81fb75344cd3e3f2353904b44a95ea73d0167da4
[linux-2.6.git] / 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/seq_file.h>
11 #include <linux/bootmem.h>
12 #include <linux/debugfs.h>
13 #include <linux/kernel.h>
14 #include <linux/module.h>
15 #include <linux/gfp.h>
16 #include <linux/mm.h>
17 #include <linux/fs.h>
18 #include <linux/rbtree.h>
19
20 #include <asm/cacheflush.h>
21 #include <asm/processor.h>
22 #include <asm/tlbflush.h>
23 #include <asm/pgtable.h>
24 #include <asm/fcntl.h>
25 #include <asm/e820.h>
26 #include <asm/mtrr.h>
27 #include <asm/page.h>
28 #include <asm/msr.h>
29 #include <asm/pat.h>
30 #include <asm/io.h>
31
32 #ifdef CONFIG_X86_PAT
33 int __read_mostly pat_enabled = 1;
34
35 static inline void pat_disable(const char *reason)
36 {
37         pat_enabled = 0;
38         printk(KERN_INFO "%s\n", reason);
39 }
40
41 static int __init nopat(char *str)
42 {
43         pat_disable("PAT support disabled.");
44         return 0;
45 }
46 early_param("nopat", nopat);
47 #else
48 static inline void pat_disable(const char *reason)
49 {
50         (void)reason;
51 }
52 #endif
53
54
55 static int debug_enable;
56
57 static int __init pat_debug_setup(char *str)
58 {
59         debug_enable = 1;
60         return 0;
61 }
62 __setup("debugpat", pat_debug_setup);
63
64 #define dprintk(fmt, arg...) \
65         do { if (debug_enable) printk(KERN_INFO fmt, ##arg); } while (0)
66
67
68 static u64 __read_mostly boot_pat_state;
69
70 enum {
71         PAT_UC = 0,             /* uncached */
72         PAT_WC = 1,             /* Write combining */
73         PAT_WT = 4,             /* Write Through */
74         PAT_WP = 5,             /* Write Protected */
75         PAT_WB = 6,             /* Write Back (default) */
76         PAT_UC_MINUS = 7,       /* UC, but can be overriden by MTRR */
77 };
78
79 #define PAT(x, y)       ((u64)PAT_ ## y << ((x)*8))
80
81 void pat_init(void)
82 {
83         u64 pat;
84         bool boot_cpu = !boot_pat_state;
85
86         if (!pat_enabled)
87                 return;
88
89         if (!cpu_has_pat) {
90                 if (!boot_pat_state) {
91                         pat_disable("PAT not supported by CPU.");
92                         return;
93                 } else {
94                         /*
95                          * If this happens we are on a secondary CPU, but
96                          * switched to PAT on the boot CPU. We have no way to
97                          * undo PAT.
98                          */
99                         printk(KERN_ERR "PAT enabled, "
100                                "but not supported by secondary CPU\n");
101                         BUG();
102                 }
103         }
104
105         /* Set PWT to Write-Combining. All other bits stay the same */
106         /*
107          * PTE encoding used in Linux:
108          *      PAT
109          *      |PCD
110          *      ||PWT
111          *      |||
112          *      000 WB          _PAGE_CACHE_WB
113          *      001 WC          _PAGE_CACHE_WC
114          *      010 UC-         _PAGE_CACHE_UC_MINUS
115          *      011 UC          _PAGE_CACHE_UC
116          * PAT bit unused
117          */
118         pat = PAT(0, WB) | PAT(1, WC) | PAT(2, UC_MINUS) | PAT(3, UC) |
119               PAT(4, WB) | PAT(5, WC) | PAT(6, UC_MINUS) | PAT(7, UC);
120
121         /* Boot CPU check */
122         if (!boot_pat_state)
123                 rdmsrl(MSR_IA32_CR_PAT, boot_pat_state);
124
125         wrmsrl(MSR_IA32_CR_PAT, pat);
126
127         if (boot_cpu)
128                 printk(KERN_INFO "x86 PAT enabled: cpu %d, old 0x%Lx, new 0x%Lx\n",
129                        smp_processor_id(), boot_pat_state, pat);
130 }
131
132 #undef PAT
133
134 static char *cattr_name(unsigned long flags)
135 {
136         switch (flags & _PAGE_CACHE_MASK) {
137         case _PAGE_CACHE_UC:            return "uncached";
138         case _PAGE_CACHE_UC_MINUS:      return "uncached-minus";
139         case _PAGE_CACHE_WB:            return "write-back";
140         case _PAGE_CACHE_WC:            return "write-combining";
141         default:                        return "broken";
142         }
143 }
144
145 /*
146  * The global memtype list keeps track of memory type for specific
147  * physical memory areas. Conflicting memory types in different
148  * mappings can cause CPU cache corruption. To avoid this we keep track.
149  *
150  * The list is sorted based on starting address and can contain multiple
151  * entries for each address (this allows reference counting for overlapping
152  * areas). All the aliases have the same cache attributes of course.
153  * Zero attributes are represented as holes.
154  *
155  * The data structure is a list that is also organized as an rbtree
156  * sorted on the start address of memtype range.
157  *
158  * memtype_lock protects both the linear list and rbtree.
159  */
160
161 struct memtype {
162         u64                     start;
163         u64                     end;
164         unsigned long           type;
165         struct list_head        nd;
166         struct rb_node          rb;
167 };
168
169 static struct rb_root memtype_rbroot = RB_ROOT;
170 static LIST_HEAD(memtype_list);
171 static DEFINE_SPINLOCK(memtype_lock);   /* protects memtype list */
172
173 static struct memtype *memtype_rb_search(struct rb_root *root, u64 start)
174 {
175         struct rb_node *node = root->rb_node;
176         struct memtype *last_lower = NULL;
177
178         while (node) {
179                 struct memtype *data = container_of(node, struct memtype, rb);
180
181                 if (data->start < start) {
182                         last_lower = data;
183                         node = node->rb_right;
184                 } else if (data->start > start) {
185                         node = node->rb_left;
186                 } else
187                         return data;
188         }
189
190         /* Will return NULL if there is no entry with its start <= start */
191         return last_lower;
192 }
193
194 static void memtype_rb_insert(struct rb_root *root, struct memtype *data)
195 {
196         struct rb_node **new = &(root->rb_node);
197         struct rb_node *parent = NULL;
198
199         while (*new) {
200                 struct memtype *this = container_of(*new, struct memtype, rb);
201
202                 parent = *new;
203                 if (data->start <= this->start)
204                         new = &((*new)->rb_left);
205                 else if (data->start > this->start)
206                         new = &((*new)->rb_right);
207         }
208
209         rb_link_node(&data->rb, parent, new);
210         rb_insert_color(&data->rb, root);
211 }
212
213 /*
214  * Does intersection of PAT memory type and MTRR memory type and returns
215  * the resulting memory type as PAT understands it.
216  * (Type in pat and mtrr will not have same value)
217  * The intersection is based on "Effective Memory Type" tables in IA-32
218  * SDM vol 3a
219  */
220 static unsigned long pat_x_mtrr_type(u64 start, u64 end, unsigned long req_type)
221 {
222         /*
223          * Look for MTRR hint to get the effective type in case where PAT
224          * request is for WB.
225          */
226         if (req_type == _PAGE_CACHE_WB) {
227                 u8 mtrr_type;
228
229                 mtrr_type = mtrr_type_lookup(start, end);
230                 if (mtrr_type != MTRR_TYPE_WRBACK)
231                         return _PAGE_CACHE_UC_MINUS;
232
233                 return _PAGE_CACHE_WB;
234         }
235
236         return req_type;
237 }
238
239 static int
240 chk_conflict(struct memtype *new, struct memtype *entry, unsigned long *type)
241 {
242         if (new->type != entry->type) {
243                 if (type) {
244                         new->type = entry->type;
245                         *type = entry->type;
246                 } else
247                         goto conflict;
248         }
249
250          /* check overlaps with more than one entry in the list */
251         list_for_each_entry_continue(entry, &memtype_list, nd) {
252                 if (new->end <= entry->start)
253                         break;
254                 else if (new->type != entry->type)
255                         goto conflict;
256         }
257         return 0;
258
259  conflict:
260         printk(KERN_INFO "%s:%d conflicting memory types "
261                "%Lx-%Lx %s<->%s\n", current->comm, current->pid, new->start,
262                new->end, cattr_name(new->type), cattr_name(entry->type));
263         return -EBUSY;
264 }
265
266 static int pat_pagerange_is_ram(unsigned long start, unsigned long end)
267 {
268         int ram_page = 0, not_rampage = 0;
269         unsigned long page_nr;
270
271         for (page_nr = (start >> PAGE_SHIFT); page_nr < (end >> PAGE_SHIFT);
272              ++page_nr) {
273                 /*
274                  * For legacy reasons, physical address range in the legacy ISA
275                  * region is tracked as non-RAM. This will allow users of
276                  * /dev/mem to map portions of legacy ISA region, even when
277                  * some of those portions are listed(or not even listed) with
278                  * different e820 types(RAM/reserved/..)
279                  */
280                 if (page_nr >= (ISA_END_ADDRESS >> PAGE_SHIFT) &&
281                     page_is_ram(page_nr))
282                         ram_page = 1;
283                 else
284                         not_rampage = 1;
285
286                 if (ram_page == not_rampage)
287                         return -1;
288         }
289
290         return ram_page;
291 }
292
293 /*
294  * For RAM pages, we use page flags to mark the pages with appropriate type.
295  * Here we do two pass:
296  * - Find the memtype of all the pages in the range, look for any conflicts
297  * - In case of no conflicts, set the new memtype for pages in the range
298  *
299  * Caller must hold memtype_lock for atomicity.
300  */
301 static int reserve_ram_pages_type(u64 start, u64 end, unsigned long req_type,
302                                   unsigned long *new_type)
303 {
304         struct page *page;
305         u64 pfn;
306
307         if (req_type == _PAGE_CACHE_UC) {
308                 /* We do not support strong UC */
309                 WARN_ON_ONCE(1);
310                 req_type = _PAGE_CACHE_UC_MINUS;
311         }
312
313         for (pfn = (start >> PAGE_SHIFT); pfn < (end >> PAGE_SHIFT); ++pfn) {
314                 unsigned long type;
315
316                 page = pfn_to_page(pfn);
317                 type = get_page_memtype(page);
318                 if (type != -1) {
319                         printk(KERN_INFO "reserve_ram_pages_type failed "
320                                 "0x%Lx-0x%Lx, track 0x%lx, req 0x%lx\n",
321                                 start, end, type, req_type);
322                         if (new_type)
323                                 *new_type = type;
324
325                         return -EBUSY;
326                 }
327         }
328
329         if (new_type)
330                 *new_type = req_type;
331
332         for (pfn = (start >> PAGE_SHIFT); pfn < (end >> PAGE_SHIFT); ++pfn) {
333                 page = pfn_to_page(pfn);
334                 set_page_memtype(page, req_type);
335         }
336         return 0;
337 }
338
339 static int free_ram_pages_type(u64 start, u64 end)
340 {
341         struct page *page;
342         u64 pfn;
343
344         for (pfn = (start >> PAGE_SHIFT); pfn < (end >> PAGE_SHIFT); ++pfn) {
345                 page = pfn_to_page(pfn);
346                 set_page_memtype(page, -1);
347         }
348         return 0;
349 }
350
351 /*
352  * req_type typically has one of the:
353  * - _PAGE_CACHE_WB
354  * - _PAGE_CACHE_WC
355  * - _PAGE_CACHE_UC_MINUS
356  * - _PAGE_CACHE_UC
357  *
358  * If new_type is NULL, function will return an error if it cannot reserve the
359  * region with req_type. If new_type is non-NULL, function will return
360  * available type in new_type in case of no error. In case of any error
361  * it will return a negative return value.
362  */
363 int reserve_memtype(u64 start, u64 end, unsigned long req_type,
364                     unsigned long *new_type)
365 {
366         struct memtype *new, *entry;
367         unsigned long actual_type;
368         struct list_head *where;
369         int is_range_ram;
370         int err = 0;
371
372         BUG_ON(start >= end); /* end is exclusive */
373
374         if (!pat_enabled) {
375                 /* This is identical to page table setting without PAT */
376                 if (new_type) {
377                         if (req_type == _PAGE_CACHE_WC)
378                                 *new_type = _PAGE_CACHE_UC_MINUS;
379                         else
380                                 *new_type = req_type & _PAGE_CACHE_MASK;
381                 }
382                 return 0;
383         }
384
385         /* Low ISA region is always mapped WB in page table. No need to track */
386         if (is_ISA_range(start, end - 1)) {
387                 if (new_type)
388                         *new_type = _PAGE_CACHE_WB;
389                 return 0;
390         }
391
392         /*
393          * Call mtrr_lookup to get the type hint. This is an
394          * optimization for /dev/mem mmap'ers into WB memory (BIOS
395          * tools and ACPI tools). Use WB request for WB memory and use
396          * UC_MINUS otherwise.
397          */
398         actual_type = pat_x_mtrr_type(start, end, req_type & _PAGE_CACHE_MASK);
399
400         if (new_type)
401                 *new_type = actual_type;
402
403         is_range_ram = pat_pagerange_is_ram(start, end);
404         if (is_range_ram == 1) {
405
406                 spin_lock(&memtype_lock);
407                 err = reserve_ram_pages_type(start, end, req_type, new_type);
408                 spin_unlock(&memtype_lock);
409
410                 return err;
411         } else if (is_range_ram < 0) {
412                 return -EINVAL;
413         }
414
415         new  = kmalloc(sizeof(struct memtype), GFP_KERNEL);
416         if (!new)
417                 return -ENOMEM;
418
419         new->start      = start;
420         new->end        = end;
421         new->type       = actual_type;
422
423         spin_lock(&memtype_lock);
424
425         /* Search for existing mapping that overlaps the current range */
426         where = NULL;
427         list_for_each_entry(entry, &memtype_list, nd) {
428                 if (end <= entry->start) {
429                         where = entry->nd.prev;
430                         break;
431                 } else if (start <= entry->start) { /* end > entry->start */
432                         err = chk_conflict(new, entry, new_type);
433                         if (!err) {
434                                 dprintk("Overlap at 0x%Lx-0x%Lx\n",
435                                         entry->start, entry->end);
436                                 where = entry->nd.prev;
437                         }
438                         break;
439                 } else if (start < entry->end) { /* start > entry->start */
440                         err = chk_conflict(new, entry, new_type);
441                         if (!err) {
442                                 dprintk("Overlap at 0x%Lx-0x%Lx\n",
443                                         entry->start, entry->end);
444
445                                 /*
446                                  * Move to right position in the linked
447                                  * list to add this new entry
448                                  */
449                                 list_for_each_entry_continue(entry,
450                                                         &memtype_list, nd) {
451                                         if (start <= entry->start) {
452                                                 where = entry->nd.prev;
453                                                 break;
454                                         }
455                                 }
456                         }
457                         break;
458                 }
459         }
460
461         if (err) {
462                 printk(KERN_INFO "reserve_memtype failed 0x%Lx-0x%Lx, "
463                        "track %s, req %s\n",
464                        start, end, cattr_name(new->type), cattr_name(req_type));
465                 kfree(new);
466                 spin_unlock(&memtype_lock);
467
468                 return err;
469         }
470
471         if (where)
472                 list_add(&new->nd, where);
473         else
474                 list_add_tail(&new->nd, &memtype_list);
475
476         memtype_rb_insert(&memtype_rbroot, new);
477
478         spin_unlock(&memtype_lock);
479
480         dprintk("reserve_memtype added 0x%Lx-0x%Lx, track %s, req %s, ret %s\n",
481                 start, end, cattr_name(new->type), cattr_name(req_type),
482                 new_type ? cattr_name(*new_type) : "-");
483
484         return err;
485 }
486
487 int free_memtype(u64 start, u64 end)
488 {
489         struct memtype *entry, *saved_entry;
490         int err = -EINVAL;
491         int is_range_ram;
492
493         if (!pat_enabled)
494                 return 0;
495
496         /* Low ISA region is always mapped WB. No need to track */
497         if (is_ISA_range(start, end - 1))
498                 return 0;
499
500         is_range_ram = pat_pagerange_is_ram(start, end);
501         if (is_range_ram == 1) {
502
503                 spin_lock(&memtype_lock);
504                 err = free_ram_pages_type(start, end);
505                 spin_unlock(&memtype_lock);
506
507                 return err;
508         } else if (is_range_ram < 0) {
509                 return -EINVAL;
510         }
511
512         spin_lock(&memtype_lock);
513
514         entry = memtype_rb_search(&memtype_rbroot, start);
515         if (unlikely(entry == NULL))
516                 goto unlock_ret;
517
518         /*
519          * Saved entry points to an entry with start same or less than what
520          * we searched for. Now go through the list in both directions to look
521          * for the entry that matches with both start and end, with list stored
522          * in sorted start address
523          */
524         saved_entry = entry;
525         list_for_each_entry_from(entry, &memtype_list, nd) {
526                 if (entry->start == start && entry->end == end) {
527                         rb_erase(&entry->rb, &memtype_rbroot);
528                         list_del(&entry->nd);
529                         kfree(entry);
530                         err = 0;
531                         break;
532                 } else if (entry->start > start) {
533                         break;
534                 }
535         }
536
537         if (!err)
538                 goto unlock_ret;
539
540         entry = saved_entry;
541         list_for_each_entry_reverse(entry, &memtype_list, nd) {
542                 if (entry->start == start && entry->end == end) {
543                         rb_erase(&entry->rb, &memtype_rbroot);
544                         list_del(&entry->nd);
545                         kfree(entry);
546                         err = 0;
547                         break;
548                 } else if (entry->start < start) {
549                         break;
550                 }
551         }
552 unlock_ret:
553         spin_unlock(&memtype_lock);
554
555         if (err) {
556                 printk(KERN_INFO "%s:%d freeing invalid memtype %Lx-%Lx\n",
557                         current->comm, current->pid, start, end);
558         }
559
560         dprintk("free_memtype request 0x%Lx-0x%Lx\n", start, end);
561
562         return err;
563 }
564
565
566 /**
567  * lookup_memtype - Looksup the memory type for a physical address
568  * @paddr: physical address of which memory type needs to be looked up
569  *
570  * Only to be called when PAT is enabled
571  *
572  * Returns _PAGE_CACHE_WB, _PAGE_CACHE_WC, _PAGE_CACHE_UC_MINUS or
573  * _PAGE_CACHE_UC
574  */
575 static unsigned long lookup_memtype(u64 paddr)
576 {
577         int rettype = _PAGE_CACHE_WB;
578         struct memtype *entry;
579
580         if (is_ISA_range(paddr, paddr + PAGE_SIZE - 1))
581                 return rettype;
582
583         if (pat_pagerange_is_ram(paddr, paddr + PAGE_SIZE)) {
584                 struct page *page;
585                 spin_lock(&memtype_lock);
586                 page = pfn_to_page(paddr >> PAGE_SHIFT);
587                 rettype = get_page_memtype(page);
588                 spin_unlock(&memtype_lock);
589                 /*
590                  * -1 from get_page_memtype() implies RAM page is in its
591                  * default state and not reserved, and hence of type WB
592                  */
593                 if (rettype == -1)
594                         rettype = _PAGE_CACHE_WB;
595
596                 return rettype;
597         }
598
599         spin_lock(&memtype_lock);
600
601         entry = memtype_rb_search(&memtype_rbroot, paddr);
602         if (entry != NULL)
603                 rettype = entry->type;
604         else
605                 rettype = _PAGE_CACHE_UC_MINUS;
606
607         spin_unlock(&memtype_lock);
608         return rettype;
609 }
610
611 /**
612  * io_reserve_memtype - Request a memory type mapping for a region of memory
613  * @start: start (physical address) of the region
614  * @end: end (physical address) of the region
615  * @type: A pointer to memtype, with requested type. On success, requested
616  * or any other compatible type that was available for the region is returned
617  *
618  * On success, returns 0
619  * On failure, returns non-zero
620  */
621 int io_reserve_memtype(resource_size_t start, resource_size_t end,
622                         unsigned long *type)
623 {
624         resource_size_t size = end - start;
625         unsigned long req_type = *type;
626         unsigned long new_type;
627         int ret;
628
629         WARN_ON_ONCE(iomem_map_sanity_check(start, size));
630
631         ret = reserve_memtype(start, end, req_type, &new_type);
632         if (ret)
633                 goto out_err;
634
635         if (!is_new_memtype_allowed(start, size, req_type, new_type))
636                 goto out_free;
637
638         if (kernel_map_sync_memtype(start, size, new_type) < 0)
639                 goto out_free;
640
641         *type = new_type;
642         return 0;
643
644 out_free:
645         free_memtype(start, end);
646         ret = -EBUSY;
647 out_err:
648         return ret;
649 }
650
651 /**
652  * io_free_memtype - Release a memory type mapping for a region of memory
653  * @start: start (physical address) of the region
654  * @end: end (physical address) of the region
655  */
656 void io_free_memtype(resource_size_t start, resource_size_t end)
657 {
658         free_memtype(start, end);
659 }
660
661 pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
662                                 unsigned long size, pgprot_t vma_prot)
663 {
664         return vma_prot;
665 }
666
667 #ifdef CONFIG_STRICT_DEVMEM
668 /* This check is done in drivers/char/mem.c in case of STRICT_DEVMEM*/
669 static inline int range_is_allowed(unsigned long pfn, unsigned long size)
670 {
671         return 1;
672 }
673 #else
674 /* This check is needed to avoid cache aliasing when PAT is enabled */
675 static inline int range_is_allowed(unsigned long pfn, unsigned long size)
676 {
677         u64 from = ((u64)pfn) << PAGE_SHIFT;
678         u64 to = from + size;
679         u64 cursor = from;
680
681         if (!pat_enabled)
682                 return 1;
683
684         while (cursor < to) {
685                 if (!devmem_is_allowed(pfn)) {
686                         printk(KERN_INFO
687                 "Program %s tried to access /dev/mem between %Lx->%Lx.\n",
688                                 current->comm, from, to);
689                         return 0;
690                 }
691                 cursor += PAGE_SIZE;
692                 pfn++;
693         }
694         return 1;
695 }
696 #endif /* CONFIG_STRICT_DEVMEM */
697
698 int phys_mem_access_prot_allowed(struct file *file, unsigned long pfn,
699                                 unsigned long size, pgprot_t *vma_prot)
700 {
701         unsigned long flags = _PAGE_CACHE_WB;
702
703         if (!range_is_allowed(pfn, size))
704                 return 0;
705
706         if (file->f_flags & O_SYNC) {
707                 flags = _PAGE_CACHE_UC_MINUS;
708         }
709
710 #ifdef CONFIG_X86_32
711         /*
712          * On the PPro and successors, the MTRRs are used to set
713          * memory types for physical addresses outside main memory,
714          * so blindly setting UC or PWT on those pages is wrong.
715          * For Pentiums and earlier, the surround logic should disable
716          * caching for the high addresses through the KEN pin, but
717          * we maintain the tradition of paranoia in this code.
718          */
719         if (!pat_enabled &&
720             !(boot_cpu_has(X86_FEATURE_MTRR) ||
721               boot_cpu_has(X86_FEATURE_K6_MTRR) ||
722               boot_cpu_has(X86_FEATURE_CYRIX_ARR) ||
723               boot_cpu_has(X86_FEATURE_CENTAUR_MCR)) &&
724             (pfn << PAGE_SHIFT) >= __pa(high_memory)) {
725                 flags = _PAGE_CACHE_UC;
726         }
727 #endif
728
729         *vma_prot = __pgprot((pgprot_val(*vma_prot) & ~_PAGE_CACHE_MASK) |
730                              flags);
731         return 1;
732 }
733
734 /*
735  * Change the memory type for the physial address range in kernel identity
736  * mapping space if that range is a part of identity map.
737  */
738 int kernel_map_sync_memtype(u64 base, unsigned long size, unsigned long flags)
739 {
740         unsigned long id_sz;
741
742         if (base >= __pa(high_memory))
743                 return 0;
744
745         id_sz = (__pa(high_memory) < base + size) ?
746                                 __pa(high_memory) - base :
747                                 size;
748
749         if (ioremap_change_attr((unsigned long)__va(base), id_sz, flags) < 0) {
750                 printk(KERN_INFO
751                         "%s:%d ioremap_change_attr failed %s "
752                         "for %Lx-%Lx\n",
753                         current->comm, current->pid,
754                         cattr_name(flags),
755                         base, (unsigned long long)(base + size));
756                 return -EINVAL;
757         }
758         return 0;
759 }
760
761 /*
762  * Internal interface to reserve a range of physical memory with prot.
763  * Reserved non RAM regions only and after successful reserve_memtype,
764  * this func also keeps identity mapping (if any) in sync with this new prot.
765  */
766 static int reserve_pfn_range(u64 paddr, unsigned long size, pgprot_t *vma_prot,
767                                 int strict_prot)
768 {
769         int is_ram = 0;
770         int ret;
771         unsigned long want_flags = (pgprot_val(*vma_prot) & _PAGE_CACHE_MASK);
772         unsigned long flags = want_flags;
773
774         is_ram = pat_pagerange_is_ram(paddr, paddr + size);
775
776         /*
777          * reserve_pfn_range() for RAM pages. We do not refcount to keep
778          * track of number of mappings of RAM pages. We can assert that
779          * the type requested matches the type of first page in the range.
780          */
781         if (is_ram) {
782                 if (!pat_enabled)
783                         return 0;
784
785                 flags = lookup_memtype(paddr);
786                 if (want_flags != flags) {
787                         printk(KERN_WARNING
788                         "%s:%d map pfn RAM range req %s for %Lx-%Lx, got %s\n",
789                                 current->comm, current->pid,
790                                 cattr_name(want_flags),
791                                 (unsigned long long)paddr,
792                                 (unsigned long long)(paddr + size),
793                                 cattr_name(flags));
794                         *vma_prot = __pgprot((pgprot_val(*vma_prot) &
795                                               (~_PAGE_CACHE_MASK)) |
796                                              flags);
797                 }
798                 return 0;
799         }
800
801         ret = reserve_memtype(paddr, paddr + size, want_flags, &flags);
802         if (ret)
803                 return ret;
804
805         if (flags != want_flags) {
806                 if (strict_prot ||
807                     !is_new_memtype_allowed(paddr, size, want_flags, flags)) {
808                         free_memtype(paddr, paddr + size);
809                         printk(KERN_ERR "%s:%d map pfn expected mapping type %s"
810                                 " for %Lx-%Lx, got %s\n",
811                                 current->comm, current->pid,
812                                 cattr_name(want_flags),
813                                 (unsigned long long)paddr,
814                                 (unsigned long long)(paddr + size),
815                                 cattr_name(flags));
816                         return -EINVAL;
817                 }
818                 /*
819                  * We allow returning different type than the one requested in
820                  * non strict case.
821                  */
822                 *vma_prot = __pgprot((pgprot_val(*vma_prot) &
823                                       (~_PAGE_CACHE_MASK)) |
824                                      flags);
825         }
826
827         if (kernel_map_sync_memtype(paddr, size, flags) < 0) {
828                 free_memtype(paddr, paddr + size);
829                 return -EINVAL;
830         }
831         return 0;
832 }
833
834 /*
835  * Internal interface to free a range of physical memory.
836  * Frees non RAM regions only.
837  */
838 static void free_pfn_range(u64 paddr, unsigned long size)
839 {
840         int is_ram;
841
842         is_ram = pat_pagerange_is_ram(paddr, paddr + size);
843         if (is_ram == 0)
844                 free_memtype(paddr, paddr + size);
845 }
846
847 /*
848  * track_pfn_vma_copy is called when vma that is covering the pfnmap gets
849  * copied through copy_page_range().
850  *
851  * If the vma has a linear pfn mapping for the entire range, we get the prot
852  * from pte and reserve the entire vma range with single reserve_pfn_range call.
853  */
854 int track_pfn_vma_copy(struct vm_area_struct *vma)
855 {
856         resource_size_t paddr;
857         unsigned long prot;
858         unsigned long vma_size = vma->vm_end - vma->vm_start;
859         pgprot_t pgprot;
860
861         if (is_linear_pfn_mapping(vma)) {
862                 /*
863                  * reserve the whole chunk covered by vma. We need the
864                  * starting address and protection from pte.
865                  */
866                 if (follow_phys(vma, vma->vm_start, 0, &prot, &paddr)) {
867                         WARN_ON_ONCE(1);
868                         return -EINVAL;
869                 }
870                 pgprot = __pgprot(prot);
871                 return reserve_pfn_range(paddr, vma_size, &pgprot, 1);
872         }
873
874         return 0;
875 }
876
877 /*
878  * track_pfn_vma_new is called when a _new_ pfn mapping is being established
879  * for physical range indicated by pfn and size.
880  *
881  * prot is passed in as a parameter for the new mapping. If the vma has a
882  * linear pfn mapping for the entire range reserve the entire vma range with
883  * single reserve_pfn_range call.
884  */
885 int track_pfn_vma_new(struct vm_area_struct *vma, pgprot_t *prot,
886                         unsigned long pfn, unsigned long size)
887 {
888         unsigned long flags;
889         resource_size_t paddr;
890         unsigned long vma_size = vma->vm_end - vma->vm_start;
891
892         if (is_linear_pfn_mapping(vma)) {
893                 /* reserve the whole chunk starting from vm_pgoff */
894                 paddr = (resource_size_t)vma->vm_pgoff << PAGE_SHIFT;
895                 return reserve_pfn_range(paddr, vma_size, prot, 0);
896         }
897
898         if (!pat_enabled)
899                 return 0;
900
901         /* for vm_insert_pfn and friends, we set prot based on lookup */
902         flags = lookup_memtype(pfn << PAGE_SHIFT);
903         *prot = __pgprot((pgprot_val(vma->vm_page_prot) & (~_PAGE_CACHE_MASK)) |
904                          flags);
905
906         return 0;
907 }
908
909 /*
910  * untrack_pfn_vma is called while unmapping a pfnmap for a region.
911  * untrack can be called for a specific region indicated by pfn and size or
912  * can be for the entire vma (in which case size can be zero).
913  */
914 void untrack_pfn_vma(struct vm_area_struct *vma, unsigned long pfn,
915                         unsigned long size)
916 {
917         resource_size_t paddr;
918         unsigned long vma_size = vma->vm_end - vma->vm_start;
919
920         if (is_linear_pfn_mapping(vma)) {
921                 /* free the whole chunk starting from vm_pgoff */
922                 paddr = (resource_size_t)vma->vm_pgoff << PAGE_SHIFT;
923                 free_pfn_range(paddr, vma_size);
924                 return;
925         }
926 }
927
928 pgprot_t pgprot_writecombine(pgprot_t prot)
929 {
930         if (pat_enabled)
931                 return __pgprot(pgprot_val(prot) | _PAGE_CACHE_WC);
932         else
933                 return pgprot_noncached(prot);
934 }
935 EXPORT_SYMBOL_GPL(pgprot_writecombine);
936
937 #if defined(CONFIG_DEBUG_FS) && defined(CONFIG_X86_PAT)
938
939 /* get Nth element of the linked list */
940 static struct memtype *memtype_get_idx(loff_t pos)
941 {
942         struct memtype *list_node, *print_entry;
943         int i = 1;
944
945         print_entry  = kmalloc(sizeof(struct memtype), GFP_KERNEL);
946         if (!print_entry)
947                 return NULL;
948
949         spin_lock(&memtype_lock);
950         list_for_each_entry(list_node, &memtype_list, nd) {
951                 if (pos == i) {
952                         *print_entry = *list_node;
953                         spin_unlock(&memtype_lock);
954                         return print_entry;
955                 }
956                 ++i;
957         }
958         spin_unlock(&memtype_lock);
959         kfree(print_entry);
960
961         return NULL;
962 }
963
964 static void *memtype_seq_start(struct seq_file *seq, loff_t *pos)
965 {
966         if (*pos == 0) {
967                 ++*pos;
968                 seq_printf(seq, "PAT memtype list:\n");
969         }
970
971         return memtype_get_idx(*pos);
972 }
973
974 static void *memtype_seq_next(struct seq_file *seq, void *v, loff_t *pos)
975 {
976         ++*pos;
977         return memtype_get_idx(*pos);
978 }
979
980 static void memtype_seq_stop(struct seq_file *seq, void *v)
981 {
982 }
983
984 static int memtype_seq_show(struct seq_file *seq, void *v)
985 {
986         struct memtype *print_entry = (struct memtype *)v;
987
988         seq_printf(seq, "%s @ 0x%Lx-0x%Lx\n", cattr_name(print_entry->type),
989                         print_entry->start, print_entry->end);
990         kfree(print_entry);
991
992         return 0;
993 }
994
995 static const struct seq_operations memtype_seq_ops = {
996         .start = memtype_seq_start,
997         .next  = memtype_seq_next,
998         .stop  = memtype_seq_stop,
999         .show  = memtype_seq_show,
1000 };
1001
1002 static int memtype_seq_open(struct inode *inode, struct file *file)
1003 {
1004         return seq_open(file, &memtype_seq_ops);
1005 }
1006
1007 static const struct file_operations memtype_fops = {
1008         .open    = memtype_seq_open,
1009         .read    = seq_read,
1010         .llseek  = seq_lseek,
1011         .release = seq_release,
1012 };
1013
1014 static int __init pat_memtype_list_init(void)
1015 {
1016         debugfs_create_file("pat_memtype_list", S_IRUSR, arch_debugfs_dir,
1017                                 NULL, &memtype_fops);
1018         return 0;
1019 }
1020
1021 late_initcall(pat_memtype_list_init);
1022
1023 #endif /* CONFIG_DEBUG_FS && CONFIG_X86_PAT */