pnfs: GETDEVICELIST
[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
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 */
a9bae566 39 NFS_LSEG_LAYOUTCOMMIT, /* layoutcommit bit set for layoutcommit */
4541d16c
FI
40};
41
974cec8c 42struct pnfs_layout_segment {
566052c5 43 struct list_head pls_list;
a9bae566 44 struct list_head pls_lc_list;
566052c5 45 struct pnfs_layout_range pls_range;
4541d16c
FI
46 atomic_t pls_refcount;
47 unsigned long pls_flags;
566052c5 48 struct pnfs_layout_hdr *pls_layout;
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;
acff5880 128 loff_t plh_lwb; /* last write byte for layoutcommit */
9fa40758 129 struct rpc_cred *plh_lc_cred; /* layoutcommit cred */
b7edfaa1 130 struct inode *plh_inode;
e5e94017
BH
131};
132
b1f69b75
AA
133struct pnfs_device {
134 struct nfs4_deviceid dev_id;
135 unsigned int layout_type;
136 unsigned int mincount;
137 struct page **pages;
7f11d8d3 138 void *area;
b1f69b75
AA
139 unsigned int pgbase;
140 unsigned int pglen;
141};
142
7f11d8d3
AA
143#define NFS4_PNFS_GETDEVLIST_MAXNUM 16
144
145struct pnfs_devicelist {
146 unsigned int eof;
147 unsigned int num_devs;
148 struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
149};
150
02c35fca
FI
151extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
152extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
153
b1f69b75 154/* nfs4proc.c */
7f11d8d3
AA
155extern int nfs4_proc_getdevicelist(struct nfs_server *server,
156 const struct nfs_fh *fh,
157 struct pnfs_devicelist *devlist);
b1f69b75
AA
158extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
159 struct pnfs_device *dev);
160extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
cbe82603 161extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
b1f69b75
AA
162
163/* pnfs.c */
43f1b3da 164void get_layout_hdr(struct pnfs_layout_hdr *lo);
bae724ef 165void put_lseg(struct pnfs_layout_segment *lseg);
1751c363
TM
166
167bool pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *);
168bool pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *, int);
169
85e174ba
RL
170void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
171void unset_pnfs_layoutdriver(struct nfs_server *);
d8007d4d 172void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
493292dd 173int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
d8007d4d 174void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *, struct nfs_page *);
dce81290 175int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
18ad0a9f 176bool pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev, struct nfs_page *req);
b1f69b75 177int pnfs_layout_process(struct nfs4_layoutget *lgp);
43f1b3da 178void pnfs_free_lseg_list(struct list_head *tmp_list);
e5e94017 179void pnfs_destroy_layout(struct nfs_inode *);
974cec8c 180void pnfs_destroy_all_layouts(struct nfs_client *);
cc6e5340 181void put_layout_hdr(struct pnfs_layout_hdr *lo);
43f1b3da
FI
182void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
183 const nfs4_stateid *new,
184 bool update_barrier);
fd6002e9
FI
185int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
186 struct pnfs_layout_hdr *lo,
187 struct nfs4_state *open_state);
43f1b3da
FI
188int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
189 struct list_head *tmp_list,
778b5502 190 struct pnfs_layout_range *recall_range);
f7e8917a
FI
191bool pnfs_roc(struct inode *ino);
192void pnfs_roc_release(struct inode *ino);
193void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
194bool pnfs_roc_drain(struct inode *ino, u32 *barrier);
863a3c6c 195void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
ef311537 196int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
cbe82603 197int _pnfs_return_layout(struct inode *);
d20581aa
BH
198int pnfs_ld_write_done(struct nfs_write_data *);
199int pnfs_ld_read_done(struct nfs_read_data *);
7c24d948
AA
200struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
201 struct nfs_open_context *ctx,
202 loff_t pos,
203 u64 count,
204 enum pnfs_iomode iomode,
205 gfp_t gfp_flags);
e5e94017 206
c47abcf8
AA
207void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
208
209/* nfs4_deviceid_flags */
210enum {
211 NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
212};
213
a1eaecbc
BH
214/* pnfs_dev.c */
215struct nfs4_deviceid_node {
216 struct hlist_node node;
9e3bd4e2 217 struct hlist_node tmpnode;
1775bc34 218 const struct pnfs_layoutdriver_type *ld;
a1eaecbc 219 const struct nfs_client *nfs_client;
c47abcf8 220 unsigned long flags;
a1eaecbc
BH
221 struct nfs4_deviceid deviceid;
222 atomic_t ref;
223};
224
225void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
35c8bb54 226struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
35c8bb54 227void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
a1eaecbc 228void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
1775bc34 229 const struct pnfs_layoutdriver_type *,
a1eaecbc
BH
230 const struct nfs_client *,
231 const struct nfs4_deviceid *);
232struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *);
233bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
1775bc34 234void nfs4_deviceid_purge_client(const struct nfs_client *);
a1eaecbc 235
e5e94017
BH
236static inline int lo_fail_bit(u32 iomode)
237{
238 return iomode == IOMODE_RW ?
239 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
240}
241
d684d2ae
FI
242static inline struct pnfs_layout_segment *
243get_lseg(struct pnfs_layout_segment *lseg)
244{
245 if (lseg) {
246 atomic_inc(&lseg->pls_refcount);
247 smp_mb__after_atomic_inc();
248 }
249 return lseg;
250}
251
e5e94017
BH
252/* Return true if a layout driver is being used for this mountpoint */
253static inline int pnfs_enabled_sb(struct nfs_server *nfss)
254{
255 return nfss->pnfs_curr_ld != NULL;
256}
85e174ba 257
a861a1e1
FI
258static inline void
259pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
260{
261 if (lseg) {
262 struct pnfs_layoutdriver_type *ld;
263
264 ld = NFS_SERVER(req->wb_page->mapping->host)->pnfs_curr_ld;
265 if (ld->mark_pnfs_commit && ld->mark_pnfs_commit(lseg)) {
266 set_bit(PG_PNFS_COMMIT, &req->wb_flags);
267 req->wb_commit_lseg = get_lseg(lseg);
268 }
269 }
270}
271
272static inline int
273pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
274{
275 if (!test_and_clear_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags))
276 return PNFS_NOT_ATTEMPTED;
277 return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how);
278}
279
280static inline struct list_head *
281pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
282{
283 struct list_head *rv;
284
285 if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags)) {
286 struct inode *inode = req->wb_commit_lseg->pls_layout->plh_inode;
287
288 set_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags);
289 rv = NFS_SERVER(inode)->pnfs_curr_ld->choose_commit_list(req);
290 /* matched by ref taken when PG_PNFS_COMMIT is set */
291 put_lseg(req->wb_commit_lseg);
292 } else
293 rv = mds;
294 return rv;
295}
296
297static inline void pnfs_clear_request_commit(struct nfs_page *req)
298{
299 if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags))
300 put_lseg(req->wb_commit_lseg);
301}
302
8a1636c4
BH
303/* Should the pNFS client commit and return the layout upon a setattr */
304static inline bool
305pnfs_ld_layoutret_on_setattr(struct inode *inode)
306{
307 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
308 return false;
309 return NFS_SERVER(inode)->pnfs_curr_ld->flags &
310 PNFS_LAYOUTRET_ON_SETATTR;
311}
312
cbe82603
BH
313static inline int pnfs_return_layout(struct inode *ino)
314{
315 struct nfs_inode *nfsi = NFS_I(ino);
316 struct nfs_server *nfss = NFS_SERVER(ino);
317
318 if (pnfs_enabled_sb(nfss) && nfsi->layout)
319 return _pnfs_return_layout(ino);
320
321 return 0;
322}
323
85e174ba
RL
324#else /* CONFIG_NFS_V4_1 */
325
974cec8c
AA
326static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
327{
328}
329
e5e94017
BH
330static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
331{
332}
333
d684d2ae
FI
334static inline struct pnfs_layout_segment *
335get_lseg(struct pnfs_layout_segment *lseg)
336{
337 return NULL;
338}
339
340static inline void put_lseg(struct pnfs_layout_segment *lseg)
341{
342}
343
cbe82603
BH
344static inline int pnfs_return_layout(struct inode *ino)
345{
346 return 0;
347}
348
8a1636c4
BH
349static inline bool
350pnfs_ld_layoutret_on_setattr(struct inode *inode)
351{
352 return false;
353}
354
f7e8917a
FI
355static inline bool
356pnfs_roc(struct inode *ino)
357{
358 return false;
359}
360
361static inline void
362pnfs_roc_release(struct inode *ino)
363{
364}
365
366static inline void
367pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
368{
369}
370
371static inline bool
372pnfs_roc_drain(struct inode *ino, u32 *barrier)
373{
374 return false;
375}
376
85e174ba
RL
377static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id)
378{
379}
380
381static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
382{
383}
384
1751c363 385static inline bool pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *inode)
44b83799 386{
1751c363
TM
387 return false;
388}
389
390static inline bool pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *inode, int ioflags)
391{
392 return false;
44b83799
FI
393}
394
a861a1e1
FI
395static inline void
396pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
397{
398}
399
400static inline int
401pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
402{
403 return PNFS_NOT_ATTEMPTED;
404}
405
406static inline struct list_head *
407pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
408{
409 return mds;
410}
411
412static inline void pnfs_clear_request_commit(struct nfs_page *req)
413{
414}
415
ef311537 416static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
863a3c6c
AA
417{
418 return 0;
419}
1775bc34
BH
420
421static inline void nfs4_deviceid_purge_client(struct nfs_client *ncl)
422{
423}
85e174ba
RL
424#endif /* CONFIG_NFS_V4_1 */
425
426#endif /* FS_NFS_PNFS_H */