]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - fs/nfs/pnfs.h
Merge tag 'dax-fixes-5.13-rc2' of git://git.kernel.org/pub/scm/linux/kernel/git/nvdim...
[mirror_ubuntu-jammy-kernel.git] / fs / nfs / pnfs.h
CommitLineData
85e174ba
RL
1/*
2 * pNFS client data structures.
3 *
4 * Copyright (c) 2002
5 * The Regents of the University of Michigan
6 * All Rights Reserved
7 *
8 * Dean Hildebrand <dhildebz@umich.edu>
9 *
10 * Permission is granted to use, copy, create derivative works, and
11 * redistribute this software and such derivative works for any purpose,
12 * so long as the name of the University of Michigan is not used in
13 * any advertising or publicity pertaining to the use or distribution
14 * of this software without specific, written prior authorization. If
15 * the above copyright notice or any other identification of the
16 * University of Michigan is included in any copy of any portion of
17 * this software, then the disclaimer below must also be included.
18 *
19 * This software is provided as is, without representation or warranty
20 * of any kind either express or implied, including without limitation
21 * the implied warranties of merchantability, fitness for a particular
22 * purpose, or noninfringement. The Regents of the University of
23 * Michigan shall not be liable for any damages, including special,
24 * indirect, incidental, or consequential damages, with respect to any
25 * claim arising out of or in connection with the use of the software,
26 * even if it has been or is hereafter advised of the possibility of
27 * such damages.
28 */
29
30#ifndef FS_NFS_PNFS_H
31#define FS_NFS_PNFS_H
32
a2a5dea7 33#include <linux/refcount.h>
45df3c8b 34#include <linux/nfs_fs.h>
94ad1c80 35#include <linux/nfs_page.h>
e6cf82d1 36#include <linux/workqueue.h>
94ad1c80 37
2409a976
FI
38struct nfs4_opendata;
39
4541d16c
FI
40enum {
41 NFS_LSEG_VALID = 0, /* cleared when lseg is recalled/returned */
f7e8917a 42 NFS_LSEG_ROC, /* roc bit received from server */
a9bae566 43 NFS_LSEG_LAYOUTCOMMIT, /* layoutcommit bit set for layoutcommit */
016256df 44 NFS_LSEG_LAYOUTRETURN, /* layoutreturn bit set for layoutreturn */
b3dce6a2 45 NFS_LSEG_UNAVAILABLE, /* unavailable bit set for temporary problem */
4541d16c
FI
46};
47
875ae069
PT
48/* Individual ip address */
49struct nfs4_pnfs_ds_addr {
50 struct sockaddr_storage da_addr;
51 size_t da_addrlen;
52 struct list_head da_node; /* nfs4_pnfs_dev_hlist dev_dslist */
53 char *da_remotestr; /* human readable addr+port */
4be78d26
TM
54 const char *da_netid;
55 int da_transport;
875ae069
PT
56};
57
58struct nfs4_pnfs_ds {
59 struct list_head ds_node; /* nfs4_pnfs_dev_hlist dev_dslist */
60 char *ds_remotestr; /* comma sep list of addrs */
61 struct list_head ds_addrs;
62 struct nfs_client *ds_clp;
a2a5dea7 63 refcount_t ds_count;
875ae069
PT
64 unsigned long ds_state;
65#define NFS4DS_CONNECTING 0 /* ds is establishing connection */
4541d16c
FI
66};
67
974cec8c 68struct pnfs_layout_segment {
566052c5 69 struct list_head pls_list;
a9bae566 70 struct list_head pls_lc_list;
a9901899 71 struct list_head pls_commits;
566052c5 72 struct pnfs_layout_range pls_range;
eba6dd69 73 refcount_t pls_refcount;
66755283 74 u32 pls_seq;
4541d16c 75 unsigned long pls_flags;
566052c5 76 struct pnfs_layout_hdr *pls_layout;
974cec8c
AA
77};
78
64419a9b
AA
79enum pnfs_try_status {
80 PNFS_ATTEMPTED = 0,
81 PNFS_NOT_ATTEMPTED = 1,
ceb11e13 82 PNFS_TRY_AGAIN = 2,
64419a9b
AA
83};
84
0722dc9f
TM
85/* error codes for internal use */
86#define NFS4ERR_RESET_TO_MDS 12001
87#define NFS4ERR_RESET_TO_PNFS 12002
88
85e174ba
RL
89#ifdef CONFIG_NFS_V4_1
90
91#define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
92
39280a5a
PT
93/*
94 * Default data server connection timeout and retrans vaules.
95 * Set by module parameters dataserver_timeo and dataserver_retrans.
96 */
97#define NFS4_DEF_DS_TIMEO 600 /* in tenths of a second */
98#define NFS4_DEF_DS_RETRANS 5
b3dce6a2 99#define PNFS_DEVICE_RETRY_TIMEOUT (120*HZ)
39280a5a 100
e5e94017
BH
101enum {
102 NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */
103 NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */
43f1b3da 104 NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */
2370abda 105 NFS_LAYOUT_RETURN, /* layoutreturn in progress */
6604b203 106 NFS_LAYOUT_RETURN_LOCK, /* Serialise layoutreturn */
2370abda 107 NFS_LAYOUT_RETURN_REQUESTED, /* Return this layout ASAP */
47abadef 108 NFS_LAYOUT_INVALID_STID, /* layout stateid id is invalid */
9bf87482 109 NFS_LAYOUT_FIRST_LAYOUTGET, /* Serialize first layoutget */
5085607d 110 NFS_LAYOUT_INODE_FREEING, /* The inode is being freed */
cf6605d1 111 NFS_LAYOUT_HASHED, /* The layout visible */
e5e94017
BH
112};
113
8a1636c4 114enum layoutdriver_policy_flags {
88ac815c
PT
115 /* Should the pNFS client commit and return the layout upon truncate to
116 * a smaller size */
8a1636c4 117 PNFS_LAYOUTRET_ON_SETATTR = 1 << 0,
fe0fe835 118 PNFS_LAYOUTRET_ON_ERROR = 1 << 1,
612aa983 119 PNFS_READ_WHOLE_PAGE = 1 << 2,
f86c3ac5 120 PNFS_LAYOUTGET_ON_OPEN = 1 << 3,
8a1636c4
BH
121};
122
1775bc34
BH
123struct nfs4_deviceid_node;
124
85e174ba
RL
125/* Per-layout driver specific registration structure */
126struct pnfs_layoutdriver_type {
02c35fca
FI
127 struct list_head pnfs_tblid;
128 const u32 id;
129 const char *name;
130 struct module *owner;
8a1636c4 131 unsigned flags;
661373b1 132 unsigned max_deviceinfo_size;
28ced9a8 133 unsigned max_layoutget_response;
636fb9c8 134
738fd0f3
BH
135 int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
136 int (*clear_layoutdriver) (struct nfs_server *);
137
636fb9c8
BH
138 struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
139 void (*free_layout_hdr) (struct pnfs_layout_hdr *);
140
a75b9df9 141 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
b1f69b75 142 void (*free_lseg) (struct pnfs_layout_segment *lseg);
03772d2f
TM
143 void (*add_lseg) (struct pnfs_layout_hdr *layoutid,
144 struct pnfs_layout_segment *lseg,
145 struct list_head *free_me);
94ad1c80 146
c88953d8
CH
147 void (*return_range) (struct pnfs_layout_hdr *lo,
148 struct pnfs_layout_range *range);
149
94ad1c80 150 /* test for nfs page cache coalescing */
1751c363
TM
151 const struct nfs_pageio_ops *pg_read_ops;
152 const struct nfs_pageio_ops *pg_write_ops;
64419a9b 153
ea2cf228 154 struct pnfs_ds_commit_info *(*get_ds_info) (struct inode *inode);
a861a1e1 155
5bb89b47
TM
156 int (*sync)(struct inode *inode, bool datasync);
157
64419a9b
AA
158 /*
159 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
160 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
161 */
d45f60c6
WAA
162 enum pnfs_try_status (*read_pagelist)(struct nfs_pgio_header *);
163 enum pnfs_try_status (*write_pagelist)(struct nfs_pgio_header *, int);
1775bc34
BH
164
165 void (*free_deviceid_node) (struct nfs4_deviceid_node *);
661373b1
CH
166 struct nfs4_deviceid_node * (*alloc_deviceid_node)
167 (struct nfs_server *server, struct pnfs_device *pdev,
168 gfp_t gfp_flags);
04a55549 169
287bd3e9 170 int (*prepare_layoutreturn) (struct nfs4_layoutreturn_args *);
ac7db726 171
db29c089 172 void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);
5f919c9f 173 int (*prepare_layoutcommit) (struct nfs4_layoutcommit_args *args);
8733408d 174 int (*prepare_layoutstats) (struct nfs42_layoutstat_args *args);
85e174ba
RL
175};
176
9c455a8c
TM
177struct pnfs_commit_ops {
178 void (*setup_ds_info)(struct pnfs_ds_commit_info *,
179 struct pnfs_layout_segment *);
180 void (*release_ds_info)(struct pnfs_ds_commit_info *,
181 struct inode *inode);
182 int (*commit_pagelist)(struct inode *inode,
183 struct list_head *mds_pages,
184 int how,
185 struct nfs_commit_info *cinfo);
186 void (*mark_request_commit) (struct nfs_page *req,
187 struct pnfs_layout_segment *lseg,
188 struct nfs_commit_info *cinfo,
189 u32 ds_commit_idx);
190 void (*clear_request_commit) (struct nfs_page *req,
191 struct nfs_commit_info *cinfo);
192 int (*scan_commit_lists) (struct nfs_commit_info *cinfo,
193 int max);
194 void (*recover_commit_reqs) (struct list_head *list,
195 struct nfs_commit_info *cinfo);
196 struct nfs_page * (*search_commit_reqs)(struct nfs_commit_info *cinfo,
197 struct page *page);
198};
199
e5e94017 200struct pnfs_layout_hdr {
2b28a7be 201 refcount_t plh_refcount;
82714bd1 202 atomic_t plh_outstanding; /* number of RPCs out */
b7edfaa1 203 struct list_head plh_layouts; /* other client layouts */
fd9a8d71 204 struct list_head plh_bulk_destroy;
b7edfaa1 205 struct list_head plh_segs; /* layout segments list */
68f74479 206 struct list_head plh_return_segs; /* invalid layout segments */
f7e8917a 207 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
25c75333 208 unsigned long plh_retry_timestamp;
566052c5 209 unsigned long plh_flags;
82714bd1
TM
210 nfs4_stateid plh_stateid;
211 u32 plh_barrier; /* ignore lower seqids */
3982a6a2 212 u32 plh_return_seq;
016256df 213 enum pnfs_iomode plh_return_iomode;
acff5880 214 loff_t plh_lwb; /* last write byte for layoutcommit */
a52458b4 215 const struct cred *plh_lc_cred; /* layoutcommit cred */
b7edfaa1 216 struct inode *plh_inode;
cf6605d1 217 struct rcu_head plh_rcu;
e5e94017
BH
218};
219
b1f69b75
AA
220struct pnfs_device {
221 struct nfs4_deviceid dev_id;
222 unsigned int layout_type;
223 unsigned int mincount;
f1c097be 224 unsigned int maxcount; /* gdia_maxcount */
b1f69b75 225 struct page **pages;
b1f69b75 226 unsigned int pgbase;
f1c097be 227 unsigned int pglen; /* reply buffer length */
df52699e 228 unsigned char nocache : 1;/* May not be cached */
b1f69b75
AA
229};
230
7f11d8d3
AA
231#define NFS4_PNFS_GETDEVLIST_MAXNUM 16
232
233struct pnfs_devicelist {
234 unsigned int eof;
235 unsigned int num_devs;
236 struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
237};
238
02c35fca
FI
239extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
240extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
241
b1f69b75 242/* nfs4proc.c */
dacb452d 243extern size_t max_response_pages(struct nfs_server *server);
b1f69b75 244extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
cd5875fe 245 struct pnfs_device *dev,
a52458b4 246 const struct cred *cred);
dacb452d 247extern struct pnfs_layout_segment* nfs4_proc_layoutget(struct nfs4_layoutget *lgp, long *timeout);
6c16605d 248extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp, bool sync);
b1f69b75
AA
249
250/* pnfs.c */
70c3bd2b 251void pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo);
9369a431 252void pnfs_put_lseg(struct pnfs_layout_segment *lseg);
1751c363 253
ca440c38 254void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, struct nfs_fsinfo *);
85e174ba 255void unset_pnfs_layoutdriver(struct nfs_server *);
b3230e80 256void pnfs_generic_pg_check_layout(struct nfs_pageio_descriptor *pgio);
e1e54ab7 257void pnfs_generic_pg_check_range(struct nfs_pageio_descriptor *pgio, struct nfs_page *req);
d8007d4d 258void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
493292dd 259int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
6296556f
PT
260void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio,
261 struct nfs_page *req, u64 wb_size);
180bb5ec 262void pnfs_generic_pg_cleanup(struct nfs_pageio_descriptor *);
dce81290 263int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
b4fdac1a
WAA
264size_t pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio,
265 struct nfs_page *prev, struct nfs_page *req);
1b0ae068 266void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
a0b0a6e3 267struct pnfs_layout_segment *pnfs_layout_process(struct nfs4_layoutget *lgp);
29a8bfe5 268void pnfs_layoutget_free(struct nfs4_layoutget *lgp);
43f1b3da 269void pnfs_free_lseg_list(struct list_head *tmp_list);
e5e94017 270void pnfs_destroy_layout(struct nfs_inode *);
b6d49ecd 271void pnfs_destroy_layout_final(struct nfs_inode *);
974cec8c 272void pnfs_destroy_all_layouts(struct nfs_client *);
fd9a8d71
TM
273int pnfs_destroy_layouts_byfsid(struct nfs_client *clp,
274 struct nfs_fsid *fsid,
275 bool is_recall);
276int pnfs_destroy_layouts_byclid(struct nfs_client *clp,
277 bool is_recall);
30cb3ee2 278bool nfs4_layout_refresh_old_stateid(nfs4_stateid *dst,
ecf84026
TM
279 struct pnfs_layout_range *dst_range,
280 struct inode *inode);
70c3bd2b 281void pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo);
43f1b3da
FI
282void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
283 const nfs4_stateid *new,
59b56394 284 const struct cred *cred,
43f1b3da 285 bool update_barrier);
49a85061 286int pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
43f1b3da 287 struct list_head *tmp_list,
6d597e17
JL
288 const struct pnfs_layout_range *recall_range,
289 u32 seq);
10335556 290int pnfs_mark_matching_lsegs_return(struct pnfs_layout_hdr *lo,
fc7ff367 291 struct list_head *tmp_list,
6d597e17
JL
292 const struct pnfs_layout_range *recall_range,
293 u32 seq);
5f46be04
TM
294int pnfs_mark_layout_stateid_invalid(struct pnfs_layout_hdr *lo,
295 struct list_head *lseg_list);
1c5bd76d
TM
296bool pnfs_roc(struct inode *ino,
297 struct nfs4_layoutreturn_args *args,
298 struct nfs4_layoutreturn_res *res,
a52458b4 299 const struct cred *cred);
078000d0
TM
300int pnfs_roc_done(struct rpc_task *task, struct nfs4_layoutreturn_args **argpp,
301 struct nfs4_layoutreturn_res **respp, int *ret);
1c5bd76d
TM
302void pnfs_roc_release(struct nfs4_layoutreturn_args *args,
303 struct nfs4_layoutreturn_res *res,
304 int ret);
500d701f 305bool pnfs_wait_on_layoutreturn(struct inode *ino, struct rpc_task *task);
67af7611 306void pnfs_set_layoutcommit(struct inode *, struct pnfs_layout_segment *, loff_t);
db29c089 307void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
ef311537 308int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
5bb89b47
TM
309int pnfs_generic_sync(struct inode *inode, bool datasync);
310int pnfs_nfs_generic_sync(struct inode *inode, bool datasync);
cbe82603 311int _pnfs_return_layout(struct inode *);
24028672 312int pnfs_commit_and_return_layout(struct inode *);
d45f60c6
WAA
313void pnfs_ld_write_done(struct nfs_pgio_header *);
314void pnfs_ld_read_done(struct nfs_pgio_header *);
563c53e7 315void pnfs_read_resend_pnfs(struct nfs_pgio_header *, unsigned int mirror_idx);
7c24d948
AA
316struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
317 struct nfs_open_context *ctx,
318 loff_t pos,
319 u64 count,
320 enum pnfs_iomode iomode,
c7d73af2 321 bool strict_iomode,
7c24d948 322 gfp_t gfp_flags);
68f74479 323void pnfs_layoutreturn_free_lsegs(struct pnfs_layout_hdr *lo,
2a974425 324 const nfs4_stateid *arg_stateid,
68f74479 325 const struct pnfs_layout_range *range,
68f74479 326 const nfs4_stateid *stateid);
e5e94017 327
03772d2f
TM
328void pnfs_generic_layout_insert_lseg(struct pnfs_layout_hdr *lo,
329 struct pnfs_layout_segment *lseg,
330 bool (*is_after)(const struct pnfs_layout_range *lseg_range,
331 const struct pnfs_layout_range *old),
332 bool (*do_merge)(struct pnfs_layout_segment *lseg,
333 struct pnfs_layout_segment *old),
334 struct list_head *free_me);
335
c47abcf8 336void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
53113ad3
WAA
337int pnfs_read_done_resend_to_mds(struct nfs_pgio_header *);
338int pnfs_write_done_resend_to_mds(struct nfs_pgio_header *);
82be417a 339struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
016256df
PT
340void pnfs_error_mark_layout_for_return(struct inode *inode,
341 struct pnfs_layout_segment *lseg);
b5fdf841
TM
342void pnfs_layout_return_unused_byclid(struct nfs_client *clp,
343 enum pnfs_iomode iomode);
344
c47abcf8
AA
345/* nfs4_deviceid_flags */
346enum {
347 NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
1dfed273 348 NFS_DEVICEID_UNAVAILABLE, /* device temporarily unavailable */
df52699e 349 NFS_DEVICEID_NOCACHE, /* device may not be cached */
c47abcf8
AA
350};
351
a1eaecbc
BH
352/* pnfs_dev.c */
353struct nfs4_deviceid_node {
354 struct hlist_node node;
9e3bd4e2 355 struct hlist_node tmpnode;
1775bc34 356 const struct pnfs_layoutdriver_type *ld;
a1eaecbc 357 const struct nfs_client *nfs_client;
c47abcf8 358 unsigned long flags;
1dfed273 359 unsigned long timestamp_unavailable;
a1eaecbc 360 struct nfs4_deviceid deviceid;
84a80f62 361 struct rcu_head rcu;
a1eaecbc
BH
362 atomic_t ref;
363};
364
661373b1
CH
365struct nfs4_deviceid_node *
366nfs4_find_get_deviceid(struct nfs_server *server,
a52458b4 367 const struct nfs4_deviceid *id, const struct cred *cred,
661373b1 368 gfp_t gfp_mask);
35c8bb54 369void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
661373b1 370void nfs4_init_deviceid_node(struct nfs4_deviceid_node *, struct nfs_server *,
a1eaecbc 371 const struct nfs4_deviceid *);
a1eaecbc 372bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
76c66905 373void nfs4_mark_deviceid_available(struct nfs4_deviceid_node *node);
1dfed273
TM
374void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
375bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
1775bc34 376void nfs4_deviceid_purge_client(const struct nfs_client *);
a1eaecbc 377
f54bcf2e 378/* pnfs_nfs.c */
d7242c46
TM
379struct pnfs_commit_array *pnfs_alloc_commit_array(size_t n, gfp_t gfp_flags);
380void pnfs_free_commit_array(struct pnfs_commit_array *p);
ba827c9a
TM
381struct pnfs_commit_array *pnfs_add_commit_array(struct pnfs_ds_commit_info *,
382 struct pnfs_commit_array *,
383 struct pnfs_layout_segment *);
384
a9901899
TM
385void pnfs_generic_ds_cinfo_release_lseg(struct pnfs_ds_commit_info *fl_cinfo,
386 struct pnfs_layout_segment *lseg);
387void pnfs_generic_ds_cinfo_destroy(struct pnfs_ds_commit_info *fl_cinfo);
d7242c46 388
f54bcf2e
TH
389void pnfs_generic_clear_request_commit(struct nfs_page *req,
390 struct nfs_commit_info *cinfo);
391void pnfs_generic_commit_release(void *calldata);
392void pnfs_generic_prepare_to_resend_writes(struct nfs_commit_data *data);
393void pnfs_generic_rw_release(void *data);
394void pnfs_generic_recover_commit_reqs(struct list_head *dst,
395 struct nfs_commit_info *cinfo);
fb6b53ba
TM
396struct nfs_page *pnfs_generic_search_commit_reqs(struct nfs_commit_info *cinfo,
397 struct page *page);
f54bcf2e
TH
398int pnfs_generic_commit_pagelist(struct inode *inode,
399 struct list_head *mds_pages,
400 int how,
401 struct nfs_commit_info *cinfo,
402 int (*initiate_commit)(struct nfs_commit_data *data,
403 int how));
404int pnfs_generic_scan_commit_lists(struct nfs_commit_info *cinfo, int max);
405void pnfs_generic_write_commit_done(struct rpc_task *task, void *data);
875ae069
PT
406void nfs4_pnfs_ds_put(struct nfs4_pnfs_ds *ds);
407struct nfs4_pnfs_ds *nfs4_pnfs_ds_add(struct list_head *dsaddrs,
408 gfp_t gfp_flags);
5f01d953 409void nfs4_pnfs_v3_ds_connect_unload(void);
a33e4b03 410int nfs4_pnfs_ds_connect(struct nfs_server *mds_srv, struct nfs4_pnfs_ds *ds,
7405f9e1 411 struct nfs4_deviceid_node *devid, unsigned int timeo,
7d38de3f 412 unsigned int retrans, u32 version, u32 minor_version);
6b7f3cf9
PT
413struct nfs4_pnfs_ds_addr *nfs4_decode_mp_ds_addr(struct net *net,
414 struct xdr_stream *xdr,
415 gfp_t gfp_flags);
338d00cf
TH
416void pnfs_layout_mark_request_commit(struct nfs_page *req,
417 struct pnfs_layout_segment *lseg,
418 struct nfs_commit_info *cinfo,
419 u32 ds_commit_idx);
2409a976
FI
420void pnfs_lgopen_prepare(struct nfs4_opendata *data,
421 struct nfs_open_context *ctx);
422void pnfs_parse_lgopen(struct inode *ino, struct nfs4_layoutget *lgp,
423 struct nfs_open_context *ctx);
30ae2412 424void nfs4_lgopen_release(struct nfs4_layoutget *lgp);
f54bcf2e 425
40dd4b7a
TM
426static inline bool nfs_have_layout(struct inode *inode)
427{
428 return NFS_I(inode)->layout != NULL;
429}
430
45fcc7bc
TM
431static inline bool pnfs_layout_is_valid(const struct pnfs_layout_hdr *lo)
432{
433 return test_bit(NFS_LAYOUT_INVALID_STID, &lo->plh_flags) == 0;
434}
435
30ff0603
CH
436static inline struct nfs4_deviceid_node *
437nfs4_get_deviceid(struct nfs4_deviceid_node *d)
438{
439 atomic_inc(&d->ref);
440 return d;
441}
442
d684d2ae 443static inline struct pnfs_layout_segment *
9369a431 444pnfs_get_lseg(struct pnfs_layout_segment *lseg)
d684d2ae
FI
445{
446 if (lseg) {
eba6dd69 447 refcount_inc(&lseg->pls_refcount);
4e857c58 448 smp_mb__after_atomic();
d684d2ae
FI
449 }
450 return lseg;
451}
452
b20135d0
TM
453static inline bool
454pnfs_is_valid_lseg(struct pnfs_layout_segment *lseg)
455{
456 return test_bit(NFS_LSEG_VALID, &lseg->pls_flags) != 0;
457}
458
e5e94017
BH
459/* Return true if a layout driver is being used for this mountpoint */
460static inline int pnfs_enabled_sb(struct nfs_server *nfss)
461{
462 return nfss->pnfs_curr_ld != NULL;
463}
85e174ba 464
a861a1e1 465static inline int
ea2cf228
FI
466pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
467 struct nfs_commit_info *cinfo)
a861a1e1 468{
9c455a8c
TM
469 struct pnfs_ds_commit_info *fl_cinfo = cinfo->ds;
470
471 if (fl_cinfo == NULL || fl_cinfo->ncommitting == 0)
a861a1e1 472 return PNFS_NOT_ATTEMPTED;
9c455a8c 473 return fl_cinfo->ops->commit_pagelist(inode, mds_pages, how, cinfo);
ea2cf228
FI
474}
475
476static inline struct pnfs_ds_commit_info *
477pnfs_get_ds_info(struct inode *inode)
478{
479 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
480
481 if (ld == NULL || ld->get_ds_info == NULL)
482 return NULL;
483 return ld->get_ds_info(inode);
a861a1e1
FI
484}
485
9c455a8c
TM
486static inline void
487pnfs_init_ds_commit_info_ops(struct pnfs_ds_commit_info *fl_cinfo, struct inode *inode)
488{
489 struct pnfs_ds_commit_info *inode_cinfo = pnfs_get_ds_info(inode);
490 if (inode_cinfo != NULL)
491 fl_cinfo->ops = inode_cinfo->ops;
492}
493
c21e7168
TM
494static inline void
495pnfs_init_ds_commit_info(struct pnfs_ds_commit_info *fl_cinfo)
496{
497 INIT_LIST_HEAD(&fl_cinfo->commits);
9c455a8c 498 fl_cinfo->ops = NULL;
c21e7168
TM
499}
500
18f41296
TM
501static inline void
502pnfs_release_ds_info(struct pnfs_ds_commit_info *fl_cinfo, struct inode *inode)
503{
9c455a8c
TM
504 if (fl_cinfo->ops != NULL && fl_cinfo->ops->release_ds_info != NULL)
505 fl_cinfo->ops->release_ds_info(fl_cinfo, inode);
18f41296
TM
506}
507
f54bcf2e
TH
508static inline void
509pnfs_generic_mark_devid_invalid(struct nfs4_deviceid_node *node)
510{
511 set_bit(NFS_DEVICEID_INVALID, &node->flags);
512}
513
8dd37758 514static inline bool
ea2cf228 515pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
b57ff130 516 struct nfs_commit_info *cinfo, u32 ds_commit_idx)
a861a1e1 517{
9c455a8c 518 struct pnfs_ds_commit_info *fl_cinfo = cinfo->ds;
a861a1e1 519
9c455a8c 520 if (!lseg || !fl_cinfo->ops->mark_request_commit)
8dd37758 521 return false;
9c455a8c 522 fl_cinfo->ops->mark_request_commit(req, lseg, cinfo, ds_commit_idx);
8dd37758 523 return true;
a861a1e1
FI
524}
525
8dd37758 526static inline bool
ea2cf228 527pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
a861a1e1 528{
9c455a8c 529 struct pnfs_ds_commit_info *fl_cinfo = cinfo->ds;
d6d6dc7c 530
9c455a8c 531 if (!fl_cinfo || !fl_cinfo->ops || !fl_cinfo->ops->clear_request_commit)
8dd37758 532 return false;
9c455a8c 533 fl_cinfo->ops->clear_request_commit(req, cinfo);
8dd37758 534 return true;
d6d6dc7c
FI
535}
536
537static inline int
ea2cf228
FI
538pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
539 int max)
d6d6dc7c 540{
9c455a8c
TM
541 struct pnfs_ds_commit_info *fl_cinfo = cinfo->ds;
542
543 if (!fl_cinfo || fl_cinfo->nwritten == 0)
d6d6dc7c 544 return 0;
9c455a8c
TM
545 return fl_cinfo->ops->scan_commit_lists(cinfo, max);
546}
547
548static inline void
549pnfs_recover_commit_reqs(struct list_head *head, struct nfs_commit_info *cinfo)
550{
551 struct pnfs_ds_commit_info *fl_cinfo = cinfo->ds;
552
553 if (fl_cinfo && fl_cinfo->nwritten != 0)
554 fl_cinfo->ops->recover_commit_reqs(head, cinfo);
a861a1e1
FI
555}
556
02d1426c
WAA
557static inline struct nfs_page *
558pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
559 struct page *page)
560{
9c455a8c 561 struct pnfs_ds_commit_info *fl_cinfo = cinfo->ds;
02d1426c 562
9c455a8c 563 if (!fl_cinfo->ops || !fl_cinfo->ops->search_commit_reqs)
02d1426c 564 return NULL;
9c455a8c 565 return fl_cinfo->ops->search_commit_reqs(cinfo, page);
02d1426c
WAA
566}
567
8a1636c4
BH
568/* Should the pNFS client commit and return the layout upon a setattr */
569static inline bool
570pnfs_ld_layoutret_on_setattr(struct inode *inode)
571{
572 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
573 return false;
574 return NFS_SERVER(inode)->pnfs_curr_ld->flags &
575 PNFS_LAYOUTRET_ON_SETATTR;
576}
577
612aa983
CH
578static inline bool
579pnfs_ld_read_whole_page(struct inode *inode)
580{
581 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
582 return false;
583 return NFS_SERVER(inode)->pnfs_curr_ld->flags & PNFS_READ_WHOLE_PAGE;
584}
585
5bb89b47
TM
586static inline int
587pnfs_sync_inode(struct inode *inode, bool datasync)
588{
589 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
590 return 0;
591 return NFS_SERVER(inode)->pnfs_curr_ld->sync(inode, datasync);
592}
593
d8c951c3
TM
594static inline bool
595pnfs_layoutcommit_outstanding(struct inode *inode)
596{
597 struct nfs_inode *nfsi = NFS_I(inode);
598
599 return test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags) != 0 ||
600 test_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags) != 0;
601}
602
cbe82603
BH
603static inline int pnfs_return_layout(struct inode *ino)
604{
605 struct nfs_inode *nfsi = NFS_I(ino);
606 struct nfs_server *nfss = NFS_SERVER(ino);
607
d78471d3
BC
608 if (pnfs_enabled_sb(nfss) && nfsi->layout) {
609 set_bit(NFS_LAYOUT_RETURN_REQUESTED, &nfsi->layout->plh_flags);
cbe82603 610 return _pnfs_return_layout(ino);
d78471d3 611 }
cbe82603
BH
612
613 return 0;
614}
615
82be417a
AA
616static inline bool
617pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
618 struct nfs_server *nfss)
619{
fb47ddc9 620 return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
82be417a
AA
621 nfss->pnfs_curr_ld->id == src->l_type);
622}
623
0762ed2c
TM
624static inline u64
625pnfs_calc_offset_end(u64 offset, u64 len)
626{
627 if (len == NFS4_MAX_UINT64 || len >= NFS4_MAX_UINT64 - offset)
628 return NFS4_MAX_UINT64;
629 return offset + len - 1;
630}
631
632static inline u64
633pnfs_calc_offset_length(u64 offset, u64 end)
634{
635 if (end == NFS4_MAX_UINT64 || end <= offset)
636 return NFS4_MAX_UINT64;
637 return 1 + end - offset;
638}
639
e144e539
TM
640static inline void
641pnfs_copy_range(struct pnfs_layout_range *dst,
642 const struct pnfs_layout_range *src)
643{
644 memcpy(dst, src, sizeof(*dst));
645}
646
17822b20
TM
647static inline u64
648pnfs_end_offset(u64 start, u64 len)
649{
650 if (NFS4_MAX_UINT64 - start <= len)
651 return NFS4_MAX_UINT64;
652 return start + len;
653}
654
655/*
656 * Are 2 ranges intersecting?
657 * start1 end1
658 * [----------------------------------)
659 * start2 end2
660 * [----------------)
661 */
662static inline bool
663pnfs_is_range_intersecting(u64 start1, u64 end1, u64 start2, u64 end2)
664{
665 return (end1 == NFS4_MAX_UINT64 || start2 < end1) &&
666 (end2 == NFS4_MAX_UINT64 || start1 < end2);
667}
668
669static inline bool
670pnfs_lseg_range_intersecting(const struct pnfs_layout_range *l1,
671 const struct pnfs_layout_range *l2)
672{
673 u64 end1 = pnfs_end_offset(l1->offset, l1->length);
674 u64 end2 = pnfs_end_offset(l2->offset, l2->length);
675
676 return pnfs_is_range_intersecting(l1->offset, end1, l2->offset, end2);
677}
678
08cb5b0f
BC
679static inline bool
680pnfs_lseg_request_intersecting(struct pnfs_layout_segment *lseg, struct nfs_page *req)
681{
682 u64 seg_last = pnfs_end_offset(lseg->pls_range.offset, lseg->pls_range.length);
683 u64 req_last = req_offset(req) + req->wb_bytes;
684
685 return pnfs_is_range_intersecting(lseg->pls_range.offset, seg_last,
686 req_offset(req), req_last);
687}
688
bbf58bf3
TM
689extern unsigned int layoutstats_timer;
690
6f00866d
TM
691#ifdef NFS_DEBUG
692void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
693#else
694static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
695{
696}
bbf58bf3 697
6f00866d 698#endif /* NFS_DEBUG */
85e174ba
RL
699#else /* CONFIG_NFS_V4_1 */
700
40dd4b7a
TM
701static inline bool nfs_have_layout(struct inode *inode)
702{
703 return false;
704}
705
974cec8c
AA
706static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
707{
708}
709
e5e94017
BH
710static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
711{
712}
713
b6d49ecd
TM
714static inline void pnfs_destroy_layout_final(struct nfs_inode *nfsi)
715{
716}
717
d684d2ae 718static inline struct pnfs_layout_segment *
9369a431 719pnfs_get_lseg(struct pnfs_layout_segment *lseg)
d684d2ae
FI
720{
721 return NULL;
722}
723
9369a431 724static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
d684d2ae
FI
725{
726}
727
cbe82603
BH
728static inline int pnfs_return_layout(struct inode *ino)
729{
730 return 0;
731}
732
24028672
TM
733static inline int pnfs_commit_and_return_layout(struct inode *inode)
734{
735 return 0;
736}
737
8a1636c4
BH
738static inline bool
739pnfs_ld_layoutret_on_setattr(struct inode *inode)
740{
741 return false;
742}
743
612aa983
CH
744static inline bool
745pnfs_ld_read_whole_page(struct inode *inode)
746{
747 return false;
748}
749
5bb89b47
TM
750static inline int
751pnfs_sync_inode(struct inode *inode, bool datasync)
752{
753 return 0;
754}
755
10b7e9ad
TM
756static inline bool
757pnfs_layoutcommit_outstanding(struct inode *inode)
758{
759 return false;
760}
761
762
f7e8917a 763static inline bool
1c5bd76d
TM
764pnfs_roc(struct inode *ino,
765 struct nfs4_layoutreturn_args *args,
766 struct nfs4_layoutreturn_res *res,
a52458b4 767 const struct cred *cred)
f7e8917a
FI
768{
769 return false;
770}
771
287a9c55 772static inline int
078000d0 773pnfs_roc_done(struct rpc_task *task,
287a9c55
TM
774 struct nfs4_layoutreturn_args **argpp,
775 struct nfs4_layoutreturn_res **respp,
776 int *ret)
777{
778 return 0;
779}
780
f7e8917a 781static inline void
1c5bd76d
TM
782pnfs_roc_release(struct nfs4_layoutreturn_args *args,
783 struct nfs4_layoutreturn_res *res,
784 int ret)
f7e8917a 785{
f7e8917a
FI
786}
787
500d701f
PT
788static inline bool
789pnfs_wait_on_layoutreturn(struct inode *ino, struct rpc_task *task)
790{
791 return false;
792}
793
738fd0f3 794static inline void set_pnfs_layoutdriver(struct nfs_server *s,
ca440c38
JL
795 const struct nfs_fh *mntfh,
796 struct nfs_fsinfo *fsinfo)
85e174ba
RL
797{
798}
799
800static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
801{
802}
803
a861a1e1 804static inline int
ea2cf228
FI
805pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
806 struct nfs_commit_info *cinfo)
a861a1e1
FI
807{
808 return PNFS_NOT_ATTEMPTED;
809}
810
ea2cf228
FI
811static inline struct pnfs_ds_commit_info *
812pnfs_get_ds_info(struct inode *inode)
813{
814 return NULL;
815}
816
9c455a8c
TM
817static inline void
818pnfs_init_ds_commit_info_ops(struct pnfs_ds_commit_info *fl_cinfo, struct inode *inode)
819{
820}
821
c21e7168
TM
822static inline void
823pnfs_init_ds_commit_info(struct pnfs_ds_commit_info *fl_cinfo)
824{
825}
826
18f41296
TM
827static inline void
828pnfs_release_ds_info(struct pnfs_ds_commit_info *fl_cinfo, struct inode *inode)
829{
830}
831
8dd37758 832static inline bool
ea2cf228 833pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
b57ff130 834 struct nfs_commit_info *cinfo, u32 ds_commit_idx)
a861a1e1 835{
8dd37758 836 return false;
a861a1e1
FI
837}
838
8dd37758 839static inline bool
ea2cf228 840pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
a861a1e1 841{
8dd37758 842 return false;
d6d6dc7c
FI
843}
844
845static inline int
ea2cf228
FI
846pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
847 int max)
d6d6dc7c
FI
848{
849 return 0;
a861a1e1
FI
850}
851
9c455a8c
TM
852static inline void
853pnfs_recover_commit_reqs(struct list_head *head, struct nfs_commit_info *cinfo)
854{
855}
856
02d1426c
WAA
857static inline struct nfs_page *
858pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
859 struct page *page)
860{
861 return NULL;
862}
863
ef311537 864static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
863a3c6c
AA
865{
866 return 0;
867}
1775bc34 868
82be417a
AA
869static inline bool
870pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
871 struct nfs_server *nfss)
872{
873 return false;
874}
875
876static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
877{
878 return NULL;
879}
880
5f01d953
PT
881static inline void nfs4_pnfs_v3_ds_connect_unload(void)
882{
883}
884
30cb3ee2 885static inline bool nfs4_layout_refresh_old_stateid(nfs4_stateid *dst,
ecf84026 886 struct pnfs_layout_range *dst_range,
7380020e
TM
887 struct inode *inode)
888{
889 return false;
890}
2409a976
FI
891
892static inline void pnfs_lgopen_prepare(struct nfs4_opendata *data,
893 struct nfs_open_context *ctx)
894{
895}
896
897static inline void pnfs_parse_lgopen(struct inode *ino,
898 struct nfs4_layoutget *lgp,
899 struct nfs_open_context *ctx)
900{
901}
30ae2412
FI
902
903static inline void nfs4_lgopen_release(struct nfs4_layoutget *lgp)
904{
905}
906
c8bf7073
TM
907static inline bool pnfs_layout_is_valid(const struct pnfs_layout_hdr *lo)
908{
909 return false;
910}
911
85e174ba
RL
912#endif /* CONFIG_NFS_V4_1 */
913
865a7ecb 914#if IS_ENABLED(CONFIG_NFS_V4_2)
c8ad8894 915int pnfs_report_layoutstat(struct inode *inode, gfp_t gfp_flags);
865a7ecb
PT
916#else
917static inline int
c8ad8894 918pnfs_report_layoutstat(struct inode *inode, gfp_t gfp_flags)
865a7ecb
PT
919{
920 return 0;
921}
922#endif
923
85e174ba 924#endif /* FS_NFS_PNFS_H */