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