fs/exportfs/expfs.c

   1 /*
   2  * Copyright (C) Neil Brown 2002
   3  * Copyright (C) Christoph Hellwig 2007
   4  *
   5  * This file contains the code mapping from inodes to NFS file handles,
   6  * and for mapping back from file handles to dentries.
   7  *
   8  * For details on why we do all the strange and hairy things in here
   9  * take a look at Documentation/filesystems/nfs/Exporting.
  10  */
  11 #include <linux/exportfs.h>
  12 #include <linux/fs.h>
  13 #include <linux/file.h>
  14 #include <linux/module.h>
  15 #include <linux/mount.h>
  16 #include <linux/namei.h>
  17 #include <linux/sched.h>
  18
  19 #define dprintk(fmt, args...) do{}while(0)
  20
  21
  22 static int get_name(const struct path *path, char *name, struct dentry *child);
  23
  24
  25 static int exportfs_get_name(struct vfsmount *mnt, struct dentry *dir,
  26                 char *name, struct dentry *child)
  27 {
  28         const struct export_operations *nop = dir->d_sb->s_export_op;
  29         struct path path = {.mnt = mnt, .dentry = dir};
  30
  31         if (nop->get_name)
  32                 return nop->get_name(dir, name, child);
  33         else
  34                 return get_name(&path, name, child);
  35 }
  36
  37 /*
  38  * Check if the dentry or any of it's aliases is acceptable.
  39  */
  40 static struct dentry *
  41 find_acceptable_alias(struct dentry *result,
  42                 int (*acceptable)(void *context, struct dentry *dentry),
  43                 void *context)
  44 {
  45         struct dentry *dentry, *toput = NULL;
  46         struct inode *inode;
  47
  48         if (acceptable(context, result))
  49                 return result;
  50
  51         inode = result->d_inode;
  52         spin_lock(&inode->i_lock);
  53         hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
  54                 dget(dentry);
  55                 spin_unlock(&inode->i_lock);
  56                 if (toput)
  57                         dput(toput);
  58                 if (dentry != result && acceptable(context, dentry)) {
  59                         dput(result);
  60                         return dentry;
  61                 }
  62                 spin_lock(&inode->i_lock);
  63                 toput = dentry;
  64         }
  65         spin_unlock(&inode->i_lock);
  66
  67         if (toput)
  68                 dput(toput);
  69         return NULL;
  70 }
  71
  72 static bool dentry_connected(struct dentry *dentry)
  73 {
  74         dget(dentry);
  75         while (dentry->d_flags & DCACHE_DISCONNECTED) {
  76                 struct dentry *parent = dget_parent(dentry);
  77
  78                 dput(dentry);
  79                 if (dentry == parent) {
  80                         dput(parent);
  81                         return false;
  82                 }
  83                 dentry = parent;
  84         }
  85         dput(dentry);
  86         return true;
  87 }
  88
  89 static void clear_disconnected(struct dentry *dentry)
  90 {
  91         dget(dentry);
  92         while (dentry->d_flags & DCACHE_DISCONNECTED) {
  93                 struct dentry *parent = dget_parent(dentry);
  94
  95                 WARN_ON_ONCE(IS_ROOT(dentry));
  96
  97                 spin_lock(&dentry->d_lock);
  98                 dentry->d_flags &= ~DCACHE_DISCONNECTED;
  99                 spin_unlock(&dentry->d_lock);
 100
 101                 dput(dentry);
 102                 dentry = parent;
 103         }
 104         dput(dentry);
 105 }
 106
 107 /*
 108  * Reconnect a directory dentry with its parent.
 109  *
 110  * This can return a dentry, or NULL, or an error.
 111  *
 112  * In the first case the returned dentry is the parent of the given
 113  * dentry, and may itself need to be reconnected to its parent.
 114  *
 115  * In the NULL case, a concurrent VFS operation has either renamed or
 116  * removed this directory.  The concurrent operation has reconnected our
 117  * dentry, so we no longer need to.
 118  */
 119 static struct dentry *reconnect_one(struct vfsmount *mnt,
 120                 struct dentry *dentry, char *nbuf)
 121 {
 122         struct dentry *parent;
 123         struct dentry *tmp;
 124         int err;
 125
 126         parent = ERR_PTR(-EACCES);
 127         inode_lock(dentry->d_inode);
 128         if (mnt->mnt_sb->s_export_op->get_parent)
 129                 parent = mnt->mnt_sb->s_export_op->get_parent(dentry);
 130         inode_unlock(dentry->d_inode);
 131
 132         if (IS_ERR(parent)) {
 133                 dprintk("%s: get_parent of %ld failed, err %d\n",
 134                         __func__, dentry->d_inode->i_ino, PTR_ERR(parent));
 135                 return parent;
 136         }
 137
 138         dprintk("%s: find name of %lu in %lu\n", __func__,
 139                 dentry->d_inode->i_ino, parent->d_inode->i_ino);
 140         err = exportfs_get_name(mnt, parent, nbuf, dentry);
 141         if (err == -ENOENT)
 142                 goto out_reconnected;
 143         if (err)
 144                 goto out_err;
 145         dprintk("%s: found name: %s\n", __func__, nbuf);
 146         tmp = lookup_one_len_unlocked(nbuf, parent, strlen(nbuf));
 147         if (IS_ERR(tmp)) {
 148                 dprintk("%s: lookup failed: %d\n", __func__, PTR_ERR(tmp));
 149                 err = PTR_ERR(tmp);
 150                 goto out_err;
 151         }
 152         if (tmp != dentry) {
 153                 /*
 154                  * Somebody has renamed it since exportfs_get_name();
 155                  * great, since it could've only been renamed if it
 156                  * got looked up and thus connected, and it would
 157                  * remain connected afterwards.  We are done.
 158                  */
 159                 dput(tmp);
 160                 goto out_reconnected;
 161         }
 162         dput(tmp);
 163         if (IS_ROOT(dentry)) {
 164                 err = -ESTALE;
 165                 goto out_err;
 166         }
 167         return parent;
 168
 169 out_err:
 170         dput(parent);
 171         return ERR_PTR(err);
 172 out_reconnected:
 173         dput(parent);
 174         /*
 175          * Someone must have renamed our entry into another parent, in
 176          * which case it has been reconnected by the rename.
 177          *
 178          * Or someone removed it entirely, in which case filehandle
 179          * lookup will succeed but the directory is now IS_DEAD and
 180          * subsequent operations on it will fail.
 181          *
 182          * Alternatively, maybe there was no race at all, and the
 183          * filesystem is just corrupt and gave us a parent that doesn't
 184          * actually contain any entry pointing to this inode.  So,
 185          * double check that this worked and return -ESTALE if not:
 186          */
 187         if (!dentry_connected(dentry))
 188                 return ERR_PTR(-ESTALE);
 189         return NULL;
 190 }
 191
 192 /*
 193  * Make sure target_dir is fully connected to the dentry tree.
 194  *
 195  * On successful return, DCACHE_DISCONNECTED will be cleared on
 196  * target_dir, and target_dir->d_parent->...->d_parent will reach the
 197  * root of the filesystem.
 198  *
 199  * Whenever DCACHE_DISCONNECTED is unset, target_dir is fully connected.
 200  * But the converse is not true: target_dir may have DCACHE_DISCONNECTED
 201  * set but already be connected.  In that case we'll verify the
 202  * connection to root and then clear the flag.
 203  *
 204  * Note that target_dir could be removed by a concurrent operation.  In
 205  * that case reconnect_path may still succeed with target_dir fully
 206  * connected, but further operations using the filehandle will fail when
 207  * necessary (due to S_DEAD being set on the directory).
 208  */
 209 static int
 210 reconnect_path(struct vfsmount *mnt, struct dentry *target_dir, char *nbuf)
 211 {
 212         struct dentry *dentry, *parent;
 213
 214         dentry = dget(target_dir);
 215
 216         while (dentry->d_flags & DCACHE_DISCONNECTED) {
 217                 BUG_ON(dentry == mnt->mnt_sb->s_root);
 218
 219                 if (IS_ROOT(dentry))
 220                         parent = reconnect_one(mnt, dentry, nbuf);
 221                 else
 222                         parent = dget_parent(dentry);
 223
 224                 if (!parent)
 225                         break;
 226                 dput(dentry);
 227                 if (IS_ERR(parent))
 228                         return PTR_ERR(parent);
 229                 dentry = parent;
 230         }
 231         dput(dentry);
 232         clear_disconnected(target_dir);
 233         return 0;
 234 }
 235
 236 struct getdents_callback {
 237         struct dir_context ctx;
 238         char *name;             /* name that was found. It already points to a
 239                                    buffer NAME_MAX+1 is size */
 240         u64 ino;                /* the inum we are looking for */
 241         int found;              /* inode matched? */
 242         int sequence;           /* sequence counter */
 243 };
 244
 245 /*
 246  * A rather strange filldir function to capture
 247  * the name matching the specified inode number.
 248  */
 249 static int filldir_one(struct dir_context *ctx, const char *name, int len,
 250                         loff_t pos, u64 ino, unsigned int d_type)
 251 {
 252         struct getdents_callback *buf =
 253                 container_of(ctx, struct getdents_callback, ctx);
 254         int result = 0;
 255
 256         buf->sequence++;
 257         if (buf->ino == ino && len <= NAME_MAX) {
 258                 memcpy(buf->name, name, len);
 259                 buf->name[len] = '\0';
 260                 buf->found = 1;
 261                 result = -1;
 262         }
 263         return result;
 264 }
 265
 266 /**
 267  * get_name - default export_operations->get_name function
 268  * @path:   the directory in which to find a name
 269  * @name:   a pointer to a %NAME_MAX+1 char buffer to store the name
 270  * @child:  the dentry for the child directory.
 271  *
 272  * calls readdir on the parent until it finds an entry with
 273  * the same inode number as the child, and returns that.
 274  */
 275 static int get_name(const struct path *path, char *name, struct dentry *child)
 276 {
 277         const struct cred *cred = current_cred();
 278         struct inode *dir = path->dentry->d_inode;
 279         int error;
 280         struct file *file;
 281         struct kstat stat;
 282         struct path child_path = {
 283                 .mnt = path->mnt,
 284                 .dentry = child,
 285         };
 286         struct getdents_callback buffer = {
 287                 .ctx.actor = filldir_one,
 288                 .name = name,
 289         };
 290
 291         error = -ENOTDIR;
 292         if (!dir || !S_ISDIR(dir->i_mode))
 293                 goto out;
 294         error = -EINVAL;
 295         if (!dir->i_fop)
 296                 goto out;
 297         /*
 298          * inode->i_ino is unsigned long, kstat->ino is u64, so the
 299          * former would be insufficient on 32-bit hosts when the
 300          * filesystem supports 64-bit inode numbers.  So we need to
 301          * actually call ->getattr, not just read i_ino:
 302          */
 303         error = vfs_getattr_nosec(&child_path, &stat);
 304         if (error)
 305                 return error;
 306         buffer.ino = stat.ino;
 307         /*
 308          * Open the directory ...
 309          */
 310         file = dentry_open(path, O_RDONLY, cred);
 311         error = PTR_ERR(file);
 312         if (IS_ERR(file))
 313                 goto out;
 314
 315         error = -EINVAL;
 316         if (!file->f_op->iterate && !file->f_op->iterate_shared)
 317                 goto out_close;
 318
 319         buffer.sequence = 0;
 320         while (1) {
 321                 int old_seq = buffer.sequence;
 322
 323                 error = iterate_dir(file, &buffer.ctx);
 324                 if (buffer.found) {
 325                         error = 0;
 326                         break;
 327                 }
 328
 329                 if (error < 0)
 330                         break;
 331
 332                 error = -ENOENT;
 333                 if (old_seq == buffer.sequence)
 334                         break;
 335         }
 336
 337 out_close:
 338         fput(file);
 339 out:
 340         return error;
 341 }
 342
 343 /**
 344  * export_encode_fh - default export_operations->encode_fh function
 345  * @inode:   the object to encode
 346  * @fid:     where to store the file handle fragment
 347  * @max_len: maximum length to store there
 348  * @parent:  parent directory inode, if wanted
 349  *
 350  * This default encode_fh function assumes that the 32 inode number
 351  * is suitable for locating an inode, and that the generation number
 352  * can be used to check that it is still valid.  It places them in the
 353  * filehandle fragment where export_decode_fh expects to find them.
 354  */
 355 static int export_encode_fh(struct inode *inode, struct fid *fid,
 356                 int *max_len, struct inode *parent)
 357 {
 358         int len = *max_len;
 359         int type = FILEID_INO32_GEN;
 360
 361         if (parent && (len < 4)) {
 362                 *max_len = 4;
 363                 return FILEID_INVALID;
 364         } else if (len < 2) {
 365                 *max_len = 2;
 366                 return FILEID_INVALID;
 367         }
 368
 369         len = 2;
 370         fid->i32.ino = inode->i_ino;
 371         fid->i32.gen = inode->i_generation;
 372         if (parent) {
 373                 fid->i32.parent_ino = parent->i_ino;
 374                 fid->i32.parent_gen = parent->i_generation;
 375                 len = 4;
 376                 type = FILEID_INO32_GEN_PARENT;
 377         }
 378         *max_len = len;
 379         return type;
 380 }
 381
 382 int exportfs_encode_inode_fh(struct inode *inode, struct fid *fid,
 383                              int *max_len, struct inode *parent)
 384 {
 385         const struct export_operations *nop = inode->i_sb->s_export_op;
 386
 387         if (nop && nop->encode_fh)
 388                 return nop->encode_fh(inode, fid->raw, max_len, parent);
 389
 390         return export_encode_fh(inode, fid, max_len, parent);
 391 }
 392 EXPORT_SYMBOL_GPL(exportfs_encode_inode_fh);
 393
 394 int exportfs_encode_fh(struct dentry *dentry, struct fid *fid, int *max_len,
 395                 int connectable)
 396 {
 397         int error;
 398         struct dentry *p = NULL;
 399         struct inode *inode = dentry->d_inode, *parent = NULL;
 400
 401         if (connectable && !S_ISDIR(inode->i_mode)) {
 402                 p = dget_parent(dentry);
 403                 /*
 404                  * note that while p might've ceased to be our parent already,
 405                  * it's still pinned by and still positive.
 406                  */
 407                 parent = p->d_inode;
 408         }
 409
 410         error = exportfs_encode_inode_fh(inode, fid, max_len, parent);
 411         dput(p);
 412
 413         return error;
 414 }
 415 EXPORT_SYMBOL_GPL(exportfs_encode_fh);
 416
 417 struct dentry *exportfs_decode_fh(struct vfsmount *mnt, struct fid *fid,
 418                 int fh_len, int fileid_type,
 419                 int (*acceptable)(void *, struct dentry *), void *context)
 420 {
 421         const struct export_operations *nop = mnt->mnt_sb->s_export_op;
 422         struct dentry *result, *alias;
 423         char nbuf[NAME_MAX+1];
 424         int err;
 425
 426         /*
 427          * Try to get any dentry for the given file handle from the filesystem.
 428          */
 429         if (!nop || !nop->fh_to_dentry)
 430                 return ERR_PTR(-ESTALE);
 431         result = nop->fh_to_dentry(mnt->mnt_sb, fid, fh_len, fileid_type);
 432         if (PTR_ERR(result) == -ENOMEM)
 433                 return ERR_CAST(result);
 434         if (IS_ERR_OR_NULL(result))
 435                 return ERR_PTR(-ESTALE);
 436
 437         if (d_is_dir(result)) {
 438                 /*
 439                  * This request is for a directory.
 440                  *
 441                  * On the positive side there is only one dentry for each
 442                  * directory inode.  On the negative side this implies that we
 443                  * to ensure our dentry is connected all the way up to the
 444                  * filesystem root.
 445                  */
 446                 if (result->d_flags & DCACHE_DISCONNECTED) {
 447                         err = reconnect_path(mnt, result, nbuf);
 448                         if (err)
 449                                 goto err_result;
 450                 }
 451
 452                 if (!acceptable(context, result)) {
 453                         err = -EACCES;
 454                         goto err_result;
 455                 }
 456
 457                 return result;
 458         } else {
 459                 /*
 460                  * It's not a directory.  Life is a little more complicated.
 461                  */
 462                 struct dentry *target_dir, *nresult;
 463
 464                 /*
 465                  * See if either the dentry we just got from the filesystem
 466                  * or any alias for it is acceptable.  This is always true
 467                  * if this filesystem is exported without the subtreecheck
 468                  * option.  If the filesystem is exported with the subtree
 469                  * check option there's a fair chance we need to look at
 470                  * the parent directory in the file handle and make sure
 471                  * it's connected to the filesystem root.
 472                  */
 473                 alias = find_acceptable_alias(result, acceptable, context);
 474                 if (alias)
 475                         return alias;
 476
 477                 /*
 478                  * Try to extract a dentry for the parent directory from the
 479                  * file handle.  If this fails we'll have to give up.
 480                  */
 481                 err = -ESTALE;
 482                 if (!nop->fh_to_parent)
 483                         goto err_result;
 484
 485                 target_dir = nop->fh_to_parent(mnt->mnt_sb, fid,
 486                                 fh_len, fileid_type);
 487                 if (!target_dir)
 488                         goto err_result;
 489                 err = PTR_ERR(target_dir);
 490                 if (IS_ERR(target_dir))
 491                         goto err_result;
 492
 493                 /*
 494                  * And as usual we need to make sure the parent directory is
 495                  * connected to the filesystem root.  The VFS really doesn't
 496                  * like disconnected directories..
 497                  */
 498                 err = reconnect_path(mnt, target_dir, nbuf);
 499                 if (err) {
 500                         dput(target_dir);
 501                         goto err_result;
 502                 }
 503
 504                 /*
 505                  * Now that we've got both a well-connected parent and a
 506                  * dentry for the inode we're after, make sure that our
 507                  * inode is actually connected to the parent.
 508                  */
 509                 err = exportfs_get_name(mnt, target_dir, nbuf, result);
 510                 if (err) {
 511                         dput(target_dir);
 512                         goto err_result;
 513                 }
 514
 515                 inode_lock(target_dir->d_inode);
 516                 nresult = lookup_one_len(nbuf, target_dir, strlen(nbuf));
 517                 if (!IS_ERR(nresult)) {
 518                         if (unlikely(nresult->d_inode != result->d_inode)) {
 519                                 dput(nresult);
 520                                 nresult = ERR_PTR(-ESTALE);
 521                         }
 522                 }
 523                 inode_unlock(target_dir->d_inode);
 524                 /*
 525                  * At this point we are done with the parent, but it's pinned
 526                  * by the child dentry anyway.
 527                  */
 528                 dput(target_dir);
 529
 530                 if (IS_ERR(nresult)) {
 531                         err = PTR_ERR(nresult);
 532                         goto err_result;
 533                 }
 534                 dput(result);
 535                 result = nresult;
 536
 537                 /*
 538                  * And finally make sure the dentry is actually acceptable
 539                  * to NFSD.
 540                  */
 541                 alias = find_acceptable_alias(result, acceptable, context);
 542                 if (!alias) {
 543                         err = -EACCES;
 544                         goto err_result;
 545                 }
 546
 547                 return alias;
 548         }
 549
 550  err_result:
 551         dput(result);
 552         if (err != -ENOMEM)
 553                 err = -ESTALE;
 554         return ERR_PTR(err);
 555 }
 556 EXPORT_SYMBOL_GPL(exportfs_decode_fh);
 557
 558 MODULE_LICENSE("GPL");