pnfs.h 13.1 KB
Newer Older
R
Ricardo Labiaga 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
/*
 *  pNFS client data structures.
 *
 *  Copyright (c) 2002
 *  The Regents of the University of Michigan
 *  All Rights Reserved
 *
 *  Dean Hildebrand <dhildebz@umich.edu>
 *
 *  Permission is granted to use, copy, create derivative works, and
 *  redistribute this software and such derivative works for any purpose,
 *  so long as the name of the University of Michigan is not used in
 *  any advertising or publicity pertaining to the use or distribution
 *  of this software without specific, written prior authorization. If
 *  the above copyright notice or any other identification of the
 *  University of Michigan is included in any copy of any portion of
 *  this software, then the disclaimer below must also be included.
 *
 *  This software is provided as is, without representation or warranty
 *  of any kind either express or implied, including without limitation
 *  the implied warranties of merchantability, fitness for a particular
 *  purpose, or noninfringement.  The Regents of the University of
 *  Michigan shall not be liable for any damages, including special,
 *  indirect, incidental, or consequential damages, with respect to any
 *  claim arising out of or in connection with the use of the software,
 *  even if it has been or is hereafter advised of the possibility of
 *  such damages.
 */

#ifndef FS_NFS_PNFS_H
#define FS_NFS_PNFS_H

33
#include <linux/nfs_fs.h>
34 35
#include <linux/nfs_page.h>

36 37
enum {
	NFS_LSEG_VALID = 0,	/* cleared when lseg is recalled/returned */
F
Fred Isaman 已提交
38
	NFS_LSEG_ROC,		/* roc bit received from server */
39
	NFS_LSEG_LAYOUTCOMMIT,	/* layoutcommit bit set for layoutcommit */
40 41
};

42
struct pnfs_layout_segment {
43
	struct list_head pls_list;
44
	struct list_head pls_lc_list;
45
	struct pnfs_layout_range pls_range;
46 47
	atomic_t pls_refcount;
	unsigned long pls_flags;
48
	struct pnfs_layout_hdr *pls_layout;
49 50
};

A
Andy Adamson 已提交
51 52 53 54 55
enum pnfs_try_status {
	PNFS_ATTEMPTED     = 0,
	PNFS_NOT_ATTEMPTED = 1,
};

R
Ricardo Labiaga 已提交
56 57 58 59
#ifdef CONFIG_NFS_V4_1

#define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"

60 61 62
enum {
	NFS_LAYOUT_RO_FAILED = 0,	/* get ro layout failed stop trying */
	NFS_LAYOUT_RW_FAILED,		/* get rw layout failed stop trying */
F
Fred Isaman 已提交
63
	NFS_LAYOUT_BULK_RECALL,		/* bulk recall affecting layout */
F
Fred Isaman 已提交
64
	NFS_LAYOUT_ROC,			/* some lseg had roc bit set */
65
	NFS_LAYOUT_DESTROYED,		/* no new use of layout allowed */
66 67
};

B
Benny Halevy 已提交
68 69 70
enum layoutdriver_policy_flags {
	/* Should the pNFS client commit and return the layout upon a setattr */
	PNFS_LAYOUTRET_ON_SETATTR	= 1 << 0,
71
	PNFS_LAYOUTRET_ON_ERROR		= 1 << 1,
B
Benny Halevy 已提交
72 73
};

74 75
struct nfs4_deviceid_node;

R
Ricardo Labiaga 已提交
76 77
/* Per-layout driver specific registration structure */
struct pnfs_layoutdriver_type {
78 79 80 81
	struct list_head pnfs_tblid;
	const u32 id;
	const char *name;
	struct module *owner;
B
Benny Halevy 已提交
82
	unsigned flags;
83

84 85 86
	int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
	int (*clear_layoutdriver) (struct nfs_server *);

87 88 89
	struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
	void (*free_layout_hdr) (struct pnfs_layout_hdr *);

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 95
	const struct nfs_pageio_ops *pg_read_ops;
	const struct nfs_pageio_ops *pg_write_ops;
A
Andy Adamson 已提交
96

F
Fred Isaman 已提交
97 98 99 100
	struct list_head * (*choose_commit_list) (struct nfs_page *req,
					struct pnfs_layout_segment *lseg);
	struct pnfs_layout_segment *(*remove_commit_req) (struct nfs_page *req);
	int (*scan_commit_lists) (struct inode *inode, int max);
101 102
	int (*commit_pagelist)(struct inode *inode, struct list_head *mds_pages, int how);

A
Andy Adamson 已提交
103 104 105 106 107
	/*
	 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
	 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
	 */
	enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data);
108
	enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);
109 110

	void (*free_deviceid_node) (struct nfs4_deviceid_node *);
A
Andy Adamson 已提交
111 112 113 114

	void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid,
				     struct xdr_stream *xdr,
				     const struct nfs4_layoutreturn_args *args);
B
Benny Halevy 已提交
115

A
Andy Adamson 已提交
116 117
	void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);

B
Benny Halevy 已提交
118 119 120
	void (*encode_layoutcommit) (struct pnfs_layout_hdr *layoutid,
				     struct xdr_stream *xdr,
				     const struct nfs4_layoutcommit_args *args);
R
Ricardo Labiaga 已提交
121 122
};

123
struct pnfs_layout_hdr {
124
	atomic_t		plh_refcount;
125
	struct list_head	plh_layouts;   /* other client layouts */
F
Fred Isaman 已提交
126
	struct list_head	plh_bulk_recall; /* clnt list of bulk recalls */
127 128
	struct list_head	plh_segs;      /* layout segments list */
	nfs4_stateid		plh_stateid;
129
	atomic_t		plh_outstanding; /* number of RPCs out */
F
Fred Isaman 已提交
130
	unsigned long		plh_block_lgets; /* block LAYOUTGET if >0 */
F
Fred Isaman 已提交
131
	u32			plh_barrier; /* ignore lower seqids */
132
	unsigned long		plh_flags;
133
	loff_t			plh_lwb; /* last write byte for layoutcommit */
134
	struct rpc_cred		*plh_lc_cred; /* layoutcommit cred */
135
	struct inode		*plh_inode;
136 137
};

138 139 140 141 142 143 144 145 146
struct pnfs_device {
	struct nfs4_deviceid dev_id;
	unsigned int  layout_type;
	unsigned int  mincount;
	struct page **pages;
	unsigned int  pgbase;
	unsigned int  pglen;
};

A
Andy Adamson 已提交
147 148 149 150 151 152 153 154
#define NFS4_PNFS_GETDEVLIST_MAXNUM 16

struct pnfs_devicelist {
	unsigned int		eof;
	unsigned int		num_devs;
	struct nfs4_deviceid	dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
};

155 156 157
extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);

158
/* nfs4proc.c */
A
Andy Adamson 已提交
159 160 161
extern int nfs4_proc_getdevicelist(struct nfs_server *server,
				   const struct nfs_fh *fh,
				   struct pnfs_devicelist *devlist);
162 163 164
extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
				   struct pnfs_device *dev);
extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
B
Benny Halevy 已提交
165
extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
166 167

/* pnfs.c */
F
Fred Isaman 已提交
168
void get_layout_hdr(struct pnfs_layout_hdr *lo);
169
void put_lseg(struct pnfs_layout_segment *lseg);
170 171 172 173

bool pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *);
bool pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *, int);

174
void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, u32);
R
Ricardo Labiaga 已提交
175
void unset_pnfs_layoutdriver(struct nfs_server *);
176
void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
177
int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
178
void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *, struct nfs_page *);
179
int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
180
bool pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev, struct nfs_page *req);
P
Peng Tao 已提交
181
void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
182
int pnfs_layout_process(struct nfs4_layoutget *lgp);
F
Fred Isaman 已提交
183
void pnfs_free_lseg_list(struct list_head *tmp_list);
184
void pnfs_destroy_layout(struct nfs_inode *);
185
void pnfs_destroy_all_layouts(struct nfs_client *);
186
void put_layout_hdr(struct pnfs_layout_hdr *lo);
F
Fred Isaman 已提交
187 188 189
void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
			     const nfs4_stateid *new,
			     bool update_barrier);
190 191 192
int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
				  struct pnfs_layout_hdr *lo,
				  struct nfs4_state *open_state);
F
Fred Isaman 已提交
193 194
int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
				struct list_head *tmp_list,
195
				struct pnfs_layout_range *recall_range);
F
Fred Isaman 已提交
196 197 198 199
bool pnfs_roc(struct inode *ino);
void pnfs_roc_release(struct inode *ino);
void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
bool pnfs_roc_drain(struct inode *ino, u32 *barrier);
A
Andy Adamson 已提交
200
void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
A
Andy Adamson 已提交
201
void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
202
int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
B
Benny Halevy 已提交
203
int _pnfs_return_layout(struct inode *);
204
void pnfs_ld_write_done(struct nfs_write_data *);
205
void pnfs_ld_read_done(struct nfs_read_data *);
206 207 208 209 210 211
struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
					       struct nfs_open_context *ctx,
					       loff_t pos,
					       u64 count,
					       enum pnfs_iomode iomode,
					       gfp_t gfp_flags);
212

213 214 215 216 217 218 219
void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);

/* nfs4_deviceid_flags */
enum {
	NFS_DEVICEID_INVALID = 0,       /* set when MDS clientid recalled */
};

220 221 222
/* pnfs_dev.c */
struct nfs4_deviceid_node {
	struct hlist_node		node;
223
	struct hlist_node		tmpnode;
224
	const struct pnfs_layoutdriver_type *ld;
225
	const struct nfs_client		*nfs_client;
226
	unsigned long 			flags;
227 228 229 230 231
	struct nfs4_deviceid		deviceid;
	atomic_t			ref;
};

void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
232 233
struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
234
void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
235
			     const struct pnfs_layoutdriver_type *,
236 237 238 239
			     const struct nfs_client *,
			     const struct nfs4_deviceid *);
struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *);
bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
240
void nfs4_deviceid_purge_client(const struct nfs_client *);
241

242 243 244 245 246 247
static inline int lo_fail_bit(u32 iomode)
{
	return iomode == IOMODE_RW ?
			 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
}

F
Fred Isaman 已提交
248 249 250 251 252 253 254 255 256 257
static inline struct pnfs_layout_segment *
get_lseg(struct pnfs_layout_segment *lseg)
{
	if (lseg) {
		atomic_inc(&lseg->pls_refcount);
		smp_mb__after_atomic_inc();
	}
	return lseg;
}

258 259 260 261 262
/* Return true if a layout driver is being used for this mountpoint */
static inline int pnfs_enabled_sb(struct nfs_server *nfss)
{
	return nfss->pnfs_curr_ld != NULL;
}
R
Ricardo Labiaga 已提交
263

264 265 266 267 268 269 270 271 272
static inline int
pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
{
	if (!test_and_clear_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags))
		return PNFS_NOT_ATTEMPTED;
	return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how);
}

static inline struct list_head *
F
Fred Isaman 已提交
273
pnfs_choose_commit_list(struct nfs_page *req, struct pnfs_layout_segment *lseg)
274
{
F
Fred Isaman 已提交
275
	struct inode *inode = req->wb_context->dentry->d_inode;
276 277
	struct list_head *rv;

F
Fred Isaman 已提交
278 279 280 281
	if (lseg && NFS_SERVER(inode)->pnfs_curr_ld->choose_commit_list)
		rv = NFS_SERVER(inode)->pnfs_curr_ld->choose_commit_list(req, lseg);
	else
		rv = &NFS_I(inode)->commit_list;
282 283 284
	return rv;
}

F
Fred Isaman 已提交
285 286
static inline struct pnfs_layout_segment *
pnfs_clear_request_commit(struct nfs_page *req)
287
{
F
Fred Isaman 已提交
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
	struct inode *inode = req->wb_context->dentry->d_inode;

	if (NFS_SERVER(inode)->pnfs_curr_ld &&
	    NFS_SERVER(inode)->pnfs_curr_ld->remove_commit_req)
		return NFS_SERVER(inode)->pnfs_curr_ld->remove_commit_req(req);
	else
		return NULL;
}

static inline int
pnfs_scan_commit_lists(struct inode *inode, int max)
{
	if (NFS_SERVER(inode)->pnfs_curr_ld &&
	    NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists)
		return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(inode, max);
	else
		return 0;
305 306
}

B
Benny Halevy 已提交
307 308 309 310 311 312 313 314 315 316
/* Should the pNFS client commit and return the layout upon a setattr */
static inline bool
pnfs_ld_layoutret_on_setattr(struct inode *inode)
{
	if (!pnfs_enabled_sb(NFS_SERVER(inode)))
		return false;
	return NFS_SERVER(inode)->pnfs_curr_ld->flags &
		PNFS_LAYOUTRET_ON_SETATTR;
}

B
Benny Halevy 已提交
317 318 319 320 321 322 323 324 325 326 327
static inline int pnfs_return_layout(struct inode *ino)
{
	struct nfs_inode *nfsi = NFS_I(ino);
	struct nfs_server *nfss = NFS_SERVER(ino);

	if (pnfs_enabled_sb(nfss) && nfsi->layout)
		return _pnfs_return_layout(ino);

	return 0;
}

R
Ricardo Labiaga 已提交
328 329
#else  /* CONFIG_NFS_V4_1 */

330 331 332 333
static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
{
}

334 335 336 337
static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
{
}

F
Fred Isaman 已提交
338 339 340 341 342 343 344 345 346 347
static inline struct pnfs_layout_segment *
get_lseg(struct pnfs_layout_segment *lseg)
{
	return NULL;
}

static inline void put_lseg(struct pnfs_layout_segment *lseg)
{
}

B
Benny Halevy 已提交
348 349 350 351 352
static inline int pnfs_return_layout(struct inode *ino)
{
	return 0;
}

B
Benny Halevy 已提交
353 354 355 356 357 358
static inline bool
pnfs_ld_layoutret_on_setattr(struct inode *inode)
{
	return false;
}

F
Fred Isaman 已提交
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
static inline bool
pnfs_roc(struct inode *ino)
{
	return false;
}

static inline void
pnfs_roc_release(struct inode *ino)
{
}

static inline void
pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
{
}

static inline bool
pnfs_roc_drain(struct inode *ino, u32 *barrier)
{
	return false;
}

381
static inline void set_pnfs_layoutdriver(struct nfs_server *s,
382
					 const struct nfs_fh *mntfh, u32 id)
R
Ricardo Labiaga 已提交
383 384 385 386 387 388 389
{
}

static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
{
}

390
static inline bool pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *inode)
391
{
392 393 394 395 396 397
	return false;
}

static inline bool pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *inode, int ioflags)
{
	return false;
398 399
}

400 401 402 403 404 405 406
static inline int
pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
{
	return PNFS_NOT_ATTEMPTED;
}

static inline struct list_head *
F
Fred Isaman 已提交
407
pnfs_choose_commit_list(struct nfs_page *req, struct pnfs_layout_segment *lseg)
408
{
F
Fred Isaman 已提交
409 410 411
	struct inode *inode = req->wb_context->dentry->d_inode;

	return &NFS_I(inode)->commit_list;
412 413
}

F
Fred Isaman 已提交
414 415
static inline struct pnfs_layout_segment *
pnfs_clear_request_commit(struct nfs_page *req)
416
{
F
Fred Isaman 已提交
417 418 419 420 421 422 423
	return NULL;
}

static inline int
pnfs_scan_commit_lists(struct inode *inode, int max)
{
	return 0;
424 425
}

426
static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
A
Andy Adamson 已提交
427 428 429
{
	return 0;
}
430

R
Ricardo Labiaga 已提交
431 432 433
#endif /* CONFIG_NFS_V4_1 */

#endif /* FS_NFS_PNFS_H */