xref: /freebsd/sys/fs/smbfs/smbfs_vfsops.c (revision 7afb8adff33d47f10a11368ff54bb2eec5b30165)
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  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/proc.h>
32 #include <sys/bio.h>
33 #include <sys/buf.h>
34 #include <sys/kernel.h>
35 #include <sys/sysctl.h>
36 #include <sys/vnode.h>
37 #include <sys/mount.h>
38 #include <sys/stat.h>
39 #include <sys/malloc.h>
40 #include <sys/module.h>
41 #include <sys/sx.h>
42 
43 
44 #include <netsmb/smb.h>
45 #include <netsmb/smb_conn.h>
46 #include <netsmb/smb_subr.h>
47 #include <netsmb/smb_dev.h>
48 
49 #include <fs/smbfs/smbfs.h>
50 #include <fs/smbfs/smbfs_node.h>
51 #include <fs/smbfs/smbfs_subr.h>
52 
53 static int smbfs_debuglevel = 0;
54 
55 static int smbfs_version = SMBFS_VERSION;
56 
57 SYSCTL_NODE(_vfs, OID_AUTO, smbfs, CTLFLAG_RW, 0, "SMB/CIFS filesystem");
58 SYSCTL_INT(_vfs_smbfs, OID_AUTO, version, CTLFLAG_RD, &smbfs_version, 0, "");
59 SYSCTL_INT(_vfs_smbfs, OID_AUTO, debuglevel, CTLFLAG_RW, &smbfs_debuglevel, 0, "");
60 
61 static vfs_init_t       smbfs_init;
62 static vfs_uninit_t     smbfs_uninit;
63 static vfs_cmount_t     smbfs_cmount;
64 static vfs_mount_t      smbfs_mount;
65 static vfs_root_t       smbfs_root;
66 static vfs_quotactl_t   smbfs_quotactl;
67 static vfs_statfs_t     smbfs_statfs;
68 static vfs_unmount_t    smbfs_unmount;
69 
70 static struct vfsops smbfs_vfsops = {
71 	.vfs_init =		smbfs_init,
72 	.vfs_cmount =		smbfs_cmount,
73 	.vfs_mount =		smbfs_mount,
74 	.vfs_quotactl =		smbfs_quotactl,
75 	.vfs_root =		smbfs_root,
76 	.vfs_statfs =		smbfs_statfs,
77 	.vfs_sync =		vfs_stdsync,
78 	.vfs_uninit =		smbfs_uninit,
79 	.vfs_unmount =		smbfs_unmount,
80 };
81 
82 
83 VFS_SET(smbfs_vfsops, smbfs, VFCF_NETWORK);
84 
85 MODULE_DEPEND(smbfs, netsmb, NSMB_VERSION, NSMB_VERSION, NSMB_VERSION);
86 MODULE_DEPEND(smbfs, libiconv, 1, 1, 2);
87 MODULE_DEPEND(smbfs, libmchain, 1, 1, 1);
88 
89 int smbfs_pbuf_freecnt = -1;	/* start out unlimited */
90 
91 static int
92 smbfs_cmount(struct mntarg *ma, void * data, uint64_t flags)
93 {
94 	struct smbfs_args args;
95 	int error;
96 
97 	error = copyin(data, &args, sizeof(struct smbfs_args));
98 	if (error)
99 		return error;
100 
101 	if (args.version != SMBFS_VERSION) {
102 		printf("mount version mismatch: kernel=%d, mount=%d\n",
103 		    SMBFS_VERSION, args.version);
104 		return EINVAL;
105 	}
106 	ma = mount_argf(ma, "dev", "%d", args.dev);
107 	ma = mount_argb(ma, args.flags & SMBFS_MOUNT_SOFT, "nosoft");
108 	ma = mount_argb(ma, args.flags & SMBFS_MOUNT_INTR, "nointr");
109 	ma = mount_argb(ma, args.flags & SMBFS_MOUNT_STRONG, "nostrong");
110 	ma = mount_argb(ma, args.flags & SMBFS_MOUNT_HAVE_NLS, "nohave_nls");
111 	ma = mount_argb(ma, !(args.flags & SMBFS_MOUNT_NO_LONG), "nolong");
112 	ma = mount_arg(ma, "rootpath", args.root_path, -1);
113 	ma = mount_argf(ma, "uid", "%d", args.uid);
114 	ma = mount_argf(ma, "gid", "%d", args.gid);
115 	ma = mount_argf(ma, "file_mode", "%d", args.file_mode);
116 	ma = mount_argf(ma, "dir_mode", "%d", args.dir_mode);
117 	ma = mount_argf(ma, "caseopt", "%d", args.caseopt);
118 
119 	error = kernel_mount(ma, flags);
120 
121 	return (error);
122 }
123 
124 static const char *smbfs_opts[] = {
125 	"fd", "soft", "intr", "strong", "have_nls", "long",
126 	"mountpoint", "rootpath", "uid", "gid", "file_mode", "dir_mode",
127 	"caseopt", "errmsg", NULL
128 };
129 
130 static int
131 smbfs_mount(struct mount *mp)
132 {
133 	struct smbmount *smp = NULL;
134 	struct smb_vc *vcp;
135 	struct smb_share *ssp = NULL;
136 	struct vnode *vp;
137 	struct thread *td;
138 	struct smb_dev *dev;
139 	struct smb_cred *scred;
140 	int error, v;
141 	char *pc, *pe;
142 
143 	dev = NULL;
144 	td = curthread;
145 	if (mp->mnt_flag & (MNT_UPDATE | MNT_ROOTFS))
146 		return EOPNOTSUPP;
147 
148 	if (vfs_filteropt(mp->mnt_optnew, smbfs_opts)) {
149 		vfs_mount_error(mp, "%s", "Invalid option");
150 		return (EINVAL);
151 	}
152 
153 	scred = smbfs_malloc_scred();
154 	smb_makescred(scred, td, td->td_ucred);
155 
156 	/* Ask userspace of `fd`, the file descriptor of this session */
157 	if (1 != vfs_scanopt(mp->mnt_optnew, "fd", "%d", &v)) {
158 		vfs_mount_error(mp, "No fd option");
159 		smbfs_free_scred(scred);
160 		return (EINVAL);
161 	}
162 	error = smb_dev2share(v, SMBM_EXEC, scred, &ssp, &dev);
163 	smp = malloc(sizeof(*smp), M_SMBFSDATA, M_WAITOK | M_ZERO);
164 	if (error) {
165 		printf("invalid device handle %d (%d)\n", v, error);
166 		vfs_mount_error(mp, "invalid device handle %d %d\n", v, error);
167 		smbfs_free_scred(scred);
168 		free(smp, M_SMBFSDATA);
169 		return error;
170 	}
171 	vcp = SSTOVC(ssp);
172 	smb_share_unlock(ssp);
173 	mp->mnt_stat.f_iosize = SSTOVC(ssp)->vc_txmax;
174 	mp->mnt_data = smp;
175 	smp->sm_share = ssp;
176 	smp->sm_root = NULL;
177 	smp->sm_dev = dev;
178 	if (1 != vfs_scanopt(mp->mnt_optnew,
179 	    "caseopt", "%d", &smp->sm_caseopt)) {
180 		vfs_mount_error(mp, "Invalid caseopt");
181 		error = EINVAL;
182 		goto bad;
183 	}
184 	if (1 != vfs_scanopt(mp->mnt_optnew, "uid", "%d", &v)) {
185 		vfs_mount_error(mp, "Invalid uid");
186 		error = EINVAL;
187 		goto bad;
188 	}
189 	smp->sm_uid = v;
190 
191 	if (1 != vfs_scanopt(mp->mnt_optnew, "gid", "%d", &v)) {
192 		vfs_mount_error(mp, "Invalid gid");
193 		error = EINVAL;
194 		goto bad;
195 	}
196 	smp->sm_gid = v;
197 
198 	if (1 != vfs_scanopt(mp->mnt_optnew, "file_mode", "%d", &v)) {
199 		vfs_mount_error(mp, "Invalid file_mode");
200 		error = EINVAL;
201 		goto bad;
202 	}
203 	smp->sm_file_mode = (v & (S_IRWXU|S_IRWXG|S_IRWXO)) | S_IFREG;
204 
205 	if (1 != vfs_scanopt(mp->mnt_optnew, "dir_mode", "%d", &v)) {
206 		vfs_mount_error(mp, "Invalid dir_mode");
207 		error = EINVAL;
208 		goto bad;
209 	}
210 	smp->sm_dir_mode  = (v & (S_IRWXU|S_IRWXG|S_IRWXO)) | S_IFDIR;
211 
212 	vfs_flagopt(mp->mnt_optnew,
213 	    "nolong", &smp->sm_flags, SMBFS_MOUNT_NO_LONG);
214 
215 	pc = mp->mnt_stat.f_mntfromname;
216 	pe = pc + sizeof(mp->mnt_stat.f_mntfromname);
217 	bzero(pc, MNAMELEN);
218 	*pc++ = '/';
219 	*pc++ = '/';
220 	pc = strchr(strncpy(pc, vcp->vc_username, pe - pc - 2), 0);
221 	if (pc < pe-1) {
222 		*(pc++) = '@';
223 		pc = strchr(strncpy(pc, vcp->vc_srvname, pe - pc - 2), 0);
224 		if (pc < pe - 1) {
225 			*(pc++) = '/';
226 			strncpy(pc, ssp->ss_name, pe - pc - 2);
227 		}
228 	}
229 	vfs_getnewfsid(mp);
230 	error = smbfs_root(mp, LK_EXCLUSIVE, &vp);
231 	if (error) {
232 		vfs_mount_error(mp, "smbfs_root error: %d", error);
233 		goto bad;
234 	}
235 	VOP_UNLOCK(vp, 0);
236 	SMBVDEBUG("root.v_usecount = %d\n", vrefcnt(vp));
237 
238 #ifdef DIAGNOSTIC
239 	SMBERROR("mp=%p\n", mp);
240 #endif
241 	smbfs_free_scred(scred);
242 	return error;
243 bad:
244 	if (ssp)
245 		smb_share_put(ssp, scred);
246 	smbfs_free_scred(scred);
247 	SMB_LOCK();
248 	if (error && smp->sm_dev == dev) {
249 		smp->sm_dev = NULL;
250 		sdp_trydestroy(dev);
251 	}
252 	SMB_UNLOCK();
253 	free(smp, M_SMBFSDATA);
254 	return error;
255 }
256 
257 /* Unmount the filesystem described by mp. */
258 static int
259 smbfs_unmount(struct mount *mp, int mntflags)
260 {
261 	struct thread *td;
262 	struct smbmount *smp = VFSTOSMBFS(mp);
263 	struct smb_cred *scred;
264 	struct smb_dev *dev;
265 	int error, flags;
266 
267 	SMBVDEBUG("smbfs_unmount: flags=%04x\n", mntflags);
268 	td = curthread;
269 	flags = 0;
270 	if (mntflags & MNT_FORCE)
271 		flags |= FORCECLOSE;
272 	/*
273 	 * Keep trying to flush the vnode list for the mount while
274 	 * some are still busy and we are making progress towards
275 	 * making them not busy. This is needed because smbfs vnodes
276 	 * reference their parent directory but may appear after their
277 	 * parent in the list; one pass over the vnode list is not
278 	 * sufficient in this case.
279 	 */
280 	do {
281 		smp->sm_didrele = 0;
282 		/* There is 1 extra root vnode reference from smbfs_mount(). */
283 		error = vflush(mp, 1, flags, td);
284 	} while (error == EBUSY && smp->sm_didrele != 0);
285 	if (error)
286 		return error;
287 	scred = smbfs_malloc_scred();
288 	smb_makescred(scred, td, td->td_ucred);
289 	error = smb_share_lock(smp->sm_share);
290 	if (error)
291 		goto out;
292 	smb_share_put(smp->sm_share, scred);
293 	SMB_LOCK();
294 	dev = smp->sm_dev;
295 	if (!dev)
296 		panic("No private data for mount point");
297 	sdp_trydestroy(dev);
298 	mp->mnt_data = NULL;
299 	SMB_UNLOCK();
300 	free(smp, M_SMBFSDATA);
301 	MNT_ILOCK(mp);
302 	mp->mnt_flag &= ~MNT_LOCAL;
303 	MNT_IUNLOCK(mp);
304 out:
305 	smbfs_free_scred(scred);
306 	return error;
307 }
308 
309 /*
310  * Return locked root vnode of a filesystem
311  */
312 static int
313 smbfs_root(struct mount *mp, int flags, struct vnode **vpp)
314 {
315 	struct smbmount *smp = VFSTOSMBFS(mp);
316 	struct vnode *vp;
317 	struct smbnode *np;
318 	struct smbfattr fattr;
319 	struct thread *td;
320 	struct ucred *cred;
321 	struct smb_cred *scred;
322 	int error;
323 
324 	td = curthread;
325 	cred = td->td_ucred;
326 
327 	if (smp->sm_root) {
328 		*vpp = SMBTOV(smp->sm_root);
329 		return vget(*vpp, LK_EXCLUSIVE | LK_RETRY, td);
330 	}
331 	scred = smbfs_malloc_scred();
332 	smb_makescred(scred, td, cred);
333 	error = smbfs_smb_lookup(NULL, NULL, 0, &fattr, scred);
334 	if (error)
335 		goto out;
336 	error = smbfs_nget(mp, NULL, NULL, 0, &fattr, &vp);
337 	if (error)
338 		goto out;
339 	ASSERT_VOP_LOCKED(vp, "smbfs_root");
340 	vp->v_vflag |= VV_ROOT;
341 	np = VTOSMB(vp);
342 	smp->sm_root = np;
343 	*vpp = vp;
344 out:
345 	smbfs_free_scred(scred);
346 	return error;
347 }
348 
349 /*
350  * Do operations associated with quotas, not supported
351  */
352 /* ARGSUSED */
353 static int
354 smbfs_quotactl(mp, cmd, uid, arg)
355 	struct mount *mp;
356 	int cmd;
357 	uid_t uid;
358 	void *arg;
359 {
360 	SMBVDEBUG("return EOPNOTSUPP\n");
361 	return EOPNOTSUPP;
362 }
363 
364 /*ARGSUSED*/
365 int
366 smbfs_init(struct vfsconf *vfsp)
367 {
368 	smbfs_pbuf_freecnt = nswbuf / 2 + 1;
369 	SMBVDEBUG("done.\n");
370 	return 0;
371 }
372 
373 /*ARGSUSED*/
374 int
375 smbfs_uninit(struct vfsconf *vfsp)
376 {
377 
378 	SMBVDEBUG("done.\n");
379 	return 0;
380 }
381 
382 /*
383  * smbfs_statfs call
384  */
385 int
386 smbfs_statfs(struct mount *mp, struct statfs *sbp)
387 {
388 	struct thread *td = curthread;
389 	struct smbmount *smp = VFSTOSMBFS(mp);
390 	struct smbnode *np = smp->sm_root;
391 	struct smb_share *ssp = smp->sm_share;
392 	struct smb_cred *scred;
393 	int error;
394 
395 	if (np == NULL) {
396 		vfs_mount_error(mp, "np == NULL");
397 		return EINVAL;
398 	}
399 
400 	sbp->f_iosize = SSTOVC(ssp)->vc_txmax;		/* optimal transfer block size */
401 	scred = smbfs_malloc_scred();
402 	smb_makescred(scred, td, td->td_ucred);
403 	error = smbfs_smb_statfs(ssp, sbp, scred);
404 	smbfs_free_scred(scred);
405 	return (error);
406 }
407