pnfs.h 12.5 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 40
};

41
struct pnfs_layout_segment {
42 43
	struct list_head pls_list;
	struct pnfs_layout_range pls_range;
44 45
	atomic_t pls_refcount;
	unsigned long pls_flags;
46
	struct pnfs_layout_hdr *pls_layout;
A
Andy Adamson 已提交
47 48
	struct rpc_cred	*pls_lc_cred; /* LAYOUTCOMMIT credential */
	loff_t pls_end_pos; /* LAYOUTCOMMIT write end */
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 71 72
enum layoutdriver_policy_flags {
	/* Should the pNFS client commit and return the layout upon a setattr */
	PNFS_LAYOUTRET_ON_SETATTR	= 1 << 0,
};

73 74
struct nfs4_deviceid_node;

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

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

86
	struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
87
	void (*free_lseg) (struct pnfs_layout_segment *lseg);
88 89

	/* test for nfs page cache coalescing */
90
	bool (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *);
A
Andy Adamson 已提交
91

92 93 94 95 96 97 98
	/* Returns true if layoutdriver wants to divert this request to
	 * driver's commit routine.
	 */
	bool (*mark_pnfs_commit)(struct pnfs_layout_segment *lseg);
	struct list_head * (*choose_commit_list) (struct nfs_page *req);
	int (*commit_pagelist)(struct inode *inode, struct list_head *mds_pages, int how);

A
Andy Adamson 已提交
99 100 101 102 103
	/*
	 * 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);
104
	enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);
105 106

	void (*free_deviceid_node) (struct nfs4_deviceid_node *);
A
Andy Adamson 已提交
107 108 109 110

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

	void (*encode_layoutcommit) (struct pnfs_layout_hdr *layoutid,
				     struct xdr_stream *xdr,
				     const struct nfs4_layoutcommit_args *args);
R
Ricardo Labiaga 已提交
115 116
};

117
struct pnfs_layout_hdr {
118
	atomic_t		plh_refcount;
119
	struct list_head	plh_layouts;   /* other client layouts */
F
Fred Isaman 已提交
120
	struct list_head	plh_bulk_recall; /* clnt list of bulk recalls */
121 122
	struct list_head	plh_segs;      /* layout segments list */
	nfs4_stateid		plh_stateid;
123
	atomic_t		plh_outstanding; /* number of RPCs out */
F
Fred Isaman 已提交
124
	unsigned long		plh_block_lgets; /* block LAYOUTGET if >0 */
F
Fred Isaman 已提交
125
	u32			plh_barrier; /* ignore lower seqids */
126
	unsigned long		plh_flags;
127
	struct inode		*plh_inode;
128 129
};

130 131 132 133 134 135 136 137 138
struct pnfs_device {
	struct nfs4_deviceid dev_id;
	unsigned int  layout_type;
	unsigned int  mincount;
	struct page **pages;
	unsigned int  pgbase;
	unsigned int  pglen;
};

139 140 141
extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);

142 143 144 145
/* nfs4proc.c */
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 已提交
146
extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
147 148

/* pnfs.c */
F
Fred Isaman 已提交
149
void get_layout_hdr(struct pnfs_layout_hdr *lo);
150
void put_lseg(struct pnfs_layout_segment *lseg);
151 152
struct pnfs_layout_segment *
pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
153 154
		   loff_t pos, u64 count, enum pnfs_iomode access_type,
		   gfp_t gfp_flags);
R
Ricardo Labiaga 已提交
155 156
void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
void unset_pnfs_layoutdriver(struct nfs_server *);
157 158
enum pnfs_try_status pnfs_try_to_write_data(struct nfs_write_data *,
					     const struct rpc_call_ops *, int);
A
Andy Adamson 已提交
159 160
enum pnfs_try_status pnfs_try_to_read_data(struct nfs_read_data *,
					    const struct rpc_call_ops *);
161
bool pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev, struct nfs_page *req);
162
int pnfs_layout_process(struct nfs4_layoutget *lgp);
F
Fred Isaman 已提交
163
void pnfs_free_lseg_list(struct list_head *tmp_list);
164
void pnfs_destroy_layout(struct nfs_inode *);
165
void pnfs_destroy_all_layouts(struct nfs_client *);
166
void put_layout_hdr(struct pnfs_layout_hdr *lo);
F
Fred Isaman 已提交
167 168 169
void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
			     const nfs4_stateid *new,
			     bool update_barrier);
170 171 172
int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
				  struct pnfs_layout_hdr *lo,
				  struct nfs4_state *open_state);
F
Fred Isaman 已提交
173 174
int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
				struct list_head *tmp_list,
175
				struct pnfs_layout_range *recall_range);
F
Fred Isaman 已提交
176 177 178 179
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 已提交
180
void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
181
int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
B
Benny Halevy 已提交
182
int _pnfs_return_layout(struct inode *);
183 184
int pnfs_ld_write_done(struct nfs_write_data *);
int pnfs_ld_read_done(struct nfs_read_data *);
185

186 187 188
/* pnfs_dev.c */
struct nfs4_deviceid_node {
	struct hlist_node		node;
189
	struct hlist_node		tmpnode;
190
	const struct pnfs_layoutdriver_type *ld;
191 192 193 194 195 196
	const struct nfs_client		*nfs_client;
	struct nfs4_deviceid		deviceid;
	atomic_t			ref;
};

void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
197 198 199
struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
struct nfs4_deviceid_node *nfs4_unhash_put_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 *);
200
void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
201
			     const struct pnfs_layoutdriver_type *,
202 203 204 205
			     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 *);
206
void nfs4_deviceid_purge_client(const struct nfs_client *);
207

208 209 210 211 212 213
static inline int lo_fail_bit(u32 iomode)
{
	return iomode == IOMODE_RW ?
			 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
}

F
Fred Isaman 已提交
214 215 216 217 218 219 220 221 222 223
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;
}

224 225 226 227 228
/* 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 已提交
229

230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
static inline void
pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
{
	if (lseg) {
		struct pnfs_layoutdriver_type *ld;

		ld = NFS_SERVER(req->wb_page->mapping->host)->pnfs_curr_ld;
		if (ld->mark_pnfs_commit && ld->mark_pnfs_commit(lseg)) {
			set_bit(PG_PNFS_COMMIT, &req->wb_flags);
			req->wb_commit_lseg = get_lseg(lseg);
		}
	}
}

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 *
pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
{
	struct list_head *rv;

	if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags)) {
		struct inode *inode = req->wb_commit_lseg->pls_layout->plh_inode;

		set_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags);
		rv = NFS_SERVER(inode)->pnfs_curr_ld->choose_commit_list(req);
		/* matched by ref taken when PG_PNFS_COMMIT is set */
		put_lseg(req->wb_commit_lseg);
	} else
		rv = mds;
	return rv;
}

static inline void pnfs_clear_request_commit(struct nfs_page *req)
{
	if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags))
		put_lseg(req->wb_commit_lseg);
}

B
Benny Halevy 已提交
275 276 277 278 279 280 281 282 283 284
/* 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 已提交
285 286 287 288 289 290 291 292 293 294 295
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;
}

296 297 298
static inline void pnfs_pageio_init(struct nfs_pageio_descriptor *pgio,
				    struct inode *inode)
{
299 300 301 302
	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;

	if (ld)
		pgio->pg_test = ld->pg_test;
303 304
}

R
Ricardo Labiaga 已提交
305 306
#else  /* CONFIG_NFS_V4_1 */

307 308 309 310
static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
{
}

311 312 313 314
static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
{
}

F
Fred Isaman 已提交
315 316 317 318 319 320 321 322 323 324
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)
{
}

325 326
static inline struct pnfs_layout_segment *
pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
327 328
		   loff_t pos, u64 count, enum pnfs_iomode access_type,
		   gfp_t gfp_flags)
329 330 331 332
{
	return NULL;
}

A
Andy Adamson 已提交
333 334 335 336 337 338 339
static inline enum pnfs_try_status
pnfs_try_to_read_data(struct nfs_read_data *data,
		      const struct rpc_call_ops *call_ops)
{
	return PNFS_NOT_ATTEMPTED;
}

340 341 342 343 344 345 346
static inline enum pnfs_try_status
pnfs_try_to_write_data(struct nfs_write_data *data,
		       const struct rpc_call_ops *call_ops, int how)
{
	return PNFS_NOT_ATTEMPTED;
}

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

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

F
Fred Isaman 已提交
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
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;
}

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

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

388 389
static inline void pnfs_pageio_init(struct nfs_pageio_descriptor *pgio,
				    struct inode *inode)
390 391 392
{
}

393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
static inline void
pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
{
}

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 *
pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
{
	return mds;
}

static inline void pnfs_clear_request_commit(struct nfs_page *req)
{
}

414
static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
A
Andy Adamson 已提交
415 416 417
{
	return 0;
}
418 419 420 421

static inline void nfs4_deviceid_purge_client(struct nfs_client *ncl)
{
}
R
Ricardo Labiaga 已提交
422 423 424
#endif /* CONFIG_NFS_V4_1 */

#endif /* FS_NFS_PNFS_H */