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