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/slab.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/x86_init.h>
  24 #include <asm/pgtable.h>
  25 #include <asm/fcntl.h>
  26 #include <asm/e820.h>
  27 #include <asm/mtrr.h>
  28 #include <asm/page.h>
  29 #include <asm/msr.h>
  30 #include <asm/pat.h>
  31 #include <asm/io.h>
  32
  33 #include "pat_internal.h"
  34 #include "mm_internal.h"
  35
  36 #undef pr_fmt
  37 #define pr_fmt(fmt) "" fmt
  38
  39 static bool boot_cpu_done;
  40
  41 static int __read_mostly __pat_enabled = IS_ENABLED(CONFIG_X86_PAT);
  42
  43 static inline void pat_disable(const char *reason)
  44 {
  45         __pat_enabled = 0;
  46         pr_info("x86/PAT: %s\n", reason);
  47 }
  48
  49 static int __init nopat(char *str)
  50 {
  51         pat_disable("PAT support disabled.");
  52         return 0;
  53 }
  54 early_param("nopat", nopat);
  55
  56 bool pat_enabled(void)
  57 {
  58         return !!__pat_enabled;
  59 }
  60 EXPORT_SYMBOL_GPL(pat_enabled);
  61
  62 int pat_debug_enable;
  63
  64 static int __init pat_debug_setup(char *str)
  65 {
  66         pat_debug_enable = 1;
  67         return 0;
  68 }
  69 __setup("debugpat", pat_debug_setup);
  70
  71 #ifdef CONFIG_X86_PAT
  72 /*
  73  * X86 PAT uses page flags arch_1 and uncached together to keep track of
  74  * memory type of pages that have backing page struct.
  75  *
  76  * X86 PAT supports 4 different memory types:
  77  *  - _PAGE_CACHE_MODE_WB
  78  *  - _PAGE_CACHE_MODE_WC
  79  *  - _PAGE_CACHE_MODE_UC_MINUS
  80  *  - _PAGE_CACHE_MODE_WT
  81  *
  82  * _PAGE_CACHE_MODE_WB is the default type.
  83  */
  84
  85 #define _PGMT_WB                0
  86 #define _PGMT_WC                (1UL << PG_arch_1)
  87 #define _PGMT_UC_MINUS          (1UL << PG_uncached)
  88 #define _PGMT_WT                (1UL << PG_uncached | 1UL << PG_arch_1)
  89 #define _PGMT_MASK              (1UL << PG_uncached | 1UL << PG_arch_1)
  90 #define _PGMT_CLEAR_MASK        (~_PGMT_MASK)
  91
  92 static inline enum page_cache_mode get_page_memtype(struct page *pg)
  93 {
  94         unsigned long pg_flags = pg->flags & _PGMT_MASK;
  95
  96         if (pg_flags == _PGMT_WB)
  97                 return _PAGE_CACHE_MODE_WB;
  98         else if (pg_flags == _PGMT_WC)
  99                 return _PAGE_CACHE_MODE_WC;
 100         else if (pg_flags == _PGMT_UC_MINUS)
 101                 return _PAGE_CACHE_MODE_UC_MINUS;
 102         else
 103                 return _PAGE_CACHE_MODE_WT;
 104 }
 105
 106 static inline void set_page_memtype(struct page *pg,
 107                                     enum page_cache_mode memtype)
 108 {
 109         unsigned long memtype_flags;
 110         unsigned long old_flags;
 111         unsigned long new_flags;
 112
 113         switch (memtype) {
 114         case _PAGE_CACHE_MODE_WC:
 115                 memtype_flags = _PGMT_WC;
 116                 break;
 117         case _PAGE_CACHE_MODE_UC_MINUS:
 118                 memtype_flags = _PGMT_UC_MINUS;
 119                 break;
 120         case _PAGE_CACHE_MODE_WT:
 121                 memtype_flags = _PGMT_WT;
 122                 break;
 123         case _PAGE_CACHE_MODE_WB:
 124         default:
 125                 memtype_flags = _PGMT_WB;
 126                 break;
 127         }
 128
 129         do {
 130                 old_flags = pg->flags;
 131                 new_flags = (old_flags & _PGMT_CLEAR_MASK) | memtype_flags;
 132         } while (cmpxchg(&pg->flags, old_flags, new_flags) != old_flags);
 133 }
 134 #else
 135 static inline enum page_cache_mode get_page_memtype(struct page *pg)
 136 {
 137         return -1;
 138 }
 139 static inline void set_page_memtype(struct page *pg,
 140                                     enum page_cache_mode memtype)
 141 {
 142 }
 143 #endif
 144
 145 enum {
 146         PAT_UC = 0,             /* uncached */
 147         PAT_WC = 1,             /* Write combining */
 148         PAT_WT = 4,             /* Write Through */
 149         PAT_WP = 5,             /* Write Protected */
 150         PAT_WB = 6,             /* Write Back (default) */
 151         PAT_UC_MINUS = 7,       /* UC, but can be overriden by MTRR */
 152 };
 153
 154 #define CM(c) (_PAGE_CACHE_MODE_ ## c)
 155
 156 static enum page_cache_mode pat_get_cache_mode(unsigned pat_val, char *msg)
 157 {
 158         enum page_cache_mode cache;
 159         char *cache_mode;
 160
 161         switch (pat_val) {
 162         case PAT_UC:       cache = CM(UC);       cache_mode = "UC  "; break;
 163         case PAT_WC:       cache = CM(WC);       cache_mode = "WC  "; break;
 164         case PAT_WT:       cache = CM(WT);       cache_mode = "WT  "; break;
 165         case PAT_WP:       cache = CM(WP);       cache_mode = "WP  "; break;
 166         case PAT_WB:       cache = CM(WB);       cache_mode = "WB  "; break;
 167         case PAT_UC_MINUS: cache = CM(UC_MINUS); cache_mode = "UC- "; break;
 168         default:           cache = CM(WB);       cache_mode = "WB  "; break;
 169         }
 170
 171         memcpy(msg, cache_mode, 4);
 172
 173         return cache;
 174 }
 175
 176 #undef CM
 177
 178 /*
 179  * Update the cache mode to pgprot translation tables according to PAT
 180  * configuration.
 181  * Using lower indices is preferred, so we start with highest index.
 182  */
 183 void __init_cache_modes(u64 pat)
 184 {
 185         enum page_cache_mode cache;
 186         char pat_msg[33];
 187         int i;
 188
 189         pat_msg[32] = 0;
 190         for (i = 7; i >= 0; i--) {
 191                 cache = pat_get_cache_mode((pat >> (i * 8)) & 7,
 192                                            pat_msg + 4 * i);
 193                 update_cache_mode_entry(i, cache);
 194         }
 195         pr_info("x86/PAT: Configuration [0-7]: %s\n", pat_msg);
 196 }
 197
 198 #define PAT(x, y)       ((u64)PAT_ ## y << ((x)*8))
 199
 200 static void pat_bsp_init(u64 pat)
 201 {
 202         u64 tmp_pat;
 203
 204         if (!cpu_has_pat) {
 205                 pat_disable("PAT not supported by CPU.");
 206                 return;
 207         }
 208
 209         rdmsrl(MSR_IA32_CR_PAT, tmp_pat);
 210         if (!tmp_pat) {
 211                 pat_disable("PAT MSR is 0, disabled.");
 212                 return;
 213         }
 214
 215         wrmsrl(MSR_IA32_CR_PAT, pat);
 216
 217         __init_cache_modes(pat);
 218 }
 219
 220 static void pat_ap_init(u64 pat)
 221 {
 222         if (!cpu_has_pat) {
 223                 /*
 224                  * If this happens we are on a secondary CPU, but switched to
 225                  * PAT on the boot CPU. We have no way to undo PAT.
 226                  */
 227                 panic("x86/PAT: PAT enabled, but not supported by secondary CPU\n");
 228         }
 229
 230         wrmsrl(MSR_IA32_CR_PAT, pat);
 231 }
 232
 233 static void init_cache_modes(void)
 234 {
 235         u64 pat = 0;
 236         static int init_cm_done;
 237
 238         if (init_cm_done)
 239                 return;
 240
 241         if (boot_cpu_has(X86_FEATURE_PAT)) {
 242                 /*
 243                  * CPU supports PAT. Set PAT table to be consistent with
 244                  * PAT MSR. This case supports "nopat" boot option, and
 245                  * virtual machine environments which support PAT without
 246                  * MTRRs. In specific, Xen has unique setup to PAT MSR.
 247                  *
 248                  * If PAT MSR returns 0, it is considered invalid and emulates
 249                  * as No PAT.
 250                  */
 251                 rdmsrl(MSR_IA32_CR_PAT, pat);
 252         }
 253
 254         if (!pat) {
 255                 /*
 256                  * No PAT. Emulate the PAT table that corresponds to the two
 257                  * cache bits, PWT (Write Through) and PCD (Cache Disable).
 258                  * This setup is also the same as the BIOS default setup.
 259                  *
 260                  * PTE encoding:
 261                  *
 262                  *       PCD
 263                  *       |PWT  PAT
 264                  *       ||    slot
 265                  *       00    0    WB : _PAGE_CACHE_MODE_WB
 266                  *       01    1    WT : _PAGE_CACHE_MODE_WT
 267                  *       10    2    UC-: _PAGE_CACHE_MODE_UC_MINUS
 268                  *       11    3    UC : _PAGE_CACHE_MODE_UC
 269                  *
 270                  * NOTE: When WC or WP is used, it is redirected to UC- per
 271                  * the default setup in __cachemode2pte_tbl[].
 272                  */
 273                 pat = PAT(0, WB) | PAT(1, WT) | PAT(2, UC_MINUS) | PAT(3, UC) |
 274                       PAT(4, WB) | PAT(5, WT) | PAT(6, UC_MINUS) | PAT(7, UC);
 275         }
 276
 277         __init_cache_modes(pat);
 278
 279         init_cm_done = 1;
 280 }
 281
 282 /**
 283  * pat_init - Initialize PAT MSR and PAT table
 284  *
 285  * This function initializes PAT MSR and PAT table with an OS-defined value
 286  * to enable additional cache attributes, WC and WT.
 287  *
 288  * This function must be called on all CPUs using the specific sequence of
 289  * operations defined in Intel SDM. mtrr_rendezvous_handler() provides this
 290  * procedure for PAT.
 291  */
 292 void pat_init(void)
 293 {
 294         u64 pat;
 295         struct cpuinfo_x86 *c = &boot_cpu_data;
 296
 297         if (!pat_enabled()) {
 298                 init_cache_modes();
 299                 return;
 300         }
 301
 302         if ((c->x86_vendor == X86_VENDOR_INTEL) &&
 303             (((c->x86 == 0x6) && (c->x86_model <= 0xd)) ||
 304              ((c->x86 == 0xf) && (c->x86_model <= 0x6)))) {
 305                 /*
 306                  * PAT support with the lower four entries. Intel Pentium 2,
 307                  * 3, M, and 4 are affected by PAT errata, which makes the
 308                  * upper four entries unusable. To be on the safe side, we don't
 309                  * use those.
 310                  *
 311                  *  PTE encoding:
 312                  *      PAT
 313                  *      |PCD
 314                  *      ||PWT  PAT
 315                  *      |||    slot
 316                  *      000    0    WB : _PAGE_CACHE_MODE_WB
 317                  *      001    1    WC : _PAGE_CACHE_MODE_WC
 318                  *      010    2    UC-: _PAGE_CACHE_MODE_UC_MINUS
 319                  *      011    3    UC : _PAGE_CACHE_MODE_UC
 320                  * PAT bit unused
 321                  *
 322                  * NOTE: When WT or WP is used, it is redirected to UC- per
 323                  * the default setup in __cachemode2pte_tbl[].
 324                  */
 325                 pat = PAT(0, WB) | PAT(1, WC) | PAT(2, UC_MINUS) | PAT(3, UC) |
 326                       PAT(4, WB) | PAT(5, WC) | PAT(6, UC_MINUS) | PAT(7, UC);
 327         } else {
 328                 /*
 329                  * Full PAT support.  We put WT in slot 7 to improve
 330                  * robustness in the presence of errata that might cause
 331                  * the high PAT bit to be ignored.  This way, a buggy slot 7
 332                  * access will hit slot 3, and slot 3 is UC, so at worst
 333                  * we lose performance without causing a correctness issue.
 334                  * Pentium 4 erratum N46 is an example for such an erratum,
 335                  * although we try not to use PAT at all on affected CPUs.
 336                  *
 337                  *  PTE encoding:
 338                  *      PAT
 339                  *      |PCD
 340                  *      ||PWT  PAT
 341                  *      |||    slot
 342                  *      000    0    WB : _PAGE_CACHE_MODE_WB
 343                  *      001    1    WC : _PAGE_CACHE_MODE_WC
 344                  *      010    2    UC-: _PAGE_CACHE_MODE_UC_MINUS
 345                  *      011    3    UC : _PAGE_CACHE_MODE_UC
 346                  *      100    4    WB : Reserved
 347                  *      101    5    WC : Reserved
 348                  *      110    6    UC-: Reserved
 349                  *      111    7    WT : _PAGE_CACHE_MODE_WT
 350                  *
 351                  * The reserved slots are unused, but mapped to their
 352                  * corresponding types in the presence of PAT errata.
 353                  */
 354                 pat = PAT(0, WB) | PAT(1, WC) | PAT(2, UC_MINUS) | PAT(3, UC) |
 355                       PAT(4, WB) | PAT(5, WC) | PAT(6, UC_MINUS) | PAT(7, WT);
 356         }
 357
 358         if (!boot_cpu_done) {
 359                 pat_bsp_init(pat);
 360                 boot_cpu_done = true;
 361         } else {
 362                 pat_ap_init(pat);
 363         }
 364 }
 365
 366 #undef PAT
 367
 368 static DEFINE_SPINLOCK(memtype_lock);   /* protects memtype accesses */
 369
 370 /*
 371  * Does intersection of PAT memory type and MTRR memory type and returns
 372  * the resulting memory type as PAT understands it.
 373  * (Type in pat and mtrr will not have same value)
 374  * The intersection is based on "Effective Memory Type" tables in IA-32
 375  * SDM vol 3a
 376  */
 377 static unsigned long pat_x_mtrr_type(u64 start, u64 end,
 378                                      enum page_cache_mode req_type)
 379 {
 380         /*
 381          * Look for MTRR hint to get the effective type in case where PAT
 382          * request is for WB.
 383          */
 384         if (req_type == _PAGE_CACHE_MODE_WB) {
 385                 u8 mtrr_type, uniform;
 386
 387                 mtrr_type = mtrr_type_lookup(start, end, &uniform);
 388                 if (mtrr_type != MTRR_TYPE_WRBACK)
 389                         return _PAGE_CACHE_MODE_UC_MINUS;
 390
 391                 return _PAGE_CACHE_MODE_WB;
 392         }
 393
 394         return req_type;
 395 }
 396
 397 struct pagerange_state {
 398         unsigned long           cur_pfn;
 399         int                     ram;
 400         int                     not_ram;
 401 };
 402
 403 static int
 404 pagerange_is_ram_callback(unsigned long initial_pfn, unsigned long total_nr_pages, void *arg)
 405 {
 406         struct pagerange_state *state = arg;
 407
 408         state->not_ram  |= initial_pfn > state->cur_pfn;
 409         state->ram      |= total_nr_pages > 0;
 410         state->cur_pfn   = initial_pfn + total_nr_pages;
 411
 412         return state->ram && state->not_ram;
 413 }
 414
 415 static int pat_pagerange_is_ram(resource_size_t start, resource_size_t end)
 416 {
 417         int ret = 0;
 418         unsigned long start_pfn = start >> PAGE_SHIFT;
 419         unsigned long end_pfn = (end + PAGE_SIZE - 1) >> PAGE_SHIFT;
 420         struct pagerange_state state = {start_pfn, 0, 0};
 421
 422         /*
 423          * For legacy reasons, physical address range in the legacy ISA
 424          * region is tracked as non-RAM. This will allow users of
 425          * /dev/mem to map portions of legacy ISA region, even when
 426          * some of those portions are listed(or not even listed) with
 427          * different e820 types(RAM/reserved/..)
 428          */
 429         if (start_pfn < ISA_END_ADDRESS >> PAGE_SHIFT)
 430                 start_pfn = ISA_END_ADDRESS >> PAGE_SHIFT;
 431
 432         if (start_pfn < end_pfn) {
 433                 ret = walk_system_ram_range(start_pfn, end_pfn - start_pfn,
 434                                 &state, pagerange_is_ram_callback);
 435         }
 436
 437         return (ret > 0) ? -1 : (state.ram ? 1 : 0);
 438 }
 439
 440 /*
 441  * For RAM pages, we use page flags to mark the pages with appropriate type.
 442  * The page flags are limited to four types, WB (default), WC, WT and UC-.
 443  * WP request fails with -EINVAL, and UC gets redirected to UC-.  Setting
 444  * a new memory type is only allowed for a page mapped with the default WB
 445  * type.
 446  *
 447  * Here we do two passes:
 448  * - Find the memtype of all the pages in the range, look for any conflicts.
 449  * - In case of no conflicts, set the new memtype for pages in the range.
 450  */
 451 static int reserve_ram_pages_type(u64 start, u64 end,
 452                                   enum page_cache_mode req_type,
 453                                   enum page_cache_mode *new_type)
 454 {
 455         struct page *page;
 456         u64 pfn;
 457
 458         if (req_type == _PAGE_CACHE_MODE_WP) {
 459                 if (new_type)
 460                         *new_type = _PAGE_CACHE_MODE_UC_MINUS;
 461                 return -EINVAL;
 462         }
 463
 464         if (req_type == _PAGE_CACHE_MODE_UC) {
 465                 /* We do not support strong UC */
 466                 WARN_ON_ONCE(1);
 467                 req_type = _PAGE_CACHE_MODE_UC_MINUS;
 468         }
 469
 470         for (pfn = (start >> PAGE_SHIFT); pfn < (end >> PAGE_SHIFT); ++pfn) {
 471                 enum page_cache_mode type;
 472
 473                 page = pfn_to_page(pfn);
 474                 type = get_page_memtype(page);
 475                 if (type != _PAGE_CACHE_MODE_WB) {
 476                         pr_info("x86/PAT: reserve_ram_pages_type failed [mem %#010Lx-%#010Lx], track 0x%x, req 0x%x\n",
 477                                 start, end - 1, type, req_type);
 478                         if (new_type)
 479                                 *new_type = type;
 480
 481                         return -EBUSY;
 482                 }
 483         }
 484
 485         if (new_type)
 486                 *new_type = req_type;
 487
 488         for (pfn = (start >> PAGE_SHIFT); pfn < (end >> PAGE_SHIFT); ++pfn) {
 489                 page = pfn_to_page(pfn);
 490                 set_page_memtype(page, req_type);
 491         }
 492         return 0;
 493 }
 494
 495 static int free_ram_pages_type(u64 start, u64 end)
 496 {
 497         struct page *page;
 498         u64 pfn;
 499
 500         for (pfn = (start >> PAGE_SHIFT); pfn < (end >> PAGE_SHIFT); ++pfn) {
 501                 page = pfn_to_page(pfn);
 502                 set_page_memtype(page, _PAGE_CACHE_MODE_WB);
 503         }
 504         return 0;
 505 }
 506
 507 /*
 508  * req_type typically has one of the:
 509  * - _PAGE_CACHE_MODE_WB
 510  * - _PAGE_CACHE_MODE_WC
 511  * - _PAGE_CACHE_MODE_UC_MINUS
 512  * - _PAGE_CACHE_MODE_UC
 513  * - _PAGE_CACHE_MODE_WT
 514  *
 515  * If new_type is NULL, function will return an error if it cannot reserve the
 516  * region with req_type. If new_type is non-NULL, function will return
 517  * available type in new_type in case of no error. In case of any error
 518  * it will return a negative return value.
 519  */
 520 int reserve_memtype(u64 start, u64 end, enum page_cache_mode req_type,
 521                     enum page_cache_mode *new_type)
 522 {
 523         struct memtype *new;
 524         enum page_cache_mode actual_type;
 525         int is_range_ram;
 526         int err = 0;
 527
 528         BUG_ON(start >= end); /* end is exclusive */
 529
 530         if (!pat_enabled()) {
 531                 /* This is identical to page table setting without PAT */
 532                 if (new_type)
 533                         *new_type = req_type;
 534                 return 0;
 535         }
 536
 537         /* Low ISA region is always mapped WB in page table. No need to track */
 538         if (x86_platform.is_untracked_pat_range(start, end)) {
 539                 if (new_type)
 540                         *new_type = _PAGE_CACHE_MODE_WB;
 541                 return 0;
 542         }
 543
 544         /*
 545          * Call mtrr_lookup to get the type hint. This is an
 546          * optimization for /dev/mem mmap'ers into WB memory (BIOS
 547          * tools and ACPI tools). Use WB request for WB memory and use
 548          * UC_MINUS otherwise.
 549          */
 550         actual_type = pat_x_mtrr_type(start, end, req_type);
 551
 552         if (new_type)
 553                 *new_type = actual_type;
 554
 555         is_range_ram = pat_pagerange_is_ram(start, end);
 556         if (is_range_ram == 1) {
 557
 558                 err = reserve_ram_pages_type(start, end, req_type, new_type);
 559
 560                 return err;
 561         } else if (is_range_ram < 0) {
 562                 return -EINVAL;
 563         }
 564
 565         new  = kzalloc(sizeof(struct memtype), GFP_KERNEL);
 566         if (!new)
 567                 return -ENOMEM;
 568
 569         new->start      = start;
 570         new->end        = end;
 571         new->type       = actual_type;
 572
 573         spin_lock(&memtype_lock);
 574
 575         err = rbt_memtype_check_insert(new, new_type);
 576         if (err) {
 577                 pr_info("x86/PAT: reserve_memtype failed [mem %#010Lx-%#010Lx], track %s, req %s\n",
 578                         start, end - 1,
 579                         cattr_name(new->type), cattr_name(req_type));
 580                 kfree(new);
 581                 spin_unlock(&memtype_lock);
 582
 583                 return err;
 584         }
 585
 586         spin_unlock(&memtype_lock);
 587
 588         dprintk("reserve_memtype added [mem %#010Lx-%#010Lx], track %s, req %s, ret %s\n",
 589                 start, end - 1, cattr_name(new->type), cattr_name(req_type),
 590                 new_type ? cattr_name(*new_type) : "-");
 591
 592         return err;
 593 }
 594
 595 int free_memtype(u64 start, u64 end)
 596 {
 597         int err = -EINVAL;
 598         int is_range_ram;
 599         struct memtype *entry;
 600
 601         if (!pat_enabled())
 602                 return 0;
 603
 604         /* Low ISA region is always mapped WB. No need to track */
 605         if (x86_platform.is_untracked_pat_range(start, end))
 606                 return 0;
 607
 608         is_range_ram = pat_pagerange_is_ram(start, end);
 609         if (is_range_ram == 1) {
 610
 611                 err = free_ram_pages_type(start, end);
 612
 613                 return err;
 614         } else if (is_range_ram < 0) {
 615                 return -EINVAL;
 616         }
 617
 618         spin_lock(&memtype_lock);
 619         entry = rbt_memtype_erase(start, end);
 620         spin_unlock(&memtype_lock);
 621
 622         if (!entry) {
 623                 pr_info("x86/PAT: %s:%d freeing invalid memtype [mem %#010Lx-%#010Lx]\n",
 624                         current->comm, current->pid, start, end - 1);
 625                 return -EINVAL;
 626         }
 627
 628         kfree(entry);
 629
 630         dprintk("free_memtype request [mem %#010Lx-%#010Lx]\n", start, end - 1);
 631
 632         return 0;
 633 }
 634
 635
 636 /**
 637  * lookup_memtype - Looksup the memory type for a physical address
 638  * @paddr: physical address of which memory type needs to be looked up
 639  *
 640  * Only to be called when PAT is enabled
 641  *
 642  * Returns _PAGE_CACHE_MODE_WB, _PAGE_CACHE_MODE_WC, _PAGE_CACHE_MODE_UC_MINUS
 643  * or _PAGE_CACHE_MODE_WT.
 644  */
 645 static enum page_cache_mode lookup_memtype(u64 paddr)
 646 {
 647         enum page_cache_mode rettype = _PAGE_CACHE_MODE_WB;
 648         struct memtype *entry;
 649
 650         if (x86_platform.is_untracked_pat_range(paddr, paddr + PAGE_SIZE))
 651                 return rettype;
 652
 653         if (pat_pagerange_is_ram(paddr, paddr + PAGE_SIZE)) {
 654                 struct page *page;
 655
 656                 page = pfn_to_page(paddr >> PAGE_SHIFT);
 657                 return get_page_memtype(page);
 658         }
 659
 660         spin_lock(&memtype_lock);
 661
 662         entry = rbt_memtype_lookup(paddr);
 663         if (entry != NULL)
 664                 rettype = entry->type;
 665         else
 666                 rettype = _PAGE_CACHE_MODE_UC_MINUS;
 667
 668         spin_unlock(&memtype_lock);
 669         return rettype;
 670 }
 671
 672 /**
 673  * io_reserve_memtype - Request a memory type mapping for a region of memory
 674  * @start: start (physical address) of the region
 675  * @end: end (physical address) of the region
 676  * @type: A pointer to memtype, with requested type. On success, requested
 677  * or any other compatible type that was available for the region is returned
 678  *
 679  * On success, returns 0
 680  * On failure, returns non-zero
 681  */
 682 int io_reserve_memtype(resource_size_t start, resource_size_t end,
 683                         enum page_cache_mode *type)
 684 {
 685         resource_size_t size = end - start;
 686         enum page_cache_mode req_type = *type;
 687         enum page_cache_mode new_type;
 688         int ret;
 689
 690         WARN_ON_ONCE(iomem_map_sanity_check(start, size));
 691
 692         ret = reserve_memtype(start, end, req_type, &new_type);
 693         if (ret)
 694                 goto out_err;
 695
 696         if (!is_new_memtype_allowed(start, size, req_type, new_type))
 697                 goto out_free;
 698
 699         if (kernel_map_sync_memtype(start, size, new_type) < 0)
 700                 goto out_free;
 701
 702         *type = new_type;
 703         return 0;
 704
 705 out_free:
 706         free_memtype(start, end);
 707         ret = -EBUSY;
 708 out_err:
 709         return ret;
 710 }
 711
 712 /**
 713  * io_free_memtype - Release a memory type mapping for a region of memory
 714  * @start: start (physical address) of the region
 715  * @end: end (physical address) of the region
 716  */
 717 void io_free_memtype(resource_size_t start, resource_size_t end)
 718 {
 719         free_memtype(start, end);
 720 }
 721
 722 pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
 723                                 unsigned long size, pgprot_t vma_prot)
 724 {
 725         return vma_prot;
 726 }
 727
 728 #ifdef CONFIG_STRICT_DEVMEM
 729 /* This check is done in drivers/char/mem.c in case of STRICT_DEVMEM */
 730 static inline int range_is_allowed(unsigned long pfn, unsigned long size)
 731 {
 732         return 1;
 733 }
 734 #else
 735 /* This check is needed to avoid cache aliasing when PAT is enabled */
 736 static inline int range_is_allowed(unsigned long pfn, unsigned long size)
 737 {
 738         u64 from = ((u64)pfn) << PAGE_SHIFT;
 739         u64 to = from + size;
 740         u64 cursor = from;
 741
 742         if (!pat_enabled())
 743                 return 1;
 744
 745         while (cursor < to) {
 746                 if (!devmem_is_allowed(pfn)) {
 747                         pr_info("x86/PAT: Program %s tried to access /dev/mem between [mem %#010Lx-%#010Lx], PAT prevents it\n",
 748                                 current->comm, from, to - 1);
 749                         return 0;
 750                 }
 751                 cursor += PAGE_SIZE;
 752                 pfn++;
 753         }
 754         return 1;
 755 }
 756 #endif /* CONFIG_STRICT_DEVMEM */
 757
 758 int phys_mem_access_prot_allowed(struct file *file, unsigned long pfn,
 759                                 unsigned long size, pgprot_t *vma_prot)
 760 {
 761         enum page_cache_mode pcm = _PAGE_CACHE_MODE_WB;
 762
 763         if (!range_is_allowed(pfn, size))
 764                 return 0;
 765
 766         if (file->f_flags & O_DSYNC)
 767                 pcm = _PAGE_CACHE_MODE_UC_MINUS;
 768
 769 #ifdef CONFIG_X86_32
 770         /*
 771          * On the PPro and successors, the MTRRs are used to set
 772          * memory types for physical addresses outside main memory,
 773          * so blindly setting UC or PWT on those pages is wrong.
 774          * For Pentiums and earlier, the surround logic should disable
 775          * caching for the high addresses through the KEN pin, but
 776          * we maintain the tradition of paranoia in this code.
 777          */
 778         if (!pat_enabled() &&
 779             !(boot_cpu_has(X86_FEATURE_MTRR) ||
 780               boot_cpu_has(X86_FEATURE_K6_MTRR) ||
 781               boot_cpu_has(X86_FEATURE_CYRIX_ARR) ||
 782               boot_cpu_has(X86_FEATURE_CENTAUR_MCR)) &&
 783             (pfn << PAGE_SHIFT) >= __pa(high_memory)) {
 784                 pcm = _PAGE_CACHE_MODE_UC;
 785         }
 786 #endif
 787
 788         *vma_prot = __pgprot((pgprot_val(*vma_prot) & ~_PAGE_CACHE_MASK) |
 789                              cachemode2protval(pcm));
 790         return 1;
 791 }
 792
 793 /*
 794  * Change the memory type for the physial address range in kernel identity
 795  * mapping space if that range is a part of identity map.
 796  */
 797 int kernel_map_sync_memtype(u64 base, unsigned long size,
 798                             enum page_cache_mode pcm)
 799 {
 800         unsigned long id_sz;
 801
 802         if (base > __pa(high_memory-1))
 803                 return 0;
 804
 805         /*
 806          * some areas in the middle of the kernel identity range
 807          * are not mapped, like the PCI space.
 808          */
 809         if (!page_is_ram(base >> PAGE_SHIFT))
 810                 return 0;
 811
 812         id_sz = (__pa(high_memory-1) <= base + size) ?
 813                                 __pa(high_memory) - base :
 814                                 size;
 815
 816         if (ioremap_change_attr((unsigned long)__va(base), id_sz, pcm) < 0) {
 817                 pr_info("x86/PAT: %s:%d ioremap_change_attr failed %s for [mem %#010Lx-%#010Lx]\n",
 818                         current->comm, current->pid,
 819                         cattr_name(pcm),
 820                         base, (unsigned long long)(base + size-1));
 821                 return -EINVAL;
 822         }
 823         return 0;
 824 }
 825
 826 /*
 827  * Internal interface to reserve a range of physical memory with prot.
 828  * Reserved non RAM regions only and after successful reserve_memtype,
 829  * this func also keeps identity mapping (if any) in sync with this new prot.
 830  */
 831 static int reserve_pfn_range(u64 paddr, unsigned long size, pgprot_t *vma_prot,
 832                                 int strict_prot)
 833 {
 834         int is_ram = 0;
 835         int ret;
 836         enum page_cache_mode want_pcm = pgprot2cachemode(*vma_prot);
 837         enum page_cache_mode pcm = want_pcm;
 838
 839         is_ram = pat_pagerange_is_ram(paddr, paddr + size);
 840
 841         /*
 842          * reserve_pfn_range() for RAM pages. We do not refcount to keep
 843          * track of number of mappings of RAM pages. We can assert that
 844          * the type requested matches the type of first page in the range.
 845          */
 846         if (is_ram) {
 847                 if (!pat_enabled())
 848                         return 0;
 849
 850                 pcm = lookup_memtype(paddr);
 851                 if (want_pcm != pcm) {
 852                         pr_warn("x86/PAT: %s:%d map pfn RAM range req %s for [mem %#010Lx-%#010Lx], got %s\n",
 853                                 current->comm, current->pid,
 854                                 cattr_name(want_pcm),
 855                                 (unsigned long long)paddr,
 856                                 (unsigned long long)(paddr + size - 1),
 857                                 cattr_name(pcm));
 858                         *vma_prot = __pgprot((pgprot_val(*vma_prot) &
 859                                              (~_PAGE_CACHE_MASK)) |
 860                                              cachemode2protval(pcm));
 861                 }
 862                 return 0;
 863         }
 864
 865         ret = reserve_memtype(paddr, paddr + size, want_pcm, &pcm);
 866         if (ret)
 867                 return ret;
 868
 869         if (pcm != want_pcm) {
 870                 if (strict_prot ||
 871                     !is_new_memtype_allowed(paddr, size, want_pcm, pcm)) {
 872                         free_memtype(paddr, paddr + size);
 873                         pr_err("x86/PAT: %s:%d map pfn expected mapping type %s for [mem %#010Lx-%#010Lx], got %s\n",
 874                                current->comm, current->pid,
 875                                cattr_name(want_pcm),
 876                                (unsigned long long)paddr,
 877                                (unsigned long long)(paddr + size - 1),
 878                                cattr_name(pcm));
 879                         return -EINVAL;
 880                 }
 881                 /*
 882                  * We allow returning different type than the one requested in
 883                  * non strict case.
 884                  */
 885                 *vma_prot = __pgprot((pgprot_val(*vma_prot) &
 886                                       (~_PAGE_CACHE_MASK)) |
 887                                      cachemode2protval(pcm));
 888         }
 889
 890         if (kernel_map_sync_memtype(paddr, size, pcm) < 0) {
 891                 free_memtype(paddr, paddr + size);
 892                 return -EINVAL;
 893         }
 894         return 0;
 895 }
 896
 897 /*
 898  * Internal interface to free a range of physical memory.
 899  * Frees non RAM regions only.
 900  */
 901 static void free_pfn_range(u64 paddr, unsigned long size)
 902 {
 903         int is_ram;
 904
 905         is_ram = pat_pagerange_is_ram(paddr, paddr + size);
 906         if (is_ram == 0)
 907                 free_memtype(paddr, paddr + size);
 908 }
 909
 910 /*
 911  * track_pfn_copy is called when vma that is covering the pfnmap gets
 912  * copied through copy_page_range().
 913  *
 914  * If the vma has a linear pfn mapping for the entire range, we get the prot
 915  * from pte and reserve the entire vma range with single reserve_pfn_range call.
 916  */
 917 int track_pfn_copy(struct vm_area_struct *vma)
 918 {
 919         resource_size_t paddr;
 920         unsigned long prot;
 921         unsigned long vma_size = vma->vm_end - vma->vm_start;
 922         pgprot_t pgprot;
 923
 924         if (vma->vm_flags & VM_PAT) {
 925                 /*
 926                  * reserve the whole chunk covered by vma. We need the
 927                  * starting address and protection from pte.
 928                  */
 929                 if (follow_phys(vma, vma->vm_start, 0, &prot, &paddr)) {
 930                         WARN_ON_ONCE(1);
 931                         return -EINVAL;
 932                 }
 933                 pgprot = __pgprot(prot);
 934                 return reserve_pfn_range(paddr, vma_size, &pgprot, 1);
 935         }
 936
 937         return 0;
 938 }
 939
 940 /*
 941  * prot is passed in as a parameter for the new mapping. If the vma has a
 942  * linear pfn mapping for the entire range reserve the entire vma range with
 943  * single reserve_pfn_range call.
 944  */
 945 int track_pfn_remap(struct vm_area_struct *vma, pgprot_t *prot,
 946                     unsigned long pfn, unsigned long addr, unsigned long size)
 947 {
 948         resource_size_t paddr = (resource_size_t)pfn << PAGE_SHIFT;
 949         enum page_cache_mode pcm;
 950
 951         /* reserve the whole chunk starting from paddr */
 952         if (addr == vma->vm_start && size == (vma->vm_end - vma->vm_start)) {
 953                 int ret;
 954
 955                 ret = reserve_pfn_range(paddr, size, prot, 0);
 956                 if (!ret)
 957                         vma->vm_flags |= VM_PAT;
 958                 return ret;
 959         }
 960
 961         if (!pat_enabled())
 962                 return 0;
 963
 964         /*
 965          * For anything smaller than the vma size we set prot based on the
 966          * lookup.
 967          */
 968         pcm = lookup_memtype(paddr);
 969
 970         /* Check memtype for the remaining pages */
 971         while (size > PAGE_SIZE) {
 972                 size -= PAGE_SIZE;
 973                 paddr += PAGE_SIZE;
 974                 if (pcm != lookup_memtype(paddr))
 975                         return -EINVAL;
 976         }
 977
 978         *prot = __pgprot((pgprot_val(vma->vm_page_prot) & (~_PAGE_CACHE_MASK)) |
 979                          cachemode2protval(pcm));
 980
 981         return 0;
 982 }
 983
 984 int track_pfn_insert(struct vm_area_struct *vma, pgprot_t *prot,
 985                      unsigned long pfn)
 986 {
 987         enum page_cache_mode pcm;
 988
 989         if (!pat_enabled())
 990                 return 0;
 991
 992         /* Set prot based on lookup */
 993         pcm = lookup_memtype((resource_size_t)pfn << PAGE_SHIFT);
 994         *prot = __pgprot((pgprot_val(vma->vm_page_prot) & (~_PAGE_CACHE_MASK)) |
 995                          cachemode2protval(pcm));
 996
 997         return 0;
 998 }
 999
1000 /*
1001  * untrack_pfn is called while unmapping a pfnmap for a region.
1002  * untrack can be called for a specific region indicated by pfn and size or
1003  * can be for the entire vma (in which case pfn, size are zero).
1004  */
1005 void untrack_pfn(struct vm_area_struct *vma, unsigned long pfn,
1006                  unsigned long size)
1007 {
1008         resource_size_t paddr;
1009         unsigned long prot;
1010
1011         if (!(vma->vm_flags & VM_PAT))
1012                 return;
1013
1014         /* free the chunk starting from pfn or the whole chunk */
1015         paddr = (resource_size_t)pfn << PAGE_SHIFT;
1016         if (!paddr && !size) {
1017                 if (follow_phys(vma, vma->vm_start, 0, &prot, &paddr)) {
1018                         WARN_ON_ONCE(1);
1019                         return;
1020                 }
1021
1022                 size = vma->vm_end - vma->vm_start;
1023         }
1024         free_pfn_range(paddr, size);
1025         vma->vm_flags &= ~VM_PAT;
1026 }
1027
1028 pgprot_t pgprot_writecombine(pgprot_t prot)
1029 {
1030         return __pgprot(pgprot_val(prot) |
1031                                 cachemode2protval(_PAGE_CACHE_MODE_WC));
1032 }
1033 EXPORT_SYMBOL_GPL(pgprot_writecombine);
1034
1035 pgprot_t pgprot_writethrough(pgprot_t prot)
1036 {
1037         return __pgprot(pgprot_val(prot) |
1038                                 cachemode2protval(_PAGE_CACHE_MODE_WT));
1039 }
1040 EXPORT_SYMBOL_GPL(pgprot_writethrough);
1041
1042 #if defined(CONFIG_DEBUG_FS) && defined(CONFIG_X86_PAT)
1043
1044 static struct memtype *memtype_get_idx(loff_t pos)
1045 {
1046         struct memtype *print_entry;
1047         int ret;
1048
1049         print_entry  = kzalloc(sizeof(struct memtype), GFP_KERNEL);
1050         if (!print_entry)
1051                 return NULL;
1052
1053         spin_lock(&memtype_lock);
1054         ret = rbt_memtype_copy_nth_element(print_entry, pos);
1055         spin_unlock(&memtype_lock);
1056
1057         if (!ret) {
1058                 return print_entry;
1059         } else {
1060                 kfree(print_entry);
1061                 return NULL;
1062         }
1063 }
1064
1065 static void *memtype_seq_start(struct seq_file *seq, loff_t *pos)
1066 {
1067         if (*pos == 0) {
1068                 ++*pos;
1069                 seq_puts(seq, "PAT memtype list:\n");
1070         }
1071
1072         return memtype_get_idx(*pos);
1073 }
1074
1075 static void *memtype_seq_next(struct seq_file *seq, void *v, loff_t *pos)
1076 {
1077         ++*pos;
1078         return memtype_get_idx(*pos);
1079 }
1080
1081 static void memtype_seq_stop(struct seq_file *seq, void *v)
1082 {
1083 }
1084
1085 static int memtype_seq_show(struct seq_file *seq, void *v)
1086 {
1087         struct memtype *print_entry = (struct memtype *)v;
1088
1089         seq_printf(seq, "%s @ 0x%Lx-0x%Lx\n", cattr_name(print_entry->type),
1090                         print_entry->start, print_entry->end);
1091         kfree(print_entry);
1092
1093         return 0;
1094 }
1095
1096 static const struct seq_operations memtype_seq_ops = {
1097         .start = memtype_seq_start,
1098         .next  = memtype_seq_next,
1099         .stop  = memtype_seq_stop,
1100         .show  = memtype_seq_show,
1101 };
1102
1103 static int memtype_seq_open(struct inode *inode, struct file *file)
1104 {
1105         return seq_open(file, &memtype_seq_ops);
1106 }
1107
1108 static const struct file_operations memtype_fops = {
1109         .open    = memtype_seq_open,
1110         .read    = seq_read,
1111         .llseek  = seq_lseek,
1112         .release = seq_release,
1113 };
1114
1115 static int __init pat_memtype_list_init(void)
1116 {
1117         if (pat_enabled()) {
1118                 debugfs_create_file("pat_memtype_list", S_IRUSR,
1119                                     arch_debugfs_dir, NULL, &memtype_fops);
1120         }
1121         return 0;
1122 }
1123
1124 late_initcall(pat_memtype_list_init);
1125
1126 #endif /* CONFIG_DEBUG_FS && CONFIG_X86_PAT */