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/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 NFS_LAYOUT_INVALID, /* layout is being destroyed */
67};
68
69enum layoutdriver_policy_flags {
70 /* Should the pNFS client commit and return the layout upon a setattr */
71 PNFS_LAYOUTRET_ON_SETATTR = 1 << 0,
72 PNFS_LAYOUTRET_ON_ERROR = 1 << 1,
73};
74
75struct nfs4_deviceid_node;
76
77/* Per-layout driver specific registration structure */
78struct pnfs_layoutdriver_type {
79 struct list_head pnfs_tblid;
80 const u32 id;
81 const char *name;
82 struct module *owner;
83 unsigned flags;
84
85 int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
86 int (*clear_layoutdriver) (struct nfs_server *);
87
88 struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
89 void (*free_layout_hdr) (struct pnfs_layout_hdr *);
90
91 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
92 void (*free_lseg) (struct pnfs_layout_segment *lseg);
93
94 /* test for nfs page cache coalescing */
95 const struct nfs_pageio_ops *pg_read_ops;
96 const struct nfs_pageio_ops *pg_write_ops;
97
98 struct pnfs_ds_commit_info *(*get_ds_info) (struct inode *inode);
99 void (*mark_request_commit) (struct nfs_page *req,
100 struct pnfs_layout_segment *lseg,
101 struct nfs_commit_info *cinfo);
102 void (*clear_request_commit) (struct nfs_page *req,
103 struct nfs_commit_info *cinfo);
104 int (*scan_commit_lists) (struct nfs_commit_info *cinfo,
105 int max);
106 void (*recover_commit_reqs) (struct list_head *list,
107 struct nfs_commit_info *cinfo);
108 int (*commit_pagelist)(struct inode *inode,
109 struct list_head *mds_pages,
110 int how,
111 struct nfs_commit_info *cinfo);
112
113 /*
114 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
115 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
116 */
117 enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data);
118 enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);
119
120 void (*free_deviceid_node) (struct nfs4_deviceid_node *);
121
122 void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid,
123 struct xdr_stream *xdr,
124 const struct nfs4_layoutreturn_args *args);
125
126 void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);
127
128 void (*encode_layoutcommit) (struct pnfs_layout_hdr *layoutid,
129 struct xdr_stream *xdr,
130 const struct nfs4_layoutcommit_args *args);
131};
132
133struct pnfs_layout_hdr {
134 atomic_t plh_refcount;
135 struct list_head plh_layouts; /* other client layouts */
136 struct list_head plh_bulk_recall; /* clnt list of bulk recalls */
137 struct list_head plh_segs; /* layout segments list */
138 nfs4_stateid plh_stateid;
139 atomic_t plh_outstanding; /* number of RPCs out */
140 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
141 u32 plh_barrier; /* ignore lower seqids */
142 unsigned long plh_flags;
143 loff_t plh_lwb; /* last write byte for layoutcommit */
144 struct rpc_cred *plh_lc_cred; /* layoutcommit cred */
145 struct inode *plh_inode;
146};
147
148struct pnfs_device {
149 struct nfs4_deviceid dev_id;
150 unsigned int layout_type;
151 unsigned int mincount;
152 struct page **pages;
153 unsigned int pgbase;
154 unsigned int pglen;
155};
156
157#define NFS4_PNFS_GETDEVLIST_MAXNUM 16
158
159struct pnfs_devicelist {
160 unsigned int eof;
161 unsigned int num_devs;
162 struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
163};
164
165extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
166extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
167
168/* nfs4proc.c */
169extern int nfs4_proc_getdevicelist(struct nfs_server *server,
170 const struct nfs_fh *fh,
171 struct pnfs_devicelist *devlist);
172extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
173 struct pnfs_device *dev);
174extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp, gfp_t gfp_flags);
175extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
176
177/* pnfs.c */
178void get_layout_hdr(struct pnfs_layout_hdr *lo);
179void put_lseg(struct pnfs_layout_segment *lseg);
180
181bool pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *,
182 const struct nfs_pgio_completion_ops *);
183bool pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *,
184 int, const struct nfs_pgio_completion_ops *);
185
186void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, u32);
187void unset_pnfs_layoutdriver(struct nfs_server *);
188void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
189int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
190void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *, struct nfs_page *);
191int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
192bool pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev, struct nfs_page *req);
193void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
194int pnfs_layout_process(struct nfs4_layoutget *lgp);
195void pnfs_free_lseg_list(struct list_head *tmp_list);
196void pnfs_destroy_layout(struct nfs_inode *);
197void pnfs_destroy_all_layouts(struct nfs_client *);
198void put_layout_hdr(struct pnfs_layout_hdr *lo);
199void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
200 const nfs4_stateid *new,
201 bool update_barrier);
202int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
203 struct pnfs_layout_hdr *lo,
204 struct nfs4_state *open_state);
205int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
206 struct list_head *tmp_list,
207 struct pnfs_layout_range *recall_range);
208bool pnfs_roc(struct inode *ino);
209void pnfs_roc_release(struct inode *ino);
210void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
211bool pnfs_roc_drain(struct inode *ino, u32 *barrier);
212void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
213void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
214int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
215int _pnfs_return_layout(struct inode *);
216void pnfs_ld_write_done(struct nfs_write_data *);
217void pnfs_ld_read_done(struct nfs_read_data *);
218struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
219 struct nfs_open_context *ctx,
220 loff_t pos,
221 u64 count,
222 enum pnfs_iomode iomode,
223 gfp_t gfp_flags);
224
225void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
226int pnfs_read_done_resend_to_mds(struct inode *inode, struct list_head *head,
227 const struct nfs_pgio_completion_ops *compl_ops);
228int pnfs_write_done_resend_to_mds(struct inode *inode, struct list_head *head,
229 const struct nfs_pgio_completion_ops *compl_ops);
230struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
231
232/* nfs4_deviceid_flags */
233enum {
234 NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
235};
236
237/* pnfs_dev.c */
238struct nfs4_deviceid_node {
239 struct hlist_node node;
240 struct hlist_node tmpnode;
241 const struct pnfs_layoutdriver_type *ld;
242 const struct nfs_client *nfs_client;
243 unsigned long flags;
244 struct nfs4_deviceid deviceid;
245 atomic_t ref;
246};
247
248struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
249void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
250void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
251 const struct pnfs_layoutdriver_type *,
252 const struct nfs_client *,
253 const struct nfs4_deviceid *);
254struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *);
255bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
256void nfs4_deviceid_purge_client(const struct nfs_client *);
257
258static inline int lo_fail_bit(u32 iomode)
259{
260 return iomode == IOMODE_RW ?
261 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
262}
263
264static inline struct pnfs_layout_segment *
265get_lseg(struct pnfs_layout_segment *lseg)
266{
267 if (lseg) {
268 atomic_inc(&lseg->pls_refcount);
269 smp_mb__after_atomic_inc();
270 }
271 return lseg;
272}
273
274/* Return true if a layout driver is being used for this mountpoint */
275static inline int pnfs_enabled_sb(struct nfs_server *nfss)
276{
277 return nfss->pnfs_curr_ld != NULL;
278}
279
280static inline int
281pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
282 struct nfs_commit_info *cinfo)
283{
284 if (cinfo->ds == NULL || cinfo->ds->ncommitting == 0)
285 return PNFS_NOT_ATTEMPTED;
286 return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
287}
288
289static inline struct pnfs_ds_commit_info *
290pnfs_get_ds_info(struct inode *inode)
291{
292 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
293
294 if (ld == NULL || ld->get_ds_info == NULL)
295 return NULL;
296 return ld->get_ds_info(inode);
297}
298
299static inline bool
300pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
301 struct nfs_commit_info *cinfo)
302{
303 struct inode *inode = req->wb_context->dentry->d_inode;
304 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
305
306 if (lseg == NULL || ld->mark_request_commit == NULL)
307 return false;
308 ld->mark_request_commit(req, lseg, cinfo);
309 return true;
310}
311
312static inline bool
313pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
314{
315 struct inode *inode = req->wb_context->dentry->d_inode;
316 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
317
318 if (ld == NULL || ld->clear_request_commit == NULL)
319 return false;
320 ld->clear_request_commit(req, cinfo);
321 return true;
322}
323
324static inline int
325pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
326 int max)
327{
328 if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
329 return 0;
330 else
331 return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
332}
333
334static inline void
335pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
336 struct nfs_commit_info *cinfo)
337{
338 if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
339 return;
340 NFS_SERVER(inode)->pnfs_curr_ld->recover_commit_reqs(list, cinfo);
341}
342
343/* Should the pNFS client commit and return the layout upon a setattr */
344static inline bool
345pnfs_ld_layoutret_on_setattr(struct inode *inode)
346{
347 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
348 return false;
349 return NFS_SERVER(inode)->pnfs_curr_ld->flags &
350 PNFS_LAYOUTRET_ON_SETATTR;
351}
352
353static inline int pnfs_return_layout(struct inode *ino)
354{
355 struct nfs_inode *nfsi = NFS_I(ino);
356 struct nfs_server *nfss = NFS_SERVER(ino);
357
358 if (pnfs_enabled_sb(nfss) && nfsi->layout)
359 return _pnfs_return_layout(ino);
360
361 return 0;
362}
363
364static inline bool
365pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
366 struct nfs_server *nfss)
367{
368 return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
369 nfss->pnfs_curr_ld->id == src->l_type);
370}
371
372#ifdef NFS_DEBUG
373void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
374#else
375static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
376{
377}
378#endif /* NFS_DEBUG */
379#else /* CONFIG_NFS_V4_1 */
380
381static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
382{
383}
384
385static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
386{
387}
388
389static inline struct pnfs_layout_segment *
390get_lseg(struct pnfs_layout_segment *lseg)
391{
392 return NULL;
393}
394
395static inline void put_lseg(struct pnfs_layout_segment *lseg)
396{
397}
398
399static inline int pnfs_return_layout(struct inode *ino)
400{
401 return 0;
402}
403
404static inline bool
405pnfs_ld_layoutret_on_setattr(struct inode *inode)
406{
407 return false;
408}
409
410static inline bool
411pnfs_roc(struct inode *ino)
412{
413 return false;
414}
415
416static inline void
417pnfs_roc_release(struct inode *ino)
418{
419}
420
421static inline void
422pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
423{
424}
425
426static inline bool
427pnfs_roc_drain(struct inode *ino, u32 *barrier)
428{
429 return false;
430}
431
432static inline void set_pnfs_layoutdriver(struct nfs_server *s,
433 const struct nfs_fh *mntfh, u32 id)
434{
435}
436
437static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
438{
439}
440
441static inline bool pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *inode,
442 const struct nfs_pgio_completion_ops *compl_ops)
443{
444 return false;
445}
446
447static inline bool pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *inode, int ioflags,
448 const struct nfs_pgio_completion_ops *compl_ops)
449{
450 return false;
451}
452
453static inline int
454pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
455 struct nfs_commit_info *cinfo)
456{
457 return PNFS_NOT_ATTEMPTED;
458}
459
460static inline struct pnfs_ds_commit_info *
461pnfs_get_ds_info(struct inode *inode)
462{
463 return NULL;
464}
465
466static inline bool
467pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
468 struct nfs_commit_info *cinfo)
469{
470 return false;
471}
472
473static inline bool
474pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
475{
476 return false;
477}
478
479static inline int
480pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
481 int max)
482{
483 return 0;
484}
485
486static inline void
487pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
488 struct nfs_commit_info *cinfo)
489{
490}
491
492static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
493{
494 return 0;
495}
496
497static inline bool
498pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
499 struct nfs_server *nfss)
500{
501 return false;
502}
503
504static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
505{
506 return NULL;
507}
508
509#endif /* CONFIG_NFS_V4_1 */
510
511#endif /* FS_NFS_PNFS_H */