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