pnfs.h 9.7 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 34
#include <linux/nfs_page.h>

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

40
struct pnfs_layout_segment {
41 42
	struct list_head pls_list;
	struct pnfs_layout_range pls_range;
43 44
	atomic_t pls_refcount;
	unsigned long pls_flags;
45
	struct pnfs_layout_hdr *pls_layout;
A
Andy Adamson 已提交
46 47
	struct rpc_cred	*pls_lc_cred; /* LAYOUTCOMMIT credential */
	loff_t pls_end_pos; /* LAYOUTCOMMIT write end */
48 49
};

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

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

#define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"

59 60 61
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 已提交
62
	NFS_LAYOUT_BULK_RECALL,		/* bulk recall affecting layout */
F
Fred Isaman 已提交
63
	NFS_LAYOUT_ROC,			/* some lseg had roc bit set */
64
	NFS_LAYOUT_DESTROYED,		/* no new use of layout allowed */
65 66
};

R
Ricardo Labiaga 已提交
67 68
/* Per-layout driver specific registration structure */
struct pnfs_layoutdriver_type {
69 70 71 72
	struct list_head pnfs_tblid;
	const u32 id;
	const char *name;
	struct module *owner;
73
	struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
74
	void (*free_lseg) (struct pnfs_layout_segment *lseg);
75 76 77

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

79 80 81 82 83 84 85
	/* 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 已提交
86 87 88 89 90
	/*
	 * 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);
91
	enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);
R
Ricardo Labiaga 已提交
92 93
};

94
struct pnfs_layout_hdr {
95
	atomic_t		plh_refcount;
96
	struct list_head	plh_layouts;   /* other client layouts */
F
Fred Isaman 已提交
97
	struct list_head	plh_bulk_recall; /* clnt list of bulk recalls */
98 99
	struct list_head	plh_segs;      /* layout segments list */
	nfs4_stateid		plh_stateid;
100
	atomic_t		plh_outstanding; /* number of RPCs out */
F
Fred Isaman 已提交
101
	unsigned long		plh_block_lgets; /* block LAYOUTGET if >0 */
F
Fred Isaman 已提交
102
	u32			plh_barrier; /* ignore lower seqids */
103
	unsigned long		plh_flags;
104
	struct inode		*plh_inode;
105 106
};

107 108 109 110 111 112 113 114 115
struct pnfs_device {
	struct nfs4_deviceid dev_id;
	unsigned int  layout_type;
	unsigned int  mincount;
	struct page **pages;
	unsigned int  pgbase;
	unsigned int  pglen;
};

116 117 118
extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);

119 120 121 122 123 124
/* nfs4proc.c */
extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
				   struct pnfs_device *dev);
extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);

/* pnfs.c */
F
Fred Isaman 已提交
125
void get_layout_hdr(struct pnfs_layout_hdr *lo);
126
void put_lseg(struct pnfs_layout_segment *lseg);
127 128
struct pnfs_layout_segment *
pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
129
		   enum pnfs_iomode access_type, gfp_t gfp_flags);
R
Ricardo Labiaga 已提交
130 131
void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
void unset_pnfs_layoutdriver(struct nfs_server *);
132 133
enum pnfs_try_status pnfs_try_to_write_data(struct nfs_write_data *,
					     const struct rpc_call_ops *, int);
A
Andy Adamson 已提交
134 135
enum pnfs_try_status pnfs_try_to_read_data(struct nfs_read_data *,
					    const struct rpc_call_ops *);
136
void pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *);
137
void pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *);
138
int pnfs_layout_process(struct nfs4_layoutget *lgp);
F
Fred Isaman 已提交
139
void pnfs_free_lseg_list(struct list_head *tmp_list);
140
void pnfs_destroy_layout(struct nfs_inode *);
141
void pnfs_destroy_all_layouts(struct nfs_client *);
142
void put_layout_hdr(struct pnfs_layout_hdr *lo);
F
Fred Isaman 已提交
143 144 145
void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
			     const nfs4_stateid *new,
			     bool update_barrier);
146 147 148
int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
				  struct pnfs_layout_hdr *lo,
				  struct nfs4_state *open_state);
F
Fred Isaman 已提交
149 150 151
int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
				struct list_head *tmp_list,
				u32 iomode);
F
Fred Isaman 已提交
152 153 154 155
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 已提交
156
void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
157
int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
158 159 160 161 162 163 164

static inline int lo_fail_bit(u32 iomode)
{
	return iomode == IOMODE_RW ?
			 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
}

F
Fred Isaman 已提交
165 166 167 168 169 170 171 172 173 174
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;
}

175 176 177 178 179
/* 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 已提交
180

181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
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);
}

R
Ricardo Labiaga 已提交
226 227
#else  /* CONFIG_NFS_V4_1 */

228 229 230 231
static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
{
}

232 233 234 235
static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
{
}

F
Fred Isaman 已提交
236 237 238 239 240 241 242 243 244 245
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)
{
}

246 247
static inline struct pnfs_layout_segment *
pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
248
		   enum pnfs_iomode access_type, gfp_t gfp_flags)
249 250 251 252
{
	return NULL;
}

A
Andy Adamson 已提交
253 254 255 256 257 258 259
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;
}

260 261 262 263 264 265 266
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;
}

F
Fred Isaman 已提交
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
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 已提交
289 290 291 292 293 294 295 296
static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id)
{
}

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

297 298 299 300 301 302
static inline void
pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *ino)
{
	pgio->pg_test = NULL;
}

303 304 305 306 307 308
static inline void
pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *ino)
{
	pgio->pg_test = NULL;
}

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
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)
{
}

330
static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
A
Andy Adamson 已提交
331 332 333
{
	return 0;
}
R
Ricardo Labiaga 已提交
334 335 336
#endif /* CONFIG_NFS_V4_1 */

#endif /* FS_NFS_PNFS_H */