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