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
  17 #include <linux/sunrpc/debug.h>
  18 #include <linux/sunrpc/auth.h>
  19
  20 #include <linux/nfs.h>
  21 #include <linux/nfs2.h>
  22 #include <linux/nfs3.h>
  23 #include <linux/nfs_xdr.h>
  24
  25 /*
  26  * Enable debugging support for nfs client.
  27  * Requires RPC_DEBUG.
  28  */
  29 #ifdef RPC_DEBUG
  30 # define NFS_DEBUG
  31 #endif
  32
  33 /*
  34  * NFS_MAX_DIRCACHE controls the number of simultaneously cached
  35  * directory chunks. Each chunk holds the list of nfs_entry's returned
  36  * in a single readdir call in a memory region of size PAGE_SIZE.
  37  *
  38  * Note that at most server->rsize bytes of the cache memory are used.
  39  */
  40 #define NFS_MAX_DIRCACHE                16
  41
  42 #define NFS_MAX_FILE_IO_BUFFER_SIZE     32768
  43 #define NFS_DEF_FILE_IO_BUFFER_SIZE     4096
  44
  45 /*
  46  * The upper limit on timeouts for the exponential backoff algorithm.
  47  */
  48 #define NFS_MAX_RPC_TIMEOUT             (6*HZ)
  49 #define NFS_READ_DELAY                  (2*HZ)
  50 #define NFS_WRITEBACK_DELAY             (5*HZ)
  51 #define NFS_WRITEBACK_LOCKDELAY         (60*HZ)
  52 #define NFS_COMMIT_DELAY                (5*HZ)
  53
  54 /*
  55  * Size of the lookup cache in units of number of entries cached.
  56  * It is better not to make this too large although the optimum
  57  * depends on a usage and environment.
  58  */
  59 #define NFS_LOOKUP_CACHE_SIZE           64
  60
  61 /*
  62  * superblock magic number for NFS
  63  */
  64 #define NFS_SUPER_MAGIC                 0x6969
  65
  66 #define NFS_FH(inode)                   (&(inode)->u.nfs_i.fh)
  67 #define NFS_SERVER(inode)               (&(inode)->i_sb->u.nfs_sb.s_server)
  68 #define NFS_CLIENT(inode)               (NFS_SERVER(inode)->client)
  69 #define NFS_PROTO(inode)                (NFS_SERVER(inode)->rpc_ops)
  70 #define NFS_REQUESTLIST(inode)          (NFS_SERVER(inode)->rw_requests)
  71 #define NFS_ADDR(inode)                 (RPC_PEERADDR(NFS_CLIENT(inode)))
  72 #define NFS_CONGESTED(inode)            (RPC_CONGESTED(NFS_CLIENT(inode)))
  73 #define NFS_COOKIEVERF(inode)           ((inode)->u.nfs_i.cookieverf)
  74 #define NFS_READTIME(inode)             ((inode)->u.nfs_i.read_cache_jiffies)
  75 #define NFS_CACHE_CTIME(inode)          ((inode)->u.nfs_i.read_cache_ctime)
  76 #define NFS_CACHE_MTIME(inode)          ((inode)->u.nfs_i.read_cache_mtime)
  77 #define NFS_CACHE_ATIME(inode)          ((inode)->u.nfs_i.read_cache_atime)
  78 #define NFS_CACHE_ISIZE(inode)          ((inode)->u.nfs_i.read_cache_isize)
  79 #define NFS_NEXTSCAN(inode)             ((inode)->u.nfs_i.nextscan)
  80 #define NFS_CACHEINV(inode) \
  81 do { \
  82         NFS_READTIME(inode) = jiffies - NFS_MAXATTRTIMEO(inode) - 1; \
  83 } while (0)
  84 #define NFS_ATTRTIMEO(inode)            ((inode)->u.nfs_i.attrtimeo)
  85 #define NFS_MINATTRTIMEO(inode) \
  86         (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
  87                                : NFS_SERVER(inode)->acregmin)
  88 #define NFS_MAXATTRTIMEO(inode) \
  89         (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
  90                                : NFS_SERVER(inode)->acregmax)
  91 #define NFS_ATTRTIMEO_UPDATE(inode)     ((inode)->u.nfs_i.attrtimeo_timestamp)
  92
  93 #define NFS_FLAGS(inode)                ((inode)->u.nfs_i.flags)
  94 #define NFS_REVALIDATING(inode)         (NFS_FLAGS(inode) & NFS_INO_REVALIDATING)
  95
  96 #define NFS_FILEID(inode)               ((inode)->u.nfs_i.fileid)
  97 #define NFS_FSID(inode)                 ((inode)->u.nfs_i.fsid)
  98
  99 /* Inode Flags */
 100 #define NFS_USE_READDIRPLUS(inode)      ((NFS_FLAGS(inode) & NFS_INO_ADVISE_RDPLUS) ? 1 : 0)
 101
 102 /*
 103  * These are the default flags for swap requests
 104  */
 105 #define NFS_RPC_SWAPFLAGS               (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
 106
 107 /* Flags in the RPC client structure */
 108 #define NFS_CLNTF_BUFSIZE       0x0001  /* readdir buffer in longwords */
 109
 110 #define NFS_RW_SYNC             0x0001  /* O_SYNC handling */
 111 #define NFS_RW_SWAP             0x0002  /* This is a swap request */
 112
 113 /*
 114  * When flushing a cluster of dirty pages, there can be different
 115  * strategies:
 116  */
 117 #define FLUSH_AGING             0       /* only flush old buffers */
 118 #define FLUSH_SYNC              1       /* file being synced, or contention */
 119 #define FLUSH_WAIT              2       /* wait for completion */
 120 #define FLUSH_STABLE            4       /* commit to stable storage */
 121
 122 static inline
 123 loff_t page_offset(struct page *page)
 124 {
 125         return ((loff_t)page->index) << PAGE_CACHE_SHIFT;
 126 }
 127
 128 static inline
 129 unsigned long page_index(struct page *page)
 130 {
 131         return page->index;
 132 }
 133
 134 #ifdef __KERNEL__
 135 /*
 136  * linux/fs/nfs/inode.c
 137  */
 138 extern struct super_block *nfs_read_super(struct super_block *, void *, int);
 139 extern int init_nfs_fs(void);
 140 extern void nfs_zap_caches(struct inode *);
 141 extern struct inode *nfs_fhget(struct dentry *, struct nfs_fh *,
 142                                 struct nfs_fattr *);
 143 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
 144 extern int nfs_revalidate(struct dentry *);
 145 extern int nfs_permission(struct inode *, int);
 146 extern int nfs_open(struct inode *, struct file *);
 147 extern int nfs_release(struct inode *, struct file *);
 148 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
 149 extern int nfs_notify_change(struct dentry *, struct iattr *);
 150
 151 /*
 152  * linux/fs/nfs/file.c
 153  */
 154 extern struct inode_operations nfs_file_inode_operations;
 155 extern struct file_operations nfs_file_operations;
 156 extern struct address_space_operations nfs_file_aops;
 157
 158 static __inline__ struct rpc_cred *
 159 nfs_file_cred(struct file *file)
 160 {
 161         struct rpc_cred *cred = (struct rpc_cred *)(file->private_data);
 162 #ifdef RPC_DEBUG
 163         if (cred && cred->cr_magic != RPCAUTH_CRED_MAGIC)
 164                 BUG();
 165 #endif
 166         return cred;
 167 }
 168
 169 /*
 170  * linux/fs/nfs/dir.c
 171  */
 172 extern struct inode_operations nfs_dir_inode_operations;
 173 extern struct file_operations nfs_dir_operations;
 174 extern struct dentry_operations nfs_dentry_operations;
 175
 176 /*
 177  * linux/fs/nfs/symlink.c
 178  */
 179 extern struct inode_operations nfs_symlink_inode_operations;
 180
 181 /*
 182  * linux/fs/nfs/locks.c
 183  */
 184 extern int nfs_lock(struct file *, int, struct file_lock *);
 185
 186 /*
 187  * linux/fs/nfs/unlink.c
 188  */
 189 extern int  nfs_async_unlink(struct dentry *);
 190 extern void nfs_complete_unlink(struct dentry *);
 191
 192 /*
 193  * linux/fs/nfs/write.c
 194  */
 195 extern int  nfs_writepage(struct page *);
 196 extern int  nfs_flush_incompatible(struct file *file, struct page *page);
 197 extern int  nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
 198 /*
 199  * Try to write back everything synchronously (but check the
 200  * return value!)
 201  */
 202 extern int  nfs_sync_file(struct inode *, struct file *, unsigned long, unsigned int, int);
 203 extern int  nfs_flush_file(struct inode *, struct file *, unsigned long, unsigned int, int);
 204 extern int  nfs_flush_timeout(struct inode *, int);
 205 #ifdef CONFIG_NFS_V3
 206 extern int  nfs_commit_file(struct inode *, struct file *, unsigned long, unsigned int, int);
 207 extern int  nfs_commit_timeout(struct inode *, int);
 208 #endif
 209
 210 static inline int
 211 nfs_have_read(struct inode *inode)
 212 {
 213         return !list_empty(&inode->u.nfs_i.read);
 214 }
 215
 216 static inline int
 217 nfs_have_writebacks(struct inode *inode)
 218 {
 219         return !list_empty(&inode->u.nfs_i.writeback);
 220 }
 221
 222 static inline int
 223 nfs_wb_all(struct inode *inode)
 224 {
 225         int error = nfs_sync_file(inode, 0, 0, 0, FLUSH_WAIT);
 226         return (error < 0) ? error : 0;
 227 }
 228
 229 /*
 230  * Write back all requests on one page - we do this before reading it.
 231  */
 232 static inline int
 233 nfs_wb_page(struct inode *inode, struct page* page)
 234 {
 235         int error = nfs_sync_file(inode, 0, page_index(page), 1, FLUSH_WAIT | FLUSH_STABLE);
 236         return (error < 0) ? error : 0;
 237 }
 238
 239 /*
 240  * Write back all pending writes for one user..
 241  */
 242 static inline int
 243 nfs_wb_file(struct inode *inode, struct file *file)
 244 {
 245         int error = nfs_sync_file(inode, file, 0, 0, FLUSH_WAIT);
 246         return (error < 0) ? error : 0;
 247 }
 248
 249 /*
 250  * linux/fs/nfs/read.c
 251  */
 252 extern int  nfs_readpage(struct file *, struct page *);
 253 extern int  nfs_pagein_inode(struct inode *, unsigned long, unsigned int);
 254 extern int  nfs_pagein_timeout(struct inode *);
 255
 256 /*
 257  * linux/fs/mount_clnt.c
 258  * (Used only by nfsroot module)
 259  */
 260 extern int  nfs_mount(struct sockaddr_in *, char *, struct nfs_fh *);
 261 extern int  nfs3_mount(struct sockaddr_in *, char *, struct nfs_fh *);
 262
 263 /*
 264  * inline functions
 265  */
 266 static inline int
 267 nfs_revalidate_inode(struct nfs_server *server, struct inode *inode)
 268 {
 269         if (time_before(jiffies, NFS_READTIME(inode)+NFS_ATTRTIMEO(inode)))
 270                 return 0;
 271         return __nfs_revalidate_inode(server, inode);
 272 }
 273
 274 static inline loff_t
 275 nfs_size_to_loff_t(__u64 size)
 276 {
 277         loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
 278         if (size > maxsz)
 279                 return maxsz;
 280         return (loff_t) size;
 281 }
 282
 283 static inline ino_t
 284 nfs_fileid_to_ino_t(u64 fileid)
 285 {
 286         ino_t ino = (ino_t) fileid;
 287         if (sizeof(ino_t) < sizeof(u64))
 288                 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
 289         return ino;
 290 }
 291
 292 static inline time_t
 293 nfs_time_to_secs(__u64 time)
 294 {
 295         return (time_t)(time >> 32);
 296 }
 297
 298 /* NFS root */
 299
 300 extern void * nfs_root_data(void);
 301
 302 #define nfs_wait_event(clnt, wq, condition)                             \
 303 ({                                                                      \
 304         int __retval = 0;                                               \
 305         if (clnt->cl_intr) {                                            \
 306                 sigset_t oldmask;                                       \
 307                 rpc_clnt_sigmask(clnt, &oldmask);                       \
 308                 __retval = wait_event_interruptible(wq, condition);     \
 309                 rpc_clnt_sigunmask(clnt, &oldmask);                     \
 310         } else                                                          \
 311                 wait_event(wq, condition);                              \
 312         __retval;                                                       \
 313 })
 314
 315 #endif /* __KERNEL__ */
 316
 317 /*
 318  * NFS debug flags
 319  */
 320 #define NFSDBG_VFS              0x0001
 321 #define NFSDBG_DIRCACHE         0x0002
 322 #define NFSDBG_LOOKUPCACHE      0x0004
 323 #define NFSDBG_PAGECACHE        0x0008
 324 #define NFSDBG_PROC             0x0010
 325 #define NFSDBG_XDR              0x0020
 326 #define NFSDBG_FILE             0x0040
 327 #define NFSDBG_ROOT             0x0080
 328 #define NFSDBG_ALL              0xFFFF
 329
 330 #ifdef __KERNEL__
 331 # undef ifdebug
 332 # ifdef NFS_DEBUG
 333 #  define ifdebug(fac)          if (nfs_debug & NFSDBG_##fac)
 334 # else
 335 #  define ifdebug(fac)          if (0)
 336 # endif
 337 #endif /* __KERNEL */
 338
 339 #endif