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/config.h>
  13 #include <linux/in.h>
  14 #include <linux/mm.h>
  15 #include <linux/pagemap.h>
  16 #include <linux/rwsem.h>
  17 #include <linux/wait.h>
  18
  19 #include <linux/nfs_fs_sb.h>
  20
  21 #include <linux/sunrpc/debug.h>
  22 #include <linux/sunrpc/auth.h>
  23 #include <linux/sunrpc/clnt.h>
  24
  25 #include <linux/nfs.h>
  26 #include <linux/nfs2.h>
  27 #include <linux/nfs3.h>
  28 #include <linux/nfs4.h>
  29 #include <linux/nfs_xdr.h>
  30 #include <linux/rwsem.h>
  31 #include <linux/mempool.h>
  32
  33 /*
  34  * Enable debugging support for nfs client.
  35  * Requires RPC_DEBUG.
  36  */
  37 #ifdef RPC_DEBUG
  38 # define NFS_DEBUG
  39 #endif
  40
  41 #define NFS_MAX_FILE_IO_BUFFER_SIZE     32768
  42 #define NFS_DEF_FILE_IO_BUFFER_SIZE     4096
  43
  44 /* Default timeout values */
  45 #define NFS_MAX_UDP_TIMEOUT     (60*HZ)
  46 #define NFS_MAX_TCP_TIMEOUT     (600*HZ)
  47
  48 /*
  49  * superblock magic number for NFS
  50  */
  51 #define NFS_SUPER_MAGIC                 0x6969
  52
  53 /*
  54  * These are the default flags for swap requests
  55  */
  56 #define NFS_RPC_SWAPFLAGS               (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
  57
  58 /*
  59  * When flushing a cluster of dirty pages, there can be different
  60  * strategies:
  61  */
  62 #define FLUSH_AGING             0       /* only flush old buffers */
  63 #define FLUSH_SYNC              1       /* file being synced, or contention */
  64 #define FLUSH_WAIT              2       /* wait for completion */
  65 #define FLUSH_STABLE            4       /* commit to stable storage */
  66 #define FLUSH_LOWPRI            8       /* low priority background flush */
  67 #define FLUSH_HIGHPRI           16      /* high priority memory reclaim flush */
  68
  69 #ifdef __KERNEL__
  70
  71 /*
  72  * NFSv3/v4 Access mode cache entry
  73  */
  74 struct nfs_access_entry {
  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 dentry *dentry;
  84         struct rpc_cred *cred;
  85         struct nfs4_state *state;
  86         fl_owner_t lockowner;
  87         int mode;
  88         int error;
  89
  90         struct list_head list;
  91
  92         __u64 dir_cookie;
  93 };
  94
  95 /*
  96  * NFSv4 delegation
  97  */
  98 struct nfs_delegation;
  99
 100 struct posix_acl;
 101
 102 /*
 103  * nfs fs inode data in memory
 104  */
 105 struct nfs_inode {
 106         /*
 107          * The 64bit 'inode number'
 108          */
 109         __u64 fileid;
 110
 111         /*
 112          * NFS file handle
 113          */
 114         struct nfs_fh           fh;
 115
 116         /*
 117          * Various flags
 118          */
 119         unsigned long           flags;                  /* atomic bit ops */
 120         unsigned long           cache_validity;         /* bit mask */
 121
 122         /*
 123          * read_cache_jiffies is when we started read-caching this inode,
 124          * and read_cache_mtime is the mtime of the inode at that time.
 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          * and invalidate any cached data/flush out any dirty pages if
 135          * we find that
 136          *
 137          *      mtime != read_cache_mtime
 138          */
 139         unsigned long           read_cache_jiffies;
 140         unsigned long           attrtimeo;
 141         unsigned long           attrtimeo_timestamp;
 142         __u64                   change_attr;            /* v4 only */
 143
 144         unsigned long           last_updated;
 145         /* "Generation counter" for the attribute cache. This is
 146          * bumped whenever we update the metadata on the
 147          * server.
 148          */
 149         unsigned long           cache_change_attribute;
 150         /*
 151          * Counter indicating the number of outstanding requests that
 152          * will cause a file data update.
 153          */
 154         atomic_t                data_updates;
 155
 156         struct nfs_access_entry cache_access;
 157 #ifdef CONFIG_NFS_V3_ACL
 158         struct posix_acl        *acl_access;
 159         struct posix_acl        *acl_default;
 160 #endif
 161
 162         /*
 163          * This is the cookie verifier used for NFSv3 readdir
 164          * operations
 165          */
 166         __u32                   cookieverf[2];
 167
 168         /*
 169          * This is the list of dirty unwritten pages.
 170          */
 171         spinlock_t              req_lock;
 172         struct list_head        dirty;
 173         struct list_head        commit;
 174         struct radix_tree_root  nfs_page_tree;
 175
 176         unsigned int            ndirty,
 177                                 ncommit,
 178                                 npages;
 179
 180         /* Open contexts for shared mmap writes */
 181         struct list_head        open_files;
 182
 183 #ifdef CONFIG_NFS_V4
 184         struct nfs4_cached_acl  *nfs4_acl;
 185         /* NFSv4 state */
 186         struct list_head        open_states;
 187         struct nfs_delegation   *delegation;
 188         int                      delegation_state;
 189         struct rw_semaphore     rwsem;
 190 #endif /* CONFIG_NFS_V4*/
 191         struct inode            vfs_inode;
 192 };
 193
 194 /*
 195  * Cache validity bit flags
 196  */
 197 #define NFS_INO_INVALID_ATTR    0x0001          /* cached attrs are invalid */
 198 #define NFS_INO_INVALID_DATA    0x0002          /* cached data is invalid */
 199 #define NFS_INO_INVALID_ATIME   0x0004          /* cached atime is invalid */
 200 #define NFS_INO_INVALID_ACCESS  0x0008          /* cached access cred invalid */
 201 #define NFS_INO_INVALID_ACL     0x0010          /* cached acls are invalid */
 202 #define NFS_INO_REVAL_PAGECACHE 0x0020          /* must revalidate pagecache */
 203
 204 /*
 205  * Bit offsets in flags field
 206  */
 207 #define NFS_INO_REVALIDATING    (0)             /* revalidating attrs */
 208 #define NFS_INO_ADVISE_RDPLUS   (1)             /* advise readdirplus */
 209 #define NFS_INO_STALE           (2)             /* possible stale inode */
 210
 211 static inline struct nfs_inode *NFS_I(struct inode *inode)
 212 {
 213         return container_of(inode, struct nfs_inode, vfs_inode);
 214 }
 215 #define NFS_SB(s)               ((struct nfs_server *)(s->s_fs_info))
 216
 217 #define NFS_FH(inode)                   (&NFS_I(inode)->fh)
 218 #define NFS_SERVER(inode)               (NFS_SB(inode->i_sb))
 219 #define NFS_CLIENT(inode)               (NFS_SERVER(inode)->client)
 220 #define NFS_PROTO(inode)                (NFS_SERVER(inode)->rpc_ops)
 221 #define NFS_ADDR(inode)                 (RPC_PEERADDR(NFS_CLIENT(inode)))
 222 #define NFS_COOKIEVERF(inode)           (NFS_I(inode)->cookieverf)
 223 #define NFS_READTIME(inode)             (NFS_I(inode)->read_cache_jiffies)
 224 #define NFS_CHANGE_ATTR(inode)          (NFS_I(inode)->change_attr)
 225 #define NFS_ATTRTIMEO(inode)            (NFS_I(inode)->attrtimeo)
 226 #define NFS_MINATTRTIMEO(inode) \
 227         (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
 228                                : NFS_SERVER(inode)->acregmin)
 229 #define NFS_MAXATTRTIMEO(inode) \
 230         (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
 231                                : NFS_SERVER(inode)->acregmax)
 232 #define NFS_ATTRTIMEO_UPDATE(inode)     (NFS_I(inode)->attrtimeo_timestamp)
 233
 234 #define NFS_FLAGS(inode)                (NFS_I(inode)->flags)
 235 #define NFS_STALE(inode)                (test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
 236
 237 #define NFS_FILEID(inode)               (NFS_I(inode)->fileid)
 238
 239 static inline int nfs_caches_unstable(struct inode *inode)
 240 {
 241         return atomic_read(&NFS_I(inode)->data_updates) != 0;
 242 }
 243
 244 static inline void nfs_mark_for_revalidate(struct inode *inode)
 245 {
 246         spin_lock(&inode->i_lock);
 247         NFS_I(inode)->cache_validity |= NFS_INO_INVALID_ATTR | NFS_INO_INVALID_ACCESS;
 248         spin_unlock(&inode->i_lock);
 249 }
 250
 251 static inline void NFS_CACHEINV(struct inode *inode)
 252 {
 253         if (!nfs_caches_unstable(inode))
 254                 nfs_mark_for_revalidate(inode);
 255 }
 256
 257 static inline int nfs_server_capable(struct inode *inode, int cap)
 258 {
 259         return NFS_SERVER(inode)->caps & cap;
 260 }
 261
 262 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
 263 {
 264         return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
 265 }
 266
 267 /**
 268  * nfs_save_change_attribute - Returns the inode attribute change cookie
 269  * @inode - pointer to inode
 270  * The "change attribute" is updated every time we finish an operation
 271  * that will result in a metadata change on the server.
 272  */
 273 static inline long nfs_save_change_attribute(struct inode *inode)
 274 {
 275         return NFS_I(inode)->cache_change_attribute;
 276 }
 277
 278 /**
 279  * nfs_verify_change_attribute - Detects NFS inode cache updates
 280  * @inode - pointer to inode
 281  * @chattr - previously saved change attribute
 282  * Return "false" if metadata has been updated (or is in the process of
 283  * being updated) since the change attribute was saved.
 284  */
 285 static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
 286 {
 287         return !nfs_caches_unstable(inode)
 288                 && time_after_eq(chattr, NFS_I(inode)->cache_change_attribute);
 289 }
 290
 291 /*
 292  * linux/fs/nfs/inode.c
 293  */
 294 extern int nfs_sync_mapping(struct address_space *mapping);
 295 extern void nfs_zap_caches(struct inode *);
 296 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
 297                                 struct nfs_fattr *);
 298 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
 299 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
 300 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
 301 extern int nfs_permission(struct inode *, int, struct nameidata *);
 302 extern int nfs_access_get_cached(struct inode *, struct rpc_cred *, struct nfs_access_entry *);
 303 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
 304 extern int nfs_open(struct inode *, struct file *);
 305 extern int nfs_release(struct inode *, struct file *);
 306 extern int nfs_attribute_timeout(struct inode *inode);
 307 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
 308 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
 309 extern void nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
 310 extern int nfs_setattr(struct dentry *, struct iattr *);
 311 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
 312 extern void nfs_begin_attr_update(struct inode *);
 313 extern void nfs_end_attr_update(struct inode *);
 314 extern void nfs_begin_data_update(struct inode *);
 315 extern void nfs_end_data_update(struct inode *);
 316 extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, struct rpc_cred *cred);
 317 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
 318 extern void put_nfs_open_context(struct nfs_open_context *ctx);
 319 extern void nfs_file_set_open_context(struct file *filp, 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 void nfs_file_clear_open_context(struct file *filp);
 322
 323 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
 324 extern u32 root_nfs_parse_addr(char *name); /*__init*/
 325
 326 static inline void nfs_fattr_init(struct nfs_fattr *fattr)
 327 {
 328         fattr->valid = 0;
 329         fattr->time_start = jiffies;
 330 }
 331
 332 /*
 333  * linux/fs/nfs/file.c
 334  */
 335 extern struct inode_operations nfs_file_inode_operations;
 336 #ifdef CONFIG_NFS_V3
 337 extern struct inode_operations nfs3_file_inode_operations;
 338 #endif /* CONFIG_NFS_V3 */
 339 extern struct file_operations nfs_file_operations;
 340 extern struct address_space_operations nfs_file_aops;
 341
 342 static inline struct rpc_cred *nfs_file_cred(struct file *file)
 343 {
 344         if (file != NULL) {
 345                 struct nfs_open_context *ctx;
 346
 347                 ctx = (struct nfs_open_context*)file->private_data;
 348                 return ctx->cred;
 349         }
 350         return NULL;
 351 }
 352
 353 /*
 354  * linux/fs/nfs/xattr.c
 355  */
 356 #ifdef CONFIG_NFS_V3_ACL
 357 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
 358 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
 359 extern int nfs3_setxattr(struct dentry *, const char *,
 360                         const void *, size_t, int);
 361 extern int nfs3_removexattr (struct dentry *, const char *name);
 362 #else
 363 # define nfs3_listxattr NULL
 364 # define nfs3_getxattr NULL
 365 # define nfs3_setxattr NULL
 366 # define nfs3_removexattr NULL
 367 #endif
 368
 369 /*
 370  * linux/fs/nfs/direct.c
 371  */
 372 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
 373                         unsigned long);
 374 extern ssize_t nfs_file_direct_read(struct kiocb *iocb, char __user *buf,
 375                         size_t count, loff_t pos);
 376 extern ssize_t nfs_file_direct_write(struct kiocb *iocb, const char __user *buf,
 377                         size_t count, loff_t pos);
 378
 379 /*
 380  * linux/fs/nfs/dir.c
 381  */
 382 extern struct inode_operations nfs_dir_inode_operations;
 383 #ifdef CONFIG_NFS_V3
 384 extern struct inode_operations nfs3_dir_inode_operations;
 385 #endif /* CONFIG_NFS_V3 */
 386 extern struct file_operations nfs_dir_operations;
 387 extern struct dentry_operations nfs_dentry_operations;
 388
 389 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
 390
 391 /*
 392  * linux/fs/nfs/symlink.c
 393  */
 394 extern struct inode_operations nfs_symlink_inode_operations;
 395
 396 /*
 397  * linux/fs/nfs/unlink.c
 398  */
 399 extern int  nfs_async_unlink(struct dentry *);
 400 extern void nfs_complete_unlink(struct dentry *);
 401
 402 /*
 403  * linux/fs/nfs/write.c
 404  */
 405 extern int  nfs_writepage(struct page *page, struct writeback_control *wbc);
 406 extern int  nfs_writepages(struct address_space *, struct writeback_control *);
 407 extern int  nfs_flush_incompatible(struct file *file, struct page *page);
 408 extern int  nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
 409 extern void nfs_writeback_done(struct rpc_task *task);
 410
 411 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
 412 extern void nfs_commit_done(struct rpc_task *);
 413 #endif
 414
 415 /*
 416  * Try to write back everything synchronously (but check the
 417  * return value!)
 418  */
 419 extern int  nfs_sync_inode(struct inode *, unsigned long, unsigned int, int);
 420 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
 421 extern int  nfs_commit_inode(struct inode *, int);
 422 #else
 423 static inline int
 424 nfs_commit_inode(struct inode *inode, int how)
 425 {
 426         return 0;
 427 }
 428 #endif
 429
 430 static inline int
 431 nfs_have_writebacks(struct inode *inode)
 432 {
 433         return NFS_I(inode)->npages != 0;
 434 }
 435
 436 static inline int
 437 nfs_wb_all(struct inode *inode)
 438 {
 439         int error = nfs_sync_inode(inode, 0, 0, FLUSH_WAIT);
 440         return (error < 0) ? error : 0;
 441 }
 442
 443 /*
 444  * Write back all requests on one page - we do this before reading it.
 445  */
 446 static inline int nfs_wb_page_priority(struct inode *inode, struct page* page, int how)
 447 {
 448         int error = nfs_sync_inode(inode, page->index, 1,
 449                         how | FLUSH_WAIT | FLUSH_STABLE);
 450         return (error < 0) ? error : 0;
 451 }
 452
 453 static inline int nfs_wb_page(struct inode *inode, struct page* page)
 454 {
 455         return nfs_wb_page_priority(inode, page, 0);
 456 }
 457
 458 /*
 459  * Allocate and free nfs_write_data structures
 460  */
 461 extern mempool_t *nfs_wdata_mempool;
 462
 463 static inline struct nfs_write_data *nfs_writedata_alloc(void)
 464 {
 465         struct nfs_write_data *p = mempool_alloc(nfs_wdata_mempool, SLAB_NOFS);
 466         if (p) {
 467                 memset(p, 0, sizeof(*p));
 468                 INIT_LIST_HEAD(&p->pages);
 469         }
 470         return p;
 471 }
 472
 473 static inline void nfs_writedata_free(struct nfs_write_data *p)
 474 {
 475         mempool_free(p, nfs_wdata_mempool);
 476 }
 477
 478 /*
 479  * linux/fs/nfs/read.c
 480  */
 481 extern int  nfs_readpage(struct file *, struct page *);
 482 extern int  nfs_readpages(struct file *, struct address_space *,
 483                 struct list_head *, unsigned);
 484 extern void nfs_readpage_result(struct rpc_task *);
 485
 486 /*
 487  * Allocate and free nfs_read_data structures
 488  */
 489 extern mempool_t *nfs_rdata_mempool;
 490
 491 static inline struct nfs_read_data *nfs_readdata_alloc(void)
 492 {
 493         struct nfs_read_data *p = mempool_alloc(nfs_rdata_mempool, SLAB_NOFS);
 494         if (p)
 495                 memset(p, 0, sizeof(*p));
 496         return p;
 497 }
 498
 499 static inline void nfs_readdata_free(struct nfs_read_data *p)
 500 {
 501         mempool_free(p, nfs_rdata_mempool);
 502 }
 503
 504 extern void  nfs_readdata_release(struct rpc_task *task);
 505
 506 /*
 507  * linux/fs/nfs3proc.c
 508  */
 509 #ifdef CONFIG_NFS_V3_ACL
 510 extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
 511 extern int nfs3_proc_setacl(struct inode *inode, int type,
 512                             struct posix_acl *acl);
 513 extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
 514                 mode_t mode);
 515 extern void nfs3_forget_cached_acls(struct inode *inode);
 516 #else
 517 static inline int nfs3_proc_set_default_acl(struct inode *dir,
 518                                             struct inode *inode,
 519                                             mode_t mode)
 520 {
 521         return 0;
 522 }
 523
 524 static inline void nfs3_forget_cached_acls(struct inode *inode)
 525 {
 526 }
 527 #endif /* CONFIG_NFS_V3_ACL */
 528
 529 /*
 530  * linux/fs/mount_clnt.c
 531  * (Used only by nfsroot module)
 532  */
 533 extern int  nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
 534                 int, int);
 535
 536 /*
 537  * inline functions
 538  */
 539
 540 static inline loff_t
 541 nfs_size_to_loff_t(__u64 size)
 542 {
 543         loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
 544         if (size > maxsz)
 545                 return maxsz;
 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 = 0;                                               \
 565         if (clnt->cl_intr) {                                            \
 566                 sigset_t oldmask;                                       \
 567                 rpc_clnt_sigmask(clnt, &oldmask);                       \
 568                 __retval = wait_event_interruptible(wq, condition);     \
 569                 rpc_clnt_sigunmask(clnt, &oldmask);                     \
 570         } else                                                          \
 571                 wait_event(wq, condition);                              \
 572         __retval;                                                       \
 573 })
 574
 575 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
 576
 577 #endif /* __KERNEL__ */
 578
 579 /*
 580  * NFS debug flags
 581  */
 582 #define NFSDBG_VFS              0x0001
 583 #define NFSDBG_DIRCACHE         0x0002
 584 #define NFSDBG_LOOKUPCACHE      0x0004
 585 #define NFSDBG_PAGECACHE        0x0008
 586 #define NFSDBG_PROC             0x0010
 587 #define NFSDBG_XDR              0x0020
 588 #define NFSDBG_FILE             0x0040
 589 #define NFSDBG_ROOT             0x0080
 590 #define NFSDBG_CALLBACK         0x0100
 591 #define NFSDBG_ALL              0xFFFF
 592
 593 #ifdef __KERNEL__
 594 # undef ifdebug
 595 # ifdef NFS_DEBUG
 596 #  define ifdebug(fac)          if (unlikely(nfs_debug & NFSDBG_##fac))
 597 # else
 598 #  define ifdebug(fac)          if (0)
 599 # endif
 600 #endif /* __KERNEL */
 601
 602 #endif