pnfs.h 15.3 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
	NFS_LAYOUT_INVALID,		/* layout is being destroyed */
67 68
};

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

75 76
struct nfs4_deviceid_node;

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

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

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

91
	struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
92
	void (*free_lseg) (struct pnfs_layout_segment *lseg);
93 94

	/* test for nfs page cache coalescing */
95 96
	const struct nfs_pageio_ops *pg_read_ops;
	const struct nfs_pageio_ops *pg_write_ops;
A
Andy Adamson 已提交
97

F
Fred Isaman 已提交
98
	struct pnfs_ds_commit_info *(*get_ds_info) (struct inode *inode);
99
	void (*mark_request_commit) (struct nfs_page *req,
F
Fred Isaman 已提交
100 101 102 103 104 105
				     struct pnfs_layout_segment *lseg,
				     struct nfs_commit_info *cinfo);
	void (*clear_request_commit) (struct nfs_page *req,
				      struct nfs_commit_info *cinfo);
	int (*scan_commit_lists) (struct nfs_commit_info *cinfo,
				  int max);
106 107
	void (*recover_commit_reqs) (struct list_head *list,
				     struct nfs_commit_info *cinfo);
F
Fred Isaman 已提交
108 109 110 111
	int (*commit_pagelist)(struct inode *inode,
			       struct list_head *mds_pages,
			       int how,
			       struct nfs_commit_info *cinfo);
112

A
Andy Adamson 已提交
113 114 115 116 117
	/*
	 * 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);
118
	enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);
119 120

	void (*free_deviceid_node) (struct nfs4_deviceid_node *);
A
Andy Adamson 已提交
121 122 123 124

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

A
Andy Adamson 已提交
126 127
	void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);

B
Benny Halevy 已提交
128 129 130
	void (*encode_layoutcommit) (struct pnfs_layout_hdr *layoutid,
				     struct xdr_stream *xdr,
				     const struct nfs4_layoutcommit_args *args);
R
Ricardo Labiaga 已提交
131 132
};

133
struct pnfs_layout_hdr {
134
	atomic_t		plh_refcount;
135
	struct list_head	plh_layouts;   /* other client layouts */
F
Fred Isaman 已提交
136
	struct list_head	plh_bulk_recall; /* clnt list of bulk recalls */
137 138
	struct list_head	plh_segs;      /* layout segments list */
	nfs4_stateid		plh_stateid;
139
	atomic_t		plh_outstanding; /* number of RPCs out */
F
Fred Isaman 已提交
140
	unsigned long		plh_block_lgets; /* block LAYOUTGET if >0 */
F
Fred Isaman 已提交
141
	u32			plh_barrier; /* ignore lower seqids */
142
	unsigned long		plh_flags;
143
	loff_t			plh_lwb; /* last write byte for layoutcommit */
144
	struct rpc_cred		*plh_lc_cred; /* layoutcommit cred */
145
	struct inode		*plh_inode;
146 147
};

148 149 150 151 152 153 154 155 156
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 已提交
157 158 159 160 161 162 163 164
#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];
};

165 166 167
extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);

168
/* nfs4proc.c */
A
Andy Adamson 已提交
169 170 171
extern int nfs4_proc_getdevicelist(struct nfs_server *server,
				   const struct nfs_fh *fh,
				   struct pnfs_devicelist *devlist);
172 173 174
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 已提交
175
extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
176 177

/* pnfs.c */
F
Fred Isaman 已提交
178
void get_layout_hdr(struct pnfs_layout_hdr *lo);
179
void 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);
R
Ricardo Labiaga 已提交
187
void unset_pnfs_layoutdriver(struct nfs_server *);
188
void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
189
int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
190
void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *, struct nfs_page *);
191
int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
192
bool pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev, struct nfs_page *req);
P
Peng Tao 已提交
193
void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
194
int pnfs_layout_process(struct nfs4_layoutget *lgp);
F
Fred Isaman 已提交
195
void pnfs_free_lseg_list(struct list_head *tmp_list);
196
void pnfs_destroy_layout(struct nfs_inode *);
197
void pnfs_destroy_all_layouts(struct nfs_client *);
198
void put_layout_hdr(struct pnfs_layout_hdr *lo);
F
Fred Isaman 已提交
199 200 201
void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
			     const nfs4_stateid *new,
			     bool update_barrier);
202 203 204
int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
				  struct pnfs_layout_hdr *lo,
				  struct nfs4_state *open_state);
F
Fred Isaman 已提交
205 206
int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
				struct list_head *tmp_list,
207
				struct pnfs_layout_range *recall_range);
F
Fred Isaman 已提交
208 209 210 211
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 已提交
212
void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
A
Andy Adamson 已提交
213
void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
214
int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
B
Benny Halevy 已提交
215
int _pnfs_return_layout(struct inode *);
216
void pnfs_ld_write_done(struct nfs_write_data *);
217
void pnfs_ld_read_done(struct nfs_read_data *);
218 219 220 221 222 223
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);
224

225
void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
226 227 228 229
int pnfs_read_done_resend_to_mds(struct inode *inode, struct list_head *head,
			const struct nfs_pgio_completion_ops *compl_ops);
int pnfs_write_done_resend_to_mds(struct inode *inode, struct list_head *head,
			const struct nfs_pgio_completion_ops *compl_ops);
230
struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
231 232 233 234 235 236

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

237 238 239
/* pnfs_dev.c */
struct nfs4_deviceid_node {
	struct hlist_node		node;
240
	struct hlist_node		tmpnode;
241
	const struct pnfs_layoutdriver_type *ld;
242
	const struct nfs_client		*nfs_client;
243
	unsigned long 			flags;
244 245 246 247
	struct nfs4_deviceid		deviceid;
	atomic_t			ref;
};

248 249
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 *);
250
void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
251
			     const struct pnfs_layoutdriver_type *,
252 253 254 255
			     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 *);
256
void nfs4_deviceid_purge_client(const struct nfs_client *);
257

258 259 260 261 262 263
static inline int lo_fail_bit(u32 iomode)
{
	return iomode == IOMODE_RW ?
			 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
}

F
Fred Isaman 已提交
264 265 266 267 268 269 270 271 272 273
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;
}

274 275 276 277 278
/* 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 已提交
279

280
static inline int
F
Fred Isaman 已提交
281 282
pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
		 struct nfs_commit_info *cinfo)
283
{
F
Fred Isaman 已提交
284
	if (cinfo->ds == NULL || cinfo->ds->ncommitting == 0)
285
		return PNFS_NOT_ATTEMPTED;
F
Fred Isaman 已提交
286 287 288 289 290 291 292 293 294 295 296
	return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
}

static inline struct pnfs_ds_commit_info *
pnfs_get_ds_info(struct inode *inode)
{
	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;

	if (ld == NULL || ld->get_ds_info == NULL)
		return NULL;
	return ld->get_ds_info(inode);
297 298
}

299
static inline bool
F
Fred Isaman 已提交
300 301
pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
			 struct nfs_commit_info *cinfo)
302
{
F
Fred Isaman 已提交
303
	struct inode *inode = req->wb_context->dentry->d_inode;
304
	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
305

306 307
	if (lseg == NULL || ld->mark_request_commit == NULL)
		return false;
F
Fred Isaman 已提交
308
	ld->mark_request_commit(req, lseg, cinfo);
309
	return true;
310 311
}

312
static inline bool
F
Fred Isaman 已提交
313
pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
314
{
F
Fred Isaman 已提交
315
	struct inode *inode = req->wb_context->dentry->d_inode;
316
	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
F
Fred Isaman 已提交
317

318 319
	if (ld == NULL || ld->clear_request_commit == NULL)
		return false;
F
Fred Isaman 已提交
320
	ld->clear_request_commit(req, cinfo);
321
	return true;
F
Fred Isaman 已提交
322 323 324
}

static inline int
F
Fred Isaman 已提交
325 326
pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
		       int max)
F
Fred Isaman 已提交
327
{
F
Fred Isaman 已提交
328
	if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
F
Fred Isaman 已提交
329
		return 0;
F
Fred Isaman 已提交
330 331
	else
		return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
332 333
}

334 335 336 337 338 339 340 341 342
static inline void
pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
			 struct nfs_commit_info *cinfo)
{
	if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
		return;
	NFS_SERVER(inode)->pnfs_curr_ld->recover_commit_reqs(list, cinfo);
}

B
Benny Halevy 已提交
343 344 345 346 347 348 349 350 351 352
/* 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 已提交
353 354 355 356 357 358 359 360 361 362 363
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;
}

364 365 366 367
static inline bool
pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
		   struct nfs_server *nfss)
{
368
	return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
369 370 371
					nfss->pnfs_curr_ld->id == src->l_type);
}

372 373 374 375 376 377 378
#ifdef NFS_DEBUG
void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
#else
static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
{
}
#endif /* NFS_DEBUG */
R
Ricardo Labiaga 已提交
379 380
#else  /* CONFIG_NFS_V4_1 */

381 382 383 384
static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
{
}

385 386 387 388
static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
{
}

F
Fred Isaman 已提交
389 390 391 392 393 394 395 396 397 398
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 已提交
399 400 401 402 403
static inline int pnfs_return_layout(struct inode *ino)
{
	return 0;
}

B
Benny Halevy 已提交
404 405 406 407 408 409
static inline bool
pnfs_ld_layoutret_on_setattr(struct inode *inode)
{
	return false;
}

F
Fred Isaman 已提交
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
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;
}

432
static inline void set_pnfs_layoutdriver(struct nfs_server *s,
433
					 const struct nfs_fh *mntfh, u32 id)
R
Ricardo Labiaga 已提交
434 435 436 437 438 439 440
{
}

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

441
static inline void pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *inode,
442
					 const struct nfs_pgio_completion_ops *compl_ops)
443
{
444
	nfs_pageio_init_read(pgio, inode, compl_ops);
445 446
}

447
static inline void pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *inode, int ioflags,
448
					  const struct nfs_pgio_completion_ops *compl_ops)
449
{
450
	nfs_pageio_init_write(pgio, inode, ioflags, compl_ops);
451 452
}

453
static inline int
F
Fred Isaman 已提交
454 455
pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
		 struct nfs_commit_info *cinfo)
456 457 458 459
{
	return PNFS_NOT_ATTEMPTED;
}

F
Fred Isaman 已提交
460 461 462 463 464 465
static inline struct pnfs_ds_commit_info *
pnfs_get_ds_info(struct inode *inode)
{
	return NULL;
}

466
static inline bool
F
Fred Isaman 已提交
467 468
pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
			 struct nfs_commit_info *cinfo)
469
{
470
	return false;
471 472
}

473
static inline bool
F
Fred Isaman 已提交
474
pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
475
{
476
	return false;
F
Fred Isaman 已提交
477 478 479
}

static inline int
F
Fred Isaman 已提交
480 481
pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
		       int max)
F
Fred Isaman 已提交
482 483
{
	return 0;
484 485
}

486 487 488 489 490 491
static inline void
pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
			 struct nfs_commit_info *cinfo)
{
}

492
static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
A
Andy Adamson 已提交
493 494 495
{
	return 0;
}
496

497 498 499 500 501 502 503 504 505 506 507 508
static inline bool
pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
		   struct nfs_server *nfss)
{
	return false;
}

static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
{
	return NULL;
}

R
Ricardo Labiaga 已提交
509 510 511
#endif /* CONFIG_NFS_V4_1 */

#endif /* FS_NFS_PNFS_H */