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