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