Loading...
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
33#include <linux/refcount.h>
34#include <linux/nfs_fs.h>
35#include <linux/nfs_page.h>
36#include <linux/workqueue.h>
37
38enum {
39 NFS_LSEG_VALID = 0, /* cleared when lseg is recalled/returned */
40 NFS_LSEG_ROC, /* roc bit received from server */
41 NFS_LSEG_LAYOUTCOMMIT, /* layoutcommit bit set for layoutcommit */
42 NFS_LSEG_LAYOUTRETURN, /* layoutreturn bit set for layoutreturn */
43 NFS_LSEG_UNAVAILABLE, /* unavailable bit set for temporary problem */
44};
45
46/* Individual ip address */
47struct nfs4_pnfs_ds_addr {
48 struct sockaddr_storage da_addr;
49 size_t da_addrlen;
50 struct list_head da_node; /* nfs4_pnfs_dev_hlist dev_dslist */
51 char *da_remotestr; /* human readable addr+port */
52};
53
54struct nfs4_pnfs_ds {
55 struct list_head ds_node; /* nfs4_pnfs_dev_hlist dev_dslist */
56 char *ds_remotestr; /* comma sep list of addrs */
57 struct list_head ds_addrs;
58 struct nfs_client *ds_clp;
59 refcount_t ds_count;
60 unsigned long ds_state;
61#define NFS4DS_CONNECTING 0 /* ds is establishing connection */
62};
63
64struct pnfs_layout_segment {
65 struct list_head pls_list;
66 struct list_head pls_lc_list;
67 struct pnfs_layout_range pls_range;
68 refcount_t pls_refcount;
69 u32 pls_seq;
70 unsigned long pls_flags;
71 struct pnfs_layout_hdr *pls_layout;
72};
73
74enum pnfs_try_status {
75 PNFS_ATTEMPTED = 0,
76 PNFS_NOT_ATTEMPTED = 1,
77 PNFS_TRY_AGAIN = 2,
78};
79
80#ifdef CONFIG_NFS_V4_1
81
82#define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
83
84/*
85 * Default data server connection timeout and retrans vaules.
86 * Set by module parameters dataserver_timeo and dataserver_retrans.
87 */
88#define NFS4_DEF_DS_TIMEO 600 /* in tenths of a second */
89#define NFS4_DEF_DS_RETRANS 5
90#define PNFS_DEVICE_RETRY_TIMEOUT (120*HZ)
91
92/* error codes for internal use */
93#define NFS4ERR_RESET_TO_MDS 12001
94#define NFS4ERR_RESET_TO_PNFS 12002
95
96enum {
97 NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */
98 NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */
99 NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */
100 NFS_LAYOUT_RETURN, /* layoutreturn in progress */
101 NFS_LAYOUT_RETURN_LOCK, /* Serialise layoutreturn */
102 NFS_LAYOUT_RETURN_REQUESTED, /* Return this layout ASAP */
103 NFS_LAYOUT_INVALID_STID, /* layout stateid id is invalid */
104 NFS_LAYOUT_FIRST_LAYOUTGET, /* Serialize first layoutget */
105};
106
107enum layoutdriver_policy_flags {
108 /* Should the pNFS client commit and return the layout upon truncate to
109 * a smaller size */
110 PNFS_LAYOUTRET_ON_SETATTR = 1 << 0,
111 PNFS_LAYOUTRET_ON_ERROR = 1 << 1,
112 PNFS_READ_WHOLE_PAGE = 1 << 2,
113};
114
115struct nfs4_deviceid_node;
116
117/* Per-layout driver specific registration structure */
118struct pnfs_layoutdriver_type {
119 struct list_head pnfs_tblid;
120 const u32 id;
121 const char *name;
122 struct module *owner;
123 unsigned flags;
124 unsigned max_deviceinfo_size;
125
126 int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
127 int (*clear_layoutdriver) (struct nfs_server *);
128
129 struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
130 void (*free_layout_hdr) (struct pnfs_layout_hdr *);
131
132 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
133 void (*free_lseg) (struct pnfs_layout_segment *lseg);
134 void (*add_lseg) (struct pnfs_layout_hdr *layoutid,
135 struct pnfs_layout_segment *lseg,
136 struct list_head *free_me);
137
138 void (*return_range) (struct pnfs_layout_hdr *lo,
139 struct pnfs_layout_range *range);
140
141 /* test for nfs page cache coalescing */
142 const struct nfs_pageio_ops *pg_read_ops;
143 const struct nfs_pageio_ops *pg_write_ops;
144
145 struct pnfs_ds_commit_info *(*get_ds_info) (struct inode *inode);
146 void (*mark_request_commit) (struct nfs_page *req,
147 struct pnfs_layout_segment *lseg,
148 struct nfs_commit_info *cinfo,
149 u32 ds_commit_idx);
150 void (*clear_request_commit) (struct nfs_page *req,
151 struct nfs_commit_info *cinfo);
152 int (*scan_commit_lists) (struct nfs_commit_info *cinfo,
153 int max);
154 void (*recover_commit_reqs) (struct list_head *list,
155 struct nfs_commit_info *cinfo);
156 struct nfs_page * (*search_commit_reqs)(struct nfs_commit_info *cinfo,
157 struct page *page);
158 int (*commit_pagelist)(struct inode *inode,
159 struct list_head *mds_pages,
160 int how,
161 struct nfs_commit_info *cinfo);
162
163 int (*sync)(struct inode *inode, bool datasync);
164
165 /*
166 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
167 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
168 */
169 enum pnfs_try_status (*read_pagelist)(struct nfs_pgio_header *);
170 enum pnfs_try_status (*write_pagelist)(struct nfs_pgio_header *, int);
171
172 void (*free_deviceid_node) (struct nfs4_deviceid_node *);
173 struct nfs4_deviceid_node * (*alloc_deviceid_node)
174 (struct nfs_server *server, struct pnfs_device *pdev,
175 gfp_t gfp_flags);
176
177 int (*prepare_layoutreturn) (struct nfs4_layoutreturn_args *);
178
179 void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);
180 int (*prepare_layoutcommit) (struct nfs4_layoutcommit_args *args);
181 int (*prepare_layoutstats) (struct nfs42_layoutstat_args *args);
182};
183
184struct pnfs_layout_hdr {
185 refcount_t plh_refcount;
186 atomic_t plh_outstanding; /* number of RPCs out */
187 struct list_head plh_layouts; /* other client layouts */
188 struct list_head plh_bulk_destroy;
189 struct list_head plh_segs; /* layout segments list */
190 struct list_head plh_return_segs; /* invalid layout segments */
191 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
192 unsigned long plh_retry_timestamp;
193 unsigned long plh_flags;
194 nfs4_stateid plh_stateid;
195 u32 plh_barrier; /* ignore lower seqids */
196 u32 plh_return_seq;
197 enum pnfs_iomode plh_return_iomode;
198 loff_t plh_lwb; /* last write byte for layoutcommit */
199 struct rpc_cred *plh_lc_cred; /* layoutcommit cred */
200 struct inode *plh_inode;
201};
202
203struct pnfs_device {
204 struct nfs4_deviceid dev_id;
205 unsigned int layout_type;
206 unsigned int mincount;
207 unsigned int maxcount; /* gdia_maxcount */
208 struct page **pages;
209 unsigned int pgbase;
210 unsigned int pglen; /* reply buffer length */
211 unsigned char nocache : 1;/* May not be cached */
212};
213
214#define NFS4_PNFS_GETDEVLIST_MAXNUM 16
215
216struct pnfs_devicelist {
217 unsigned int eof;
218 unsigned int num_devs;
219 struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
220};
221
222extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
223extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
224
225/* nfs4proc.c */
226extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
227 struct pnfs_device *dev,
228 struct rpc_cred *cred);
229extern struct pnfs_layout_segment* nfs4_proc_layoutget(struct nfs4_layoutget *lgp, long *timeout, gfp_t gfp_flags);
230extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp, bool sync);
231
232/* pnfs.c */
233void pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo);
234void pnfs_put_lseg(struct pnfs_layout_segment *lseg);
235
236void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, struct nfs_fsinfo *);
237void unset_pnfs_layoutdriver(struct nfs_server *);
238void pnfs_generic_pg_check_layout(struct nfs_pageio_descriptor *pgio);
239void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
240int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
241void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio,
242 struct nfs_page *req, u64 wb_size);
243void pnfs_generic_pg_cleanup(struct nfs_pageio_descriptor *);
244int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
245size_t pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio,
246 struct nfs_page *prev, struct nfs_page *req);
247void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
248struct pnfs_layout_segment *pnfs_layout_process(struct nfs4_layoutget *lgp);
249void pnfs_free_lseg_list(struct list_head *tmp_list);
250void pnfs_destroy_layout(struct nfs_inode *);
251void pnfs_destroy_all_layouts(struct nfs_client *);
252int pnfs_destroy_layouts_byfsid(struct nfs_client *clp,
253 struct nfs_fsid *fsid,
254 bool is_recall);
255int pnfs_destroy_layouts_byclid(struct nfs_client *clp,
256 bool is_recall);
257bool nfs4_refresh_layout_stateid(nfs4_stateid *dst, struct inode *inode);
258void pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo);
259void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
260 const nfs4_stateid *new,
261 bool update_barrier);
262int pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
263 struct list_head *tmp_list,
264 const struct pnfs_layout_range *recall_range,
265 u32 seq);
266int pnfs_mark_matching_lsegs_return(struct pnfs_layout_hdr *lo,
267 struct list_head *tmp_list,
268 const struct pnfs_layout_range *recall_range,
269 u32 seq);
270int pnfs_mark_layout_stateid_invalid(struct pnfs_layout_hdr *lo,
271 struct list_head *lseg_list);
272bool pnfs_roc(struct inode *ino,
273 struct nfs4_layoutreturn_args *args,
274 struct nfs4_layoutreturn_res *res,
275 const struct rpc_cred *cred);
276void pnfs_roc_release(struct nfs4_layoutreturn_args *args,
277 struct nfs4_layoutreturn_res *res,
278 int ret);
279bool pnfs_wait_on_layoutreturn(struct inode *ino, struct rpc_task *task);
280void pnfs_set_layoutcommit(struct inode *, struct pnfs_layout_segment *, loff_t);
281void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
282int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
283int pnfs_generic_sync(struct inode *inode, bool datasync);
284int pnfs_nfs_generic_sync(struct inode *inode, bool datasync);
285int _pnfs_return_layout(struct inode *);
286int pnfs_commit_and_return_layout(struct inode *);
287void pnfs_ld_write_done(struct nfs_pgio_header *);
288void pnfs_ld_read_done(struct nfs_pgio_header *);
289void pnfs_read_resend_pnfs(struct nfs_pgio_header *);
290struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
291 struct nfs_open_context *ctx,
292 loff_t pos,
293 u64 count,
294 enum pnfs_iomode iomode,
295 bool strict_iomode,
296 gfp_t gfp_flags);
297void pnfs_layoutreturn_free_lsegs(struct pnfs_layout_hdr *lo,
298 const nfs4_stateid *arg_stateid,
299 const struct pnfs_layout_range *range,
300 const nfs4_stateid *stateid);
301
302void pnfs_generic_layout_insert_lseg(struct pnfs_layout_hdr *lo,
303 struct pnfs_layout_segment *lseg,
304 bool (*is_after)(const struct pnfs_layout_range *lseg_range,
305 const struct pnfs_layout_range *old),
306 bool (*do_merge)(struct pnfs_layout_segment *lseg,
307 struct pnfs_layout_segment *old),
308 struct list_head *free_me);
309
310void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
311int pnfs_read_done_resend_to_mds(struct nfs_pgio_header *);
312int pnfs_write_done_resend_to_mds(struct nfs_pgio_header *);
313struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
314void pnfs_error_mark_layout_for_return(struct inode *inode,
315 struct pnfs_layout_segment *lseg);
316/* nfs4_deviceid_flags */
317enum {
318 NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
319 NFS_DEVICEID_UNAVAILABLE, /* device temporarily unavailable */
320 NFS_DEVICEID_NOCACHE, /* device may not be cached */
321};
322
323/* pnfs_dev.c */
324struct nfs4_deviceid_node {
325 struct hlist_node node;
326 struct hlist_node tmpnode;
327 const struct pnfs_layoutdriver_type *ld;
328 const struct nfs_client *nfs_client;
329 unsigned long flags;
330 unsigned long timestamp_unavailable;
331 struct nfs4_deviceid deviceid;
332 struct rcu_head rcu;
333 atomic_t ref;
334};
335
336struct nfs4_deviceid_node *
337nfs4_find_get_deviceid(struct nfs_server *server,
338 const struct nfs4_deviceid *id, struct rpc_cred *cred,
339 gfp_t gfp_mask);
340void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
341void nfs4_init_deviceid_node(struct nfs4_deviceid_node *, struct nfs_server *,
342 const struct nfs4_deviceid *);
343bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
344void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
345bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
346void nfs4_deviceid_purge_client(const struct nfs_client *);
347
348/* pnfs_nfs.c */
349void pnfs_generic_clear_request_commit(struct nfs_page *req,
350 struct nfs_commit_info *cinfo);
351void pnfs_generic_commit_release(void *calldata);
352void pnfs_generic_prepare_to_resend_writes(struct nfs_commit_data *data);
353void pnfs_generic_rw_release(void *data);
354void pnfs_generic_recover_commit_reqs(struct list_head *dst,
355 struct nfs_commit_info *cinfo);
356int pnfs_generic_commit_pagelist(struct inode *inode,
357 struct list_head *mds_pages,
358 int how,
359 struct nfs_commit_info *cinfo,
360 int (*initiate_commit)(struct nfs_commit_data *data,
361 int how));
362int pnfs_generic_scan_commit_lists(struct nfs_commit_info *cinfo, int max);
363void pnfs_generic_write_commit_done(struct rpc_task *task, void *data);
364void nfs4_pnfs_ds_put(struct nfs4_pnfs_ds *ds);
365struct nfs4_pnfs_ds *nfs4_pnfs_ds_add(struct list_head *dsaddrs,
366 gfp_t gfp_flags);
367void nfs4_pnfs_v3_ds_connect_unload(void);
368int nfs4_pnfs_ds_connect(struct nfs_server *mds_srv, struct nfs4_pnfs_ds *ds,
369 struct nfs4_deviceid_node *devid, unsigned int timeo,
370 unsigned int retrans, u32 version, u32 minor_version);
371struct nfs4_pnfs_ds_addr *nfs4_decode_mp_ds_addr(struct net *net,
372 struct xdr_stream *xdr,
373 gfp_t gfp_flags);
374void pnfs_layout_mark_request_commit(struct nfs_page *req,
375 struct pnfs_layout_segment *lseg,
376 struct nfs_commit_info *cinfo,
377 u32 ds_commit_idx);
378
379static inline bool nfs_have_layout(struct inode *inode)
380{
381 return NFS_I(inode)->layout != NULL;
382}
383
384static inline bool pnfs_layout_is_valid(const struct pnfs_layout_hdr *lo)
385{
386 return test_bit(NFS_LAYOUT_INVALID_STID, &lo->plh_flags) == 0;
387}
388
389static inline struct nfs4_deviceid_node *
390nfs4_get_deviceid(struct nfs4_deviceid_node *d)
391{
392 atomic_inc(&d->ref);
393 return d;
394}
395
396static inline struct pnfs_layout_segment *
397pnfs_get_lseg(struct pnfs_layout_segment *lseg)
398{
399 if (lseg) {
400 refcount_inc(&lseg->pls_refcount);
401 smp_mb__after_atomic();
402 }
403 return lseg;
404}
405
406static inline bool
407pnfs_is_valid_lseg(struct pnfs_layout_segment *lseg)
408{
409 return test_bit(NFS_LSEG_VALID, &lseg->pls_flags) != 0;
410}
411
412/* Return true if a layout driver is being used for this mountpoint */
413static inline int pnfs_enabled_sb(struct nfs_server *nfss)
414{
415 return nfss->pnfs_curr_ld != NULL;
416}
417
418static inline int
419pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
420 struct nfs_commit_info *cinfo)
421{
422 if (cinfo->ds == NULL || cinfo->ds->ncommitting == 0)
423 return PNFS_NOT_ATTEMPTED;
424 return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
425}
426
427static inline struct pnfs_ds_commit_info *
428pnfs_get_ds_info(struct inode *inode)
429{
430 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
431
432 if (ld == NULL || ld->get_ds_info == NULL)
433 return NULL;
434 return ld->get_ds_info(inode);
435}
436
437static inline void
438pnfs_generic_mark_devid_invalid(struct nfs4_deviceid_node *node)
439{
440 set_bit(NFS_DEVICEID_INVALID, &node->flags);
441}
442
443static inline bool
444pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
445 struct nfs_commit_info *cinfo, u32 ds_commit_idx)
446{
447 struct inode *inode = d_inode(req->wb_context->dentry);
448 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
449
450 if (lseg == NULL || ld->mark_request_commit == NULL)
451 return false;
452 ld->mark_request_commit(req, lseg, cinfo, ds_commit_idx);
453 return true;
454}
455
456static inline bool
457pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
458{
459 struct inode *inode = d_inode(req->wb_context->dentry);
460 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
461
462 if (ld == NULL || ld->clear_request_commit == NULL)
463 return false;
464 ld->clear_request_commit(req, cinfo);
465 return true;
466}
467
468static inline int
469pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
470 int max)
471{
472 if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
473 return 0;
474 else
475 return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
476}
477
478static inline struct nfs_page *
479pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
480 struct page *page)
481{
482 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
483
484 if (ld == NULL || ld->search_commit_reqs == NULL)
485 return NULL;
486 return ld->search_commit_reqs(cinfo, page);
487}
488
489/* Should the pNFS client commit and return the layout upon a setattr */
490static inline bool
491pnfs_ld_layoutret_on_setattr(struct inode *inode)
492{
493 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
494 return false;
495 return NFS_SERVER(inode)->pnfs_curr_ld->flags &
496 PNFS_LAYOUTRET_ON_SETATTR;
497}
498
499static inline bool
500pnfs_ld_read_whole_page(struct inode *inode)
501{
502 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
503 return false;
504 return NFS_SERVER(inode)->pnfs_curr_ld->flags & PNFS_READ_WHOLE_PAGE;
505}
506
507static inline int
508pnfs_sync_inode(struct inode *inode, bool datasync)
509{
510 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
511 return 0;
512 return NFS_SERVER(inode)->pnfs_curr_ld->sync(inode, datasync);
513}
514
515static inline bool
516pnfs_layoutcommit_outstanding(struct inode *inode)
517{
518 struct nfs_inode *nfsi = NFS_I(inode);
519
520 return test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags) != 0 ||
521 test_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags) != 0;
522}
523
524static inline int pnfs_return_layout(struct inode *ino)
525{
526 struct nfs_inode *nfsi = NFS_I(ino);
527 struct nfs_server *nfss = NFS_SERVER(ino);
528
529 if (pnfs_enabled_sb(nfss) && nfsi->layout) {
530 set_bit(NFS_LAYOUT_RETURN_REQUESTED, &nfsi->layout->plh_flags);
531 return _pnfs_return_layout(ino);
532 }
533
534 return 0;
535}
536
537static inline bool
538pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
539 struct nfs_server *nfss)
540{
541 return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
542 nfss->pnfs_curr_ld->id == src->l_type);
543}
544
545static inline u64
546pnfs_calc_offset_end(u64 offset, u64 len)
547{
548 if (len == NFS4_MAX_UINT64 || len >= NFS4_MAX_UINT64 - offset)
549 return NFS4_MAX_UINT64;
550 return offset + len - 1;
551}
552
553static inline u64
554pnfs_calc_offset_length(u64 offset, u64 end)
555{
556 if (end == NFS4_MAX_UINT64 || end <= offset)
557 return NFS4_MAX_UINT64;
558 return 1 + end - offset;
559}
560
561static inline void
562pnfs_copy_range(struct pnfs_layout_range *dst,
563 const struct pnfs_layout_range *src)
564{
565 memcpy(dst, src, sizeof(*dst));
566}
567
568static inline u64
569pnfs_end_offset(u64 start, u64 len)
570{
571 if (NFS4_MAX_UINT64 - start <= len)
572 return NFS4_MAX_UINT64;
573 return start + len;
574}
575
576/*
577 * Are 2 ranges intersecting?
578 * start1 end1
579 * [----------------------------------)
580 * start2 end2
581 * [----------------)
582 */
583static inline bool
584pnfs_is_range_intersecting(u64 start1, u64 end1, u64 start2, u64 end2)
585{
586 return (end1 == NFS4_MAX_UINT64 || start2 < end1) &&
587 (end2 == NFS4_MAX_UINT64 || start1 < end2);
588}
589
590static inline bool
591pnfs_lseg_range_intersecting(const struct pnfs_layout_range *l1,
592 const struct pnfs_layout_range *l2)
593{
594 u64 end1 = pnfs_end_offset(l1->offset, l1->length);
595 u64 end2 = pnfs_end_offset(l2->offset, l2->length);
596
597 return pnfs_is_range_intersecting(l1->offset, end1, l2->offset, end2);
598}
599
600static inline bool
601pnfs_lseg_request_intersecting(struct pnfs_layout_segment *lseg, struct nfs_page *req)
602{
603 u64 seg_last = pnfs_end_offset(lseg->pls_range.offset, lseg->pls_range.length);
604 u64 req_last = req_offset(req) + req->wb_bytes;
605
606 return pnfs_is_range_intersecting(lseg->pls_range.offset, seg_last,
607 req_offset(req), req_last);
608}
609
610extern unsigned int layoutstats_timer;
611
612#ifdef NFS_DEBUG
613void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
614#else
615static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
616{
617}
618
619#endif /* NFS_DEBUG */
620#else /* CONFIG_NFS_V4_1 */
621
622static inline bool nfs_have_layout(struct inode *inode)
623{
624 return false;
625}
626
627static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
628{
629}
630
631static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
632{
633}
634
635static inline struct pnfs_layout_segment *
636pnfs_get_lseg(struct pnfs_layout_segment *lseg)
637{
638 return NULL;
639}
640
641static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
642{
643}
644
645static inline int pnfs_return_layout(struct inode *ino)
646{
647 return 0;
648}
649
650static inline int pnfs_commit_and_return_layout(struct inode *inode)
651{
652 return 0;
653}
654
655static inline bool
656pnfs_ld_layoutret_on_setattr(struct inode *inode)
657{
658 return false;
659}
660
661static inline bool
662pnfs_ld_read_whole_page(struct inode *inode)
663{
664 return false;
665}
666
667static inline int
668pnfs_sync_inode(struct inode *inode, bool datasync)
669{
670 return 0;
671}
672
673static inline bool
674pnfs_layoutcommit_outstanding(struct inode *inode)
675{
676 return false;
677}
678
679
680static inline bool
681pnfs_roc(struct inode *ino,
682 struct nfs4_layoutreturn_args *args,
683 struct nfs4_layoutreturn_res *res,
684 const struct rpc_cred *cred)
685{
686 return false;
687}
688
689static inline void
690pnfs_roc_release(struct nfs4_layoutreturn_args *args,
691 struct nfs4_layoutreturn_res *res,
692 int ret)
693{
694}
695
696static inline bool
697pnfs_wait_on_layoutreturn(struct inode *ino, struct rpc_task *task)
698{
699 return false;
700}
701
702static inline void set_pnfs_layoutdriver(struct nfs_server *s,
703 const struct nfs_fh *mntfh,
704 struct nfs_fsinfo *fsinfo)
705{
706}
707
708static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
709{
710}
711
712static inline int
713pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
714 struct nfs_commit_info *cinfo)
715{
716 return PNFS_NOT_ATTEMPTED;
717}
718
719static inline struct pnfs_ds_commit_info *
720pnfs_get_ds_info(struct inode *inode)
721{
722 return NULL;
723}
724
725static inline bool
726pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
727 struct nfs_commit_info *cinfo, u32 ds_commit_idx)
728{
729 return false;
730}
731
732static inline bool
733pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
734{
735 return false;
736}
737
738static inline int
739pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
740 int max)
741{
742 return 0;
743}
744
745static inline struct nfs_page *
746pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
747 struct page *page)
748{
749 return NULL;
750}
751
752static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
753{
754 return 0;
755}
756
757static inline bool
758pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
759 struct nfs_server *nfss)
760{
761 return false;
762}
763
764static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
765{
766 return NULL;
767}
768
769static inline void nfs4_pnfs_v3_ds_connect_unload(void)
770{
771}
772
773static inline bool nfs4_refresh_layout_stateid(nfs4_stateid *dst,
774 struct inode *inode)
775{
776 return false;
777}
778#endif /* CONFIG_NFS_V4_1 */
779
780#if IS_ENABLED(CONFIG_NFS_V4_2)
781int pnfs_report_layoutstat(struct inode *inode, gfp_t gfp_flags);
782#else
783static inline int
784pnfs_report_layoutstat(struct inode *inode, gfp_t gfp_flags)
785{
786 return 0;
787}
788#endif
789
790#endif /* FS_NFS_PNFS_H */
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
33#include <linux/nfs_fs.h>
34#include <linux/nfs_page.h>
35
36enum {
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 */
40};
41
42struct 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;
49};
50
51enum pnfs_try_status {
52 PNFS_ATTEMPTED = 0,
53 PNFS_NOT_ATTEMPTED = 1,
54};
55
56#ifdef CONFIG_NFS_V4_1
57
58#define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
59
60enum {
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};
67
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
73struct nfs4_deviceid_node;
74
75/* Per-layout driver specific registration structure */
76struct pnfs_layoutdriver_type {
77 struct list_head pnfs_tblid;
78 const u32 id;
79 const char *name;
80 struct module *owner;
81 unsigned flags;
82
83 int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
84 int (*clear_layoutdriver) (struct nfs_server *);
85
86 struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
87 void (*free_layout_hdr) (struct pnfs_layout_hdr *);
88
89 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
90 void (*free_lseg) (struct pnfs_layout_segment *lseg);
91
92 /* test for nfs page cache coalescing */
93 const struct nfs_pageio_ops *pg_read_ops;
94 const struct nfs_pageio_ops *pg_write_ops;
95
96 /* Returns true if layoutdriver wants to divert this request to
97 * driver's commit routine.
98 */
99 bool (*mark_pnfs_commit)(struct pnfs_layout_segment *lseg);
100 struct list_head * (*choose_commit_list) (struct nfs_page *req);
101 int (*commit_pagelist)(struct inode *inode, struct list_head *mds_pages, int how);
102
103 /*
104 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
105 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
106 */
107 enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data);
108 enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);
109
110 void (*free_deviceid_node) (struct nfs4_deviceid_node *);
111
112 void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid,
113 struct xdr_stream *xdr,
114 const struct nfs4_layoutreturn_args *args);
115
116 void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);
117
118 void (*encode_layoutcommit) (struct pnfs_layout_hdr *layoutid,
119 struct xdr_stream *xdr,
120 const struct nfs4_layoutcommit_args *args);
121};
122
123struct pnfs_layout_hdr {
124 atomic_t plh_refcount;
125 struct list_head plh_layouts; /* other client layouts */
126 struct list_head plh_bulk_recall; /* clnt list of bulk recalls */
127 struct list_head plh_segs; /* layout segments list */
128 nfs4_stateid plh_stateid;
129 atomic_t plh_outstanding; /* number of RPCs out */
130 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
131 u32 plh_barrier; /* ignore lower seqids */
132 unsigned long plh_flags;
133 loff_t plh_lwb; /* last write byte for layoutcommit */
134 struct rpc_cred *plh_lc_cred; /* layoutcommit cred */
135 struct inode *plh_inode;
136};
137
138struct pnfs_device {
139 struct nfs4_deviceid dev_id;
140 unsigned int layout_type;
141 unsigned int mincount;
142 struct page **pages;
143 unsigned int pgbase;
144 unsigned int pglen;
145};
146
147#define NFS4_PNFS_GETDEVLIST_MAXNUM 16
148
149struct pnfs_devicelist {
150 unsigned int eof;
151 unsigned int num_devs;
152 struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
153};
154
155extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
156extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
157
158/* nfs4proc.c */
159extern int nfs4_proc_getdevicelist(struct nfs_server *server,
160 const struct nfs_fh *fh,
161 struct pnfs_devicelist *devlist);
162extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
163 struct pnfs_device *dev);
164extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
165extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
166
167/* pnfs.c */
168void get_layout_hdr(struct pnfs_layout_hdr *lo);
169void put_lseg(struct pnfs_layout_segment *lseg);
170
171bool pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *);
172bool pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *, int);
173
174void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, u32);
175void unset_pnfs_layoutdriver(struct nfs_server *);
176void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
177int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
178void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *, struct nfs_page *);
179int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
180bool pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev, struct nfs_page *req);
181int pnfs_layout_process(struct nfs4_layoutget *lgp);
182void pnfs_free_lseg_list(struct list_head *tmp_list);
183void pnfs_destroy_layout(struct nfs_inode *);
184void pnfs_destroy_all_layouts(struct nfs_client *);
185void put_layout_hdr(struct pnfs_layout_hdr *lo);
186void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
187 const nfs4_stateid *new,
188 bool update_barrier);
189int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
190 struct pnfs_layout_hdr *lo,
191 struct nfs4_state *open_state);
192int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
193 struct list_head *tmp_list,
194 struct pnfs_layout_range *recall_range);
195bool pnfs_roc(struct inode *ino);
196void pnfs_roc_release(struct inode *ino);
197void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
198bool pnfs_roc_drain(struct inode *ino, u32 *barrier);
199void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
200void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
201int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
202int _pnfs_return_layout(struct inode *);
203int pnfs_ld_write_done(struct nfs_write_data *);
204int pnfs_ld_read_done(struct nfs_read_data *);
205struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
206 struct nfs_open_context *ctx,
207 loff_t pos,
208 u64 count,
209 enum pnfs_iomode iomode,
210 gfp_t gfp_flags);
211
212void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
213
214/* nfs4_deviceid_flags */
215enum {
216 NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
217};
218
219/* pnfs_dev.c */
220struct nfs4_deviceid_node {
221 struct hlist_node node;
222 struct hlist_node tmpnode;
223 const struct pnfs_layoutdriver_type *ld;
224 const struct nfs_client *nfs_client;
225 unsigned long flags;
226 struct nfs4_deviceid deviceid;
227 atomic_t ref;
228};
229
230void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
231struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
232void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
233void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
234 const struct pnfs_layoutdriver_type *,
235 const struct nfs_client *,
236 const struct nfs4_deviceid *);
237struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *);
238bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
239void nfs4_deviceid_purge_client(const struct nfs_client *);
240
241static inline int lo_fail_bit(u32 iomode)
242{
243 return iomode == IOMODE_RW ?
244 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
245}
246
247static inline struct pnfs_layout_segment *
248get_lseg(struct pnfs_layout_segment *lseg)
249{
250 if (lseg) {
251 atomic_inc(&lseg->pls_refcount);
252 smp_mb__after_atomic_inc();
253 }
254 return lseg;
255}
256
257/* Return true if a layout driver is being used for this mountpoint */
258static inline int pnfs_enabled_sb(struct nfs_server *nfss)
259{
260 return nfss->pnfs_curr_ld != NULL;
261}
262
263static inline void
264pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
265{
266 if (lseg) {
267 struct pnfs_layoutdriver_type *ld;
268
269 ld = NFS_SERVER(req->wb_page->mapping->host)->pnfs_curr_ld;
270 if (ld->mark_pnfs_commit && ld->mark_pnfs_commit(lseg)) {
271 set_bit(PG_PNFS_COMMIT, &req->wb_flags);
272 req->wb_commit_lseg = get_lseg(lseg);
273 }
274 }
275}
276
277static inline int
278pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
279{
280 if (!test_and_clear_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags))
281 return PNFS_NOT_ATTEMPTED;
282 return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how);
283}
284
285static inline struct list_head *
286pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
287{
288 struct list_head *rv;
289
290 if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags)) {
291 struct inode *inode = req->wb_commit_lseg->pls_layout->plh_inode;
292
293 set_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags);
294 rv = NFS_SERVER(inode)->pnfs_curr_ld->choose_commit_list(req);
295 /* matched by ref taken when PG_PNFS_COMMIT is set */
296 put_lseg(req->wb_commit_lseg);
297 } else
298 rv = mds;
299 return rv;
300}
301
302static inline void pnfs_clear_request_commit(struct nfs_page *req)
303{
304 if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags))
305 put_lseg(req->wb_commit_lseg);
306}
307
308/* Should the pNFS client commit and return the layout upon a setattr */
309static inline bool
310pnfs_ld_layoutret_on_setattr(struct inode *inode)
311{
312 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
313 return false;
314 return NFS_SERVER(inode)->pnfs_curr_ld->flags &
315 PNFS_LAYOUTRET_ON_SETATTR;
316}
317
318static inline int pnfs_return_layout(struct inode *ino)
319{
320 struct nfs_inode *nfsi = NFS_I(ino);
321 struct nfs_server *nfss = NFS_SERVER(ino);
322
323 if (pnfs_enabled_sb(nfss) && nfsi->layout)
324 return _pnfs_return_layout(ino);
325
326 return 0;
327}
328
329#else /* CONFIG_NFS_V4_1 */
330
331static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
332{
333}
334
335static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
336{
337}
338
339static inline struct pnfs_layout_segment *
340get_lseg(struct pnfs_layout_segment *lseg)
341{
342 return NULL;
343}
344
345static inline void put_lseg(struct pnfs_layout_segment *lseg)
346{
347}
348
349static inline int pnfs_return_layout(struct inode *ino)
350{
351 return 0;
352}
353
354static inline bool
355pnfs_ld_layoutret_on_setattr(struct inode *inode)
356{
357 return false;
358}
359
360static inline bool
361pnfs_roc(struct inode *ino)
362{
363 return false;
364}
365
366static inline void
367pnfs_roc_release(struct inode *ino)
368{
369}
370
371static inline void
372pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
373{
374}
375
376static inline bool
377pnfs_roc_drain(struct inode *ino, u32 *barrier)
378{
379 return false;
380}
381
382static inline void set_pnfs_layoutdriver(struct nfs_server *s,
383 const struct nfs_fh *mntfh, u32 id)
384{
385}
386
387static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
388{
389}
390
391static inline bool pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *inode)
392{
393 return false;
394}
395
396static inline bool pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *inode, int ioflags)
397{
398 return false;
399}
400
401static inline void
402pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
403{
404}
405
406static inline int
407pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
408{
409 return PNFS_NOT_ATTEMPTED;
410}
411
412static inline struct list_head *
413pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
414{
415 return mds;
416}
417
418static inline void pnfs_clear_request_commit(struct nfs_page *req)
419{
420}
421
422static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
423{
424 return 0;
425}
426
427static inline void nfs4_deviceid_purge_client(struct nfs_client *ncl)
428{
429}
430#endif /* CONFIG_NFS_V4_1 */
431
432#endif /* FS_NFS_PNFS_H */