flexfilelayout.h 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. /*
  3. * NFSv4 flexfile layout driver data structures.
  4. *
  5. * Copyright (c) 2014, Primary Data, Inc. All rights reserved.
  6. *
  7. * Tao Peng <bergwolf@primarydata.com>
  8. */
  9. #ifndef FS_NFS_NFS4FLEXFILELAYOUT_H
  10. #define FS_NFS_NFS4FLEXFILELAYOUT_H
  11. #define FF_FLAGS_NO_LAYOUTCOMMIT 1
  12. #define FF_FLAGS_NO_IO_THRU_MDS 2
  13. #define FF_FLAGS_NO_READ_IO 4
  14. #include <linux/refcount.h>
  15. #include "../pnfs.h"
  16. /* XXX: Let's filter out insanely large mirror count for now to avoid oom
  17. * due to network error etc. */
  18. #define NFS4_FLEXFILE_LAYOUT_MAX_MIRROR_CNT 4096
  19. /* LAYOUTSTATS report interval in ms */
  20. #define FF_LAYOUTSTATS_REPORT_INTERVAL (60000L)
  21. #define FF_LAYOUTSTATS_MAXDEV 4
  22. struct nfs4_ff_ds_version {
  23. u32 version;
  24. u32 minor_version;
  25. u32 rsize;
  26. u32 wsize;
  27. bool tightly_coupled;
  28. };
  29. /* chained in global deviceid hlist */
  30. struct nfs4_ff_layout_ds {
  31. struct nfs4_deviceid_node id_node;
  32. u32 ds_versions_cnt;
  33. struct nfs4_ff_ds_version *ds_versions;
  34. struct nfs4_pnfs_ds *ds;
  35. };
  36. struct nfs4_ff_layout_ds_err {
  37. struct list_head list; /* linked in mirror error_list */
  38. u64 offset;
  39. u64 length;
  40. int status;
  41. enum nfs_opnum4 opnum;
  42. nfs4_stateid stateid;
  43. struct nfs4_deviceid deviceid;
  44. };
  45. struct nfs4_ff_io_stat {
  46. __u64 ops_requested;
  47. __u64 bytes_requested;
  48. __u64 ops_completed;
  49. __u64 bytes_completed;
  50. __u64 bytes_not_delivered;
  51. ktime_t total_busy_time;
  52. ktime_t aggregate_completion_time;
  53. };
  54. struct nfs4_ff_busy_timer {
  55. ktime_t start_time;
  56. atomic_t n_ops;
  57. };
  58. struct nfs4_ff_layoutstat {
  59. struct nfs4_ff_io_stat io_stat;
  60. struct nfs4_ff_busy_timer busy_timer;
  61. };
  62. struct nfs4_ff_layout_mirror {
  63. struct pnfs_layout_hdr *layout;
  64. struct list_head mirrors;
  65. u32 ds_count;
  66. u32 efficiency;
  67. struct nfs4_deviceid devid;
  68. struct nfs4_ff_layout_ds *mirror_ds;
  69. u32 fh_versions_cnt;
  70. struct nfs_fh *fh_versions;
  71. nfs4_stateid stateid;
  72. struct rpc_cred __rcu *ro_cred;
  73. struct rpc_cred __rcu *rw_cred;
  74. refcount_t ref;
  75. spinlock_t lock;
  76. unsigned long flags;
  77. struct nfs4_ff_layoutstat read_stat;
  78. struct nfs4_ff_layoutstat write_stat;
  79. ktime_t start_time;
  80. u32 report_interval;
  81. };
  82. #define NFS4_FF_MIRROR_STAT_AVAIL (0)
  83. struct nfs4_ff_layout_segment {
  84. struct pnfs_layout_segment generic_hdr;
  85. u64 stripe_unit;
  86. u32 flags;
  87. u32 mirror_array_cnt;
  88. struct nfs4_ff_layout_mirror **mirror_array;
  89. };
  90. struct nfs4_flexfile_layout {
  91. struct pnfs_layout_hdr generic_hdr;
  92. struct pnfs_ds_commit_info commit_info;
  93. struct list_head mirrors;
  94. struct list_head error_list; /* nfs4_ff_layout_ds_err */
  95. ktime_t last_report_time; /* Layoutstat report times */
  96. };
  97. struct nfs4_flexfile_layoutreturn_args {
  98. struct list_head errors;
  99. struct nfs42_layoutstat_devinfo devinfo[FF_LAYOUTSTATS_MAXDEV];
  100. unsigned int num_errors;
  101. unsigned int num_dev;
  102. struct page *pages[1];
  103. };
  104. static inline struct nfs4_flexfile_layout *
  105. FF_LAYOUT_FROM_HDR(struct pnfs_layout_hdr *lo)
  106. {
  107. return container_of(lo, struct nfs4_flexfile_layout, generic_hdr);
  108. }
  109. static inline struct nfs4_ff_layout_segment *
  110. FF_LAYOUT_LSEG(struct pnfs_layout_segment *lseg)
  111. {
  112. return container_of(lseg,
  113. struct nfs4_ff_layout_segment,
  114. generic_hdr);
  115. }
  116. static inline struct nfs4_ff_layout_ds *
  117. FF_LAYOUT_MIRROR_DS(struct nfs4_deviceid_node *node)
  118. {
  119. return container_of(node, struct nfs4_ff_layout_ds, id_node);
  120. }
  121. static inline struct nfs4_ff_layout_mirror *
  122. FF_LAYOUT_COMP(struct pnfs_layout_segment *lseg, u32 idx)
  123. {
  124. struct nfs4_ff_layout_segment *fls = FF_LAYOUT_LSEG(lseg);
  125. if (idx < fls->mirror_array_cnt)
  126. return fls->mirror_array[idx];
  127. return NULL;
  128. }
  129. static inline struct nfs4_deviceid_node *
  130. FF_LAYOUT_DEVID_NODE(struct pnfs_layout_segment *lseg, u32 idx)
  131. {
  132. struct nfs4_ff_layout_mirror *mirror = FF_LAYOUT_COMP(lseg, idx);
  133. if (mirror != NULL) {
  134. struct nfs4_ff_layout_ds *mirror_ds = mirror->mirror_ds;
  135. if (!IS_ERR_OR_NULL(mirror_ds))
  136. return &mirror_ds->id_node;
  137. }
  138. return NULL;
  139. }
  140. static inline u32
  141. FF_LAYOUT_MIRROR_COUNT(struct pnfs_layout_segment *lseg)
  142. {
  143. return FF_LAYOUT_LSEG(lseg)->mirror_array_cnt;
  144. }
  145. static inline bool
  146. ff_layout_no_fallback_to_mds(struct pnfs_layout_segment *lseg)
  147. {
  148. return FF_LAYOUT_LSEG(lseg)->flags & FF_FLAGS_NO_IO_THRU_MDS;
  149. }
  150. static inline bool
  151. ff_layout_no_read_on_rw(struct pnfs_layout_segment *lseg)
  152. {
  153. return FF_LAYOUT_LSEG(lseg)->flags & FF_FLAGS_NO_READ_IO;
  154. }
  155. static inline bool
  156. ff_layout_test_devid_unavailable(struct nfs4_deviceid_node *node)
  157. {
  158. /*
  159. * Flexfiles should never mark a DS unavailable, but if it does
  160. * print a (ratelimited) warning as this can affect performance.
  161. */
  162. if (nfs4_test_deviceid_unavailable(node)) {
  163. u32 *p = (u32 *)node->deviceid.data;
  164. pr_warn_ratelimited("NFS: flexfiles layout referencing an "
  165. "unavailable device [%x%x%x%x]\n",
  166. p[0], p[1], p[2], p[3]);
  167. return true;
  168. }
  169. return false;
  170. }
  171. static inline int
  172. nfs4_ff_layout_ds_version(struct pnfs_layout_segment *lseg, u32 ds_idx)
  173. {
  174. return FF_LAYOUT_COMP(lseg, ds_idx)->mirror_ds->ds_versions[0].version;
  175. }
  176. struct nfs4_ff_layout_ds *
  177. nfs4_ff_alloc_deviceid_node(struct nfs_server *server, struct pnfs_device *pdev,
  178. gfp_t gfp_flags);
  179. void nfs4_ff_layout_put_deviceid(struct nfs4_ff_layout_ds *mirror_ds);
  180. void nfs4_ff_layout_free_deviceid(struct nfs4_ff_layout_ds *mirror_ds);
  181. int ff_layout_track_ds_error(struct nfs4_flexfile_layout *flo,
  182. struct nfs4_ff_layout_mirror *mirror, u64 offset,
  183. u64 length, int status, enum nfs_opnum4 opnum,
  184. gfp_t gfp_flags);
  185. int ff_layout_encode_ds_ioerr(struct xdr_stream *xdr, const struct list_head *head);
  186. void ff_layout_free_ds_ioerr(struct list_head *head);
  187. unsigned int ff_layout_fetch_ds_ioerr(struct pnfs_layout_hdr *lo,
  188. const struct pnfs_layout_range *range,
  189. struct list_head *head,
  190. unsigned int maxnum);
  191. struct nfs_fh *
  192. nfs4_ff_layout_select_ds_fh(struct pnfs_layout_segment *lseg, u32 mirror_idx);
  193. int
  194. nfs4_ff_layout_select_ds_stateid(struct pnfs_layout_segment *lseg,
  195. u32 mirror_idx,
  196. nfs4_stateid *stateid);
  197. struct nfs4_pnfs_ds *
  198. nfs4_ff_layout_prepare_ds(struct pnfs_layout_segment *lseg, u32 ds_idx,
  199. bool fail_return);
  200. struct rpc_clnt *
  201. nfs4_ff_find_or_create_ds_client(struct pnfs_layout_segment *lseg,
  202. u32 ds_idx,
  203. struct nfs_client *ds_clp,
  204. struct inode *inode);
  205. struct rpc_cred *ff_layout_get_ds_cred(struct pnfs_layout_segment *lseg,
  206. u32 ds_idx, struct rpc_cred *mdscred);
  207. bool ff_layout_avoid_mds_available_ds(struct pnfs_layout_segment *lseg);
  208. bool ff_layout_avoid_read_on_rw(struct pnfs_layout_segment *lseg);
  209. #endif /* FS_NFS_NFS4FLEXFILELAYOUT_H */