SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/linux/nfsd/nfsfh.h

   1 /*
   2  * include/linux/nfsd/nfsfh.h
   3  *
   4  * This file describes the layout of the file handles as passed
   5  * over the wire.
   6  *
   7  * Earlier versions of knfsd used to sign file handles using keyed MD5
   8  * or SHA. I've removed this code, because it doesn't give you more
   9  * security than blocking external access to port 2049 on your firewall.
  10  *
  11  * Copyright (C) 1995, 1996, 1997 Olaf Kirch <okir@monad.swb.de>
  12  */
  13
  14 #ifndef _LINUX_NFSD_FH_H
  15 #define _LINUX_NFSD_FH_H
  16
  17 # include <linux/types.h>
  18 #ifdef __KERNEL__
  19 # include <linux/sunrpc/svc.h>
  20 #endif
  21 #include <linux/nfsd/const.h>
  22
  23 /*
  24  * This is the old "dentry style" Linux NFSv2 file handle.
  25  *
  26  * The xino and xdev fields are currently used to transport the
  27  * ino/dev of the exported inode.
  28  */
  29 struct nfs_fhbase_old {
  30         __u32           fb_dcookie;     /* dentry cookie - always 0xfeebbaca */
  31         __u32           fb_ino;         /* our inode number */
  32         __u32           fb_dirino;      /* dir inode number, 0 for directories */
  33         __u32           fb_dev;         /* our device */
  34         __u32           fb_xdev;
  35         __u32           fb_xino;
  36         __u32           fb_generation;
  37 };
  38
  39 /*
  40  * This is the new flexible, extensible style NFSv2/v3 file handle.
  41  * by Neil Brown <neilb@cse.unsw.edu.au> - March 2000
  42  *
  43  * The file handle is seens as a list of 4byte words.
  44  * The first word contains a version number (1) and four descriptor bytes
  45  * that tell how the remaining 3 variable length fields should be handled.
  46  * These three bytes are auth_type, fsid_type and fileid_type.
  47  *
  48  * All 4byte values are in host-byte-order.
  49  *
  50  * The auth_type field specifies how the filehandle can be authenticated
  51  * This might allow a file to be confirmed to be in a writable part of a
  52  * filetree without checking the path from it upto the root.
  53  * Current values:
  54  *     0  - No authentication.  fb_auth is 0 bytes long
  55  * Possible future values:
  56  *     1  - 4 bytes taken from MD5 hash of the remainer of the file handle
  57  *          prefixed by a secret and with the important export flags.
  58  *
  59  * The fsid_type identifies how the filesystem (or export point) is
  60  *    encoded.
  61  *  Current values:
  62  *     0  - 4 byte device id (ms-2-bytes major, ls-2-bytes minor), 4byte inode number
  63  *        NOTE: we cannot use the kdev_t device id value, because kdev_t.h
  64  *              says we mustn't.  We must break it up and reassemble.
  65  *     1  - 4 byte user specified identifier
  66  *     2  - 4 byte major, 4 byte minor, 4 byte inode number - DEPRECATED
  67  *     3  - 4 byte device id, encoded for user-space, 4 byte inode number
  68  *     4  - 4 byte inode number and 4 byte uuid
  69  *     5  - 8 byte uuid
  70  *     6  - 16 byte uuid
  71  *     7  - 8 byte inode number and 16 byte uuid
  72  *
  73  * The fileid_type identified how the file within the filesystem is encoded.
  74  * This is (will be) passed to, and set by, the underlying filesystem if it supports
  75  * filehandle operations.  The filesystem must not use the value '0' or '0xff' and may
  76  * only use the values 1 and 2 as defined below:
  77  *  Current values:
  78  *    0   - The root, or export point, of the filesystem.  fb_fileid is 0 bytes.
  79  *    1   - 32bit inode number, 32 bit generation number.
  80  *    2   - 32bit inode number, 32 bit generation number, 32 bit parent directory inode number.
  81  *
  82  */
  83 struct nfs_fhbase_new {
  84         __u8            fb_version;     /* == 1, even => nfs_fhbase_old */
  85         __u8            fb_auth_type;
  86         __u8            fb_fsid_type;
  87         __u8            fb_fileid_type;
  88         __u32           fb_auth[1];
  89 /*      __u32           fb_fsid[0]; floating */
  90 /*      __u32           fb_fileid[0]; floating */
  91 };
  92
  93 struct knfsd_fh {
  94         unsigned int    fh_size;        /* significant for NFSv3.
  95                                          * Points to the current size while building
  96                                          * a new file handle
  97                                          */
  98         union {
  99                 struct nfs_fhbase_old   fh_old;
 100                 __u32                   fh_pad[NFS4_FHSIZE/4];
 101                 struct nfs_fhbase_new   fh_new;
 102         } fh_base;
 103 };
 104
 105 #define ofh_dcookie             fh_base.fh_old.fb_dcookie
 106 #define ofh_ino                 fh_base.fh_old.fb_ino
 107 #define ofh_dirino              fh_base.fh_old.fb_dirino
 108 #define ofh_dev                 fh_base.fh_old.fb_dev
 109 #define ofh_xdev                fh_base.fh_old.fb_xdev
 110 #define ofh_xino                fh_base.fh_old.fb_xino
 111 #define ofh_generation          fh_base.fh_old.fb_generation
 112
 113 #define fh_version              fh_base.fh_new.fb_version
 114 #define fh_fsid_type            fh_base.fh_new.fb_fsid_type
 115 #define fh_auth_type            fh_base.fh_new.fb_auth_type
 116 #define fh_fileid_type          fh_base.fh_new.fb_fileid_type
 117 #define fh_auth                 fh_base.fh_new.fb_auth
 118 #define fh_fsid                 fh_base.fh_new.fb_auth
 119
 120 #ifdef __KERNEL__
 121
 122 static inline __u32 ino_t_to_u32(ino_t ino)
 123 {
 124         return (__u32) ino;
 125 }
 126
 127 static inline ino_t u32_to_ino_t(__u32 uino)
 128 {
 129         return (ino_t) uino;
 130 }
 131
 132 /*
 133  * This is the internal representation of an NFS handle used in knfsd.
 134  * pre_mtime/post_version will be used to support wcc_attr's in NFSv3.
 135  */
 136 typedef struct svc_fh {
 137         struct knfsd_fh         fh_handle;      /* FH data */
 138         struct dentry *         fh_dentry;      /* validated dentry */
 139         struct svc_export *     fh_export;      /* export pointer */
 140         int                     fh_maxsize;     /* max size for fh_handle */
 141
 142         unsigned char           fh_locked;      /* inode locked by us */
 143
 144 #ifdef CONFIG_NFSD_V3
 145         unsigned char           fh_post_saved;  /* post-op attrs saved */
 146         unsigned char           fh_pre_saved;   /* pre-op attrs saved */
 147
 148         /* Pre-op attributes saved during fh_lock */
 149         __u64                   fh_pre_size;    /* size before operation */
 150         struct timespec         fh_pre_mtime;   /* mtime before oper */
 151         struct timespec         fh_pre_ctime;   /* ctime before oper */
 152         /*
 153          * pre-op nfsv4 change attr: note must check IS_I_VERSION(inode)
 154          *  to find out if it is valid.
 155          */
 156         u64                     fh_pre_change;
 157
 158         /* Post-op attributes saved in fh_unlock */
 159         struct kstat            fh_post_attr;   /* full attrs after operation */
 160         u64                     fh_post_change; /* nfsv4 change; see above */
 161 #endif /* CONFIG_NFSD_V3 */
 162
 163 } svc_fh;
 164
 165 enum nfsd_fsid {
 166         FSID_DEV = 0,
 167         FSID_NUM,
 168         FSID_MAJOR_MINOR,
 169         FSID_ENCODE_DEV,
 170         FSID_UUID4_INUM,
 171         FSID_UUID8,
 172         FSID_UUID16,
 173         FSID_UUID16_INUM,
 174 };
 175
 176 enum fsid_source {
 177         FSIDSOURCE_DEV,
 178         FSIDSOURCE_FSID,
 179         FSIDSOURCE_UUID,
 180 };
 181 extern enum fsid_source fsid_source(struct svc_fh *fhp);
 182
 183
 184 /* This might look a little large to "inline" but in all calls except
 185  * one, 'vers' is constant so moste of the function disappears.
 186  */
 187 static inline void mk_fsid(int vers, u32 *fsidv, dev_t dev, ino_t ino,
 188                            u32 fsid, unsigned char *uuid)
 189 {
 190         u32 *up;
 191         switch(vers) {
 192         case FSID_DEV:
 193                 fsidv[0] = htonl((MAJOR(dev)<<16) |
 194                                  MINOR(dev));
 195                 fsidv[1] = ino_t_to_u32(ino);
 196                 break;
 197         case FSID_NUM:
 198                 fsidv[0] = fsid;
 199                 break;
 200         case FSID_MAJOR_MINOR:
 201                 fsidv[0] = htonl(MAJOR(dev));
 202                 fsidv[1] = htonl(MINOR(dev));
 203                 fsidv[2] = ino_t_to_u32(ino);
 204                 break;
 205
 206         case FSID_ENCODE_DEV:
 207                 fsidv[0] = new_encode_dev(dev);
 208                 fsidv[1] = ino_t_to_u32(ino);
 209                 break;
 210
 211         case FSID_UUID4_INUM:
 212                 /* 4 byte fsid and inode number */
 213                 up = (u32*)uuid;
 214                 fsidv[0] = ino_t_to_u32(ino);
 215                 fsidv[1] = up[0] ^ up[1] ^ up[2] ^ up[3];
 216                 break;
 217
 218         case FSID_UUID8:
 219                 /* 8 byte fsid  */
 220                 up = (u32*)uuid;
 221                 fsidv[0] = up[0] ^ up[2];
 222                 fsidv[1] = up[1] ^ up[3];
 223                 break;
 224
 225         case FSID_UUID16:
 226                 /* 16 byte fsid - NFSv3+ only */
 227                 memcpy(fsidv, uuid, 16);
 228                 break;
 229
 230         case FSID_UUID16_INUM:
 231                 /* 8 byte inode and 16 byte fsid */
 232                 *(u64*)fsidv = (u64)ino;
 233                 memcpy(fsidv+2, uuid, 16);
 234                 break;
 235         default: BUG();
 236         }
 237 }
 238
 239 static inline int key_len(int type)
 240 {
 241         switch(type) {
 242         case FSID_DEV:          return 8;
 243         case FSID_NUM:          return 4;
 244         case FSID_MAJOR_MINOR:  return 12;
 245         case FSID_ENCODE_DEV:   return 8;
 246         case FSID_UUID4_INUM:   return 8;
 247         case FSID_UUID8:        return 8;
 248         case FSID_UUID16:       return 16;
 249         case FSID_UUID16_INUM:  return 24;
 250         default: return 0;
 251         }
 252 }
 253
 254 /*
 255  * Shorthand for dprintk()'s
 256  */
 257 extern char * SVCFH_fmt(struct svc_fh *fhp);
 258
 259 /*
 260  * Function prototypes
 261  */
 262 __be32  fh_verify(struct svc_rqst *, struct svc_fh *, int, int);
 263 __be32  fh_compose(struct svc_fh *, struct svc_export *, struct dentry *, struct svc_fh *);
 264 __be32  fh_update(struct svc_fh *);
 265 void    fh_put(struct svc_fh *);
 266
 267 static __inline__ struct svc_fh *
 268 fh_copy(struct svc_fh *dst, struct svc_fh *src)
 269 {
 270         WARN_ON(src->fh_dentry || src->fh_locked);
 271
 272         *dst = *src;
 273         return dst;
 274 }
 275
 276 static inline void
 277 fh_copy_shallow(struct knfsd_fh *dst, struct knfsd_fh *src)
 278 {
 279         dst->fh_size = src->fh_size;
 280         memcpy(&dst->fh_base, &src->fh_base, src->fh_size);
 281 }
 282
 283 static __inline__ struct svc_fh *
 284 fh_init(struct svc_fh *fhp, int maxsize)
 285 {
 286         memset(fhp, 0, sizeof(*fhp));
 287         fhp->fh_maxsize = maxsize;
 288         return fhp;
 289 }
 290
 291 #ifdef CONFIG_NFSD_V3
 292 /*
 293  * Fill in the pre_op attr for the wcc data
 294  */
 295 static inline void
 296 fill_pre_wcc(struct svc_fh *fhp)
 297 {
 298         struct inode    *inode;
 299
 300         inode = fhp->fh_dentry->d_inode;
 301         if (!fhp->fh_pre_saved) {
 302                 fhp->fh_pre_mtime = inode->i_mtime;
 303                 fhp->fh_pre_ctime = inode->i_ctime;
 304                 fhp->fh_pre_size  = inode->i_size;
 305                 fhp->fh_pre_change = inode->i_version;
 306                 fhp->fh_pre_saved = 1;
 307         }
 308 }
 309
 310 extern void fill_post_wcc(struct svc_fh *);
 311 #else
 312 #define fill_pre_wcc(ignored)
 313 #define fill_post_wcc(notused)
 314 #endif /* CONFIG_NFSD_V3 */
 315
 316
 317 /*
 318  * Lock a file handle/inode
 319  * NOTE: both fh_lock and fh_unlock are done "by hand" in
 320  * vfs.c:nfsd_rename as it needs to grab 2 i_mutex's at once
 321  * so, any changes here should be reflected there.
 322  */
 323
 324 static inline void
 325 fh_lock_nested(struct svc_fh *fhp, unsigned int subclass)
 326 {
 327         struct dentry   *dentry = fhp->fh_dentry;
 328         struct inode    *inode;
 329
 330         BUG_ON(!dentry);
 331
 332         if (fhp->fh_locked) {
 333                 printk(KERN_WARNING "fh_lock: %s/%s already locked!\n",
 334                         dentry->d_parent->d_name.name, dentry->d_name.name);
 335                 return;
 336         }
 337
 338         inode = dentry->d_inode;
 339         mutex_lock_nested(&inode->i_mutex, subclass);
 340         fill_pre_wcc(fhp);
 341         fhp->fh_locked = 1;
 342 }
 343
 344 static inline void
 345 fh_lock(struct svc_fh *fhp)
 346 {
 347         fh_lock_nested(fhp, I_MUTEX_NORMAL);
 348 }
 349
 350 /*
 351  * Unlock a file handle/inode
 352  */
 353 static inline void
 354 fh_unlock(struct svc_fh *fhp)
 355 {
 356         BUG_ON(!fhp->fh_dentry);
 357
 358         if (fhp->fh_locked) {
 359                 fill_post_wcc(fhp);
 360                 mutex_unlock(&fhp->fh_dentry->d_inode->i_mutex);
 361                 fhp->fh_locked = 0;
 362         }
 363 }
 364 #endif /* __KERNEL__ */
 365
 366
 367 #endif /* _LINUX_NFSD_FH_H */