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