xref: /freebsd/sys/fs/pseudofs/pseudofs_vncache.c (revision ee2ea5ceafed78a5bd9810beb9e3ca927180c226)
1 /*-
2  * Copyright (c) 2001 Dag-Erling Co�dan Sm�rgrav
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer
10  *    in this position and unchanged.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. The name of the author may not be used to endorse or promote products
15  *    derived from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  *      $FreeBSD$
29  */
30 
31 #include <sys/param.h>
32 #include <sys/kernel.h>
33 #include <sys/systm.h>
34 #include <sys/lock.h>
35 #include <sys/malloc.h>
36 #include <sys/mutex.h>
37 #include <sys/proc.h>
38 #include <sys/sysctl.h>
39 #include <sys/vnode.h>
40 
41 #include <fs/pseudofs/pseudofs.h>
42 #include <fs/pseudofs/pseudofs_internal.h>
43 
44 static MALLOC_DEFINE(M_PFSVNCACHE, "pfs_vncache", "pseudofs vnode cache");
45 
46 static struct mtx pfs_vncache_mutex;
47 static struct pfs_vdata *pfs_vncache;
48 static void pfs_exit(struct proc *p);
49 
50 SYSCTL_NODE(_vfs_pfs, OID_AUTO, vncache, CTLFLAG_RW, 0,
51     "pseudofs vnode cache");
52 
53 static int pfs_vncache_entries;
54 SYSCTL_INT(_vfs_pfs_vncache, OID_AUTO, entries, CTLFLAG_RD,
55     &pfs_vncache_entries, 0,
56     "number of entries in the vnode cache");
57 
58 static int pfs_vncache_maxentries;
59 SYSCTL_INT(_vfs_pfs_vncache, OID_AUTO, maxentries, CTLFLAG_RD,
60     &pfs_vncache_maxentries, 0,
61     "highest number of entries in the vnode cache");
62 
63 static int pfs_vncache_hits;
64 SYSCTL_INT(_vfs_pfs_vncache, OID_AUTO, hits, CTLFLAG_RD,
65     &pfs_vncache_hits, 0,
66     "number of cache hits since initialization");
67 
68 static int pfs_vncache_misses;
69 SYSCTL_INT(_vfs_pfs_vncache, OID_AUTO, misses, CTLFLAG_RD,
70     &pfs_vncache_misses, 0,
71     "number of cache misses since initialization");
72 
73 extern vop_t **pfs_vnodeop_p;
74 
75 /*
76  * Initialize vnode cache
77  */
78 void
79 pfs_vncache_load(void)
80 {
81 	mtx_init(&pfs_vncache_mutex, "pseudofs_vncache", NULL,
82 	    MTX_DEF | MTX_RECURSE);
83 	/* XXX at_exit() can fail with ENOMEN */
84 	at_exit(pfs_exit);
85 }
86 
87 /*
88  * Tear down vnode cache
89  */
90 void
91 pfs_vncache_unload(void)
92 {
93 	rm_at_exit(pfs_exit);
94 	if (pfs_vncache_entries != 0)
95 		printf("pfs_vncache_unload(): %d entries remaining\n",
96 		    pfs_vncache_entries);
97 	mtx_destroy(&pfs_vncache_mutex);
98 }
99 
100 /*
101  * Allocate a vnode
102  */
103 int
104 pfs_vncache_alloc(struct mount *mp, struct vnode **vpp,
105 		  struct pfs_node *pn, pid_t pid)
106 {
107 	struct pfs_vdata *pvd;
108 	int error;
109 
110 	/*
111 	 * See if the vnode is in the cache.
112 	 * XXX linear search is not very efficient.
113 	 */
114 	mtx_lock(&pfs_vncache_mutex);
115 	for (pvd = pfs_vncache; pvd; pvd = pvd->pvd_next) {
116 		if (pvd->pvd_pn == pn && pvd->pvd_pid == pid) {
117 			if (vget(pvd->pvd_vnode, 0, curthread) == 0) {
118 				++pfs_vncache_hits;
119 				*vpp = pvd->pvd_vnode;
120 				mtx_unlock(&pfs_vncache_mutex);
121 				/* XXX see comment at top of pfs_lookup() */
122 				cache_purge(*vpp);
123 				return (0);
124 			}
125 			/* XXX if this can happen, we're in trouble */
126 			break;
127 		}
128 	}
129 	mtx_unlock(&pfs_vncache_mutex);
130 	++pfs_vncache_misses;
131 
132 	/* nope, get a new one */
133 	MALLOC(pvd, struct pfs_vdata *, sizeof *pvd, M_PFSVNCACHE, M_WAITOK);
134 	if (++pfs_vncache_entries > pfs_vncache_maxentries)
135 		pfs_vncache_maxentries = pfs_vncache_entries;
136 	error = getnewvnode(VT_PSEUDOFS, mp, pfs_vnodeop_p, vpp);
137 	if (error)
138 		return (error);
139 	pvd->pvd_pn = pn;
140 	pvd->pvd_pid = pid;
141 	(*vpp)->v_data = pvd;
142 	switch (pn->pn_type) {
143 	case pfstype_root:
144 		(*vpp)->v_flag = VROOT;
145 #if 0
146 		printf("root vnode allocated\n");
147 #endif
148 		/* fall through */
149 	case pfstype_dir:
150 	case pfstype_this:
151 	case pfstype_parent:
152 	case pfstype_procdir:
153 		(*vpp)->v_type = VDIR;
154 		break;
155 	case pfstype_file:
156 		(*vpp)->v_type = VREG;
157 		break;
158 	case pfstype_symlink:
159 		(*vpp)->v_type = VLNK;
160 		break;
161 	case pfstype_none:
162 		KASSERT(0, ("pfs_vncache_alloc called for null node\n"));
163 	default:
164 		panic("%s has unexpected type: %d", pn->pn_name, pn->pn_type);
165 	}
166 	pvd->pvd_vnode = *vpp;
167 	mtx_lock(&pfs_vncache_mutex);
168 	pvd->pvd_prev = NULL;
169 	pvd->pvd_next = pfs_vncache;
170 	if (pvd->pvd_next)
171 		pvd->pvd_next->pvd_prev = pvd;
172 	pfs_vncache = pvd;
173 	mtx_unlock(&pfs_vncache_mutex);
174 	return (0);
175 }
176 
177 /*
178  * Free a vnode
179  */
180 int
181 pfs_vncache_free(struct vnode *vp)
182 {
183 	struct pfs_vdata *pvd;
184 
185 	cache_purge(vp);
186 
187 	mtx_lock(&pfs_vncache_mutex);
188 	pvd = (struct pfs_vdata *)vp->v_data;
189 	KASSERT(pvd != NULL, ("pfs_vncache_free(): no vnode data\n"));
190 	if (pvd->pvd_next)
191 		pvd->pvd_next->pvd_prev = pvd->pvd_prev;
192 	if (pvd->pvd_prev)
193 		pvd->pvd_prev->pvd_next = pvd->pvd_next;
194 	else
195 		pfs_vncache = pvd->pvd_next;
196 	mtx_unlock(&pfs_vncache_mutex);
197 
198 	--pfs_vncache_entries;
199 	FREE(pvd, M_PFSVNCACHE);
200 	vp->v_data = NULL;
201 	return (0);
202 }
203 
204 /*
205  * Free all vnodes associated with a defunct process
206  */
207 static void
208 pfs_exit(struct proc *p)
209 {
210 	struct pfs_vdata *pvd, *prev;
211 
212 	mtx_lock(&pfs_vncache_mutex);
213 	/*
214 	 * The double loop is necessary because vgone() indirectly
215 	 * calls pfs_vncache_free() which frees pvd, so we have to
216 	 * backtrace one step every time we free a vnode.
217 	 */
218 	/* XXX linear search... not very efficient */
219 	for (pvd = pfs_vncache; pvd != NULL; pvd = pvd->pvd_next) {
220 		while (pvd != NULL && pvd->pvd_pid == p->p_pid) {
221 			prev = pvd->pvd_prev;
222 			vgone(pvd->pvd_vnode);
223 			pvd = prev ? prev->pvd_next : pfs_vncache;
224 		}
225 		if (pvd == NULL)
226 			break;
227 	}
228 	mtx_unlock(&pfs_vncache_mutex);
229 }
230 
231 /*
232  * Disable a pseudofs node, and free all vnodes associated with it
233  */
234 int
235 pfs_disable(struct pfs_node *pn)
236 {
237 	struct pfs_vdata *pvd, *prev;
238 
239 	if (pn->pn_flags & PFS_DISABLED)
240 		return (0);
241 	mtx_lock(&pfs_vncache_mutex);
242 	pn->pn_flags |= PFS_DISABLED;
243 	/* see the comment about the double loop in pfs_exit() */
244 	/* XXX linear search... not very efficient */
245 	for (pvd = pfs_vncache; pvd != NULL; pvd = pvd->pvd_next) {
246 		while (pvd != NULL && pvd->pvd_pn == pn) {
247 			prev = pvd->pvd_prev;
248 			vgone(pvd->pvd_vnode);
249 			pvd = prev ? prev->pvd_next : pfs_vncache;
250 		}
251 		if (pvd == NULL)
252 			break;
253 	}
254 	mtx_unlock(&pfs_vncache_mutex);
255 	return (0);
256 }
257 
258 /*
259  * Re-enable a disabled pseudofs node
260  */
261 int
262 pfs_enable(struct pfs_node *pn)
263 {
264 	pn->pn_flags &= ~PFS_DISABLED;
265 	return (0);
266 }
267