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