SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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_DEF_UDP_TIMEO       (11)
  16 #define NFS_DEF_UDP_RETRANS     (3)
  17 #define NFS_DEF_TCP_TIMEO       (600)
  18 #define NFS_DEF_TCP_RETRANS     (2)
  19
  20 #define NFS_MAX_UDP_TIMEOUT     (60*HZ)
  21 #define NFS_MAX_TCP_TIMEOUT     (600*HZ)
  22
  23 /*
  24  * When flushing a cluster of dirty pages, there can be different
  25  * strategies:
  26  */
  27 #define FLUSH_SYNC              1       /* file being synced, or contention */
  28 #define FLUSH_STABLE            4       /* commit to stable storage */
  29 #define FLUSH_LOWPRI            8       /* low priority background flush */
  30 #define FLUSH_HIGHPRI           16      /* high priority memory reclaim flush */
  31 #define FLUSH_NOCOMMIT          32      /* Don't send the NFSv3/v4 COMMIT */
  32 #define FLUSH_INVALIDATE        64      /* Invalidate the page cache */
  33 #define FLUSH_NOWRITEPAGE       128     /* Don't call writepage() */
  34
  35 #ifdef __KERNEL__
  36
  37 #include <linux/in.h>
  38 #include <linux/kref.h>
  39 #include <linux/mm.h>
  40 #include <linux/namei.h>
  41 #include <linux/pagemap.h>
  42 #include <linux/rbtree.h>
  43 #include <linux/rwsem.h>
  44 #include <linux/wait.h>
  45
  46 #include <linux/sunrpc/debug.h>
  47 #include <linux/sunrpc/auth.h>
  48 #include <linux/sunrpc/clnt.h>
  49
  50 #include <linux/nfs.h>
  51 #include <linux/nfs2.h>
  52 #include <linux/nfs3.h>
  53 #include <linux/nfs4.h>
  54 #include <linux/nfs_xdr.h>
  55 #include <linux/nfs_fs_sb.h>
  56
  57 #include <linux/mempool.h>
  58
  59 /*
  60  * These are the default flags for swap requests
  61  */
  62 #define NFS_RPC_SWAPFLAGS               (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
  63
  64 /*
  65  * NFSv3/v4 Access mode cache entry
  66  */
  67 struct nfs_access_entry {
  68         struct rb_node          rb_node;
  69         struct list_head        lru;
  70         unsigned long           jiffies;
  71         struct rpc_cred *       cred;
  72         int                     mask;
  73 };
  74
  75 struct nfs4_state;
  76 struct nfs_open_context {
  77         atomic_t count;
  78         struct path path;
  79         struct rpc_cred *cred;
  80         struct nfs4_state *state;
  81         fl_owner_t lockowner;
  82         int mode;
  83
  84         unsigned long flags;
  85 #define NFS_CONTEXT_ERROR_WRITE         (0)
  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         struct rb_root          access_cache;
 144         struct list_head        access_cache_entry_lru;
 145         struct list_head        access_cache_inode_lru;
 146 #ifdef CONFIG_NFS_V3_ACL
 147         struct posix_acl        *acl_access;
 148         struct posix_acl        *acl_default;
 149 #endif
 150
 151         /*
 152          * This is the cookie verifier used for NFSv3 readdir
 153          * operations
 154          */
 155         __be32                  cookieverf[2];
 156
 157         /*
 158          * This is the list of dirty unwritten pages.
 159          */
 160         struct radix_tree_root  nfs_page_tree;
 161
 162         unsigned long           ncommit,
 163                                 npages;
 164
 165         /* Open contexts for shared mmap writes */
 166         struct list_head        open_files;
 167
 168         /* Number of in-flight sillydelete RPC calls */
 169         atomic_t                silly_count;
 170         /* List of deferred sillydelete requests */
 171         struct hlist_head       silly_list;
 172         wait_queue_head_t       waitqueue;
 173
 174 #ifdef CONFIG_NFS_V4
 175         struct nfs4_cached_acl  *nfs4_acl;
 176         /* NFSv4 state */
 177         struct list_head        open_states;
 178         struct nfs_delegation   *delegation;
 179         int                      delegation_state;
 180         struct rw_semaphore     rwsem;
 181 #endif /* CONFIG_NFS_V4*/
 182         struct inode            vfs_inode;
 183 };
 184
 185 /*
 186  * Cache validity bit flags
 187  */
 188 #define NFS_INO_INVALID_ATTR    0x0001          /* cached attrs are invalid */
 189 #define NFS_INO_INVALID_DATA    0x0002          /* cached data is invalid */
 190 #define NFS_INO_INVALID_ATIME   0x0004          /* cached atime is invalid */
 191 #define NFS_INO_INVALID_ACCESS  0x0008          /* cached access cred invalid */
 192 #define NFS_INO_INVALID_ACL     0x0010          /* cached acls are invalid */
 193 #define NFS_INO_REVAL_PAGECACHE 0x0020          /* must revalidate pagecache */
 194 #define NFS_INO_REVAL_FORCED    0x0040          /* force revalidation ignoring a delegation */
 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 #define NFS_INO_ACL_LRU_SET     (3)             /* Inode is on the LRU list */
 203 #define NFS_INO_MOUNTPOINT      (4)             /* inode is remote mountpoint */
 204
 205 static inline struct nfs_inode *NFS_I(const struct inode *inode)
 206 {
 207         return container_of(inode, struct nfs_inode, vfs_inode);
 208 }
 209
 210 static inline struct nfs_server *NFS_SB(const struct super_block *s)
 211 {
 212         return (struct nfs_server *)(s->s_fs_info);
 213 }
 214
 215 static inline struct nfs_fh *NFS_FH(const struct inode *inode)
 216 {
 217         return &NFS_I(inode)->fh;
 218 }
 219
 220 static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
 221 {
 222         return NFS_SB(inode->i_sb);
 223 }
 224
 225 static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
 226 {
 227         return NFS_SERVER(inode)->client;
 228 }
 229
 230 static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
 231 {
 232         return NFS_SERVER(inode)->nfs_client->rpc_ops;
 233 }
 234
 235 static inline __be32 *NFS_COOKIEVERF(const struct inode *inode)
 236 {
 237         return NFS_I(inode)->cookieverf;
 238 }
 239
 240 static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
 241 {
 242         struct nfs_server *nfss = NFS_SERVER(inode);
 243         return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
 244 }
 245
 246 static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
 247 {
 248         struct nfs_server *nfss = NFS_SERVER(inode);
 249         return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
 250 }
 251
 252 static inline int NFS_STALE(const struct inode *inode)
 253 {
 254         return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
 255 }
 256
 257 static inline __u64 NFS_FILEID(const struct inode *inode)
 258 {
 259         return NFS_I(inode)->fileid;
 260 }
 261
 262 static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
 263 {
 264         NFS_I(inode)->fileid = fileid;
 265 }
 266
 267 static inline void nfs_mark_for_revalidate(struct inode *inode)
 268 {
 269         struct nfs_inode *nfsi = NFS_I(inode);
 270
 271         spin_lock(&inode->i_lock);
 272         nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
 273         if (S_ISDIR(inode->i_mode))
 274                 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
 275         spin_unlock(&inode->i_lock);
 276 }
 277
 278 static inline int nfs_server_capable(struct inode *inode, int cap)
 279 {
 280         return NFS_SERVER(inode)->caps & cap;
 281 }
 282
 283 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
 284 {
 285         return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(inode)->flags);
 286 }
 287
 288 static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
 289 {
 290         dentry->d_time = verf;
 291 }
 292
 293 /**
 294  * nfs_save_change_attribute - Returns the inode attribute change cookie
 295  * @dir - pointer to parent directory inode
 296  * The "change attribute" is updated every time we finish an operation
 297  * that will result in a metadata change on the server.
 298  */
 299 static inline unsigned long nfs_save_change_attribute(struct inode *dir)
 300 {
 301         return NFS_I(dir)->cache_change_attribute;
 302 }
 303
 304 /**
 305  * nfs_verify_change_attribute - Detects NFS remote directory changes
 306  * @dir - pointer to parent directory inode
 307  * @chattr - previously saved change attribute
 308  * Return "false" if the verifiers doesn't match the change attribute.
 309  * This would usually indicate that the directory contents have changed on
 310  * the server, and that any dentries need revalidating.
 311  */
 312 static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
 313 {
 314         return chattr == NFS_I(dir)->cache_change_attribute;
 315 }
 316
 317 /*
 318  * linux/fs/nfs/inode.c
 319  */
 320 extern int nfs_sync_mapping(struct address_space *mapping);
 321 extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
 322 extern void nfs_zap_caches(struct inode *);
 323 extern void nfs_invalidate_atime(struct inode *);
 324 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
 325                                 struct nfs_fattr *);
 326 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
 327 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
 328 extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
 329 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
 330 extern int nfs_permission(struct inode *, int, struct nameidata *);
 331 extern int nfs_open(struct inode *, struct file *);
 332 extern int nfs_release(struct inode *, struct file *);
 333 extern int nfs_attribute_timeout(struct inode *inode);
 334 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
 335 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
 336 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
 337 extern int nfs_revalidate_mapping_nolock(struct inode *inode, struct address_space *mapping);
 338 extern int nfs_setattr(struct dentry *, struct iattr *);
 339 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
 340 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
 341 extern void put_nfs_open_context(struct nfs_open_context *ctx);
 342 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode);
 343 extern u64 nfs_compat_user_ino64(u64 fileid);
 344
 345 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
 346 extern __be32 root_nfs_parse_addr(char *name); /*__init*/
 347
 348 static inline void nfs_fattr_init(struct nfs_fattr *fattr)
 349 {
 350         fattr->valid = 0;
 351         fattr->time_start = jiffies;
 352 }
 353
 354 /*
 355  * linux/fs/nfs/file.c
 356  */
 357 extern const struct inode_operations nfs_file_inode_operations;
 358 #ifdef CONFIG_NFS_V3
 359 extern const struct inode_operations nfs3_file_inode_operations;
 360 #endif /* CONFIG_NFS_V3 */
 361 extern const struct file_operations nfs_file_operations;
 362 extern const struct address_space_operations nfs_file_aops;
 363
 364 static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
 365 {
 366         return filp->private_data;
 367 }
 368
 369 static inline struct rpc_cred *nfs_file_cred(struct file *file)
 370 {
 371         if (file != NULL)
 372                 return nfs_file_open_context(file)->cred;
 373         return NULL;
 374 }
 375
 376 /*
 377  * linux/fs/nfs/xattr.c
 378  */
 379 #ifdef CONFIG_NFS_V3_ACL
 380 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
 381 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
 382 extern int nfs3_setxattr(struct dentry *, const char *,
 383                         const void *, size_t, int);
 384 extern int nfs3_removexattr (struct dentry *, const char *name);
 385 #else
 386 # define nfs3_listxattr NULL
 387 # define nfs3_getxattr NULL
 388 # define nfs3_setxattr NULL
 389 # define nfs3_removexattr NULL
 390 #endif
 391
 392 /*
 393  * linux/fs/nfs/direct.c
 394  */
 395 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
 396                         unsigned long);
 397 extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
 398                         const struct iovec *iov, unsigned long nr_segs,
 399                         loff_t pos);
 400 extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
 401                         const struct iovec *iov, unsigned long nr_segs,
 402                         loff_t pos);
 403
 404 /*
 405  * linux/fs/nfs/dir.c
 406  */
 407 extern const struct inode_operations nfs_dir_inode_operations;
 408 #ifdef CONFIG_NFS_V3
 409 extern const struct inode_operations nfs3_dir_inode_operations;
 410 #endif /* CONFIG_NFS_V3 */
 411 extern const struct file_operations nfs_dir_operations;
 412 extern struct dentry_operations nfs_dentry_operations;
 413
 414 extern void nfs_force_lookup_revalidate(struct inode *dir);
 415 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
 416 extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
 417 extern void nfs_access_zap_cache(struct inode *inode);
 418
 419 /*
 420  * linux/fs/nfs/symlink.c
 421  */
 422 extern const struct inode_operations nfs_symlink_inode_operations;
 423
 424 /*
 425  * linux/fs/nfs/sysctl.c
 426  */
 427 #ifdef CONFIG_SYSCTL
 428 extern int nfs_register_sysctl(void);
 429 extern void nfs_unregister_sysctl(void);
 430 #else
 431 #define nfs_register_sysctl() 0
 432 #define nfs_unregister_sysctl() do { } while(0)
 433 #endif
 434
 435 /*
 436  * linux/fs/nfs/namespace.c
 437  */
 438 extern const struct inode_operations nfs_mountpoint_inode_operations;
 439 extern const struct inode_operations nfs_referral_inode_operations;
 440 extern int nfs_mountpoint_expiry_timeout;
 441 extern void nfs_release_automount_timer(void);
 442
 443 /*
 444  * linux/fs/nfs/unlink.c
 445  */
 446 extern int  nfs_async_unlink(struct inode *dir, struct dentry *dentry);
 447 extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
 448 extern void nfs_block_sillyrename(struct dentry *dentry);
 449 extern void nfs_unblock_sillyrename(struct dentry *dentry);
 450
 451 /*
 452  * linux/fs/nfs/write.c
 453  */
 454 extern int  nfs_congestion_kb;
 455 extern int  nfs_writepage(struct page *page, struct writeback_control *wbc);
 456 extern int  nfs_writepages(struct address_space *, struct writeback_control *);
 457 extern int  nfs_flush_incompatible(struct file *file, struct page *page);
 458 extern int  nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
 459 extern int nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
 460 extern void nfs_writedata_release(void *);
 461
 462 /*
 463  * Try to write back everything synchronously (but check the
 464  * return value!)
 465  */
 466 extern long nfs_sync_mapping_wait(struct address_space *, struct writeback_control *, int);
 467 extern int nfs_wb_all(struct inode *inode);
 468 extern int nfs_wb_nocommit(struct inode *inode);
 469 extern int nfs_wb_page(struct inode *inode, struct page* page);
 470 extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
 471 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
 472 extern int  nfs_commit_inode(struct inode *, int);
 473 extern struct nfs_write_data *nfs_commitdata_alloc(void);
 474 extern void nfs_commit_free(struct nfs_write_data *wdata);
 475 extern void nfs_commitdata_release(void *wdata);
 476 #else
 477 static inline int
 478 nfs_commit_inode(struct inode *inode, int how)
 479 {
 480         return 0;
 481 }
 482 #endif
 483
 484 static inline int
 485 nfs_have_writebacks(struct inode *inode)
 486 {
 487         return NFS_I(inode)->npages != 0;
 488 }
 489
 490 /*
 491  * Allocate nfs_write_data structures
 492  */
 493 extern struct nfs_write_data *nfs_writedata_alloc(unsigned int npages);
 494
 495 /*
 496  * linux/fs/nfs/read.c
 497  */
 498 extern int  nfs_readpage(struct file *, struct page *);
 499 extern int  nfs_readpages(struct file *, struct address_space *,
 500                 struct list_head *, unsigned);
 501 extern int  nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
 502 extern void nfs_readdata_release(void *data);
 503
 504 /*
 505  * Allocate nfs_read_data structures
 506  */
 507 extern struct nfs_read_data *nfs_readdata_alloc(unsigned int npages);
 508
 509 /*
 510  * linux/fs/nfs3proc.c
 511  */
 512 #ifdef CONFIG_NFS_V3_ACL
 513 extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
 514 extern int nfs3_proc_setacl(struct inode *inode, int type,
 515                             struct posix_acl *acl);
 516 extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
 517                 mode_t mode);
 518 extern void nfs3_forget_cached_acls(struct inode *inode);
 519 #else
 520 static inline int nfs3_proc_set_default_acl(struct inode *dir,
 521                                             struct inode *inode,
 522                                             mode_t mode)
 523 {
 524         return 0;
 525 }
 526
 527 static inline void nfs3_forget_cached_acls(struct inode *inode)
 528 {
 529 }
 530 #endif /* CONFIG_NFS_V3_ACL */
 531
 532 /*
 533  * linux/fs/mount_clnt.c
 534  */
 535 extern int  nfs_mount(struct sockaddr *, size_t, char *, char *,
 536                       int, int, struct nfs_fh *);
 537
 538 /*
 539  * inline functions
 540  */
 541
 542 static inline loff_t nfs_size_to_loff_t(__u64 size)
 543 {
 544         if (size > (__u64) OFFSET_MAX - 1)
 545                 return OFFSET_MAX - 1;
 546         return (loff_t) size;
 547 }
 548
 549 static inline ino_t
 550 nfs_fileid_to_ino_t(u64 fileid)
 551 {
 552         ino_t ino = (ino_t) fileid;
 553         if (sizeof(ino_t) < sizeof(u64))
 554                 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
 555         return ino;
 556 }
 557
 558 /* NFS root */
 559
 560 extern void * nfs_root_data(void);
 561
 562 #define nfs_wait_event(clnt, wq, condition)                             \
 563 ({                                                                      \
 564         int __retval = wait_event_killable(wq, condition);              \
 565         __retval;                                                       \
 566 })
 567
 568 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
 569
 570 #endif /* __KERNEL__ */
 571
 572 /*
 573  * NFS debug flags
 574  */
 575 #define NFSDBG_VFS              0x0001
 576 #define NFSDBG_DIRCACHE         0x0002
 577 #define NFSDBG_LOOKUPCACHE      0x0004
 578 #define NFSDBG_PAGECACHE        0x0008
 579 #define NFSDBG_PROC             0x0010
 580 #define NFSDBG_XDR              0x0020
 581 #define NFSDBG_FILE             0x0040
 582 #define NFSDBG_ROOT             0x0080
 583 #define NFSDBG_CALLBACK         0x0100
 584 #define NFSDBG_CLIENT           0x0200
 585 #define NFSDBG_MOUNT            0x0400
 586 #define NFSDBG_ALL              0xFFFF
 587
 588 #ifdef __KERNEL__
 589
 590 /*
 591  * Enable debugging support for nfs client.
 592  * Requires RPC_DEBUG.
 593  */
 594 #ifdef RPC_DEBUG
 595 # define NFS_DEBUG
 596 #endif
 597
 598 # undef ifdebug
 599 # ifdef NFS_DEBUG
 600 #  define ifdebug(fac)          if (unlikely(nfs_debug & NFSDBG_##fac))
 601 # else
 602 #  define ifdebug(fac)          if (0)
 603 # endif
 604 #endif /* __KERNEL */
 605
 606 #endif