nfs_fs.h revision 51d8fa6a109589d522c18a8e9bf3fb167a91b1bc
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 */ 72struct nfs_access_entry { 73 unsigned long jiffies; 74 struct rpc_cred * cred; 75 int mask; 76}; 77 78struct nfs4_state; 79struct 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 */ 97struct nfs_delegation; 98 99struct posix_acl; 100 101/* 102 * nfs fs inode data in memory 103 */ 104struct 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 204static 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 232static inline int nfs_caches_unstable(struct inode *inode) 233{ 234 return atomic_read(&NFS_I(inode)->data_updates) != 0; 235} 236 237static 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 248static inline void NFS_CACHEINV(struct inode *inode) 249{ 250 if (!nfs_caches_unstable(inode)) 251 nfs_mark_for_revalidate(inode); 252} 253 254static inline int nfs_server_capable(struct inode *inode, int cap) 255{ 256 return NFS_SERVER(inode)->caps & cap; 257} 258 259static 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 */ 270static 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 */ 282static 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 */ 291extern int nfs_sync_mapping(struct address_space *mapping); 292extern void nfs_zap_caches(struct inode *); 293extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *, 294 struct nfs_fattr *); 295extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *); 296extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr); 297extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *); 298extern int nfs_permission(struct inode *, int, struct nameidata *); 299extern int nfs_access_get_cached(struct inode *, struct rpc_cred *, struct nfs_access_entry *); 300extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *); 301extern int nfs_open(struct inode *, struct file *); 302extern int nfs_release(struct inode *, struct file *); 303extern int nfs_attribute_timeout(struct inode *inode); 304extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode); 305extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *); 306extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping); 307extern int nfs_setattr(struct dentry *, struct iattr *); 308extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr); 309extern void nfs_begin_attr_update(struct inode *); 310extern void nfs_end_attr_update(struct inode *); 311extern void nfs_begin_data_update(struct inode *); 312extern void nfs_end_data_update(struct inode *); 313extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx); 314extern void put_nfs_open_context(struct nfs_open_context *ctx); 315extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode); 316extern 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. */ 322extern u32 root_nfs_parse_addr(char *name); /*__init*/ 323 324static 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 */ 333extern struct inode_operations nfs_file_inode_operations; 334#ifdef CONFIG_NFS_V3 335extern struct inode_operations nfs3_file_inode_operations; 336#endif /* CONFIG_NFS_V3 */ 337extern const struct file_operations nfs_file_operations; 338extern struct address_space_operations nfs_file_aops; 339 340static 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 355extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t); 356extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t); 357extern int nfs3_setxattr(struct dentry *, const char *, 358 const void *, size_t, int); 359extern 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 */ 370extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t, 371 unsigned long); 372extern ssize_t nfs_file_direct_read(struct kiocb *iocb, char __user *buf, 373 size_t count, loff_t pos); 374extern 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 */ 380extern struct inode_operations nfs_dir_inode_operations; 381#ifdef CONFIG_NFS_V3 382extern struct inode_operations nfs3_dir_inode_operations; 383#endif /* CONFIG_NFS_V3 */ 384extern const struct file_operations nfs_dir_operations; 385extern struct dentry_operations nfs_dentry_operations; 386 387extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr); 388 389/* 390 * linux/fs/nfs/symlink.c 391 */ 392extern struct inode_operations nfs_symlink_inode_operations; 393 394/* 395 * linux/fs/nfs/sysctl.c 396 */ 397#ifdef CONFIG_SYSCTL 398extern int nfs_register_sysctl(void); 399extern 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 */ 408extern struct list_head nfs_automount_list; 409extern struct inode_operations nfs_mountpoint_inode_operations; 410extern int nfs_mountpoint_expiry_timeout; 411extern void nfs_release_automount_timer(void); 412 413/* 414 * linux/fs/nfs/unlink.c 415 */ 416extern int nfs_async_unlink(struct dentry *); 417extern void nfs_complete_unlink(struct dentry *); 418 419/* 420 * linux/fs/nfs/write.c 421 */ 422extern int nfs_writepage(struct page *page, struct writeback_control *wbc); 423extern int nfs_writepages(struct address_space *, struct writeback_control *); 424extern int nfs_flush_incompatible(struct file *file, struct page *page); 425extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int); 426extern int nfs_writeback_done(struct rpc_task *, struct nfs_write_data *); 427extern void nfs_writedata_release(void *); 428 429#if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4) 430struct nfs_write_data *nfs_commit_alloc(unsigned int pagecount); 431void nfs_commit_free(struct nfs_write_data *p); 432#endif 433 434/* 435 * Try to write back everything synchronously (but check the 436 * return value!) 437 */ 438extern int nfs_sync_inode_wait(struct inode *, unsigned long, unsigned int, int); 439#if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4) 440extern int nfs_commit_inode(struct inode *, int); 441extern void nfs_commit_release(void *wdata); 442#else 443static inline int 444nfs_commit_inode(struct inode *inode, int how) 445{ 446 return 0; 447} 448#endif 449 450static inline int 451nfs_have_writebacks(struct inode *inode) 452{ 453 return NFS_I(inode)->npages != 0; 454} 455 456static inline int 457nfs_wb_all(struct inode *inode) 458{ 459 int error = nfs_sync_inode_wait(inode, 0, 0, 0); 460 return (error < 0) ? error : 0; 461} 462 463/* 464 * Write back all requests on one page - we do this before reading it. 465 */ 466static inline int nfs_wb_page_priority(struct inode *inode, struct page* page, int how) 467{ 468 int error = nfs_sync_inode_wait(inode, page->index, 1, 469 how | FLUSH_STABLE); 470 return (error < 0) ? error : 0; 471} 472 473static inline int nfs_wb_page(struct inode *inode, struct page* page) 474{ 475 return nfs_wb_page_priority(inode, page, 0); 476} 477 478/* 479 * Allocate and free nfs_write_data structures 480 */ 481extern struct nfs_write_data *nfs_writedata_alloc(unsigned int pagecount); 482extern void nfs_writedata_free(struct nfs_write_data *p); 483 484/* 485 * linux/fs/nfs/read.c 486 */ 487extern int nfs_readpage(struct file *, struct page *); 488extern int nfs_readpages(struct file *, struct address_space *, 489 struct list_head *, unsigned); 490extern int nfs_readpage_result(struct rpc_task *, struct nfs_read_data *); 491extern void nfs_readdata_release(void *data); 492 493/* 494 * Allocate and free nfs_read_data structures 495 */ 496extern struct nfs_read_data *nfs_readdata_alloc(unsigned int pagecount); 497extern void nfs_readdata_free(struct nfs_read_data *p); 498 499/* 500 * linux/fs/nfs3proc.c 501 */ 502#ifdef CONFIG_NFS_V3_ACL 503extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type); 504extern int nfs3_proc_setacl(struct inode *inode, int type, 505 struct posix_acl *acl); 506extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode, 507 mode_t mode); 508extern void nfs3_forget_cached_acls(struct inode *inode); 509#else 510static inline int nfs3_proc_set_default_acl(struct inode *dir, 511 struct inode *inode, 512 mode_t mode) 513{ 514 return 0; 515} 516 517static inline void nfs3_forget_cached_acls(struct inode *inode) 518{ 519} 520#endif /* CONFIG_NFS_V3_ACL */ 521 522/* 523 * linux/fs/mount_clnt.c 524 * (Used only by nfsroot module) 525 */ 526extern int nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *, 527 int, int); 528 529/* 530 * inline functions 531 */ 532 533static inline loff_t 534nfs_size_to_loff_t(__u64 size) 535{ 536 loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1; 537 if (size > maxsz) 538 return maxsz; 539 return (loff_t) size; 540} 541 542static inline ino_t 543nfs_fileid_to_ino_t(u64 fileid) 544{ 545 ino_t ino = (ino_t) fileid; 546 if (sizeof(ino_t) < sizeof(u64)) 547 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8; 548 return ino; 549} 550 551/* NFS root */ 552 553extern void * nfs_root_data(void); 554 555#define nfs_wait_event(clnt, wq, condition) \ 556({ \ 557 int __retval = 0; \ 558 if (clnt->cl_intr) { \ 559 sigset_t oldmask; \ 560 rpc_clnt_sigmask(clnt, &oldmask); \ 561 __retval = wait_event_interruptible(wq, condition); \ 562 rpc_clnt_sigunmask(clnt, &oldmask); \ 563 } else \ 564 wait_event(wq, condition); \ 565 __retval; \ 566}) 567 568#define NFS_JUKEBOX_RETRY_TIME (5 * HZ) 569 570#endif /* __KERNEL__ */ 571 572/* 573 * NFS debug flags 574 */ 575#define NFSDBG_VFS 0x0001 576#define NFSDBG_DIRCACHE 0x0002 577#define NFSDBG_LOOKUPCACHE 0x0004 578#define NFSDBG_PAGECACHE 0x0008 579#define NFSDBG_PROC 0x0010 580#define NFSDBG_XDR 0x0020 581#define NFSDBG_FILE 0x0040 582#define NFSDBG_ROOT 0x0080 583#define NFSDBG_CALLBACK 0x0100 584#define NFSDBG_ALL 0xFFFF 585 586#ifdef __KERNEL__ 587# undef ifdebug 588# ifdef NFS_DEBUG 589# define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac)) 590# else 591# define ifdebug(fac) if (0) 592# endif 593#endif /* __KERNEL */ 594 595#endif 596