blob: 3e6ab7bfbabd428425227b6f9d2a94711edd371e [file] [log] [blame]
Ricardo Labiaga85e174b2010-10-20 00:17:58 -04001/*
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
Benny Halevy45df3c82011-05-05 08:28:46 +030033#include <linux/nfs_fs.h>
Fred Isaman94ad1c82011-03-01 01:34:14 +000034#include <linux/nfs_page.h>
Weston Andros Adamsone6cf82d2014-07-17 20:42:18 -040035#include <linux/workqueue.h>
Fred Isaman94ad1c82011-03-01 01:34:14 +000036
Fred Isaman4541d162011-01-06 11:36:23 +000037enum {
38 NFS_LSEG_VALID = 0, /* cleared when lseg is recalled/returned */
Fred Isamanf7e89172011-01-06 11:36:32 +000039 NFS_LSEG_ROC, /* roc bit received from server */
Peng Taoa9bae562011-07-30 20:52:33 -040040 NFS_LSEG_LAYOUTCOMMIT, /* layoutcommit bit set for layoutcommit */
Peng Tao016256d2014-09-06 00:53:23 +080041 NFS_LSEG_LAYOUTRETURN, /* layoutreturn bit set for layoutreturn */
Fred Isaman4541d162011-01-06 11:36:23 +000042};
43
Peng Tao875ae062014-05-29 21:06:57 +080044/* Individual ip address */
45struct nfs4_pnfs_ds_addr {
46 struct sockaddr_storage da_addr;
47 size_t da_addrlen;
48 struct list_head da_node; /* nfs4_pnfs_dev_hlist dev_dslist */
49 char *da_remotestr; /* human readable addr+port */
50};
51
52struct nfs4_pnfs_ds {
53 struct list_head ds_node; /* nfs4_pnfs_dev_hlist dev_dslist */
54 char *ds_remotestr; /* comma sep list of addrs */
55 struct list_head ds_addrs;
56 struct nfs_client *ds_clp;
57 atomic_t ds_count;
58 unsigned long ds_state;
59#define NFS4DS_CONNECTING 0 /* ds is establishing connection */
Ricardo Labiaga85e174b2010-10-20 00:17:58 -040060};
61
Andy Adamson974cec82010-10-20 00:18:02 -040062struct pnfs_layout_segment {
Fred Isaman566052c2011-01-06 11:36:20 +000063 struct list_head pls_list;
Peng Taoa9bae562011-07-30 20:52:33 -040064 struct list_head pls_lc_list;
Fred Isaman566052c2011-01-06 11:36:20 +000065 struct pnfs_layout_range pls_range;
Fred Isaman4541d162011-01-06 11:36:23 +000066 atomic_t pls_refcount;
67 unsigned long pls_flags;
Fred Isaman566052c2011-01-06 11:36:20 +000068 struct pnfs_layout_hdr *pls_layout;
Weston Andros Adamsone6cf82d2014-07-17 20:42:18 -040069 struct work_struct pls_work;
Andy Adamson974cec82010-10-20 00:18:02 -040070};
71
Andy Adamson64419a92011-03-01 01:34:16 +000072enum pnfs_try_status {
73 PNFS_ATTEMPTED = 0,
74 PNFS_NOT_ATTEMPTED = 1,
Peng Taoceb11e12014-11-10 08:35:38 +080075 PNFS_TRY_AGAIN = 2,
Andy Adamson64419a92011-03-01 01:34:16 +000076};
77
Ricardo Labiaga85e174b2010-10-20 00:17:58 -040078#ifdef CONFIG_NFS_V4_1
79
80#define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
81
Peng Tao39280a52014-05-30 18:15:55 +080082/*
83 * Default data server connection timeout and retrans vaules.
84 * Set by module parameters dataserver_timeo and dataserver_retrans.
85 */
86#define NFS4_DEF_DS_TIMEO 600 /* in tenths of a second */
87#define NFS4_DEF_DS_RETRANS 5
88
89/* error codes for internal use */
90#define NFS4ERR_RESET_TO_MDS 12001
91#define NFS4ERR_RESET_TO_PNFS 12002
92
Benny Halevye5e94012010-10-20 00:18:01 -040093enum {
94 NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */
95 NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */
Fred Isaman43f1b3d2011-01-06 11:36:30 +000096 NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */
Fred Isamanf7e89172011-01-06 11:36:32 +000097 NFS_LAYOUT_ROC, /* some lseg had roc bit set */
Trond Myklebustd527e5c2012-10-11 13:43:38 -040098 NFS_LAYOUT_RETURN, /* Return this layout ASAP */
Peng Tao193e3aa2014-11-17 09:30:41 +080099 NFS_LAYOUT_RETURN_BEFORE_CLOSE, /* Return this layout before close */
Christoph Hellwig47abade2014-08-21 11:09:22 -0500100 NFS_LAYOUT_INVALID_STID, /* layout stateid id is invalid */
Peng Tao9bf87482014-08-22 17:37:41 +0800101 NFS_LAYOUT_FIRST_LAYOUTGET, /* Serialize first layoutget */
Peng Taoc8290132014-12-01 08:22:18 +0800102 NFS_LAYOUT_RETRY_LAYOUTGET, /* Retry layoutget */
Benny Halevye5e94012010-10-20 00:18:01 -0400103};
104
Benny Halevy8a1636c2010-07-14 15:43:57 -0400105enum layoutdriver_policy_flags {
Peng Tao88ac8152014-09-12 11:04:10 +0800106 /* Should the pNFS client commit and return the layout upon truncate to
107 * a smaller size */
Benny Halevy8a1636c2010-07-14 15:43:57 -0400108 PNFS_LAYOUTRET_ON_SETATTR = 1 << 0,
Boaz Harroshfe0fe832012-01-06 09:31:20 +0200109 PNFS_LAYOUTRET_ON_ERROR = 1 << 1,
Christoph Hellwig612aa982014-09-10 08:23:30 -0700110 PNFS_READ_WHOLE_PAGE = 1 << 2,
Benny Halevy8a1636c2010-07-14 15:43:57 -0400111};
112
Benny Halevy1775bc32011-05-20 13:47:33 +0200113struct nfs4_deviceid_node;
114
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400115/* Per-layout driver specific registration structure */
116struct pnfs_layoutdriver_type {
Fred Isaman02c35fc2010-10-20 00:17:59 -0400117 struct list_head pnfs_tblid;
118 const u32 id;
119 const char *name;
120 struct module *owner;
Benny Halevy8a1636c2010-07-14 15:43:57 -0400121 unsigned flags;
Christoph Hellwig661373b2014-09-02 21:27:57 -0700122 unsigned max_deviceinfo_size;
Benny Halevy636fb9c2011-05-22 19:51:33 +0300123
Benny Halevy738fd0f32011-07-30 20:52:36 -0400124 int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
125 int (*clear_layoutdriver) (struct nfs_server *);
126
Benny Halevy636fb9c2011-05-22 19:51:33 +0300127 struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
128 void (*free_layout_hdr) (struct pnfs_layout_hdr *);
129
Trond Myklebusta75b9df2011-05-11 18:00:51 -0400130 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
Andy Adamsonb1f69b72010-10-20 00:18:03 -0400131 void (*free_lseg) (struct pnfs_layout_segment *lseg);
Fred Isaman94ad1c82011-03-01 01:34:14 +0000132
Christoph Hellwigc88953d2014-09-10 08:23:31 -0700133 void (*return_range) (struct pnfs_layout_hdr *lo,
134 struct pnfs_layout_range *range);
135
Fred Isaman94ad1c82011-03-01 01:34:14 +0000136 /* test for nfs page cache coalescing */
Trond Myklebust1751c362011-06-10 13:30:23 -0400137 const struct nfs_pageio_ops *pg_read_ops;
138 const struct nfs_pageio_ops *pg_write_ops;
Andy Adamson64419a92011-03-01 01:34:16 +0000139
Fred Isamanea2cf222012-04-20 14:47:53 -0400140 struct pnfs_ds_commit_info *(*get_ds_info) (struct inode *inode);
Trond Myklebust8dd37752012-03-15 17:16:40 -0400141 void (*mark_request_commit) (struct nfs_page *req,
Fred Isamanea2cf222012-04-20 14:47:53 -0400142 struct pnfs_layout_segment *lseg,
Weston Andros Adamsonb57ff132014-09-05 18:20:21 -0400143 struct nfs_commit_info *cinfo,
144 u32 ds_commit_idx);
Fred Isamanea2cf222012-04-20 14:47:53 -0400145 void (*clear_request_commit) (struct nfs_page *req,
146 struct nfs_commit_info *cinfo);
147 int (*scan_commit_lists) (struct nfs_commit_info *cinfo,
148 int max);
Fred Isaman1763da12012-04-20 14:47:57 -0400149 void (*recover_commit_reqs) (struct list_head *list,
150 struct nfs_commit_info *cinfo);
Weston Andros Adamson02d14262014-07-17 20:42:17 -0400151 struct nfs_page * (*search_commit_reqs)(struct nfs_commit_info *cinfo,
152 struct page *page);
Fred Isamanea2cf222012-04-20 14:47:53 -0400153 int (*commit_pagelist)(struct inode *inode,
154 struct list_head *mds_pages,
155 int how,
156 struct nfs_commit_info *cinfo);
Fred Isamana861a1e2011-03-23 13:27:51 +0000157
Trond Myklebust5bb89b42015-03-25 14:14:42 -0400158 int (*sync)(struct inode *inode, bool datasync);
159
Andy Adamson64419a92011-03-01 01:34:16 +0000160 /*
161 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
162 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
163 */
Weston Andros Adamsond45f60c2014-06-09 11:48:35 -0400164 enum pnfs_try_status (*read_pagelist)(struct nfs_pgio_header *);
165 enum pnfs_try_status (*write_pagelist)(struct nfs_pgio_header *, int);
Benny Halevy1775bc32011-05-20 13:47:33 +0200166
167 void (*free_deviceid_node) (struct nfs4_deviceid_node *);
Christoph Hellwig661373b2014-09-02 21:27:57 -0700168 struct nfs4_deviceid_node * (*alloc_deviceid_node)
169 (struct nfs_server *server, struct pnfs_device *pdev,
170 gfp_t gfp_flags);
Andy Adamson04a55542011-05-22 19:53:10 +0300171
172 void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid,
173 struct xdr_stream *xdr,
174 const struct nfs4_layoutreturn_args *args);
Benny Halevyac7db722011-05-22 19:53:48 +0300175
Andy Adamsondb29c082011-07-30 20:52:38 -0400176 void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);
Christoph Hellwig5f919c92014-08-21 11:09:25 -0500177 int (*prepare_layoutcommit) (struct nfs4_layoutcommit_args *args);
178 void (*encode_layoutcommit) (struct pnfs_layout_hdr *lo,
Benny Halevyac7db722011-05-22 19:53:48 +0300179 struct xdr_stream *xdr,
180 const struct nfs4_layoutcommit_args *args);
Peng Tao87334082015-06-23 19:51:57 +0800181 int (*prepare_layoutstats) (struct nfs42_layoutstat_args *args);
182 void (*cleanup_layoutstats) (struct nfs42_layoutstat_data *data);
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400183};
184
Benny Halevye5e94012010-10-20 00:18:01 -0400185struct pnfs_layout_hdr {
Fred Isamancc6e5342011-01-06 11:36:28 +0000186 atomic_t plh_refcount;
Fred Isamanb7edfaa2011-01-06 11:36:21 +0000187 struct list_head plh_layouts; /* other client layouts */
Trond Myklebustfd9a8d72013-02-12 09:48:42 -0500188 struct list_head plh_bulk_destroy;
Fred Isamanb7edfaa2011-01-06 11:36:21 +0000189 struct list_head plh_segs; /* layout segments list */
Fred Isamanb7edfaa2011-01-06 11:36:21 +0000190 nfs4_stateid plh_stateid;
Fred Isamancf7d63f2011-01-06 11:36:25 +0000191 atomic_t plh_outstanding; /* number of RPCs out */
Fred Isamanf7e89172011-01-06 11:36:32 +0000192 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
Fred Isaman43f1b3d2011-01-06 11:36:30 +0000193 u32 plh_barrier; /* ignore lower seqids */
Trond Myklebust25c75332012-09-18 17:01:12 -0400194 unsigned long plh_retry_timestamp;
Fred Isaman566052c2011-01-06 11:36:20 +0000195 unsigned long plh_flags;
Peng Tao016256d2014-09-06 00:53:23 +0800196 enum pnfs_iomode plh_return_iomode;
Peng Taoacff58802011-07-30 20:52:31 -0400197 loff_t plh_lwb; /* last write byte for layoutcommit */
Peng Tao9fa40752011-07-30 20:52:32 -0400198 struct rpc_cred *plh_lc_cred; /* layoutcommit cred */
Fred Isamanb7edfaa2011-01-06 11:36:21 +0000199 struct inode *plh_inode;
Benny Halevye5e94012010-10-20 00:18:01 -0400200};
201
Andy Adamsonb1f69b72010-10-20 00:18:03 -0400202struct pnfs_device {
203 struct nfs4_deviceid dev_id;
204 unsigned int layout_type;
205 unsigned int mincount;
Andy Adamsonf1c097b2013-06-25 19:02:53 -0400206 unsigned int maxcount; /* gdia_maxcount */
Andy Adamsonb1f69b72010-10-20 00:18:03 -0400207 struct page **pages;
Andy Adamsonb1f69b72010-10-20 00:18:03 -0400208 unsigned int pgbase;
Andy Adamsonf1c097b2013-06-25 19:02:53 -0400209 unsigned int pglen; /* reply buffer length */
Trond Myklebustdf526992015-03-09 14:48:32 -0400210 unsigned char nocache : 1;/* May not be cached */
Andy Adamsonb1f69b72010-10-20 00:18:03 -0400211};
212
Andy Adamson7f11d8d2011-07-30 20:52:35 -0400213#define NFS4_PNFS_GETDEVLIST_MAXNUM 16
214
215struct pnfs_devicelist {
216 unsigned int eof;
217 unsigned int num_devs;
218 struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
219};
220
Fred Isaman02c35fc2010-10-20 00:17:59 -0400221extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
222extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
223
Andy Adamsonb1f69b72010-10-20 00:18:03 -0400224/* nfs4proc.c */
225extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
Trond Myklebustcd5875f2013-05-20 11:42:54 -0400226 struct pnfs_device *dev,
227 struct rpc_cred *cred);
Trond Myklebusta0b0a6e2012-09-17 17:12:15 -0400228extern struct pnfs_layout_segment* nfs4_proc_layoutget(struct nfs4_layoutget *lgp, gfp_t gfp_flags);
Peng Tao6c166052014-11-17 09:30:40 +0800229extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp, bool sync);
Andy Adamsonb1f69b72010-10-20 00:18:03 -0400230
231/* pnfs.c */
Trond Myklebust70c3bd22012-09-18 20:51:13 -0400232void pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo);
Trond Myklebust9369a432012-09-18 20:57:08 -0400233void pnfs_put_lseg(struct pnfs_layout_segment *lseg);
Trond Myklebust6543f802014-10-08 16:39:12 -0400234void pnfs_put_lseg_locked(struct pnfs_layout_segment *lseg);
Trond Myklebust1751c362011-06-10 13:30:23 -0400235
Benny Halevy738fd0f32011-07-30 20:52:36 -0400236void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, u32);
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400237void unset_pnfs_layoutdriver(struct nfs_server *);
Trond Myklebustd8007d42011-06-10 13:30:23 -0400238void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
Trond Myklebust493292d2011-07-13 15:58:28 -0400239int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
Peng Tao62965562012-09-25 14:55:57 +0800240void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio,
241 struct nfs_page *req, u64 wb_size);
Weston Andros Adamson180bb5e2014-09-10 15:48:01 -0400242void pnfs_generic_pg_cleanup(struct nfs_pageio_descriptor *);
Trond Myklebustdce81292011-07-13 15:59:19 -0400243int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
Weston Andros Adamsonb4fdac12014-05-15 11:56:43 -0400244size_t pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio,
245 struct nfs_page *prev, struct nfs_page *req);
Peng Tao1b0ae062011-09-22 21:50:12 -0400246void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
Trond Myklebusta0b0a6e2012-09-17 17:12:15 -0400247struct pnfs_layout_segment *pnfs_layout_process(struct nfs4_layoutget *lgp);
Fred Isaman43f1b3d2011-01-06 11:36:30 +0000248void pnfs_free_lseg_list(struct list_head *tmp_list);
Benny Halevye5e94012010-10-20 00:18:01 -0400249void pnfs_destroy_layout(struct nfs_inode *);
Andy Adamson974cec82010-10-20 00:18:02 -0400250void pnfs_destroy_all_layouts(struct nfs_client *);
Trond Myklebustfd9a8d72013-02-12 09:48:42 -0500251int pnfs_destroy_layouts_byfsid(struct nfs_client *clp,
252 struct nfs_fsid *fsid,
253 bool is_recall);
254int pnfs_destroy_layouts_byclid(struct nfs_client *clp,
255 bool is_recall);
Trond Myklebust70c3bd22012-09-18 20:51:13 -0400256void pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo);
Fred Isaman43f1b3d2011-01-06 11:36:30 +0000257void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
258 const nfs4_stateid *new,
259 bool update_barrier);
Fred Isamanfd6002e2011-01-06 11:36:22 +0000260int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
261 struct pnfs_layout_hdr *lo,
Peng Taoce6ab4f2014-09-06 00:53:24 +0800262 struct pnfs_layout_range *range,
Fred Isamanfd6002e2011-01-06 11:36:22 +0000263 struct nfs4_state *open_state);
Trond Myklebust49a85062012-09-18 20:43:31 -0400264int pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
Fred Isaman43f1b3d2011-01-06 11:36:30 +0000265 struct list_head *tmp_list,
Benny Halevy778b5502011-05-22 19:48:02 +0300266 struct pnfs_layout_range *recall_range);
Fred Isamanf7e89172011-01-06 11:36:32 +0000267bool pnfs_roc(struct inode *ino);
268void pnfs_roc_release(struct inode *ino);
269void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
Trond Myklebust7fdab062012-09-20 20:15:57 -0400270bool pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task);
Trond Myklebust67af7612015-03-25 20:40:38 -0400271void pnfs_set_layoutcommit(struct inode *, struct pnfs_layout_segment *, loff_t);
Andy Adamsondb29c082011-07-30 20:52:38 -0400272void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
Andy Adamsonef311532011-03-12 02:58:10 -0500273int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
Trond Myklebust5bb89b42015-03-25 14:14:42 -0400274int pnfs_generic_sync(struct inode *inode, bool datasync);
275int pnfs_nfs_generic_sync(struct inode *inode, bool datasync);
Benny Halevycbe82602011-05-22 19:52:37 +0300276int _pnfs_return_layout(struct inode *);
Trond Myklebust24028672013-03-20 13:23:33 -0400277int pnfs_commit_and_return_layout(struct inode *);
Weston Andros Adamsond45f60c2014-06-09 11:48:35 -0400278void pnfs_ld_write_done(struct nfs_pgio_header *);
279void pnfs_ld_read_done(struct nfs_pgio_header *);
Peng Taoceb11e12014-11-10 08:35:38 +0800280int pnfs_read_resend_pnfs(struct nfs_pgio_header *);
Andy Adamson7c24d942011-06-13 18:22:38 -0400281struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
282 struct nfs_open_context *ctx,
283 loff_t pos,
284 u64 count,
285 enum pnfs_iomode iomode,
286 gfp_t gfp_flags);
Tom Haynesd67ae822014-12-11 17:02:04 -0500287void pnfs_clear_layoutreturn_waitbit(struct pnfs_layout_hdr *lo);
Benny Halevye5e94012010-10-20 00:18:01 -0400288
Andy Adamsonc47abcf2011-06-15 17:52:40 -0400289void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
Weston Andros Adamson53113ad2014-06-09 11:48:38 -0400290int pnfs_read_done_resend_to_mds(struct nfs_pgio_header *);
291int pnfs_write_done_resend_to_mds(struct nfs_pgio_header *);
Andy Adamson82be4172012-05-23 05:02:35 -0400292struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
Peng Tao016256d2014-09-06 00:53:23 +0800293void pnfs_error_mark_layout_for_return(struct inode *inode,
294 struct pnfs_layout_segment *lseg);
Andy Adamsonc47abcf2011-06-15 17:52:40 -0400295/* nfs4_deviceid_flags */
296enum {
297 NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
Trond Myklebust1dfed272012-09-18 19:51:12 -0400298 NFS_DEVICEID_UNAVAILABLE, /* device temporarily unavailable */
Trond Myklebustdf526992015-03-09 14:48:32 -0400299 NFS_DEVICEID_NOCACHE, /* device may not be cached */
Andy Adamsonc47abcf2011-06-15 17:52:40 -0400300};
301
Benny Halevya1eaecb2011-05-19 22:14:47 -0400302/* pnfs_dev.c */
303struct nfs4_deviceid_node {
304 struct hlist_node node;
Weston Andros Adamson9e3bd4e2011-05-31 21:46:50 -0400305 struct hlist_node tmpnode;
Benny Halevy1775bc32011-05-20 13:47:33 +0200306 const struct pnfs_layoutdriver_type *ld;
Benny Halevya1eaecb2011-05-19 22:14:47 -0400307 const struct nfs_client *nfs_client;
Andy Adamsonc47abcf2011-06-15 17:52:40 -0400308 unsigned long flags;
Trond Myklebust1dfed272012-09-18 19:51:12 -0400309 unsigned long timestamp_unavailable;
Benny Halevya1eaecb2011-05-19 22:14:47 -0400310 struct nfs4_deviceid deviceid;
Trond Myklebust84a80f62015-03-09 15:23:35 -0400311 struct rcu_head rcu;
Benny Halevya1eaecb2011-05-19 22:14:47 -0400312 atomic_t ref;
313};
314
Christoph Hellwig661373b2014-09-02 21:27:57 -0700315struct nfs4_deviceid_node *
316nfs4_find_get_deviceid(struct nfs_server *server,
317 const struct nfs4_deviceid *id, struct rpc_cred *cred,
318 gfp_t gfp_mask);
Benny Halevy35c8bb52011-05-24 18:04:02 +0300319void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
Christoph Hellwig661373b2014-09-02 21:27:57 -0700320void nfs4_init_deviceid_node(struct nfs4_deviceid_node *, struct nfs_server *,
Benny Halevya1eaecb2011-05-19 22:14:47 -0400321 const struct nfs4_deviceid *);
Benny Halevya1eaecb2011-05-19 22:14:47 -0400322bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
Trond Myklebust1dfed272012-09-18 19:51:12 -0400323void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
324bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
Benny Halevy1775bc32011-05-20 13:47:33 +0200325void nfs4_deviceid_purge_client(const struct nfs_client *);
Benny Halevya1eaecb2011-05-19 22:14:47 -0400326
Tom Haynesf54bcf22014-12-11 15:34:59 -0500327/* pnfs_nfs.c */
328void pnfs_generic_clear_request_commit(struct nfs_page *req,
329 struct nfs_commit_info *cinfo);
330void pnfs_generic_commit_release(void *calldata);
331void pnfs_generic_prepare_to_resend_writes(struct nfs_commit_data *data);
332void pnfs_generic_rw_release(void *data);
333void pnfs_generic_recover_commit_reqs(struct list_head *dst,
334 struct nfs_commit_info *cinfo);
335int pnfs_generic_commit_pagelist(struct inode *inode,
336 struct list_head *mds_pages,
337 int how,
338 struct nfs_commit_info *cinfo,
339 int (*initiate_commit)(struct nfs_commit_data *data,
340 int how));
341int pnfs_generic_scan_commit_lists(struct nfs_commit_info *cinfo, int max);
342void pnfs_generic_write_commit_done(struct rpc_task *task, void *data);
Peng Tao875ae062014-05-29 21:06:57 +0800343void nfs4_pnfs_ds_put(struct nfs4_pnfs_ds *ds);
344struct nfs4_pnfs_ds *nfs4_pnfs_ds_add(struct list_head *dsaddrs,
345 gfp_t gfp_flags);
Peng Tao5f01d952014-05-30 18:15:59 +0800346void nfs4_pnfs_v3_ds_connect_unload(void);
Peng Tao7405f9e2014-05-29 21:06:58 +0800347void nfs4_pnfs_ds_connect(struct nfs_server *mds_srv, struct nfs4_pnfs_ds *ds,
348 struct nfs4_deviceid_node *devid, unsigned int timeo,
Peng Tao5f01d952014-05-30 18:15:59 +0800349 unsigned int retrans, u32 version, u32 minor_version,
Peng Tao30626f92014-05-30 18:15:58 +0800350 rpc_authflavor_t au_flavor);
Peng Tao6b7f3cf2014-05-29 21:06:59 +0800351struct nfs4_pnfs_ds_addr *nfs4_decode_mp_ds_addr(struct net *net,
352 struct xdr_stream *xdr,
353 gfp_t gfp_flags);
Tom Haynes338d00c2015-02-17 14:58:15 -0800354void pnfs_layout_mark_request_commit(struct nfs_page *req,
355 struct pnfs_layout_segment *lseg,
356 struct nfs_commit_info *cinfo,
357 u32 ds_commit_idx);
Tom Haynesf54bcf22014-12-11 15:34:59 -0500358
Trond Myklebust40dd4b72015-01-24 13:54:37 -0500359static inline bool nfs_have_layout(struct inode *inode)
360{
361 return NFS_I(inode)->layout != NULL;
362}
363
Christoph Hellwig30ff0602014-09-02 21:27:59 -0700364static inline struct nfs4_deviceid_node *
365nfs4_get_deviceid(struct nfs4_deviceid_node *d)
366{
367 atomic_inc(&d->ref);
368 return d;
369}
370
Peng Taoc8290132014-12-01 08:22:18 +0800371static inline void pnfs_set_retry_layoutget(struct pnfs_layout_hdr *lo)
372{
373 if (!test_and_set_bit(NFS_LAYOUT_RETRY_LAYOUTGET, &lo->plh_flags))
374 atomic_inc(&lo->plh_refcount);
375}
376
377static inline void pnfs_clear_retry_layoutget(struct pnfs_layout_hdr *lo)
378{
Peng Taoaa8a45e2014-12-01 08:22:23 +0800379 if (test_and_clear_bit(NFS_LAYOUT_RETRY_LAYOUTGET, &lo->plh_flags)) {
Peng Taoc8290132014-12-01 08:22:18 +0800380 atomic_dec(&lo->plh_refcount);
Peng Taoaa8a45e2014-12-01 08:22:23 +0800381 /* wake up waiters for LAYOUTRETURN as that is not needed */
382 wake_up_bit(&lo->plh_flags, NFS_LAYOUT_RETURN);
383 }
Peng Taoc8290132014-12-01 08:22:18 +0800384}
385
386static inline bool pnfs_should_retry_layoutget(struct pnfs_layout_hdr *lo)
387{
388 return test_bit(NFS_LAYOUT_RETRY_LAYOUTGET, &lo->plh_flags);
389}
390
Fred Isamand684d2a2011-03-01 01:34:13 +0000391static inline struct pnfs_layout_segment *
Trond Myklebust9369a432012-09-18 20:57:08 -0400392pnfs_get_lseg(struct pnfs_layout_segment *lseg)
Fred Isamand684d2a2011-03-01 01:34:13 +0000393{
394 if (lseg) {
395 atomic_inc(&lseg->pls_refcount);
Peter Zijlstra4e857c52014-03-17 18:06:10 +0100396 smp_mb__after_atomic();
Fred Isamand684d2a2011-03-01 01:34:13 +0000397 }
398 return lseg;
399}
400
Benny Halevye5e94012010-10-20 00:18:01 -0400401/* Return true if a layout driver is being used for this mountpoint */
402static inline int pnfs_enabled_sb(struct nfs_server *nfss)
403{
404 return nfss->pnfs_curr_ld != NULL;
405}
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400406
Fred Isamana861a1e2011-03-23 13:27:51 +0000407static inline int
Fred Isamanea2cf222012-04-20 14:47:53 -0400408pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
409 struct nfs_commit_info *cinfo)
Fred Isamana861a1e2011-03-23 13:27:51 +0000410{
Fred Isamanea2cf222012-04-20 14:47:53 -0400411 if (cinfo->ds == NULL || cinfo->ds->ncommitting == 0)
Fred Isamana861a1e2011-03-23 13:27:51 +0000412 return PNFS_NOT_ATTEMPTED;
Fred Isamanea2cf222012-04-20 14:47:53 -0400413 return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
414}
415
416static inline struct pnfs_ds_commit_info *
417pnfs_get_ds_info(struct inode *inode)
418{
419 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
420
421 if (ld == NULL || ld->get_ds_info == NULL)
422 return NULL;
423 return ld->get_ds_info(inode);
Fred Isamana861a1e2011-03-23 13:27:51 +0000424}
425
Tom Haynesf54bcf22014-12-11 15:34:59 -0500426static inline void
427pnfs_generic_mark_devid_invalid(struct nfs4_deviceid_node *node)
428{
429 set_bit(NFS_DEVICEID_INVALID, &node->flags);
430}
431
Trond Myklebust8dd37752012-03-15 17:16:40 -0400432static inline bool
Fred Isamanea2cf222012-04-20 14:47:53 -0400433pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
Weston Andros Adamsonb57ff132014-09-05 18:20:21 -0400434 struct nfs_commit_info *cinfo, u32 ds_commit_idx)
Fred Isamana861a1e2011-03-23 13:27:51 +0000435{
David Howells2b0143b2015-03-17 22:25:59 +0000436 struct inode *inode = d_inode(req->wb_context->dentry);
Trond Myklebust8dd37752012-03-15 17:16:40 -0400437 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
Fred Isamana861a1e2011-03-23 13:27:51 +0000438
Trond Myklebust8dd37752012-03-15 17:16:40 -0400439 if (lseg == NULL || ld->mark_request_commit == NULL)
440 return false;
Weston Andros Adamsonb57ff132014-09-05 18:20:21 -0400441 ld->mark_request_commit(req, lseg, cinfo, ds_commit_idx);
Trond Myklebust8dd37752012-03-15 17:16:40 -0400442 return true;
Fred Isamana861a1e2011-03-23 13:27:51 +0000443}
444
Trond Myklebust8dd37752012-03-15 17:16:40 -0400445static inline bool
Fred Isamanea2cf222012-04-20 14:47:53 -0400446pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
Fred Isamana861a1e2011-03-23 13:27:51 +0000447{
David Howells2b0143b2015-03-17 22:25:59 +0000448 struct inode *inode = d_inode(req->wb_context->dentry);
Trond Myklebust8dd37752012-03-15 17:16:40 -0400449 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
Fred Isamand6d6dc72012-03-08 17:29:35 -0500450
Trond Myklebust8dd37752012-03-15 17:16:40 -0400451 if (ld == NULL || ld->clear_request_commit == NULL)
452 return false;
Fred Isamanea2cf222012-04-20 14:47:53 -0400453 ld->clear_request_commit(req, cinfo);
Trond Myklebust8dd37752012-03-15 17:16:40 -0400454 return true;
Fred Isamand6d6dc72012-03-08 17:29:35 -0500455}
456
457static inline int
Fred Isamanea2cf222012-04-20 14:47:53 -0400458pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
459 int max)
Fred Isamand6d6dc72012-03-08 17:29:35 -0500460{
Fred Isamanea2cf222012-04-20 14:47:53 -0400461 if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
Fred Isamand6d6dc72012-03-08 17:29:35 -0500462 return 0;
Fred Isamanea2cf222012-04-20 14:47:53 -0400463 else
464 return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
Fred Isamana861a1e2011-03-23 13:27:51 +0000465}
466
Weston Andros Adamson02d14262014-07-17 20:42:17 -0400467static inline struct nfs_page *
468pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
469 struct page *page)
470{
471 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
472
473 if (ld == NULL || ld->search_commit_reqs == NULL)
474 return NULL;
475 return ld->search_commit_reqs(cinfo, page);
476}
477
Benny Halevy8a1636c2010-07-14 15:43:57 -0400478/* Should the pNFS client commit and return the layout upon a setattr */
479static inline bool
480pnfs_ld_layoutret_on_setattr(struct inode *inode)
481{
482 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
483 return false;
484 return NFS_SERVER(inode)->pnfs_curr_ld->flags &
485 PNFS_LAYOUTRET_ON_SETATTR;
486}
487
Trond Myklebustd8c951c2014-01-13 12:08:11 -0500488static inline bool
Christoph Hellwig612aa982014-09-10 08:23:30 -0700489pnfs_ld_read_whole_page(struct inode *inode)
490{
491 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
492 return false;
493 return NFS_SERVER(inode)->pnfs_curr_ld->flags & PNFS_READ_WHOLE_PAGE;
494}
495
Trond Myklebust5bb89b42015-03-25 14:14:42 -0400496static inline int
497pnfs_sync_inode(struct inode *inode, bool datasync)
498{
499 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
500 return 0;
501 return NFS_SERVER(inode)->pnfs_curr_ld->sync(inode, datasync);
502}
503
Christoph Hellwig612aa982014-09-10 08:23:30 -0700504static inline bool
Trond Myklebustd8c951c2014-01-13 12:08:11 -0500505pnfs_layoutcommit_outstanding(struct inode *inode)
506{
507 struct nfs_inode *nfsi = NFS_I(inode);
508
509 return test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags) != 0 ||
510 test_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags) != 0;
511}
512
Benny Halevycbe82602011-05-22 19:52:37 +0300513static inline int pnfs_return_layout(struct inode *ino)
514{
515 struct nfs_inode *nfsi = NFS_I(ino);
516 struct nfs_server *nfss = NFS_SERVER(ino);
517
518 if (pnfs_enabled_sb(nfss) && nfsi->layout)
519 return _pnfs_return_layout(ino);
520
521 return 0;
522}
523
Andy Adamson82be4172012-05-23 05:02:35 -0400524static inline bool
525pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
526 struct nfs_server *nfss)
527{
Fred Isamanfb47ddc2012-06-07 11:42:12 -0400528 return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
Andy Adamson82be4172012-05-23 05:02:35 -0400529 nfss->pnfs_curr_ld->id == src->l_type);
530}
531
Trond Myklebust6f008662012-03-20 14:12:46 -0400532#ifdef NFS_DEBUG
533void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
534#else
535static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
536{
537}
538#endif /* NFS_DEBUG */
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400539#else /* CONFIG_NFS_V4_1 */
540
Trond Myklebust40dd4b72015-01-24 13:54:37 -0500541static inline bool nfs_have_layout(struct inode *inode)
542{
543 return false;
544}
545
Andy Adamson974cec82010-10-20 00:18:02 -0400546static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
547{
548}
549
Benny Halevye5e94012010-10-20 00:18:01 -0400550static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
551{
552}
553
554static inline struct pnfs_layout_segment *
Trond Myklebust9369a432012-09-18 20:57:08 -0400555pnfs_get_lseg(struct pnfs_layout_segment *lseg)
Fred Isamand684d2a2011-03-01 01:34:13 +0000556{
557 return NULL;
558}
559
Trond Myklebust9369a432012-09-18 20:57:08 -0400560static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
Fred Isamand684d2a2011-03-01 01:34:13 +0000561{
562}
563
Benny Halevycbe82602011-05-22 19:52:37 +0300564static inline int pnfs_return_layout(struct inode *ino)
565{
566 return 0;
567}
568
Trond Myklebust24028672013-03-20 13:23:33 -0400569static inline int pnfs_commit_and_return_layout(struct inode *inode)
570{
571 return 0;
572}
573
Fred Isamanf7e89172011-01-06 11:36:32 +0000574static inline bool
Benny Halevy8a1636c2010-07-14 15:43:57 -0400575pnfs_ld_layoutret_on_setattr(struct inode *inode)
576{
577 return false;
578}
579
580static inline bool
Christoph Hellwig612aa982014-09-10 08:23:30 -0700581pnfs_ld_read_whole_page(struct inode *inode)
582{
583 return false;
584}
585
Trond Myklebust5bb89b42015-03-25 14:14:42 -0400586static inline int
587pnfs_sync_inode(struct inode *inode, bool datasync)
588{
589 return 0;
590}
591
Christoph Hellwig612aa982014-09-10 08:23:30 -0700592static inline bool
Fred Isamanf7e89172011-01-06 11:36:32 +0000593pnfs_roc(struct inode *ino)
594{
595 return false;
596}
597
598static inline void
599pnfs_roc_release(struct inode *ino)
600{
601}
602
603static inline void
604pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
605{
606}
607
608static inline bool
Trond Myklebust7fdab062012-09-20 20:15:57 -0400609pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task)
Fred Isamanf7e89172011-01-06 11:36:32 +0000610{
611 return false;
612}
613
Benny Halevy738fd0f32011-07-30 20:52:36 -0400614static inline void set_pnfs_layoutdriver(struct nfs_server *s,
Trond Myklebusta00ed252011-07-31 16:39:04 -0400615 const struct nfs_fh *mntfh, u32 id)
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400616{
617}
618
619static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
620{
621}
622
Fred Isamana861a1e2011-03-23 13:27:51 +0000623static inline int
Fred Isamanea2cf222012-04-20 14:47:53 -0400624pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
625 struct nfs_commit_info *cinfo)
Fred Isamana861a1e2011-03-23 13:27:51 +0000626{
627 return PNFS_NOT_ATTEMPTED;
628}
629
Fred Isamanea2cf222012-04-20 14:47:53 -0400630static inline struct pnfs_ds_commit_info *
631pnfs_get_ds_info(struct inode *inode)
632{
633 return NULL;
634}
635
Trond Myklebust8dd37752012-03-15 17:16:40 -0400636static inline bool
Fred Isamanea2cf222012-04-20 14:47:53 -0400637pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
Weston Andros Adamsonb57ff132014-09-05 18:20:21 -0400638 struct nfs_commit_info *cinfo, u32 ds_commit_idx)
Fred Isamana861a1e2011-03-23 13:27:51 +0000639{
Trond Myklebust8dd37752012-03-15 17:16:40 -0400640 return false;
Fred Isamana861a1e2011-03-23 13:27:51 +0000641}
642
Trond Myklebust8dd37752012-03-15 17:16:40 -0400643static inline bool
Fred Isamanea2cf222012-04-20 14:47:53 -0400644pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
Fred Isamana861a1e2011-03-23 13:27:51 +0000645{
Trond Myklebust8dd37752012-03-15 17:16:40 -0400646 return false;
Fred Isamand6d6dc72012-03-08 17:29:35 -0500647}
648
649static inline int
Fred Isamanea2cf222012-04-20 14:47:53 -0400650pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
651 int max)
Fred Isamand6d6dc72012-03-08 17:29:35 -0500652{
653 return 0;
Fred Isamana861a1e2011-03-23 13:27:51 +0000654}
655
Weston Andros Adamson02d14262014-07-17 20:42:17 -0400656static inline struct nfs_page *
657pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
658 struct page *page)
659{
660 return NULL;
661}
662
Andy Adamsonef311532011-03-12 02:58:10 -0500663static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
Andy Adamson863a3c62011-03-23 13:27:54 +0000664{
665 return 0;
666}
Benny Halevy1775bc32011-05-20 13:47:33 +0200667
Andy Adamson82be4172012-05-23 05:02:35 -0400668static inline bool
669pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
670 struct nfs_server *nfss)
671{
672 return false;
673}
674
Trond Myklebustd8c951c2014-01-13 12:08:11 -0500675static inline bool
676pnfs_layoutcommit_outstanding(struct inode *inode)
677{
678 return false;
679}
680
681
Andy Adamson82be4172012-05-23 05:02:35 -0400682static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
683{
684 return NULL;
685}
686
Peng Tao5f01d952014-05-30 18:15:59 +0800687static inline void nfs4_pnfs_v3_ds_connect_unload(void)
688{
689}
690
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400691#endif /* CONFIG_NFS_V4_1 */
692
Peng Tao865a7ec2015-06-25 18:19:32 +0800693#if IS_ENABLED(CONFIG_NFS_V4_2)
694int pnfs_report_layoutstat(struct inode *inode);
695#else
696static inline int
697pnfs_report_layoutstat(struct inode *inode)
698{
699 return 0;
700}
701#endif
702
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400703#endif /* FS_NFS_PNFS_H */