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