added a lot of printk output to ease writing of emulator
[linux-2.4.21-pre4.git] / include / asm-ia64 / pgtable.h
1 #ifndef _ASM_IA64_PGTABLE_H
2 #define _ASM_IA64_PGTABLE_H
3
4 /*
5  * This file contains the functions and defines necessary to modify and use
6  * the IA-64 page table tree.
7  *
8  * This hopefully works with any (fixed) IA-64 page-size, as defined
9  * in <asm/page.h> (currently 8192).
10  *
11  * Copyright (C) 1998-2002 Hewlett-Packard Co
12  *      David Mosberger-Tang <davidm@hpl.hp.com>
13  */
14
15 #include <linux/config.h>
16
17 #include <asm/mman.h>
18 #include <asm/page.h>
19 #include <asm/processor.h>
20 #include <asm/system.h>
21 #include <asm/types.h>
22
23 #define IA64_MAX_PHYS_BITS      50      /* max. number of physical address bits (architected) */
24
25 /*
26  * First, define the various bits in a PTE.  Note that the PTE format
27  * matches the VHPT short format, the firt doubleword of the VHPD long
28  * format, and the first doubleword of the TLB insertion format.
29  */
30 #define _PAGE_P_BIT             0
31 #define _PAGE_A_BIT             5
32 #define _PAGE_D_BIT             6
33
34 #define _PAGE_P                 (1 << _PAGE_P_BIT)      /* page present bit */
35 #define _PAGE_MA_WB             (0x0 <<  2)     /* write back memory attribute */
36 #define _PAGE_MA_UC             (0x4 <<  2)     /* uncacheable memory attribute */
37 #define _PAGE_MA_UCE            (0x5 <<  2)     /* UC exported attribute */
38 #define _PAGE_MA_WC             (0x6 <<  2)     /* write coalescing memory attribute */
39 #define _PAGE_MA_NAT            (0x7 <<  2)     /* not-a-thing attribute */
40 #define _PAGE_MA_MASK           (0x7 <<  2)
41 #define _PAGE_PL_0              (0 <<  7)       /* privilege level 0 (kernel) */
42 #define _PAGE_PL_1              (1 <<  7)       /* privilege level 1 (unused) */
43 #define _PAGE_PL_2              (2 <<  7)       /* privilege level 2 (unused) */
44 #define _PAGE_PL_3              (3 <<  7)       /* privilege level 3 (user) */
45 #define _PAGE_PL_MASK           (3 <<  7)
46 #define _PAGE_AR_R              (0 <<  9)       /* read only */
47 #define _PAGE_AR_RX             (1 <<  9)       /* read & execute */
48 #define _PAGE_AR_RW             (2 <<  9)       /* read & write */
49 #define _PAGE_AR_RWX            (3 <<  9)       /* read, write & execute */
50 #define _PAGE_AR_R_RW           (4 <<  9)       /* read / read & write */
51 #define _PAGE_AR_RX_RWX         (5 <<  9)       /* read & exec / read, write & exec */
52 #define _PAGE_AR_RWX_RW         (6 <<  9)       /* read, write & exec / read & write */
53 #define _PAGE_AR_X_RX           (7 <<  9)       /* exec & promote / read & exec */
54 #define _PAGE_AR_MASK           (7 <<  9)
55 #define _PAGE_AR_SHIFT          9
56 #define _PAGE_A                 (1 << _PAGE_A_BIT)      /* page accessed bit */
57 #define _PAGE_D                 (1 << _PAGE_D_BIT)      /* page dirty bit */
58 #define _PAGE_PPN_MASK          (((__IA64_UL(1) << IA64_MAX_PHYS_BITS) - 1) & ~0xfffUL)
59 #define _PAGE_ED                (__IA64_UL(1) << 52)    /* exception deferral */
60 #define _PAGE_PROTNONE          (__IA64_UL(1) << 63)
61
62 #define _PFN_MASK               _PAGE_PPN_MASK
63 #define _PAGE_CHG_MASK          (_PFN_MASK | _PAGE_A | _PAGE_D)
64
65 #define _PAGE_SIZE_4K   12
66 #define _PAGE_SIZE_8K   13
67 #define _PAGE_SIZE_16K  14
68 #define _PAGE_SIZE_64K  16
69 #define _PAGE_SIZE_256K 18
70 #define _PAGE_SIZE_1M   20
71 #define _PAGE_SIZE_4M   22
72 #define _PAGE_SIZE_16M  24
73 #define _PAGE_SIZE_64M  26
74 #define _PAGE_SIZE_256M 28
75
76 #define __ACCESS_BITS           _PAGE_ED | _PAGE_A | _PAGE_P | _PAGE_MA_WB
77 #define __DIRTY_BITS_NO_ED      _PAGE_A | _PAGE_P | _PAGE_D | _PAGE_MA_WB
78 #define __DIRTY_BITS            _PAGE_ED | __DIRTY_BITS_NO_ED
79
80 /*
81  * Definitions for first level:
82  *
83  * PGDIR_SHIFT determines what a first-level page table entry can map.
84  */
85 #define PGDIR_SHIFT             (PAGE_SHIFT + 2*(PAGE_SHIFT-3))
86 #define PGDIR_SIZE              (__IA64_UL(1) << PGDIR_SHIFT)
87 #define PGDIR_MASK              (~(PGDIR_SIZE-1))
88 #define PTRS_PER_PGD            (__IA64_UL(1) << (PAGE_SHIFT-3))
89 #define USER_PTRS_PER_PGD       (5*PTRS_PER_PGD/8)      /* regions 0-4 are user regions */
90 #define FIRST_USER_PGD_NR       0
91
92 /*
93  * Definitions for second level:
94  *
95  * PMD_SHIFT determines the size of the area a second-level page table
96  * can map.
97  */
98 #define PMD_SHIFT       (PAGE_SHIFT + (PAGE_SHIFT-3))
99 #define PMD_SIZE        (__IA64_UL(1) << PMD_SHIFT)
100 #define PMD_MASK        (~(PMD_SIZE-1))
101 #define PTRS_PER_PMD    (__IA64_UL(1) << (PAGE_SHIFT-3))
102
103 /*
104  * Definitions for third level:
105  */
106 #define PTRS_PER_PTE    (__IA64_UL(1) << (PAGE_SHIFT-3))
107
108 /*
109  * All the normal masks have the "page accessed" bits on, as any time
110  * they are used, the page is accessed. They are cleared only by the
111  * page-out routines.
112  */
113 #define PAGE_NONE       __pgprot(_PAGE_PROTNONE | _PAGE_A)
114 #define PAGE_SHARED     __pgprot(__ACCESS_BITS | _PAGE_PL_3 | _PAGE_AR_RW)
115 #define PAGE_READONLY   __pgprot(__ACCESS_BITS | _PAGE_PL_3 | _PAGE_AR_R)
116 #define PAGE_COPY       __pgprot(__ACCESS_BITS | _PAGE_PL_3 | _PAGE_AR_RX)
117 #define PAGE_GATE       __pgprot(__ACCESS_BITS | _PAGE_PL_0 | _PAGE_AR_X_RX)
118 #define PAGE_KERNEL     __pgprot(__DIRTY_BITS  | _PAGE_PL_0 | _PAGE_AR_RWX)
119 #define PAGE_KERNELRX   __pgprot(__ACCESS_BITS | _PAGE_PL_0 | _PAGE_AR_RX)
120
121 # ifndef __ASSEMBLY__
122
123 #include <asm/bitops.h>
124 #include <asm/mmu_context.h>
125 #include <asm/processor.h>
126
127 /*
128  * Next come the mappings that determine how mmap() protection bits
129  * (PROT_EXEC, PROT_READ, PROT_WRITE, PROT_NONE) get implemented.  The
130  * _P version gets used for a private shared memory segment, the _S
131  * version gets used for a shared memory segment with MAP_SHARED on.
132  * In a private shared memory segment, we do a copy-on-write if a task
133  * attempts to write to the page.
134  */
135         /* xwr */
136 #define __P000  PAGE_NONE
137 #define __P001  PAGE_READONLY
138 #define __P010  PAGE_READONLY   /* write to priv pg -> copy & make writable */
139 #define __P011  PAGE_READONLY   /* ditto */
140 #define __P100  __pgprot(__ACCESS_BITS | _PAGE_PL_3 | _PAGE_AR_X_RX)
141 #define __P101  __pgprot(__ACCESS_BITS | _PAGE_PL_3 | _PAGE_AR_RX)
142 #define __P110  PAGE_COPY
143 #define __P111  PAGE_COPY
144
145 #define __S000  PAGE_NONE
146 #define __S001  PAGE_READONLY
147 #define __S010  PAGE_SHARED     /* we don't have (and don't need) write-only */
148 #define __S011  PAGE_SHARED
149 #define __S100  __pgprot(__ACCESS_BITS | _PAGE_PL_3 | _PAGE_AR_X_RX)
150 #define __S101  __pgprot(__ACCESS_BITS | _PAGE_PL_3 | _PAGE_AR_RX)
151 #define __S110  __pgprot(__ACCESS_BITS | _PAGE_PL_3 | _PAGE_AR_RWX)
152 #define __S111  __pgprot(__ACCESS_BITS | _PAGE_PL_3 | _PAGE_AR_RWX)
153
154 #define pgd_ERROR(e)    printk("%s:%d: bad pgd %016lx.\n", __FILE__, __LINE__, pgd_val(e))
155 #define pmd_ERROR(e)    printk("%s:%d: bad pmd %016lx.\n", __FILE__, __LINE__, pmd_val(e))
156 #define pte_ERROR(e)    printk("%s:%d: bad pte %016lx.\n", __FILE__, __LINE__, pte_val(e))
157
158
159 /* Quick test to see if ADDR is a (potentially) valid physical address. */
160 static inline long
161 ia64_phys_addr_valid (unsigned long addr)
162 {
163         return (addr & (local_cpu_data->unimpl_pa_mask)) == 0;
164 }
165
166 #ifndef CONFIG_DISCONTIGMEM
167 /*
168  * kern_addr_valid(ADDR) tests if ADDR is pointing to valid kernel
169  * memory.  For the return value to be meaningful, ADDR must be >=
170  * PAGE_OFFSET.  This operation can be relatively expensive (e.g.,
171  * require a hash-, or multi-level tree-lookup or something of that
172  * sort) but it guarantees to return TRUE only if accessing the page
173  * at that address does not cause an error.  Note that there may be
174  * addresses for which kern_addr_valid() returns FALSE even though an
175  * access would not cause an error (e.g., this is typically true for
176  * memory mapped I/O regions.
177  *
178  * XXX Need to implement this for IA-64.
179  */
180 #define kern_addr_valid(addr)   (1)
181
182 #endif
183
184 /*
185  * Now come the defines and routines to manage and access the three-level
186  * page table.
187  */
188
189 /*
190  * On some architectures, special things need to be done when setting
191  * the PTE in a page table.  Nothing special needs to be on IA-64.
192  */
193 #define set_pte(ptep, pteval)   (*(ptep) = (pteval))
194
195 #define RGN_SIZE        (1UL << 61)
196 #define RGN_MAP_LIMIT   ((1UL << (4*PAGE_SHIFT - 12)) - PAGE_SIZE)      /* per region addr limit */
197 #define RGN_KERNEL      7
198
199 #define VMALLOC_START           (0xa000000000000000 + 3*PAGE_SIZE)
200 #define VMALLOC_VMADDR(x)       ((unsigned long)(x))
201 #define VMALLOC_END_INIT        (0xa000000000000000 + (1UL << (4*PAGE_SHIFT - 9))) 
202 #define VMALLOC_END             vmalloc_end
203 extern unsigned long vmalloc_end;
204
205 /*
206  * Conversion functions: convert a page and protection to a page entry,
207  * and a page entry and page directory to the page they refer to.
208  */
209 #define mk_pte(page,pgprot)                                                     \
210 ({                                                                              \
211         pte_t __pte;                                                            \
212                                                                                 \
213         pte_val(__pte) = ((page - mem_map) << PAGE_SHIFT) | pgprot_val(pgprot); \
214         __pte;                                                                  \
215 })
216
217 /* This takes a physical page address that is used by the remapping functions */
218 #define mk_pte_phys(physpage, pgprot) \
219 ({ pte_t __pte; pte_val(__pte) = physpage + pgprot_val(pgprot); __pte; })
220
221 #define pte_modify(_pte, newprot) \
222         (__pte((pte_val(_pte) & _PAGE_CHG_MASK) | pgprot_val(newprot)))
223
224 #define page_pte_prot(page,prot)        mk_pte(page, prot)
225 #define page_pte(page)                  page_pte_prot(page, __pgprot(0))
226
227 #define pte_none(pte)                   (!pte_val(pte))
228 #define pte_present(pte)                (pte_val(pte) & (_PAGE_P | _PAGE_PROTNONE))
229 #define pte_clear(pte)                  (pte_val(*(pte)) = 0UL)
230 #ifndef CONFIG_DISCONTIGMEM
231 /* pte_page() returns the "struct page *" corresponding to the PTE: */
232 #define pte_page(pte)                   (mem_map + (unsigned long) ((pte_val(pte) & _PFN_MASK) >> PAGE_SHIFT))
233 #endif
234
235 #define pmd_none(pmd)                   (!pmd_val(pmd))
236 #define pmd_bad(pmd)                    (!ia64_phys_addr_valid(pmd_val(pmd)))
237 #define pmd_present(pmd)                (pmd_val(pmd) != 0UL)
238 #define pmd_clear(pmdp)                 (pmd_val(*(pmdp)) = 0UL)
239 #define pmd_page(pmd)                   ((unsigned long) __va(pmd_val(pmd) & _PFN_MASK))
240
241 #define pgd_none(pgd)                   (!pgd_val(pgd))
242 #define pgd_bad(pgd)                    (!ia64_phys_addr_valid(pgd_val(pgd)))
243 #define pgd_present(pgd)                (pgd_val(pgd) != 0UL)
244 #define pgd_clear(pgdp)                 (pgd_val(*(pgdp)) = 0UL)
245 #define pgd_page(pgd)                   ((unsigned long) __va(pgd_val(pgd) & _PFN_MASK))
246
247 /*
248  * The following have defined behavior only work if pte_present() is true.
249  */
250 #define pte_read(pte)           (((pte_val(pte) & _PAGE_AR_MASK) >> _PAGE_AR_SHIFT) < 6)
251 #define pte_write(pte)  ((unsigned) (((pte_val(pte) & _PAGE_AR_MASK) >> _PAGE_AR_SHIFT) - 2) <= 4)
252 #define pte_exec(pte)           ((pte_val(pte) & _PAGE_AR_RX) != 0)
253 #define pte_dirty(pte)          ((pte_val(pte) & _PAGE_D) != 0)
254 #define pte_young(pte)          ((pte_val(pte) & _PAGE_A) != 0)
255 /*
256  * Note: we convert AR_RWX to AR_RX and AR_RW to AR_R by clearing the 2nd bit in the
257  * access rights:
258  */
259 #define pte_wrprotect(pte)      (__pte(pte_val(pte) & ~_PAGE_AR_RW))
260 #define pte_mkwrite(pte)        (__pte(pte_val(pte) | _PAGE_AR_RW))
261 #define pte_mkexec(pte)         (__pte(pte_val(pte) | _PAGE_AR_RX))
262 #define pte_mkold(pte)          (__pte(pte_val(pte) & ~_PAGE_A))
263 #define pte_mkyoung(pte)        (__pte(pte_val(pte) | _PAGE_A))
264 #define pte_mkclean(pte)        (__pte(pte_val(pte) & ~_PAGE_D))
265 #define pte_mkdirty(pte)        (__pte(pte_val(pte) | _PAGE_D))
266
267 /*
268  * Macro to make mark a page protection value as "uncacheable".  Note
269  * that "protection" is really a misnomer here as the protection value
270  * contains the memory attribute bits, dirty bits, and various other
271  * bits as well.
272  */
273 #define pgprot_noncached(prot)          __pgprot((pgprot_val(prot) & ~_PAGE_MA_MASK) | _PAGE_MA_UC)
274
275 /*
276  * Macro to make mark a page protection value as "write-combining".
277  * Note that "protection" is really a misnomer here as the protection
278  * value contains the memory attribute bits, dirty bits, and various
279  * other bits as well.  Accesses through a write-combining translation
280  * works bypasses the caches, but does allow for consecutive writes to
281  * be combined into single (but larger) write transactions.
282  */
283 #define pgprot_writecombine(prot)       __pgprot((pgprot_val(prot) & ~_PAGE_MA_MASK) | _PAGE_MA_WC)
284
285 /*
286  * Return the region index for virtual address ADDRESS.
287  */
288 static inline unsigned long
289 rgn_index (unsigned long address)
290 {
291         ia64_va a;
292
293         a.l = address;
294         return a.f.reg;
295 }
296
297 /*
298  * Return the region offset for virtual address ADDRESS.
299  */
300 static inline unsigned long
301 rgn_offset (unsigned long address)
302 {
303         ia64_va a;
304
305         a.l = address;
306         return a.f.off;
307 }
308
309 static inline unsigned long
310 pgd_index (unsigned long address)
311 {
312         unsigned long region = address >> 61;
313         unsigned long l1index = (address >> PGDIR_SHIFT) & ((PTRS_PER_PGD >> 3) - 1);
314
315         return (region << (PAGE_SHIFT - 6)) | l1index;
316 }
317
318 /* The offset in the 1-level directory is given by the 3 region bits
319    (61..63) and the seven level-1 bits (33-39).  */
320 static inline pgd_t*
321 pgd_offset (struct mm_struct *mm, unsigned long address)
322 {
323         return mm->pgd + pgd_index(address);
324 }
325
326 /* In the kernel's mapped region we have a full 43 bit space available and completely
327    ignore the region number (since we know its in region number 5). */
328 #define pgd_offset_k(addr) \
329         (init_mm.pgd + (((addr) >> PGDIR_SHIFT) & (PTRS_PER_PGD - 1)))
330
331 /* Find an entry in the second-level page table.. */
332 #define pmd_offset(dir,addr) \
333         ((pmd_t *) pgd_page(*(dir)) + (((addr) >> PMD_SHIFT) & (PTRS_PER_PMD - 1)))
334
335 /* Find an entry in the third-level page table.. */
336 #define pte_offset(dir,addr) \
337         ((pte_t *) pmd_page(*(dir)) + (((addr) >> PAGE_SHIFT) & (PTRS_PER_PTE - 1)))
338
339 /* atomic versions of the some PTE manipulations: */
340
341 static inline int
342 ptep_test_and_clear_young (pte_t *ptep)
343 {
344 #ifdef CONFIG_SMP
345         return test_and_clear_bit(_PAGE_A_BIT, ptep);
346 #else
347         pte_t pte = *ptep;
348         if (!pte_young(pte))
349                 return 0;
350         set_pte(ptep, pte_mkold(pte));
351         return 1;
352 #endif
353 }
354
355 static inline int
356 ptep_test_and_clear_dirty (pte_t *ptep)
357 {
358 #ifdef CONFIG_SMP
359         return test_and_clear_bit(_PAGE_D_BIT, ptep);
360 #else
361         pte_t pte = *ptep;
362         if (!pte_dirty(pte))
363                 return 0;
364         set_pte(ptep, pte_mkclean(pte));
365         return 1;
366 #endif
367 }
368
369 static inline pte_t
370 ptep_get_and_clear (pte_t *ptep)
371 {
372 #ifdef CONFIG_SMP
373         return __pte(xchg((long *) ptep, 0));
374 #else
375         pte_t pte = *ptep;
376         pte_clear(ptep);
377         return pte;
378 #endif
379 }
380
381 static inline void
382 ptep_set_wrprotect (pte_t *ptep)
383 {
384 #ifdef CONFIG_SMP
385         unsigned long new, old;
386
387         do {
388                 old = pte_val(*ptep);
389                 new = pte_val(pte_wrprotect(__pte (old)));
390         } while (cmpxchg((unsigned long *) ptep, old, new) != old);
391 #else
392         pte_t old_pte = *ptep;
393         set_pte(ptep, pte_wrprotect(old_pte));
394 #endif
395 }
396
397 static inline void
398 ptep_mkdirty (pte_t *ptep)
399 {
400 #ifdef CONFIG_SMP
401         set_bit(_PAGE_D_BIT, ptep);
402 #else
403         pte_t old_pte = *ptep;
404         set_pte(ptep, pte_mkdirty(old_pte));
405 #endif
406 }
407
408 static inline int
409 pte_same (pte_t a, pte_t b)
410 {
411         return pte_val(a) == pte_val(b);
412 }
413
414 extern pgd_t swapper_pg_dir[PTRS_PER_PGD];
415 extern void paging_init (void);
416
417 #define SWP_TYPE(entry)                 (((entry).val >> 1) & 0xff)
418 #define SWP_OFFSET(entry)               (((entry).val << 1) >> 10)
419 #define SWP_ENTRY(type,offset)          ((swp_entry_t) { ((type) << 1) | ((long) (offset) << 9) })
420 #define pte_to_swp_entry(pte)           ((swp_entry_t) { pte_val(pte) })
421 #define swp_entry_to_pte(x)             ((pte_t) { (x).val })
422
423 /* Needs to be defined here and not in linux/mm.h, as it is arch dependent */
424 #define PageSkip(page)          (0)
425
426 #define io_remap_page_range remap_page_range    /* XXX is this right? */
427
428 /*
429  * ZERO_PAGE is a global shared page that is always zero: used
430  * for zero-mapped memory areas etc..
431  */
432 extern unsigned long empty_zero_page[PAGE_SIZE/sizeof(unsigned long)];
433 #define ZERO_PAGE(vaddr) (virt_to_page(empty_zero_page))
434
435 /* We provide our own get_unmapped_area to cope with VA holes for userland */
436 #define HAVE_ARCH_UNMAPPED_AREA
437
438 /*
439  * No page table caches to initialise
440  */
441 #define pgtable_cache_init()    do { } while (0)
442
443 /* arch mem_map init routines are needed due to holes in a virtual mem_map */
444 #define HAVE_ARCH_MEMMAP_INIT
445
446 typedef unsigned long memmap_init_callback_t(struct page *start,
447         struct page *end, int zone, unsigned long start_paddr, int highmem);
448
449 extern unsigned long arch_memmap_init (memmap_init_callback_t *callback,
450         struct page *start, struct page *end, int zone,
451         unsigned long start_paddr, int highmem);
452
453 # endif /* !__ASSEMBLY__ */
454
455 /*
456  * Identity-mapped regions use a large page size.  We'll call such large pages
457  * "granules".  If you can think of a better name that's unambiguous, let me
458  * know...
459  */
460 #if defined(CONFIG_IA64_GRANULE_64MB)
461 # define IA64_GRANULE_SHIFT     _PAGE_SIZE_64M
462 #elif defined(CONFIG_IA64_GRANULE_16MB)
463 # define IA64_GRANULE_SHIFT     _PAGE_SIZE_16M
464 #endif
465 #define IA64_GRANULE_SIZE       (1 << IA64_GRANULE_SHIFT)
466 /*
467  * log2() of the page size we use to map the kernel image (IA64_TR_KERNEL):
468  */
469 #define KERNEL_TR_PAGE_SHIFT    _PAGE_SIZE_64M
470 #define KERNEL_TR_PAGE_SIZE     (1 << KERNEL_TR_PAGE_SHIFT)
471 #define KERNEL_TR_PAGE_NUM      ((KERNEL_START - PAGE_OFFSET) / KERNEL_TR_PAGE_SIZE)
472
473 #endif /* _ASM_IA64_PGTABLE_H */