nfs_page.h 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155
  1. /*
  2. * linux/include/linux/nfs_page.h
  3. *
  4. * Copyright (C) 2000 Trond Myklebust
  5. *
  6. * NFS page cache wrapper.
  7. */
  8. #ifndef _LINUX_NFS_PAGE_H
  9. #define _LINUX_NFS_PAGE_H
  10. #include <linux/list.h>
  11. #include <linux/pagemap.h>
  12. #include <linux/wait.h>
  13. #include <linux/sunrpc/auth.h>
  14. #include <linux/nfs_xdr.h>
  15. #include <linux/kref.h>
  16. /*
  17. * Valid flags for a dirty buffer
  18. */
  19. enum {
  20. PG_BUSY = 0,
  21. PG_MAPPED,
  22. PG_CLEAN,
  23. PG_NEED_COMMIT,
  24. PG_NEED_RESCHED,
  25. PG_PARTIAL_READ_FAILED,
  26. PG_COMMIT_TO_DS,
  27. };
  28. struct nfs_inode;
  29. struct nfs_page {
  30. struct list_head wb_list; /* Defines state of page: */
  31. struct page *wb_page; /* page to read in/write out */
  32. struct nfs_open_context *wb_context; /* File state context info */
  33. struct nfs_lock_context *wb_lock_context; /* lock context info */
  34. atomic_t wb_complete; /* i/os we're waiting for */
  35. pgoff_t wb_index; /* Offset >> PAGE_CACHE_SHIFT */
  36. unsigned int wb_offset, /* Offset & ~PAGE_CACHE_MASK */
  37. wb_pgbase, /* Start of page data */
  38. wb_bytes; /* Length of request */
  39. struct kref wb_kref; /* reference count */
  40. unsigned long wb_flags;
  41. struct nfs_writeverf wb_verf; /* Commit cookie */
  42. };
  43. struct nfs_pageio_descriptor;
  44. struct nfs_pageio_ops {
  45. void (*pg_init)(struct nfs_pageio_descriptor *, struct nfs_page *);
  46. bool (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *);
  47. int (*pg_doio)(struct nfs_pageio_descriptor *);
  48. };
  49. struct nfs_pageio_descriptor {
  50. struct list_head pg_list;
  51. unsigned long pg_bytes_written;
  52. size_t pg_count;
  53. size_t pg_bsize;
  54. unsigned int pg_base;
  55. unsigned char pg_moreio : 1,
  56. pg_recoalesce : 1;
  57. struct inode *pg_inode;
  58. const struct nfs_pageio_ops *pg_ops;
  59. int pg_ioflags;
  60. int pg_error;
  61. const struct rpc_call_ops *pg_rpc_callops;
  62. struct pnfs_layout_segment *pg_lseg;
  63. };
  64. #define NFS_WBACK_BUSY(req) (test_bit(PG_BUSY,&(req)->wb_flags))
  65. extern struct nfs_page *nfs_create_request(struct nfs_open_context *ctx,
  66. struct inode *inode,
  67. struct page *page,
  68. unsigned int offset,
  69. unsigned int count);
  70. extern void nfs_release_request(struct nfs_page *req);
  71. extern void nfs_pageio_init(struct nfs_pageio_descriptor *desc,
  72. struct inode *inode,
  73. const struct nfs_pageio_ops *pg_ops,
  74. size_t bsize,
  75. int how);
  76. extern int nfs_pageio_add_request(struct nfs_pageio_descriptor *,
  77. struct nfs_page *);
  78. extern void nfs_pageio_complete(struct nfs_pageio_descriptor *desc);
  79. extern void nfs_pageio_cond_complete(struct nfs_pageio_descriptor *, pgoff_t);
  80. extern bool nfs_generic_pg_test(struct nfs_pageio_descriptor *desc,
  81. struct nfs_page *prev,
  82. struct nfs_page *req);
  83. extern int nfs_wait_on_request(struct nfs_page *);
  84. extern void nfs_unlock_request(struct nfs_page *req);
  85. /*
  86. * Lock the page of an asynchronous request without getting a new reference
  87. */
  88. static inline int
  89. nfs_lock_request_dontget(struct nfs_page *req)
  90. {
  91. return !test_and_set_bit(PG_BUSY, &req->wb_flags);
  92. }
  93. static inline int
  94. nfs_lock_request(struct nfs_page *req)
  95. {
  96. if (test_and_set_bit(PG_BUSY, &req->wb_flags))
  97. return 0;
  98. kref_get(&req->wb_kref);
  99. return 1;
  100. }
  101. /**
  102. * nfs_list_add_request - Insert a request into a list
  103. * @req: request
  104. * @head: head of list into which to insert the request.
  105. */
  106. static inline void
  107. nfs_list_add_request(struct nfs_page *req, struct list_head *head)
  108. {
  109. list_add_tail(&req->wb_list, head);
  110. }
  111. /**
  112. * nfs_list_remove_request - Remove a request from its wb_list
  113. * @req: request
  114. */
  115. static inline void
  116. nfs_list_remove_request(struct nfs_page *req)
  117. {
  118. if (list_empty(&req->wb_list))
  119. return;
  120. list_del_init(&req->wb_list);
  121. }
  122. static inline struct nfs_page *
  123. nfs_list_entry(struct list_head *head)
  124. {
  125. return list_entry(head, struct nfs_page, wb_list);
  126. }
  127. static inline
  128. loff_t req_offset(struct nfs_page *req)
  129. {
  130. return (((loff_t)req->wb_index) << PAGE_CACHE_SHIFT) + req->wb_offset;
  131. }
  132. #endif /* _LINUX_NFS_PAGE_H */