nfs_page.h 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  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_COMMIT_TO_DS,
  26. };
  27. struct nfs_inode;
  28. struct nfs_page {
  29. struct list_head wb_list; /* Defines state of page: */
  30. struct page *wb_page; /* page to read in/write out */
  31. struct nfs_open_context *wb_context; /* File state context info */
  32. struct nfs_lock_context *wb_lock_context; /* lock context info */
  33. pgoff_t wb_index; /* Offset >> PAGE_CACHE_SHIFT */
  34. unsigned int wb_offset, /* Offset & ~PAGE_CACHE_MASK */
  35. wb_pgbase, /* Start of page data */
  36. wb_bytes; /* Length of request */
  37. struct kref wb_kref; /* reference count */
  38. unsigned long wb_flags;
  39. struct nfs_write_verifier wb_verf; /* Commit cookie */
  40. };
  41. struct nfs_pageio_descriptor;
  42. struct nfs_pageio_ops {
  43. void (*pg_init)(struct nfs_pageio_descriptor *, struct nfs_page *);
  44. bool (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *);
  45. int (*pg_doio)(struct nfs_pageio_descriptor *);
  46. };
  47. struct nfs_rw_ops {
  48. const fmode_t rw_mode;
  49. struct nfs_rw_header *(*rw_alloc_header)(void);
  50. void (*rw_free_header)(struct nfs_rw_header *);
  51. void (*rw_release)(struct nfs_pgio_data *);
  52. int (*rw_done)(struct rpc_task *, struct nfs_pgio_data *, struct inode *);
  53. void (*rw_result)(struct rpc_task *, struct nfs_pgio_data *);
  54. void (*rw_initiate)(struct nfs_pgio_data *, struct rpc_message *,
  55. struct rpc_task_setup *, int);
  56. };
  57. struct nfs_pageio_descriptor {
  58. struct list_head pg_list;
  59. unsigned long pg_bytes_written;
  60. size_t pg_count;
  61. size_t pg_bsize;
  62. unsigned int pg_base;
  63. unsigned char pg_moreio : 1,
  64. pg_recoalesce : 1;
  65. struct inode *pg_inode;
  66. const struct nfs_pageio_ops *pg_ops;
  67. const struct nfs_rw_ops *pg_rw_ops;
  68. int pg_ioflags;
  69. int pg_error;
  70. const struct rpc_call_ops *pg_rpc_callops;
  71. const struct nfs_pgio_completion_ops *pg_completion_ops;
  72. struct pnfs_layout_segment *pg_lseg;
  73. struct nfs_direct_req *pg_dreq;
  74. void *pg_layout_private;
  75. };
  76. #define NFS_WBACK_BUSY(req) (test_bit(PG_BUSY,&(req)->wb_flags))
  77. extern struct nfs_page *nfs_create_request(struct nfs_open_context *ctx,
  78. struct inode *inode,
  79. struct page *page,
  80. unsigned int offset,
  81. unsigned int count);
  82. extern void nfs_release_request(struct nfs_page *req);
  83. extern void nfs_pageio_init(struct nfs_pageio_descriptor *desc,
  84. struct inode *inode,
  85. const struct nfs_pageio_ops *pg_ops,
  86. const struct nfs_pgio_completion_ops *compl_ops,
  87. const struct nfs_rw_ops *rw_ops,
  88. size_t bsize,
  89. int how);
  90. extern int nfs_pageio_add_request(struct nfs_pageio_descriptor *,
  91. struct nfs_page *);
  92. extern void nfs_pageio_complete(struct nfs_pageio_descriptor *desc);
  93. extern void nfs_pageio_cond_complete(struct nfs_pageio_descriptor *, pgoff_t);
  94. extern bool nfs_generic_pg_test(struct nfs_pageio_descriptor *desc,
  95. struct nfs_page *prev,
  96. struct nfs_page *req);
  97. extern int nfs_wait_on_request(struct nfs_page *);
  98. extern void nfs_unlock_request(struct nfs_page *req);
  99. extern void nfs_unlock_and_release_request(struct nfs_page *req);
  100. /*
  101. * Lock the page of an asynchronous request
  102. */
  103. static inline int
  104. nfs_lock_request(struct nfs_page *req)
  105. {
  106. return !test_and_set_bit(PG_BUSY, &req->wb_flags);
  107. }
  108. /**
  109. * nfs_list_add_request - Insert a request into a list
  110. * @req: request
  111. * @head: head of list into which to insert the request.
  112. */
  113. static inline void
  114. nfs_list_add_request(struct nfs_page *req, struct list_head *head)
  115. {
  116. list_add_tail(&req->wb_list, head);
  117. }
  118. /**
  119. * nfs_list_remove_request - Remove a request from its wb_list
  120. * @req: request
  121. */
  122. static inline void
  123. nfs_list_remove_request(struct nfs_page *req)
  124. {
  125. if (list_empty(&req->wb_list))
  126. return;
  127. list_del_init(&req->wb_list);
  128. }
  129. static inline struct nfs_page *
  130. nfs_list_entry(struct list_head *head)
  131. {
  132. return list_entry(head, struct nfs_page, wb_list);
  133. }
  134. static inline
  135. loff_t req_offset(struct nfs_page *req)
  136. {
  137. return (((loff_t)req->wb_index) << PAGE_CACHE_SHIFT) + req->wb_offset;
  138. }
  139. #endif /* _LINUX_NFS_PAGE_H */