arch/x86/mm/pat.c

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