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