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