xref: /freebsd/sys/fs/smbfs/smbfs_node.c (revision 3a51f88a2721f4cf7aded2a63f20925f8d700a7c)
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/kernel.h>
37 #include <sys/lock.h>
38 #include <sys/malloc.h>
39 #include <sys/mount.h>
40 #include <sys/proc.h>
41 #include <sys/queue.h>
42 #include <sys/sysctl.h>
43 #include <sys/time.h>
44 #include <sys/vnode.h>
45 
46 #include <netsmb/smb.h>
47 #include <netsmb/smb_conn.h>
48 #include <netsmb/smb_subr.h>
49 
50 #include <vm/vm.h>
51 #include <vm/vm_extern.h>
52 /*#include <vm/vm_page.h>
53 #include <vm/vm_object.h>*/
54 
55 #include <fs/smbfs/smbfs.h>
56 #include <fs/smbfs/smbfs_node.h>
57 #include <fs/smbfs/smbfs_subr.h>
58 
59 #define	SMBFS_NOHASH(smp, hval)	(&(smp)->sm_hash[(hval) & (smp)->sm_hashlen])
60 #define	smbfs_hash_lock(smp, p)		lockmgr(&smp->sm_hashlock, LK_EXCLUSIVE, NULL, p)
61 #define	smbfs_hash_unlock(smp, p)	lockmgr(&smp->sm_hashlock, LK_RELEASE, NULL, p)
62 
63 
64 extern vop_t **smbfs_vnodeop_p;
65 
66 MALLOC_DEFINE(M_SMBNODE, "SMBFS node", "SMBFS vnode private part");
67 static MALLOC_DEFINE(M_SMBNODENAME, "SMBFS nname", "SMBFS node name");
68 
69 int smbfs_hashprint(struct mount *mp);
70 
71 #if 0
72 extern struct linker_set sysctl_vfs_smbfs;
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(NULL, 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 		Debugger("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 		Debugger("ditto");
153 	}
154 	if (name[nmlen] != 0xfe) {
155 		printf("Last byte of name entry '%s' corrupted\n", name);
156 		Debugger("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 proc *p = curproc;	/* XXX */
169 	struct smbmount *smp = VFSTOSMBFS(mp);
170 	struct smbnode_hashhead *nhpp;
171 	struct smbnode *np, *np2, *dnp;
172 	struct vnode *vp;
173 	u_long hashval;
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(dvp)->n_parent->n_vnode;
185 		error = vget(vp, LK_EXCLUSIVE, p);
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, p);
201 loop:
202 	nhpp = SMBFS_NOHASH(smp, hashval);
203 	LIST_FOREACH(np, nhpp, n_hash) {
204 		vp = SMBTOV(np);
205 		if (np->n_parent != dnp ||
206 		    np->n_nmlen != nmlen || bcmp(name, np->n_name, nmlen) != 0)
207 			continue;
208 		VI_LOCK(vp);
209 		smbfs_hash_unlock(smp, p);
210 		if (vget(vp, LK_EXCLUSIVE | LK_INTERLOCK, p) != 0)
211 			goto retry;
212 		*vpp = vp;
213 		return 0;
214 	}
215 	smbfs_hash_unlock(smp, p);
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 = dnp;
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(&vp->v_lock, PINOD, "smbnode", 0, LK_CANRECURSE);
248 	vn_lock(vp, LK_EXCLUSIVE | LK_RETRY, p);
249 
250 	smbfs_hash_lock(smp, p);
251 	LIST_FOREACH(np2, nhpp, n_hash) {
252 		if (np2->n_parent != dnp ||
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, p);
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 int
289 smbfs_reclaim(ap)
290         struct vop_reclaim_args /* {
291 		struct vnode *a_vp;
292 		struct proc *a_p;
293         } */ *ap;
294 {
295 	struct vnode *vp = ap->a_vp;
296 	struct proc *p = ap->a_p;
297 	struct vnode *dvp;
298 	struct smbnode *np = VTOSMB(vp);
299 	struct smbmount *smp = VTOSMBFS(vp);
300 
301 	SMBVDEBUG("%s,%d\n", np->n_name, vp->v_usecount);
302 
303 	smbfs_hash_lock(smp, p);
304 
305 	dvp = (np->n_parent && (np->n_flag & NREFPARENT)) ?
306 	    np->n_parent->n_vnode : NULL;
307 
308 	if (np->n_hash.le_prev)
309 		LIST_REMOVE(np, n_hash);
310 	cache_purge(vp);
311 	if (smp->sm_root == np) {
312 		SMBVDEBUG("root vnode\n");
313 		smp->sm_root = NULL;
314 	}
315 	vp->v_data = NULL;
316 	smbfs_hash_unlock(smp, p);
317 	if (np->n_name)
318 		smbfs_name_free(np->n_name);
319 	FREE(np, M_SMBNODE);
320 	if (dvp) {
321 		VI_LOCK(dvp);
322 		if (dvp->v_usecount >= 1) {
323 			VI_UNLOCK(dvp);
324 			vrele(dvp);
325 		} else {
326 			VI_UNLOCK(dvp);
327 			SMBERROR("BUG: negative use count for parent!\n");
328 		}
329 	}
330 	return 0;
331 }
332 
333 int
334 smbfs_inactive(ap)
335 	struct vop_inactive_args /* {
336 		struct vnode *a_vp;
337 		struct proc *a_p;
338 	} */ *ap;
339 {
340 	struct proc *p = ap->a_p;
341 	struct ucred *cred = p->p_ucred;
342 	struct vnode *vp = ap->a_vp;
343 	struct smbnode *np = VTOSMB(vp);
344 	struct smb_cred scred;
345 	int error;
346 
347 	SMBVDEBUG("%s: %d\n", VTOSMB(vp)->n_name, vp->v_usecount);
348 	if (np->n_opencount) {
349 		error = smbfs_vinvalbuf(vp, V_SAVE, cred, p, 1);
350 		smb_makescred(&scred, p, cred);
351 		error = smbfs_smb_close(np->n_mount->sm_share, np->n_fid,
352 		   &np->n_mtime, &scred);
353 		np->n_opencount = 0;
354 	}
355 	VOP_UNLOCK(vp, 0, p);
356 	return (0);
357 }
358 /*
359  * routines to maintain vnode attributes cache
360  * smbfs_attr_cacheenter: unpack np.i to vattr structure
361  */
362 void
363 smbfs_attr_cacheenter(struct vnode *vp, struct smbfattr *fap)
364 {
365 	struct smbnode *np = VTOSMB(vp);
366 
367 	if (vp->v_type == VREG) {
368 		if (np->n_size != fap->fa_size) {
369 			np->n_size = fap->fa_size;
370 			vnode_pager_setsize(vp, np->n_size);
371 		}
372 	} else if (vp->v_type == VDIR) {
373 		np->n_size = 16384; 		/* should be a better way ... */
374 	} else
375 		return;
376 	np->n_mtime = fap->fa_mtime;
377 	np->n_dosattr = fap->fa_attr;
378 	np->n_attrage = time_second;
379 	return;
380 }
381 
382 int
383 smbfs_attr_cachelookup(struct vnode *vp, struct vattr *va)
384 {
385 	struct smbnode *np = VTOSMB(vp);
386 	struct smbmount *smp = VTOSMBFS(vp);
387 	int diff;
388 
389 	diff = time_second - np->n_attrage;
390 	if (diff > 2)	/* XXX should be configurable */
391 		return ENOENT;
392 	va->va_type = vp->v_type;		/* vnode type (for create) */
393 	if (vp->v_type == VREG) {
394 		va->va_mode = smp->sm_args.file_mode;	/* files access mode and type */
395 	} else if (vp->v_type == VDIR) {
396 		va->va_mode = smp->sm_args.dir_mode;	/* files access mode and type */
397 	} else
398 		return EINVAL;
399 	va->va_size = np->n_size;
400 	va->va_nlink = 1;		/* number of references to file */
401 	va->va_uid = smp->sm_args.uid;	/* owner user id */
402 	va->va_gid = smp->sm_args.gid;	/* owner group id */
403 	va->va_fsid = vp->v_mount->mnt_stat.f_fsid.val[0];
404 	va->va_fileid = np->n_ino;	/* file id */
405 	if (va->va_fileid == 0)
406 		va->va_fileid = 2;
407 	va->va_blocksize = SSTOVC(smp->sm_share)->vc_txmax;
408 	va->va_mtime = np->n_mtime;
409 	va->va_atime = va->va_ctime = va->va_mtime;	/* time file changed */
410 	va->va_gen = VNOVAL;		/* generation number of file */
411 	va->va_flags = 0;		/* flags defined for file */
412 	va->va_rdev = VNOVAL;		/* device the special file represents */
413 	va->va_bytes = va->va_size;	/* bytes of disk space held by file */
414 	va->va_filerev = 0;		/* file modification number */
415 	va->va_vaflags = 0;		/* operations flags */
416 	return 0;
417 }
418