1 /* -*- c -*- --------------------------------------------------------------- *
3 * linux/fs/autofs/waitq.c
5 * Copyright 1997-1998 Transmeta Corporation -- All Rights Reserved
6 * Copyright 2001-2006 Ian Kent <raven@themaw.net>
8 * This file is part of the Linux kernel and is made available under
9 * the terms of the GNU General Public License, version 2, or at your
10 * option, any later version, incorporated herein by reference.
12 * ------------------------------------------------------------------------- */
14 #include <linux/slab.h>
15 #include <linux/time.h>
16 #include <linux/signal.h>
17 #include <linux/file.h>
20 /* We make this a static variable rather than a part of the superblock; it
21 is better if we don't reassign numbers easily even across filesystems */
22 static autofs_wqt_t autofs4_next_wait_queue = 1;
24 /* These are the signals we allow interrupting a pending mount */
25 #define SHUTDOWN_SIGS (sigmask(SIGKILL) | sigmask(SIGINT) | sigmask(SIGQUIT))
27 void autofs4_catatonic_mode(struct autofs_sb_info *sbi)
29 struct autofs_wait_queue *wq, *nwq;
31 mutex_lock(&sbi->wq_mutex);
33 mutex_unlock(&sbi->wq_mutex);
37 DPRINTK("entering catatonic mode");
41 sbi->queues = NULL; /* Erase all wait queues */
44 wq->status = -ENOENT; /* Magic is gone - report failure */
50 wake_up_interruptible(&wq->queue);
53 fput(sbi->pipe); /* Close the pipe */
56 mutex_unlock(&sbi->wq_mutex);
59 static int autofs4_write(struct file *file, const void *addr, int bytes)
61 unsigned long sigpipe, flags;
63 const char *data = (const char *)addr;
66 /** WARNING: this is not safe for writing more than PIPE_BUF bytes! **/
68 sigpipe = sigismember(¤t->pending.signal, SIGPIPE);
70 /* Save pointer to user space and point back to kernel space */
75 (wr = file->f_op->write(file,data,bytes,&file->f_pos)) > 0) {
82 /* Keep the currently executing process from receiving a
83 SIGPIPE unless it was already supposed to get one */
84 if (wr == -EPIPE && !sigpipe) {
85 spin_lock_irqsave(¤t->sighand->siglock, flags);
86 sigdelset(¤t->pending.signal, SIGPIPE);
88 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
94 static void autofs4_notify_daemon(struct autofs_sb_info *sbi,
95 struct autofs_wait_queue *wq,
99 struct autofs_packet_hdr hdr;
100 union autofs_packet_union v4_pkt;
101 union autofs_v5_packet_union v5_pkt;
103 struct file *pipe = NULL;
106 DPRINTK("wait id = 0x%08lx, name = %.*s, type=%d",
107 wq->wait_queue_token, wq->name.len, wq->name.name, type);
109 memset(&pkt,0,sizeof pkt); /* For security reasons */
111 pkt.hdr.proto_version = sbi->version;
114 /* Kernel protocol v4 missing and expire packets */
115 case autofs_ptype_missing:
117 struct autofs_packet_missing *mp = &pkt.v4_pkt.missing;
121 mp->wait_queue_token = wq->wait_queue_token;
122 mp->len = wq->name.len;
123 memcpy(mp->name, wq->name.name, wq->name.len);
124 mp->name[wq->name.len] = '\0';
127 case autofs_ptype_expire_multi:
129 struct autofs_packet_expire_multi *ep = &pkt.v4_pkt.expire_multi;
133 ep->wait_queue_token = wq->wait_queue_token;
134 ep->len = wq->name.len;
135 memcpy(ep->name, wq->name.name, wq->name.len);
136 ep->name[wq->name.len] = '\0';
140 * Kernel protocol v5 packet for handling indirect and direct
141 * mount missing and expire requests
143 case autofs_ptype_missing_indirect:
144 case autofs_ptype_expire_indirect:
145 case autofs_ptype_missing_direct:
146 case autofs_ptype_expire_direct:
148 struct autofs_v5_packet *packet = &pkt.v5_pkt.v5_packet;
150 pktsz = sizeof(*packet);
152 packet->wait_queue_token = wq->wait_queue_token;
153 packet->len = wq->name.len;
154 memcpy(packet->name, wq->name.name, wq->name.len);
155 packet->name[wq->name.len] = '\0';
156 packet->dev = wq->dev;
157 packet->ino = wq->ino;
158 packet->uid = wq->uid;
159 packet->gid = wq->gid;
160 packet->pid = wq->pid;
161 packet->tgid = wq->tgid;
165 printk("autofs4_notify_daemon: bad type %d!\n", type);
169 /* Check if we have become catatonic */
170 mutex_lock(&sbi->wq_mutex);
171 if (!sbi->catatonic) {
175 mutex_unlock(&sbi->wq_mutex);
178 if (autofs4_write(pipe, &pkt, pktsz))
179 autofs4_catatonic_mode(sbi);
184 static int autofs4_getpath(struct autofs_sb_info *sbi,
185 struct dentry *dentry, char **name)
187 struct dentry *root = sbi->sb->s_root;
193 spin_lock(&dcache_lock);
194 for (tmp = dentry ; tmp != root ; tmp = tmp->d_parent)
195 len += tmp->d_name.len + 1;
197 if (!len || --len > NAME_MAX) {
198 spin_unlock(&dcache_lock);
203 p = buf + len - dentry->d_name.len;
204 strncpy(p, dentry->d_name.name, dentry->d_name.len);
206 for (tmp = dentry->d_parent; tmp != root ; tmp = tmp->d_parent) {
208 p -= tmp->d_name.len;
209 strncpy(p, tmp->d_name.name, tmp->d_name.len);
211 spin_unlock(&dcache_lock);
216 static struct autofs_wait_queue *
217 autofs4_find_wait(struct autofs_sb_info *sbi, struct qstr *qstr)
219 struct autofs_wait_queue *wq;
221 for (wq = sbi->queues; wq; wq = wq->next) {
222 if (wq->name.hash == qstr->hash &&
223 wq->name.len == qstr->len &&
225 !memcmp(wq->name.name, qstr->name, qstr->len))
232 * Check if we have a valid request.
234 * 1 if the request should continue.
235 * In this case we can return an autofs_wait_queue entry if one is
236 * found or NULL to idicate a new wait needs to be created.
237 * 0 or a negative errno if the request shouldn't continue.
239 static int validate_request(struct autofs_wait_queue **wait,
240 struct autofs_sb_info *sbi,
242 struct dentry*dentry, enum autofs_notify notify)
244 struct autofs_wait_queue *wq;
245 struct autofs_info *ino;
247 /* Wait in progress, continue; */
248 wq = autofs4_find_wait(sbi, qstr);
256 /* If we don't yet have any info this is a new request */
257 ino = autofs4_dentry_ino(dentry);
262 * If we've been asked to wait on an existing expire (NFY_NONE)
263 * but there is no wait in the queue ...
265 if (notify == NFY_NONE) {
267 * Either we've betean the pending expire to post it's
268 * wait or it finished while we waited on the mutex.
269 * So we need to wait till either, the wait appears
270 * or the expire finishes.
273 while (ino->flags & AUTOFS_INF_EXPIRING) {
274 mutex_unlock(&sbi->wq_mutex);
275 schedule_timeout_interruptible(HZ/10);
276 if (mutex_lock_interruptible(&sbi->wq_mutex))
279 wq = autofs4_find_wait(sbi, qstr);
287 * Not ideal but the status has already gone. Of the two
288 * cases where we wait on NFY_NONE neither depend on the
289 * return status of the wait.
295 * If we've been asked to trigger a mount and the request
296 * completed while we waited on the mutex ...
298 if (notify == NFY_MOUNT) {
300 * If the dentry was successfully mounted while we slept
301 * on the wait queue mutex we can return success. If it
302 * isn't mounted (doesn't have submounts for the case of
303 * a multi-mount with no mount at it's base) we can
304 * continue on and create a new request.
306 if (have_submounts(dentry))
313 int autofs4_wait(struct autofs_sb_info *sbi, struct dentry *dentry,
314 enum autofs_notify notify)
316 struct autofs_wait_queue *wq;
319 int status, ret, type;
321 /* In catatonic mode, we don't wait for nobody */
325 if (!dentry->d_inode) {
327 * A wait for a negative dentry is invalid for certain
328 * cases. A direct or offset mount "always" has its mount
329 * point directory created and so the request dentry must
330 * be positive or the map key doesn't exist. The situation
331 * is very similar for indirect mounts except only dentrys
332 * in the root of the autofs file system may be negative.
334 if (autofs_type_trigger(sbi->type))
336 else if (!IS_ROOT(dentry->d_parent))
340 name = kmalloc(NAME_MAX + 1, GFP_KERNEL);
344 /* If this is a direct mount request create a dummy name */
345 if (IS_ROOT(dentry) && autofs_type_trigger(sbi->type))
346 qstr.len = sprintf(name, "%p", dentry);
348 qstr.len = autofs4_getpath(sbi, dentry, &name);
355 qstr.hash = full_name_hash(name, qstr.len);
357 if (mutex_lock_interruptible(&sbi->wq_mutex)) {
362 ret = validate_request(&wq, sbi, &qstr, dentry, notify);
365 mutex_unlock(&sbi->wq_mutex);
371 /* Create a new wait queue */
372 wq = kmalloc(sizeof(struct autofs_wait_queue),GFP_KERNEL);
375 mutex_unlock(&sbi->wq_mutex);
379 wq->wait_queue_token = autofs4_next_wait_queue;
380 if (++autofs4_next_wait_queue == 0)
381 autofs4_next_wait_queue = 1;
382 wq->next = sbi->queues;
384 init_waitqueue_head(&wq->queue);
385 memcpy(&wq->name, &qstr, sizeof(struct qstr));
386 wq->dev = autofs4_get_dev(sbi);
387 wq->ino = autofs4_get_ino(sbi);
388 wq->uid = current_uid();
389 wq->gid = current_gid();
390 wq->pid = current->pid;
391 wq->tgid = current->tgid;
392 wq->status = -EINTR; /* Status return if interrupted */
394 mutex_unlock(&sbi->wq_mutex);
396 if (sbi->version < 5) {
397 if (notify == NFY_MOUNT)
398 type = autofs_ptype_missing;
400 type = autofs_ptype_expire_multi;
402 if (notify == NFY_MOUNT)
403 type = autofs_type_trigger(sbi->type) ?
404 autofs_ptype_missing_direct :
405 autofs_ptype_missing_indirect;
407 type = autofs_type_trigger(sbi->type) ?
408 autofs_ptype_expire_direct :
409 autofs_ptype_expire_indirect;
412 DPRINTK("new wait id = 0x%08lx, name = %.*s, nfy=%d\n",
413 (unsigned long) wq->wait_queue_token, wq->name.len,
414 wq->name.name, notify);
416 /* autofs4_notify_daemon() may block */
417 autofs4_notify_daemon(sbi, wq, type);
420 mutex_unlock(&sbi->wq_mutex);
422 DPRINTK("existing wait id = 0x%08lx, name = %.*s, nfy=%d",
423 (unsigned long) wq->wait_queue_token, wq->name.len,
424 wq->name.name, notify);
428 * wq->name.name is NULL iff the lock is already released
429 * or the mount has been made catatonic.
432 /* Block all but "shutdown" signals while waiting */
434 unsigned long irqflags;
436 spin_lock_irqsave(¤t->sighand->siglock, irqflags);
437 oldset = current->blocked;
438 siginitsetinv(¤t->blocked, SHUTDOWN_SIGS & ~oldset.sig[0]);
440 spin_unlock_irqrestore(¤t->sighand->siglock, irqflags);
442 wait_event_interruptible(wq->queue, wq->name.name == NULL);
444 spin_lock_irqsave(¤t->sighand->siglock, irqflags);
445 current->blocked = oldset;
447 spin_unlock_irqrestore(¤t->sighand->siglock, irqflags);
449 DPRINTK("skipped sleeping");
455 * For direct and offset mounts we need to track the requester's
456 * uid and gid in the dentry info struct. This is so it can be
457 * supplied, on request, by the misc device ioctl interface.
458 * This is needed during daemon resatart when reconnecting
459 * to existing, active, autofs mounts. The uid and gid (and
460 * related string values) may be used for macro substitution
461 * in autofs mount maps.
464 struct autofs_info *ino;
465 struct dentry *de = NULL;
467 /* direct mount or browsable map */
468 ino = autofs4_dentry_ino(dentry);
470 /* If not lookup actual dentry used */
471 de = d_lookup(dentry->d_parent, &dentry->d_name);
473 ino = autofs4_dentry_ino(de);
476 /* Set mount requester */
478 spin_lock(&sbi->fs_lock);
481 spin_unlock(&sbi->fs_lock);
488 /* Are we the last process to need status? */
489 mutex_lock(&sbi->wq_mutex);
492 mutex_unlock(&sbi->wq_mutex);
498 int autofs4_wait_release(struct autofs_sb_info *sbi, autofs_wqt_t wait_queue_token, int status)
500 struct autofs_wait_queue *wq, **wql;
502 mutex_lock(&sbi->wq_mutex);
503 for (wql = &sbi->queues; (wq = *wql) != NULL; wql = &wq->next) {
504 if (wq->wait_queue_token == wait_queue_token)
509 mutex_unlock(&sbi->wq_mutex);
513 *wql = wq->next; /* Unlink from chain */
514 kfree(wq->name.name);
515 wq->name.name = NULL; /* Do not wait on this queue */
517 wake_up_interruptible(&wq->queue);
520 mutex_unlock(&sbi->wq_mutex);