2 * Copyright 2008 Red Hat, Inc. All rights reserved.
5 * This file is part of the Linux kernel and is made available under
6 * the terms of the GNU General Public License, version 2, or at your
7 * option, any later version, incorporated herein by reference.
10 #include <linux/module.h>
11 #include <linux/vmalloc.h>
12 #include <linux/miscdevice.h>
13 #include <linux/init.h>
14 #include <linux/wait.h>
15 #include <linux/namei.h>
16 #include <linux/fcntl.h>
17 #include <linux/file.h>
18 #include <linux/fdtable.h>
19 #include <linux/sched.h>
20 #include <linux/cred.h>
21 #include <linux/compat.h>
22 #include <linux/syscalls.h>
23 #include <linux/magic.h>
24 #include <linux/dcache.h>
25 #include <linux/uaccess.h>
26 #include <linux/slab.h>
31 * This module implements an interface for routing autofs ioctl control
32 * commands via a miscellaneous device file.
34 * The alternate interface is needed because we need to be able open
35 * an ioctl file descriptor on an autofs mount that may be covered by
36 * another mount. This situation arises when starting automount(8)
37 * or other user space daemon which uses direct mounts or offset
38 * mounts (used for autofs lazy mount/umount of nested mount trees),
39 * which have been left busy at at service shutdown.
42 typedef int (*ioctl_fn)(struct file *, struct autofs_sb_info *,
43 struct autofs_dev_ioctl *);
45 static int check_name(const char *name)
47 if (!strchr(name, '/'))
53 * Check a string doesn't overrun the chunk of
54 * memory we copied from user land.
56 static int invalid_str(char *str, size_t size)
58 if (memchr(str, 0, size))
64 * Check that the user compiled against correct version of autofs
67 * As well as checking the version compatibility this always copies
68 * the kernel interface version out.
70 static int check_dev_ioctl_version(int cmd, struct autofs_dev_ioctl *param)
74 if ((param->ver_major != AUTOFS_DEV_IOCTL_VERSION_MAJOR) ||
75 (param->ver_minor > AUTOFS_DEV_IOCTL_VERSION_MINOR)) {
76 pr_warn("ioctl control interface version mismatch: "
77 "kernel(%u.%u), user(%u.%u), cmd(0x%08x)\n",
78 AUTOFS_DEV_IOCTL_VERSION_MAJOR,
79 AUTOFS_DEV_IOCTL_VERSION_MINOR,
80 param->ver_major, param->ver_minor, cmd);
84 /* Fill in the kernel version. */
85 param->ver_major = AUTOFS_DEV_IOCTL_VERSION_MAJOR;
86 param->ver_minor = AUTOFS_DEV_IOCTL_VERSION_MINOR;
92 * Copy parameter control struct, including a possible path allocated
93 * at the end of the struct.
95 static struct autofs_dev_ioctl *
96 copy_dev_ioctl(struct autofs_dev_ioctl __user *in)
98 struct autofs_dev_ioctl tmp, *res;
100 if (copy_from_user(&tmp, in, AUTOFS_DEV_IOCTL_SIZE))
101 return ERR_PTR(-EFAULT);
103 if (tmp.size < AUTOFS_DEV_IOCTL_SIZE)
104 return ERR_PTR(-EINVAL);
106 if (tmp.size > AUTOFS_DEV_IOCTL_SIZE + PATH_MAX)
107 return ERR_PTR(-ENAMETOOLONG);
109 res = memdup_user(in, tmp.size);
111 res->size = tmp.size;
116 static inline void free_dev_ioctl(struct autofs_dev_ioctl *param)
122 * Check sanity of parameter control fields and if a path is present
123 * check that it is terminated and contains at least one "/".
125 static int validate_dev_ioctl(int cmd, struct autofs_dev_ioctl *param)
129 err = check_dev_ioctl_version(cmd, param);
131 pr_warn("invalid device control module version "
132 "supplied for cmd(0x%08x)\n", cmd);
136 if (param->size > AUTOFS_DEV_IOCTL_SIZE) {
137 err = invalid_str(param->path, param->size - AUTOFS_DEV_IOCTL_SIZE);
140 "path string terminator missing for cmd(0x%08x)\n",
145 err = check_name(param->path);
147 pr_warn("invalid path supplied for cmd(0x%08x)\n",
159 * Get the autofs super block info struct from the file opened on
160 * the autofs mount point.
162 static struct autofs_sb_info *autofs_dev_ioctl_sbi(struct file *f)
164 struct autofs_sb_info *sbi = NULL;
168 inode = file_inode(f);
169 sbi = autofs4_sbi(inode->i_sb);
174 /* Return autofs dev ioctl version */
175 static int autofs_dev_ioctl_version(struct file *fp,
176 struct autofs_sb_info *sbi,
177 struct autofs_dev_ioctl *param)
179 /* This should have already been set. */
180 param->ver_major = AUTOFS_DEV_IOCTL_VERSION_MAJOR;
181 param->ver_minor = AUTOFS_DEV_IOCTL_VERSION_MINOR;
185 /* Return autofs module protocol version */
186 static int autofs_dev_ioctl_protover(struct file *fp,
187 struct autofs_sb_info *sbi,
188 struct autofs_dev_ioctl *param)
190 param->protover.version = sbi->version;
194 /* Return autofs module protocol sub version */
195 static int autofs_dev_ioctl_protosubver(struct file *fp,
196 struct autofs_sb_info *sbi,
197 struct autofs_dev_ioctl *param)
199 param->protosubver.sub_version = sbi->sub_version;
203 /* Find the topmost mount satisfying test() */
204 static int find_autofs_mount(const char *pathname,
206 int test(const struct path *path, void *data),
212 err = kern_path_mountpoint(AT_FDCWD, pathname, &path, 0);
216 while (path.dentry == path.mnt->mnt_root) {
217 if (path.dentry->d_sb->s_magic == AUTOFS_SUPER_MAGIC) {
218 if (test(&path, data)) {
225 if (!follow_up(&path))
232 static int test_by_dev(const struct path *path, void *p)
234 return path->dentry->d_sb->s_dev == *(dev_t *)p;
237 static int test_by_type(const struct path *path, void *p)
239 struct autofs_info *ino = autofs4_dentry_ino(path->dentry);
241 return ino && ino->sbi->type & *(unsigned *)p;
245 * Open a file descriptor on the autofs mount point corresponding
246 * to the given path and device number (aka. new_encode_dev(sb->s_dev)).
248 static int autofs_dev_ioctl_open_mountpoint(const char *name, dev_t devid)
252 fd = get_unused_fd_flags(O_CLOEXEC);
253 if (likely(fd >= 0)) {
257 err = find_autofs_mount(name, &path, test_by_dev, &devid);
261 filp = dentry_open(&path, O_RDONLY, current_cred());
268 fd_install(fd, filp);
278 /* Open a file descriptor on an autofs mount point */
279 static int autofs_dev_ioctl_openmount(struct file *fp,
280 struct autofs_sb_info *sbi,
281 struct autofs_dev_ioctl *param)
287 /* param->path has already been checked */
288 if (!param->openmount.devid)
294 devid = new_decode_dev(param->openmount.devid);
297 fd = autofs_dev_ioctl_open_mountpoint(path, devid);
298 if (unlikely(fd < 0)) {
308 /* Close file descriptor allocated above (user can also use close(2)). */
309 static int autofs_dev_ioctl_closemount(struct file *fp,
310 struct autofs_sb_info *sbi,
311 struct autofs_dev_ioctl *param)
313 return sys_close(param->ioctlfd);
317 * Send "ready" status for an existing wait (either a mount or an expire
320 static int autofs_dev_ioctl_ready(struct file *fp,
321 struct autofs_sb_info *sbi,
322 struct autofs_dev_ioctl *param)
326 token = (autofs_wqt_t) param->ready.token;
327 return autofs4_wait_release(sbi, token, 0);
331 * Send "fail" status for an existing wait (either a mount or an expire
334 static int autofs_dev_ioctl_fail(struct file *fp,
335 struct autofs_sb_info *sbi,
336 struct autofs_dev_ioctl *param)
341 token = (autofs_wqt_t) param->fail.token;
342 status = param->fail.status < 0 ? param->fail.status : -ENOENT;
343 return autofs4_wait_release(sbi, token, status);
347 * Set the pipe fd for kernel communication to the daemon.
349 * Normally this is set at mount using an option but if we
350 * are reconnecting to a busy mount then we need to use this
351 * to tell the autofs mount about the new kernel pipe fd. In
352 * order to protect mounts against incorrectly setting the
353 * pipefd we also require that the autofs mount be catatonic.
355 * This also sets the process group id used to identify the
356 * controlling process (eg. the owning automount(8) daemon).
358 static int autofs_dev_ioctl_setpipefd(struct file *fp,
359 struct autofs_sb_info *sbi,
360 struct autofs_dev_ioctl *param)
364 struct pid *new_pid = NULL;
366 if (param->setpipefd.pipefd == -1)
369 pipefd = param->setpipefd.pipefd;
371 mutex_lock(&sbi->wq_mutex);
372 if (!sbi->catatonic) {
373 mutex_unlock(&sbi->wq_mutex);
378 new_pid = get_task_pid(current, PIDTYPE_PGID);
380 if (ns_of_pid(new_pid) != ns_of_pid(sbi->oz_pgrp)) {
381 pr_warn("not allowed to change PID namespace\n");
391 if (autofs_prepare_pipe(pipe) < 0) {
396 swap(sbi->oz_pgrp, new_pid);
397 sbi->pipefd = pipefd;
403 mutex_unlock(&sbi->wq_mutex);
408 * Make the autofs mount point catatonic, no longer responsive to
409 * mount requests. Also closes the kernel pipe file descriptor.
411 static int autofs_dev_ioctl_catatonic(struct file *fp,
412 struct autofs_sb_info *sbi,
413 struct autofs_dev_ioctl *param)
415 autofs4_catatonic_mode(sbi);
419 /* Set the autofs mount timeout */
420 static int autofs_dev_ioctl_timeout(struct file *fp,
421 struct autofs_sb_info *sbi,
422 struct autofs_dev_ioctl *param)
424 unsigned long timeout;
426 timeout = param->timeout.timeout;
427 param->timeout.timeout = sbi->exp_timeout / HZ;
428 sbi->exp_timeout = timeout * HZ;
433 * Return the uid and gid of the last request for the mount
435 * When reconstructing an autofs mount tree with active mounts
436 * we need to re-connect to mounts that may have used the original
437 * process uid and gid (or string variations of them) for mount
438 * lookups within the map entry.
440 static int autofs_dev_ioctl_requester(struct file *fp,
441 struct autofs_sb_info *sbi,
442 struct autofs_dev_ioctl *param)
444 struct autofs_info *ino;
449 if (param->size <= AUTOFS_DEV_IOCTL_SIZE) {
454 devid = sbi->sb->s_dev;
456 param->requester.uid = param->requester.gid = -1;
458 err = find_autofs_mount(param->path, &path, test_by_dev, &devid);
462 ino = autofs4_dentry_ino(path.dentry);
465 autofs4_expire_wait(&path, 0);
466 spin_lock(&sbi->fs_lock);
467 param->requester.uid =
468 from_kuid_munged(current_user_ns(), ino->uid);
469 param->requester.gid =
470 from_kgid_munged(current_user_ns(), ino->gid);
471 spin_unlock(&sbi->fs_lock);
479 * Call repeatedly until it returns -EAGAIN, meaning there's nothing
480 * more that can be done.
482 static int autofs_dev_ioctl_expire(struct file *fp,
483 struct autofs_sb_info *sbi,
484 struct autofs_dev_ioctl *param)
486 struct vfsmount *mnt;
489 how = param->expire.how;
490 mnt = fp->f_path.mnt;
492 return autofs4_do_expire_multi(sbi->sb, mnt, sbi, how);
495 /* Check if autofs mount point is in use */
496 static int autofs_dev_ioctl_askumount(struct file *fp,
497 struct autofs_sb_info *sbi,
498 struct autofs_dev_ioctl *param)
500 param->askumount.may_umount = 0;
501 if (may_umount(fp->f_path.mnt))
502 param->askumount.may_umount = 1;
507 * Check if the given path is a mountpoint.
509 * If we are supplied with the file descriptor of an autofs
510 * mount we're looking for a specific mount. In this case
511 * the path is considered a mountpoint if it is itself a
512 * mountpoint or contains a mount, such as a multi-mount
513 * without a root mount. In this case we return 1 if the
514 * path is a mount point and the super magic of the covering
515 * mount if there is one or 0 if it isn't a mountpoint.
517 * If we aren't supplied with a file descriptor then we
518 * lookup the path and check if it is the root of a mount.
519 * If a type is given we are looking for a particular autofs
520 * mount and if we don't find a match we return fail. If the
521 * located path is the root of a mount we return 1 along with
522 * the super magic of the mount or 0 otherwise.
524 * In both cases the the device number (as returned by
525 * new_encode_dev()) is also returned.
527 static int autofs_dev_ioctl_ismountpoint(struct file *fp,
528 struct autofs_sb_info *sbi,
529 struct autofs_dev_ioctl *param)
534 unsigned int devid, magic;
537 if (param->size <= AUTOFS_DEV_IOCTL_SIZE) {
543 type = param->ismountpoint.in.type;
545 param->ismountpoint.out.devid = devid = 0;
546 param->ismountpoint.out.magic = magic = 0;
548 if (!fp || param->ioctlfd == -1) {
549 if (autofs_type_any(type))
550 err = kern_path_mountpoint(AT_FDCWD,
551 name, &path, LOOKUP_FOLLOW);
553 err = find_autofs_mount(name, &path,
554 test_by_type, &type);
557 devid = new_encode_dev(path.dentry->d_sb->s_dev);
559 if (path.mnt->mnt_root == path.dentry) {
561 magic = path.dentry->d_sb->s_magic;
564 dev_t dev = sbi->sb->s_dev;
566 err = find_autofs_mount(name, &path, test_by_dev, &dev);
570 devid = new_encode_dev(dev);
572 err = path_has_submounts(&path);
574 if (follow_down_one(&path))
575 magic = path.dentry->d_sb->s_magic;
578 param->ismountpoint.out.devid = devid;
579 param->ismountpoint.out.magic = magic;
586 * Our range of ioctl numbers isn't 0 based so we need to shift
587 * the array index by _IOC_NR(AUTOFS_CTL_IOC_FIRST) for the table
590 #define cmd_idx(cmd) (cmd - _IOC_NR(AUTOFS_DEV_IOCTL_IOC_FIRST))
592 static ioctl_fn lookup_dev_ioctl(unsigned int cmd)
594 static ioctl_fn _ioctls[] = {
595 autofs_dev_ioctl_version,
596 autofs_dev_ioctl_protover,
597 autofs_dev_ioctl_protosubver,
598 autofs_dev_ioctl_openmount,
599 autofs_dev_ioctl_closemount,
600 autofs_dev_ioctl_ready,
601 autofs_dev_ioctl_fail,
602 autofs_dev_ioctl_setpipefd,
603 autofs_dev_ioctl_catatonic,
604 autofs_dev_ioctl_timeout,
605 autofs_dev_ioctl_requester,
606 autofs_dev_ioctl_expire,
607 autofs_dev_ioctl_askumount,
608 autofs_dev_ioctl_ismountpoint,
610 unsigned int idx = cmd_idx(cmd);
612 return (idx >= ARRAY_SIZE(_ioctls)) ? NULL : _ioctls[idx];
615 /* ioctl dispatcher */
616 static int _autofs_dev_ioctl(unsigned int command,
617 struct autofs_dev_ioctl __user *user)
619 struct autofs_dev_ioctl *param;
621 struct autofs_sb_info *sbi;
622 unsigned int cmd_first, cmd;
626 cmd_first = _IOC_NR(AUTOFS_DEV_IOCTL_IOC_FIRST);
627 cmd = _IOC_NR(command);
629 if (_IOC_TYPE(command) != _IOC_TYPE(AUTOFS_DEV_IOCTL_IOC_FIRST) ||
630 cmd - cmd_first > AUTOFS_DEV_IOCTL_IOC_COUNT) {
634 /* Only root can use ioctls other than AUTOFS_DEV_IOCTL_VERSION_CMD
635 * and AUTOFS_DEV_IOCTL_ISMOUNTPOINT_CMD
637 if (cmd != AUTOFS_DEV_IOCTL_VERSION_CMD &&
638 cmd != AUTOFS_DEV_IOCTL_ISMOUNTPOINT_CMD &&
639 !capable(CAP_SYS_ADMIN))
642 /* Copy the parameters into kernel space. */
643 param = copy_dev_ioctl(user);
645 return PTR_ERR(param);
647 err = validate_dev_ioctl(command, param);
651 fn = lookup_dev_ioctl(cmd);
653 pr_warn("unknown command 0x%08x\n", command);
662 * For obvious reasons the openmount can't have a file
663 * descriptor yet. We don't take a reference to the
664 * file during close to allow for immediate release,
665 * and the same for retrieving ioctl version.
667 if (cmd != AUTOFS_DEV_IOCTL_VERSION_CMD &&
668 cmd != AUTOFS_DEV_IOCTL_OPENMOUNT_CMD &&
669 cmd != AUTOFS_DEV_IOCTL_CLOSEMOUNT_CMD) {
670 fp = fget(param->ioctlfd);
672 if (cmd == AUTOFS_DEV_IOCTL_ISMOUNTPOINT_CMD)
678 sbi = autofs_dev_ioctl_sbi(fp);
679 if (!sbi || sbi->magic != AUTOFS_SBI_MAGIC) {
686 * Admin needs to be able to set the mount catatonic in
687 * order to be able to perform the re-open.
689 if (!autofs4_oz_mode(sbi) &&
690 cmd != AUTOFS_DEV_IOCTL_CATATONIC_CMD) {
697 err = fn(fp, sbi, param);
701 if (err >= 0 && copy_to_user(user, param, AUTOFS_DEV_IOCTL_SIZE))
704 free_dev_ioctl(param);
708 static long autofs_dev_ioctl(struct file *file, unsigned int command,
713 err = _autofs_dev_ioctl(command, (struct autofs_dev_ioctl __user *) u);
718 static long autofs_dev_ioctl_compat(struct file *file, unsigned int command,
721 return autofs_dev_ioctl(file, command, (unsigned long) compat_ptr(u));
724 #define autofs_dev_ioctl_compat NULL
727 static const struct file_operations _dev_ioctl_fops = {
728 .unlocked_ioctl = autofs_dev_ioctl,
729 .compat_ioctl = autofs_dev_ioctl_compat,
730 .owner = THIS_MODULE,
731 .llseek = noop_llseek,
734 static struct miscdevice _autofs_dev_ioctl_misc = {
735 .minor = AUTOFS_MINOR,
736 .name = AUTOFS_DEVICE_NAME,
737 .fops = &_dev_ioctl_fops,
741 MODULE_ALIAS_MISCDEV(AUTOFS_MINOR);
742 MODULE_ALIAS("devname:autofs");
744 /* Register/deregister misc character device */
745 int __init autofs_dev_ioctl_init(void)
749 r = misc_register(&_autofs_dev_ioctl_misc);
751 pr_err("misc_register failed for control device\n");
758 void autofs_dev_ioctl_exit(void)
760 misc_deregister(&_autofs_dev_ioctl_misc);