pnfs-obj: osd raid engine read/write implementation
[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
1775bc34
BH
68struct nfs4_deviceid_node;
69
85e174ba
RL
70/* Per-layout driver specific registration structure */
71struct pnfs_layoutdriver_type {
02c35fca
FI
72 struct list_head pnfs_tblid;
73 const u32 id;
74 const char *name;
75 struct module *owner;
636fb9c8
BH
76
77 struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
78 void (*free_layout_hdr) (struct pnfs_layout_hdr *);
79
a75b9df9 80 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
b1f69b75 81 void (*free_lseg) (struct pnfs_layout_segment *lseg);
94ad1c80
FI
82
83 /* test for nfs page cache coalescing */
84 int (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *);
64419a9b 85
a861a1e1
FI
86 /* Returns true if layoutdriver wants to divert this request to
87 * driver's commit routine.
88 */
89 bool (*mark_pnfs_commit)(struct pnfs_layout_segment *lseg);
90 struct list_head * (*choose_commit_list) (struct nfs_page *req);
91 int (*commit_pagelist)(struct inode *inode, struct list_head *mds_pages, int how);
92
64419a9b
AA
93 /*
94 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
95 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
96 */
97 enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data);
0382b744 98 enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);
1775bc34
BH
99
100 void (*free_deviceid_node) (struct nfs4_deviceid_node *);
85e174ba
RL
101};
102
e5e94017 103struct pnfs_layout_hdr {
cc6e5340 104 atomic_t plh_refcount;
b7edfaa1 105 struct list_head plh_layouts; /* other client layouts */
43f1b3da 106 struct list_head plh_bulk_recall; /* clnt list of bulk recalls */
b7edfaa1 107 struct list_head plh_segs; /* layout segments list */
b7edfaa1 108 nfs4_stateid plh_stateid;
cf7d63f1 109 atomic_t plh_outstanding; /* number of RPCs out */
f7e8917a 110 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
43f1b3da 111 u32 plh_barrier; /* ignore lower seqids */
566052c5 112 unsigned long plh_flags;
b7edfaa1 113 struct inode *plh_inode;
e5e94017
BH
114};
115
b1f69b75
AA
116struct pnfs_device {
117 struct nfs4_deviceid dev_id;
118 unsigned int layout_type;
119 unsigned int mincount;
120 struct page **pages;
b1f69b75
AA
121 unsigned int pgbase;
122 unsigned int pglen;
123};
124
02c35fca
FI
125extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
126extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
127
b1f69b75
AA
128/* nfs4proc.c */
129extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
130 struct pnfs_device *dev);
131extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
132
133/* pnfs.c */
43f1b3da 134void get_layout_hdr(struct pnfs_layout_hdr *lo);
bae724ef 135void put_lseg(struct pnfs_layout_segment *lseg);
e5e94017
BH
136struct pnfs_layout_segment *
137pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
fb3296eb
BH
138 loff_t pos, u64 count, enum pnfs_iomode access_type,
139 gfp_t gfp_flags);
85e174ba
RL
140void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
141void unset_pnfs_layoutdriver(struct nfs_server *);
0382b744
AA
142enum pnfs_try_status pnfs_try_to_write_data(struct nfs_write_data *,
143 const struct rpc_call_ops *, int);
64419a9b
AA
144enum pnfs_try_status pnfs_try_to_read_data(struct nfs_read_data *,
145 const struct rpc_call_ops *);
94ad1c80 146void pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *);
44b83799 147void pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *);
b1f69b75 148int pnfs_layout_process(struct nfs4_layoutget *lgp);
43f1b3da 149void pnfs_free_lseg_list(struct list_head *tmp_list);
e5e94017 150void pnfs_destroy_layout(struct nfs_inode *);
974cec8c 151void pnfs_destroy_all_layouts(struct nfs_client *);
cc6e5340 152void put_layout_hdr(struct pnfs_layout_hdr *lo);
43f1b3da
FI
153void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
154 const nfs4_stateid *new,
155 bool update_barrier);
fd6002e9
FI
156int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
157 struct pnfs_layout_hdr *lo,
158 struct nfs4_state *open_state);
43f1b3da
FI
159int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
160 struct list_head *tmp_list,
778b5502 161 struct pnfs_layout_range *recall_range);
f7e8917a
FI
162bool pnfs_roc(struct inode *ino);
163void pnfs_roc_release(struct inode *ino);
164void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
165bool pnfs_roc_drain(struct inode *ino, u32 *barrier);
863a3c6c 166void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
ef311537 167int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
d20581aa
BH
168int pnfs_ld_write_done(struct nfs_write_data *);
169int pnfs_ld_read_done(struct nfs_read_data *);
e5e94017 170
a1eaecbc
BH
171/* pnfs_dev.c */
172struct nfs4_deviceid_node {
173 struct hlist_node node;
1775bc34 174 const struct pnfs_layoutdriver_type *ld;
a1eaecbc
BH
175 const struct nfs_client *nfs_client;
176 struct nfs4_deviceid deviceid;
177 atomic_t ref;
178};
179
180void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
35c8bb54
BH
181struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
182struct nfs4_deviceid_node *nfs4_unhash_put_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
183void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
a1eaecbc 184void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
1775bc34 185 const struct pnfs_layoutdriver_type *,
a1eaecbc
BH
186 const struct nfs_client *,
187 const struct nfs4_deviceid *);
188struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *);
189bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
1775bc34 190void nfs4_deviceid_purge_client(const struct nfs_client *);
a1eaecbc 191
e5e94017
BH
192static inline int lo_fail_bit(u32 iomode)
193{
194 return iomode == IOMODE_RW ?
195 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
196}
197
d684d2ae
FI
198static inline struct pnfs_layout_segment *
199get_lseg(struct pnfs_layout_segment *lseg)
200{
201 if (lseg) {
202 atomic_inc(&lseg->pls_refcount);
203 smp_mb__after_atomic_inc();
204 }
205 return lseg;
206}
207
e5e94017
BH
208/* Return true if a layout driver is being used for this mountpoint */
209static inline int pnfs_enabled_sb(struct nfs_server *nfss)
210{
211 return nfss->pnfs_curr_ld != NULL;
212}
85e174ba 213
a861a1e1
FI
214static inline void
215pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
216{
217 if (lseg) {
218 struct pnfs_layoutdriver_type *ld;
219
220 ld = NFS_SERVER(req->wb_page->mapping->host)->pnfs_curr_ld;
221 if (ld->mark_pnfs_commit && ld->mark_pnfs_commit(lseg)) {
222 set_bit(PG_PNFS_COMMIT, &req->wb_flags);
223 req->wb_commit_lseg = get_lseg(lseg);
224 }
225 }
226}
227
228static inline int
229pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
230{
231 if (!test_and_clear_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags))
232 return PNFS_NOT_ATTEMPTED;
233 return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how);
234}
235
236static inline struct list_head *
237pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
238{
239 struct list_head *rv;
240
241 if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags)) {
242 struct inode *inode = req->wb_commit_lseg->pls_layout->plh_inode;
243
244 set_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags);
245 rv = NFS_SERVER(inode)->pnfs_curr_ld->choose_commit_list(req);
246 /* matched by ref taken when PG_PNFS_COMMIT is set */
247 put_lseg(req->wb_commit_lseg);
248 } else
249 rv = mds;
250 return rv;
251}
252
253static inline void pnfs_clear_request_commit(struct nfs_page *req)
254{
255 if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags))
256 put_lseg(req->wb_commit_lseg);
257}
258
85e174ba
RL
259#else /* CONFIG_NFS_V4_1 */
260
974cec8c
AA
261static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
262{
263}
264
e5e94017
BH
265static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
266{
267}
268
d684d2ae
FI
269static inline struct pnfs_layout_segment *
270get_lseg(struct pnfs_layout_segment *lseg)
271{
272 return NULL;
273}
274
275static inline void put_lseg(struct pnfs_layout_segment *lseg)
276{
277}
278
e5e94017
BH
279static inline struct pnfs_layout_segment *
280pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
fb3296eb
BH
281 loff_t pos, u64 count, enum pnfs_iomode access_type,
282 gfp_t gfp_flags)
e5e94017
BH
283{
284 return NULL;
285}
286
64419a9b
AA
287static inline enum pnfs_try_status
288pnfs_try_to_read_data(struct nfs_read_data *data,
289 const struct rpc_call_ops *call_ops)
290{
291 return PNFS_NOT_ATTEMPTED;
292}
293
0382b744
AA
294static inline enum pnfs_try_status
295pnfs_try_to_write_data(struct nfs_write_data *data,
296 const struct rpc_call_ops *call_ops, int how)
297{
298 return PNFS_NOT_ATTEMPTED;
299}
300
f7e8917a
FI
301static inline bool
302pnfs_roc(struct inode *ino)
303{
304 return false;
305}
306
307static inline void
308pnfs_roc_release(struct inode *ino)
309{
310}
311
312static inline void
313pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
314{
315}
316
317static inline bool
318pnfs_roc_drain(struct inode *ino, u32 *barrier)
319{
320 return false;
321}
322
85e174ba
RL
323static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id)
324{
325}
326
327static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
328{
329}
330
94ad1c80
FI
331static inline void
332pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *ino)
333{
334 pgio->pg_test = NULL;
335}
336
44b83799
FI
337static inline void
338pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *ino)
339{
340 pgio->pg_test = NULL;
341}
342
a861a1e1
FI
343static inline void
344pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
345{
346}
347
348static inline int
349pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
350{
351 return PNFS_NOT_ATTEMPTED;
352}
353
354static inline struct list_head *
355pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
356{
357 return mds;
358}
359
360static inline void pnfs_clear_request_commit(struct nfs_page *req)
361{
362}
363
ef311537 364static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
863a3c6c
AA
365{
366 return 0;
367}
1775bc34
BH
368
369static inline void nfs4_deviceid_purge_client(struct nfs_client *ncl)
370{
371}
85e174ba
RL
372#endif /* CONFIG_NFS_V4_1 */
373
374#endif /* FS_NFS_PNFS_H */
This page took 0.080113 seconds and 5 git commands to generate.