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