xref: /dflybsd-src/sys/vfs/smbfs/smbfs_vfsops.c (revision ad63697b1227b985f99dd96f67aaafb238b3d148)
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_vfsops.c,v 1.2.2.5 2003/01/17 08:20:26 tjr Exp $
33  */
34 
35 #ifndef KLD_MODULE
36 #include "opt_netsmb.h"
37 #ifndef NETSMB
38 #error "SMBFS requires option NETSMB"
39 #endif
40 #endif
41 
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/proc.h>
45 #include <sys/kernel.h>
46 #include <sys/sysctl.h>
47 #include <sys/vnode.h>
48 #include <sys/mount.h>
49 #include <sys/stat.h>
50 #include <sys/malloc.h>
51 #include <sys/module.h>
52 
53 
54 #include <netproto/smb/smb.h>
55 #include <netproto/smb/smb_conn.h>
56 #include <netproto/smb/smb_subr.h>
57 #include <netproto/smb/smb_dev.h>
58 
59 #include "smbfs.h"
60 #include "smbfs_node.h"
61 #include "smbfs_subr.h"
62 
63 #include <sys/buf.h>
64 
65 extern struct vop_ops smbfs_vnode_vops;
66 
67 int smbfs_debuglevel = 0;
68 
69 static int smbfs_version = SMBFS_VERSION;
70 
71 #ifdef SMBFS_USEZONE
72 #include <vm/vm.h>
73 #include <vm/vm_extern.h>
74 #include <vm/vm_zone.h>
75 
76 vm_zone_t smbfsmount_zone;
77 #endif
78 
79 SYSCTL_NODE(_vfs, OID_AUTO, smbfs, CTLFLAG_RW, 0, "SMB/CIFS file system");
80 SYSCTL_INT(_vfs_smbfs, OID_AUTO, version, CTLFLAG_RD, &smbfs_version, 0, "");
81 SYSCTL_INT(_vfs_smbfs, OID_AUTO, debuglevel, CTLFLAG_RW, &smbfs_debuglevel, 0, "");
82 
83 static MALLOC_DEFINE(M_SMBFSHASH, "SMBFS hash", "SMBFS hash table");
84 
85 
86 static int smbfs_mount(struct mount *, char *, caddr_t, struct ucred *);
87 static int smbfs_root(struct mount *, struct vnode **);
88 static int smbfs_statfs(struct mount *, struct statfs *, struct ucred *);
89 static int smbfs_sync(struct mount *, int);
90 static int smbfs_unmount(struct mount *, int);
91 static int smbfs_init(struct vfsconf *vfsp);
92 static int smbfs_uninit(struct vfsconf *vfsp);
93 
94 #if defined(__FreeBSD__) && __FreeBSD_version < 400009
95 static int smbfs_vget(struct mount *mp, ino_t ino, struct vnode **vpp);
96 static int smbfs_fhtovp(struct mount *, struct fid *,
97 			struct sockaddr *, struct vnode **, int *,
98 			struct ucred **);
99 static int smbfs_vptofh(struct vnode *, struct fid *);
100 #endif
101 
102 static struct vfsops smbfs_vfsops = {
103 	.vfs_mount =    	smbfs_mount,
104 	.vfs_unmount =    	smbfs_unmount,
105 	.vfs_root =    		smbfs_root,
106 	.vfs_statfs =    	smbfs_statfs,
107 	.vfs_sync =    		smbfs_sync,
108 	.vfs_init =    		smbfs_init,
109 	.vfs_uninit =    	smbfs_uninit
110 };
111 
112 
113 VFS_SET(smbfs_vfsops, smbfs, VFCF_NETWORK);
114 MODULE_VERSION(smbfs, 1);
115 
116 MODULE_DEPEND(smbfs, netsmb, NSMB_VERSION, NSMB_VERSION, NSMB_VERSION);
117 MODULE_DEPEND(smbfs, libiconv, 1, 1, 2);
118 MODULE_DEPEND(smbfs, libmchain, 1, 1, 1);
119 
120 int smbfs_pbuf_freecnt = -1;	/* start out unlimited */
121 
122 static int
123 smbfs_mount(struct mount *mp, char *path, caddr_t data, struct ucred *cred)
124 {
125 	struct smbfs_args args; 	  /* will hold data from mount request */
126 	struct smbmount *smp = NULL;
127 	struct smb_vc *vcp;
128 	struct smb_share *ssp = NULL;
129 	struct vnode *vp;
130 	struct smb_cred scred;
131 	int error;
132 	char *pc, *pe;
133 
134 	if (data == NULL) {
135 		kprintf("missing data argument\n");
136 		return EINVAL;
137 	}
138 	if (mp->mnt_flag & MNT_UPDATE) {
139 		kprintf("MNT_UPDATE not implemented");
140 		return EOPNOTSUPP;
141 	}
142 	error = copyin(data, (caddr_t)&args, sizeof(struct smbfs_args));
143 	if (error)
144 		return error;
145 	if (args.version != SMBFS_VERSION) {
146 		kprintf("mount version mismatch: kernel=%d, mount=%d\n",
147 		    SMBFS_VERSION, args.version);
148 		return EINVAL;
149 	}
150 	smb_makescred(&scred, curthread, cred);
151 	error = smb_dev2share(args.dev, SMBM_EXEC, &scred, &ssp);
152 	if (error) {
153 		kprintf("invalid device handle %d (%d)\n", args.dev, error);
154 		return error;
155 	}
156 	vcp = SSTOVC(ssp);
157 	smb_share_unlock(ssp, 0);
158 	mp->mnt_stat.f_iosize = SSTOVC(ssp)->vc_txmax;
159 
160 #ifdef SMBFS_USEZONE
161 	smp = zalloc(smbfsmount_zone);
162 #else
163         smp = kmalloc(sizeof(*smp), M_SMBFSDATA, M_WAITOK | M_USE_RESERVE);
164 #endif
165         if (smp == NULL) {
166                 kprintf("could not alloc smbmount\n");
167                 error = ENOMEM;
168 		goto bad;
169         }
170 	bzero(smp, sizeof(*smp));
171         mp->mnt_data = (qaddr_t)smp;
172 	smp->sm_cred = crhold(cred);
173 	smp->sm_hash = hashinit(desiredvnodes, M_SMBFSHASH, &smp->sm_hashlen);
174 	if (smp->sm_hash == NULL)
175 		goto bad;
176 	lockinit(&smp->sm_hashlock, "smbfsh", 0, 0);
177 	smp->sm_share = ssp;
178 	smp->sm_root = NULL;
179         smp->sm_args = args;
180 	smp->sm_caseopt = args.caseopt;
181 	smp->sm_args.file_mode = (smp->sm_args.file_mode &
182 			    (S_IRWXU|S_IRWXG|S_IRWXO)) | S_IFREG;
183 	smp->sm_args.dir_mode  = (smp->sm_args.dir_mode &
184 			    (S_IRWXU|S_IRWXG|S_IRWXO)) | S_IFDIR;
185 
186 /*	simple_lock_init(&smp->sm_npslock);*/
187 	pc = mp->mnt_stat.f_mntfromname;
188 	pe = pc + sizeof(mp->mnt_stat.f_mntfromname);
189 	bzero(pc, MNAMELEN);
190 	*pc++ = '/';
191 	*pc++ = '/';
192 	pc=index(strncpy(pc, vcp->vc_username, pe - pc - 2), 0);
193 	if (pc < pe-1) {
194 		*(pc++) = '@';
195 		pc = index(strncpy(pc, vcp->vc_srvname, pe - pc - 2), 0);
196 		if (pc < pe - 1) {
197 			*(pc++) = '/';
198 			strncpy(pc, ssp->ss_name, pe - pc - 2);
199 		}
200 	}
201 	/* protect against invalid mount points */
202 	smp->sm_args.mount_point[sizeof(smp->sm_args.mount_point) - 1] = '\0';
203 	vfs_getnewfsid(mp);
204 
205 	vfs_add_vnodeops(mp, &smbfs_vnode_vops, &mp->mnt_vn_norm_ops);
206 
207 	error = smbfs_root(mp, &vp);
208 	if (error)
209 		goto bad;
210 	vn_unlock(vp);
211 	SMBVDEBUG("root.v_sysrefs = %d\n", vp->v_sysref.refcnt);
212 
213 #ifdef DIAGNOSTICS
214 	SMBERROR("mp=%p\n", mp);
215 #endif
216 	return error;
217 bad:
218         if (smp) {
219 		if (smp->sm_cred)
220 			crfree(smp->sm_cred);
221 		if (smp->sm_hash)
222 			kfree(smp->sm_hash, M_SMBFSHASH);
223 		lockdestroy(&smp->sm_hashlock);
224 #ifdef SMBFS_USEZONE
225 		zfree(smbfsmount_zone, smp);
226 #else
227 		kfree(smp, M_SMBFSDATA);
228 #endif
229 	}
230 	if (ssp)
231 		smb_share_put(ssp, &scred);
232         return error;
233 }
234 
235 /* Unmount the filesystem described by mp. */
236 static int
237 smbfs_unmount(struct mount *mp, int mntflags)
238 {
239 	struct smbmount *smp = VFSTOSMBFS(mp);
240 	struct smb_cred scred;
241 	int error, flags;
242 
243 	SMBVDEBUG("smbfs_unmount: flags=%04x\n", mntflags);
244 	flags = 0;
245 	if (mntflags & MNT_FORCE)
246 		flags |= FORCECLOSE;
247 	/*
248 	 * Keep trying to flush the vnode list for the mount while
249 	 * some are still busy and we are making progress towards
250 	 * making them not busy. This is needed because smbfs vnodes
251 	 * reference their parent directory but may appear after their
252 	 * parent in the list; one pass over the vnode list is not
253 	 * sufficient in this case.
254 	 */
255 	do {
256 		smp->sm_didrele = 0;
257 		/* There is 1 extra root vnode reference from smbfs_mount(). */
258 		error = vflush(mp, 1, flags);
259 	} while (error == EBUSY && smp->sm_didrele != 0);
260 	if (error)
261 		return error;
262 	smb_makescred(&scred, curthread, smp->sm_cred);
263 	smb_share_put(smp->sm_share, &scred);
264 	mp->mnt_data = (qaddr_t)0;
265 
266 	if (smp->sm_cred)
267 		crfree(smp->sm_cred);
268 	if (smp->sm_hash)
269 		kfree(smp->sm_hash, M_SMBFSHASH);
270 	lockdestroy(&smp->sm_hashlock);
271 #ifdef SMBFS_USEZONE
272 	zfree(smbfsmount_zone, smp);
273 #else
274 	kfree(smp, M_SMBFSDATA);
275 #endif
276 	mp->mnt_flag &= ~MNT_LOCAL;
277 	return error;
278 }
279 
280 /*
281  * Return locked root vnode of a filesystem
282  */
283 static int
284 smbfs_root(struct mount *mp, struct vnode **vpp)
285 {
286 	struct thread *td = curthread;	/* XXX */
287 	struct smbmount *smp = VFSTOSMBFS(mp);
288 	struct vnode *vp;
289 	struct smbnode *np;
290 	struct smbfattr fattr;
291 	struct ucred *cred;
292 	struct smb_cred scred;
293 	int error;
294 
295 	if (smp == NULL) {
296 		SMBERROR("smp == NULL (bug in umount)\n");
297 		return EINVAL;
298 	}
299 	if (smp->sm_root) {
300 		*vpp = SMBTOV(smp->sm_root);
301 		return vget(*vpp, LK_EXCLUSIVE | LK_RETRY);
302 	}
303 	if (td->td_proc)
304 		cred = td->td_proc->p_ucred;
305 	else
306 		cred = proc0.p_ucred;
307 
308 	smb_makescred(&scred, td, cred);
309 	error = smbfs_smb_lookup(NULL, NULL, 0, &fattr, &scred);
310 	if (error)
311 		return error;
312 	error = smbfs_nget(mp, NULL, "TheRooT", 7, &fattr, &vp);
313 	if (error)
314 		return error;
315 	vsetflags(vp, VROOT);
316 	np = VTOSMB(vp);
317 	smp->sm_root = np;
318 	*vpp = vp;
319 	return 0;
320 }
321 
322 /*ARGSUSED*/
323 int
324 smbfs_init(struct vfsconf *vfsp)
325 {
326 #ifdef SMBFS_USEZONE
327 	smbfsmount_zone = zinit("SMBFSMOUNT", sizeof(struct smbmount), 0, 0, 1);
328 #endif
329 	smbfs_pbuf_freecnt = nswbuf / 2 + 1;
330 	SMBVDEBUG("done.\n");
331 	return 0;
332 }
333 
334 /*ARGSUSED*/
335 int
336 smbfs_uninit(struct vfsconf *vfsp)
337 {
338 	SMBVDEBUG("done.\n");
339 	return 0;
340 }
341 
342 /*
343  * smbfs_statfs call
344  */
345 int
346 smbfs_statfs(struct mount *mp, struct statfs *sbp, struct ucred *cred)
347 {
348 	struct smbmount *smp = VFSTOSMBFS(mp);
349 	struct smbnode *np = smp->sm_root;
350 	struct smb_share *ssp = smp->sm_share;
351 	struct smb_cred scred;
352 	int error = 0;
353 
354 	if (np == NULL)
355 		return EINVAL;
356 
357 	sbp->f_iosize = SSTOVC(ssp)->vc_txmax;		/* optimal transfer block size */
358 	sbp->f_spare2 = 0;			/* placeholder */
359 	smb_makescred(&scred, curthread, cred);
360 
361 	if (SMB_DIALECT(SSTOVC(ssp)) >= SMB_DIALECT_LANMAN2_0)
362 		error = smbfs_smb_statfs2(ssp, sbp, &scred);
363 	else
364 		error = smbfs_smb_statfs(ssp, sbp, &scred);
365 	if (error)
366 		return error;
367 	sbp->f_flags = 0;		/* copy of mount exported flags */
368 	if (sbp != &mp->mnt_stat) {
369 		sbp->f_fsid = mp->mnt_stat.f_fsid;	/* file system id */
370 		sbp->f_owner = mp->mnt_stat.f_owner;	/* user that mounted the filesystem */
371 		sbp->f_type = mp->mnt_vfc->vfc_typenum;	/* type of filesystem */
372 		bcopy(mp->mnt_stat.f_mntfromname, sbp->f_mntfromname, MNAMELEN);
373 	}
374 	strncpy(sbp->f_fstypename, mp->mnt_vfc->vfc_name, MFSNAMELEN);
375 	return 0;
376 }
377 
378 /*
379  * Flush out the buffer cache
380  */
381 /* ARGSUSED */
382 static int
383 smbfs_sync(struct mount *mp, int waitfor)
384 {
385 	struct vnode *vp;
386 	int error, allerror = 0;
387 	/*
388 	 * Force stale buffer cache information to be flushed.
389 	 */
390 loop:
391 	for (vp = TAILQ_FIRST(&mp->mnt_nvnodelist);
392 	     vp != NULL;
393 	     vp = TAILQ_NEXT(vp, v_nmntvnodes)) {
394 		/*
395 		 * If the vnode that we are about to sync is no longer
396 		 * associated with this mount point, start over.
397 		 */
398 		if (vp->v_mount != mp)
399 			goto loop;
400 		if (vn_islocked(vp) || RB_EMPTY(&vp->v_rbdirty_tree) ||
401 		    (waitfor & MNT_LAZY))
402 			continue;
403 		if (vget(vp, LK_EXCLUSIVE))
404 			goto loop;
405 		error = VOP_FSYNC(vp, waitfor, 0);
406 		if (error)
407 			allerror = error;
408 		vput(vp);
409 	}
410 	return (allerror);
411 }
412 
413 #if defined(__FreeBSD__) && __FreeBSD_version < 400009
414 /*
415  * smbfs flat namespace lookup. Unsupported.
416  */
417 /* ARGSUSED */
418 static int smbfs_vget(struct mount *mp, ino_t ino, struct vnode **vpp)
419 {
420 	return (EOPNOTSUPP);
421 }
422 
423 /* ARGSUSED */
424 static int smbfs_fhtovp(struct mount *mp, struct fid *fhp,
425 			struct sockaddr *nam, struct vnode **vpp,
426 			int *exflagsp, struct ucred **credanonp)
427 {
428 	return (EINVAL);
429 }
430 
431 /*
432  * Vnode pointer to File handle, should never happen either
433  */
434 /* ARGSUSED */
435 static int
436 smbfs_vptofh(struct vnode *vp, struct fid *fhp)
437 {
438 	return (EINVAL);
439 }
440 
441 #endif /* __FreeBSD_version < 400009 */
442