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