autofs4: autofs4_wait() vs. autofs4_catatonic_mode() race
[linux-3.10.git] / fs / autofs4 / waitq.c
1 /* -*- c -*- --------------------------------------------------------------- *
2  *
3  * linux/fs/autofs/waitq.c
4  *
5  *  Copyright 1997-1998 Transmeta Corporation -- All Rights Reserved
6  *  Copyright 2001-2006 Ian Kent <raven@themaw.net>
7  *
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.
11  *
12  * ------------------------------------------------------------------------- */
13
14 #include <linux/slab.h>
15 #include <linux/time.h>
16 #include <linux/signal.h>
17 #include <linux/file.h>
18 #include "autofs_i.h"
19
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;
23
24 /* These are the signals we allow interrupting a pending mount */
25 #define SHUTDOWN_SIGS   (sigmask(SIGKILL) | sigmask(SIGINT) | sigmask(SIGQUIT))
26
27 void autofs4_catatonic_mode(struct autofs_sb_info *sbi)
28 {
29         struct autofs_wait_queue *wq, *nwq;
30
31         mutex_lock(&sbi->wq_mutex);
32         if (sbi->catatonic) {
33                 mutex_unlock(&sbi->wq_mutex);
34                 return;
35         }
36
37         DPRINTK("entering catatonic mode");
38
39         sbi->catatonic = 1;
40         wq = sbi->queues;
41         sbi->queues = NULL;     /* Erase all wait queues */
42         while (wq) {
43                 nwq = wq->next;
44                 wq->status = -ENOENT; /* Magic is gone - report failure */
45                 if (wq->name.name) {
46                         kfree(wq->name.name);
47                         wq->name.name = NULL;
48                 }
49                 wq->wait_ctr--;
50                 wake_up_interruptible(&wq->queue);
51                 wq = nwq;
52         }
53         fput(sbi->pipe);        /* Close the pipe */
54         sbi->pipe = NULL;
55         sbi->pipefd = -1;
56         mutex_unlock(&sbi->wq_mutex);
57 }
58
59 static int autofs4_write(struct file *file, const void *addr, int bytes)
60 {
61         unsigned long sigpipe, flags;
62         mm_segment_t fs;
63         const char *data = (const char *)addr;
64         ssize_t wr = 0;
65
66         /** WARNING: this is not safe for writing more than PIPE_BUF bytes! **/
67
68         sigpipe = sigismember(&current->pending.signal, SIGPIPE);
69
70         /* Save pointer to user space and point back to kernel space */
71         fs = get_fs();
72         set_fs(KERNEL_DS);
73
74         while (bytes &&
75                (wr = file->f_op->write(file,data,bytes,&file->f_pos)) > 0) {
76                 data += wr;
77                 bytes -= wr;
78         }
79
80         set_fs(fs);
81
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(&current->sighand->siglock, flags);
86                 sigdelset(&current->pending.signal, SIGPIPE);
87                 recalc_sigpending();
88                 spin_unlock_irqrestore(&current->sighand->siglock, flags);
89         }
90
91         return (bytes > 0);
92 }
93         
94 static void autofs4_notify_daemon(struct autofs_sb_info *sbi,
95                                  struct autofs_wait_queue *wq,
96                                  int type)
97 {
98         union {
99                 struct autofs_packet_hdr hdr;
100                 union autofs_packet_union v4_pkt;
101                 union autofs_v5_packet_union v5_pkt;
102         } pkt;
103         struct file *pipe = NULL;
104         size_t pktsz;
105
106         DPRINTK("wait id = 0x%08lx, name = %.*s, type=%d",
107                 (unsigned long) wq->wait_queue_token, wq->name.len, wq->name.name, type);
108
109         memset(&pkt,0,sizeof pkt); /* For security reasons */
110
111         pkt.hdr.proto_version = sbi->version;
112         pkt.hdr.type = type;
113         switch (type) {
114         /* Kernel protocol v4 missing and expire packets */
115         case autofs_ptype_missing:
116         {
117                 struct autofs_packet_missing *mp = &pkt.v4_pkt.missing;
118
119                 pktsz = sizeof(*mp);
120
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';
125                 break;
126         }
127         case autofs_ptype_expire_multi:
128         {
129                 struct autofs_packet_expire_multi *ep = &pkt.v4_pkt.expire_multi;
130
131                 pktsz = sizeof(*ep);
132
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';
137                 break;
138         }
139         /*
140          * Kernel protocol v5 packet for handling indirect and direct
141          * mount missing and expire requests
142          */
143         case autofs_ptype_missing_indirect:
144         case autofs_ptype_expire_indirect:
145         case autofs_ptype_missing_direct:
146         case autofs_ptype_expire_direct:
147         {
148                 struct autofs_v5_packet *packet = &pkt.v5_pkt.v5_packet;
149
150                 pktsz = sizeof(*packet);
151
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;
162                 break;
163         }
164         default:
165                 printk("autofs4_notify_daemon: bad type %d!\n", type);
166                 return;
167         }
168
169         /* Check if we have become catatonic */
170         mutex_lock(&sbi->wq_mutex);
171         if (!sbi->catatonic) {
172                 pipe = sbi->pipe;
173                 get_file(pipe);
174         }
175         mutex_unlock(&sbi->wq_mutex);
176
177         if (pipe) {
178                 if (autofs4_write(pipe, &pkt, pktsz))
179                         autofs4_catatonic_mode(sbi);
180                 fput(pipe);
181         }
182 }
183
184 static int autofs4_getpath(struct autofs_sb_info *sbi,
185                            struct dentry *dentry, char **name)
186 {
187         struct dentry *root = sbi->sb->s_root;
188         struct dentry *tmp;
189         char *buf;
190         char *p;
191         int len;
192         unsigned seq;
193
194 rename_retry:
195         buf = *name;
196         len = 0;
197
198         seq = read_seqbegin(&rename_lock);
199         rcu_read_lock();
200         spin_lock(&sbi->fs_lock);
201         for (tmp = dentry ; tmp != root ; tmp = tmp->d_parent)
202                 len += tmp->d_name.len + 1;
203
204         if (!len || --len > NAME_MAX) {
205                 spin_unlock(&sbi->fs_lock);
206                 rcu_read_unlock();
207                 if (read_seqretry(&rename_lock, seq))
208                         goto rename_retry;
209                 return 0;
210         }
211
212         *(buf + len) = '\0';
213         p = buf + len - dentry->d_name.len;
214         strncpy(p, dentry->d_name.name, dentry->d_name.len);
215
216         for (tmp = dentry->d_parent; tmp != root ; tmp = tmp->d_parent) {
217                 *(--p) = '/';
218                 p -= tmp->d_name.len;
219                 strncpy(p, tmp->d_name.name, tmp->d_name.len);
220         }
221         spin_unlock(&sbi->fs_lock);
222         rcu_read_unlock();
223         if (read_seqretry(&rename_lock, seq))
224                 goto rename_retry;
225
226         return len;
227 }
228
229 static struct autofs_wait_queue *
230 autofs4_find_wait(struct autofs_sb_info *sbi, struct qstr *qstr)
231 {
232         struct autofs_wait_queue *wq;
233
234         for (wq = sbi->queues; wq; wq = wq->next) {
235                 if (wq->name.hash == qstr->hash &&
236                     wq->name.len == qstr->len &&
237                     wq->name.name &&
238                          !memcmp(wq->name.name, qstr->name, qstr->len))
239                         break;
240         }
241         return wq;
242 }
243
244 /*
245  * Check if we have a valid request.
246  * Returns
247  * 1 if the request should continue.
248  *   In this case we can return an autofs_wait_queue entry if one is
249  *   found or NULL to idicate a new wait needs to be created.
250  * 0 or a negative errno if the request shouldn't continue.
251  */
252 static int validate_request(struct autofs_wait_queue **wait,
253                             struct autofs_sb_info *sbi,
254                             struct qstr *qstr,
255                             struct dentry*dentry, enum autofs_notify notify)
256 {
257         struct autofs_wait_queue *wq;
258         struct autofs_info *ino;
259
260         if (sbi->catatonic)
261                 return -ENOENT;
262
263         /* Wait in progress, continue; */
264         wq = autofs4_find_wait(sbi, qstr);
265         if (wq) {
266                 *wait = wq;
267                 return 1;
268         }
269
270         *wait = NULL;
271
272         /* If we don't yet have any info this is a new request */
273         ino = autofs4_dentry_ino(dentry);
274         if (!ino)
275                 return 1;
276
277         /*
278          * If we've been asked to wait on an existing expire (NFY_NONE)
279          * but there is no wait in the queue ...
280          */
281         if (notify == NFY_NONE) {
282                 /*
283                  * Either we've betean the pending expire to post it's
284                  * wait or it finished while we waited on the mutex.
285                  * So we need to wait till either, the wait appears
286                  * or the expire finishes.
287                  */
288
289                 while (ino->flags & AUTOFS_INF_EXPIRING) {
290                         mutex_unlock(&sbi->wq_mutex);
291                         schedule_timeout_interruptible(HZ/10);
292                         if (mutex_lock_interruptible(&sbi->wq_mutex))
293                                 return -EINTR;
294
295                         if (sbi->catatonic)
296                                 return -ENOENT;
297
298                         wq = autofs4_find_wait(sbi, qstr);
299                         if (wq) {
300                                 *wait = wq;
301                                 return 1;
302                         }
303                 }
304
305                 /*
306                  * Not ideal but the status has already gone. Of the two
307                  * cases where we wait on NFY_NONE neither depend on the
308                  * return status of the wait.
309                  */
310                 return 0;
311         }
312
313         /*
314          * If we've been asked to trigger a mount and the request
315          * completed while we waited on the mutex ...
316          */
317         if (notify == NFY_MOUNT) {
318                 struct dentry *new = NULL;
319                 int valid = 1;
320
321                 /*
322                  * If the dentry was successfully mounted while we slept
323                  * on the wait queue mutex we can return success. If it
324                  * isn't mounted (doesn't have submounts for the case of
325                  * a multi-mount with no mount at it's base) we can
326                  * continue on and create a new request.
327                  */
328                 if (!IS_ROOT(dentry)) {
329                         if (dentry->d_inode && d_unhashed(dentry)) {
330                                 struct dentry *parent = dentry->d_parent;
331                                 new = d_lookup(parent, &dentry->d_name);
332                                 if (new)
333                                         dentry = new;
334                         }
335                 }
336                 if (have_submounts(dentry))
337                         valid = 0;
338
339                 if (new)
340                         dput(new);
341                 return valid;
342         }
343
344         return 1;
345 }
346
347 int autofs4_wait(struct autofs_sb_info *sbi, struct dentry *dentry,
348                 enum autofs_notify notify)
349 {
350         struct autofs_wait_queue *wq;
351         struct qstr qstr;
352         char *name;
353         int status, ret, type;
354
355         /* In catatonic mode, we don't wait for nobody */
356         if (sbi->catatonic)
357                 return -ENOENT;
358
359         if (!dentry->d_inode) {
360                 /*
361                  * A wait for a negative dentry is invalid for certain
362                  * cases. A direct or offset mount "always" has its mount
363                  * point directory created and so the request dentry must
364                  * be positive or the map key doesn't exist. The situation
365                  * is very similar for indirect mounts except only dentrys
366                  * in the root of the autofs file system may be negative.
367                  */
368                 if (autofs_type_trigger(sbi->type))
369                         return -ENOENT;
370                 else if (!IS_ROOT(dentry->d_parent))
371                         return -ENOENT;
372         }
373
374         name = kmalloc(NAME_MAX + 1, GFP_KERNEL);
375         if (!name)
376                 return -ENOMEM;
377
378         /* If this is a direct mount request create a dummy name */
379         if (IS_ROOT(dentry) && autofs_type_trigger(sbi->type))
380                 qstr.len = sprintf(name, "%p", dentry);
381         else {
382                 qstr.len = autofs4_getpath(sbi, dentry, &name);
383                 if (!qstr.len) {
384                         kfree(name);
385                         return -ENOENT;
386                 }
387         }
388         qstr.name = name;
389         qstr.hash = full_name_hash(name, qstr.len);
390
391         if (mutex_lock_interruptible(&sbi->wq_mutex)) {
392                 kfree(qstr.name);
393                 return -EINTR;
394         }
395
396         ret = validate_request(&wq, sbi, &qstr, dentry, notify);
397         if (ret <= 0) {
398                 if (ret != -EINTR)
399                         mutex_unlock(&sbi->wq_mutex);
400                 kfree(qstr.name);
401                 return ret;
402         }
403
404         if (!wq) {
405                 /* Create a new wait queue */
406                 wq = kmalloc(sizeof(struct autofs_wait_queue),GFP_KERNEL);
407                 if (!wq) {
408                         kfree(qstr.name);
409                         mutex_unlock(&sbi->wq_mutex);
410                         return -ENOMEM;
411                 }
412
413                 wq->wait_queue_token = autofs4_next_wait_queue;
414                 if (++autofs4_next_wait_queue == 0)
415                         autofs4_next_wait_queue = 1;
416                 wq->next = sbi->queues;
417                 sbi->queues = wq;
418                 init_waitqueue_head(&wq->queue);
419                 memcpy(&wq->name, &qstr, sizeof(struct qstr));
420                 wq->dev = autofs4_get_dev(sbi);
421                 wq->ino = autofs4_get_ino(sbi);
422                 wq->uid = current_uid();
423                 wq->gid = current_gid();
424                 wq->pid = current->pid;
425                 wq->tgid = current->tgid;
426                 wq->status = -EINTR; /* Status return if interrupted */
427                 wq->wait_ctr = 2;
428                 mutex_unlock(&sbi->wq_mutex);
429
430                 if (sbi->version < 5) {
431                         if (notify == NFY_MOUNT)
432                                 type = autofs_ptype_missing;
433                         else
434                                 type = autofs_ptype_expire_multi;
435                 } else {
436                         if (notify == NFY_MOUNT)
437                                 type = autofs_type_trigger(sbi->type) ?
438                                         autofs_ptype_missing_direct :
439                                          autofs_ptype_missing_indirect;
440                         else
441                                 type = autofs_type_trigger(sbi->type) ?
442                                         autofs_ptype_expire_direct :
443                                         autofs_ptype_expire_indirect;
444                 }
445
446                 DPRINTK("new wait id = 0x%08lx, name = %.*s, nfy=%d\n",
447                         (unsigned long) wq->wait_queue_token, wq->name.len,
448                         wq->name.name, notify);
449
450                 /* autofs4_notify_daemon() may block */
451                 autofs4_notify_daemon(sbi, wq, type);
452         } else {
453                 wq->wait_ctr++;
454                 mutex_unlock(&sbi->wq_mutex);
455                 kfree(qstr.name);
456                 DPRINTK("existing wait id = 0x%08lx, name = %.*s, nfy=%d",
457                         (unsigned long) wq->wait_queue_token, wq->name.len,
458                         wq->name.name, notify);
459         }
460
461         /*
462          * wq->name.name is NULL iff the lock is already released
463          * or the mount has been made catatonic.
464          */
465         if (wq->name.name) {
466                 /* Block all but "shutdown" signals while waiting */
467                 sigset_t oldset;
468                 unsigned long irqflags;
469
470                 spin_lock_irqsave(&current->sighand->siglock, irqflags);
471                 oldset = current->blocked;
472                 siginitsetinv(&current->blocked, SHUTDOWN_SIGS & ~oldset.sig[0]);
473                 recalc_sigpending();
474                 spin_unlock_irqrestore(&current->sighand->siglock, irqflags);
475
476                 wait_event_interruptible(wq->queue, wq->name.name == NULL);
477
478                 spin_lock_irqsave(&current->sighand->siglock, irqflags);
479                 current->blocked = oldset;
480                 recalc_sigpending();
481                 spin_unlock_irqrestore(&current->sighand->siglock, irqflags);
482         } else {
483                 DPRINTK("skipped sleeping");
484         }
485
486         status = wq->status;
487
488         /*
489          * For direct and offset mounts we need to track the requester's
490          * uid and gid in the dentry info struct. This is so it can be
491          * supplied, on request, by the misc device ioctl interface.
492          * This is needed during daemon resatart when reconnecting
493          * to existing, active, autofs mounts. The uid and gid (and
494          * related string values) may be used for macro substitution
495          * in autofs mount maps.
496          */
497         if (!status) {
498                 struct autofs_info *ino;
499                 struct dentry *de = NULL;
500
501                 /* direct mount or browsable map */
502                 ino = autofs4_dentry_ino(dentry);
503                 if (!ino) {
504                         /* If not lookup actual dentry used */
505                         de = d_lookup(dentry->d_parent, &dentry->d_name);
506                         if (de)
507                                 ino = autofs4_dentry_ino(de);
508                 }
509
510                 /* Set mount requester */
511                 if (ino) {
512                         spin_lock(&sbi->fs_lock);
513                         ino->uid = wq->uid;
514                         ino->gid = wq->gid;
515                         spin_unlock(&sbi->fs_lock);
516                 }
517
518                 if (de)
519                         dput(de);
520         }
521
522         /* Are we the last process to need status? */
523         mutex_lock(&sbi->wq_mutex);
524         if (!--wq->wait_ctr)
525                 kfree(wq);
526         mutex_unlock(&sbi->wq_mutex);
527
528         return status;
529 }
530
531
532 int autofs4_wait_release(struct autofs_sb_info *sbi, autofs_wqt_t wait_queue_token, int status)
533 {
534         struct autofs_wait_queue *wq, **wql;
535
536         mutex_lock(&sbi->wq_mutex);
537         for (wql = &sbi->queues; (wq = *wql) != NULL; wql = &wq->next) {
538                 if (wq->wait_queue_token == wait_queue_token)
539                         break;
540         }
541
542         if (!wq) {
543                 mutex_unlock(&sbi->wq_mutex);
544                 return -EINVAL;
545         }
546
547         *wql = wq->next;        /* Unlink from chain */
548         kfree(wq->name.name);
549         wq->name.name = NULL;   /* Do not wait on this queue */
550         wq->status = status;
551         wake_up_interruptible(&wq->queue);
552         if (!--wq->wait_ctr)
553                 kfree(wq);
554         mutex_unlock(&sbi->wq_mutex);
555
556         return 0;
557 }
558