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/miscdevice.h>
11 #include <linux/compat.h>
12 #include <linux/syscalls.h>
13 #include <linux/magic.h>
18 * This module implements an interface for routing autofs ioctl control
19 * commands via a miscellaneous device file.
21 * The alternate interface is needed because we need to be able open
22 * an ioctl file descriptor on an autofs mount that may be covered by
23 * another mount. This situation arises when starting automount(8)
24 * or other user space daemon which uses direct mounts or offset
25 * mounts (used for autofs lazy mount/umount of nested mount trees),
26 * which have been left busy at at service shutdown.
29 typedef int (*ioctl_fn)(struct file *, struct autofs_sb_info *,
30 struct autofs_dev_ioctl *);
32 static int check_name(const char *name)
34 if (!strchr(name, '/'))
40 * Check a string doesn't overrun the chunk of
41 * memory we copied from user land.
43 static int invalid_str(char *str, size_t size)
45 if (memchr(str, 0, size))
51 * Check that the user compiled against correct version of autofs
54 * As well as checking the version compatibility this always copies
55 * the kernel interface version out.
57 static int check_dev_ioctl_version(int cmd, struct autofs_dev_ioctl *param)
61 if ((param->ver_major != AUTOFS_DEV_IOCTL_VERSION_MAJOR) ||
62 (param->ver_minor > AUTOFS_DEV_IOCTL_VERSION_MINOR)) {
63 pr_warn("ioctl control interface version mismatch: "
64 "kernel(%u.%u), user(%u.%u), cmd(0x%08x)\n",
65 AUTOFS_DEV_IOCTL_VERSION_MAJOR,
66 AUTOFS_DEV_IOCTL_VERSION_MINOR,
67 param->ver_major, param->ver_minor, cmd);
71 /* Fill in the kernel version. */
72 param->ver_major = AUTOFS_DEV_IOCTL_VERSION_MAJOR;
73 param->ver_minor = AUTOFS_DEV_IOCTL_VERSION_MINOR;
79 * Copy parameter control struct, including a possible path allocated
80 * at the end of the struct.
82 static struct autofs_dev_ioctl *
83 copy_dev_ioctl(struct autofs_dev_ioctl __user *in)
85 struct autofs_dev_ioctl tmp, *res;
87 if (copy_from_user(&tmp, in, AUTOFS_DEV_IOCTL_SIZE))
88 return ERR_PTR(-EFAULT);
90 if (tmp.size < AUTOFS_DEV_IOCTL_SIZE)
91 return ERR_PTR(-EINVAL);
93 if (tmp.size > AUTOFS_DEV_IOCTL_SIZE + PATH_MAX)
94 return ERR_PTR(-ENAMETOOLONG);
96 res = memdup_user(in, tmp.size);
103 static inline void free_dev_ioctl(struct autofs_dev_ioctl *param)
109 * Check sanity of parameter control fields and if a path is present
110 * check that it is terminated and contains at least one "/".
112 static int validate_dev_ioctl(int cmd, struct autofs_dev_ioctl *param)
116 err = check_dev_ioctl_version(cmd, param);
118 pr_warn("invalid device control module version "
119 "supplied for cmd(0x%08x)\n", cmd);
123 if (param->size > AUTOFS_DEV_IOCTL_SIZE) {
124 err = invalid_str(param->path, param->size - AUTOFS_DEV_IOCTL_SIZE);
127 "path string terminator missing for cmd(0x%08x)\n",
132 err = check_name(param->path);
134 pr_warn("invalid path supplied for cmd(0x%08x)\n",
139 unsigned int inr = _IOC_NR(cmd);
141 if (inr == AUTOFS_DEV_IOCTL_OPENMOUNT_CMD ||
142 inr == AUTOFS_DEV_IOCTL_REQUESTER_CMD ||
143 inr == AUTOFS_DEV_IOCTL_ISMOUNTPOINT_CMD) {
154 /* Return autofs dev ioctl version */
155 static int autofs_dev_ioctl_version(struct file *fp,
156 struct autofs_sb_info *sbi,
157 struct autofs_dev_ioctl *param)
159 /* This should have already been set. */
160 param->ver_major = AUTOFS_DEV_IOCTL_VERSION_MAJOR;
161 param->ver_minor = AUTOFS_DEV_IOCTL_VERSION_MINOR;
165 /* Return autofs module protocol version */
166 static int autofs_dev_ioctl_protover(struct file *fp,
167 struct autofs_sb_info *sbi,
168 struct autofs_dev_ioctl *param)
170 param->protover.version = sbi->version;
174 /* Return autofs module protocol sub version */
175 static int autofs_dev_ioctl_protosubver(struct file *fp,
176 struct autofs_sb_info *sbi,
177 struct autofs_dev_ioctl *param)
179 param->protosubver.sub_version = sbi->sub_version;
183 /* Find the topmost mount satisfying test() */
184 static int find_autofs_mount(const char *pathname,
186 int test(const struct path *path, void *data),
192 err = kern_path_mountpoint(AT_FDCWD, pathname, &path, 0);
196 while (path.dentry == path.mnt->mnt_root) {
197 if (path.dentry->d_sb->s_magic == AUTOFS_SUPER_MAGIC) {
198 if (test(&path, data)) {
205 if (!follow_up(&path))
212 static int test_by_dev(const struct path *path, void *p)
214 return path->dentry->d_sb->s_dev == *(dev_t *)p;
217 static int test_by_type(const struct path *path, void *p)
219 struct autofs_info *ino = autofs_dentry_ino(path->dentry);
221 return ino && ino->sbi->type & *(unsigned *)p;
225 * Open a file descriptor on the autofs mount point corresponding
226 * to the given path and device number (aka. new_encode_dev(sb->s_dev)).
228 static int autofs_dev_ioctl_open_mountpoint(const char *name, dev_t devid)
232 fd = get_unused_fd_flags(O_CLOEXEC);
233 if (likely(fd >= 0)) {
237 err = find_autofs_mount(name, &path, test_by_dev, &devid);
241 filp = dentry_open(&path, O_RDONLY, current_cred());
248 fd_install(fd, filp);
258 /* Open a file descriptor on an autofs mount point */
259 static int autofs_dev_ioctl_openmount(struct file *fp,
260 struct autofs_sb_info *sbi,
261 struct autofs_dev_ioctl *param)
267 /* param->path has been checked in validate_dev_ioctl() */
269 if (!param->openmount.devid)
275 devid = new_decode_dev(param->openmount.devid);
278 fd = autofs_dev_ioctl_open_mountpoint(path, devid);
279 if (unlikely(fd < 0)) {
289 /* Close file descriptor allocated above (user can also use close(2)). */
290 static int autofs_dev_ioctl_closemount(struct file *fp,
291 struct autofs_sb_info *sbi,
292 struct autofs_dev_ioctl *param)
294 return ksys_close(param->ioctlfd);
298 * Send "ready" status for an existing wait (either a mount or an expire
301 static int autofs_dev_ioctl_ready(struct file *fp,
302 struct autofs_sb_info *sbi,
303 struct autofs_dev_ioctl *param)
307 token = (autofs_wqt_t) param->ready.token;
308 return autofs_wait_release(sbi, token, 0);
312 * Send "fail" status for an existing wait (either a mount or an expire
315 static int autofs_dev_ioctl_fail(struct file *fp,
316 struct autofs_sb_info *sbi,
317 struct autofs_dev_ioctl *param)
322 token = (autofs_wqt_t) param->fail.token;
323 status = param->fail.status < 0 ? param->fail.status : -ENOENT;
324 return autofs_wait_release(sbi, token, status);
328 * Set the pipe fd for kernel communication to the daemon.
330 * Normally this is set at mount using an option but if we
331 * are reconnecting to a busy mount then we need to use this
332 * to tell the autofs mount about the new kernel pipe fd. In
333 * order to protect mounts against incorrectly setting the
334 * pipefd we also require that the autofs mount be catatonic.
336 * This also sets the process group id used to identify the
337 * controlling process (eg. the owning automount(8) daemon).
339 static int autofs_dev_ioctl_setpipefd(struct file *fp,
340 struct autofs_sb_info *sbi,
341 struct autofs_dev_ioctl *param)
345 struct pid *new_pid = NULL;
347 if (param->setpipefd.pipefd == -1)
350 pipefd = param->setpipefd.pipefd;
352 mutex_lock(&sbi->wq_mutex);
353 if (!(sbi->flags & AUTOFS_SBI_CATATONIC)) {
354 mutex_unlock(&sbi->wq_mutex);
359 new_pid = get_task_pid(current, PIDTYPE_PGID);
361 if (ns_of_pid(new_pid) != ns_of_pid(sbi->oz_pgrp)) {
362 pr_warn("not allowed to change PID namespace\n");
372 if (autofs_prepare_pipe(pipe) < 0) {
377 swap(sbi->oz_pgrp, new_pid);
378 sbi->pipefd = pipefd;
380 sbi->flags &= ~AUTOFS_SBI_CATATONIC;
384 mutex_unlock(&sbi->wq_mutex);
389 * Make the autofs mount point catatonic, no longer responsive to
390 * mount requests. Also closes the kernel pipe file descriptor.
392 static int autofs_dev_ioctl_catatonic(struct file *fp,
393 struct autofs_sb_info *sbi,
394 struct autofs_dev_ioctl *param)
396 autofs_catatonic_mode(sbi);
400 /* Set the autofs mount timeout */
401 static int autofs_dev_ioctl_timeout(struct file *fp,
402 struct autofs_sb_info *sbi,
403 struct autofs_dev_ioctl *param)
405 unsigned long timeout;
407 timeout = param->timeout.timeout;
408 param->timeout.timeout = sbi->exp_timeout / HZ;
409 sbi->exp_timeout = timeout * HZ;
414 * Return the uid and gid of the last request for the mount
416 * When reconstructing an autofs mount tree with active mounts
417 * we need to re-connect to mounts that may have used the original
418 * process uid and gid (or string variations of them) for mount
419 * lookups within the map entry.
421 static int autofs_dev_ioctl_requester(struct file *fp,
422 struct autofs_sb_info *sbi,
423 struct autofs_dev_ioctl *param)
425 struct autofs_info *ino;
430 /* param->path has been checked in validate_dev_ioctl() */
432 devid = sbi->sb->s_dev;
434 param->requester.uid = param->requester.gid = -1;
436 err = find_autofs_mount(param->path, &path, test_by_dev, &devid);
440 ino = autofs_dentry_ino(path.dentry);
443 autofs_expire_wait(&path, 0);
444 spin_lock(&sbi->fs_lock);
445 param->requester.uid =
446 from_kuid_munged(current_user_ns(), ino->uid);
447 param->requester.gid =
448 from_kgid_munged(current_user_ns(), ino->gid);
449 spin_unlock(&sbi->fs_lock);
457 * Call repeatedly until it returns -EAGAIN, meaning there's nothing
458 * more that can be done.
460 static int autofs_dev_ioctl_expire(struct file *fp,
461 struct autofs_sb_info *sbi,
462 struct autofs_dev_ioctl *param)
464 struct vfsmount *mnt;
467 how = param->expire.how;
468 mnt = fp->f_path.mnt;
470 return autofs_do_expire_multi(sbi->sb, mnt, sbi, how);
473 /* Check if autofs mount point is in use */
474 static int autofs_dev_ioctl_askumount(struct file *fp,
475 struct autofs_sb_info *sbi,
476 struct autofs_dev_ioctl *param)
478 param->askumount.may_umount = 0;
479 if (may_umount(fp->f_path.mnt))
480 param->askumount.may_umount = 1;
485 * Check if the given path is a mountpoint.
487 * If we are supplied with the file descriptor of an autofs
488 * mount we're looking for a specific mount. In this case
489 * the path is considered a mountpoint if it is itself a
490 * mountpoint or contains a mount, such as a multi-mount
491 * without a root mount. In this case we return 1 if the
492 * path is a mount point and the super magic of the covering
493 * mount if there is one or 0 if it isn't a mountpoint.
495 * If we aren't supplied with a file descriptor then we
496 * lookup the path and check if it is the root of a mount.
497 * If a type is given we are looking for a particular autofs
498 * mount and if we don't find a match we return fail. If the
499 * located path is the root of a mount we return 1 along with
500 * the super magic of the mount or 0 otherwise.
502 * In both cases the the device number (as returned by
503 * new_encode_dev()) is also returned.
505 static int autofs_dev_ioctl_ismountpoint(struct file *fp,
506 struct autofs_sb_info *sbi,
507 struct autofs_dev_ioctl *param)
512 unsigned int devid, magic;
515 /* param->path has been checked in validate_dev_ioctl() */
518 type = param->ismountpoint.in.type;
520 param->ismountpoint.out.devid = devid = 0;
521 param->ismountpoint.out.magic = magic = 0;
523 if (!fp || param->ioctlfd == -1) {
524 if (autofs_type_any(type))
525 err = kern_path_mountpoint(AT_FDCWD,
526 name, &path, LOOKUP_FOLLOW);
528 err = find_autofs_mount(name, &path,
529 test_by_type, &type);
532 devid = new_encode_dev(path.dentry->d_sb->s_dev);
534 if (path.mnt->mnt_root == path.dentry) {
536 magic = path.dentry->d_sb->s_magic;
539 dev_t dev = sbi->sb->s_dev;
541 err = find_autofs_mount(name, &path, test_by_dev, &dev);
545 devid = new_encode_dev(dev);
547 err = path_has_submounts(&path);
549 if (follow_down_one(&path))
550 magic = path.dentry->d_sb->s_magic;
553 param->ismountpoint.out.devid = devid;
554 param->ismountpoint.out.magic = magic;
561 * Our range of ioctl numbers isn't 0 based so we need to shift
562 * the array index by _IOC_NR(AUTOFS_CTL_IOC_FIRST) for the table
565 #define cmd_idx(cmd) (cmd - _IOC_NR(AUTOFS_DEV_IOCTL_IOC_FIRST))
567 static ioctl_fn lookup_dev_ioctl(unsigned int cmd)
569 static ioctl_fn _ioctls[] = {
570 autofs_dev_ioctl_version,
571 autofs_dev_ioctl_protover,
572 autofs_dev_ioctl_protosubver,
573 autofs_dev_ioctl_openmount,
574 autofs_dev_ioctl_closemount,
575 autofs_dev_ioctl_ready,
576 autofs_dev_ioctl_fail,
577 autofs_dev_ioctl_setpipefd,
578 autofs_dev_ioctl_catatonic,
579 autofs_dev_ioctl_timeout,
580 autofs_dev_ioctl_requester,
581 autofs_dev_ioctl_expire,
582 autofs_dev_ioctl_askumount,
583 autofs_dev_ioctl_ismountpoint,
585 unsigned int idx = cmd_idx(cmd);
587 return (idx >= ARRAY_SIZE(_ioctls)) ? NULL : _ioctls[idx];
590 /* ioctl dispatcher */
591 static int _autofs_dev_ioctl(unsigned int command,
592 struct autofs_dev_ioctl __user *user)
594 struct autofs_dev_ioctl *param;
596 struct autofs_sb_info *sbi;
597 unsigned int cmd_first, cmd;
601 cmd_first = _IOC_NR(AUTOFS_DEV_IOCTL_IOC_FIRST);
602 cmd = _IOC_NR(command);
604 if (_IOC_TYPE(command) != _IOC_TYPE(AUTOFS_DEV_IOCTL_IOC_FIRST) ||
605 cmd - cmd_first > AUTOFS_DEV_IOCTL_IOC_COUNT) {
609 /* Only root can use ioctls other than AUTOFS_DEV_IOCTL_VERSION_CMD
610 * and AUTOFS_DEV_IOCTL_ISMOUNTPOINT_CMD
612 if (cmd != AUTOFS_DEV_IOCTL_VERSION_CMD &&
613 cmd != AUTOFS_DEV_IOCTL_ISMOUNTPOINT_CMD &&
614 !capable(CAP_SYS_ADMIN))
617 /* Copy the parameters into kernel space. */
618 param = copy_dev_ioctl(user);
620 return PTR_ERR(param);
622 err = validate_dev_ioctl(command, param);
626 fn = lookup_dev_ioctl(cmd);
628 pr_warn("unknown command 0x%08x\n", command);
637 * For obvious reasons the openmount can't have a file
638 * descriptor yet. We don't take a reference to the
639 * file during close to allow for immediate release,
640 * and the same for retrieving ioctl version.
642 if (cmd != AUTOFS_DEV_IOCTL_VERSION_CMD &&
643 cmd != AUTOFS_DEV_IOCTL_OPENMOUNT_CMD &&
644 cmd != AUTOFS_DEV_IOCTL_CLOSEMOUNT_CMD) {
645 struct super_block *sb;
647 fp = fget(param->ioctlfd);
649 if (cmd == AUTOFS_DEV_IOCTL_ISMOUNTPOINT_CMD)
655 sb = file_inode(fp)->i_sb;
656 if (sb->s_type != &autofs_fs_type) {
661 sbi = autofs_sbi(sb);
664 * Admin needs to be able to set the mount catatonic in
665 * order to be able to perform the re-open.
667 if (!autofs_oz_mode(sbi) &&
668 cmd != AUTOFS_DEV_IOCTL_CATATONIC_CMD) {
675 err = fn(fp, sbi, param);
679 if (err >= 0 && copy_to_user(user, param, AUTOFS_DEV_IOCTL_SIZE))
682 free_dev_ioctl(param);
686 static long autofs_dev_ioctl(struct file *file, unsigned int command,
691 err = _autofs_dev_ioctl(command, (struct autofs_dev_ioctl __user *) u);
696 static long autofs_dev_ioctl_compat(struct file *file, unsigned int command,
699 return autofs_dev_ioctl(file, command, (unsigned long) compat_ptr(u));
702 #define autofs_dev_ioctl_compat NULL
705 static const struct file_operations _dev_ioctl_fops = {
706 .unlocked_ioctl = autofs_dev_ioctl,
707 .compat_ioctl = autofs_dev_ioctl_compat,
708 .owner = THIS_MODULE,
709 .llseek = noop_llseek,
712 static struct miscdevice _autofs_dev_ioctl_misc = {
713 .minor = AUTOFS_MINOR,
714 .name = AUTOFS_DEVICE_NAME,
715 .fops = &_dev_ioctl_fops,
719 MODULE_ALIAS_MISCDEV(AUTOFS_MINOR);
720 MODULE_ALIAS("devname:autofs");
722 /* Register/deregister misc character device */
723 int __init autofs_dev_ioctl_init(void)
727 r = misc_register(&_autofs_dev_ioctl_misc);
729 pr_err("misc_register failed for control device\n");
736 void autofs_dev_ioctl_exit(void)
738 misc_deregister(&_autofs_dev_ioctl_misc);