Uses kref for struct page
[akaros.git] / kern / include / pmap.h
1 /* See COPYRIGHT for copyright information.
2  * Inlines, macros, and most function prototypes (c) the JOS project.
3  *
4  * Actual implementation:
5  * Copyright (c) 2009 The Regents of the University of California
6  * Barret Rhoden <brho@cs.berkeley.edu>
7  * Kevin Klues <klueska@cs.berkeley.edu> (multiboot functions)
8  * See LICENSE for details.
9  *
10  * Physical memory mangement, low-level virtual address space initialization and
11  * management, and other things related to virtual->physical mappings.
12  */
13
14 #ifndef ROS_KERN_PMAP_H
15 #define ROS_KERN_PMAP_H
16
17 #include <ros/memlayout.h>
18 #include <ros/mman.h>
19 #include <sys/queue.h>
20 #include <multiboot.h>
21 #include <atomic.h>
22 #include <process.h>
23 #include <assert.h>
24 #include <page_alloc.h>
25 #include <multiboot.h>
26
27 /* This macro takes a kernel virtual address -- an address that points above
28  * KERNBASE, where the machine's maximum 256MB of physical memory is mapped --
29  * and returns the corresponding physical address.  It panics if you pass it a
30  * non-kernel virtual address.
31  */
32 #define PADDR(kva)                                              \
33 ({                                                              \
34         physaddr_t __m_kva = (physaddr_t) (kva);                \
35         if (__m_kva < KERNBASE)                                 \
36                 panic("PADDR called with invalid kva %08lx", __m_kva);\
37         __m_kva - KERNBASE;                                     \
38 })
39
40 /* This macro takes a physical address and returns the corresponding kernel
41  * virtual address.  It warns if you pass an invalid physical address. */
42 #define KADDR(pa)                                               \
43 ({                                                              \
44         physaddr_t __m_pa = (pa);                               \
45         size_t __m_ppn = LA2PPN(__m_pa);                        \
46         if (__m_ppn >= npages)                                  \
47                 warn("KADDR called with invalid pa %08lx", __m_pa);\
48         (void*TRUSTED) (__m_pa + KERNBASE);                             \
49 })
50
51 extern char (SNT RO bootstacktop)[], (SNT RO bootstack)[];
52
53 // List of physical pages
54 extern page_t * RO CT(npages) pages;
55
56 extern physaddr_t RO boot_cr3;
57 extern pde_t *CT(NPDENTRIES) RO boot_pgdir;
58
59 extern char *RO BND(end, maxaddrpa_ptr + IVY_KERNBASE) boot_freemem;
60
61 void    multiboot_detect_memory(multiboot_info_t *COUNT(1) mbi);
62 void    multiboot_print_memory_map(multiboot_info_t *COUNT(1) mbi);
63 bool    enable_pse(void);
64 void    vm_init(void);
65
66 void    page_init(void);
67 void    page_check(void);
68 int         page_insert(pde_t *pgdir, struct page *page, void *SNT va, int perm);
69 void*COUNT(PGSIZE) page_insert_in_range(pde_t *COUNT(NPDENTRIES) pgdir, page_t *pp, 
70                              void *SNT vab, void *SNT vae, int perm);
71 void    page_remove(pde_t *COUNT(NPDENTRIES) pgdir, void *SNT va);
72 page_t*COUNT(1) page_lookup(pde_t SSOMELOCK*COUNT(NPDENTRIES) pgdir, void *SNT va, pte_t **pte_store);
73 error_t pagetable_remove(pde_t *COUNT(NPDENTRIES) pgdir, void *SNT va);
74 void    page_decref(page_t *COUNT(1) pp);
75
76 void setup_default_mtrrs(barrier_t* smp_barrier);
77 void    tlb_invalidate(pde_t *COUNT(NPDENTRIES) pgdir, void *SNT va);
78 void tlb_flush_global(void);
79
80 /* Arch specific implementations for these */
81 pte_t *pgdir_walk(pde_t *COUNT(NPDENTRIES) pgdir, const void *SNT va, int create);
82 int get_va_perms(pde_t *COUNT(NPDENTRIES) pgdir, const void *SNT va);
83
84 static inline page_t *SAFE ppn2page(size_t ppn)
85 {
86         if( ppn >= npages )
87                 warn("ppn2page called with ppn (%08u) larger than npages", ppn);
88         return &(pages[ppn]);
89 }
90
91 static inline ppn_t page2ppn(page_t *pp)
92 {
93         return pp - pages;
94 }
95
96 static inline physaddr_t page2pa(page_t *pp)
97 {
98         return page2ppn(pp) << PGSHIFT;
99 }
100
101 static inline page_t*COUNT(1) pa2page(physaddr_t pa)
102 {
103         if (LA2PPN(pa) >= npages)
104                 warn("pa2page called with pa (0x%08x) larger than npages", pa);
105         return &pages[LA2PPN(pa)];
106 }
107
108 static inline void*COUNT(PGSIZE) page2kva(page_t *pp)
109 {
110         return KADDR(page2pa(pp));
111 }
112
113 static inline void*COUNT(PGSIZE) ppn2kva(size_t pp)
114 {
115         return page2kva(ppn2page(pp));
116 }
117
118 static inline page_t* kva2page(void* addr) 
119 {
120         return pa2page(PADDR(addr));
121 }
122
123 static inline ppn_t kva2ppn(void* addr) 
124 {
125         return page2ppn(kva2page(addr));
126 }
127
128 #endif /* !ROS_KERN_PMAP_H */