xref: /illumos-gate/usr/src/uts/sun4v/sys/pte.h (revision 4703203d)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef _SYS_PTE_H
28 #define	_SYS_PTE_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #ifndef _ASM
33 #include <sys/types.h>
34 #endif /* _ASM */
35 
36 #ifdef	__cplusplus
37 extern "C" {
38 #endif
39 
40 #ifndef _ASM
41 /*
42  * The tte struct is a 64 bit data type.  Since we currently plan to
43  * use a V8 compiler all manipulations in C will be done using the bit fields
44  * or as 2 integers.  In assembly code we will deal with it as a double (using
45  * ldx and stx).  The structure is defined to force a double alignment.
46  */
47 typedef union {
48 	struct tte {
49 		unsigned int	v:1;		/* <63> valid */
50 		unsigned int	nfo:1;		/* <62> non-fault only */
51 		unsigned int	hmenum:3;	/* <61:59> sw hmenum */
52 		unsigned int	no_sync:1;	/* <58> sw - ghost unload */
53 		unsigned int	lock:1;		/* <57> sw - locked */
54 		unsigned int	susp:1;		/* <56> sw - suspend? */
55 		unsigned int	pahi:24;	/* <55:32> pa */
56 		/* ------------------- */
57 		unsigned int	palo:19;	/* <31:13> pa */
58 		unsigned int	ie:1;		/* <12> 1=invert endianness */
59 		unsigned int	e:1;		/* <11> side effect */
60 		unsigned int	cp:1;		/* <10> physically cache */
61 		unsigned int	cv:1;		/* <9> virtually cache */
62 		unsigned int	p:1;		/* <8> privilege required */
63 		unsigned int	x:1;		/* <7> execute perm */
64 		unsigned int	w:1;		/* <6> write perm */
65 		unsigned int	ref:1;		/* <5> sw - ref */
66 		unsigned int	wr_perm:1;	/* <4> sw - write perm */
67 		unsigned int	rsvd:1;		/* <3> reserved */
68 		unsigned int	sz:3;		/* <2:0> pagesize */
69 	} tte_bit;
70 	struct {
71 		int32_t		inthi;
72 		uint32_t	intlo;
73 	} tte_int;
74 	uint64_t		ll;
75 } tte_t;
76 
77 #define	tte_val 	tte_bit.v		/* use < 0 check in asm */
78 #define	tte_size	tte_bit.sz
79 #define	tte_nfo		tte_bit.nfo
80 #define	tte_ie		tte_bit.ie		/* XXX? */
81 #define	tte_hmenum	tte_bit.hmenum
82 #define	tte_pahi	tte_bit.pahi
83 #define	tte_palo	tte_bit.palo
84 #define	tte_ref		tte_bit.ref
85 #define	tte_wr_perm	tte_bit.wr_perm
86 #define	tte_no_sync	tte_bit.no_sync
87 #define	tte_suspend	tte_bit.susp
88 #define	tte_exec_perm	tte_bit.x
89 #define	tte_lock	tte_bit.lock
90 #define	tte_cp		tte_bit.cp
91 #define	tte_cv		tte_bit.cv
92 #define	tte_se		tte_bit.e
93 #define	tte_priv	tte_bit.p
94 #define	tte_hwwr	tte_bit.w
95 
96 #define	tte_inthi	tte_int.inthi
97 #define	tte_intlo	tte_int.intlo
98 
99 #endif /* !_ASM */
100 
101 /* Defines for sz field in tte */
102 #define	TTE8K			0x0
103 #define	TTE64K			0x1
104 #define	TTE512K			0x2
105 #define	TTE4M			0x3
106 #define	TTE32M			0x4
107 #define	TTE256M			0x5
108 #define	TTE2G			0x6
109 #define	TTE16G			0x7
110 
111 #define	TTE_SZ_SHFT		0
112 #define	TTE_SZ_BITS		0x7
113 
114 #define	TTE_CSZ(ttep)	((ttep)->tte_size)
115 
116 #define	TTE_BSZS_SHIFT(sz)	((sz) * 3)
117 #define	TTEBYTES(sz)	(MMU_PAGESIZE << TTE_BSZS_SHIFT(sz))
118 #define	TTEPAGES(sz)	(1 << TTE_BSZS_SHIFT(sz))
119 #define	TTE_PAGE_SHIFT(sz)	(MMU_PAGESHIFT + TTE_BSZS_SHIFT(sz))
120 #define	TTE_PAGE_OFFSET(sz)	(TTEBYTES(sz) - 1)
121 #define	TTE_PAGEMASK(sz)	(~TTE_PAGE_OFFSET(sz))
122 #define	TTE_PFNMASK(sz)	(~(TTE_PAGE_OFFSET(sz) >> MMU_PAGESHIFT))
123 
124 #define	TTE_PA_LSHIFT	8	/* used to do sllx on tte to get pa */
125 
126 #ifndef _ASM
127 
128 #define	TTE_PASHIFT	19	/* used to manage pahi and palo */
129 #define	TTE_PALOMASK	((1 << TTE_PASHIFT) -1)
130 /* PFN is defined as bits [40-13] of the physical address */
131 #define	TTE_TO_TTEPFN(ttep)						\
132 	((((ttep)->tte_pahi << TTE_PASHIFT) | (ttep)->tte_palo) &	\
133 	TTE_PFNMASK(TTE_CSZ(ttep)))
134 /*
135  * This define adds the vaddr page offset to obtain a correct pfn
136  */
137 #define	TTE_TO_PFN(vaddr, ttep)						\
138 	(sfmmu_ttetopfn(ttep, vaddr))
139 
140 #define	PFN_TO_TTE(entry, pfn) {			\
141 	entry.tte_pahi = pfn >> TTE_PASHIFT;	\
142 	entry.tte_palo = pfn & TTE_PALOMASK;	\
143 	}
144 
145 #endif /* !_ASM */
146 
147 /*
148  * The tte defines are separated into integers because the compiler doesn't
149  * support 64bit defines.
150  */
151 /* Defines for tte using inthi */
152 #define	TTE_VALID_INT			0x80000000
153 #define	TTE_NFO_INT			0x40000000
154 #define	TTE_NOSYNC_INT			0x04000000
155 #define	TTE_SUSPEND			0x01000000
156 #define	TTE_SUSPEND_SHIFT		32
157 
158 /* Defines for tte using intlo */
159 #define	TTE_IE_INT			0x00001000
160 #define	TTE_SIDEFF_INT			0x00000800
161 #define	TTE_CP_INT			0x00000400
162 #define	TTE_CV_INT			0x00000200
163 #define	TTE_PRIV_INT			0x00000100
164 #define	TTE_EXECPRM_INT			0x00000080
165 #define	TTE_HWWR_INT			0x00000040
166 #define	TTE_REF_INT			0x00000020
167 #define	TTE_WRPRM_INT			0x00000010
168 
169 #define	TTE_PROT_INT			(TTE_WRPRM_INT | TTE_PRIV_INT)
170 
171 #ifndef ASM
172 
173 /* Defines to help build ttes using inthi */
174 #define	TTE_SZ_INTLO(sz)		((sz) & TTE_SZ_BITS)
175 #define	TTE_HMENUM_INT(hmenum)		((hmenum) << 27)
176 
177 /* PFN is defined as bits [40-13] of the physical address */
178 #define	TTE_PFN_INTHI(pfn)		((pfn) >> TTE_PASHIFT)
179 #define	TTE_VALID_CHECK(attr)	\
180 	(((attr) & PROT_ALL) ? TTE_VALID_INT : 0)
181 #define	TTE_NFO_CHECK(attr)	\
182 	(((attr) & HAT_NOFAULT) ? TTE_NFO_INT : 0)
183 
184 /* Defines to help build ttes using intlo */
185 #define	TTE_PFN_INTLO(pfn)		(((pfn) & TTE_PALOMASK) << 13)
186 #define	TTE_IE_CHECK(attr)	\
187 	(((attr) & HAT_STRUCTURE_LE) ? TTE_IE_INT : 0)
188 #define	TTE_WRPRM_CHECK(attr)	 \
189 	(((attr) & PROT_WRITE) ? TTE_WRPRM_INT : 0)
190 #define	TTE_EXECPRM_CHECK(attr)	 \
191 	(((attr) & PROT_EXEC) ? TTE_EXECPRM_INT : 0)
192 #define	TTE_NOSYNC_CHECK(attr)	 \
193 	(((attr) & HAT_NOSYNC) ? TTE_NOSYNC_INT : 0)
194 #define	TTE_CP_CHECK(attr)	\
195 	(((attr) & SFMMU_UNCACHEPTTE) ? 0: TTE_CP_INT)
196 #define	TTE_CV_CHECK(attr)	\
197 	(((attr) & SFMMU_UNCACHEVTTE) ? 0: TTE_CV_INT)
198 #define	TTE_SE_CHECK(attr)	\
199 	(((attr) & SFMMU_SIDEFFECT) ? TTE_SIDEFF_INT : 0)
200 #define	TTE_PRIV_CHECK(attr)	\
201 	(((attr) & PROT_USER) ? 0 : TTE_PRIV_INT)
202 
203 #define	MAKE_TTEATTR_INTHI(attr)				\
204 	(TTE_VALID_CHECK(attr) | TTE_NFO_CHECK(attr))
205 
206 #define	MAKE_TTE_INTHI(pfn, attr, sz, hmenum)			\
207 	(MAKE_TTEATTR_INTHI(attr) | TTE_HMENUM_INT(hmenum) |	\
208 	TTE_NOSYNC_CHECK(attr) | TTE_PFN_INTHI(pfn))
209 
210 #define	MAKE_TTEATTR_INTLO(attr)					\
211 	(TTE_WRPRM_CHECK(attr) | TTE_CP_CHECK(attr) | TTE_CV_CHECK(attr) | \
212 	TTE_SE_CHECK(attr) | TTE_PRIV_CHECK(attr) | TTE_EXECPRM_CHECK(attr) | \
213 	TTE_IE_CHECK(attr))
214 
215 #define	MAKE_TTE_INTLO(pfn, attr, sz, hmenum)				\
216 	(TTE_PFN_INTLO(pfn) | TTE_REF_INT | MAKE_TTEATTR_INTLO(attr) | \
217 	TTE_SZ_INTLO(sz))
218 
219 #define	TTEINTHI_ATTR	(TTE_VALID_INT | TTE_NFO_INT | TTE_NOSYNC_INT)
220 
221 #define	TTEINTLO_ATTR							\
222 	(TTE_IE_INT | TTE_WRPRM_INT | TTE_CP_INT | TTE_CV_INT |		\
223 	TTE_SIDEFF_INT | TTE_PRIV_INT | TTE_EXECPRM_INT)
224 
225 #define	MAKE_TTE_MASK(ttep)				\
226 	{						\
227 		(ttep)->tte_bit.v = 1;			\
228 		(ttep)->tte_bit.nfo = 1;		\
229 		(ttep)->tte_bit.pahi = 0xffffff;	\
230 		(ttep)->tte_bit.palo = 0x7ffff;		\
231 		(ttep)->tte_bit.ie = 1;			\
232 		(ttep)->tte_bit.e = 1;			\
233 		(ttep)->tte_bit.cp = 1;			\
234 		(ttep)->tte_bit.cv = 1;			\
235 		(ttep)->tte_bit.p = 1;			\
236 		(ttep)->tte_bit.x = 1;			\
237 		(ttep)->tte_bit.w = 1;			\
238 		(ttep)->tte_bit.sz = 7;			\
239 	}
240 
241 /*
242  * Defines to check/set TTE bits.
243  */
244 #define	TTE_IS_VALID(ttep)	((ttep)->tte_inthi < 0)
245 #define	TTE_SET_INVALID(ttep)	((ttep)->tte_val = 0)
246 #define	TTE_IS_8K(ttep)		(TTE_CSZ(ttep) == TTE8K)
247 #define	TTE_IS_WRITABLE(ttep)	((ttep)->tte_wr_perm)
248 #define	TTE_IS_EXECUTABLE(ttep)	((ttep)->tte_exec_perm)
249 #define	TTE_IS_PRIVILEGED(ttep)	((ttep)->tte_priv)
250 #define	TTE_IS_NOSYNC(ttep)	((ttep)->tte_no_sync)
251 #define	TTE_IS_LOCKED(ttep)	((ttep)->tte_lock)
252 #define	TTE_IS_SIDEFFECT(ttep)	((ttep)->tte_se)
253 #define	TTE_IS_NFO(ttep)	((ttep)->tte_nfo)
254 
255 #define	TTE_IS_REF(ttep)	((ttep)->tte_ref)
256 #define	TTE_IS_MOD(ttep)	((ttep)->tte_hwwr)
257 #define	TTE_IS_IE(ttep)		((ttep)->tte_ie)
258 #define	TTE_SET_SUSPEND(ttep)	((ttep)->tte_suspend = 1)
259 #define	TTE_CLR_SUSPEND(ttep)	((ttep)->tte_suspend = 0)
260 #define	TTE_IS_SUSPEND(ttep)	((ttep)->tte_suspend)
261 #define	TTE_SET_REF(ttep)	((ttep)->tte_ref = 1)
262 #define	TTE_CLR_REF(ttep)	((ttep)->tte_ref = 0)
263 #define	TTE_SET_LOCKED(ttep)	((ttep)->tte_lock = 1)
264 #define	TTE_CLR_LOCKED(ttep)	((ttep)->tte_lock = 0)
265 #define	TTE_SET_MOD(ttep)	((ttep)->tte_hwwr = 1)
266 #define	TTE_CLR_MOD(ttep)	((ttep)->tte_hwwr = 0)
267 #define	TTE_SET_RM(ttep)						\
268 	(((ttep)->tte_intlo) =						\
269 	(ttep)->tte_intlo | TTE_HWWR_INT | TTE_REF_INT)
270 #define	TTE_CLR_RM(ttep)						\
271 	(((ttep)->tte_intlo) =						\
272 	(ttep)->tte_intlo & ~(TTE_HWWR_INT | TTE_REF_INT))
273 
274 #define	TTE_SET_WRT(ttep)	((ttep)->tte_wr_perm = 1)
275 #define	TTE_CLR_WRT(ttep)	((ttep)->tte_wr_perm = 0)
276 #define	TTE_SET_EXEC(ttep)	((ttep)->tte_exec_perm = 1)
277 #define	TTE_CLR_EXEC(ttep)	((ttep)->tte_exec_perm = 0)
278 #define	TTE_SET_PRIV(ttep)	((ttep)->tte_priv = 1)
279 #define	TTE_CLR_PRIV(ttep)	((ttep)->tte_priv = 0)
280 
281 #define	TTE_IS_VCACHEABLE(ttep)		((ttep)->tte_cv)
282 #define	TTE_SET_VCACHEABLE(ttep)	((ttep)->tte_cv = 1)
283 #define	TTE_CLR_VCACHEABLE(ttep)	((ttep)->tte_cv = 0)
284 #define	TTE_IS_PCACHEABLE(ttep)		((ttep)->tte_cp)
285 #define	TTE_SET_PCACHEABLE(ttep)	((ttep)->tte_cp = 1)
286 #define	TTE_CLR_PCACHEABLE(ttep)	((ttep)->tte_cp = 0)
287 
288 
289 #define	KPM_TTE_VCACHED(tte64, pfn, tte_sz)				\
290 	tte64 = ((uint64_t)TTE_VALID_INT << 32) |			\
291 	    ((uint64_t)((tte_sz) << TTE_SZ_SHFT)) |			\
292 	    (((pfn) >> TTE_BSZS_SHIFT(tte_sz)) <<			\
293 	    (TTE_BSZS_SHIFT(tte_sz) + MMU_PAGESHIFT)) |			\
294 	    (TTE_CP_INT | TTE_CV_INT | TTE_PRIV_INT | TTE_HWWR_INT)
295 
296 #define	KPM_TTE_VUNCACHED(tte64, pfn, tte_sz)				\
297 	tte64 = ((uint64_t)TTE_VALID_INT << 32) |			\
298 	    ((uint64_t)((tte_sz) << TTE_SZ_SHFT)) |			\
299 	    (((pfn) >> TTE_BSZS_SHIFT(tte_sz)) <<			\
300 	    (TTE_BSZS_SHIFT(tte_sz) + MMU_PAGESHIFT)) |			\
301 	    (TTE_CP_INT | TTE_PRIV_INT | TTE_HWWR_INT)
302 
303 
304 /*
305  * This define provides a generic method to set and clear multiple tte flags.
306  * A bitmask of all flags to be affected is passed in "flags" and a bitmask
307  * of the new values is passed in "newflags".
308  */
309 #define	TTE_SET_LOFLAGS(ttep, flags, newflags)				\
310 	((ttep)->tte_intlo = ((ttep)->tte_intlo & ~(flags)) | (newflags))
311 
312 #define	TTE_GET_LOFLAGS(ttep, flags)	((ttep)->tte_intlo & flags)
313 
314 #endif /* !_ASM */
315 
316 #ifdef	__cplusplus
317 }
318 #endif
319 
320 #endif /* !_SYS_PTE_H */
321