sys/riscv/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/_cpuset.h>
  45 #include <sys/_lock.h>
  46 #include <sys/_mutex.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)->aflags & 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 struct pmap {
  81         struct mtx              pm_mtx;
  82         struct pmap_statistics  pm_stats;       /* pmap statictics */
  83         pd_entry_t              *pm_l1;
  84         u_long                  pm_satp;        /* value for SATP register */
  85         cpuset_t                pm_active;      /* active on cpus */
  86         TAILQ_HEAD(,pv_chunk)   pm_pvchunk;     /* list of mappings in pmap */
  87         LIST_ENTRY(pmap)        pm_list;        /* List of all pmaps */
  88         struct vm_radix         pm_root;
  89 };
  90
  91 typedef struct pv_entry {
  92         vm_offset_t             pv_va;  /* virtual address for mapping */
  93         TAILQ_ENTRY(pv_entry)   pv_next;
  94 } *pv_entry_t;
  95
  96 /*
  97  * pv_entries are allocated in chunks per-process.  This avoids the
  98  * need to track per-pmap assignments.
  99  */
 100 #define _NPCM   3
 101 #define _NPCPV  168
 102 struct pv_chunk {
 103         struct pmap *           pc_pmap;
 104         TAILQ_ENTRY(pv_chunk)   pc_list;
 105         uint64_t                pc_map[_NPCM];  /* bitmap; 1 = free */
 106         TAILQ_ENTRY(pv_chunk)   pc_lru;
 107         struct pv_entry         pc_pventry[_NPCPV];
 108 };
 109
 110 typedef struct pmap *pmap_t;
 111
 112 #ifdef _KERNEL
 113 extern struct pmap      kernel_pmap_store;
 114 #define kernel_pmap     (&kernel_pmap_store)
 115 #define pmap_kernel()   kernel_pmap
 116
 117 #define PMAP_ASSERT_LOCKED(pmap) \
 118                                 mtx_assert(&(pmap)->pm_mtx, MA_OWNED)
 119 #define PMAP_LOCK(pmap)         mtx_lock(&(pmap)->pm_mtx)
 120 #define PMAP_LOCK_ASSERT(pmap, type) \
 121                                 mtx_assert(&(pmap)->pm_mtx, (type))
 122 #define PMAP_LOCK_DESTROY(pmap) mtx_destroy(&(pmap)->pm_mtx)
 123 #define PMAP_LOCK_INIT(pmap)    mtx_init(&(pmap)->pm_mtx, "pmap", \
 124                                     NULL, MTX_DEF | MTX_DUPOK)
 125 #define PMAP_OWNED(pmap)        mtx_owned(&(pmap)->pm_mtx)
 126 #define PMAP_MTX(pmap)          (&(pmap)->pm_mtx)
 127 #define PMAP_TRYLOCK(pmap)      mtx_trylock(&(pmap)->pm_mtx)
 128 #define PMAP_UNLOCK(pmap)       mtx_unlock(&(pmap)->pm_mtx)
 129
 130 #define PHYS_AVAIL_SIZE 10
 131 extern vm_paddr_t phys_avail[];
 132 extern vm_paddr_t dump_avail[];
 133 extern vm_offset_t virtual_avail;
 134 extern vm_offset_t virtual_end;
 135
 136 /*
 137  * Macros to test if a mapping is mappable with an L1 Section mapping
 138  * or an L2 Large Page mapping.
 139  */
 140 #define L1_MAPPABLE_P(va, pa, size)                                     \
 141         ((((va) | (pa)) & L1_OFFSET) == 0 && (size) >= L1_SIZE)
 142
 143 struct thread;
 144
 145 void    pmap_activate_boot(pmap_t);
 146 void    pmap_activate_sw(struct thread *);
 147 void    pmap_bootstrap(vm_offset_t, vm_paddr_t, vm_size_t);
 148 void    pmap_kenter_device(vm_offset_t, vm_size_t, vm_paddr_t);
 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 bool    pmap_page_is_mapped(vm_page_t m);
 153 bool    pmap_ps_enabled(pmap_t);
 154
 155 void    *pmap_mapdev(vm_offset_t, vm_size_t);
 156 void    *pmap_mapbios(vm_paddr_t, vm_size_t);
 157 void    pmap_unmapdev(vm_offset_t, vm_size_t);
 158 void    pmap_unmapbios(vm_offset_t, vm_size_t);
 159
 160 boolean_t pmap_map_io_transient(vm_page_t *, vm_offset_t *, int, boolean_t);
 161 void    pmap_unmap_io_transient(vm_page_t *, vm_offset_t *, int, boolean_t);
 162
 163 bool    pmap_get_tables(pmap_t, vm_offset_t, pd_entry_t **, pd_entry_t **,
 164     pt_entry_t **);
 165
 166 int pmap_fault_fixup(pmap_t, vm_offset_t, vm_prot_t);
 167
 168 static inline int
 169 pmap_vmspace_copy(pmap_t dst_pmap __unused, pmap_t src_pmap __unused)
 170 {
 171
 172         return (0);
 173 }
 174
 175 #endif  /* _KERNEL */
 176
 177 #endif  /* !LOCORE */
 178
 179 #endif  /* !_MACHINE_PMAP_H_ */