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