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