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