xref: /freebsd/sys/fs/smbfs/smbfs_vfsops.c (revision 7660b554bc59a07be0431c17e0e33815818baa69)
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 "opt_netsmb.h"
35 #ifndef NETSMB
36 #error "SMBFS requires option NETSMB"
37 #endif
38 
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/proc.h>
42 #include <sys/bio.h>
43 #include <sys/buf.h>
44 #include <sys/kernel.h>
45 #include <sys/sysctl.h>
46 #include <sys/vnode.h>
47 #include <sys/mount.h>
48 #include <sys/stat.h>
49 #include <sys/malloc.h>
50 #include <sys/module.h>
51 
52 
53 #include <netsmb/smb.h>
54 #include <netsmb/smb_conn.h>
55 #include <netsmb/smb_subr.h>
56 #include <netsmb/smb_dev.h>
57 
58 #include <fs/smbfs/smbfs.h>
59 #include <fs/smbfs/smbfs_node.h>
60 #include <fs/smbfs/smbfs_subr.h>
61 
62 int smbfs_debuglevel = 0;
63 
64 static int smbfs_version = SMBFS_VERSION;
65 
66 #ifdef SMBFS_USEZONE
67 #include <vm/vm.h>
68 #include <vm/vm_extern.h>
69 
70 vm_zone_t smbfsmount_zone;
71 #endif
72 
73 SYSCTL_NODE(_vfs, OID_AUTO, smbfs, CTLFLAG_RW, 0, "SMB/CIFS filesystem");
74 SYSCTL_INT(_vfs_smbfs, OID_AUTO, version, CTLFLAG_RD, &smbfs_version, 0, "");
75 SYSCTL_INT(_vfs_smbfs, OID_AUTO, debuglevel, CTLFLAG_RW, &smbfs_debuglevel, 0, "");
76 
77 static MALLOC_DEFINE(M_SMBFSHASH, "SMBFS hash", "SMBFS hash table");
78 
79 static vfs_init_t       smbfs_init;
80 static vfs_uninit_t     smbfs_uninit;
81 static vfs_mount_t      smbfs_mount;
82 static vfs_start_t      smbfs_start;
83 static vfs_root_t       smbfs_root;
84 static vfs_quotactl_t   smbfs_quotactl;
85 static vfs_statfs_t     smbfs_statfs;
86 static vfs_unmount_t    smbfs_unmount;
87 
88 static struct vfsops smbfs_vfsops = {
89 	.vfs_init =		smbfs_init,
90 	.vfs_mount =		smbfs_mount,
91 	.vfs_quotactl =		smbfs_quotactl,
92 	.vfs_root =		smbfs_root,
93 	.vfs_start =		smbfs_start,
94 	.vfs_statfs =		smbfs_statfs,
95 	.vfs_sync =		vfs_stdsync,
96 	.vfs_uninit =		smbfs_uninit,
97 	.vfs_unmount =		smbfs_unmount,
98 };
99 
100 
101 VFS_SET(smbfs_vfsops, smbfs, VFCF_NETWORK);
102 
103 MODULE_DEPEND(smbfs, netsmb, NSMB_VERSION, NSMB_VERSION, NSMB_VERSION);
104 MODULE_DEPEND(smbfs, libiconv, 1, 1, 1);
105 MODULE_DEPEND(smbfs, libmchain, 1, 1, 1);
106 
107 int smbfs_pbuf_freecnt = -1;	/* start out unlimited */
108 
109 static int
110 smbfs_mount(struct mount *mp, char *path, caddr_t data,
111 	struct nameidata *ndp, struct thread *td)
112 {
113 	struct smbfs_args args; 	  /* will hold data from mount request */
114 	struct smbmount *smp = NULL;
115 	struct smb_vc *vcp;
116 	struct smb_share *ssp = NULL;
117 	struct vnode *vp;
118 	struct smb_cred scred;
119 	int error;
120 	char *pc, *pe;
121 
122 	if (data == NULL) {
123 		printf("missing data argument\n");
124 		return EINVAL;
125 	}
126 	if (mp->mnt_flag & MNT_UPDATE) {
127 		printf("MNT_UPDATE not implemented");
128 		return EOPNOTSUPP;
129 	}
130 	error = copyin(data, (caddr_t)&args, sizeof(struct smbfs_args));
131 	if (error)
132 		return error;
133 	if (args.version != SMBFS_VERSION) {
134 		printf("mount version mismatch: kernel=%d, mount=%d\n",
135 		    SMBFS_VERSION, args.version);
136 		return EINVAL;
137 	}
138 	smb_makescred(&scred, td, td->td_ucred);
139 	error = smb_dev2share(args.dev, SMBM_EXEC, &scred, &ssp);
140 	if (error) {
141 		printf("invalid device handle %d (%d)\n", args.dev, error);
142 		return error;
143 	}
144 	vcp = SSTOVC(ssp);
145 	smb_share_unlock(ssp, 0, td);
146 	mp->mnt_stat.f_iosize = SSTOVC(ssp)->vc_txmax;
147 
148 #ifdef SMBFS_USEZONE
149 	smp = zalloc(smbfsmount_zone);
150 #else
151 	MALLOC(smp, struct smbmount*, sizeof(*smp), M_SMBFSDATA,
152 	    M_WAITOK|M_USE_RESERVE);
153 #endif
154         if (smp == NULL) {
155                 printf("could not alloc smbmount\n");
156                 error = ENOMEM;
157 		goto bad;
158         }
159 	bzero(smp, sizeof(*smp));
160         mp->mnt_data = (qaddr_t)smp;
161 	smp->sm_hash = hashinit(desiredvnodes, M_SMBFSHASH, &smp->sm_hashlen);
162 	if (smp->sm_hash == NULL)
163 		goto bad;
164 	lockinit(&smp->sm_hashlock, PVFS, "smbfsh", 0, 0);
165 	smp->sm_share = ssp;
166 	smp->sm_root = NULL;
167         smp->sm_args = args;
168 	smp->sm_caseopt = args.caseopt;
169 	smp->sm_args.file_mode = (smp->sm_args.file_mode &
170 			    (S_IRWXU|S_IRWXG|S_IRWXO)) | S_IFREG;
171 	smp->sm_args.dir_mode  = (smp->sm_args.dir_mode &
172 			    (S_IRWXU|S_IRWXG|S_IRWXO)) | S_IFDIR;
173 
174 /*	simple_lock_init(&smp->sm_npslock);*/
175 	pc = mp->mnt_stat.f_mntfromname;
176 	pe = pc + sizeof(mp->mnt_stat.f_mntfromname);
177 	bzero(pc, MNAMELEN);
178 	*pc++ = '/';
179 	*pc++ = '/';
180 	pc=index(strncpy(pc, vcp->vc_username, pe - pc - 2), 0);
181 	if (pc < pe-1) {
182 		*(pc++) = '@';
183 		pc = index(strncpy(pc, vcp->vc_srvname, pe - pc - 2), 0);
184 		if (pc < pe - 1) {
185 			*(pc++) = '/';
186 			strncpy(pc, ssp->ss_name, pe - pc - 2);
187 		}
188 	}
189 	/* protect against invalid mount points */
190 	smp->sm_args.mount_point[sizeof(smp->sm_args.mount_point) - 1] = '\0';
191 	vfs_getnewfsid(mp);
192 	error = smbfs_root(mp, &vp);
193 	if (error)
194 		goto bad;
195 	VOP_UNLOCK(vp, 0, td);
196 	SMBVDEBUG("root.v_usecount = %d\n", vrefcnt(vp));
197 
198 #ifdef DIAGNOSTICS
199 	SMBERROR("mp=%p\n", mp);
200 #endif
201 	return error;
202 bad:
203         if (smp) {
204 		if (smp->sm_hash)
205 			free(smp->sm_hash, M_SMBFSHASH);
206 		lockdestroy(&smp->sm_hashlock);
207 #ifdef SMBFS_USEZONE
208 		zfree(smbfsmount_zone, smp);
209 #else
210 		free(smp, M_SMBFSDATA);
211 #endif
212 	}
213 	if (ssp)
214 		smb_share_put(ssp, &scred);
215         return error;
216 }
217 
218 /* Unmount the filesystem described by mp. */
219 static int
220 smbfs_unmount(struct mount *mp, int mntflags, struct thread *td)
221 {
222 	struct smbmount *smp = VFSTOSMBFS(mp);
223 	struct smb_cred scred;
224 	int error, flags;
225 
226 	SMBVDEBUG("smbfs_unmount: flags=%04x\n", mntflags);
227 	flags = 0;
228 	if (mntflags & MNT_FORCE)
229 		flags |= FORCECLOSE;
230 	/*
231 	 * Keep trying to flush the vnode list for the mount while
232 	 * some are still busy and we are making progress towards
233 	 * making them not busy. This is needed because smbfs vnodes
234 	 * reference their parent directory but may appear after their
235 	 * parent in the list; one pass over the vnode list is not
236 	 * sufficient in this case.
237 	 */
238 	do {
239 		smp->sm_didrele = 0;
240 		/* There is 1 extra root vnode reference from smbfs_mount(). */
241 		error = vflush(mp, 1, flags);
242 	} while (error == EBUSY && smp->sm_didrele != 0);
243 	if (error)
244 		return error;
245 	smb_makescred(&scred, td, td->td_ucred);
246 	smb_share_put(smp->sm_share, &scred);
247 	mp->mnt_data = (qaddr_t)0;
248 
249 	if (smp->sm_hash)
250 		free(smp->sm_hash, M_SMBFSHASH);
251 	lockdestroy(&smp->sm_hashlock);
252 #ifdef SMBFS_USEZONE
253 	zfree(smbfsmount_zone, smp);
254 #else
255 	free(smp, M_SMBFSDATA);
256 #endif
257 	mp->mnt_flag &= ~MNT_LOCAL;
258 	return error;
259 }
260 
261 /*
262  * Return locked root vnode of a filesystem
263  */
264 static int
265 smbfs_root(struct mount *mp, struct vnode **vpp)
266 {
267 	struct smbmount *smp = VFSTOSMBFS(mp);
268 	struct vnode *vp;
269 	struct smbnode *np;
270 	struct smbfattr fattr;
271 	struct thread *td = curthread;
272 	struct ucred *cred = td->td_ucred;
273 	struct smb_cred scred;
274 	int error;
275 
276 	if (smp == NULL) {
277 		SMBERROR("smp == NULL (bug in umount)\n");
278 		return EINVAL;
279 	}
280 	if (smp->sm_root) {
281 		*vpp = SMBTOV(smp->sm_root);
282 		return vget(*vpp, LK_EXCLUSIVE | LK_RETRY, td);
283 	}
284 	smb_makescred(&scred, td, cred);
285 	error = smbfs_smb_lookup(NULL, NULL, 0, &fattr, &scred);
286 	if (error)
287 		return error;
288 	error = smbfs_nget(mp, NULL, "TheRooT", 7, &fattr, &vp);
289 	if (error)
290 		return error;
291 	ASSERT_VOP_LOCKED(vp, "smbfs_root");
292 	vp->v_vflag |= VV_ROOT;
293 	np = VTOSMB(vp);
294 	smp->sm_root = np;
295 	*vpp = vp;
296 	return 0;
297 }
298 
299 /*
300  * Vfs start routine, a no-op.
301  */
302 /* ARGSUSED */
303 static int
304 smbfs_start(mp, flags, td)
305 	struct mount *mp;
306 	int flags;
307 	struct thread *td;
308 {
309 	SMBVDEBUG("flags=%04x\n", flags);
310 	return 0;
311 }
312 
313 /*
314  * Do operations associated with quotas, not supported
315  */
316 /* ARGSUSED */
317 static int
318 smbfs_quotactl(mp, cmd, uid, arg, td)
319 	struct mount *mp;
320 	int cmd;
321 	uid_t uid;
322 	caddr_t arg;
323 	struct thread *td;
324 {
325 	SMBVDEBUG("return EOPNOTSUPP\n");
326 	return EOPNOTSUPP;
327 }
328 
329 /*ARGSUSED*/
330 int
331 smbfs_init(struct vfsconf *vfsp)
332 {
333 #ifndef SMP
334 	int name[2];
335 	int ncpu, error;
336 	size_t olen, plen;
337 
338 	name[0] = CTL_HW;
339 	name[1] = HW_NCPU;
340 	error = kernel_sysctl(curthread, name, 2, &ncpu, &olen, NULL, 0, &plen);
341 	if (error == 0 && ncpu > 1)
342 		printf("warning: smbfs module compiled without SMP support.");
343 #endif
344 
345 #ifdef SMBFS_USEZONE
346 	smbfsmount_zone = zinit("SMBFSMOUNT", sizeof(struct smbmount), 0, 0, 1);
347 #endif
348 	smbfs_pbuf_freecnt = nswbuf / 2 + 1;
349 	SMBVDEBUG("done.\n");
350 	return 0;
351 }
352 
353 /*ARGSUSED*/
354 int
355 smbfs_uninit(struct vfsconf *vfsp)
356 {
357 
358 	SMBVDEBUG("done.\n");
359 	return 0;
360 }
361 
362 /*
363  * smbfs_statfs call
364  */
365 int
366 smbfs_statfs(struct mount *mp, struct statfs *sbp, struct thread *td)
367 {
368 	struct smbmount *smp = VFSTOSMBFS(mp);
369 	struct smbnode *np = smp->sm_root;
370 	struct smb_share *ssp = smp->sm_share;
371 	struct smb_cred scred;
372 	int error = 0;
373 
374 	if (np == NULL)
375 		return EINVAL;
376 
377 	sbp->f_iosize = SSTOVC(ssp)->vc_txmax;		/* optimal transfer block size */
378 	sbp->f_spare2 = 0;			/* placeholder */
379 	smb_makescred(&scred, td, td->td_ucred);
380 
381 	if (SMB_DIALECT(SSTOVC(ssp)) >= SMB_DIALECT_LANMAN2_0)
382 		error = smbfs_smb_statfs2(ssp, sbp, &scred);
383 	else
384 		error = smbfs_smb_statfs(ssp, sbp, &scred);
385 	if (error)
386 		return error;
387 	sbp->f_flags = 0;		/* copy of mount exported flags */
388 	if (sbp != &mp->mnt_stat) {
389 		sbp->f_fsid = mp->mnt_stat.f_fsid;	/* filesystem id */
390 		sbp->f_owner = mp->mnt_stat.f_owner;	/* user that mounted the filesystem */
391 		sbp->f_type = mp->mnt_vfc->vfc_typenum;	/* type of filesystem */
392 		bcopy(mp->mnt_stat.f_mntonname, sbp->f_mntonname, MNAMELEN);
393 		bcopy(mp->mnt_stat.f_mntfromname, sbp->f_mntfromname, MNAMELEN);
394 	}
395 	strncpy(sbp->f_fstypename, mp->mnt_vfc->vfc_name, MFSNAMELEN);
396 	return 0;
397 }
398