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