pnfs-obj: report errors and .encode_layoutreturn Implementation.
[linux-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
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 */
90 int (*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);
85e174ba
RL
111};
112
e5e94017 113struct pnfs_layout_hdr {
cc6e5340 114 atomic_t plh_refcount;
b7edfaa1 115 struct list_head plh_layouts; /* other client layouts */
43f1b3da 116 struct list_head plh_bulk_recall; /* clnt list of bulk recalls */
b7edfaa1 117 struct list_head plh_segs; /* layout segments list */
b7edfaa1 118 nfs4_stateid plh_stateid;
cf7d63f1 119 atomic_t plh_outstanding; /* number of RPCs out */
f7e8917a 120 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
43f1b3da 121 u32 plh_barrier; /* ignore lower seqids */
566052c5 122 unsigned long plh_flags;
b7edfaa1 123 struct inode *plh_inode;
e5e94017
BH
124};
125
b1f69b75
AA
126struct pnfs_device {
127 struct nfs4_deviceid dev_id;
128 unsigned int layout_type;
129 unsigned int mincount;
130 struct page **pages;
b1f69b75
AA
131 unsigned int pgbase;
132 unsigned int pglen;
133};
134
02c35fca
FI
135extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
136extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
137
b1f69b75
AA
138/* nfs4proc.c */
139extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
140 struct pnfs_device *dev);
141extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
cbe82603 142extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
b1f69b75
AA
143
144/* pnfs.c */
43f1b3da 145void get_layout_hdr(struct pnfs_layout_hdr *lo);
bae724ef 146void put_lseg(struct pnfs_layout_segment *lseg);
e5e94017
BH
147struct pnfs_layout_segment *
148pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
fb3296eb
BH
149 loff_t pos, u64 count, enum pnfs_iomode access_type,
150 gfp_t gfp_flags);
85e174ba
RL
151void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
152void unset_pnfs_layoutdriver(struct nfs_server *);
0382b744
AA
153enum pnfs_try_status pnfs_try_to_write_data(struct nfs_write_data *,
154 const struct rpc_call_ops *, int);
64419a9b
AA
155enum pnfs_try_status pnfs_try_to_read_data(struct nfs_read_data *,
156 const struct rpc_call_ops *);
94ad1c80 157void pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *);
44b83799 158void pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *);
b1f69b75 159int pnfs_layout_process(struct nfs4_layoutget *lgp);
43f1b3da 160void pnfs_free_lseg_list(struct list_head *tmp_list);
e5e94017 161void pnfs_destroy_layout(struct nfs_inode *);
974cec8c 162void pnfs_destroy_all_layouts(struct nfs_client *);
cc6e5340 163void put_layout_hdr(struct pnfs_layout_hdr *lo);
43f1b3da
FI
164void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
165 const nfs4_stateid *new,
166 bool update_barrier);
fd6002e9
FI
167int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
168 struct pnfs_layout_hdr *lo,
169 struct nfs4_state *open_state);
43f1b3da
FI
170int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
171 struct list_head *tmp_list,
778b5502 172 struct pnfs_layout_range *recall_range);
f7e8917a
FI
173bool pnfs_roc(struct inode *ino);
174void pnfs_roc_release(struct inode *ino);
175void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
176bool pnfs_roc_drain(struct inode *ino, u32 *barrier);
863a3c6c 177void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
ef311537 178int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
cbe82603 179int _pnfs_return_layout(struct inode *);
d20581aa
BH
180int pnfs_ld_write_done(struct nfs_write_data *);
181int pnfs_ld_read_done(struct nfs_read_data *);
e5e94017 182
a1eaecbc
BH
183/* pnfs_dev.c */
184struct nfs4_deviceid_node {
185 struct hlist_node node;
1775bc34 186 const struct pnfs_layoutdriver_type *ld;
a1eaecbc
BH
187 const struct nfs_client *nfs_client;
188 struct nfs4_deviceid deviceid;
189 atomic_t ref;
190};
191
192void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
35c8bb54
BH
193struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
194struct nfs4_deviceid_node *nfs4_unhash_put_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
195void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
a1eaecbc 196void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
1775bc34 197 const struct pnfs_layoutdriver_type *,
a1eaecbc
BH
198 const struct nfs_client *,
199 const struct nfs4_deviceid *);
200struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *);
201bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
1775bc34 202void nfs4_deviceid_purge_client(const struct nfs_client *);
a1eaecbc 203
e5e94017
BH
204static inline int lo_fail_bit(u32 iomode)
205{
206 return iomode == IOMODE_RW ?
207 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
208}
209
d684d2ae
FI
210static inline struct pnfs_layout_segment *
211get_lseg(struct pnfs_layout_segment *lseg)
212{
213 if (lseg) {
214 atomic_inc(&lseg->pls_refcount);
215 smp_mb__after_atomic_inc();
216 }
217 return lseg;
218}
219
e5e94017
BH
220/* Return true if a layout driver is being used for this mountpoint */
221static inline int pnfs_enabled_sb(struct nfs_server *nfss)
222{
223 return nfss->pnfs_curr_ld != NULL;
224}
85e174ba 225
a861a1e1
FI
226static inline void
227pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
228{
229 if (lseg) {
230 struct pnfs_layoutdriver_type *ld;
231
232 ld = NFS_SERVER(req->wb_page->mapping->host)->pnfs_curr_ld;
233 if (ld->mark_pnfs_commit && ld->mark_pnfs_commit(lseg)) {
234 set_bit(PG_PNFS_COMMIT, &req->wb_flags);
235 req->wb_commit_lseg = get_lseg(lseg);
236 }
237 }
238}
239
240static inline int
241pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
242{
243 if (!test_and_clear_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags))
244 return PNFS_NOT_ATTEMPTED;
245 return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how);
246}
247
248static inline struct list_head *
249pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
250{
251 struct list_head *rv;
252
253 if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags)) {
254 struct inode *inode = req->wb_commit_lseg->pls_layout->plh_inode;
255
256 set_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags);
257 rv = NFS_SERVER(inode)->pnfs_curr_ld->choose_commit_list(req);
258 /* matched by ref taken when PG_PNFS_COMMIT is set */
259 put_lseg(req->wb_commit_lseg);
260 } else
261 rv = mds;
262 return rv;
263}
264
265static inline void pnfs_clear_request_commit(struct nfs_page *req)
266{
267 if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags))
268 put_lseg(req->wb_commit_lseg);
269}
270
8a1636c4
BH
271/* Should the pNFS client commit and return the layout upon a setattr */
272static inline bool
273pnfs_ld_layoutret_on_setattr(struct inode *inode)
274{
275 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
276 return false;
277 return NFS_SERVER(inode)->pnfs_curr_ld->flags &
278 PNFS_LAYOUTRET_ON_SETATTR;
279}
280
cbe82603
BH
281static inline int pnfs_return_layout(struct inode *ino)
282{
283 struct nfs_inode *nfsi = NFS_I(ino);
284 struct nfs_server *nfss = NFS_SERVER(ino);
285
286 if (pnfs_enabled_sb(nfss) && nfsi->layout)
287 return _pnfs_return_layout(ino);
288
289 return 0;
290}
291
85e174ba
RL
292#else /* CONFIG_NFS_V4_1 */
293
974cec8c
AA
294static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
295{
296}
297
e5e94017
BH
298static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
299{
300}
301
d684d2ae
FI
302static inline struct pnfs_layout_segment *
303get_lseg(struct pnfs_layout_segment *lseg)
304{
305 return NULL;
306}
307
308static inline void put_lseg(struct pnfs_layout_segment *lseg)
309{
310}
311
e5e94017
BH
312static inline struct pnfs_layout_segment *
313pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
fb3296eb
BH
314 loff_t pos, u64 count, enum pnfs_iomode access_type,
315 gfp_t gfp_flags)
e5e94017
BH
316{
317 return NULL;
318}
319
64419a9b
AA
320static inline enum pnfs_try_status
321pnfs_try_to_read_data(struct nfs_read_data *data,
322 const struct rpc_call_ops *call_ops)
323{
324 return PNFS_NOT_ATTEMPTED;
325}
326
0382b744
AA
327static inline enum pnfs_try_status
328pnfs_try_to_write_data(struct nfs_write_data *data,
329 const struct rpc_call_ops *call_ops, int how)
330{
331 return PNFS_NOT_ATTEMPTED;
332}
333
cbe82603
BH
334static inline int pnfs_return_layout(struct inode *ino)
335{
336 return 0;
337}
338
8a1636c4
BH
339static inline bool
340pnfs_ld_layoutret_on_setattr(struct inode *inode)
341{
342 return false;
343}
344
f7e8917a
FI
345static inline bool
346pnfs_roc(struct inode *ino)
347{
348 return false;
349}
350
351static inline void
352pnfs_roc_release(struct inode *ino)
353{
354}
355
356static inline void
357pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
358{
359}
360
361static inline bool
362pnfs_roc_drain(struct inode *ino, u32 *barrier)
363{
364 return false;
365}
366
85e174ba
RL
367static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id)
368{
369}
370
371static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
372{
373}
374
94ad1c80
FI
375static inline void
376pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *ino)
377{
378 pgio->pg_test = NULL;
379}
380
44b83799
FI
381static inline void
382pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *ino)
383{
384 pgio->pg_test = NULL;
385}
386
a861a1e1
FI
387static inline void
388pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
389{
390}
391
392static inline int
393pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
394{
395 return PNFS_NOT_ATTEMPTED;
396}
397
398static inline struct list_head *
399pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
400{
401 return mds;
402}
403
404static inline void pnfs_clear_request_commit(struct nfs_page *req)
405{
406}
407
ef311537 408static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
863a3c6c
AA
409{
410 return 0;
411}
1775bc34
BH
412
413static inline void nfs4_deviceid_purge_client(struct nfs_client *ncl)
414{
415}
85e174ba
RL
416#endif /* CONFIG_NFS_V4_1 */
417
418#endif /* FS_NFS_PNFS_H */