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 * 4. 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 * Derived from hp300 version by Mike Hibler, this version by William
34 * Jolitz uses a recursive map [a pde points to the page directory] to
35 * map the page tables using the pagetables themselves. This is done to
36 * reduce the impact on kernel virtual memory for lots of sparse address
37 * space, and to reduce the cost of memory to each process.
38 *
39 *	from: hp300: @(#)pmap.h 7.2 (Berkeley) 12/16/90
40 *	from: @(#)pmap.h	7.4 (Berkeley) 5/12/91
41 *	from: src/sys/i386/include/pmap.h,v 1.65.2.2 2000/11/30 01:54:42 peter
42 *	JNPR: pmap.h,v 1.7.2.1 2007/09/10 07:44:12 girish
43 *      $FreeBSD$
44 */
45
46#ifndef _MACHINE_PMAP_H_
47#define	_MACHINE_PMAP_H_
48
49#include <machine/vmparam.h>
50#include <machine/pte.h>
51
52#if defined(__mips_n32) || defined(__mips_n64) /* PHYSADDR_64BIT */
53#define	NKPT		256	/* mem > 4G, vm_page_startup needs more KPTs */
54#else
55#define	NKPT		120	/* actual number of kernel page tables */
56#endif
57
58#ifndef LOCORE
59
60#include <sys/queue.h>
61#include <sys/_cpuset.h>
62#include <sys/_lock.h>
63#include <sys/_mutex.h>
64
65/*
66 * Pmap stuff
67 */
68struct pv_entry;
69struct pv_chunk;
70
71struct md_page {
72	int pv_flags;
73	TAILQ_HEAD(, pv_entry) pv_list;
74};
75
76#define	PV_TABLE_REF		0x02	/* referenced */
77#define	PV_MEMATTR_UNCACHEABLE	0x04
78
79#define	ASID_BITS		8
80#define	ASIDGEN_BITS		(32 - ASID_BITS)
81#define	ASIDGEN_MASK		((1 << ASIDGEN_BITS) - 1)
82
83struct pmap {
84	pd_entry_t *pm_segtab;	/* KVA of segment table */
85	TAILQ_HEAD(, pv_chunk)	pm_pvchunk;	/* list of mappings in pmap */
86	cpuset_t	pm_active;		/* active on cpus */
87	struct {
88		u_int32_t asid:ASID_BITS;	/* TLB address space tag */
89		u_int32_t gen:ASIDGEN_BITS;	/* its generation number */
90	}      pm_asid[MAXSMPCPU];
91	struct pmap_statistics pm_stats;	/* pmap statistics */
92	struct mtx pm_mtx;
93};
94
95typedef struct pmap *pmap_t;
96
97#ifdef	_KERNEL
98
99pt_entry_t *pmap_pte(pmap_t, vm_offset_t);
100vm_paddr_t pmap_kextract(vm_offset_t va);
101
102#define	vtophys(va)	pmap_kextract(((vm_offset_t) (va)))
103#define	pmap_asid(pmap)	(pmap)->pm_asid[PCPU_GET(cpuid)].asid
104
105extern struct pmap	kernel_pmap_store;
106#define kernel_pmap	(&kernel_pmap_store)
107
108#define	PMAP_LOCK(pmap)		mtx_lock(&(pmap)->pm_mtx)
109#define	PMAP_LOCK_ASSERT(pmap, type)	mtx_assert(&(pmap)->pm_mtx, (type))
110#define	PMAP_LOCK_DESTROY(pmap) mtx_destroy(&(pmap)->pm_mtx)
111#define	PMAP_LOCK_INIT(pmap)	mtx_init(&(pmap)->pm_mtx, "pmap", \
112				    NULL, MTX_DEF)
113#define	PMAP_LOCKED(pmap)	mtx_owned(&(pmap)->pm_mtx)
114#define	PMAP_MTX(pmap)		(&(pmap)->pm_mtx)
115#define	PMAP_TRYLOCK(pmap)	mtx_trylock(&(pmap)->pm_mtx)
116#define	PMAP_UNLOCK(pmap)	mtx_unlock(&(pmap)->pm_mtx)
117
118/*
119 * For each vm_page_t, there is a list of all currently valid virtual
120 * mappings of that page.  An entry is a pv_entry_t, the list is pv_table.
121 */
122typedef struct pv_entry {
123	vm_offset_t pv_va;	/* virtual address for mapping */
124	TAILQ_ENTRY(pv_entry) pv_list;
125}       *pv_entry_t;
126
127/*
128 * pv_entries are allocated in chunks per-process.  This avoids the
129 * need to track per-pmap assignments.
130 */
131#ifdef __mips_n64
132#define	_NPCM	3
133#define	_NPCPV	168
134#else
135#define	_NPCM	11
136#define	_NPCPV	336
137#endif
138struct pv_chunk {
139	pmap_t			pc_pmap;
140	TAILQ_ENTRY(pv_chunk)	pc_list;
141	u_long			pc_map[_NPCM];	/* bitmap; 1 = free */
142	TAILQ_ENTRY(pv_chunk)	pc_lru;
143	struct pv_entry		pc_pventry[_NPCPV];
144};
145
146/*
147 * physmem_desc[] is a superset of phys_avail[] and describes all the
148 * memory present in the system.
149 *
150 * phys_avail[] is similar but does not include the memory stolen by
151 * pmap_steal_memory().
152 *
153 * Each memory region is described by a pair of elements in the array
154 * so we can describe up to (PHYS_AVAIL_ENTRIES / 2) distinct memory
155 * regions.
156 */
157#define	PHYS_AVAIL_ENTRIES	10
158extern vm_paddr_t phys_avail[PHYS_AVAIL_ENTRIES + 2];
159extern vm_paddr_t physmem_desc[PHYS_AVAIL_ENTRIES + 2];
160
161extern vm_offset_t virtual_avail;
162extern vm_offset_t virtual_end;
163
164extern vm_paddr_t dump_avail[PHYS_AVAIL_ENTRIES + 2];
165
166#define	pmap_page_get_memattr(m)	VM_MEMATTR_DEFAULT
167#define	pmap_page_is_mapped(m)	(!TAILQ_EMPTY(&(m)->md.pv_list))
168#define	pmap_page_is_write_mapped(m)	(((m)->aflags & PGA_WRITEABLE) != 0)
169
170void pmap_bootstrap(void);
171void *pmap_mapdev(vm_paddr_t, vm_size_t);
172void pmap_unmapdev(vm_offset_t, vm_size_t);
173vm_offset_t pmap_steal_memory(vm_size_t size);
174void pmap_kenter(vm_offset_t va, vm_paddr_t pa);
175void pmap_kenter_attr(vm_offset_t va, vm_paddr_t pa, int attr);
176void pmap_kremove(vm_offset_t va);
177void *pmap_kenter_temporary(vm_paddr_t pa, int i);
178void pmap_kenter_temporary_free(vm_paddr_t pa);
179void pmap_flush_pvcache(vm_page_t m);
180int pmap_emulate_modified(pmap_t pmap, vm_offset_t va);
181void pmap_page_set_memattr(vm_page_t, vm_memattr_t);
182
183#endif				/* _KERNEL */
184
185#endif				/* !LOCORE */
186
187#endif				/* !_MACHINE_PMAP_H_ */
188