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