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