xref: /freebsd/sys/fs/smbfs/smbfs_node.c (revision 3642298923e528d795e3a30ec165d2b469e28b40)
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$
33  */
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kdb.h>
37 #include <sys/kernel.h>
38 #include <sys/lock.h>
39 #include <sys/malloc.h>
40 #include <sys/mount.h>
41 #include <sys/proc.h>
42 #include <sys/queue.h>
43 #include <sys/sysctl.h>
44 #include <sys/time.h>
45 #include <sys/vnode.h>
46 
47 #include <netsmb/smb.h>
48 #include <netsmb/smb_conn.h>
49 #include <netsmb/smb_subr.h>
50 
51 #include <vm/vm.h>
52 #include <vm/vm_extern.h>
53 /*#include <vm/vm_page.h>
54 #include <vm/vm_object.h>*/
55 
56 #include <fs/smbfs/smbfs.h>
57 #include <fs/smbfs/smbfs_node.h>
58 #include <fs/smbfs/smbfs_subr.h>
59 
60 #define	SMBFS_NOHASH(smp, hval)	(&(smp)->sm_hash[(hval) & (smp)->sm_hashlen])
61 #define	smbfs_hash_lock(smp, td)	lockmgr(&smp->sm_hashlock, LK_EXCLUSIVE, NULL, td)
62 #define	smbfs_hash_unlock(smp, td)	lockmgr(&smp->sm_hashlock, LK_RELEASE, NULL, td)
63 
64 
65 extern struct vop_vector smbfs_vnodeops;	/* XXX -> .h file */
66 
67 MALLOC_DEFINE(M_SMBNODE, "SMBFS node", "SMBFS vnode private part");
68 static MALLOC_DEFINE(M_SMBNODENAME, "SMBFS nname", "SMBFS node name");
69 
70 int smbfs_hashprint(struct mount *mp);
71 
72 #if 0
73 #ifdef SYSCTL_DECL
74 SYSCTL_DECL(_vfs_smbfs);
75 #endif
76 SYSCTL_PROC(_vfs_smbfs, OID_AUTO, vnprint, CTLFLAG_WR|CTLTYPE_OPAQUE,
77 	    NULL, 0, smbfs_hashprint, "S,vnlist", "vnode hash");
78 #endif
79 
80 #define	FNV_32_PRIME ((u_int32_t) 0x01000193UL)
81 #define	FNV1_32_INIT ((u_int32_t) 33554467UL)
82 
83 u_int32_t
84 smbfs_hash(const u_char *name, int nmlen)
85 {
86 	u_int32_t v;
87 
88 	for (v = FNV1_32_INIT; nmlen; name++, nmlen--) {
89 		v *= FNV_32_PRIME;
90 		v ^= (u_int32_t)*name;
91 	}
92 	return v;
93 }
94 
95 int
96 smbfs_hashprint(struct mount *mp)
97 {
98 	struct smbmount *smp = VFSTOSMBFS(mp);
99 	struct smbnode_hashhead *nhpp;
100 	struct smbnode *np;
101 	int i;
102 
103 	for(i = 0; i <= smp->sm_hashlen; i++) {
104 		nhpp = &smp->sm_hash[i];
105 		LIST_FOREACH(np, nhpp, n_hash)
106 			vprint("", SMBTOV(np));
107 	}
108 	return 0;
109 }
110 
111 static char *
112 smbfs_name_alloc(const u_char *name, int nmlen)
113 {
114 	u_char *cp;
115 
116 	nmlen++;
117 #ifdef SMBFS_NAME_DEBUG
118 	cp = malloc(nmlen + 2 + sizeof(int), M_SMBNODENAME, M_WAITOK);
119 	*(int*)cp = nmlen;
120 	cp += sizeof(int);
121 	cp[0] = 0xfc;
122 	cp++;
123 	bcopy(name, cp, nmlen - 1);
124 	cp[nmlen] = 0xfe;
125 #else
126 	cp = malloc(nmlen, M_SMBNODENAME, M_WAITOK);
127 	bcopy(name, cp, nmlen - 1);
128 #endif
129 	cp[nmlen - 1] = 0;
130 	return cp;
131 }
132 
133 static void
134 smbfs_name_free(u_char *name)
135 {
136 #ifdef SMBFS_NAME_DEBUG
137 	int nmlen, slen;
138 	u_char *cp;
139 
140 	cp = name;
141 	cp--;
142 	if (*cp != 0xfc) {
143 		printf("First byte of name entry '%s' corrupted\n", name);
144 		kdb_enter("ditto");
145 	}
146 	cp -= sizeof(int);
147 	nmlen = *(int*)cp;
148 	slen = strlen(name) + 1;
149 	if (nmlen != slen) {
150 		printf("Name length mismatch: was %d, now %d name '%s'\n",
151 		    nmlen, slen, name);
152 		kdb_enter("ditto");
153 	}
154 	if (name[nmlen] != 0xfe) {
155 		printf("Last byte of name entry '%s' corrupted\n", name);
156 		kdb_enter("ditto");
157 	}
158 	free(cp, M_SMBNODENAME);
159 #else
160 	free(name, M_SMBNODENAME);
161 #endif
162 }
163 
164 static int
165 smbfs_node_alloc(struct mount *mp, struct vnode *dvp,
166 	const char *name, int nmlen, struct smbfattr *fap, struct vnode **vpp)
167 {
168 	struct vattr vattr;
169 	struct thread *td = curthread;	/* XXX */
170 	struct smbmount *smp = VFSTOSMBFS(mp);
171 	struct smbnode_hashhead *nhpp;
172 	struct smbnode *np, *np2, *dnp;
173 	struct vnode *vp;
174 	u_long hashval;
175 	int error;
176 
177 	*vpp = NULL;
178 	if (smp->sm_root != NULL && dvp == NULL) {
179 		SMBERROR("do not allocate root vnode twice!\n");
180 		return EINVAL;
181 	}
182 	if (nmlen == 2 && bcmp(name, "..", 2) == 0) {
183 		if (dvp == NULL)
184 			return EINVAL;
185 		vp = VTOSMB(VTOSMB(dvp)->n_parent)->n_vnode;
186 		error = vget(vp, LK_EXCLUSIVE, td);
187 		if (error == 0)
188 			*vpp = vp;
189 		return error;
190 	} else if (nmlen == 1 && name[0] == '.') {
191 		SMBERROR("do not call me with dot!\n");
192 		return EINVAL;
193 	}
194 	dnp = dvp ? VTOSMB(dvp) : NULL;
195 	if (dnp == NULL && dvp != NULL) {
196 		vprint("smbfs_node_alloc: dead parent vnode", dvp);
197 		return EINVAL;
198 	}
199 	hashval = smbfs_hash(name, nmlen);
200 retry:
201 	smbfs_hash_lock(smp, td);
202 loop:
203 	nhpp = SMBFS_NOHASH(smp, hashval);
204 	LIST_FOREACH(np, nhpp, n_hash) {
205 		vp = SMBTOV(np);
206 		if (np->n_parent != dvp ||
207 		    np->n_nmlen != nmlen || bcmp(name, np->n_name, nmlen) != 0)
208 			continue;
209 		VI_LOCK(vp);
210 		smbfs_hash_unlock(smp, td);
211 		if (vget(vp, LK_EXCLUSIVE | LK_INTERLOCK, td) != 0)
212 			goto retry;
213 		/* Force cached attributes to be refreshed if stale. */
214 		(void)VOP_GETATTR(vp, &vattr, td->td_ucred, td);
215 		/*
216 		 * If the file type on the server is inconsistent with
217 		 * what it was when we created the vnode, kill the
218 		 * bogus vnode now and fall through to the code below
219 		 * to create a new one with the right type.
220 		 */
221 		if ((vp->v_type == VDIR && (np->n_dosattr & SMB_FA_DIR) == 0) ||
222 		    (vp->v_type == VREG && (np->n_dosattr & SMB_FA_DIR) != 0)) {
223 			vgone(vp);
224 			vput(vp);
225 			break;
226 		}
227 		*vpp = vp;
228 		return 0;
229 	}
230 	smbfs_hash_unlock(smp, td);
231 	/*
232 	 * If we don't have node attributes, then it is an explicit lookup
233 	 * for an existing vnode.
234 	 */
235 	if (fap == NULL)
236 		return ENOENT;
237 
238 	MALLOC(np, struct smbnode *, sizeof *np, M_SMBNODE, M_WAITOK);
239 	error = getnewvnode("smbfs", mp, &smbfs_vnodeops, &vp);
240 	if (error) {
241 		FREE(np, M_SMBNODE);
242 		return error;
243 	}
244 	vp->v_type = fap->fa_attr & SMB_FA_DIR ? VDIR : VREG;
245 	bzero(np, sizeof(*np));
246 	vp->v_data = np;
247 	np->n_vnode = vp;
248 	np->n_mount = VFSTOSMBFS(mp);
249 	np->n_nmlen = nmlen;
250 	np->n_name = smbfs_name_alloc(name, nmlen);
251 	np->n_ino = fap->fa_ino;
252 
253 	if (dvp) {
254 		ASSERT_VOP_LOCKED(dvp, "smbfs_node_alloc");
255 		np->n_parent = dvp;
256 		if (/*vp->v_type == VDIR &&*/ (dvp->v_vflag & VV_ROOT) == 0) {
257 			vref(dvp);
258 			np->n_flag |= NREFPARENT;
259 		}
260 	} else if (vp->v_type == VREG)
261 		SMBERROR("new vnode '%s' born without parent ?\n", np->n_name);
262 
263 	vp->v_vnlock->lk_flags |= LK_CANRECURSE;
264 	vn_lock(vp, LK_EXCLUSIVE | LK_RETRY, td);
265 
266 	smbfs_hash_lock(smp, td);
267 	LIST_FOREACH(np2, nhpp, n_hash) {
268 		if (np2->n_parent != dvp ||
269 		    np2->n_nmlen != nmlen || bcmp(name, np2->n_name, nmlen) != 0)
270 			continue;
271 		vput(vp);
272 /*		smb_name_free(np->n_name);
273 		FREE(np, M_SMBNODE);*/
274 		goto loop;
275 	}
276 	LIST_INSERT_HEAD(nhpp, np, n_hash);
277 	smbfs_hash_unlock(smp, td);
278 	*vpp = vp;
279 	return 0;
280 }
281 
282 int
283 smbfs_nget(struct mount *mp, struct vnode *dvp, const char *name, int nmlen,
284 	struct smbfattr *fap, struct vnode **vpp)
285 {
286 	struct smbnode *np;
287 	struct vnode *vp;
288 	int error;
289 
290 	*vpp = NULL;
291 	error = smbfs_node_alloc(mp, dvp, name, nmlen, fap, &vp);
292 	if (error)
293 		return error;
294 	np = VTOSMB(vp);
295 	if (fap)
296 		smbfs_attr_cacheenter(vp, fap);
297 	*vpp = vp;
298 	return 0;
299 }
300 
301 /*
302  * Free smbnode, and give vnode back to system
303  */
304 int
305 smbfs_reclaim(ap)
306         struct vop_reclaim_args /* {
307 		struct vnode *a_vp;
308 		struct thread *a_p;
309         } */ *ap;
310 {
311 	struct vnode *vp = ap->a_vp;
312 	struct thread *td = ap->a_td;
313 	struct vnode *dvp;
314 	struct smbnode *np = VTOSMB(vp);
315 	struct smbmount *smp = VTOSMBFS(vp);
316 
317 	SMBVDEBUG("%s,%d\n", np->n_name, vrefcnt(vp));
318 
319 	KASSERT((np->n_flag & NOPEN) == 0, ("file not closed before reclaim"));
320 
321 	smbfs_hash_lock(smp, td);
322 
323 	dvp = (np->n_parent && (np->n_flag & NREFPARENT)) ?
324 	    np->n_parent : NULL;
325 
326 	if (np->n_hash.le_prev)
327 		LIST_REMOVE(np, n_hash);
328 	if (smp->sm_root == np) {
329 		SMBVDEBUG("root vnode\n");
330 		smp->sm_root = NULL;
331 	}
332 	vp->v_data = NULL;
333 	vnode_destroy_vobject(vp);
334 	smbfs_hash_unlock(smp, td);
335 	if (np->n_name)
336 		smbfs_name_free(np->n_name);
337 	FREE(np, M_SMBNODE);
338 	if (dvp != NULL) {
339 		vrele(dvp);
340 		/*
341 		 * Indicate that we released something; see comment
342 		 * in smbfs_unmount().
343 		 */
344 		smp->sm_didrele = 1;
345 	}
346 	return 0;
347 }
348 
349 int
350 smbfs_inactive(ap)
351 	struct vop_inactive_args /* {
352 		struct vnode *a_vp;
353 		struct thread *a_td;
354 	} */ *ap;
355 {
356 	struct thread *td = ap->a_td;
357 	struct ucred *cred = td->td_ucred;
358 	struct vnode *vp = ap->a_vp;
359 	struct smbnode *np = VTOSMB(vp);
360 	struct smb_cred scred;
361 	struct vattr va;
362 
363 	SMBVDEBUG("%s: %d\n", VTOSMB(vp)->n_name, vrefcnt(vp));
364 	if ((np->n_flag & NOPEN) != 0) {
365 		smb_makescred(&scred, td, cred);
366 		smbfs_vinvalbuf(vp, td);
367 		if (vp->v_type == VREG) {
368 			VOP_GETATTR(vp, &va, cred, td);
369 			smbfs_smb_close(np->n_mount->sm_share, np->n_fid,
370 			    &np->n_mtime, &scred);
371 		} else if (vp->v_type == VDIR) {
372 			if (np->n_dirseq != NULL) {
373 				smbfs_findclose(np->n_dirseq, &scred);
374 				np->n_dirseq = NULL;
375 			}
376 		}
377 		np->n_flag &= ~NOPEN;
378 		smbfs_attr_cacheremove(vp);
379 	}
380 	if (np->n_flag & NGONE)
381 		vrecycle(vp, td);
382 	return (0);
383 }
384 /*
385  * routines to maintain vnode attributes cache
386  * smbfs_attr_cacheenter: unpack np.i to vattr structure
387  */
388 void
389 smbfs_attr_cacheenter(struct vnode *vp, struct smbfattr *fap)
390 {
391 	struct smbnode *np = VTOSMB(vp);
392 
393 	if (vp->v_type == VREG) {
394 		if (np->n_size != fap->fa_size) {
395 			np->n_size = fap->fa_size;
396 			vnode_pager_setsize(vp, np->n_size);
397 		}
398 	} else if (vp->v_type == VDIR) {
399 		np->n_size = 16384; 		/* should be a better way ... */
400 	} else
401 		return;
402 	np->n_mtime = fap->fa_mtime;
403 	np->n_dosattr = fap->fa_attr;
404 	np->n_attrage = time_second;
405 	return;
406 }
407 
408 int
409 smbfs_attr_cachelookup(struct vnode *vp, struct vattr *va)
410 {
411 	struct smbnode *np = VTOSMB(vp);
412 	struct smbmount *smp = VTOSMBFS(vp);
413 	int diff;
414 
415 	diff = time_second - np->n_attrage;
416 	if (diff > 2)	/* XXX should be configurable */
417 		return ENOENT;
418 	va->va_type = vp->v_type;		/* vnode type (for create) */
419 	if (vp->v_type == VREG) {
420 		va->va_mode = smp->sm_file_mode; /* files access mode and type */
421 	} else if (vp->v_type == VDIR) {
422 		va->va_mode = smp->sm_dir_mode;	/* files access mode and type */
423 	} else
424 		return EINVAL;
425 	va->va_size = np->n_size;
426 	va->va_nlink = 1;		/* number of references to file */
427 	va->va_uid = smp->sm_uid;	/* owner user id */
428 	va->va_gid = smp->sm_gid;	/* owner group id */
429 	va->va_fsid = vp->v_mount->mnt_stat.f_fsid.val[0];
430 	va->va_fileid = np->n_ino;	/* file id */
431 	if (va->va_fileid == 0)
432 		va->va_fileid = 2;
433 	va->va_blocksize = SSTOVC(smp->sm_share)->vc_txmax;
434 	va->va_mtime = np->n_mtime;
435 	va->va_atime = va->va_ctime = va->va_mtime;	/* time file changed */
436 	va->va_gen = VNOVAL;		/* generation number of file */
437 	va->va_flags = 0;		/* flags defined for file */
438 	va->va_rdev = VNOVAL;		/* device the special file represents */
439 	va->va_bytes = va->va_size;	/* bytes of disk space held by file */
440 	va->va_filerev = 0;		/* file modification number */
441 	va->va_vaflags = 0;		/* operations flags */
442 	return 0;
443 }
444