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