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