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