sys/arm64/include/pmap.h

   1 /*-
   2  * Copyright (c) 1991 Regents of the University of California.
   3  * All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * the Systems Programming Group of the University of Utah Computer
   7  * Science Department and William Jolitz of UUNET Technologies Inc.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  * $FreeBSD$
  34  */
  35
  36 #ifndef _MACHINE_PMAP_H_
  37 #define _MACHINE_PMAP_H_
  38
  39 #include <machine/pte.h>
  40
  41 #ifndef LOCORE
  42
  43 #include <sys/queue.h>
  44 #include <sys/_lock.h>
  45 #include <sys/_mutex.h>
  46 #include <sys/_pv_entry.h>
  47
  48 #include <vm/_vm_radix.h>
  49
  50 #ifdef _KERNEL
  51
  52 #define vtophys(va)     pmap_kextract((vm_offset_t)(va))
  53
  54 #endif
  55
  56 #define pmap_page_get_memattr(m)        ((m)->md.pv_memattr)
  57 #define pmap_page_is_write_mapped(m)    (((m)->a.flags & PGA_WRITEABLE) != 0)
  58 void pmap_page_set_memattr(vm_page_t m, vm_memattr_t ma);
  59
  60 /*
  61  * Pmap stuff
  62  */
  63
  64 struct md_page {
  65         TAILQ_HEAD(,pv_entry)   pv_list;
  66         int                     pv_gen;
  67         vm_memattr_t            pv_memattr;
  68 };
  69
  70 /*
  71  * This structure is used to hold a virtual<->physical address
  72  * association and is used mostly by bootstrap code
  73  */
  74 struct pv_addr {
  75         SLIST_ENTRY(pv_addr) pv_list;
  76         vm_offset_t     pv_va;
  77         vm_paddr_t      pv_pa;
  78 };
  79
  80 enum pmap_stage {
  81         PM_INVALID,
  82         PM_STAGE1,
  83         PM_STAGE2,
  84 };
  85
  86 struct pmap {
  87         struct mtx              pm_mtx;
  88         struct pmap_statistics  pm_stats;       /* pmap statistics */
  89         uint64_t                pm_ttbr;
  90         vm_paddr_t              pm_l0_paddr;
  91         pd_entry_t              *pm_l0;
  92         TAILQ_HEAD(,pv_chunk)   pm_pvchunk;     /* list of mappings in pmap */
  93         struct vm_radix         pm_root;        /* spare page table pages */
  94         long                    pm_cookie;      /* encodes the pmap's ASID */
  95         struct asid_set         *pm_asid_set;   /* The ASID/VMID set to use */
  96         enum pmap_stage         pm_stage;
  97         int                     pm_levels;
  98         uint64_t                pm_reserved[4];
  99 };
 100 typedef struct pmap *pmap_t;
 101
 102 struct thread;
 103
 104 #ifdef _KERNEL
 105 extern struct pmap      kernel_pmap_store;
 106 #define kernel_pmap     (&kernel_pmap_store)
 107 #define pmap_kernel()   kernel_pmap
 108
 109 #define PMAP_ASSERT_LOCKED(pmap) \
 110                                 mtx_assert(&(pmap)->pm_mtx, MA_OWNED)
 111 #define PMAP_LOCK(pmap)         mtx_lock(&(pmap)->pm_mtx)
 112 #define PMAP_LOCK_ASSERT(pmap, type) \
 113                                 mtx_assert(&(pmap)->pm_mtx, (type))
 114 #define PMAP_LOCK_DESTROY(pmap) mtx_destroy(&(pmap)->pm_mtx)
 115 #define PMAP_LOCK_INIT(pmap)    mtx_init(&(pmap)->pm_mtx, "pmap", \
 116                                     NULL, MTX_DEF | MTX_DUPOK)
 117 #define PMAP_OWNED(pmap)        mtx_owned(&(pmap)->pm_mtx)
 118 #define PMAP_MTX(pmap)          (&(pmap)->pm_mtx)
 119 #define PMAP_TRYLOCK(pmap)      mtx_trylock(&(pmap)->pm_mtx)
 120 #define PMAP_UNLOCK(pmap)       mtx_unlock(&(pmap)->pm_mtx)
 121
 122 #define ASID_RESERVED_FOR_PID_0 0
 123 #define ASID_RESERVED_FOR_EFI   1
 124 #define ASID_FIRST_AVAILABLE    (ASID_RESERVED_FOR_EFI + 1)
 125 #define ASID_TO_OPERAND(asid)   ({                                      \
 126         KASSERT((asid) != -1, ("invalid ASID"));                        \
 127         (uint64_t)(asid) << TTBR_ASID_SHIFT;                    \
 128 })
 129
 130 extern vm_offset_t virtual_avail;
 131 extern vm_offset_t virtual_end;
 132
 133 /*
 134  * Macros to test if a mapping is mappable with an L1 Section mapping
 135  * or an L2 Large Page mapping.
 136  */
 137 #define L1_MAPPABLE_P(va, pa, size)                                     \
 138         ((((va) | (pa)) & L1_OFFSET) == 0 && (size) >= L1_SIZE)
 139
 140 #define pmap_vm_page_alloc_check(m)
 141
 142 void    pmap_activate_vm(pmap_t);
 143 void    pmap_bootstrap(vm_paddr_t, vm_size_t);
 144 int     pmap_change_attr(vm_offset_t va, vm_size_t size, int mode);
 145 int     pmap_change_prot(vm_offset_t va, vm_size_t size, vm_prot_t prot);
 146 void    pmap_kenter(vm_offset_t sva, vm_size_t size, vm_paddr_t pa, int mode);
 147 void    pmap_kenter_device(vm_offset_t, vm_size_t, vm_paddr_t);
 148 bool    pmap_klookup(vm_offset_t va, vm_paddr_t *pa);
 149 vm_paddr_t pmap_kextract(vm_offset_t va);
 150 void    pmap_kremove(vm_offset_t);
 151 void    pmap_kremove_device(vm_offset_t, vm_size_t);
 152 void    *pmap_mapdev_attr(vm_paddr_t pa, vm_size_t size, vm_memattr_t ma);
 153 bool    pmap_page_is_mapped(vm_page_t m);
 154 int     pmap_pinit_stage(pmap_t, enum pmap_stage, int);
 155 bool    pmap_ps_enabled(pmap_t pmap);
 156 uint64_t pmap_to_ttbr0(pmap_t pmap);
 157 void    pmap_disable_promotion(vm_offset_t sva, vm_size_t size);
 158 void    pmap_map_delete(pmap_t, vm_offset_t, vm_offset_t);
 159
 160 void    *pmap_mapdev(vm_paddr_t, vm_size_t);
 161 void    *pmap_mapbios(vm_paddr_t, vm_size_t);
 162 void    pmap_unmapdev(void *, vm_size_t);
 163 void    pmap_unmapbios(void *, vm_size_t);
 164
 165 bool    pmap_map_io_transient(vm_page_t *, vm_offset_t *, int, bool);
 166 void    pmap_unmap_io_transient(vm_page_t *, vm_offset_t *, int, bool);
 167
 168 bool    pmap_get_tables(pmap_t, vm_offset_t, pd_entry_t **, pd_entry_t **,
 169     pd_entry_t **, pt_entry_t **);
 170
 171 int     pmap_fault(pmap_t, uint64_t, uint64_t);
 172
 173 struct pcb *pmap_switch(struct thread *);
 174
 175 extern void (*pmap_clean_stage2_tlbi)(void);
 176 extern void (*pmap_invalidate_vpipt_icache)(void);
 177 extern void (*pmap_stage2_invalidate_range)(uint64_t, vm_offset_t, vm_offset_t,
 178     bool);
 179 extern void (*pmap_stage2_invalidate_all)(uint64_t);
 180
 181 static inline int
 182 pmap_vmspace_copy(pmap_t dst_pmap __unused, pmap_t src_pmap __unused)
 183 {
 184
 185         return (0);
 186 }
 187
 188 #if defined(KASAN) || defined(KMSAN)
 189 struct arm64_bootparams;
 190
 191 void    pmap_bootstrap_san(vm_paddr_t);
 192 void    pmap_san_enter(vm_offset_t);
 193 void    pmap_san_bootstrap(struct arm64_bootparams *);
 194 #endif
 195
 196 #endif  /* _KERNEL */
 197
 198 #endif  /* !LOCORE */
 199
 200 #endif  /* !_MACHINE_PMAP_H_ */