xref: /freebsd/sys/fs/smbfs/smbfs_node.c (revision f9218d3d4fd34f082473b3a021c6d4d109fb47cf)
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, td)	lockmgr(&smp->sm_hashlock, LK_EXCLUSIVE, NULL, td)
61 #define	smbfs_hash_unlock(smp, td)	lockmgr(&smp->sm_hashlock, LK_RELEASE, NULL, td)
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 #ifdef SYSCTL_DECL
73 SYSCTL_DECL(_vfs_smbfs);
74 #endif
75 SYSCTL_PROC(_vfs_smbfs, OID_AUTO, vnprint, CTLFLAG_WR|CTLTYPE_OPAQUE,
76 	    NULL, 0, smbfs_hashprint, "S,vnlist", "vnode hash");
77 #endif
78 
79 #define	FNV_32_PRIME ((u_int32_t) 0x01000193UL)
80 #define	FNV1_32_INIT ((u_int32_t) 33554467UL)
81 
82 u_int32_t
83 smbfs_hash(const u_char *name, int nmlen)
84 {
85 	u_int32_t v;
86 
87 	for (v = FNV1_32_INIT; nmlen; name++, nmlen--) {
88 		v *= FNV_32_PRIME;
89 		v ^= (u_int32_t)*name;
90 	}
91 	return v;
92 }
93 
94 int
95 smbfs_hashprint(struct mount *mp)
96 {
97 	struct smbmount *smp = VFSTOSMBFS(mp);
98 	struct smbnode_hashhead *nhpp;
99 	struct smbnode *np;
100 	int i;
101 
102 	for(i = 0; i <= smp->sm_hashlen; i++) {
103 		nhpp = &smp->sm_hash[i];
104 		LIST_FOREACH(np, nhpp, n_hash)
105 			vprint(NULL, SMBTOV(np));
106 	}
107 	return 0;
108 }
109 
110 static char *
111 smbfs_name_alloc(const u_char *name, int nmlen)
112 {
113 	u_char *cp;
114 
115 	nmlen++;
116 #ifdef SMBFS_NAME_DEBUG
117 	cp = malloc(nmlen + 2 + sizeof(int), M_SMBNODENAME, M_WAITOK);
118 	*(int*)cp = nmlen;
119 	cp += sizeof(int);
120 	cp[0] = 0xfc;
121 	cp++;
122 	bcopy(name, cp, nmlen - 1);
123 	cp[nmlen] = 0xfe;
124 #else
125 	cp = malloc(nmlen, M_SMBNODENAME, M_WAITOK);
126 	bcopy(name, cp, nmlen - 1);
127 #endif
128 	cp[nmlen - 1] = 0;
129 	return cp;
130 }
131 
132 static void
133 smbfs_name_free(u_char *name)
134 {
135 #ifdef SMBFS_NAME_DEBUG
136 	int nmlen, slen;
137 	u_char *cp;
138 
139 	cp = name;
140 	cp--;
141 	if (*cp != 0xfc) {
142 		printf("First byte of name entry '%s' corrupted\n", name);
143 		Debugger("ditto");
144 	}
145 	cp -= sizeof(int);
146 	nmlen = *(int*)cp;
147 	slen = strlen(name) + 1;
148 	if (nmlen != slen) {
149 		printf("Name length mismatch: was %d, now %d name '%s'\n",
150 		    nmlen, slen, name);
151 		Debugger("ditto");
152 	}
153 	if (name[nmlen] != 0xfe) {
154 		printf("Last byte of name entry '%s' corrupted\n", name);
155 		Debugger("ditto");
156 	}
157 	free(cp, M_SMBNODENAME);
158 #else
159 	free(name, M_SMBNODENAME);
160 #endif
161 }
162 
163 static int
164 smbfs_node_alloc(struct mount *mp, struct vnode *dvp,
165 	const char *name, int nmlen, struct smbfattr *fap, 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 	int error;
174 
175 	*vpp = NULL;
176 	if (smp->sm_root != NULL && dvp == NULL) {
177 		SMBERROR("do not allocate root vnode twice!\n");
178 		return EINVAL;
179 	}
180 	if (nmlen == 2 && bcmp(name, "..", 2) == 0) {
181 		if (dvp == NULL)
182 			return EINVAL;
183 		vp = VTOSMB(VTOSMB(dvp)->n_parent)->n_vnode;
184 		error = vget(vp, LK_EXCLUSIVE, td);
185 		if (error == 0)
186 			*vpp = vp;
187 		return error;
188 	} else if (nmlen == 1 && name[0] == '.') {
189 		SMBERROR("do not call me with dot!\n");
190 		return EINVAL;
191 	}
192 	dnp = dvp ? VTOSMB(dvp) : NULL;
193 	if (dnp == NULL && dvp != NULL) {
194 		vprint("smbfs_node_alloc: dead parent vnode", dvp);
195 		return EINVAL;
196 	}
197 	hashval = smbfs_hash(name, nmlen);
198 retry:
199 	smbfs_hash_lock(smp, td);
200 loop:
201 	nhpp = SMBFS_NOHASH(smp, hashval);
202 	LIST_FOREACH(np, nhpp, n_hash) {
203 		vp = SMBTOV(np);
204 		if (np->n_parent != dvp ||
205 		    np->n_nmlen != nmlen || bcmp(name, np->n_name, nmlen) != 0)
206 			continue;
207 		VI_LOCK(vp);
208 		smbfs_hash_unlock(smp, td);
209 		if (vget(vp, LK_EXCLUSIVE | LK_INTERLOCK, td) != 0)
210 			goto retry;
211 		*vpp = vp;
212 		return 0;
213 	}
214 	smbfs_hash_unlock(smp, td);
215 	/*
216 	 * If we don't have node attributes, then it is an explicit lookup
217 	 * for an existing vnode.
218 	 */
219 	if (fap == NULL)
220 		return ENOENT;
221 
222 	MALLOC(np, struct smbnode *, sizeof *np, M_SMBNODE, M_WAITOK);
223 	error = getnewvnode("smbfs", mp, smbfs_vnodeop_p, &vp);
224 	if (error) {
225 		FREE(np, M_SMBNODE);
226 		return error;
227 	}
228 	vp->v_type = fap->fa_attr & SMB_FA_DIR ? VDIR : VREG;
229 	bzero(np, sizeof(*np));
230 	vp->v_data = np;
231 	np->n_vnode = vp;
232 	np->n_mount = VFSTOSMBFS(mp);
233 	np->n_nmlen = nmlen;
234 	np->n_name = smbfs_name_alloc(name, nmlen);
235 	np->n_ino = fap->fa_ino;
236 
237 	if (dvp) {
238 		ASSERT_VOP_LOCKED(dvp, "smbfs_node_alloc");
239 		np->n_parent = dvp;
240 		if (/*vp->v_type == VDIR &&*/ (dvp->v_vflag & VV_ROOT) == 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 	vp->v_vnlock->lk_flags |= LK_CANRECURSE;
248 	vn_lock(vp, 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 int
289 smbfs_reclaim(ap)
290         struct vop_reclaim_args /* {
291 		struct vnode *a_vp;
292 		struct thread *a_p;
293         } */ *ap;
294 {
295 	struct vnode *vp = ap->a_vp;
296 	struct thread *td = ap->a_td;
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, vrefcnt(vp));
302 
303 	smbfs_hash_lock(smp, td);
304 
305 	dvp = (np->n_parent && (np->n_flag & NREFPARENT)) ?
306 	    np->n_parent : 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, td);
317 	if (np->n_name)
318 		smbfs_name_free(np->n_name);
319 	FREE(np, M_SMBNODE);
320 	if (dvp != NULL) {
321 		vrele(dvp);
322 		/*
323 		 * Indicate that we released something; see comment
324 		 * in smbfs_unmount().
325 		 */
326 		smp->sm_didrele = 1;
327 	}
328 	return 0;
329 }
330 
331 int
332 smbfs_inactive(ap)
333 	struct vop_inactive_args /* {
334 		struct vnode *a_vp;
335 		struct thread *a_td;
336 	} */ *ap;
337 {
338 	struct thread *td = ap->a_td;
339 	struct ucred *cred = td->td_ucred;
340 	struct vnode *vp = ap->a_vp;
341 	struct smbnode *np = VTOSMB(vp);
342 	struct smb_cred scred;
343 	int error;
344 
345 	SMBVDEBUG("%s: %d\n", VTOSMB(vp)->n_name, vrefcnt(vp));
346 	if (np->n_opencount) {
347 		error = smbfs_vinvalbuf(vp, V_SAVE, cred, td, 1);
348 		smb_makescred(&scred, td, cred);
349 		error = smbfs_smb_close(np->n_mount->sm_share, np->n_fid,
350 		   &np->n_mtime, &scred);
351 		np->n_opencount = 0;
352 	}
353 	VOP_UNLOCK(vp, 0, td);
354 	return (0);
355 }
356 /*
357  * routines to maintain vnode attributes cache
358  * smbfs_attr_cacheenter: unpack np.i to vattr structure
359  */
360 void
361 smbfs_attr_cacheenter(struct vnode *vp, struct smbfattr *fap)
362 {
363 	struct smbnode *np = VTOSMB(vp);
364 
365 	if (vp->v_type == VREG) {
366 		if (np->n_size != fap->fa_size) {
367 			np->n_size = fap->fa_size;
368 			vnode_pager_setsize(vp, np->n_size);
369 		}
370 	} else if (vp->v_type == VDIR) {
371 		np->n_size = 16384; 		/* should be a better way ... */
372 	} else
373 		return;
374 	np->n_mtime = fap->fa_mtime;
375 	np->n_dosattr = fap->fa_attr;
376 	np->n_attrage = time_second;
377 	return;
378 }
379 
380 int
381 smbfs_attr_cachelookup(struct vnode *vp, struct vattr *va)
382 {
383 	struct smbnode *np = VTOSMB(vp);
384 	struct smbmount *smp = VTOSMBFS(vp);
385 	int diff;
386 
387 	diff = time_second - np->n_attrage;
388 	if (diff > 2)	/* XXX should be configurable */
389 		return ENOENT;
390 	va->va_type = vp->v_type;		/* vnode type (for create) */
391 	if (vp->v_type == VREG) {
392 		va->va_mode = smp->sm_args.file_mode;	/* files access mode and type */
393 	} else if (vp->v_type == VDIR) {
394 		va->va_mode = smp->sm_args.dir_mode;	/* files access mode and type */
395 	} else
396 		return EINVAL;
397 	va->va_size = np->n_size;
398 	va->va_nlink = 1;		/* number of references to file */
399 	va->va_uid = smp->sm_args.uid;	/* owner user id */
400 	va->va_gid = smp->sm_args.gid;	/* owner group id */
401 	va->va_fsid = vp->v_mount->mnt_stat.f_fsid.val[0];
402 	va->va_fileid = np->n_ino;	/* file id */
403 	if (va->va_fileid == 0)
404 		va->va_fileid = 2;
405 	va->va_blocksize = SSTOVC(smp->sm_share)->vc_txmax;
406 	va->va_mtime = np->n_mtime;
407 	va->va_atime = va->va_ctime = va->va_mtime;	/* time file changed */
408 	va->va_gen = VNOVAL;		/* generation number of file */
409 	va->va_flags = 0;		/* flags defined for file */
410 	va->va_rdev = VNOVAL;		/* device the special file represents */
411 	va->va_bytes = va->va_size;	/* bytes of disk space held by file */
412 	va->va_filerev = 0;		/* file modification number */
413 	va->va_vaflags = 0;		/* operations flags */
414 	return 0;
415 }
416