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