]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - fs/nfs/pnfs.h
NFS: test and free stateids during recovery
[mirror_ubuntu-zesty-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
45df3c8b 33#include <linux/nfs_fs.h>
94ad1c80
FI
34#include <linux/nfs_page.h>
35
4541d16c
FI
36enum {
37 NFS_LSEG_VALID = 0, /* cleared when lseg is recalled/returned */
f7e8917a 38 NFS_LSEG_ROC, /* roc bit received from server */
4541d16c
FI
39};
40
974cec8c 41struct pnfs_layout_segment {
566052c5
FI
42 struct list_head pls_list;
43 struct pnfs_layout_range pls_range;
4541d16c
FI
44 atomic_t pls_refcount;
45 unsigned long pls_flags;
566052c5 46 struct pnfs_layout_hdr *pls_layout;
863a3c6c
AA
47 struct rpc_cred *pls_lc_cred; /* LAYOUTCOMMIT credential */
48 loff_t pls_end_pos; /* LAYOUTCOMMIT write end */
974cec8c
AA
49};
50
64419a9b
AA
51enum pnfs_try_status {
52 PNFS_ATTEMPTED = 0,
53 PNFS_NOT_ATTEMPTED = 1,
54};
55
85e174ba
RL
56#ifdef CONFIG_NFS_V4_1
57
58#define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
59
e5e94017
BH
60enum {
61 NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */
62 NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */
43f1b3da 63 NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */
f7e8917a 64 NFS_LAYOUT_ROC, /* some lseg had roc bit set */
4541d16c 65 NFS_LAYOUT_DESTROYED, /* no new use of layout allowed */
e5e94017
BH
66};
67
8a1636c4
BH
68enum layoutdriver_policy_flags {
69 /* Should the pNFS client commit and return the layout upon a setattr */
70 PNFS_LAYOUTRET_ON_SETATTR = 1 << 0,
71};
72
1775bc34
BH
73struct nfs4_deviceid_node;
74
85e174ba
RL
75/* Per-layout driver specific registration structure */
76struct pnfs_layoutdriver_type {
02c35fca
FI
77 struct list_head pnfs_tblid;
78 const u32 id;
79 const char *name;
80 struct module *owner;
8a1636c4 81 unsigned flags;
636fb9c8
BH
82
83 struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
84 void (*free_layout_hdr) (struct pnfs_layout_hdr *);
85
a75b9df9 86 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
b1f69b75 87 void (*free_lseg) (struct pnfs_layout_segment *lseg);
94ad1c80
FI
88
89 /* test for nfs page cache coalescing */
18ad0a9f 90 bool (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *);
64419a9b 91
a861a1e1
FI
92 /* Returns true if layoutdriver wants to divert this request to
93 * driver's commit routine.
94 */
95 bool (*mark_pnfs_commit)(struct pnfs_layout_segment *lseg);
96 struct list_head * (*choose_commit_list) (struct nfs_page *req);
97 int (*commit_pagelist)(struct inode *inode, struct list_head *mds_pages, int how);
98
64419a9b
AA
99 /*
100 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
101 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
102 */
103 enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data);
0382b744 104 enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);
1775bc34
BH
105
106 void (*free_deviceid_node) (struct nfs4_deviceid_node *);
04a55549
AA
107
108 void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid,
109 struct xdr_stream *xdr,
110 const struct nfs4_layoutreturn_args *args);
ac7db726
BH
111
112 void (*encode_layoutcommit) (struct pnfs_layout_hdr *layoutid,
113 struct xdr_stream *xdr,
114 const struct nfs4_layoutcommit_args *args);
85e174ba
RL
115};
116
e5e94017 117struct pnfs_layout_hdr {
cc6e5340 118 atomic_t plh_refcount;
b7edfaa1 119 struct list_head plh_layouts; /* other client layouts */
43f1b3da 120 struct list_head plh_bulk_recall; /* clnt list of bulk recalls */
b7edfaa1 121 struct list_head plh_segs; /* layout segments list */
b7edfaa1 122 nfs4_stateid plh_stateid;
cf7d63f1 123 atomic_t plh_outstanding; /* number of RPCs out */
f7e8917a 124 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
43f1b3da 125 u32 plh_barrier; /* ignore lower seqids */
566052c5 126 unsigned long plh_flags;
b7edfaa1 127 struct inode *plh_inode;
e5e94017
BH
128};
129
b1f69b75
AA
130struct pnfs_device {
131 struct nfs4_deviceid dev_id;
132 unsigned int layout_type;
133 unsigned int mincount;
134 struct page **pages;
b1f69b75
AA
135 unsigned int pgbase;
136 unsigned int pglen;
137};
138
02c35fca
FI
139extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
140extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
141
b1f69b75
AA
142/* nfs4proc.c */
143extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
144 struct pnfs_device *dev);
145extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
cbe82603 146extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
b1f69b75
AA
147
148/* pnfs.c */
43f1b3da 149void get_layout_hdr(struct pnfs_layout_hdr *lo);
bae724ef 150void put_lseg(struct pnfs_layout_segment *lseg);
e5e94017
BH
151struct pnfs_layout_segment *
152pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
fb3296eb
BH
153 loff_t pos, u64 count, enum pnfs_iomode access_type,
154 gfp_t gfp_flags);
85e174ba
RL
155void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
156void unset_pnfs_layoutdriver(struct nfs_server *);
0382b744
AA
157enum pnfs_try_status pnfs_try_to_write_data(struct nfs_write_data *,
158 const struct rpc_call_ops *, int);
64419a9b
AA
159enum pnfs_try_status pnfs_try_to_read_data(struct nfs_read_data *,
160 const struct rpc_call_ops *);
18ad0a9f 161bool pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev, struct nfs_page *req);
b1f69b75 162int pnfs_layout_process(struct nfs4_layoutget *lgp);
43f1b3da 163void pnfs_free_lseg_list(struct list_head *tmp_list);
e5e94017 164void pnfs_destroy_layout(struct nfs_inode *);
974cec8c 165void pnfs_destroy_all_layouts(struct nfs_client *);
cc6e5340 166void put_layout_hdr(struct pnfs_layout_hdr *lo);
43f1b3da
FI
167void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
168 const nfs4_stateid *new,
169 bool update_barrier);
fd6002e9
FI
170int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
171 struct pnfs_layout_hdr *lo,
172 struct nfs4_state *open_state);
43f1b3da
FI
173int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
174 struct list_head *tmp_list,
778b5502 175 struct pnfs_layout_range *recall_range);
f7e8917a
FI
176bool pnfs_roc(struct inode *ino);
177void pnfs_roc_release(struct inode *ino);
178void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
179bool pnfs_roc_drain(struct inode *ino, u32 *barrier);
863a3c6c 180void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
ef311537 181int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
cbe82603 182int _pnfs_return_layout(struct inode *);
d20581aa
BH
183int pnfs_ld_write_done(struct nfs_write_data *);
184int pnfs_ld_read_done(struct nfs_read_data *);
e5e94017 185
a1eaecbc
BH
186/* pnfs_dev.c */
187struct nfs4_deviceid_node {
188 struct hlist_node node;
9e3bd4e2 189 struct hlist_node tmpnode;
1775bc34 190 const struct pnfs_layoutdriver_type *ld;
a1eaecbc
BH
191 const struct nfs_client *nfs_client;
192 struct nfs4_deviceid deviceid;
193 atomic_t ref;
194};
195
196void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
35c8bb54
BH
197struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
198struct nfs4_deviceid_node *nfs4_unhash_put_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
199void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
a1eaecbc 200void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
1775bc34 201 const struct pnfs_layoutdriver_type *,
a1eaecbc
BH
202 const struct nfs_client *,
203 const struct nfs4_deviceid *);
204struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *);
205bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
1775bc34 206void nfs4_deviceid_purge_client(const struct nfs_client *);
a1eaecbc 207
e5e94017
BH
208static inline int lo_fail_bit(u32 iomode)
209{
210 return iomode == IOMODE_RW ?
211 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
212}
213
d684d2ae
FI
214static inline struct pnfs_layout_segment *
215get_lseg(struct pnfs_layout_segment *lseg)
216{
217 if (lseg) {
218 atomic_inc(&lseg->pls_refcount);
219 smp_mb__after_atomic_inc();
220 }
221 return lseg;
222}
223
e5e94017
BH
224/* Return true if a layout driver is being used for this mountpoint */
225static inline int pnfs_enabled_sb(struct nfs_server *nfss)
226{
227 return nfss->pnfs_curr_ld != NULL;
228}
85e174ba 229
a861a1e1
FI
230static inline void
231pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
232{
233 if (lseg) {
234 struct pnfs_layoutdriver_type *ld;
235
236 ld = NFS_SERVER(req->wb_page->mapping->host)->pnfs_curr_ld;
237 if (ld->mark_pnfs_commit && ld->mark_pnfs_commit(lseg)) {
238 set_bit(PG_PNFS_COMMIT, &req->wb_flags);
239 req->wb_commit_lseg = get_lseg(lseg);
240 }
241 }
242}
243
244static inline int
245pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
246{
247 if (!test_and_clear_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags))
248 return PNFS_NOT_ATTEMPTED;
249 return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how);
250}
251
252static inline struct list_head *
253pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
254{
255 struct list_head *rv;
256
257 if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags)) {
258 struct inode *inode = req->wb_commit_lseg->pls_layout->plh_inode;
259
260 set_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags);
261 rv = NFS_SERVER(inode)->pnfs_curr_ld->choose_commit_list(req);
262 /* matched by ref taken when PG_PNFS_COMMIT is set */
263 put_lseg(req->wb_commit_lseg);
264 } else
265 rv = mds;
266 return rv;
267}
268
269static inline void pnfs_clear_request_commit(struct nfs_page *req)
270{
271 if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags))
272 put_lseg(req->wb_commit_lseg);
273}
274
8a1636c4
BH
275/* Should the pNFS client commit and return the layout upon a setattr */
276static inline bool
277pnfs_ld_layoutret_on_setattr(struct inode *inode)
278{
279 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
280 return false;
281 return NFS_SERVER(inode)->pnfs_curr_ld->flags &
282 PNFS_LAYOUTRET_ON_SETATTR;
283}
284
cbe82603
BH
285static inline int pnfs_return_layout(struct inode *ino)
286{
287 struct nfs_inode *nfsi = NFS_I(ino);
288 struct nfs_server *nfss = NFS_SERVER(ino);
289
290 if (pnfs_enabled_sb(nfss) && nfsi->layout)
291 return _pnfs_return_layout(ino);
292
293 return 0;
294}
295
dfed206b
BH
296static inline void pnfs_pageio_init(struct nfs_pageio_descriptor *pgio,
297 struct inode *inode)
298{
89a58e32
BH
299 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
300
301 if (ld)
302 pgio->pg_test = ld->pg_test;
dfed206b
BH
303}
304
85e174ba
RL
305#else /* CONFIG_NFS_V4_1 */
306
974cec8c
AA
307static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
308{
309}
310
e5e94017
BH
311static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
312{
313}
314
d684d2ae
FI
315static inline struct pnfs_layout_segment *
316get_lseg(struct pnfs_layout_segment *lseg)
317{
318 return NULL;
319}
320
321static inline void put_lseg(struct pnfs_layout_segment *lseg)
322{
323}
324
e5e94017
BH
325static inline struct pnfs_layout_segment *
326pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
fb3296eb
BH
327 loff_t pos, u64 count, enum pnfs_iomode access_type,
328 gfp_t gfp_flags)
e5e94017
BH
329{
330 return NULL;
331}
332
64419a9b
AA
333static inline enum pnfs_try_status
334pnfs_try_to_read_data(struct nfs_read_data *data,
335 const struct rpc_call_ops *call_ops)
336{
337 return PNFS_NOT_ATTEMPTED;
338}
339
0382b744
AA
340static inline enum pnfs_try_status
341pnfs_try_to_write_data(struct nfs_write_data *data,
342 const struct rpc_call_ops *call_ops, int how)
343{
344 return PNFS_NOT_ATTEMPTED;
345}
346
cbe82603
BH
347static inline int pnfs_return_layout(struct inode *ino)
348{
349 return 0;
350}
351
8a1636c4
BH
352static inline bool
353pnfs_ld_layoutret_on_setattr(struct inode *inode)
354{
355 return false;
356}
357
f7e8917a
FI
358static inline bool
359pnfs_roc(struct inode *ino)
360{
361 return false;
362}
363
364static inline void
365pnfs_roc_release(struct inode *ino)
366{
367}
368
369static inline void
370pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
371{
372}
373
374static inline bool
375pnfs_roc_drain(struct inode *ino, u32 *barrier)
376{
377 return false;
378}
379
85e174ba
RL
380static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id)
381{
382}
383
384static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
385{
386}
387
dfed206b
BH
388static inline void pnfs_pageio_init(struct nfs_pageio_descriptor *pgio,
389 struct inode *inode)
44b83799 390{
44b83799
FI
391}
392
a861a1e1
FI
393static inline void
394pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
395{
396}
397
398static inline int
399pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
400{
401 return PNFS_NOT_ATTEMPTED;
402}
403
404static inline struct list_head *
405pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
406{
407 return mds;
408}
409
410static inline void pnfs_clear_request_commit(struct nfs_page *req)
411{
412}
413
ef311537 414static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
863a3c6c
AA
415{
416 return 0;
417}
1775bc34
BH
418
419static inline void nfs4_deviceid_purge_client(struct nfs_client *ncl)
420{
421}
85e174ba
RL
422#endif /* CONFIG_NFS_V4_1 */
423
424#endif /* FS_NFS_PNFS_H */