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>
35 #include <linux/workqueue.h>
38 NFS_LSEG_VALID
= 0, /* cleared when lseg is recalled/returned */
39 NFS_LSEG_ROC
, /* roc bit received from server */
40 NFS_LSEG_LAYOUTCOMMIT
, /* layoutcommit bit set for layoutcommit */
41 NFS_LSEG_LAYOUTRETURN
, /* layoutreturn bit set for layoutreturn */
44 /* Individual ip address */
45 struct nfs4_pnfs_ds_addr
{
46 struct sockaddr_storage da_addr
;
48 struct list_head da_node
; /* nfs4_pnfs_dev_hlist dev_dslist */
49 char *da_remotestr
; /* human readable addr+port */
53 struct list_head ds_node
; /* nfs4_pnfs_dev_hlist dev_dslist */
54 char *ds_remotestr
; /* comma sep list of addrs */
55 struct list_head ds_addrs
;
56 struct nfs_client
*ds_clp
;
58 unsigned long ds_state
;
59 #define NFS4DS_CONNECTING 0 /* ds is establishing connection */
62 struct pnfs_layout_segment
{
63 struct list_head pls_list
;
64 struct list_head pls_lc_list
;
65 struct pnfs_layout_range pls_range
;
66 atomic_t pls_refcount
;
67 unsigned long pls_flags
;
68 struct pnfs_layout_hdr
*pls_layout
;
69 struct work_struct pls_work
;
72 enum pnfs_try_status
{
74 PNFS_NOT_ATTEMPTED
= 1,
77 #ifdef CONFIG_NFS_V4_1
79 #define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
82 * Default data server connection timeout and retrans vaules.
83 * Set by module parameters dataserver_timeo and dataserver_retrans.
85 #define NFS4_DEF_DS_TIMEO 600 /* in tenths of a second */
86 #define NFS4_DEF_DS_RETRANS 5
88 /* error codes for internal use */
89 #define NFS4ERR_RESET_TO_MDS 12001
90 #define NFS4ERR_RESET_TO_PNFS 12002
93 NFS_LAYOUT_RO_FAILED
= 0, /* get ro layout failed stop trying */
94 NFS_LAYOUT_RW_FAILED
, /* get rw layout failed stop trying */
95 NFS_LAYOUT_BULK_RECALL
, /* bulk recall affecting layout */
96 NFS_LAYOUT_ROC
, /* some lseg had roc bit set */
97 NFS_LAYOUT_RETURN
, /* Return this layout ASAP */
98 NFS_LAYOUT_INVALID_STID
, /* layout stateid id is invalid */
99 NFS_LAYOUT_FIRST_LAYOUTGET
, /* Serialize first layoutget */
102 enum layoutdriver_policy_flags
{
103 /* Should the pNFS client commit and return the layout upon truncate to
105 PNFS_LAYOUTRET_ON_SETATTR
= 1 << 0,
106 PNFS_LAYOUTRET_ON_ERROR
= 1 << 1,
107 PNFS_READ_WHOLE_PAGE
= 1 << 2,
110 struct nfs4_deviceid_node
;
112 /* Per-layout driver specific registration structure */
113 struct pnfs_layoutdriver_type
{
114 struct list_head pnfs_tblid
;
117 struct module
*owner
;
119 unsigned max_deviceinfo_size
;
121 int (*set_layoutdriver
) (struct nfs_server
*, const struct nfs_fh
*);
122 int (*clear_layoutdriver
) (struct nfs_server
*);
124 struct pnfs_layout_hdr
* (*alloc_layout_hdr
) (struct inode
*inode
, gfp_t gfp_flags
);
125 void (*free_layout_hdr
) (struct pnfs_layout_hdr
*);
127 struct pnfs_layout_segment
* (*alloc_lseg
) (struct pnfs_layout_hdr
*layoutid
, struct nfs4_layoutget_res
*lgr
, gfp_t gfp_flags
);
128 void (*free_lseg
) (struct pnfs_layout_segment
*lseg
);
130 void (*return_range
) (struct pnfs_layout_hdr
*lo
,
131 struct pnfs_layout_range
*range
);
133 /* test for nfs page cache coalescing */
134 const struct nfs_pageio_ops
*pg_read_ops
;
135 const struct nfs_pageio_ops
*pg_write_ops
;
137 struct pnfs_ds_commit_info
*(*get_ds_info
) (struct inode
*inode
);
138 void (*mark_request_commit
) (struct nfs_page
*req
,
139 struct pnfs_layout_segment
*lseg
,
140 struct nfs_commit_info
*cinfo
);
141 void (*clear_request_commit
) (struct nfs_page
*req
,
142 struct nfs_commit_info
*cinfo
);
143 int (*scan_commit_lists
) (struct nfs_commit_info
*cinfo
,
145 void (*recover_commit_reqs
) (struct list_head
*list
,
146 struct nfs_commit_info
*cinfo
);
147 struct nfs_page
* (*search_commit_reqs
)(struct nfs_commit_info
*cinfo
,
149 int (*commit_pagelist
)(struct inode
*inode
,
150 struct list_head
*mds_pages
,
152 struct nfs_commit_info
*cinfo
);
155 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
156 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
158 enum pnfs_try_status (*read_pagelist
)(struct nfs_pgio_header
*);
159 enum pnfs_try_status (*write_pagelist
)(struct nfs_pgio_header
*, int);
161 void (*free_deviceid_node
) (struct nfs4_deviceid_node
*);
162 struct nfs4_deviceid_node
* (*alloc_deviceid_node
)
163 (struct nfs_server
*server
, struct pnfs_device
*pdev
,
166 void (*encode_layoutreturn
) (struct pnfs_layout_hdr
*layoutid
,
167 struct xdr_stream
*xdr
,
168 const struct nfs4_layoutreturn_args
*args
);
170 void (*cleanup_layoutcommit
) (struct nfs4_layoutcommit_data
*data
);
171 int (*prepare_layoutcommit
) (struct nfs4_layoutcommit_args
*args
);
172 void (*encode_layoutcommit
) (struct pnfs_layout_hdr
*lo
,
173 struct xdr_stream
*xdr
,
174 const struct nfs4_layoutcommit_args
*args
);
177 struct pnfs_layout_hdr
{
178 atomic_t plh_refcount
;
179 struct list_head plh_layouts
; /* other client layouts */
180 struct list_head plh_bulk_destroy
;
181 struct list_head plh_segs
; /* layout segments list */
182 nfs4_stateid plh_stateid
;
183 atomic_t plh_outstanding
; /* number of RPCs out */
184 unsigned long plh_block_lgets
; /* block LAYOUTGET if >0 */
185 u32 plh_barrier
; /* ignore lower seqids */
186 unsigned long plh_retry_timestamp
;
187 unsigned long plh_flags
;
188 enum pnfs_iomode plh_return_iomode
;
189 loff_t plh_lwb
; /* last write byte for layoutcommit */
190 struct rpc_cred
*plh_lc_cred
; /* layoutcommit cred */
191 struct inode
*plh_inode
;
195 struct nfs4_deviceid dev_id
;
196 unsigned int layout_type
;
197 unsigned int mincount
;
198 unsigned int maxcount
; /* gdia_maxcount */
201 unsigned int pglen
; /* reply buffer length */
204 #define NFS4_PNFS_GETDEVLIST_MAXNUM 16
206 struct pnfs_devicelist
{
208 unsigned int num_devs
;
209 struct nfs4_deviceid dev_id
[NFS4_PNFS_GETDEVLIST_MAXNUM
];
212 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type
*);
213 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type
*);
216 extern int nfs4_proc_getdeviceinfo(struct nfs_server
*server
,
217 struct pnfs_device
*dev
,
218 struct rpc_cred
*cred
);
219 extern struct pnfs_layout_segment
* nfs4_proc_layoutget(struct nfs4_layoutget
*lgp
, gfp_t gfp_flags
);
220 extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn
*lrp
);
223 void pnfs_get_layout_hdr(struct pnfs_layout_hdr
*lo
);
224 void pnfs_put_lseg(struct pnfs_layout_segment
*lseg
);
225 void pnfs_put_lseg_locked(struct pnfs_layout_segment
*lseg
);
227 void set_pnfs_layoutdriver(struct nfs_server
*, const struct nfs_fh
*, u32
);
228 void unset_pnfs_layoutdriver(struct nfs_server
*);
229 void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor
*, struct nfs_page
*);
230 int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor
*desc
);
231 void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor
*pgio
,
232 struct nfs_page
*req
, u64 wb_size
);
233 int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor
*desc
);
234 size_t pnfs_generic_pg_test(struct nfs_pageio_descriptor
*pgio
,
235 struct nfs_page
*prev
, struct nfs_page
*req
);
236 void pnfs_set_lo_fail(struct pnfs_layout_segment
*lseg
);
237 struct pnfs_layout_segment
*pnfs_layout_process(struct nfs4_layoutget
*lgp
);
238 void pnfs_free_lseg_list(struct list_head
*tmp_list
);
239 void pnfs_destroy_layout(struct nfs_inode
*);
240 void pnfs_destroy_all_layouts(struct nfs_client
*);
241 int pnfs_destroy_layouts_byfsid(struct nfs_client
*clp
,
242 struct nfs_fsid
*fsid
,
244 int pnfs_destroy_layouts_byclid(struct nfs_client
*clp
,
246 void pnfs_put_layout_hdr(struct pnfs_layout_hdr
*lo
);
247 void pnfs_set_layout_stateid(struct pnfs_layout_hdr
*lo
,
248 const nfs4_stateid
*new,
249 bool update_barrier
);
250 int pnfs_choose_layoutget_stateid(nfs4_stateid
*dst
,
251 struct pnfs_layout_hdr
*lo
,
252 struct pnfs_layout_range
*range
,
253 struct nfs4_state
*open_state
);
254 int pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr
*lo
,
255 struct list_head
*tmp_list
,
256 struct pnfs_layout_range
*recall_range
);
257 bool pnfs_roc(struct inode
*ino
);
258 void pnfs_roc_release(struct inode
*ino
);
259 void pnfs_roc_set_barrier(struct inode
*ino
, u32 barrier
);
260 bool pnfs_roc_drain(struct inode
*ino
, u32
*barrier
, struct rpc_task
*task
);
261 void pnfs_set_layoutcommit(struct nfs_pgio_header
*);
262 void pnfs_commit_set_layoutcommit(struct nfs_commit_data
*data
);
263 void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data
*data
);
264 int pnfs_layoutcommit_inode(struct inode
*inode
, bool sync
);
265 int _pnfs_return_layout(struct inode
*);
266 int pnfs_commit_and_return_layout(struct inode
*);
267 void pnfs_ld_write_done(struct nfs_pgio_header
*);
268 void pnfs_ld_read_done(struct nfs_pgio_header
*);
269 struct pnfs_layout_segment
*pnfs_update_layout(struct inode
*ino
,
270 struct nfs_open_context
*ctx
,
273 enum pnfs_iomode iomode
,
276 void nfs4_deviceid_mark_client_invalid(struct nfs_client
*clp
);
277 int pnfs_read_done_resend_to_mds(struct nfs_pgio_header
*);
278 int pnfs_write_done_resend_to_mds(struct nfs_pgio_header
*);
279 struct nfs4_threshold
*pnfs_mdsthreshold_alloc(void);
280 void pnfs_error_mark_layout_for_return(struct inode
*inode
,
281 struct pnfs_layout_segment
*lseg
);
283 /* nfs4_deviceid_flags */
285 NFS_DEVICEID_INVALID
= 0, /* set when MDS clientid recalled */
286 NFS_DEVICEID_UNAVAILABLE
, /* device temporarily unavailable */
290 struct nfs4_deviceid_node
{
291 struct hlist_node node
;
292 struct hlist_node tmpnode
;
293 const struct pnfs_layoutdriver_type
*ld
;
294 const struct nfs_client
*nfs_client
;
296 unsigned long timestamp_unavailable
;
297 struct nfs4_deviceid deviceid
;
301 struct nfs4_deviceid_node
*
302 nfs4_find_get_deviceid(struct nfs_server
*server
,
303 const struct nfs4_deviceid
*id
, struct rpc_cred
*cred
,
305 void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type
*, const struct nfs_client
*, const struct nfs4_deviceid
*);
306 void nfs4_init_deviceid_node(struct nfs4_deviceid_node
*, struct nfs_server
*,
307 const struct nfs4_deviceid
*);
308 bool nfs4_put_deviceid_node(struct nfs4_deviceid_node
*);
309 void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node
*node
);
310 bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node
*node
);
311 void nfs4_deviceid_purge_client(const struct nfs_client
*);
314 void pnfs_generic_clear_request_commit(struct nfs_page
*req
,
315 struct nfs_commit_info
*cinfo
);
316 void pnfs_generic_commit_release(void *calldata
);
317 void pnfs_generic_prepare_to_resend_writes(struct nfs_commit_data
*data
);
318 void pnfs_generic_rw_release(void *data
);
319 void pnfs_generic_recover_commit_reqs(struct list_head
*dst
,
320 struct nfs_commit_info
*cinfo
);
321 int pnfs_generic_commit_pagelist(struct inode
*inode
,
322 struct list_head
*mds_pages
,
324 struct nfs_commit_info
*cinfo
,
325 int (*initiate_commit
)(struct nfs_commit_data
*data
,
327 int pnfs_generic_scan_commit_lists(struct nfs_commit_info
*cinfo
, int max
);
328 void pnfs_generic_write_commit_done(struct rpc_task
*task
, void *data
);
329 void nfs4_pnfs_ds_put(struct nfs4_pnfs_ds
*ds
);
330 struct nfs4_pnfs_ds
*nfs4_pnfs_ds_add(struct list_head
*dsaddrs
,
332 void nfs4_pnfs_v3_ds_connect_unload(void);
333 void nfs4_pnfs_ds_connect(struct nfs_server
*mds_srv
, struct nfs4_pnfs_ds
*ds
,
334 struct nfs4_deviceid_node
*devid
, unsigned int timeo
,
335 unsigned int retrans
, u32 version
, u32 minor_version
,
336 rpc_authflavor_t au_flavor
);
337 struct nfs4_pnfs_ds_addr
*nfs4_decode_mp_ds_addr(struct net
*net
,
338 struct xdr_stream
*xdr
,
341 static inline struct nfs4_deviceid_node
*
342 nfs4_get_deviceid(struct nfs4_deviceid_node
*d
)
348 static inline struct pnfs_layout_segment
*
349 pnfs_get_lseg(struct pnfs_layout_segment
*lseg
)
352 atomic_inc(&lseg
->pls_refcount
);
353 smp_mb__after_atomic();
358 /* Return true if a layout driver is being used for this mountpoint */
359 static inline int pnfs_enabled_sb(struct nfs_server
*nfss
)
361 return nfss
->pnfs_curr_ld
!= NULL
;
365 pnfs_commit_list(struct inode
*inode
, struct list_head
*mds_pages
, int how
,
366 struct nfs_commit_info
*cinfo
)
368 if (cinfo
->ds
== NULL
|| cinfo
->ds
->ncommitting
== 0)
369 return PNFS_NOT_ATTEMPTED
;
370 return NFS_SERVER(inode
)->pnfs_curr_ld
->commit_pagelist(inode
, mds_pages
, how
, cinfo
);
373 static inline struct pnfs_ds_commit_info
*
374 pnfs_get_ds_info(struct inode
*inode
)
376 struct pnfs_layoutdriver_type
*ld
= NFS_SERVER(inode
)->pnfs_curr_ld
;
378 if (ld
== NULL
|| ld
->get_ds_info
== NULL
)
380 return ld
->get_ds_info(inode
);
384 pnfs_generic_mark_devid_invalid(struct nfs4_deviceid_node
*node
)
386 set_bit(NFS_DEVICEID_INVALID
, &node
->flags
);
390 pnfs_mark_request_commit(struct nfs_page
*req
, struct pnfs_layout_segment
*lseg
,
391 struct nfs_commit_info
*cinfo
)
393 struct inode
*inode
= req
->wb_context
->dentry
->d_inode
;
394 struct pnfs_layoutdriver_type
*ld
= NFS_SERVER(inode
)->pnfs_curr_ld
;
396 if (lseg
== NULL
|| ld
->mark_request_commit
== NULL
)
398 ld
->mark_request_commit(req
, lseg
, cinfo
);
403 pnfs_clear_request_commit(struct nfs_page
*req
, struct nfs_commit_info
*cinfo
)
405 struct inode
*inode
= req
->wb_context
->dentry
->d_inode
;
406 struct pnfs_layoutdriver_type
*ld
= NFS_SERVER(inode
)->pnfs_curr_ld
;
408 if (ld
== NULL
|| ld
->clear_request_commit
== NULL
)
410 ld
->clear_request_commit(req
, cinfo
);
415 pnfs_scan_commit_lists(struct inode
*inode
, struct nfs_commit_info
*cinfo
,
418 if (cinfo
->ds
== NULL
|| cinfo
->ds
->nwritten
== 0)
421 return NFS_SERVER(inode
)->pnfs_curr_ld
->scan_commit_lists(cinfo
, max
);
424 static inline struct nfs_page
*
425 pnfs_search_commit_reqs(struct inode
*inode
, struct nfs_commit_info
*cinfo
,
428 struct pnfs_layoutdriver_type
*ld
= NFS_SERVER(inode
)->pnfs_curr_ld
;
430 if (ld
== NULL
|| ld
->search_commit_reqs
== NULL
)
432 return ld
->search_commit_reqs(cinfo
, page
);
435 /* Should the pNFS client commit and return the layout upon a setattr */
437 pnfs_ld_layoutret_on_setattr(struct inode
*inode
)
439 if (!pnfs_enabled_sb(NFS_SERVER(inode
)))
441 return NFS_SERVER(inode
)->pnfs_curr_ld
->flags
&
442 PNFS_LAYOUTRET_ON_SETATTR
;
446 pnfs_ld_read_whole_page(struct inode
*inode
)
448 if (!pnfs_enabled_sb(NFS_SERVER(inode
)))
450 return NFS_SERVER(inode
)->pnfs_curr_ld
->flags
& PNFS_READ_WHOLE_PAGE
;
454 pnfs_layoutcommit_outstanding(struct inode
*inode
)
456 struct nfs_inode
*nfsi
= NFS_I(inode
);
458 return test_bit(NFS_INO_LAYOUTCOMMIT
, &nfsi
->flags
) != 0 ||
459 test_bit(NFS_INO_LAYOUTCOMMITTING
, &nfsi
->flags
) != 0;
462 static inline int pnfs_return_layout(struct inode
*ino
)
464 struct nfs_inode
*nfsi
= NFS_I(ino
);
465 struct nfs_server
*nfss
= NFS_SERVER(ino
);
467 if (pnfs_enabled_sb(nfss
) && nfsi
->layout
)
468 return _pnfs_return_layout(ino
);
474 pnfs_use_threshold(struct nfs4_threshold
**dst
, struct nfs4_threshold
*src
,
475 struct nfs_server
*nfss
)
477 return (dst
&& src
&& src
->bm
!= 0 && nfss
->pnfs_curr_ld
&&
478 nfss
->pnfs_curr_ld
->id
== src
->l_type
);
482 void nfs4_print_deviceid(const struct nfs4_deviceid
*dev_id
);
484 static inline void nfs4_print_deviceid(const struct nfs4_deviceid
*dev_id
)
487 #endif /* NFS_DEBUG */
488 #else /* CONFIG_NFS_V4_1 */
490 static inline void pnfs_destroy_all_layouts(struct nfs_client
*clp
)
494 static inline void pnfs_destroy_layout(struct nfs_inode
*nfsi
)
498 static inline struct pnfs_layout_segment
*
499 pnfs_get_lseg(struct pnfs_layout_segment
*lseg
)
504 static inline void pnfs_put_lseg(struct pnfs_layout_segment
*lseg
)
508 static inline int pnfs_return_layout(struct inode
*ino
)
513 static inline int pnfs_commit_and_return_layout(struct inode
*inode
)
519 pnfs_ld_layoutret_on_setattr(struct inode
*inode
)
525 pnfs_ld_read_whole_page(struct inode
*inode
)
531 pnfs_roc(struct inode
*ino
)
537 pnfs_roc_release(struct inode
*ino
)
542 pnfs_roc_set_barrier(struct inode
*ino
, u32 barrier
)
547 pnfs_roc_drain(struct inode
*ino
, u32
*barrier
, struct rpc_task
*task
)
552 static inline void set_pnfs_layoutdriver(struct nfs_server
*s
,
553 const struct nfs_fh
*mntfh
, u32 id
)
557 static inline void unset_pnfs_layoutdriver(struct nfs_server
*s
)
562 pnfs_commit_list(struct inode
*inode
, struct list_head
*mds_pages
, int how
,
563 struct nfs_commit_info
*cinfo
)
565 return PNFS_NOT_ATTEMPTED
;
568 static inline struct pnfs_ds_commit_info
*
569 pnfs_get_ds_info(struct inode
*inode
)
575 pnfs_mark_request_commit(struct nfs_page
*req
, struct pnfs_layout_segment
*lseg
,
576 struct nfs_commit_info
*cinfo
)
582 pnfs_clear_request_commit(struct nfs_page
*req
, struct nfs_commit_info
*cinfo
)
588 pnfs_scan_commit_lists(struct inode
*inode
, struct nfs_commit_info
*cinfo
,
594 static inline struct nfs_page
*
595 pnfs_search_commit_reqs(struct inode
*inode
, struct nfs_commit_info
*cinfo
,
601 static inline int pnfs_layoutcommit_inode(struct inode
*inode
, bool sync
)
607 pnfs_use_threshold(struct nfs4_threshold
**dst
, struct nfs4_threshold
*src
,
608 struct nfs_server
*nfss
)
614 pnfs_layoutcommit_outstanding(struct inode
*inode
)
620 static inline struct nfs4_threshold
*pnfs_mdsthreshold_alloc(void)
625 static inline void nfs4_pnfs_v3_ds_connect_unload(void)
629 #endif /* CONFIG_NFS_V4_1 */
631 #endif /* FS_NFS_PNFS_H */