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/wait.h>
  17 #include <linux/uio.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_page.h>
  30 #include <linux/nfs_xdr.h>
  31
  32 /*
  33  * Enable debugging support for nfs client.
  34  * Requires RPC_DEBUG.
  35  */
  36 #ifdef RPC_DEBUG
  37 # define NFS_DEBUG
  38 #endif
  39
  40 #define NFS_MAX_FILE_IO_BUFFER_SIZE     32768
  41 #define NFS_DEF_FILE_IO_BUFFER_SIZE     4096
  42
  43 /*
  44  * The upper limit on timeouts for the exponential backoff algorithm.
  45  */
  46 #define NFS_WRITEBACK_DELAY             (5*HZ)
  47 #define NFS_WRITEBACK_LOCKDELAY         (60*HZ)
  48 #define NFS_COMMIT_DELAY                (5*HZ)
  49
  50 /*
  51  * superblock magic number for NFS
  52  */
  53 #define NFS_SUPER_MAGIC                 0x6969
  54
  55 /*
  56  * These are the default flags for swap requests
  57  */
  58 #define NFS_RPC_SWAPFLAGS               (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
  59
  60 #define NFS_RW_SYNC             0x0001  /* O_SYNC handling */
  61 #define NFS_RW_SWAP             0x0002  /* This is a swap request */
  62
  63 /*
  64  * When flushing a cluster of dirty pages, there can be different
  65  * strategies:
  66  */
  67 #define FLUSH_AGING             0       /* only flush old buffers */
  68 #define FLUSH_SYNC              1       /* file being synced, or contention */
  69 #define FLUSH_WAIT              2       /* wait for completion */
  70 #define FLUSH_STABLE            4       /* commit to stable storage */
  71
  72 #ifdef __KERNEL__
  73
  74 /*
  75  * NFSv3 Access mode cache
  76  */
  77 struct nfs_access_cache {
  78         unsigned long           jiffies;
  79         struct rpc_cred *       cred;
  80         int                     mask;
  81         int                     err;
  82 };
  83
  84 /*
  85  * nfs fs inode data in memory
  86  */
  87 struct nfs_inode {
  88         /*
  89          * The 64bit 'inode number'
  90          */
  91         __u64 fileid;
  92
  93         /*
  94          * NFS file handle
  95          */
  96         struct nfs_fh           fh;
  97
  98         /*
  99          * Various flags
 100          */
 101         unsigned short          flags;
 102
 103         /*
 104          * read_cache_jiffies is when we started read-caching this inode,
 105          * and read_cache_mtime is the mtime of the inode at that time.
 106          * attrtimeo is for how long the cached information is assumed
 107          * to be valid. A successful attribute revalidation doubles
 108          * attrtimeo (up to acregmax/acdirmax), a failure resets it to
 109          * acregmin/acdirmin.
 110          *
 111          * We need to revalidate the cached attrs for this inode if
 112          *
 113          *      jiffies - read_cache_jiffies > attrtimeo
 114          *
 115          * and invalidate any cached data/flush out any dirty pages if
 116          * we find that
 117          *
 118          *      mtime != read_cache_mtime
 119          */
 120         unsigned long           read_cache_jiffies;
 121         struct timespec         read_cache_ctime;
 122         struct timespec         read_cache_mtime;
 123         __u64                   read_cache_isize;
 124         unsigned long           attrtimeo;
 125         unsigned long           attrtimeo_timestamp;
 126         __u64                   change_attr;            /* v4 only */
 127
 128         /*
 129          * Timestamp that dates the change made to read_cache_mtime.
 130          * This is of use for dentry revalidation
 131          */
 132         unsigned long           cache_mtime_jiffies;
 133
 134         struct nfs_access_cache cache_access;
 135
 136         /*
 137          * This is the cookie verifier used for NFSv3 readdir
 138          * operations
 139          */
 140         __u32                   cookieverf[2];
 141
 142         /*
 143          * This is the list of dirty unwritten pages.
 144          */
 145         struct list_head        dirty;
 146         struct list_head        commit;
 147         struct radix_tree_root  nfs_page_tree;
 148
 149         unsigned int            ndirty,
 150                                 ncommit,
 151                                 npages;
 152
 153         /* Credentials for shared mmap */
 154         struct rpc_cred         *mm_cred;
 155
 156         wait_queue_head_t       nfs_i_wait;
 157
 158 #ifdef CONFIG_NFS_V4
 159         /* NFSv4 state */
 160         struct nfs4_shareowner   *ro_owner;
 161         struct nfs4_shareowner   *wo_owner;
 162         struct nfs4_shareowner   *rw_owner;
 163 #endif /* CONFIG_NFS_V4*/
 164
 165         struct inode            vfs_inode;
 166 };
 167
 168 /*
 169  * Legal inode flag values
 170  */
 171 #define NFS_INO_STALE           0x0001          /* possible stale inode */
 172 #define NFS_INO_ADVISE_RDPLUS   0x0002          /* advise readdirplus */
 173 #define NFS_INO_REVALIDATING    0x0004          /* revalidating attrs */
 174 #define NFS_INO_FLUSH           0x0008          /* inode is due for flushing */
 175 #define NFS_INO_FAKE_ROOT       0x0080          /* root inode placeholder */
 176
 177 static inline struct nfs_inode *NFS_I(struct inode *inode)
 178 {
 179         return container_of(inode, struct nfs_inode, vfs_inode);
 180 }
 181 #define NFS_SB(s)               ((struct nfs_server *)(s->s_fs_info))
 182
 183 #define NFS_FH(inode)                   (&NFS_I(inode)->fh)
 184 #define NFS_SERVER(inode)               (NFS_SB(inode->i_sb))
 185 #define NFS_CLIENT(inode)               (NFS_SERVER(inode)->client)
 186 #define NFS_PROTO(inode)                (NFS_SERVER(inode)->rpc_ops)
 187 #define NFS_ADDR(inode)                 (RPC_PEERADDR(NFS_CLIENT(inode)))
 188 #define NFS_COOKIEVERF(inode)           (NFS_I(inode)->cookieverf)
 189 #define NFS_READTIME(inode)             (NFS_I(inode)->read_cache_jiffies)
 190 #define NFS_MTIME_UPDATE(inode)         (NFS_I(inode)->cache_mtime_jiffies)
 191 #define NFS_CACHE_CTIME(inode)          (NFS_I(inode)->read_cache_ctime)
 192 #define NFS_CACHE_MTIME(inode)          (NFS_I(inode)->read_cache_mtime)
 193 #define NFS_CACHE_ISIZE(inode)          (NFS_I(inode)->read_cache_isize)
 194 #define NFS_CHANGE_ATTR(inode)          (NFS_I(inode)->change_attr)
 195 #define NFS_CACHEINV(inode) \
 196 do { \
 197         NFS_READTIME(inode) = jiffies - NFS_MAXATTRTIMEO(inode) - 1; \
 198 } while (0)
 199 #define NFS_ATTRTIMEO(inode)            (NFS_I(inode)->attrtimeo)
 200 #define NFS_MINATTRTIMEO(inode) \
 201         (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
 202                                : NFS_SERVER(inode)->acregmin)
 203 #define NFS_MAXATTRTIMEO(inode) \
 204         (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
 205                                : NFS_SERVER(inode)->acregmax)
 206 #define NFS_ATTRTIMEO_UPDATE(inode)     (NFS_I(inode)->attrtimeo_timestamp)
 207
 208 #define NFS_FLAGS(inode)                (NFS_I(inode)->flags)
 209 #define NFS_REVALIDATING(inode)         (NFS_FLAGS(inode) & NFS_INO_REVALIDATING)
 210 #define NFS_STALE(inode)                (NFS_FLAGS(inode) & NFS_INO_STALE)
 211 #define NFS_FAKE_ROOT(inode)            (NFS_FLAGS(inode) & NFS_INO_FAKE_ROOT)
 212
 213 #define NFS_FILEID(inode)               (NFS_I(inode)->fileid)
 214
 215 static inline int nfs_server_capable(struct inode *inode, int cap)
 216 {
 217         return NFS_SERVER(inode)->caps & cap;
 218 }
 219
 220 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
 221 {
 222         return NFS_FLAGS(inode) & NFS_INO_ADVISE_RDPLUS;
 223 }
 224
 225 static inline
 226 loff_t page_offset(struct page *page)
 227 {
 228         return ((loff_t)page->index) << PAGE_CACHE_SHIFT;
 229 }
 230
 231 static inline
 232 loff_t req_offset(struct nfs_page *req)
 233 {
 234         return (((loff_t)req->wb_index) << PAGE_CACHE_SHIFT) + req->wb_offset;
 235 }
 236
 237 /*
 238  * linux/fs/nfs/inode.c
 239  */
 240 extern void nfs_zap_caches(struct inode *);
 241 extern struct inode *nfs_fhget(struct dentry *, struct nfs_fh *,
 242                                 struct nfs_fattr *);
 243 extern int __nfs_refresh_inode(struct inode *, struct nfs_fattr *);
 244 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
 245 extern int nfs_permission(struct inode *, int, struct nameidata *);
 246 extern int nfs_open(struct inode *, struct file *);
 247 extern int nfs_release(struct inode *, struct file *);
 248 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
 249 extern int nfs_setattr(struct dentry *, struct iattr *);
 250
 251 /*
 252  * linux/fs/nfs/file.c
 253  */
 254 extern struct inode_operations nfs_file_inode_operations;
 255 extern struct file_operations nfs_file_operations;
 256 extern struct address_space_operations nfs_file_aops;
 257
 258 static __inline__ struct rpc_cred *
 259 nfs_file_cred(struct file *file)
 260 {
 261         struct rpc_cred *cred = NULL;
 262         if (file)
 263                 cred = (struct rpc_cred *)file->private_data;
 264 #ifdef RPC_DEBUG
 265         if (cred && cred->cr_magic != RPCAUTH_CRED_MAGIC)
 266                 BUG();
 267 #endif
 268         return cred;
 269 }
 270
 271 /*
 272  * linux/fs/nfs/direct.c
 273  */
 274 extern int nfs_direct_IO(int, struct file *, const struct iovec *, loff_t,
 275                         unsigned long);
 276
 277 /*
 278  * linux/fs/nfs/dir.c
 279  */
 280 extern struct inode_operations nfs_dir_inode_operations;
 281 extern struct file_operations nfs_dir_operations;
 282 extern struct dentry_operations nfs_dentry_operations;
 283
 284 /*
 285  * linux/fs/nfs/symlink.c
 286  */
 287 extern struct inode_operations nfs_symlink_inode_operations;
 288
 289 /*
 290  * linux/fs/nfs/locks.c
 291  */
 292 extern int nfs_lock(struct file *, int, struct file_lock *);
 293
 294 /*
 295  * linux/fs/nfs/unlink.c
 296  */
 297 extern int  nfs_async_unlink(struct dentry *);
 298 extern void nfs_complete_unlink(struct dentry *);
 299
 300 /*
 301  * linux/fs/nfs/write.c
 302  */
 303 extern int  nfs_writepage(struct page *page, struct writeback_control *wbc);
 304 extern int  nfs_writepages(struct address_space *, struct writeback_control *);
 305 extern int  nfs_flush_incompatible(struct file *file, struct page *page);
 306 extern int  nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
 307 extern void nfs_writeback_done(struct rpc_task *task);
 308 extern void nfs_writedata_release(struct rpc_task *task);
 309
 310 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
 311 extern void nfs_commit_release(struct rpc_task *task);
 312 extern void nfs_commit_done(struct rpc_task *);
 313 #endif
 314
 315 /*
 316  * Try to write back everything synchronously (but check the
 317  * return value!)
 318  */
 319 extern int  nfs_sync_file(struct inode *, struct file *, unsigned long, unsigned int, int);
 320 extern int  nfs_flush_file(struct inode *, struct file *, unsigned long, unsigned int, int);
 321 extern int  nfs_flush_list(struct list_head *, int, int);
 322 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
 323 extern int  nfs_commit_file(struct inode *, struct file *, unsigned long, unsigned int, int);
 324 extern int  nfs_commit_list(struct list_head *, int);
 325 #else
 326 static inline int
 327 nfs_commit_file(struct inode *inode, struct file *file, unsigned long offset,
 328                 unsigned int len, int flags)
 329 {
 330         return 0;
 331 }
 332 #endif
 333
 334 static inline int
 335 nfs_have_writebacks(struct inode *inode)
 336 {
 337         return NFS_I(inode)->npages != 0;
 338 }
 339
 340 static inline int
 341 nfs_wb_all(struct inode *inode)
 342 {
 343         int error = nfs_sync_file(inode, 0, 0, 0, FLUSH_WAIT);
 344         return (error < 0) ? error : 0;
 345 }
 346
 347 /*
 348  * Write back all requests on one page - we do this before reading it.
 349  */
 350 static inline int
 351 nfs_wb_page(struct inode *inode, struct page* page)
 352 {
 353         int error = nfs_sync_file(inode, 0, page->index, 1,
 354                                                 FLUSH_WAIT | FLUSH_STABLE);
 355         return (error < 0) ? error : 0;
 356 }
 357
 358 /*
 359  * Write back all pending writes for one user..
 360  */
 361 static inline int
 362 nfs_wb_file(struct inode *inode, struct file *file)
 363 {
 364         int error = nfs_sync_file(inode, file, 0, 0, FLUSH_WAIT);
 365         return (error < 0) ? error : 0;
 366 }
 367
 368 /* Hack for future NFS swap support */
 369 #ifndef IS_SWAPFILE
 370 # define IS_SWAPFILE(inode)     (0)
 371 #endif
 372
 373 /*
 374  * linux/fs/nfs/read.c
 375  */
 376 extern int  nfs_readpage(struct file *, struct page *);
 377 extern int  nfs_readpages(struct file *, struct address_space *,
 378                 struct list_head *, unsigned);
 379 extern int  nfs_pagein_list(struct list_head *, int);
 380 extern void nfs_readpage_result(struct rpc_task *);
 381 extern void nfs_readdata_release(struct rpc_task *);
 382
 383 /*
 384  * linux/fs/mount_clnt.c
 385  * (Used only by nfsroot module)
 386  */
 387 extern int  nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
 388                 int, int);
 389
 390 /*
 391  * inline functions
 392  */
 393 static inline int
 394 nfs_revalidate_inode(struct nfs_server *server, struct inode *inode)
 395 {
 396         if (time_before(jiffies, NFS_READTIME(inode)+NFS_ATTRTIMEO(inode)))
 397                 return NFS_STALE(inode) ? -ESTALE : 0;
 398         return __nfs_revalidate_inode(server, inode);
 399 }
 400
 401 static inline int
 402 nfs_refresh_inode(struct inode *inode, struct nfs_fattr *fattr)
 403 {
 404         if ((fattr->valid & NFS_ATTR_FATTR) == 0)
 405                 return 0;
 406         return __nfs_refresh_inode(inode,fattr);
 407 }
 408
 409 static inline loff_t
 410 nfs_size_to_loff_t(__u64 size)
 411 {
 412         loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
 413         if (size > maxsz)
 414                 return maxsz;
 415         return (loff_t) size;
 416 }
 417
 418 static inline ino_t
 419 nfs_fileid_to_ino_t(u64 fileid)
 420 {
 421         ino_t ino = (ino_t) fileid;
 422         if (sizeof(ino_t) < sizeof(u64))
 423                 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
 424         return ino;
 425 }
 426
 427 /* NFS root */
 428
 429 extern void * nfs_root_data(void);
 430
 431 #define nfs_wait_event(clnt, wq, condition)                             \
 432 ({                                                                      \
 433         int __retval = 0;                                               \
 434         if (clnt->cl_intr) {                                            \
 435                 sigset_t oldmask;                                       \
 436                 rpc_clnt_sigmask(clnt, &oldmask);                       \
 437                 __retval = wait_event_interruptible(wq, condition);     \
 438                 rpc_clnt_sigunmask(clnt, &oldmask);                     \
 439         } else                                                          \
 440                 wait_event(wq, condition);                              \
 441         __retval;                                                       \
 442 })
 443
 444 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
 445
 446 #ifdef CONFIG_NFS_V4
 447
 448 /*
 449  * In a seqid-mutating op, this macro controls which error return
 450  * values trigger incrementation of the seqid.
 451  *
 452  * from rfc 3010:
 453  * The client MUST monotonically increment the sequence number for the
 454  * CLOSE, LOCK, LOCKU, OPEN, OPEN_CONFIRM, and OPEN_DOWNGRADE
 455  * operations.  This is true even in the event that the previous
 456  * operation that used the sequence number received an error.  The only
 457  * exception to this rule is if the previous operation received one of
 458  * the following errors: NFSERR_STALE_CLIENTID, NFSERR_STALE_STATEID,
 459  * NFSERR_BAD_STATEID, NFSERR_BAD_SEQID, NFSERR_BADXDR,
 460  * NFSERR_RESOURCE, NFSERR_NOFILEHANDLE.
 461  *
 462  */
 463 #define seqid_mutating_err(err)       \
 464 (((err) != NFSERR_STALE_CLIENTID) &&  \
 465  ((err) != NFSERR_STALE_STATEID)  &&  \
 466  ((err) != NFSERR_BAD_STATEID)    &&  \
 467  ((err) != NFSERR_BAD_SEQID)      &&  \
 468  ((err) != NFSERR_BAD_XDR)        &&  \
 469  ((err) != NFSERR_RESOURCE)       &&  \
 470  ((err) != NFSERR_NOFILEHANDLE))
 471
 472 struct nfs4_client {
 473         u64                     cl_clientid;    /* constant */
 474         nfs4_verifier           cl_confirm;
 475
 476         u32                     cl_lockowner_id;
 477 };
 478
 479 /*
 480 * The ->so_sema is held during all shareowner seqid-mutating operations:
 481 * OPEN, OPEN_DOWNGRADE, and CLOSE.
 482 * Its purpose is to properly serialize so_seqid, as mandated by
 483 * the protocol.
 484 */
 485 struct nfs4_shareowner {
 486         u32                  so_id;      /* 32-bit identifier, unique */
 487         struct semaphore     so_sema;
 488         u32                  so_seqid;   /* protected by so_sema */
 489         nfs4_stateid         so_stateid; /* protected by so_sema */
 490         unsigned int         so_flags;   /* protected by so_sema */
 491 };
 492
 493
 494 /* nfs4proc.c */
 495 extern int nfs4_proc_renew(struct nfs_server *server);
 496 extern int nfs4_do_close(struct inode *inode, struct nfs4_shareowner *sp);
 497
 498 /* nfs4renewd.c */
 499 extern int nfs4_init_renewd(struct nfs_server *server);
 500
 501 /* nfs4state.c */
 502 extern struct nfs4_client *nfs4_get_client(void);
 503 extern void nfs4_put_client(struct nfs4_client *clp);
 504 extern struct nfs4_shareowner * nfs4_get_shareowner(struct inode *inode);
 505 void nfs4_put_shareowner(struct inode *inode, struct nfs4_shareowner *sp);
 506 extern int nfs4_set_inode_share(struct inode * inode,
 507                      struct nfs4_shareowner *sp, unsigned int flags);
 508 extern void nfs4_increment_seqid(u32 status, struct nfs4_shareowner *sp);
 509 extern int nfs4_test_shareowner(struct inode *inode, unsigned int open_flags);
 510 struct nfs4_shareowner * nfs4_get_inode_share(struct inode * inode, unsigned int open_flags);
 511
 512
 513
 514
 515
 516
 517 struct nfs4_mount_data;
 518 static inline int
 519 create_nfsv4_state(struct nfs_server *server, struct nfs4_mount_data *data)
 520 {
 521         server->nfs4_state = NULL;
 522         return 0;
 523 }
 524
 525 static inline void
 526 destroy_nfsv4_state(struct nfs_server *server)
 527 {
 528         if (server->mnt_path) {
 529                 kfree(server->mnt_path);
 530                 server->mnt_path = NULL;
 531         }
 532         if (server->nfs4_state) {
 533                 nfs4_put_client(server->nfs4_state);
 534                 server->nfs4_state = NULL;
 535         }
 536 }
 537 #else
 538 #define create_nfsv4_state(server, data)  0
 539 #define destroy_nfsv4_state(server)       do { } while (0)
 540 #define nfs4_put_shareowner(inode, owner) do { } while (0)
 541 #endif
 542
 543 #endif /* __KERNEL__ */
 544
 545 /*
 546  * NFS debug flags
 547  */
 548 #define NFSDBG_VFS              0x0001
 549 #define NFSDBG_DIRCACHE         0x0002
 550 #define NFSDBG_LOOKUPCACHE      0x0004
 551 #define NFSDBG_PAGECACHE        0x0008
 552 #define NFSDBG_PROC             0x0010
 553 #define NFSDBG_XDR              0x0020
 554 #define NFSDBG_FILE             0x0040
 555 #define NFSDBG_ROOT             0x0080
 556 #define NFSDBG_ALL              0xFFFF
 557
 558 #ifdef __KERNEL__
 559 # undef ifdebug
 560 # ifdef NFS_DEBUG
 561 #  define ifdebug(fac)          if (nfs_debug & NFSDBG_##fac)
 562 # else
 563 #  define ifdebug(fac)          if (0)
 564 # endif
 565 #endif /* __KERNEL */
 566
 567 #endif