objlayout.h 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. /*
  2. * Data types and function declerations for interfacing with the
  3. * pNFS standard object layout driver.
  4. *
  5. * Copyright (C) 2007 Panasas Inc. [year of first publication]
  6. * All rights reserved.
  7. *
  8. * Benny Halevy <bhalevy@panasas.com>
  9. * Boaz Harrosh <bharrosh@panasas.com>
  10. *
  11. * This program is free software; you can redistribute it and/or modify
  12. * it under the terms of the GNU General Public License version 2
  13. * See the file COPYING included with this distribution for more details.
  14. *
  15. * Redistribution and use in source and binary forms, with or without
  16. * modification, are permitted provided that the following conditions
  17. * are met:
  18. *
  19. * 1. Redistributions of source code must retain the above copyright
  20. * notice, this list of conditions and the following disclaimer.
  21. * 2. Redistributions in binary form must reproduce the above copyright
  22. * notice, this list of conditions and the following disclaimer in the
  23. * documentation and/or other materials provided with the distribution.
  24. * 3. Neither the name of the Panasas company nor the names of its
  25. * contributors may be used to endorse or promote products derived
  26. * from this software without specific prior written permission.
  27. *
  28. * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  29. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  30. * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  31. * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  32. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  34. * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  35. * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  36. * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  37. * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  38. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  39. */
  40. #ifndef _OBJLAYOUT_H
  41. #define _OBJLAYOUT_H
  42. #include <linux/nfs_fs.h>
  43. #include <linux/pnfs_osd_xdr.h>
  44. #include "../pnfs.h"
  45. /*
  46. * per-inode layout
  47. */
  48. struct objlayout {
  49. struct pnfs_layout_hdr pnfs_layout;
  50. /* for layout_return */
  51. spinlock_t lock;
  52. struct list_head err_list;
  53. };
  54. static inline struct objlayout *
  55. OBJLAYOUT(struct pnfs_layout_hdr *lo)
  56. {
  57. return container_of(lo, struct objlayout, pnfs_layout);
  58. }
  59. /*
  60. * per-I/O operation state
  61. * embedded in objects provider io_state data structure
  62. */
  63. struct objlayout_io_state {
  64. struct pnfs_layout_segment *lseg;
  65. struct page **pages;
  66. unsigned pgbase;
  67. unsigned nr_pages;
  68. unsigned long count;
  69. loff_t offset;
  70. bool sync;
  71. void *rpcdata;
  72. int status; /* res */
  73. int eof; /* res */
  74. int committed; /* res */
  75. /* Error reporting (layout_return) */
  76. struct list_head err_list;
  77. unsigned num_comps;
  78. /* Pointer to array of error descriptors of size num_comps.
  79. * It should contain as many entries as devices in the osd_layout
  80. * that participate in the I/O. It is up to the io_engine to allocate
  81. * needed space and set num_comps.
  82. */
  83. struct pnfs_osd_ioerr *ioerrs;
  84. };
  85. /*
  86. * Raid engine I/O API
  87. */
  88. extern int objio_alloc_lseg(struct pnfs_layout_segment **outp,
  89. struct pnfs_layout_hdr *pnfslay,
  90. struct pnfs_layout_range *range,
  91. struct xdr_stream *xdr,
  92. gfp_t gfp_flags);
  93. extern void objio_free_lseg(struct pnfs_layout_segment *lseg);
  94. extern int objio_alloc_io_state(
  95. struct pnfs_layout_segment *lseg,
  96. struct objlayout_io_state **outp,
  97. gfp_t gfp_flags);
  98. extern void objio_free_io_state(struct objlayout_io_state *state);
  99. extern ssize_t objio_read_pagelist(struct objlayout_io_state *ol_state);
  100. extern ssize_t objio_write_pagelist(struct objlayout_io_state *ol_state,
  101. bool stable);
  102. /*
  103. * callback API
  104. */
  105. extern void objlayout_io_set_result(struct objlayout_io_state *state,
  106. unsigned index, struct pnfs_osd_objid *pooid,
  107. int osd_error, u64 offset, u64 length, bool is_write);
  108. extern void objlayout_read_done(struct objlayout_io_state *state,
  109. ssize_t status, bool sync);
  110. extern void objlayout_write_done(struct objlayout_io_state *state,
  111. ssize_t status, bool sync);
  112. extern int objlayout_get_deviceinfo(struct pnfs_layout_hdr *pnfslay,
  113. struct nfs4_deviceid *d_id, struct pnfs_osd_deviceaddr **deviceaddr,
  114. gfp_t gfp_flags);
  115. extern void objlayout_put_deviceinfo(struct pnfs_osd_deviceaddr *deviceaddr);
  116. /*
  117. * exported generic objects function vectors
  118. */
  119. extern struct pnfs_layout_hdr *objlayout_alloc_layout_hdr(struct inode *, gfp_t gfp_flags);
  120. extern void objlayout_free_layout_hdr(struct pnfs_layout_hdr *);
  121. extern struct pnfs_layout_segment *objlayout_alloc_lseg(
  122. struct pnfs_layout_hdr *,
  123. struct nfs4_layoutget_res *,
  124. gfp_t gfp_flags);
  125. extern void objlayout_free_lseg(struct pnfs_layout_segment *);
  126. extern enum pnfs_try_status objlayout_read_pagelist(
  127. struct nfs_read_data *);
  128. extern enum pnfs_try_status objlayout_write_pagelist(
  129. struct nfs_write_data *,
  130. int how);
  131. extern void objlayout_encode_layoutreturn(
  132. struct pnfs_layout_hdr *,
  133. struct xdr_stream *,
  134. const struct nfs4_layoutreturn_args *);
  135. #endif /* _OBJLAYOUT_H */