Split pgtable.h into pgtable_types.h and pgtable.h
[linux-2.6] / arch / x86 / include / asm / pgtable.h
1 #ifndef _ASM_X86_PGTABLE_H
2 #define _ASM_X86_PGTABLE_H
3
4 #include <asm/page.h>
5
6 #include <asm/pgtable_types.h>
7
8 /*
9  * Macro to mark a page protection value as UC-
10  */
11 #define pgprot_noncached(prot)                                  \
12         ((boot_cpu_data.x86 > 3)                                \
13          ? (__pgprot(pgprot_val(prot) | _PAGE_CACHE_UC_MINUS))  \
14          : (prot))
15
16 #ifndef __ASSEMBLY__
17
18 /*
19  * ZERO_PAGE is a global shared page that is always zero: used
20  * for zero-mapped memory areas etc..
21  */
22 extern unsigned long empty_zero_page[PAGE_SIZE / sizeof(unsigned long)];
23 #define ZERO_PAGE(vaddr) (virt_to_page(empty_zero_page))
24
25 extern spinlock_t pgd_lock;
26 extern struct list_head pgd_list;
27
28 /*
29  * The following only work if pte_present() is true.
30  * Undefined behaviour if not..
31  */
32 static inline int pte_dirty(pte_t pte)
33 {
34         return pte_flags(pte) & _PAGE_DIRTY;
35 }
36
37 static inline int pte_young(pte_t pte)
38 {
39         return pte_flags(pte) & _PAGE_ACCESSED;
40 }
41
42 static inline int pte_write(pte_t pte)
43 {
44         return pte_flags(pte) & _PAGE_RW;
45 }
46
47 static inline int pte_file(pte_t pte)
48 {
49         return pte_flags(pte) & _PAGE_FILE;
50 }
51
52 static inline int pte_huge(pte_t pte)
53 {
54         return pte_flags(pte) & _PAGE_PSE;
55 }
56
57 static inline int pte_global(pte_t pte)
58 {
59         return pte_flags(pte) & _PAGE_GLOBAL;
60 }
61
62 static inline int pte_exec(pte_t pte)
63 {
64         return !(pte_flags(pte) & _PAGE_NX);
65 }
66
67 static inline int pte_special(pte_t pte)
68 {
69         return pte_flags(pte) & _PAGE_SPECIAL;
70 }
71
72 static inline unsigned long pte_pfn(pte_t pte)
73 {
74         return (pte_val(pte) & PTE_PFN_MASK) >> PAGE_SHIFT;
75 }
76
77 #define pte_page(pte)   pfn_to_page(pte_pfn(pte))
78
79 static inline int pmd_large(pmd_t pte)
80 {
81         return (pmd_flags(pte) & (_PAGE_PSE | _PAGE_PRESENT)) ==
82                 (_PAGE_PSE | _PAGE_PRESENT);
83 }
84
85 static inline pte_t pte_set_flags(pte_t pte, pteval_t set)
86 {
87         pteval_t v = native_pte_val(pte);
88
89         return native_make_pte(v | set);
90 }
91
92 static inline pte_t pte_clear_flags(pte_t pte, pteval_t clear)
93 {
94         pteval_t v = native_pte_val(pte);
95
96         return native_make_pte(v & ~clear);
97 }
98
99 static inline pte_t pte_mkclean(pte_t pte)
100 {
101         return pte_clear_flags(pte, _PAGE_DIRTY);
102 }
103
104 static inline pte_t pte_mkold(pte_t pte)
105 {
106         return pte_clear_flags(pte, _PAGE_ACCESSED);
107 }
108
109 static inline pte_t pte_wrprotect(pte_t pte)
110 {
111         return pte_clear_flags(pte, _PAGE_RW);
112 }
113
114 static inline pte_t pte_mkexec(pte_t pte)
115 {
116         return pte_clear_flags(pte, _PAGE_NX);
117 }
118
119 static inline pte_t pte_mkdirty(pte_t pte)
120 {
121         return pte_set_flags(pte, _PAGE_DIRTY);
122 }
123
124 static inline pte_t pte_mkyoung(pte_t pte)
125 {
126         return pte_set_flags(pte, _PAGE_ACCESSED);
127 }
128
129 static inline pte_t pte_mkwrite(pte_t pte)
130 {
131         return pte_set_flags(pte, _PAGE_RW);
132 }
133
134 static inline pte_t pte_mkhuge(pte_t pte)
135 {
136         return pte_set_flags(pte, _PAGE_PSE);
137 }
138
139 static inline pte_t pte_clrhuge(pte_t pte)
140 {
141         return pte_clear_flags(pte, _PAGE_PSE);
142 }
143
144 static inline pte_t pte_mkglobal(pte_t pte)
145 {
146         return pte_set_flags(pte, _PAGE_GLOBAL);
147 }
148
149 static inline pte_t pte_clrglobal(pte_t pte)
150 {
151         return pte_clear_flags(pte, _PAGE_GLOBAL);
152 }
153
154 static inline pte_t pte_mkspecial(pte_t pte)
155 {
156         return pte_set_flags(pte, _PAGE_SPECIAL);
157 }
158
159 static inline pte_t pfn_pte(unsigned long page_nr, pgprot_t pgprot)
160 {
161         return __pte((((phys_addr_t)page_nr << PAGE_SHIFT) |
162                       pgprot_val(pgprot)) & __supported_pte_mask);
163 }
164
165 static inline pmd_t pfn_pmd(unsigned long page_nr, pgprot_t pgprot)
166 {
167         return __pmd((((phys_addr_t)page_nr << PAGE_SHIFT) |
168                       pgprot_val(pgprot)) & __supported_pte_mask);
169 }
170
171 static inline pte_t pte_modify(pte_t pte, pgprot_t newprot)
172 {
173         pteval_t val = pte_val(pte);
174
175         /*
176          * Chop off the NX bit (if present), and add the NX portion of
177          * the newprot (if present):
178          */
179         val &= _PAGE_CHG_MASK;
180         val |= pgprot_val(newprot) & (~_PAGE_CHG_MASK) & __supported_pte_mask;
181
182         return __pte(val);
183 }
184
185 /* mprotect needs to preserve PAT bits when updating vm_page_prot */
186 #define pgprot_modify pgprot_modify
187 static inline pgprot_t pgprot_modify(pgprot_t oldprot, pgprot_t newprot)
188 {
189         pgprotval_t preservebits = pgprot_val(oldprot) & _PAGE_CHG_MASK;
190         pgprotval_t addbits = pgprot_val(newprot);
191         return __pgprot(preservebits | addbits);
192 }
193
194 #define pte_pgprot(x) __pgprot(pte_flags(x) & PTE_FLAGS_MASK)
195
196 #define canon_pgprot(p) __pgprot(pgprot_val(p) & __supported_pte_mask)
197
198 static inline int is_new_memtype_allowed(unsigned long flags,
199                                                 unsigned long new_flags)
200 {
201         /*
202          * Certain new memtypes are not allowed with certain
203          * requested memtype:
204          * - request is uncached, return cannot be write-back
205          * - request is write-combine, return cannot be write-back
206          */
207         if ((flags == _PAGE_CACHE_UC_MINUS &&
208              new_flags == _PAGE_CACHE_WB) ||
209             (flags == _PAGE_CACHE_WC &&
210              new_flags == _PAGE_CACHE_WB)) {
211                 return 0;
212         }
213
214         return 1;
215 }
216
217 #ifdef CONFIG_PARAVIRT
218 #include <asm/paravirt.h>
219 #else  /* !CONFIG_PARAVIRT */
220 #define set_pte(ptep, pte)              native_set_pte(ptep, pte)
221 #define set_pte_at(mm, addr, ptep, pte) native_set_pte_at(mm, addr, ptep, pte)
222
223 #define set_pte_present(mm, addr, ptep, pte)                            \
224         native_set_pte_present(mm, addr, ptep, pte)
225 #define set_pte_atomic(ptep, pte)                                       \
226         native_set_pte_atomic(ptep, pte)
227
228 #define set_pmd(pmdp, pmd)              native_set_pmd(pmdp, pmd)
229
230 #ifndef __PAGETABLE_PUD_FOLDED
231 #define set_pgd(pgdp, pgd)              native_set_pgd(pgdp, pgd)
232 #define pgd_clear(pgd)                  native_pgd_clear(pgd)
233 #endif
234
235 #ifndef set_pud
236 # define set_pud(pudp, pud)             native_set_pud(pudp, pud)
237 #endif
238
239 #ifndef __PAGETABLE_PMD_FOLDED
240 #define pud_clear(pud)                  native_pud_clear(pud)
241 #endif
242
243 #define pte_clear(mm, addr, ptep)       native_pte_clear(mm, addr, ptep)
244 #define pmd_clear(pmd)                  native_pmd_clear(pmd)
245
246 #define pte_update(mm, addr, ptep)              do { } while (0)
247 #define pte_update_defer(mm, addr, ptep)        do { } while (0)
248
249 static inline void __init paravirt_pagetable_setup_start(pgd_t *base)
250 {
251         native_pagetable_setup_start(base);
252 }
253
254 static inline void __init paravirt_pagetable_setup_done(pgd_t *base)
255 {
256         native_pagetable_setup_done(base);
257 }
258 #endif  /* CONFIG_PARAVIRT */
259
260 #endif  /* __ASSEMBLY__ */
261
262 #ifdef CONFIG_X86_32
263 # include "pgtable_32.h"
264 #else
265 # include "pgtable_64.h"
266 #endif
267
268 #ifndef __ASSEMBLY__
269 #include <linux/mm_types.h>
270
271 static inline int pte_none(pte_t pte)
272 {
273         return !pte.pte;
274 }
275
276 #define __HAVE_ARCH_PTE_SAME
277 static inline int pte_same(pte_t a, pte_t b)
278 {
279         return a.pte == b.pte;
280 }
281
282 static inline int pte_present(pte_t a)
283 {
284         return pte_flags(a) & (_PAGE_PRESENT | _PAGE_PROTNONE);
285 }
286
287 static inline int pmd_present(pmd_t pmd)
288 {
289         return pmd_flags(pmd) & _PAGE_PRESENT;
290 }
291
292 static inline int pmd_none(pmd_t pmd)
293 {
294         /* Only check low word on 32-bit platforms, since it might be
295            out of sync with upper half. */
296         return (unsigned long)native_pmd_val(pmd) == 0;
297 }
298
299 static inline unsigned long pmd_page_vaddr(pmd_t pmd)
300 {
301         return (unsigned long)__va(pmd_val(pmd) & PTE_PFN_MASK);
302 }
303
304 /*
305  * Currently stuck as a macro due to indirect forward reference to
306  * linux/mmzone.h's __section_mem_map_addr() definition:
307  */
308 #define pmd_page(pmd)   pfn_to_page(pmd_val(pmd) >> PAGE_SHIFT)
309
310 /*
311  * the pmd page can be thought of an array like this: pmd_t[PTRS_PER_PMD]
312  *
313  * this macro returns the index of the entry in the pmd page which would
314  * control the given virtual address
315  */
316 static inline unsigned pmd_index(unsigned long address)
317 {
318         return (address >> PMD_SHIFT) & (PTRS_PER_PMD - 1);
319 }
320
321 /*
322  * Conversion functions: convert a page and protection to a page entry,
323  * and a page entry and page directory to the page they refer to.
324  *
325  * (Currently stuck as a macro because of indirect forward reference
326  * to linux/mm.h:page_to_nid())
327  */
328 #define mk_pte(page, pgprot)   pfn_pte(page_to_pfn(page), (pgprot))
329
330 /*
331  * the pte page can be thought of an array like this: pte_t[PTRS_PER_PTE]
332  *
333  * this function returns the index of the entry in the pte page which would
334  * control the given virtual address
335  */
336 static inline unsigned pte_index(unsigned long address)
337 {
338         return (address >> PAGE_SHIFT) & (PTRS_PER_PTE - 1);
339 }
340
341 static inline pte_t *pte_offset_kernel(pmd_t *pmd, unsigned long address)
342 {
343         return (pte_t *)pmd_page_vaddr(*pmd) + pte_index(address);
344 }
345
346 static inline int pmd_bad(pmd_t pmd)
347 {
348         return (pmd_flags(pmd) & ~_PAGE_USER) != _KERNPG_TABLE;
349 }
350
351 static inline unsigned long pages_to_mb(unsigned long npg)
352 {
353         return npg >> (20 - PAGE_SHIFT);
354 }
355
356 #define io_remap_pfn_range(vma, vaddr, pfn, size, prot) \
357         remap_pfn_range(vma, vaddr, pfn, size, prot)
358
359 #if PAGETABLE_LEVELS == 2
360 static inline int pud_large(pud_t pud)
361 {
362         return 0;
363 }
364 #endif
365
366 #if PAGETABLE_LEVELS > 2
367 static inline int pud_none(pud_t pud)
368 {
369         return native_pud_val(pud) == 0;
370 }
371
372 static inline int pud_present(pud_t pud)
373 {
374         return pud_flags(pud) & _PAGE_PRESENT;
375 }
376
377 static inline unsigned long pud_page_vaddr(pud_t pud)
378 {
379         return (unsigned long)__va((unsigned long)pud_val(pud) & PTE_PFN_MASK);
380 }
381
382 /*
383  * Currently stuck as a macro due to indirect forward reference to
384  * linux/mmzone.h's __section_mem_map_addr() definition:
385  */
386 #define pud_page(pud)           pfn_to_page(pud_val(pud) >> PAGE_SHIFT)
387
388 /* Find an entry in the second-level page table.. */
389 static inline pmd_t *pmd_offset(pud_t *pud, unsigned long address)
390 {
391         return (pmd_t *)pud_page_vaddr(*pud) + pmd_index(address);
392 }
393
394 static inline unsigned long pmd_pfn(pmd_t pmd)
395 {
396         return (pmd_val(pmd) & PTE_PFN_MASK) >> PAGE_SHIFT;
397 }
398
399 static inline int pud_large(pud_t pud)
400 {
401         return (pud_flags(pud) & (_PAGE_PSE | _PAGE_PRESENT)) ==
402                 (_PAGE_PSE | _PAGE_PRESENT);
403 }
404
405 static inline int pud_bad(pud_t pud)
406 {
407         return (pud_flags(pud) & ~(_KERNPG_TABLE | _PAGE_USER)) != 0;
408 }
409 #endif  /* PAGETABLE_LEVELS > 2 */
410
411 #if PAGETABLE_LEVELS > 3
412 static inline int pgd_present(pgd_t pgd)
413 {
414         return pgd_flags(pgd) & _PAGE_PRESENT;
415 }
416
417 static inline unsigned long pgd_page_vaddr(pgd_t pgd)
418 {
419         return (unsigned long)__va((unsigned long)pgd_val(pgd) & PTE_PFN_MASK);
420 }
421
422 /*
423  * Currently stuck as a macro due to indirect forward reference to
424  * linux/mmzone.h's __section_mem_map_addr() definition:
425  */
426 #define pgd_page(pgd)           pfn_to_page(pgd_val(pgd) >> PAGE_SHIFT)
427
428 /* to find an entry in a page-table-directory. */
429 static inline unsigned pud_index(unsigned long address)
430 {
431         return (address >> PUD_SHIFT) & (PTRS_PER_PUD - 1);
432 }
433
434 static inline pud_t *pud_offset(pgd_t *pgd, unsigned long address)
435 {
436         return (pud_t *)pgd_page_vaddr(*pgd) + pud_index(address);
437 }
438
439 static inline int pgd_bad(pgd_t pgd)
440 {
441         return (pgd_flags(pgd) & ~_PAGE_USER) != _KERNPG_TABLE;
442 }
443
444 static inline int pgd_none(pgd_t pgd)
445 {
446         return !native_pgd_val(pgd);
447 }
448 #endif  /* PAGETABLE_LEVELS > 3 */
449
450 #endif  /* __ASSEMBLY__ */
451
452 /*
453  * the pgd page can be thought of an array like this: pgd_t[PTRS_PER_PGD]
454  *
455  * this macro returns the index of the entry in the pgd page which would
456  * control the given virtual address
457  */
458 #define pgd_index(address) (((address) >> PGDIR_SHIFT) & (PTRS_PER_PGD - 1))
459
460 /*
461  * pgd_offset() returns a (pgd_t *)
462  * pgd_index() is used get the offset into the pgd page's array of pgd_t's;
463  */
464 #define pgd_offset(mm, address) ((mm)->pgd + pgd_index((address)))
465 /*
466  * a shortcut which implies the use of the kernel's pgd, instead
467  * of a process's
468  */
469 #define pgd_offset_k(address) pgd_offset(&init_mm, (address))
470
471
472 #define KERNEL_PGD_BOUNDARY     pgd_index(PAGE_OFFSET)
473 #define KERNEL_PGD_PTRS         (PTRS_PER_PGD - KERNEL_PGD_BOUNDARY)
474
475 #ifndef __ASSEMBLY__
476
477 /* local pte updates need not use xchg for locking */
478 static inline pte_t native_local_ptep_get_and_clear(pte_t *ptep)
479 {
480         pte_t res = *ptep;
481
482         /* Pure native function needs no input for mm, addr */
483         native_pte_clear(NULL, 0, ptep);
484         return res;
485 }
486
487 static inline void native_set_pte_at(struct mm_struct *mm, unsigned long addr,
488                                      pte_t *ptep , pte_t pte)
489 {
490         native_set_pte(ptep, pte);
491 }
492
493 #ifndef CONFIG_PARAVIRT
494 /*
495  * Rules for using pte_update - it must be called after any PTE update which
496  * has not been done using the set_pte / clear_pte interfaces.  It is used by
497  * shadow mode hypervisors to resynchronize the shadow page tables.  Kernel PTE
498  * updates should either be sets, clears, or set_pte_atomic for P->P
499  * transitions, which means this hook should only be called for user PTEs.
500  * This hook implies a P->P protection or access change has taken place, which
501  * requires a subsequent TLB flush.  The notification can optionally be delayed
502  * until the TLB flush event by using the pte_update_defer form of the
503  * interface, but care must be taken to assure that the flush happens while
504  * still holding the same page table lock so that the shadow and primary pages
505  * do not become out of sync on SMP.
506  */
507 #define pte_update(mm, addr, ptep)              do { } while (0)
508 #define pte_update_defer(mm, addr, ptep)        do { } while (0)
509 #endif
510
511 /*
512  * We only update the dirty/accessed state if we set
513  * the dirty bit by hand in the kernel, since the hardware
514  * will do the accessed bit for us, and we don't want to
515  * race with other CPU's that might be updating the dirty
516  * bit at the same time.
517  */
518 struct vm_area_struct;
519
520 #define  __HAVE_ARCH_PTEP_SET_ACCESS_FLAGS
521 extern int ptep_set_access_flags(struct vm_area_struct *vma,
522                                  unsigned long address, pte_t *ptep,
523                                  pte_t entry, int dirty);
524
525 #define __HAVE_ARCH_PTEP_TEST_AND_CLEAR_YOUNG
526 extern int ptep_test_and_clear_young(struct vm_area_struct *vma,
527                                      unsigned long addr, pte_t *ptep);
528
529 #define __HAVE_ARCH_PTEP_CLEAR_YOUNG_FLUSH
530 extern int ptep_clear_flush_young(struct vm_area_struct *vma,
531                                   unsigned long address, pte_t *ptep);
532
533 #define __HAVE_ARCH_PTEP_GET_AND_CLEAR
534 static inline pte_t ptep_get_and_clear(struct mm_struct *mm, unsigned long addr,
535                                        pte_t *ptep)
536 {
537         pte_t pte = native_ptep_get_and_clear(ptep);
538         pte_update(mm, addr, ptep);
539         return pte;
540 }
541
542 #define __HAVE_ARCH_PTEP_GET_AND_CLEAR_FULL
543 static inline pte_t ptep_get_and_clear_full(struct mm_struct *mm,
544                                             unsigned long addr, pte_t *ptep,
545                                             int full)
546 {
547         pte_t pte;
548         if (full) {
549                 /*
550                  * Full address destruction in progress; paravirt does not
551                  * care about updates and native needs no locking
552                  */
553                 pte = native_local_ptep_get_and_clear(ptep);
554         } else {
555                 pte = ptep_get_and_clear(mm, addr, ptep);
556         }
557         return pte;
558 }
559
560 #define __HAVE_ARCH_PTEP_SET_WRPROTECT
561 static inline void ptep_set_wrprotect(struct mm_struct *mm,
562                                       unsigned long addr, pte_t *ptep)
563 {
564         clear_bit(_PAGE_BIT_RW, (unsigned long *)&ptep->pte);
565         pte_update(mm, addr, ptep);
566 }
567
568 /*
569  * clone_pgd_range(pgd_t *dst, pgd_t *src, int count);
570  *
571  *  dst - pointer to pgd range anwhere on a pgd page
572  *  src - ""
573  *  count - the number of pgds to copy.
574  *
575  * dst and src can be on the same page, but the range must not overlap,
576  * and must not cross a page boundary.
577  */
578 static inline void clone_pgd_range(pgd_t *dst, pgd_t *src, int count)
579 {
580        memcpy(dst, src, count * sizeof(pgd_t));
581 }
582
583
584 #include <asm-generic/pgtable.h>
585 #endif  /* __ASSEMBLY__ */
586
587 #endif /* _ASM_X86_PGTABLE_H */