fs/autofs4/expire.c

   1 /* -*- c -*- --------------------------------------------------------------- *
   2  *
   3  * linux/fs/autofs/expire.c
   4  *
   5  *  Copyright 1997-1998 Transmeta Corporation -- All Rights Reserved
   6  *  Copyright 1999-2000 Jeremy Fitzhardinge <jeremy@goop.org>
   7  *  Copyright 2001-2006 Ian Kent <raven@themaw.net>
   8  *
   9  * This file is part of the Linux kernel and is made available under
  10  * the terms of the GNU General Public License, version 2, or at your
  11  * option, any later version, incorporated herein by reference.
  12  *
  13  * ------------------------------------------------------------------------- */
  14
  15 #include "autofs_i.h"
  16
  17 static unsigned long now;
  18
  19 /* Check if a dentry can be expired */
  20 static inline int autofs4_can_expire(struct dentry *dentry,
  21                                         unsigned long timeout, int do_now)
  22 {
  23         struct autofs_info *ino = autofs4_dentry_ino(dentry);
  24
  25         /* dentry in the process of being deleted */
  26         if (ino == NULL)
  27                 return 0;
  28
  29         /* No point expiring a pending mount */
  30         if (ino->flags & AUTOFS_INF_PENDING)
  31                 return 0;
  32
  33         if (!do_now) {
  34                 /* Too young to die */
  35                 if (!timeout || time_after(ino->last_used + timeout, now))
  36                         return 0;
  37
  38                 /* update last_used here :-
  39                    - obviously makes sense if it is in use now
  40                    - less obviously, prevents rapid-fire expire
  41                      attempts if expire fails the first time */
  42                 ino->last_used = now;
  43         }
  44         return 1;
  45 }
  46
  47 /* Check a mount point for busyness */
  48 static int autofs4_mount_busy(struct vfsmount *mnt, struct dentry *dentry)
  49 {
  50         struct dentry *top = dentry;
  51         struct path path = {.mnt = mnt, .dentry = dentry};
  52         int status = 1;
  53
  54         DPRINTK("dentry %p %.*s",
  55                 dentry, (int)dentry->d_name.len, dentry->d_name.name);
  56
  57         path_get(&path);
  58
  59         if (!follow_down_one(&path))
  60                 goto done;
  61
  62         if (is_autofs4_dentry(path.dentry)) {
  63                 struct autofs_sb_info *sbi = autofs4_sbi(path.dentry->d_sb);
  64
  65                 /* This is an autofs submount, we can't expire it */
  66                 if (autofs_type_indirect(sbi->type))
  67                         goto done;
  68
  69                 /*
  70                  * Otherwise it's an offset mount and we need to check
  71                  * if we can umount its mount, if there is one.
  72                  */
  73                 if (!d_mountpoint(path.dentry)) {
  74                         status = 0;
  75                         goto done;
  76                 }
  77         }
  78
  79         /* Update the expiry counter if fs is busy */
  80         if (!may_umount_tree(path.mnt)) {
  81                 struct autofs_info *ino = autofs4_dentry_ino(top);
  82                 ino->last_used = jiffies;
  83                 goto done;
  84         }
  85
  86         status = 0;
  87 done:
  88         DPRINTK("returning = %d", status);
  89         path_put(&path);
  90         return status;
  91 }
  92
  93 /*
  94  * Calculate and dget next entry in top down tree traversal.
  95  */
  96 static struct dentry *get_next_positive_dentry(struct dentry *prev,
  97                                                 struct dentry *root)
  98 {
  99         struct list_head *next;
 100         struct dentry *p, *ret;
 101
 102         if (prev == NULL)
 103                 return dget(prev);
 104
 105         spin_lock(&autofs4_lock);
 106 relock:
 107         p = prev;
 108         spin_lock(&p->d_lock);
 109 again:
 110         next = p->d_subdirs.next;
 111         if (next == &p->d_subdirs) {
 112                 while (1) {
 113                         struct dentry *parent;
 114
 115                         if (p == root) {
 116                                 spin_unlock(&p->d_lock);
 117                                 spin_unlock(&autofs4_lock);
 118                                 dput(prev);
 119                                 return NULL;
 120                         }
 121
 122                         parent = p->d_parent;
 123                         if (!spin_trylock(&parent->d_lock)) {
 124                                 spin_unlock(&p->d_lock);
 125                                 cpu_relax();
 126                                 goto relock;
 127                         }
 128                         spin_unlock(&p->d_lock);
 129                         next = p->d_u.d_child.next;
 130                         p = parent;
 131                         if (next != &parent->d_subdirs)
 132                                 break;
 133                 }
 134         }
 135         ret = list_entry(next, struct dentry, d_u.d_child);
 136
 137         spin_lock_nested(&ret->d_lock, DENTRY_D_LOCK_NESTED);
 138         /* Negative dentry - try next */
 139         if (!simple_positive(ret)) {
 140                 spin_unlock(&ret->d_lock);
 141                 p = ret;
 142                 goto again;
 143         }
 144         dget_dlock(ret);
 145         spin_unlock(&ret->d_lock);
 146         spin_unlock(&p->d_lock);
 147         spin_unlock(&autofs4_lock);
 148
 149         dput(prev);
 150
 151         return ret;
 152 }
 153
 154 /*
 155  * Check a direct mount point for busyness.
 156  * Direct mounts have similar expiry semantics to tree mounts.
 157  * The tree is not busy iff no mountpoints are busy and there are no
 158  * autofs submounts.
 159  */
 160 static int autofs4_direct_busy(struct vfsmount *mnt,
 161                                 struct dentry *top,
 162                                 unsigned long timeout,
 163                                 int do_now)
 164 {
 165         DPRINTK("top %p %.*s",
 166                 top, (int) top->d_name.len, top->d_name.name);
 167
 168         /* If it's busy update the expiry counters */
 169         if (!may_umount_tree(mnt)) {
 170                 struct autofs_info *ino = autofs4_dentry_ino(top);
 171                 if (ino)
 172                         ino->last_used = jiffies;
 173                 return 1;
 174         }
 175
 176         /* Timeout of a direct mount is determined by its top dentry */
 177         if (!autofs4_can_expire(top, timeout, do_now))
 178                 return 1;
 179
 180         return 0;
 181 }
 182
 183 /* Check a directory tree of mount points for busyness
 184  * The tree is not busy iff no mountpoints are busy
 185  */
 186 static int autofs4_tree_busy(struct vfsmount *mnt,
 187                              struct dentry *top,
 188                              unsigned long timeout,
 189                              int do_now)
 190 {
 191         struct autofs_info *top_ino = autofs4_dentry_ino(top);
 192         struct dentry *p;
 193
 194         DPRINTK("top %p %.*s",
 195                 top, (int)top->d_name.len, top->d_name.name);
 196
 197         /* Negative dentry - give up */
 198         if (!simple_positive(top))
 199                 return 1;
 200
 201         p = NULL;
 202         while ((p = get_next_positive_dentry(p, top))) {
 203                 DPRINTK("dentry %p %.*s",
 204                         p, (int) p->d_name.len, p->d_name.name);
 205
 206                 /*
 207                  * Is someone visiting anywhere in the subtree ?
 208                  * If there's no mount we need to check the usage
 209                  * count for the autofs dentry.
 210                  * If the fs is busy update the expiry counter.
 211                  */
 212                 if (d_mountpoint(p)) {
 213                         if (autofs4_mount_busy(mnt, p)) {
 214                                 top_ino->last_used = jiffies;
 215                                 dput(p);
 216                                 return 1;
 217                         }
 218                 } else {
 219                         struct autofs_info *ino = autofs4_dentry_ino(p);
 220                         unsigned int ino_count = atomic_read(&ino->count);
 221
 222                         /*
 223                          * Clean stale dentries below that have not been
 224                          * invalidated after a mount fail during lookup
 225                          */
 226                         d_invalidate(p);
 227
 228                         /* allow for dget above and top is already dgot */
 229                         if (p == top)
 230                                 ino_count += 2;
 231                         else
 232                                 ino_count++;
 233
 234                         if (p->d_count > ino_count) {
 235                                 top_ino->last_used = jiffies;
 236                                 dput(p);
 237                                 return 1;
 238                         }
 239                 }
 240         }
 241
 242         /* Timeout of a tree mount is ultimately determined by its top dentry */
 243         if (!autofs4_can_expire(top, timeout, do_now))
 244                 return 1;
 245
 246         return 0;
 247 }
 248
 249 static struct dentry *autofs4_check_leaves(struct vfsmount *mnt,
 250                                            struct dentry *parent,
 251                                            unsigned long timeout,
 252                                            int do_now)
 253 {
 254         struct dentry *p;
 255
 256         DPRINTK("parent %p %.*s",
 257                 parent, (int)parent->d_name.len, parent->d_name.name);
 258
 259         p = NULL;
 260         while ((p = get_next_positive_dentry(p, parent))) {
 261                 DPRINTK("dentry %p %.*s",
 262                         p, (int) p->d_name.len, p->d_name.name);
 263
 264                 if (d_mountpoint(p)) {
 265                         /* Can we umount this guy */
 266                         if (autofs4_mount_busy(mnt, p))
 267                                 continue;
 268
 269                         /* Can we expire this guy */
 270                         if (autofs4_can_expire(p, timeout, do_now))
 271                                 return p;
 272                 }
 273         }
 274         return NULL;
 275 }
 276
 277 /* Check if we can expire a direct mount (possibly a tree) */
 278 struct dentry *autofs4_expire_direct(struct super_block *sb,
 279                                      struct vfsmount *mnt,
 280                                      struct autofs_sb_info *sbi,
 281                                      int how)
 282 {
 283         unsigned long timeout;
 284         struct dentry *root = dget(sb->s_root);
 285         int do_now = how & AUTOFS_EXP_IMMEDIATE;
 286
 287         if (!root)
 288                 return NULL;
 289
 290         now = jiffies;
 291         timeout = sbi->exp_timeout;
 292
 293         spin_lock(&sbi->fs_lock);
 294         if (!autofs4_direct_busy(mnt, root, timeout, do_now)) {
 295                 struct autofs_info *ino = autofs4_dentry_ino(root);
 296                 if (d_mountpoint(root)) {
 297                         ino->flags |= AUTOFS_INF_MOUNTPOINT;
 298                         spin_lock(&root->d_lock);
 299                         root->d_flags &= ~DCACHE_MOUNTED;
 300                         spin_unlock(&root->d_lock);
 301                 }
 302                 ino->flags |= AUTOFS_INF_EXPIRING;
 303                 managed_dentry_set_automount(root);
 304                 init_completion(&ino->expire_complete);
 305                 spin_unlock(&sbi->fs_lock);
 306                 return root;
 307         }
 308         spin_unlock(&sbi->fs_lock);
 309         dput(root);
 310
 311         return NULL;
 312 }
 313
 314 /*
 315  * Find an eligible tree to time-out
 316  * A tree is eligible if :-
 317  *  - it is unused by any user process
 318  *  - it has been unused for exp_timeout time
 319  */
 320 struct dentry *autofs4_expire_indirect(struct super_block *sb,
 321                                        struct vfsmount *mnt,
 322                                        struct autofs_sb_info *sbi,
 323                                        int how)
 324 {
 325         unsigned long timeout;
 326         struct dentry *root = sb->s_root;
 327         struct dentry *dentry;
 328         struct dentry *expired = NULL;
 329         int do_now = how & AUTOFS_EXP_IMMEDIATE;
 330         int exp_leaves = how & AUTOFS_EXP_LEAVES;
 331         struct autofs_info *ino;
 332         unsigned int ino_count;
 333
 334         if (!root)
 335                 return NULL;
 336
 337         now = jiffies;
 338         timeout = sbi->exp_timeout;
 339
 340         dentry = NULL;
 341         while ((dentry = get_next_positive_dentry(dentry, root))) {
 342                 spin_lock(&sbi->fs_lock);
 343                 ino = autofs4_dentry_ino(dentry);
 344
 345                 /*
 346                  * Case 1: (i) indirect mount or top level pseudo direct mount
 347                  *         (autofs-4.1).
 348                  *         (ii) indirect mount with offset mount, check the "/"
 349                  *         offset (autofs-5.0+).
 350                  */
 351                 if (d_mountpoint(dentry)) {
 352                         DPRINTK("checking mountpoint %p %.*s",
 353                                 dentry, (int)dentry->d_name.len, dentry->d_name.name);
 354
 355                         /* Path walk currently on this dentry? */
 356                         ino_count = atomic_read(&ino->count) + 2;
 357                         if (dentry->d_count > ino_count)
 358                                 goto next;
 359
 360                         /* Can we umount this guy */
 361                         if (autofs4_mount_busy(mnt, dentry))
 362                                 goto next;
 363
 364                         /* Can we expire this guy */
 365                         if (autofs4_can_expire(dentry, timeout, do_now)) {
 366                                 expired = dentry;
 367                                 goto found;
 368                         }
 369                         goto next;
 370                 }
 371
 372                 if (simple_empty(dentry))
 373                         goto next;
 374
 375                 /* Case 2: tree mount, expire iff entire tree is not busy */
 376                 if (!exp_leaves) {
 377                         /* Path walk currently on this dentry? */
 378                         ino_count = atomic_read(&ino->count) + 1;
 379                         if (dentry->d_count > ino_count)
 380                                 goto next;
 381
 382                         if (!autofs4_tree_busy(mnt, dentry, timeout, do_now)) {
 383                                 expired = dentry;
 384                                 goto found;
 385                         }
 386                 /*
 387                  * Case 3: pseudo direct mount, expire individual leaves
 388                  *         (autofs-4.1).
 389                  */
 390                 } else {
 391                         /* Path walk currently on this dentry? */
 392                         ino_count = atomic_read(&ino->count) + 1;
 393                         if (dentry->d_count > ino_count)
 394                                 goto next;
 395
 396                         expired = autofs4_check_leaves(mnt, dentry, timeout, do_now);
 397                         if (expired) {
 398                                 dput(dentry);
 399                                 goto found;
 400                         }
 401                 }
 402 next:
 403                 spin_unlock(&sbi->fs_lock);
 404         }
 405         return NULL;
 406
 407 found:
 408         DPRINTK("returning %p %.*s",
 409                 expired, (int)expired->d_name.len, expired->d_name.name);
 410         ino = autofs4_dentry_ino(expired);
 411         ino->flags |= AUTOFS_INF_EXPIRING;
 412         managed_dentry_set_automount(expired);
 413         init_completion(&ino->expire_complete);
 414         spin_unlock(&sbi->fs_lock);
 415         spin_lock(&autofs4_lock);
 416         spin_lock(&expired->d_parent->d_lock);
 417         spin_lock_nested(&expired->d_lock, DENTRY_D_LOCK_NESTED);
 418         list_move(&expired->d_parent->d_subdirs, &expired->d_u.d_child);
 419         spin_unlock(&expired->d_lock);
 420         spin_unlock(&expired->d_parent->d_lock);
 421         spin_unlock(&autofs4_lock);
 422         return expired;
 423 }
 424
 425 int autofs4_expire_wait(struct dentry *dentry)
 426 {
 427         struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
 428         struct autofs_info *ino = autofs4_dentry_ino(dentry);
 429         int status;
 430
 431         /* Block on any pending expire */
 432         spin_lock(&sbi->fs_lock);
 433         if (ino->flags & AUTOFS_INF_EXPIRING) {
 434                 spin_unlock(&sbi->fs_lock);
 435
 436                 DPRINTK("waiting for expire %p name=%.*s",
 437                          dentry, dentry->d_name.len, dentry->d_name.name);
 438
 439                 status = autofs4_wait(sbi, dentry, NFY_NONE);
 440                 wait_for_completion(&ino->expire_complete);
 441
 442                 DPRINTK("expire done status=%d", status);
 443
 444                 if (d_unhashed(dentry))
 445                         return -EAGAIN;
 446
 447                 return status;
 448         }
 449         spin_unlock(&sbi->fs_lock);
 450
 451         return 0;
 452 }
 453
 454 /* Perform an expiry operation */
 455 int autofs4_expire_run(struct super_block *sb,
 456                       struct vfsmount *mnt,
 457                       struct autofs_sb_info *sbi,
 458                       struct autofs_packet_expire __user *pkt_p)
 459 {
 460         struct autofs_packet_expire pkt;
 461         struct autofs_info *ino;
 462         struct dentry *dentry;
 463         int ret = 0;
 464
 465         memset(&pkt,0,sizeof pkt);
 466
 467         pkt.hdr.proto_version = sbi->version;
 468         pkt.hdr.type = autofs_ptype_expire;
 469
 470         if ((dentry = autofs4_expire_indirect(sb, mnt, sbi, 0)) == NULL)
 471                 return -EAGAIN;
 472
 473         pkt.len = dentry->d_name.len;
 474         memcpy(pkt.name, dentry->d_name.name, pkt.len);
 475         pkt.name[pkt.len] = '\0';
 476         dput(dentry);
 477
 478         if ( copy_to_user(pkt_p, &pkt, sizeof(struct autofs_packet_expire)) )
 479                 ret = -EFAULT;
 480
 481         spin_lock(&sbi->fs_lock);
 482         ino = autofs4_dentry_ino(dentry);
 483         ino->flags &= ~AUTOFS_INF_EXPIRING;
 484         if (!d_unhashed(dentry))
 485                 managed_dentry_clear_automount(dentry);
 486         complete_all(&ino->expire_complete);
 487         spin_unlock(&sbi->fs_lock);
 488
 489         return ret;
 490 }
 491
 492 int autofs4_do_expire_multi(struct super_block *sb, struct vfsmount *mnt,
 493                             struct autofs_sb_info *sbi, int when)
 494 {
 495         struct dentry *dentry;
 496         int ret = -EAGAIN;
 497
 498         if (autofs_type_trigger(sbi->type))
 499                 dentry = autofs4_expire_direct(sb, mnt, sbi, when);
 500         else
 501                 dentry = autofs4_expire_indirect(sb, mnt, sbi, when);
 502
 503         if (dentry) {
 504                 struct autofs_info *ino = autofs4_dentry_ino(dentry);
 505
 506                 /* This is synchronous because it makes the daemon a
 507                    little easier */
 508                 ret = autofs4_wait(sbi, dentry, NFY_EXPIRE);
 509
 510                 spin_lock(&sbi->fs_lock);
 511                 if (ino->flags & AUTOFS_INF_MOUNTPOINT) {
 512                         spin_lock(&sb->s_root->d_lock);
 513                         /*
 514                          * If we haven't been expired away, then reset
 515                          * mounted status.
 516                          */
 517                         if (mnt->mnt_parent != mnt)
 518                                 sb->s_root->d_flags |= DCACHE_MOUNTED;
 519                         spin_unlock(&sb->s_root->d_lock);
 520                         ino->flags &= ~AUTOFS_INF_MOUNTPOINT;
 521                 }
 522                 ino->flags &= ~AUTOFS_INF_EXPIRING;
 523                 if (ret)
 524                         managed_dentry_clear_automount(dentry);
 525                 complete_all(&ino->expire_complete);
 526                 spin_unlock(&sbi->fs_lock);
 527                 dput(dentry);
 528         }
 529
 530         return ret;
 531 }
 532
 533 /* Call repeatedly until it returns -EAGAIN, meaning there's nothing
 534    more to be done */
 535 int autofs4_expire_multi(struct super_block *sb, struct vfsmount *mnt,
 536                         struct autofs_sb_info *sbi, int __user *arg)
 537 {
 538         int do_now = 0;
 539
 540         if (arg && get_user(do_now, arg))
 541                 return -EFAULT;
 542
 543         return autofs4_do_expire_multi(sb, mnt, sbi, do_now);
 544 }
 545