fs/autofs4/waitq.c

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