include/linux/nfs_fs.h

   1 /*
   2  *  linux/include/linux/nfs_fs.h
   3  *
   4  *  Copyright (C) 1992  Rick Sladkey
   5  *
   6  *  OS-specific nfs filesystem definitions and declarations
   7  */
   8
   9 #ifndef _LINUX_NFS_FS_H
  10 #define _LINUX_NFS_FS_H
  11
  12 #include <linux/config.h>
  13 #include <linux/in.h>
  14 #include <linux/mm.h>
  15 #include <linux/pagemap.h>
  16 #include <linux/rwsem.h>
  17 #include <linux/wait.h>
  18
  19 #include <linux/sunrpc/debug.h>
  20 #include <linux/sunrpc/auth.h>
  21 #include <linux/sunrpc/clnt.h>
  22
  23 #include <linux/nfs.h>
  24 #include <linux/nfs2.h>
  25 #include <linux/nfs3.h>
  26 #include <linux/nfs4.h>
  27 #include <linux/nfs_xdr.h>
  28
  29 #include <linux/nfs_fs_sb.h>
  30
  31 #include <linux/rwsem.h>
  32 #include <linux/mempool.h>
  33
  34 /*
  35  * Enable debugging support for nfs client.
  36  * Requires RPC_DEBUG.
  37  */
  38 #ifdef RPC_DEBUG
  39 # define NFS_DEBUG
  40 #endif
  41
  42 /* Default timeout values */
  43 #define NFS_MAX_UDP_TIMEOUT     (60*HZ)
  44 #define NFS_MAX_TCP_TIMEOUT     (600*HZ)
  45
  46 /*
  47  * superblock magic number for NFS
  48  */
  49 #define NFS_SUPER_MAGIC                 0x6969
  50
  51 /*
  52  * These are the default flags for swap requests
  53  */
  54 #define NFS_RPC_SWAPFLAGS               (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
  55
  56 /*
  57  * When flushing a cluster of dirty pages, there can be different
  58  * strategies:
  59  */
  60 #define FLUSH_SYNC              1       /* file being synced, or contention */
  61 #define FLUSH_STABLE            4       /* commit to stable storage */
  62 #define FLUSH_LOWPRI            8       /* low priority background flush */
  63 #define FLUSH_HIGHPRI           16      /* high priority memory reclaim flush */
  64 #define FLUSH_NOCOMMIT          32      /* Don't send the NFSv3/v4 COMMIT */
  65 #define FLUSH_INVALIDATE        64      /* Invalidate the page cache */
  66
  67 #ifdef __KERNEL__
  68
  69 /*
  70  * NFSv3/v4 Access mode cache entry
  71  */
  72 struct nfs_access_entry {
  73         unsigned long           jiffies;
  74         struct rpc_cred *       cred;
  75         int                     mask;
  76 };
  77
  78 struct nfs4_state;
  79 struct nfs_open_context {
  80         atomic_t count;
  81         struct vfsmount *vfsmnt;
  82         struct dentry *dentry;
  83         struct rpc_cred *cred;
  84         struct nfs4_state *state;
  85         fl_owner_t lockowner;
  86         int mode;
  87         int error;
  88
  89         struct list_head list;
  90
  91         __u64 dir_cookie;
  92 };
  93
  94 /*
  95  * NFSv4 delegation
  96  */
  97 struct nfs_delegation;
  98
  99 struct posix_acl;
 100
 101 /*
 102  * nfs fs inode data in memory
 103  */
 104 struct nfs_inode {
 105         /*
 106          * The 64bit 'inode number'
 107          */
 108         __u64 fileid;
 109
 110         /*
 111          * NFS file handle
 112          */
 113         struct nfs_fh           fh;
 114
 115         /*
 116          * Various flags
 117          */
 118         unsigned long           flags;                  /* atomic bit ops */
 119         unsigned long           cache_validity;         /* bit mask */
 120
 121         /*
 122          * read_cache_jiffies is when we started read-caching this inode.
 123          * attrtimeo is for how long the cached information is assumed
 124          * to be valid. A successful attribute revalidation doubles
 125          * attrtimeo (up to acregmax/acdirmax), a failure resets it to
 126          * acregmin/acdirmin.
 127          *
 128          * We need to revalidate the cached attrs for this inode if
 129          *
 130          *      jiffies - read_cache_jiffies > attrtimeo
 131          */
 132         unsigned long           read_cache_jiffies;
 133         unsigned long           attrtimeo;
 134         unsigned long           attrtimeo_timestamp;
 135         __u64                   change_attr;            /* v4 only */
 136
 137         unsigned long           last_updated;
 138         /* "Generation counter" for the attribute cache. This is
 139          * bumped whenever we update the metadata on the
 140          * server.
 141          */
 142         unsigned long           cache_change_attribute;
 143         /*
 144          * Counter indicating the number of outstanding requests that
 145          * will cause a file data update.
 146          */
 147         atomic_t                data_updates;
 148
 149         struct nfs_access_entry cache_access;
 150 #ifdef CONFIG_NFS_V3_ACL
 151         struct posix_acl        *acl_access;
 152         struct posix_acl        *acl_default;
 153 #endif
 154
 155         /*
 156          * This is the cookie verifier used for NFSv3 readdir
 157          * operations
 158          */
 159         __u32                   cookieverf[2];
 160
 161         /*
 162          * This is the list of dirty unwritten pages.
 163          */
 164         spinlock_t              req_lock;
 165         struct list_head        dirty;
 166         struct list_head        commit;
 167         struct radix_tree_root  nfs_page_tree;
 168
 169         unsigned int            ndirty,
 170                                 ncommit,
 171                                 npages;
 172
 173         /* Open contexts for shared mmap writes */
 174         struct list_head        open_files;
 175
 176 #ifdef CONFIG_NFS_V4
 177         struct nfs4_cached_acl  *nfs4_acl;
 178         /* NFSv4 state */
 179         struct list_head        open_states;
 180         struct nfs_delegation   *delegation;
 181         int                      delegation_state;
 182         struct rw_semaphore     rwsem;
 183 #endif /* CONFIG_NFS_V4*/
 184         struct inode            vfs_inode;
 185 };
 186
 187 /*
 188  * Cache validity bit flags
 189  */
 190 #define NFS_INO_INVALID_ATTR    0x0001          /* cached attrs are invalid */
 191 #define NFS_INO_INVALID_DATA    0x0002          /* cached data is invalid */
 192 #define NFS_INO_INVALID_ATIME   0x0004          /* cached atime is invalid */
 193 #define NFS_INO_INVALID_ACCESS  0x0008          /* cached access cred invalid */
 194 #define NFS_INO_INVALID_ACL     0x0010          /* cached acls are invalid */
 195 #define NFS_INO_REVAL_PAGECACHE 0x0020          /* must revalidate pagecache */
 196
 197 /*
 198  * Bit offsets in flags field
 199  */
 200 #define NFS_INO_REVALIDATING    (0)             /* revalidating attrs */
 201 #define NFS_INO_ADVISE_RDPLUS   (1)             /* advise readdirplus */
 202 #define NFS_INO_STALE           (2)             /* possible stale inode */
 203
 204 static inline struct nfs_inode *NFS_I(struct inode *inode)
 205 {
 206         return container_of(inode, struct nfs_inode, vfs_inode);
 207 }
 208 #define NFS_SB(s)               ((struct nfs_server *)(s->s_fs_info))
 209
 210 #define NFS_FH(inode)                   (&NFS_I(inode)->fh)
 211 #define NFS_SERVER(inode)               (NFS_SB(inode->i_sb))
 212 #define NFS_CLIENT(inode)               (NFS_SERVER(inode)->client)
 213 #define NFS_PROTO(inode)                (NFS_SERVER(inode)->rpc_ops)
 214 #define NFS_ADDR(inode)                 (RPC_PEERADDR(NFS_CLIENT(inode)))
 215 #define NFS_COOKIEVERF(inode)           (NFS_I(inode)->cookieverf)
 216 #define NFS_READTIME(inode)             (NFS_I(inode)->read_cache_jiffies)
 217 #define NFS_CHANGE_ATTR(inode)          (NFS_I(inode)->change_attr)
 218 #define NFS_ATTRTIMEO(inode)            (NFS_I(inode)->attrtimeo)
 219 #define NFS_MINATTRTIMEO(inode) \
 220         (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
 221                                : NFS_SERVER(inode)->acregmin)
 222 #define NFS_MAXATTRTIMEO(inode) \
 223         (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
 224                                : NFS_SERVER(inode)->acregmax)
 225 #define NFS_ATTRTIMEO_UPDATE(inode)     (NFS_I(inode)->attrtimeo_timestamp)
 226
 227 #define NFS_FLAGS(inode)                (NFS_I(inode)->flags)
 228 #define NFS_STALE(inode)                (test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
 229
 230 #define NFS_FILEID(inode)               (NFS_I(inode)->fileid)
 231
 232 static inline int nfs_caches_unstable(struct inode *inode)
 233 {
 234         return atomic_read(&NFS_I(inode)->data_updates) != 0;
 235 }
 236
 237 static inline void nfs_mark_for_revalidate(struct inode *inode)
 238 {
 239         struct nfs_inode *nfsi = NFS_I(inode);
 240
 241         spin_lock(&inode->i_lock);
 242         nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
 243         if (S_ISDIR(inode->i_mode))
 244                 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
 245         spin_unlock(&inode->i_lock);
 246 }
 247
 248 static inline void NFS_CACHEINV(struct inode *inode)
 249 {
 250         if (!nfs_caches_unstable(inode))
 251                 nfs_mark_for_revalidate(inode);
 252 }
 253
 254 static inline int nfs_server_capable(struct inode *inode, int cap)
 255 {
 256         return NFS_SERVER(inode)->caps & cap;
 257 }
 258
 259 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
 260 {
 261         return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
 262 }
 263
 264 /**
 265  * nfs_save_change_attribute - Returns the inode attribute change cookie
 266  * @inode - pointer to inode
 267  * The "change attribute" is updated every time we finish an operation
 268  * that will result in a metadata change on the server.
 269  */
 270 static inline long nfs_save_change_attribute(struct inode *inode)
 271 {
 272         return NFS_I(inode)->cache_change_attribute;
 273 }
 274
 275 /**
 276  * nfs_verify_change_attribute - Detects NFS inode cache updates
 277  * @inode - pointer to inode
 278  * @chattr - previously saved change attribute
 279  * Return "false" if metadata has been updated (or is in the process of
 280  * being updated) since the change attribute was saved.
 281  */
 282 static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
 283 {
 284         return !nfs_caches_unstable(inode)
 285                 && time_after_eq(chattr, NFS_I(inode)->cache_change_attribute);
 286 }
 287
 288 /*
 289  * linux/fs/nfs/inode.c
 290  */
 291 extern int nfs_sync_mapping(struct address_space *mapping);
 292 extern void nfs_zap_caches(struct inode *);
 293 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
 294                                 struct nfs_fattr *);
 295 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
 296 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
 297 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
 298 extern int nfs_permission(struct inode *, int, struct nameidata *);
 299 extern int nfs_access_get_cached(struct inode *, struct rpc_cred *, struct nfs_access_entry *);
 300 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
 301 extern int nfs_open(struct inode *, struct file *);
 302 extern int nfs_release(struct inode *, struct file *);
 303 extern int nfs_attribute_timeout(struct inode *inode);
 304 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
 305 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
 306 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
 307 extern int nfs_setattr(struct dentry *, struct iattr *);
 308 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
 309 extern void nfs_begin_attr_update(struct inode *);
 310 extern void nfs_end_attr_update(struct inode *);
 311 extern void nfs_begin_data_update(struct inode *);
 312 extern void nfs_end_data_update(struct inode *);
 313 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
 314 extern void put_nfs_open_context(struct nfs_open_context *ctx);
 315 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode);
 316 extern struct vfsmount *nfs_do_submount(const struct vfsmount *mnt_parent,
 317                                         const struct dentry *dentry,
 318                                         struct nfs_fh *fh,
 319                                         struct nfs_fattr *fattr);
 320
 321 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
 322 extern u32 root_nfs_parse_addr(char *name); /*__init*/
 323
 324 static inline void nfs_fattr_init(struct nfs_fattr *fattr)
 325 {
 326         fattr->valid = 0;
 327         fattr->time_start = jiffies;
 328 }
 329
 330 /*
 331  * linux/fs/nfs/file.c
 332  */
 333 extern struct inode_operations nfs_file_inode_operations;
 334 #ifdef CONFIG_NFS_V3
 335 extern struct inode_operations nfs3_file_inode_operations;
 336 #endif /* CONFIG_NFS_V3 */
 337 extern const struct file_operations nfs_file_operations;
 338 extern const struct address_space_operations nfs_file_aops;
 339
 340 static inline struct rpc_cred *nfs_file_cred(struct file *file)
 341 {
 342         if (file != NULL) {
 343                 struct nfs_open_context *ctx;
 344
 345                 ctx = (struct nfs_open_context*)file->private_data;
 346                 return ctx->cred;
 347         }
 348         return NULL;
 349 }
 350
 351 /*
 352  * linux/fs/nfs/xattr.c
 353  */
 354 #ifdef CONFIG_NFS_V3_ACL
 355 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
 356 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
 357 extern int nfs3_setxattr(struct dentry *, const char *,
 358                         const void *, size_t, int);
 359 extern int nfs3_removexattr (struct dentry *, const char *name);
 360 #else
 361 # define nfs3_listxattr NULL
 362 # define nfs3_getxattr NULL
 363 # define nfs3_setxattr NULL
 364 # define nfs3_removexattr NULL
 365 #endif
 366
 367 /*
 368  * linux/fs/nfs/direct.c
 369  */
 370 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
 371                         unsigned long);
 372 extern ssize_t nfs_file_direct_read(struct kiocb *iocb, char __user *buf,
 373                         size_t count, loff_t pos);
 374 extern ssize_t nfs_file_direct_write(struct kiocb *iocb, const char __user *buf,
 375                         size_t count, loff_t pos);
 376
 377 /*
 378  * linux/fs/nfs/dir.c
 379  */
 380 extern struct inode_operations nfs_dir_inode_operations;
 381 #ifdef CONFIG_NFS_V3
 382 extern struct inode_operations nfs3_dir_inode_operations;
 383 #endif /* CONFIG_NFS_V3 */
 384 extern const struct file_operations nfs_dir_operations;
 385 extern struct dentry_operations nfs_dentry_operations;
 386
 387 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
 388
 389 /*
 390  * linux/fs/nfs/symlink.c
 391  */
 392 extern struct inode_operations nfs_symlink_inode_operations;
 393
 394 /*
 395  * linux/fs/nfs/sysctl.c
 396  */
 397 #ifdef CONFIG_SYSCTL
 398 extern int nfs_register_sysctl(void);
 399 extern void nfs_unregister_sysctl(void);
 400 #else
 401 #define nfs_register_sysctl() 0
 402 #define nfs_unregister_sysctl() do { } while(0)
 403 #endif
 404
 405 /*
 406  * linux/fs/nfs/namespace.c
 407  */
 408 extern struct list_head nfs_automount_list;
 409 extern struct inode_operations nfs_mountpoint_inode_operations;
 410 extern struct inode_operations nfs_referral_inode_operations;
 411 extern int nfs_mountpoint_expiry_timeout;
 412 extern void nfs_release_automount_timer(void);
 413
 414 /*
 415  * linux/fs/nfs/unlink.c
 416  */
 417 extern int  nfs_async_unlink(struct dentry *);
 418 extern void nfs_complete_unlink(struct dentry *);
 419
 420 /*
 421  * linux/fs/nfs/write.c
 422  */
 423 extern int  nfs_writepage(struct page *page, struct writeback_control *wbc);
 424 extern int  nfs_writepages(struct address_space *, struct writeback_control *);
 425 extern int  nfs_flush_incompatible(struct file *file, struct page *page);
 426 extern int  nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
 427 extern int nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
 428 extern void nfs_writedata_release(void *);
 429
 430 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
 431 struct nfs_write_data *nfs_commit_alloc(unsigned int pagecount);
 432 void nfs_commit_free(struct nfs_write_data *p);
 433 #endif
 434
 435 /*
 436  * Try to write back everything synchronously (but check the
 437  * return value!)
 438  */
 439 extern int  nfs_sync_inode_wait(struct inode *, unsigned long, unsigned int, int);
 440 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
 441 extern int  nfs_commit_inode(struct inode *, int);
 442 extern void nfs_commit_release(void *wdata);
 443 #else
 444 static inline int
 445 nfs_commit_inode(struct inode *inode, int how)
 446 {
 447         return 0;
 448 }
 449 #endif
 450
 451 static inline int
 452 nfs_have_writebacks(struct inode *inode)
 453 {
 454         return NFS_I(inode)->npages != 0;
 455 }
 456
 457 static inline int
 458 nfs_wb_all(struct inode *inode)
 459 {
 460         int error = nfs_sync_inode_wait(inode, 0, 0, 0);
 461         return (error < 0) ? error : 0;
 462 }
 463
 464 /*
 465  * Write back all requests on one page - we do this before reading it.
 466  */
 467 static inline int nfs_wb_page_priority(struct inode *inode, struct page* page, int how)
 468 {
 469         int error = nfs_sync_inode_wait(inode, page->index, 1,
 470                         how | FLUSH_STABLE);
 471         return (error < 0) ? error : 0;
 472 }
 473
 474 static inline int nfs_wb_page(struct inode *inode, struct page* page)
 475 {
 476         return nfs_wb_page_priority(inode, page, 0);
 477 }
 478
 479 /*
 480  * Allocate and free nfs_write_data structures
 481  */
 482 extern struct nfs_write_data *nfs_writedata_alloc(unsigned int pagecount);
 483 extern void nfs_writedata_free(struct nfs_write_data *p);
 484
 485 /*
 486  * linux/fs/nfs/read.c
 487  */
 488 extern int  nfs_readpage(struct file *, struct page *);
 489 extern int  nfs_readpages(struct file *, struct address_space *,
 490                 struct list_head *, unsigned);
 491 extern int  nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
 492 extern void nfs_readdata_release(void *data);
 493
 494 /*
 495  * Allocate and free nfs_read_data structures
 496  */
 497 extern struct nfs_read_data *nfs_readdata_alloc(unsigned int pagecount);
 498 extern void nfs_readdata_free(struct nfs_read_data *p);
 499
 500 /*
 501  * linux/fs/nfs3proc.c
 502  */
 503 #ifdef CONFIG_NFS_V3_ACL
 504 extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
 505 extern int nfs3_proc_setacl(struct inode *inode, int type,
 506                             struct posix_acl *acl);
 507 extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
 508                 mode_t mode);
 509 extern void nfs3_forget_cached_acls(struct inode *inode);
 510 #else
 511 static inline int nfs3_proc_set_default_acl(struct inode *dir,
 512                                             struct inode *inode,
 513                                             mode_t mode)
 514 {
 515         return 0;
 516 }
 517
 518 static inline void nfs3_forget_cached_acls(struct inode *inode)
 519 {
 520 }
 521 #endif /* CONFIG_NFS_V3_ACL */
 522
 523 /*
 524  * linux/fs/mount_clnt.c
 525  * (Used only by nfsroot module)
 526  */
 527 extern int  nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
 528                 int, int);
 529
 530 /*
 531  * inline functions
 532  */
 533
 534 static inline loff_t
 535 nfs_size_to_loff_t(__u64 size)
 536 {
 537         loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
 538         if (size > maxsz)
 539                 return maxsz;
 540         return (loff_t) size;
 541 }
 542
 543 static inline ino_t
 544 nfs_fileid_to_ino_t(u64 fileid)
 545 {
 546         ino_t ino = (ino_t) fileid;
 547         if (sizeof(ino_t) < sizeof(u64))
 548                 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
 549         return ino;
 550 }
 551
 552 /* NFS root */
 553
 554 extern void * nfs_root_data(void);
 555
 556 #define nfs_wait_event(clnt, wq, condition)                             \
 557 ({                                                                      \
 558         int __retval = 0;                                               \
 559         if (clnt->cl_intr) {                                            \
 560                 sigset_t oldmask;                                       \
 561                 rpc_clnt_sigmask(clnt, &oldmask);                       \
 562                 __retval = wait_event_interruptible(wq, condition);     \
 563                 rpc_clnt_sigunmask(clnt, &oldmask);                     \
 564         } else                                                          \
 565                 wait_event(wq, condition);                              \
 566         __retval;                                                       \
 567 })
 568
 569 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
 570
 571 #endif /* __KERNEL__ */
 572
 573 /*
 574  * NFS debug flags
 575  */
 576 #define NFSDBG_VFS              0x0001
 577 #define NFSDBG_DIRCACHE         0x0002
 578 #define NFSDBG_LOOKUPCACHE      0x0004
 579 #define NFSDBG_PAGECACHE        0x0008
 580 #define NFSDBG_PROC             0x0010
 581 #define NFSDBG_XDR              0x0020
 582 #define NFSDBG_FILE             0x0040
 583 #define NFSDBG_ROOT             0x0080
 584 #define NFSDBG_CALLBACK         0x0100
 585 #define NFSDBG_ALL              0xFFFF
 586
 587 #ifdef __KERNEL__
 588 # undef ifdebug
 589 # ifdef NFS_DEBUG
 590 #  define ifdebug(fac)          if (unlikely(nfs_debug & NFSDBG_##fac))
 591 # else
 592 #  define ifdebug(fac)          if (0)
 593 # endif
 594 #endif /* __KERNEL */
 595
 596 #endif