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