pnfs.h 6.9 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
enum {
	NFS_LSEG_VALID = 0,	/* cleared when lseg is recalled/returned */
F
Fred Isaman 已提交
35
	NFS_LSEG_ROC,		/* roc bit received from server */
36 37
};

38
struct pnfs_layout_segment {
39 40
	struct list_head pls_list;
	struct pnfs_layout_range pls_range;
41 42
	atomic_t pls_refcount;
	unsigned long pls_flags;
43
	struct pnfs_layout_hdr *pls_layout;
44 45
};

R
Ricardo Labiaga 已提交
46 47 48 49
#ifdef CONFIG_NFS_V4_1

#define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"

50 51 52
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 已提交
53
	NFS_LAYOUT_BULK_RECALL,		/* bulk recall affecting layout */
F
Fred Isaman 已提交
54
	NFS_LAYOUT_ROC,			/* some lseg had roc bit set */
55
	NFS_LAYOUT_DESTROYED,		/* no new use of layout allowed */
56 57
};

R
Ricardo Labiaga 已提交
58 59
/* Per-layout driver specific registration structure */
struct pnfs_layoutdriver_type {
60 61 62 63
	struct list_head pnfs_tblid;
	const u32 id;
	const char *name;
	struct module *owner;
64 65
	int (*set_layoutdriver) (struct nfs_server *);
	int (*clear_layoutdriver) (struct nfs_server *);
66 67
	struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr);
	void (*free_lseg) (struct pnfs_layout_segment *lseg);
R
Ricardo Labiaga 已提交
68 69
};

70
struct pnfs_layout_hdr {
71
	atomic_t		plh_refcount;
72
	struct list_head	plh_layouts;   /* other client layouts */
F
Fred Isaman 已提交
73
	struct list_head	plh_bulk_recall; /* clnt list of bulk recalls */
74 75
	struct list_head	plh_segs;      /* layout segments list */
	nfs4_stateid		plh_stateid;
76
	atomic_t		plh_outstanding; /* number of RPCs out */
F
Fred Isaman 已提交
77
	unsigned long		plh_block_lgets; /* block LAYOUTGET if >0 */
F
Fred Isaman 已提交
78
	u32			plh_barrier; /* ignore lower seqids */
79
	unsigned long		plh_flags;
80
	struct inode		*plh_inode;
81 82
};

83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 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;
	void          *area;
	unsigned int  pgbase;
	unsigned int  pglen;
};

/*
 * Device ID RCU cache. A device ID is unique per client ID and layout type.
 */
#define NFS4_DEVICE_ID_HASH_BITS	5
#define NFS4_DEVICE_ID_HASH_SIZE	(1 << NFS4_DEVICE_ID_HASH_BITS)
#define NFS4_DEVICE_ID_HASH_MASK	(NFS4_DEVICE_ID_HASH_SIZE - 1)

static inline u32
nfs4_deviceid_hash(struct nfs4_deviceid *id)
{
	unsigned char *cptr = (unsigned char *)id->data;
	unsigned int nbytes = NFS4_DEVICEID4_SIZE;
	u32 x = 0;

	while (nbytes--) {
		x *= 37;
		x += *cptr++;
	}
	return x & NFS4_DEVICE_ID_HASH_MASK;
}

struct pnfs_deviceid_node {
	struct hlist_node	de_node;
	struct nfs4_deviceid	de_id;
	atomic_t		de_ref;
};

struct pnfs_deviceid_cache {
	spinlock_t		dc_lock;
	atomic_t		dc_ref;
	void			(*dc_free_callback)(struct pnfs_deviceid_node *);
	struct hlist_head	dc_deviceids[NFS4_DEVICE_ID_HASH_SIZE];
};

extern int pnfs_alloc_init_deviceid_cache(struct nfs_client *,
			void (*free_callback)(struct pnfs_deviceid_node *));
extern void pnfs_put_deviceid_cache(struct nfs_client *);
extern struct pnfs_deviceid_node *pnfs_find_get_deviceid(
				struct pnfs_deviceid_cache *,
				struct nfs4_deviceid *);
extern struct pnfs_deviceid_node *pnfs_add_deviceid(
				struct pnfs_deviceid_cache *,
				struct pnfs_deviceid_node *);
extern void pnfs_put_deviceid(struct pnfs_deviceid_cache *c,
			      struct pnfs_deviceid_node *devid);

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 146 147
/* 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 已提交
148
void get_layout_hdr(struct pnfs_layout_hdr *lo);
149 150 151
struct pnfs_layout_segment *
pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
		   enum pnfs_iomode access_type);
R
Ricardo Labiaga 已提交
152 153
void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
void unset_pnfs_layoutdriver(struct nfs_server *);
154
int pnfs_layout_process(struct nfs4_layoutget *lgp);
F
Fred Isaman 已提交
155
void pnfs_free_lseg_list(struct list_head *tmp_list);
156
void pnfs_destroy_layout(struct nfs_inode *);
157
void pnfs_destroy_all_layouts(struct nfs_client *);
158
void put_layout_hdr(struct pnfs_layout_hdr *lo);
F
Fred Isaman 已提交
159 160 161
void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
			     const nfs4_stateid *new,
			     bool update_barrier);
162 163 164
int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
				  struct pnfs_layout_hdr *lo,
				  struct nfs4_state *open_state);
F
Fred Isaman 已提交
165 166 167
int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
				struct list_head *tmp_list,
				u32 iomode);
F
Fred Isaman 已提交
168 169 170 171
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);
172 173 174 175 176 177 178 179 180 181 182 183 184


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

/* 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 已提交
185 186 187

#else  /* CONFIG_NFS_V4_1 */

188 189 190 191
static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
{
}

192 193 194 195 196 197 198 199 200 201 202
static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
{
}

static inline struct pnfs_layout_segment *
pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
		   enum pnfs_iomode access_type)
{
	return NULL;
}

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

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

#endif /* CONFIG_NFS_V4_1 */

#endif /* FS_NFS_PNFS_H */