pnfs.h 6.8 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;
46 47
};

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

R
Ricardo Labiaga 已提交
53 54 55 56
#ifdef CONFIG_NFS_V4_1

#define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"

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

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

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

	/*
	 * 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);
R
Ricardo Labiaga 已提交
82 83
};

84
struct pnfs_layout_hdr {
85
	atomic_t		plh_refcount;
86
	struct list_head	plh_layouts;   /* other client layouts */
F
Fred Isaman 已提交
87
	struct list_head	plh_bulk_recall; /* clnt list of bulk recalls */
88 89
	struct list_head	plh_segs;      /* layout segments list */
	nfs4_stateid		plh_stateid;
90
	atomic_t		plh_outstanding; /* number of RPCs out */
F
Fred Isaman 已提交
91
	unsigned long		plh_block_lgets; /* block LAYOUTGET if >0 */
F
Fred Isaman 已提交
92
	u32			plh_barrier; /* ignore lower seqids */
93
	unsigned long		plh_flags;
94
	struct inode		*plh_inode;
95 96
};

97 98 99 100 101 102 103 104 105 106
struct pnfs_device {
	struct nfs4_deviceid dev_id;
	unsigned int  layout_type;
	unsigned int  mincount;
	struct page **pages;
	void          *area;
	unsigned int  pgbase;
	unsigned int  pglen;
};

107 108 109
extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);

110 111 112 113 114 115
/* 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 已提交
116
void get_layout_hdr(struct pnfs_layout_hdr *lo);
117
void put_lseg(struct pnfs_layout_segment *lseg);
118 119 120
struct pnfs_layout_segment *
pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
		   enum pnfs_iomode access_type);
R
Ricardo Labiaga 已提交
121 122
void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
void unset_pnfs_layoutdriver(struct nfs_server *);
A
Andy Adamson 已提交
123 124
enum pnfs_try_status pnfs_try_to_read_data(struct nfs_read_data *,
					    const struct rpc_call_ops *);
125
void pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *);
126
int pnfs_layout_process(struct nfs4_layoutget *lgp);
F
Fred Isaman 已提交
127
void pnfs_free_lseg_list(struct list_head *tmp_list);
128
void pnfs_destroy_layout(struct nfs_inode *);
129
void pnfs_destroy_all_layouts(struct nfs_client *);
130
void put_layout_hdr(struct pnfs_layout_hdr *lo);
F
Fred Isaman 已提交
131 132 133
void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
			     const nfs4_stateid *new,
			     bool update_barrier);
134 135 136
int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
				  struct pnfs_layout_hdr *lo,
				  struct nfs4_state *open_state);
F
Fred Isaman 已提交
137 138 139
int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
				struct list_head *tmp_list,
				u32 iomode);
F
Fred Isaman 已提交
140 141 142 143
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);
144 145 146 147 148 149 150 151


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

F
Fred Isaman 已提交
152 153 154 155 156 157 158 159 160 161
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;
}

162 163 164 165 166
/* 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 已提交
167 168 169

#else  /* CONFIG_NFS_V4_1 */

170 171 172 173
static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
{
}

174 175 176 177
static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
{
}

F
Fred Isaman 已提交
178 179 180 181 182 183 184 185 186 187
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)
{
}

188 189 190 191 192 193 194
static inline struct pnfs_layout_segment *
pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
		   enum pnfs_iomode access_type)
{
	return NULL;
}

A
Andy Adamson 已提交
195 196 197 198 199 200 201
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;
}

F
Fred Isaman 已提交
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
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 已提交
224 225 226 227 228 229 230 231
static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id)
{
}

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

232 233 234 235 236 237
static inline void
pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *ino)
{
	pgio->pg_test = NULL;
}

R
Ricardo Labiaga 已提交
238 239 240
#endif /* CONFIG_NFS_V4_1 */

#endif /* FS_NFS_PNFS_H */