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         struct rb_root          access_cache;
 141         struct list_head        access_cache_entry_lru;
 142         struct list_head        access_cache_inode_lru;
 143 #ifdef CONFIG_NFS_V3_ACL
 144         struct posix_acl        *acl_access;
 145         struct posix_acl        *acl_default;
 146 #endif
 147
 148         /*
 149          * This is the cookie verifier used for NFSv3 readdir
 150          * operations
 151          */
 152         __be32                  cookieverf[2];
 153
 154         /*
 155          * This is the list of dirty unwritten pages.
 156          */
 157         struct radix_tree_root  nfs_page_tree;
 158
 159         unsigned long           ncommit,
 160                                 npages;
 161
 162         /* Open contexts for shared mmap writes */
 163         struct list_head        open_files;
 164
 165 #ifdef CONFIG_NFS_V4
 166         struct nfs4_cached_acl  *nfs4_acl;
 167         /* NFSv4 state */
 168         struct list_head        open_states;
 169         struct nfs_delegation   *delegation;
 170         int                      delegation_state;
 171         struct rw_semaphore     rwsem;
 172 #endif /* CONFIG_NFS_V4*/
 173         struct inode            vfs_inode;
 174 };
 175
 176 /*
 177  * Cache validity bit flags
 178  */
 179 #define NFS_INO_INVALID_ATTR    0x0001          /* cached attrs are invalid */
 180 #define NFS_INO_INVALID_DATA    0x0002          /* cached data is invalid */
 181 #define NFS_INO_INVALID_ATIME   0x0004          /* cached atime is invalid */
 182 #define NFS_INO_INVALID_ACCESS  0x0008          /* cached access cred invalid */
 183 #define NFS_INO_INVALID_ACL     0x0010          /* cached acls are invalid */
 184 #define NFS_INO_REVAL_PAGECACHE 0x0020          /* must revalidate pagecache */
 185 #define NFS_INO_REVAL_FORCED    0x0040          /* force revalidation ignoring a delegation */
 186
 187 /*
 188  * Bit offsets in flags field
 189  */
 190 #define NFS_INO_REVALIDATING    (0)             /* revalidating attrs */
 191 #define NFS_INO_ADVISE_RDPLUS   (1)             /* advise readdirplus */
 192 #define NFS_INO_STALE           (2)             /* possible stale inode */
 193 #define NFS_INO_ACL_LRU_SET     (3)             /* Inode is on the LRU list */
 194
 195 static inline struct nfs_inode *NFS_I(struct inode *inode)
 196 {
 197         return container_of(inode, struct nfs_inode, vfs_inode);
 198 }
 199 #define NFS_SB(s)               ((struct nfs_server *)(s->s_fs_info))
 200
 201 #define NFS_FH(inode)                   (&NFS_I(inode)->fh)
 202 #define NFS_SERVER(inode)               (NFS_SB(inode->i_sb))
 203 #define NFS_CLIENT(inode)               (NFS_SERVER(inode)->client)
 204 #define NFS_PROTO(inode)                (NFS_SERVER(inode)->nfs_client->rpc_ops)
 205 #define NFS_COOKIEVERF(inode)           (NFS_I(inode)->cookieverf)
 206 #define NFS_READTIME(inode)             (NFS_I(inode)->read_cache_jiffies)
 207 #define NFS_CHANGE_ATTR(inode)          (NFS_I(inode)->change_attr)
 208 #define NFS_ATTRTIMEO(inode)            (NFS_I(inode)->attrtimeo)
 209 #define NFS_MINATTRTIMEO(inode) \
 210         (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
 211                                : NFS_SERVER(inode)->acregmin)
 212 #define NFS_MAXATTRTIMEO(inode) \
 213         (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
 214                                : NFS_SERVER(inode)->acregmax)
 215 #define NFS_ATTRTIMEO_UPDATE(inode)     (NFS_I(inode)->attrtimeo_timestamp)
 216
 217 #define NFS_FLAGS(inode)                (NFS_I(inode)->flags)
 218 #define NFS_STALE(inode)                (test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
 219
 220 #define NFS_FILEID(inode)               (NFS_I(inode)->fileid)
 221
 222 static inline void nfs_mark_for_revalidate(struct inode *inode)
 223 {
 224         struct nfs_inode *nfsi = NFS_I(inode);
 225
 226         spin_lock(&inode->i_lock);
 227         nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
 228         if (S_ISDIR(inode->i_mode))
 229                 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
 230         spin_unlock(&inode->i_lock);
 231 }
 232
 233 static inline int nfs_server_capable(struct inode *inode, int cap)
 234 {
 235         return NFS_SERVER(inode)->caps & cap;
 236 }
 237
 238 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
 239 {
 240         return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
 241 }
 242
 243 static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
 244 {
 245         dentry->d_time = verf;
 246 }
 247
 248 /**
 249  * nfs_save_change_attribute - Returns the inode attribute change cookie
 250  * @dir - pointer to parent directory inode
 251  * The "change attribute" is updated every time we finish an operation
 252  * that will result in a metadata change on the server.
 253  */
 254 static inline unsigned long nfs_save_change_attribute(struct inode *dir)
 255 {
 256         return NFS_I(dir)->cache_change_attribute;
 257 }
 258
 259 /**
 260  * nfs_verify_change_attribute - Detects NFS remote directory changes
 261  * @dir - pointer to parent directory inode
 262  * @chattr - previously saved change attribute
 263  * Return "false" if the verifiers doesn't match the change attribute.
 264  * This would usually indicate that the directory contents have changed on
 265  * the server, and that any dentries need revalidating.
 266  */
 267 static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
 268 {
 269         return chattr == NFS_I(dir)->cache_change_attribute;
 270 }
 271
 272 /*
 273  * linux/fs/nfs/inode.c
 274  */
 275 extern int nfs_sync_mapping(struct address_space *mapping);
 276 extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
 277 extern void nfs_zap_caches(struct inode *);
 278 extern void nfs_invalidate_atime(struct inode *);
 279 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
 280                                 struct nfs_fattr *);
 281 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
 282 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
 283 extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
 284 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
 285 extern int nfs_permission(struct inode *, int, struct nameidata *);
 286 extern int nfs_open(struct inode *, struct file *);
 287 extern int nfs_release(struct inode *, struct file *);
 288 extern int nfs_attribute_timeout(struct inode *inode);
 289 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
 290 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
 291 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
 292 extern int nfs_revalidate_mapping_nolock(struct inode *inode, struct address_space *mapping);
 293 extern int nfs_setattr(struct dentry *, struct iattr *);
 294 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
 295 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
 296 extern void put_nfs_open_context(struct nfs_open_context *ctx);
 297 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode);
 298
 299 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
 300 extern __be32 root_nfs_parse_addr(char *name); /*__init*/
 301
 302 static inline void nfs_fattr_init(struct nfs_fattr *fattr)
 303 {
 304         fattr->valid = 0;
 305         fattr->time_start = jiffies;
 306 }
 307
 308 /*
 309  * linux/fs/nfs/file.c
 310  */
 311 extern const struct inode_operations nfs_file_inode_operations;
 312 #ifdef CONFIG_NFS_V3
 313 extern const struct inode_operations nfs3_file_inode_operations;
 314 #endif /* CONFIG_NFS_V3 */
 315 extern const struct file_operations nfs_file_operations;
 316 extern const struct address_space_operations nfs_file_aops;
 317
 318 static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
 319 {
 320         return filp->private_data;
 321 }
 322
 323 static inline struct rpc_cred *nfs_file_cred(struct file *file)
 324 {
 325         if (file != NULL)
 326                 return nfs_file_open_context(file)->cred;
 327         return NULL;
 328 }
 329
 330 /*
 331  * linux/fs/nfs/xattr.c
 332  */
 333 #ifdef CONFIG_NFS_V3_ACL
 334 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
 335 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
 336 extern int nfs3_setxattr(struct dentry *, const char *,
 337                         const void *, size_t, int);
 338 extern int nfs3_removexattr (struct dentry *, const char *name);
 339 #else
 340 # define nfs3_listxattr NULL
 341 # define nfs3_getxattr NULL
 342 # define nfs3_setxattr NULL
 343 # define nfs3_removexattr NULL
 344 #endif
 345
 346 /*
 347  * linux/fs/nfs/direct.c
 348  */
 349 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
 350                         unsigned long);
 351 extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
 352                         const struct iovec *iov, unsigned long nr_segs,
 353                         loff_t pos);
 354 extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
 355                         const struct iovec *iov, unsigned long nr_segs,
 356                         loff_t pos);
 357
 358 /*
 359  * linux/fs/nfs/dir.c
 360  */
 361 extern const struct inode_operations nfs_dir_inode_operations;
 362 #ifdef CONFIG_NFS_V3
 363 extern const struct inode_operations nfs3_dir_inode_operations;
 364 #endif /* CONFIG_NFS_V3 */
 365 extern const struct file_operations nfs_dir_operations;
 366 extern struct dentry_operations nfs_dentry_operations;
 367
 368 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
 369 extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
 370 extern void nfs_access_zap_cache(struct inode *inode);
 371
 372 /*
 373  * linux/fs/nfs/symlink.c
 374  */
 375 extern const struct inode_operations nfs_symlink_inode_operations;
 376
 377 /*
 378  * linux/fs/nfs/sysctl.c
 379  */
 380 #ifdef CONFIG_SYSCTL
 381 extern int nfs_register_sysctl(void);
 382 extern void nfs_unregister_sysctl(void);
 383 #else
 384 #define nfs_register_sysctl() 0
 385 #define nfs_unregister_sysctl() do { } while(0)
 386 #endif
 387
 388 /*
 389  * linux/fs/nfs/namespace.c
 390  */
 391 extern struct list_head nfs_automount_list;
 392 extern const struct inode_operations nfs_mountpoint_inode_operations;
 393 extern const struct inode_operations nfs_referral_inode_operations;
 394 extern int nfs_mountpoint_expiry_timeout;
 395 extern void nfs_release_automount_timer(void);
 396
 397 /*
 398  * linux/fs/nfs/unlink.c
 399  */
 400 extern int  nfs_async_unlink(struct inode *dir, struct dentry *dentry);
 401 extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
 402
 403 /*
 404  * linux/fs/nfs/write.c
 405  */
 406 extern int  nfs_congestion_kb;
 407 extern int  nfs_writepage(struct page *page, struct writeback_control *wbc);
 408 extern int  nfs_writepages(struct address_space *, struct writeback_control *);
 409 extern int  nfs_flush_incompatible(struct file *file, struct page *page);
 410 extern int  nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
 411 extern int nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
 412 extern void nfs_writedata_release(void *);
 413
 414 /*
 415  * Try to write back everything synchronously (but check the
 416  * return value!)
 417  */
 418 extern long nfs_sync_mapping_wait(struct address_space *, struct writeback_control *, int);
 419 extern int nfs_wb_all(struct inode *inode);
 420 extern int nfs_wb_nocommit(struct inode *inode);
 421 extern int nfs_wb_page(struct inode *inode, struct page* page);
 422 extern int nfs_wb_page_priority(struct inode *inode, struct page* page, int how);
 423 extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
 424 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
 425 extern int  nfs_commit_inode(struct inode *, int);
 426 extern struct nfs_write_data *nfs_commit_alloc(void);
 427 extern void nfs_commit_free(struct nfs_write_data *wdata);
 428 extern void nfs_commit_release(void *wdata);
 429 #else
 430 static inline int
 431 nfs_commit_inode(struct inode *inode, int how)
 432 {
 433         return 0;
 434 }
 435 #endif
 436
 437 static inline int
 438 nfs_have_writebacks(struct inode *inode)
 439 {
 440         return NFS_I(inode)->npages != 0;
 441 }
 442
 443 /*
 444  * Allocate nfs_write_data structures
 445  */
 446 extern struct nfs_write_data *nfs_writedata_alloc(unsigned int npages);
 447
 448 /*
 449  * linux/fs/nfs/read.c
 450  */
 451 extern int  nfs_readpage(struct file *, struct page *);
 452 extern int  nfs_readpages(struct file *, struct address_space *,
 453                 struct list_head *, unsigned);
 454 extern int  nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
 455 extern void nfs_readdata_release(void *data);
 456
 457 /*
 458  * Allocate nfs_read_data structures
 459  */
 460 extern struct nfs_read_data *nfs_readdata_alloc(unsigned int npages);
 461
 462 /*
 463  * linux/fs/nfs3proc.c
 464  */
 465 #ifdef CONFIG_NFS_V3_ACL
 466 extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
 467 extern int nfs3_proc_setacl(struct inode *inode, int type,
 468                             struct posix_acl *acl);
 469 extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
 470                 mode_t mode);
 471 extern void nfs3_forget_cached_acls(struct inode *inode);
 472 #else
 473 static inline int nfs3_proc_set_default_acl(struct inode *dir,
 474                                             struct inode *inode,
 475                                             mode_t mode)
 476 {
 477         return 0;
 478 }
 479
 480 static inline void nfs3_forget_cached_acls(struct inode *inode)
 481 {
 482 }
 483 #endif /* CONFIG_NFS_V3_ACL */
 484
 485 /*
 486  * linux/fs/mount_clnt.c
 487  */
 488 extern int  nfs_mount(struct sockaddr *, size_t, char *, char *,
 489                       int, int, struct nfs_fh *);
 490
 491 /*
 492  * inline functions
 493  */
 494
 495 static inline loff_t nfs_size_to_loff_t(__u64 size)
 496 {
 497         if (size > (__u64) OFFSET_MAX - 1)
 498                 return OFFSET_MAX - 1;
 499         return (loff_t) size;
 500 }
 501
 502 static inline ino_t
 503 nfs_fileid_to_ino_t(u64 fileid)
 504 {
 505         ino_t ino = (ino_t) fileid;
 506         if (sizeof(ino_t) < sizeof(u64))
 507                 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
 508         return ino;
 509 }
 510
 511 /* NFS root */
 512
 513 extern void * nfs_root_data(void);
 514
 515 #define nfs_wait_event(clnt, wq, condition)                             \
 516 ({                                                                      \
 517         int __retval = 0;                                               \
 518         if (clnt->cl_intr) {                                            \
 519                 sigset_t oldmask;                                       \
 520                 rpc_clnt_sigmask(clnt, &oldmask);                       \
 521                 __retval = wait_event_interruptible(wq, condition);     \
 522                 rpc_clnt_sigunmask(clnt, &oldmask);                     \
 523         } else                                                          \
 524                 wait_event(wq, condition);                              \
 525         __retval;                                                       \
 526 })
 527
 528 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
 529
 530 #endif /* __KERNEL__ */
 531
 532 /*
 533  * NFS debug flags
 534  */
 535 #define NFSDBG_VFS              0x0001
 536 #define NFSDBG_DIRCACHE         0x0002
 537 #define NFSDBG_LOOKUPCACHE      0x0004
 538 #define NFSDBG_PAGECACHE        0x0008
 539 #define NFSDBG_PROC             0x0010
 540 #define NFSDBG_XDR              0x0020
 541 #define NFSDBG_FILE             0x0040
 542 #define NFSDBG_ROOT             0x0080
 543 #define NFSDBG_CALLBACK         0x0100
 544 #define NFSDBG_CLIENT           0x0200
 545 #define NFSDBG_MOUNT            0x0400
 546 #define NFSDBG_ALL              0xFFFF
 547
 548 #ifdef __KERNEL__
 549
 550 /*
 551  * Enable debugging support for nfs client.
 552  * Requires RPC_DEBUG.
 553  */
 554 #ifdef RPC_DEBUG
 555 # define NFS_DEBUG
 556 #endif
 557
 558 # undef ifdebug
 559 # ifdef NFS_DEBUG
 560 #  define ifdebug(fac)          if (unlikely(nfs_debug & NFSDBG_##fac))
 561 # else
 562 #  define ifdebug(fac)          if (0)
 563 # endif
 564 #endif /* __KERNEL */
 565
 566 #endif