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