2 * pNFS client data structures.
5 * The Regents of the University of Michigan
8 * Dean Hildebrand <dhildebz@umich.edu>
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.
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
33 #include <linux/nfs_fs.h>
34 #include <linux/nfs_page.h>
37 NFS_LSEG_VALID
= 0, /* cleared when lseg is recalled/returned */
38 NFS_LSEG_ROC
, /* roc bit received from server */
39 NFS_LSEG_LAYOUTCOMMIT
, /* layoutcommit bit set for layoutcommit */
42 struct pnfs_layout_segment
{
43 struct list_head pls_list
;
44 struct list_head pls_lc_list
;
45 struct pnfs_layout_range pls_range
;
46 atomic_t pls_refcount
;
47 unsigned long pls_flags
;
48 struct pnfs_layout_hdr
*pls_layout
;
51 enum pnfs_try_status
{
53 PNFS_NOT_ATTEMPTED
= 1,
56 #ifdef CONFIG_NFS_V4_1
58 #define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
61 NFS_LAYOUT_RO_FAILED
= 0, /* get ro layout failed stop trying */
62 NFS_LAYOUT_RW_FAILED
, /* get rw layout failed stop trying */
63 NFS_LAYOUT_BULK_RECALL
, /* bulk recall affecting layout */
64 NFS_LAYOUT_ROC
, /* some lseg had roc bit set */
65 NFS_LAYOUT_DESTROYED
, /* no new use of layout allowed */
66 NFS_LAYOUT_INVALID
, /* layout is being destroyed */
67 NFS_LAYOUT_RETURNED
, /* layout has already been returned */
70 enum layoutdriver_policy_flags
{
71 /* Should the pNFS client commit and return the layout upon a setattr */
72 PNFS_LAYOUTRET_ON_SETATTR
= 1 << 0,
73 PNFS_LAYOUTRET_ON_ERROR
= 1 << 1,
76 struct nfs4_deviceid_node
;
78 /* Per-layout driver specific registration structure */
79 struct pnfs_layoutdriver_type
{
80 struct list_head pnfs_tblid
;
86 int (*set_layoutdriver
) (struct nfs_server
*, const struct nfs_fh
*);
87 int (*clear_layoutdriver
) (struct nfs_server
*);
89 struct pnfs_layout_hdr
* (*alloc_layout_hdr
) (struct inode
*inode
, gfp_t gfp_flags
);
90 void (*free_layout_hdr
) (struct pnfs_layout_hdr
*);
92 struct pnfs_layout_segment
* (*alloc_lseg
) (struct pnfs_layout_hdr
*layoutid
, struct nfs4_layoutget_res
*lgr
, gfp_t gfp_flags
);
93 void (*free_lseg
) (struct pnfs_layout_segment
*lseg
);
95 /* test for nfs page cache coalescing */
96 const struct nfs_pageio_ops
*pg_read_ops
;
97 const struct nfs_pageio_ops
*pg_write_ops
;
99 struct pnfs_ds_commit_info
*(*get_ds_info
) (struct inode
*inode
);
100 void (*mark_request_commit
) (struct nfs_page
*req
,
101 struct pnfs_layout_segment
*lseg
,
102 struct nfs_commit_info
*cinfo
);
103 void (*clear_request_commit
) (struct nfs_page
*req
,
104 struct nfs_commit_info
*cinfo
);
105 int (*scan_commit_lists
) (struct nfs_commit_info
*cinfo
,
107 void (*recover_commit_reqs
) (struct list_head
*list
,
108 struct nfs_commit_info
*cinfo
);
109 int (*commit_pagelist
)(struct inode
*inode
,
110 struct list_head
*mds_pages
,
112 struct nfs_commit_info
*cinfo
);
115 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
116 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
118 enum pnfs_try_status (*read_pagelist
) (struct nfs_read_data
*nfs_data
);
119 enum pnfs_try_status (*write_pagelist
) (struct nfs_write_data
*nfs_data
, int how
);
121 void (*free_deviceid_node
) (struct nfs4_deviceid_node
*);
123 void (*encode_layoutreturn
) (struct pnfs_layout_hdr
*layoutid
,
124 struct xdr_stream
*xdr
,
125 const struct nfs4_layoutreturn_args
*args
);
127 void (*cleanup_layoutcommit
) (struct nfs4_layoutcommit_data
*data
);
129 void (*encode_layoutcommit
) (struct pnfs_layout_hdr
*layoutid
,
130 struct xdr_stream
*xdr
,
131 const struct nfs4_layoutcommit_args
*args
);
134 struct pnfs_layout_hdr
{
135 atomic_t plh_refcount
;
136 struct list_head plh_layouts
; /* other client layouts */
137 struct list_head plh_bulk_recall
; /* clnt list of bulk recalls */
138 struct list_head plh_segs
; /* layout segments list */
139 nfs4_stateid plh_stateid
;
140 atomic_t plh_outstanding
; /* number of RPCs out */
141 unsigned long plh_block_lgets
; /* block LAYOUTGET if >0 */
142 u32 plh_barrier
; /* ignore lower seqids */
143 unsigned long plh_flags
;
144 loff_t plh_lwb
; /* last write byte for layoutcommit */
145 struct rpc_cred
*plh_lc_cred
; /* layoutcommit cred */
146 struct inode
*plh_inode
;
150 struct nfs4_deviceid dev_id
;
151 unsigned int layout_type
;
152 unsigned int mincount
;
158 #define NFS4_PNFS_GETDEVLIST_MAXNUM 16
160 struct pnfs_devicelist
{
162 unsigned int num_devs
;
163 struct nfs4_deviceid dev_id
[NFS4_PNFS_GETDEVLIST_MAXNUM
];
166 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type
*);
167 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type
*);
170 extern int nfs4_proc_getdevicelist(struct nfs_server
*server
,
171 const struct nfs_fh
*fh
,
172 struct pnfs_devicelist
*devlist
);
173 extern int nfs4_proc_getdeviceinfo(struct nfs_server
*server
,
174 struct pnfs_device
*dev
);
175 extern int nfs4_proc_layoutget(struct nfs4_layoutget
*lgp
);
176 extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn
*lrp
);
179 void get_layout_hdr(struct pnfs_layout_hdr
*lo
);
180 void put_lseg(struct pnfs_layout_segment
*lseg
);
182 void pnfs_pageio_init_read(struct nfs_pageio_descriptor
*, struct inode
*,
183 const struct nfs_pgio_completion_ops
*);
184 void pnfs_pageio_init_write(struct nfs_pageio_descriptor
*, struct inode
*,
185 int, const struct nfs_pgio_completion_ops
*);
187 void set_pnfs_layoutdriver(struct nfs_server
*, const struct nfs_fh
*, u32
);
188 void unset_pnfs_layoutdriver(struct nfs_server
*);
189 void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor
*, struct nfs_page
*);
190 int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor
*desc
);
191 void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor
*, struct nfs_page
*);
192 int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor
*desc
);
193 bool pnfs_generic_pg_test(struct nfs_pageio_descriptor
*pgio
, struct nfs_page
*prev
, struct nfs_page
*req
);
194 void pnfs_set_lo_fail(struct pnfs_layout_segment
*lseg
);
195 int pnfs_layout_process(struct nfs4_layoutget
*lgp
);
196 void pnfs_free_lseg_list(struct list_head
*tmp_list
);
197 void pnfs_destroy_layout(struct nfs_inode
*);
198 void pnfs_destroy_all_layouts(struct nfs_client
*);
199 void put_layout_hdr(struct pnfs_layout_hdr
*lo
);
200 void pnfs_set_layout_stateid(struct pnfs_layout_hdr
*lo
,
201 const nfs4_stateid
*new,
202 bool update_barrier
);
203 int pnfs_choose_layoutget_stateid(nfs4_stateid
*dst
,
204 struct pnfs_layout_hdr
*lo
,
205 struct nfs4_state
*open_state
);
206 int mark_matching_lsegs_invalid(struct pnfs_layout_hdr
*lo
,
207 struct list_head
*tmp_list
,
208 struct pnfs_layout_range
*recall_range
);
209 bool pnfs_roc(struct inode
*ino
);
210 void pnfs_roc_release(struct inode
*ino
);
211 void pnfs_roc_set_barrier(struct inode
*ino
, u32 barrier
);
212 bool pnfs_roc_drain(struct inode
*ino
, u32
*barrier
);
213 void pnfs_set_layoutcommit(struct nfs_write_data
*wdata
);
214 void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data
*data
);
215 int pnfs_layoutcommit_inode(struct inode
*inode
, bool sync
);
216 int _pnfs_return_layout(struct inode
*);
217 void pnfs_ld_write_done(struct nfs_write_data
*);
218 void pnfs_ld_read_done(struct nfs_read_data
*);
219 struct pnfs_layout_segment
*pnfs_update_layout(struct inode
*ino
,
220 struct nfs_open_context
*ctx
,
223 enum pnfs_iomode iomode
,
226 void nfs4_deviceid_mark_client_invalid(struct nfs_client
*clp
);
227 int pnfs_read_done_resend_to_mds(struct inode
*inode
, struct list_head
*head
,
228 const struct nfs_pgio_completion_ops
*compl_ops
);
229 int pnfs_write_done_resend_to_mds(struct inode
*inode
, struct list_head
*head
,
230 const struct nfs_pgio_completion_ops
*compl_ops
);
231 struct nfs4_threshold
*pnfs_mdsthreshold_alloc(void);
233 /* nfs4_deviceid_flags */
235 NFS_DEVICEID_INVALID
= 0, /* set when MDS clientid recalled */
239 struct nfs4_deviceid_node
{
240 struct hlist_node node
;
241 struct hlist_node tmpnode
;
242 const struct pnfs_layoutdriver_type
*ld
;
243 const struct nfs_client
*nfs_client
;
245 struct nfs4_deviceid deviceid
;
249 struct nfs4_deviceid_node
*nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type
*, const struct nfs_client
*, const struct nfs4_deviceid
*);
250 void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type
*, const struct nfs_client
*, const struct nfs4_deviceid
*);
251 void nfs4_init_deviceid_node(struct nfs4_deviceid_node
*,
252 const struct pnfs_layoutdriver_type
*,
253 const struct nfs_client
*,
254 const struct nfs4_deviceid
*);
255 struct nfs4_deviceid_node
*nfs4_insert_deviceid_node(struct nfs4_deviceid_node
*);
256 bool nfs4_put_deviceid_node(struct nfs4_deviceid_node
*);
257 void nfs4_deviceid_purge_client(const struct nfs_client
*);
260 pnfs_mark_layout_returned(struct pnfs_layout_hdr
*lo
)
262 set_bit(NFS_LAYOUT_RETURNED
, &lo
->plh_flags
);
266 pnfs_clear_layout_returned(struct pnfs_layout_hdr
*lo
)
268 clear_bit(NFS_LAYOUT_RETURNED
, &lo
->plh_flags
);
272 pnfs_test_layout_returned(struct pnfs_layout_hdr
*lo
)
274 return test_bit(NFS_LAYOUT_RETURNED
, &lo
->plh_flags
);
277 static inline int lo_fail_bit(u32 iomode
)
279 return iomode
== IOMODE_RW
?
280 NFS_LAYOUT_RW_FAILED
: NFS_LAYOUT_RO_FAILED
;
283 static inline struct pnfs_layout_segment
*
284 get_lseg(struct pnfs_layout_segment
*lseg
)
287 atomic_inc(&lseg
->pls_refcount
);
288 smp_mb__after_atomic_inc();
293 /* Return true if a layout driver is being used for this mountpoint */
294 static inline int pnfs_enabled_sb(struct nfs_server
*nfss
)
296 return nfss
->pnfs_curr_ld
!= NULL
;
300 pnfs_commit_list(struct inode
*inode
, struct list_head
*mds_pages
, int how
,
301 struct nfs_commit_info
*cinfo
)
303 if (cinfo
->ds
== NULL
|| cinfo
->ds
->ncommitting
== 0)
304 return PNFS_NOT_ATTEMPTED
;
305 return NFS_SERVER(inode
)->pnfs_curr_ld
->commit_pagelist(inode
, mds_pages
, how
, cinfo
);
308 static inline struct pnfs_ds_commit_info
*
309 pnfs_get_ds_info(struct inode
*inode
)
311 struct pnfs_layoutdriver_type
*ld
= NFS_SERVER(inode
)->pnfs_curr_ld
;
313 if (ld
== NULL
|| ld
->get_ds_info
== NULL
)
315 return ld
->get_ds_info(inode
);
319 pnfs_mark_request_commit(struct nfs_page
*req
, struct pnfs_layout_segment
*lseg
,
320 struct nfs_commit_info
*cinfo
)
322 struct inode
*inode
= req
->wb_context
->dentry
->d_inode
;
323 struct pnfs_layoutdriver_type
*ld
= NFS_SERVER(inode
)->pnfs_curr_ld
;
325 if (lseg
== NULL
|| ld
->mark_request_commit
== NULL
)
327 ld
->mark_request_commit(req
, lseg
, cinfo
);
332 pnfs_clear_request_commit(struct nfs_page
*req
, struct nfs_commit_info
*cinfo
)
334 struct inode
*inode
= req
->wb_context
->dentry
->d_inode
;
335 struct pnfs_layoutdriver_type
*ld
= NFS_SERVER(inode
)->pnfs_curr_ld
;
337 if (ld
== NULL
|| ld
->clear_request_commit
== NULL
)
339 ld
->clear_request_commit(req
, cinfo
);
344 pnfs_scan_commit_lists(struct inode
*inode
, struct nfs_commit_info
*cinfo
,
347 if (cinfo
->ds
== NULL
|| cinfo
->ds
->nwritten
== 0)
350 return NFS_SERVER(inode
)->pnfs_curr_ld
->scan_commit_lists(cinfo
, max
);
354 pnfs_recover_commit_reqs(struct inode
*inode
, struct list_head
*list
,
355 struct nfs_commit_info
*cinfo
)
357 if (cinfo
->ds
== NULL
|| cinfo
->ds
->nwritten
== 0)
359 NFS_SERVER(inode
)->pnfs_curr_ld
->recover_commit_reqs(list
, cinfo
);
362 /* Should the pNFS client commit and return the layout upon a setattr */
364 pnfs_ld_layoutret_on_setattr(struct inode
*inode
)
366 if (!pnfs_enabled_sb(NFS_SERVER(inode
)))
368 return NFS_SERVER(inode
)->pnfs_curr_ld
->flags
&
369 PNFS_LAYOUTRET_ON_SETATTR
;
372 static inline int pnfs_return_layout(struct inode
*ino
)
374 struct nfs_inode
*nfsi
= NFS_I(ino
);
375 struct nfs_server
*nfss
= NFS_SERVER(ino
);
377 if (pnfs_enabled_sb(nfss
) && nfsi
->layout
)
378 return _pnfs_return_layout(ino
);
384 pnfs_use_threshold(struct nfs4_threshold
**dst
, struct nfs4_threshold
*src
,
385 struct nfs_server
*nfss
)
387 return (dst
&& src
&& src
->bm
!= 0 && nfss
->pnfs_curr_ld
&&
388 nfss
->pnfs_curr_ld
->id
== src
->l_type
);
392 void nfs4_print_deviceid(const struct nfs4_deviceid
*dev_id
);
394 static inline void nfs4_print_deviceid(const struct nfs4_deviceid
*dev_id
)
397 #endif /* NFS_DEBUG */
398 #else /* CONFIG_NFS_V4_1 */
400 static inline void pnfs_destroy_all_layouts(struct nfs_client
*clp
)
404 static inline void pnfs_destroy_layout(struct nfs_inode
*nfsi
)
408 static inline struct pnfs_layout_segment
*
409 get_lseg(struct pnfs_layout_segment
*lseg
)
414 static inline void put_lseg(struct pnfs_layout_segment
*lseg
)
418 static inline int pnfs_return_layout(struct inode
*ino
)
424 pnfs_ld_layoutret_on_setattr(struct inode
*inode
)
430 pnfs_roc(struct inode
*ino
)
436 pnfs_roc_release(struct inode
*ino
)
441 pnfs_roc_set_barrier(struct inode
*ino
, u32 barrier
)
446 pnfs_roc_drain(struct inode
*ino
, u32
*barrier
)
451 static inline void set_pnfs_layoutdriver(struct nfs_server
*s
,
452 const struct nfs_fh
*mntfh
, u32 id
)
456 static inline void unset_pnfs_layoutdriver(struct nfs_server
*s
)
460 static inline void pnfs_pageio_init_read(struct nfs_pageio_descriptor
*pgio
, struct inode
*inode
,
461 const struct nfs_pgio_completion_ops
*compl_ops
)
463 nfs_pageio_init_read(pgio
, inode
, compl_ops
);
466 static inline void pnfs_pageio_init_write(struct nfs_pageio_descriptor
*pgio
, struct inode
*inode
, int ioflags
,
467 const struct nfs_pgio_completion_ops
*compl_ops
)
469 nfs_pageio_init_write(pgio
, inode
, ioflags
, compl_ops
);
473 pnfs_commit_list(struct inode
*inode
, struct list_head
*mds_pages
, int how
,
474 struct nfs_commit_info
*cinfo
)
476 return PNFS_NOT_ATTEMPTED
;
479 static inline struct pnfs_ds_commit_info
*
480 pnfs_get_ds_info(struct inode
*inode
)
486 pnfs_mark_request_commit(struct nfs_page
*req
, struct pnfs_layout_segment
*lseg
,
487 struct nfs_commit_info
*cinfo
)
493 pnfs_clear_request_commit(struct nfs_page
*req
, struct nfs_commit_info
*cinfo
)
499 pnfs_scan_commit_lists(struct inode
*inode
, struct nfs_commit_info
*cinfo
,
506 pnfs_recover_commit_reqs(struct inode
*inode
, struct list_head
*list
,
507 struct nfs_commit_info
*cinfo
)
511 static inline int pnfs_layoutcommit_inode(struct inode
*inode
, bool sync
)
517 pnfs_use_threshold(struct nfs4_threshold
**dst
, struct nfs4_threshold
*src
,
518 struct nfs_server
*nfss
)
523 static inline struct nfs4_threshold
*pnfs_mdsthreshold_alloc(void)
528 #endif /* CONFIG_NFS_V4_1 */
530 #endif /* FS_NFS_PNFS_H */