zig

fork of https://codeberg.org/ziglang/zig
Log | Files | Refs | README | LICENSE

pmap.h (7205B) - Raw


      1 /*-
      2  * SPDX-License-Identifier: BSD-2-Clause
      3  *
      4  * Copyright (c) 2014,2016 Svatopluk Kraus <onwahe@gmail.com>
      5  * Copyright (c) 2014,2016 Michal Meloun <meloun@miracle.cz>
      6  * Copyright (c) 1991 Regents of the University of California.
      7  * All rights reserved.
      8  *
      9  * This code is derived from software contributed to Berkeley by
     10  * the Systems Programming Group of the University of Utah Computer
     11  * Science Department and William Jolitz of UUNET Technologies Inc.
     12  *
     13  * Redistribution and use in source and binary forms, with or without
     14  * modification, are permitted provided that the following conditions
     15  * are met:
     16  * 1. Redistributions of source code must retain the above copyright
     17  *    notice, this list of conditions and the following disclaimer.
     18  * 2. Redistributions in binary form must reproduce the above copyright
     19  *    notice, this list of conditions and the following disclaimer in the
     20  *    documentation and/or other materials provided with the distribution.
     21  *
     22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     32  * SUCH DAMAGE.
     33  *
     34  * The ARM version of this file was more or less based on the i386 version,
     35  * which has the following provenance...
     36  *
     37  * Derived from hp300 version by Mike Hibler, this version by William
     38  * Jolitz uses a recursive map [a pde points to the page directory] to
     39  * map the page tables using the pagetables themselves. This is done to
     40  * reduce the impact on kernel virtual memory for lots of sparse address
     41  * space, and to reduce the cost of memory to each process.
     42  *
     43  *      from: hp300: @(#)pmap.h 7.2 (Berkeley) 12/16/90
     44  *      from: @(#)pmap.h        7.4 (Berkeley) 5/12/91
     45  * 	from: FreeBSD: src/sys/i386/include/pmap.h,v 1.70 2000/11/30
     46  */
     47 
     48 #ifndef _MACHINE_PMAP_H_
     49 #define _MACHINE_PMAP_H_
     50 
     51 #include <sys/systm.h>
     52 #include <sys/queue.h>
     53 #include <sys/_cpuset.h>
     54 #include <sys/_lock.h>
     55 #include <sys/_mutex.h>
     56 #include <sys/_pv_entry.h>
     57 
     58 typedef	uint32_t	pt1_entry_t;		/* L1 table entry */
     59 typedef	uint32_t	pt2_entry_t;		/* L2 table entry */
     60 typedef uint32_t	ttb_entry_t;		/* TTB entry */
     61 
     62 #ifdef _KERNEL
     63 
     64 #if 0
     65 #define PMAP_PTE_NOCACHE // Use uncached page tables
     66 #endif
     67 
     68 /*
     69  *  (1) During pmap bootstrap, physical pages for L2 page tables are
     70  *      allocated in advance which are used for KVA continuous mapping
     71  *      starting from KERNBASE. This makes things more simple.
     72  *  (2) During vm subsystem initialization, only vm subsystem itself can
     73  *      allocate physical memory safely. As pmap_map() is called during
     74  *      this initialization, we must be prepared for that and have some
     75  *      preallocated physical pages for L2 page tables.
     76  *
     77  *  Note that some more pages for L2 page tables are preallocated too
     78  *  for mappings laying above VM_MAX_KERNEL_ADDRESS.
     79  */
     80 #ifndef NKPT2PG
     81 /*
     82  *  The optimal way is to define this in board configuration as
     83  *  definition here must be safe enough. It means really big.
     84  *
     85  *  1 GB KVA <=> 256 kernel L2 page table pages
     86  *
     87  *  From real platforms:
     88  *	1 GB physical memory <=> 10 pages is enough
     89  *	2 GB physical memory <=> 21 pages is enough
     90  */
     91 #define NKPT2PG		32
     92 #endif
     93 #endif	/* _KERNEL */
     94 
     95 /*
     96  * Pmap stuff
     97  */
     98 struct	md_page {
     99 	TAILQ_HEAD(,pv_entry)	pv_list;
    100 	uint16_t		pt2_wirecount[4];
    101 	vm_memattr_t		pat_mode;
    102 };
    103 
    104 struct	pmap {
    105 	struct mtx		pm_mtx;
    106 	pt1_entry_t		*pm_pt1;	/* KVA of pt1 */
    107 	pt2_entry_t		*pm_pt2tab;	/* KVA of pt2 pages table */
    108 	TAILQ_HEAD(,pv_chunk)	pm_pvchunk;	/* list of mappings in pmap */
    109 	cpuset_t		pm_active;	/* active on cpus */
    110 	struct pmap_statistics	pm_stats;	/* pmap statictics */
    111 	LIST_ENTRY(pmap) 	pm_list;	/* List of all pmaps */
    112 };
    113 
    114 typedef struct pmap *pmap_t;
    115 
    116 #ifdef _KERNEL
    117 extern struct pmap	        kernel_pmap_store;
    118 #define kernel_pmap	        (&kernel_pmap_store)
    119 
    120 #define	PMAP_LOCK(pmap)		mtx_lock(&(pmap)->pm_mtx)
    121 #define	PMAP_LOCK_ASSERT(pmap, type) \
    122 				mtx_assert(&(pmap)->pm_mtx, (type))
    123 #define	PMAP_LOCK_DESTROY(pmap)	mtx_destroy(&(pmap)->pm_mtx)
    124 #define	PMAP_LOCK_INIT(pmap)	mtx_init(&(pmap)->pm_mtx, "pmap", \
    125 				    NULL, MTX_DEF | MTX_DUPOK)
    126 #define	PMAP_LOCKED(pmap)	mtx_owned(&(pmap)->pm_mtx)
    127 #define	PMAP_MTX(pmap)		(&(pmap)->pm_mtx)
    128 #define	PMAP_TRYLOCK(pmap)	mtx_trylock(&(pmap)->pm_mtx)
    129 #define	PMAP_UNLOCK(pmap)	mtx_unlock(&(pmap)->pm_mtx)
    130 
    131 extern ttb_entry_t pmap_kern_ttb; 	/* TTB for kernel pmap */
    132 
    133 #define	pmap_page_get_memattr(m)	((m)->md.pat_mode)
    134 
    135 /*
    136  * Only the following functions or macros may be used before pmap_bootstrap()
    137  * is called: pmap_kenter(), pmap_kextract(), pmap_kremove(), vtophys(), and
    138  * vtopte2().
    139  */
    140 void pmap_bootstrap(vm_offset_t);
    141 void pmap_kenter(vm_offset_t, vm_paddr_t);
    142 void pmap_kremove(vm_offset_t);
    143 boolean_t pmap_page_is_mapped(vm_page_t);
    144 bool	pmap_ps_enabled(pmap_t pmap);
    145 
    146 void pmap_tlb_flush(pmap_t, vm_offset_t);
    147 void pmap_tlb_flush_range(pmap_t, vm_offset_t, vm_size_t);
    148 
    149 vm_paddr_t pmap_dump_kextract(vm_offset_t, pt2_entry_t *);
    150 
    151 int pmap_fault(pmap_t, vm_offset_t, uint32_t, int, bool);
    152 
    153 void pmap_set_tex(void);
    154 
    155 /*
    156  * Pre-bootstrap epoch functions set.
    157  */
    158 void pmap_bootstrap_prepare(vm_paddr_t);
    159 vm_paddr_t pmap_preboot_get_pages(u_int);
    160 void pmap_preboot_map_pages(vm_paddr_t, vm_offset_t, u_int);
    161 vm_offset_t pmap_preboot_reserve_pages(u_int);
    162 vm_offset_t pmap_preboot_get_vpages(u_int);
    163 void pmap_preboot_map_attr(vm_paddr_t, vm_offset_t, vm_size_t, vm_prot_t,
    164     vm_memattr_t);
    165 void pmap_remap_vm_attr(vm_memattr_t old_attr, vm_memattr_t new_attr);
    166 
    167 extern char *_tmppt;	/* poor name! */
    168 
    169 extern vm_offset_t virtual_avail;
    170 extern vm_offset_t virtual_end;
    171 
    172 void *pmap_kenter_temporary(vm_paddr_t, int);
    173 #define	pmap_page_is_write_mapped(m)	(((m)->a.flags & PGA_WRITEABLE) != 0)
    174 void pmap_page_set_memattr(vm_page_t, vm_memattr_t);
    175 #define	pmap_map_delete(pmap, sva, eva)	pmap_remove(pmap, sva, eva)
    176 
    177 void *pmap_mapdev(vm_paddr_t, vm_size_t);
    178 void pmap_unmapdev(void *, vm_size_t);
    179 
    180 static inline void *
    181 pmap_mapdev_attr(vm_paddr_t addr __unused, vm_size_t size __unused,
    182     int attr __unused)
    183 {
    184 	panic("%s is not implemented yet!\n", __func__);
    185 }
    186 
    187 struct pcb;
    188 void pmap_set_pcb_pagedir(pmap_t, struct pcb *);
    189 
    190 void pmap_kenter_device(vm_offset_t, vm_size_t, vm_paddr_t);
    191 void pmap_kremove_device(vm_offset_t, vm_size_t);
    192 
    193 vm_paddr_t pmap_kextract(vm_offset_t);
    194 #define vtophys(va)	pmap_kextract((vm_offset_t)(va))
    195 
    196 static inline int
    197 pmap_vmspace_copy(pmap_t dst_pmap __unused, pmap_t src_pmap __unused)
    198 {
    199 
    200 	return (0);
    201 }
    202 
    203 #define	PMAP_ENTER_QUICK_LOCKED	0x10000000
    204 
    205 #define	pmap_vm_page_alloc_check(m)
    206 
    207 #endif	/* _KERNEL */
    208 #endif	/* !_MACHINE_PMAP_H_ */