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