vmap: Add a helper for global TLB shootdowns
[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  * See LICENSE for details.
8  *
9  * Physical memory mangement, low-level virtual address space initialization and
10  * management, and other things related to virtual->physical mappings.
11  */
12
13 #pragma once
14
15 #include <ros/memlayout.h>
16 #include <sys/queue.h>
17 #include <multiboot.h>
18 #include <atomic.h>
19 #include <process.h>
20 #include <assert.h>
21 #include <page_alloc.h>
22 #include <multiboot.h>
23 #include <arch/pmap.h>
24
25 /* This macro takes a kernel virtual address -- an address that points above
26  * KERNBASE, where the machine's maximum 256MB of physical memory is mapped --
27  * and returns the corresponding physical address.  It panics if you pass it a
28  * non-kernel virtual address.
29  */
30 #define PADDR(kva)                                              \
31 ({                                                              \
32         physaddr_t __m_pa, __m_kva = (physaddr_t) (kva);                \
33         if (__m_kva < KERNBASE)                                 \
34                 panic("PADDR called with invalid kva %p", __m_kva);\
35         if(__m_kva >= KERN_LOAD_ADDR)                                   \
36                 __m_pa = __m_kva - KERN_LOAD_ADDR;                                      \
37         else                                    \
38                 __m_pa = __m_kva - KERNBASE;                                    \
39         __m_pa; \
40 })
41
42 #define paddr_low32(p) ((uint32_t)(uintptr_t)PADDR(p))
43 #define paddr_high32(p) ((uint32_t)((uint64_t)PADDR(p) >> 32))
44
45 /* This macro takes a physical address and returns the corresponding kernel
46  * virtual address.  It warns if you pass an invalid physical address. */
47 #define KADDR(pa)                                               \
48 ({                                                              \
49         physaddr_t __m_pa = (pa);                               \
50         size_t __m_ppn = LA2PPN(__m_pa);                        \
51         if (__m_ppn > max_nr_pages)                                     \
52                 warn("KADDR called with invalid pa %p", __m_pa);\
53         (void*) (__m_pa + KERNBASE);                            \
54 })
55
56 #define KADDR_NOCHECK(pa) ((void*)(pa + KERNBASE))
57 #define KBASEADDR(kla) KADDR(PADDR(kla))
58
59 extern char bootstacktop[], bootstack[];
60
61 extern physaddr_t max_pmem;             /* Total amount of physical memory */
62 extern size_t max_nr_pages;             /* Total number of physical memory pages */
63 extern physaddr_t max_paddr;    /* Maximum addressable physical address */
64 extern size_t nr_free_pages;
65 extern struct multiboot_info *multiboot_kaddr;
66 extern uintptr_t boot_freemem;
67 extern uintptr_t boot_freelimit;
68
69 /* Pages are stored in an array, including for pages that we can never touch
70  * (like reserved memory from the BIOS, fake regions, etc).  Pages are reference
71  * counted, and free pages are kept on a linked list. */
72 extern struct page *pages;
73
74 extern physaddr_t boot_cr3;
75 extern pgdir_t boot_pgdir;
76
77 bool enable_pse(void);
78 void vm_init(void);
79
80 void pmem_init(struct multiboot_info *mbi);
81 void *boot_alloc(size_t amt, size_t align);
82 void *boot_zalloc(size_t amt, size_t align);
83
84 void page_check(void);
85 int      page_insert(pgdir_t pgdir, struct page *page, void *va,
86                         int perm);
87 void page_remove(pgdir_t pgdir, void *va);
88 page_t* page_lookup(pgdir_t pgdir, void *va, pte_t *pte_store);
89 error_t pagetable_remove(pgdir_t pgdir, void *va);
90 void    page_decref(page_t *pp);
91
92 void    tlb_invalidate(pgdir_t pgdir, void *ga);
93 void tlb_flush_global(void);
94 void tlb_shootdown_global(void);
95 bool regions_collide_unsafe(uintptr_t start1, uintptr_t end1,
96                             uintptr_t start2, uintptr_t end2);
97
98 /* Arch specific implementations for these */
99 pte_t pgdir_walk(pgdir_t pgdir, const void *va, int create);
100 int get_va_perms(pgdir_t pgdir, const void *va);
101 int arch_pgdir_setup(pgdir_t boot_copy, pgdir_t *new_pd);
102 physaddr_t arch_pgdir_get_cr3(pgdir_t pd);
103 void arch_pgdir_clear(pgdir_t *pd);
104 int arch_max_jumbo_page_shift(void);
105
106 static inline page_t *ppn2page(size_t ppn)
107 {
108         if (ppn >= max_nr_pages)
109                 warn("ppn2page called with ppn (%08lu) larger than max_nr_pages", ppn);
110         return &(pages[ppn]);
111 }
112
113 static inline ppn_t page2ppn(page_t *pp)
114 {
115         return pp - pages;
116 }
117
118 static inline physaddr_t page2pa(page_t *pp)
119 {
120         return page2ppn(pp) << PGSHIFT;
121 }
122
123 static inline page_t *pa2page(physaddr_t pa)
124 {
125         if (LA2PPN(pa) >= max_nr_pages)
126                 warn("pa2page called with pa (%p) larger than max_nr_pages", pa);
127         return &pages[LA2PPN(pa)];
128 }
129
130 static inline ppn_t pa2ppn(physaddr_t pa)
131 {
132         return pa >> PGSHIFT;
133 }
134
135 static inline void *page2kva(page_t *pp)
136 {
137         return KADDR(page2pa(pp));
138 }
139
140 static inline void *ppn2kva(size_t pp)
141 {
142         return page2kva(ppn2page(pp));
143 }
144
145 static inline page_t* kva2page(void* addr)
146 {
147         return pa2page(PADDR(addr));
148 }
149
150 static inline ppn_t kva2ppn(void* addr)
151 {
152         return page2ppn(kva2page(addr));
153 }
154
155 static inline bool is_kaddr(void *addr)
156 {
157         return (uintptr_t)addr >= KERNBASE;
158 }
159
160 static inline unsigned long nr_pages(size_t nr_bytes)
161 {
162         return (nr_bytes >> PGSHIFT) + (PGOFF(nr_bytes) ? 1 : 0);
163 }
164
165 /* Including here, since these ops often rely on pmap.h helpers, which rely on
166  * the generic arch/pmap.h.  It's likely that many of these ops will be inlined
167  * for speed in pmap_ops. */
168 #include <arch/pmap_ops.h>