xref: /dragonfly/sys/vfs/smbfs/smbfs_node.c (revision e8364298)
1 /*
2  * Copyright (c) 2000-2001 Boris Popov
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  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *    This product includes software developed by Boris Popov.
16  * 4. Neither the name of the author nor the names of any co-contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  * $FreeBSD: src/sys/fs/smbfs/smbfs_node.c,v 1.2.2.3 2003/01/17 08:20:26 tjr Exp $
33  * $DragonFly: src/sys/vfs/smbfs/smbfs_node.c,v 1.10 2004/05/03 05:19:50 cpressey Exp $
34  */
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
38 #include <sys/time.h>
39 #include <sys/proc.h>
40 #include <sys/mount.h>
41 #include <sys/vnode.h>
42 #include <sys/malloc.h>
43 #include <sys/sysctl.h>
44 #include <vm/vm.h>
45 #include <vm/vm_extern.h>
46 /*#include <vm/vm_page.h>
47 #include <vm/vm_object.h>*/
48 #include <sys/queue.h>
49 
50 #include <netproto/smb/smb.h>
51 #include <netproto/smb/smb_conn.h>
52 #include <netproto/smb/smb_subr.h>
53 
54 #include "smbfs.h"
55 #include "smbfs_node.h"
56 #include "smbfs_subr.h"
57 
58 #define	SMBFS_NOHASH(smp, hval)	(&(smp)->sm_hash[(hval) & (smp)->sm_hashlen])
59 #define	smbfs_hash_lock(smp, td)	lockmgr(&smp->sm_hashlock, LK_EXCLUSIVE, NULL, td)
60 #define	smbfs_hash_unlock(smp, td)	lockmgr(&smp->sm_hashlock, LK_RELEASE, NULL, td)
61 
62 
63 extern vop_t **smbfs_vnodeop_p;
64 
65 MALLOC_DEFINE(M_SMBNODE, "SMBFS node", "SMBFS vnode private part");
66 static MALLOC_DEFINE(M_SMBNODENAME, "SMBFS nname", "SMBFS node name");
67 
68 int smbfs_hashprint(struct mount *mp);
69 
70 #if 0
71 #ifdef SYSCTL_DECL
72 SYSCTL_DECL(_vfs_smbfs);
73 #endif
74 SYSCTL_PROC(_vfs_smbfs, OID_AUTO, vnprint, CTLFLAG_WR|CTLTYPE_OPAQUE,
75 	    NULL, 0, smbfs_hashprint, "S,vnlist", "vnode hash");
76 #endif
77 
78 #define	FNV_32_PRIME ((u_int32_t) 0x01000193UL)
79 #define	FNV1_32_INIT ((u_int32_t) 33554467UL)
80 
81 u_int32_t
82 smbfs_hash(const u_char *name, int nmlen)
83 {
84 	u_int32_t v;
85 
86 	for (v = FNV1_32_INIT; nmlen; name++, nmlen--) {
87 		v *= FNV_32_PRIME;
88 		v ^= (u_int32_t)*name;
89 	}
90 	return v;
91 }
92 
93 int
94 smbfs_hashprint(struct mount *mp)
95 {
96 	struct smbmount *smp = VFSTOSMBFS(mp);
97 	struct smbnode_hashhead *nhpp;
98 	struct smbnode *np;
99 	int i;
100 
101 	for(i = 0; i <= smp->sm_hashlen; i++) {
102 		nhpp = &smp->sm_hash[i];
103 		LIST_FOREACH(np, nhpp, n_hash)
104 			vprint(NULL, SMBTOV(np));
105 	}
106 	return 0;
107 }
108 
109 static char *
110 smbfs_name_alloc(const u_char *name, int nmlen)
111 {
112 	u_char *cp;
113 
114 	nmlen++;
115 #ifdef SMBFS_NAME_DEBUG
116 	cp = malloc(nmlen + 2 + sizeof(int), M_SMBNODENAME, M_WAITOK);
117 	*(int*)cp = nmlen;
118 	cp += sizeof(int);
119 	cp[0] = 0xfc;
120 	cp++;
121 	bcopy(name, cp, nmlen - 1);
122 	cp[nmlen] = 0xfe;
123 #else
124 	cp = malloc(nmlen, M_SMBNODENAME, M_WAITOK);
125 	bcopy(name, cp, nmlen - 1);
126 #endif
127 	cp[nmlen - 1] = 0;
128 	return cp;
129 }
130 
131 static void
132 smbfs_name_free(u_char *name)
133 {
134 #ifdef SMBFS_NAME_DEBUG
135 	int nmlen, slen;
136 	u_char *cp;
137 
138 	cp = name;
139 	cp--;
140 	if (*cp != 0xfc) {
141 		printf("First byte of name entry '%s' corrupted\n", name);
142 		Debugger("ditto");
143 	}
144 	cp -= sizeof(int);
145 	nmlen = *(int*)cp;
146 	slen = strlen(name) + 1;
147 	if (nmlen != slen) {
148 		printf("Name length mismatch: was %d, now %d name '%s'\n",
149 		    nmlen, slen, name);
150 		Debugger("ditto");
151 	}
152 	if (name[nmlen] != 0xfe) {
153 		printf("Last byte of name entry '%s' corrupted\n", name);
154 		Debugger("ditto");
155 	}
156 	free(cp, M_SMBNODENAME);
157 #else
158 	free(name, M_SMBNODENAME);
159 #endif
160 }
161 
162 static int
163 smbfs_node_alloc(struct mount *mp, struct vnode *dvp,
164 		 const char *name, int nmlen, struct smbfattr *fap,
165 		 struct vnode **vpp)
166 {
167 	struct thread *td = curthread;	/* XXX */
168 	struct smbmount *smp = VFSTOSMBFS(mp);
169 	struct smbnode_hashhead *nhpp;
170 	struct smbnode *np, *np2, *dnp;
171 	struct vnode *vp;
172 	u_long hashval;
173 	lwkt_tokref vlock;
174 	int error;
175 
176 	*vpp = NULL;
177 	if (smp->sm_root != NULL && dvp == NULL) {
178 		SMBERROR("do not allocate root vnode twice!\n");
179 		return EINVAL;
180 	}
181 	if (nmlen == 2 && bcmp(name, "..", 2) == 0) {
182 		if (dvp == NULL)
183 			return EINVAL;
184 		vp = VTOSMB(VTOSMB(dvp)->n_parent)->n_vnode;
185 		error = vget(vp, NULL, LK_EXCLUSIVE, td);
186 		if (error == 0)
187 			*vpp = vp;
188 		return error;
189 	} else if (nmlen == 1 && name[0] == '.') {
190 		SMBERROR("do not call me with dot!\n");
191 		return EINVAL;
192 	}
193 	dnp = dvp ? VTOSMB(dvp) : NULL;
194 	if (dnp == NULL && dvp != NULL) {
195 		vprint("smbfs_node_alloc: dead parent vnode", dvp);
196 		return EINVAL;
197 	}
198 	hashval = smbfs_hash(name, nmlen);
199 retry:
200 	smbfs_hash_lock(smp, td);
201 loop:
202 	nhpp = SMBFS_NOHASH(smp, hashval);
203 	LIST_FOREACH(np, nhpp, n_hash) {
204 		vp = SMBTOV(np);
205 		if (np->n_parent != dvp ||
206 		    np->n_nmlen != nmlen || bcmp(name, np->n_name, nmlen) != 0)
207 			continue;
208 		VI_LOCK(&vlock, vp);
209 		smbfs_hash_unlock(smp, td);
210 		if (vget(vp, &vlock, LK_EXCLUSIVE | LK_INTERLOCK, td) != 0)
211 			goto retry;
212 		*vpp = vp;
213 		return 0;
214 	}
215 	smbfs_hash_unlock(smp, td);
216 	/*
217 	 * If we don't have node attributes, then it is an explicit lookup
218 	 * for an existing vnode.
219 	 */
220 	if (fap == NULL)
221 		return ENOENT;
222 
223 	MALLOC(np, struct smbnode *, sizeof *np, M_SMBNODE, M_WAITOK);
224 	error = getnewvnode(VT_SMBFS, mp, smbfs_vnodeop_p, &vp);
225 	if (error) {
226 		FREE(np, M_SMBNODE);
227 		return error;
228 	}
229 	vp->v_type = fap->fa_attr & SMB_FA_DIR ? VDIR : VREG;
230 	bzero(np, sizeof(*np));
231 	vp->v_data = np;
232 	np->n_vnode = vp;
233 	np->n_mount = VFSTOSMBFS(mp);
234 	np->n_nmlen = nmlen;
235 	np->n_name = smbfs_name_alloc(name, nmlen);
236 	np->n_ino = fap->fa_ino;
237 
238 	if (dvp) {
239 		np->n_parent = dvp;
240 		if (/*vp->v_type == VDIR &&*/ (dvp->v_flag & VROOT) == 0) {
241 			vref(dvp);
242 			np->n_flag |= NREFPARENT;
243 		}
244 	} else if (vp->v_type == VREG)
245 		SMBERROR("new vnode '%s' born without parent ?\n", np->n_name);
246 
247 	lockinit(&np->n_lock, 0, "smbnode", VLKTIMEOUT, LK_CANRECURSE);
248 	vn_lock(vp, NULL, LK_EXCLUSIVE | LK_RETRY, td);
249 
250 	smbfs_hash_lock(smp, td);
251 	LIST_FOREACH(np2, nhpp, n_hash) {
252 		if (np2->n_parent != dvp ||
253 		    np2->n_nmlen != nmlen || bcmp(name, np2->n_name, nmlen) != 0)
254 			continue;
255 		vput(vp);
256 /*		smb_name_free(np->n_name);
257 		FREE(np, M_SMBNODE);*/
258 		goto loop;
259 	}
260 	LIST_INSERT_HEAD(nhpp, np, n_hash);
261 	smbfs_hash_unlock(smp, td);
262 	*vpp = vp;
263 	return 0;
264 }
265 
266 int
267 smbfs_nget(struct mount *mp, struct vnode *dvp, const char *name, int nmlen,
268 	   struct smbfattr *fap, struct vnode **vpp)
269 {
270 	struct smbnode *np;
271 	struct vnode *vp;
272 	int error;
273 
274 	*vpp = NULL;
275 	error = smbfs_node_alloc(mp, dvp, name, nmlen, fap, &vp);
276 	if (error)
277 		return error;
278 	np = VTOSMB(vp);
279 	if (fap)
280 		smbfs_attr_cacheenter(vp, fap);
281 	*vpp = vp;
282 	return 0;
283 }
284 
285 /*
286  * Free smbnode, and give vnode back to system
287  *
288  * smbfs_reclaim(struct vnode *a_vp, struct thread *a_td)
289  */
290 int
291 smbfs_reclaim(struct vop_reclaim_args *ap)
292 {
293 	struct vnode *vp = ap->a_vp;
294 	struct thread *td = ap->a_td;
295 	struct vnode *dvp;
296 	struct smbnode *np = VTOSMB(vp);
297 	struct smbmount *smp = VTOSMBFS(vp);
298 	lwkt_tokref vlock;
299 
300 	SMBVDEBUG("%s,%d\n", np->n_name, vp->v_usecount);
301 
302 	smbfs_hash_lock(smp, td);
303 
304 	dvp = (np->n_parent && (np->n_flag & NREFPARENT)) ?
305 	    np->n_parent : NULL;
306 
307 	if (np->n_hash.le_prev)
308 		LIST_REMOVE(np, n_hash);
309 	cache_purge(vp);
310 	if (smp->sm_root == np) {
311 		SMBVDEBUG("root vnode\n");
312 		smp->sm_root = NULL;
313 	}
314 	vp->v_data = NULL;
315 	smbfs_hash_unlock(smp, td);
316 	if (np->n_name)
317 		smbfs_name_free(np->n_name);
318 	FREE(np, M_SMBNODE);
319 	if (dvp) {
320 		VI_LOCK(&vlock, dvp);
321 		if (dvp->v_usecount >= 1) {
322 			VI_UNLOCK(&vlock, dvp);
323 			vrele(dvp);
324 			/*
325 			 * Indicate that we released something; see comment
326 			 * in smbfs_unmount().
327 			 */
328 			smp->sm_didrele = 1;
329 		} else {
330 			VI_UNLOCK(&vlock, dvp);
331 			SMBERROR("BUG: negative use count for parent!\n");
332 		}
333 	}
334 	return 0;
335 }
336 
337 /*
338  * smbfs_inactive(struct vnode *a_vp, struct thread *a_td)
339  */
340 int
341 smbfs_inactive(struct vop_inactive_args *ap)
342 {
343 	struct thread *td = ap->a_td;
344 	struct ucred *cred;
345 	struct vnode *vp = ap->a_vp;
346 	struct smbnode *np = VTOSMB(vp);
347 	struct smb_cred scred;
348 	int error;
349 
350 	KKASSERT(td->td_proc);
351 	cred = td->td_proc->p_ucred;
352 
353 	SMBVDEBUG("%s: %d\n", VTOSMB(vp)->n_name, vp->v_usecount);
354 	if (np->n_opencount) {
355 		error = smbfs_vinvalbuf(vp, V_SAVE, td, 1);
356 		smb_makescred(&scred, td, cred);
357 		error = smbfs_smb_close(np->n_mount->sm_share, np->n_fid,
358 		   &np->n_mtime, &scred);
359 		np->n_opencount = 0;
360 	}
361 	VOP_UNLOCK(vp, NULL, 0, td);
362 	return (0);
363 }
364 /*
365  * routines to maintain vnode attributes cache
366  * smbfs_attr_cacheenter: unpack np.i to vattr structure
367  */
368 void
369 smbfs_attr_cacheenter(struct vnode *vp, struct smbfattr *fap)
370 {
371 	struct smbnode *np = VTOSMB(vp);
372 
373 	if (vp->v_type == VREG) {
374 		if (np->n_size != fap->fa_size) {
375 			np->n_size = fap->fa_size;
376 			vnode_pager_setsize(vp, np->n_size);
377 		}
378 	} else if (vp->v_type == VDIR) {
379 		np->n_size = 16384; 		/* should be a better way ... */
380 	} else
381 		return;
382 	np->n_mtime = fap->fa_mtime;
383 	np->n_dosattr = fap->fa_attr;
384 	np->n_attrage = time_second;
385 	return;
386 }
387 
388 int
389 smbfs_attr_cachelookup(struct vnode *vp, struct vattr *va)
390 {
391 	struct smbnode *np = VTOSMB(vp);
392 	struct smbmount *smp = VTOSMBFS(vp);
393 	int diff;
394 
395 	diff = time_second - np->n_attrage;
396 	if (diff > 2)	/* XXX should be configurable */
397 		return ENOENT;
398 	va->va_type = vp->v_type;		/* vnode type (for create) */
399 	if (vp->v_type == VREG) {
400 		va->va_mode = smp->sm_args.file_mode;	/* files access mode and type */
401 	} else if (vp->v_type == VDIR) {
402 		va->va_mode = smp->sm_args.dir_mode;	/* files access mode and type */
403 	} else
404 		return EINVAL;
405 	va->va_size = np->n_size;
406 	va->va_nlink = 1;		/* number of references to file */
407 	va->va_uid = smp->sm_args.uid;	/* owner user id */
408 	va->va_gid = smp->sm_args.gid;	/* owner group id */
409 	va->va_fsid = vp->v_mount->mnt_stat.f_fsid.val[0];
410 	va->va_fileid = np->n_ino;	/* file id */
411 	if (va->va_fileid == 0)
412 		va->va_fileid = 2;
413 	va->va_blocksize = SSTOVC(smp->sm_share)->vc_txmax;
414 	va->va_mtime = np->n_mtime;
415 	va->va_atime = va->va_ctime = va->va_mtime;	/* time file changed */
416 	va->va_gen = VNOVAL;		/* generation number of file */
417 	va->va_flags = 0;		/* flags defined for file */
418 	va->va_rdev = VNOVAL;		/* device the special file represents */
419 	va->va_bytes = va->va_size;	/* bytes of disk space held by file */
420 	va->va_filerev = 0;		/* file modification number */
421 	va->va_vaflags = 0;		/* operations flags */
422 	return 0;
423 }
424