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