1/*	$NetBSD: pmap_tlb.h,v 1.17 2023/10/06 08:48:16 skrll Exp $	*/
2
3/*
4 * Copyright (c) 1992, 1993
5 *	The Regents of the University of California.  All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * Ralph Campbell.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 *    may be used to endorse or promote products derived from this software
20 *    without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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 *	@(#)pmap.h	8.1 (Berkeley) 6/10/93
35 */
36
37/*
38 * Copyright (c) 1987 Carnegie-Mellon University
39 *
40 * This code is derived from software contributed to Berkeley by
41 * Ralph Campbell.
42 *
43 * Redistribution and use in source and binary forms, with or without
44 * modification, are permitted provided that the following conditions
45 * are met:
46 * 1. Redistributions of source code must retain the above copyright
47 *    notice, this list of conditions and the following disclaimer.
48 * 2. Redistributions in binary form must reproduce the above copyright
49 *    notice, this list of conditions and the following disclaimer in the
50 *    documentation and/or other materials provided with the distribution.
51 * 3. All advertising materials mentioning features or use of this software
52 *    must display the following acknowledgement:
53 *	This product includes software developed by the University of
54 *	California, Berkeley and its contributors.
55 * 4. Neither the name of the University nor the names of its contributors
56 *    may be used to endorse or promote products derived from this software
57 *    without specific prior written permission.
58 *
59 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69 * SUCH DAMAGE.
70 *
71 *	@(#)pmap.h	8.1 (Berkeley) 6/10/93
72 */
73
74#ifndef	_UVM_PMAP_PMAP_TLB_H_
75#define	_UVM_PMAP_PMAP_TLB_H_
76
77#include <sys/evcnt.h>
78#include <sys/kcpuset.h>
79#include <sys/bitops.h>
80
81#if !defined(PMAP_TLB_MAX)
82# if defined(MULTIPROCESSOR)
83#  define PMAP_TLB_MAX		MAXCPUS
84# else
85#  define PMAP_TLB_MAX		1
86# endif
87#endif
88
89#if !defined(PMAP_TLB_ALWAYS_ASIDS)
90#define	PMAP_TLB_ALWAYS_ASIDS	true
91#endif
92
93/*
94 * Per TLB (normally same as CPU) asid info
95 */
96struct pmap_asid_info {
97	LIST_ENTRY(pmap_asid_info) pai_link;
98	uint32_t	pai_asid;	/* TLB address space tag */
99};
100
101#define	TLBINFO_LOCK(ti)		mutex_spin_enter((ti)->ti_lock)
102#define	TLBINFO_UNLOCK(ti)		mutex_spin_exit((ti)->ti_lock)
103#define	TLBINFO_OWNED(ti)		mutex_owned((ti)->ti_lock)
104#define	PMAP_PAI_ASIDVALID_P(pai, ti)	(!tlbinfo_asids_p(ti) || (pai)->pai_asid != 0)
105#define	PMAP_PAI(pmap, ti)		(&(pmap)->pm_pai[tlbinfo_index(ti)])
106#define	PAI_PMAP(pai, ti)	\
107	((pmap_t)((intptr_t)(pai) \
108	    - offsetof(struct pmap, pm_pai[tlbinfo_index(ti)])))
109
110enum tlb_invalidate_op {
111	TLBINV_NOBODY = 0,
112	TLBINV_ONE = 1,
113	TLBINV_ALLUSER = 2,
114	TLBINV_ALLKERNEL = 3,
115	TLBINV_ALL = 4
116};
117
118struct pmap_tlb_info {
119	char ti_name[8];
120	uint32_t ti_asids_free;		/* # of ASIDs free */
121#define	tlbinfo_noasids_p(ti)	((ti)->ti_asids_free == 0)
122	kmutex_t *ti_lock;
123	u_int ti_wired;			/* # of wired TLB entries */
124	tlb_asid_t ti_asid_hint;	/* probable next ASID to use */
125	tlb_asid_t ti_asid_max;
126	LIST_HEAD(, pmap_asid_info) ti_pais; /* list of active ASIDs */
127#ifdef MULTIPROCESSOR
128	pmap_t ti_victim;
129	uint32_t ti_synci_page_bitmap;	/* page indices needing a syncicache */
130#if PMAP_TLB_MAX > 1
131	kcpuset_t *ti_kcpuset;		/* bitmask of CPUs sharing this TLB */
132	u_int ti_index;
133	enum tlb_invalidate_op ti_tlbinvop;
134#define tlbinfo_index(ti)	((ti)->ti_index)
135#else
136#define tlbinfo_index(ti)	((void)(ti), 0)
137#endif
138#if !defined(PMAP_TLB_NO_SYNCI_EVCNT)
139	struct evcnt ti_evcnt_synci_asts;
140	struct evcnt ti_evcnt_synci_all;
141	struct evcnt ti_evcnt_synci_pages;
142	struct evcnt ti_evcnt_synci_deferred;
143	struct evcnt ti_evcnt_synci_desired;
144	struct evcnt ti_evcnt_synci_duplicate;
145#endif /* !PMAP_TLB_NO_SYNCI_EVCNT */
146#else
147#define tlbinfo_index(ti)	((void)(ti), 0)
148#endif
149	struct evcnt ti_evcnt_asid_reinits;
150#ifndef PMAP_TLB_BITMAP_LENGTH
151#define	PMAP_TLB_BITMAP_LENGTH 256
152#endif
153	__BITMAP_TYPE(, u_long, PMAP_TLB_BITMAP_LENGTH) ti_asid_bitmap;
154};
155
156#ifdef	_KERNEL
157extern struct pmap_tlb_info pmap_tlb0_info;
158#ifdef MULTIPROCESSOR
159extern struct pmap_tlb_info *pmap_tlbs[PMAP_TLB_MAX];
160extern u_int pmap_ntlbs;
161#endif
162
163#ifndef cpu_set_tlb_info
164# define cpu_set_tlb_info(ci, ti)	((void)((ci)->ci_tlb_info = (ti)))
165#endif
166#ifndef cpu_tlb_info
167# if PMAP_TLB_MAX > 1
168#  define cpu_tlb_info(ci)		((ci)->ci_tlb_info)
169# else
170#  define cpu_tlb_info(ci)		(&pmap_tlb0_info)
171# endif
172#endif
173
174#ifdef MULTIPROCESSOR
175void	pmap_tlb_shootdown_process(void);
176bool	pmap_tlb_shootdown_bystanders(pmap_t pmap);
177void	pmap_tlb_info_attach(struct pmap_tlb_info *, struct cpu_info *);
178void	pmap_md_tlb_info_attach(struct pmap_tlb_info *, struct cpu_info *);
179#endif
180void	pmap_tlb_info_init(struct pmap_tlb_info *);
181void	pmap_tlb_info_evcnt_attach(struct pmap_tlb_info *);
182void	pmap_tlb_asid_acquire(pmap_t, struct lwp *l);
183void	pmap_tlb_asid_deactivate(pmap_t);
184void	pmap_tlb_asid_release_all(pmap_t);
185int	pmap_tlb_update_addr(pmap_t, vaddr_t, pt_entry_t, u_int);
186#define	PMAP_TLB_NEED_IPI	0x01
187#define	PMAP_TLB_INSERT		0x02
188void	pmap_tlb_invalidate_addr(pmap_t, vaddr_t);
189void	pmap_tlb_check(pmap_t, bool (*)(void *, vaddr_t, tlb_asid_t, pt_entry_t));
190void	pmap_tlb_asid_check(void);
191
192/* for ddb */
193void pmap_db_tlb_print(struct pmap *, void (*)(const char *, ...) __printflike(1, 2));
194
195static inline bool
196tlbinfo_asids_p(struct pmap_tlb_info *ti)
197{
198	return PMAP_TLB_ALWAYS_ASIDS || (ti)->ti_asid_max != 0;
199}
200
201#endif	/* _KERNEL */
202#endif	/* _UVM_PMAP_PMAP_TLB_H_ */
203