nfs4_fs.h 10.3 KB
Newer Older
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 33 34 35 36 37 38 39 40
/*
 * linux/fs/nfs/nfs4_fs.h
 *
 * Copyright (C) 2005 Trond Myklebust
 *
 * NFSv4-specific filesystem definitions and declarations
 */

#ifndef __LINUX_FS_NFS_NFS4_FS_H
#define __LINUX_FS_NFS_NFS4_FS_H

#ifdef CONFIG_NFS_V4

struct idmap;

/*
 * In a seqid-mutating op, this macro controls which error return
 * values trigger incrementation of the seqid.
 *
 * from rfc 3010:
 * The client MUST monotonically increment the sequence number for the
 * CLOSE, LOCK, LOCKU, OPEN, OPEN_CONFIRM, and OPEN_DOWNGRADE
 * operations.  This is true even in the event that the previous
 * operation that used the sequence number received an error.  The only
 * exception to this rule is if the previous operation received one of
 * the following errors: NFSERR_STALE_CLIENTID, NFSERR_STALE_STATEID,
 * NFSERR_BAD_STATEID, NFSERR_BAD_SEQID, NFSERR_BADXDR,
 * NFSERR_RESOURCE, NFSERR_NOFILEHANDLE.
 *
 */
#define seqid_mutating_err(err)       \
(((err) != NFSERR_STALE_CLIENTID) &&  \
 ((err) != NFSERR_STALE_STATEID)  &&  \
 ((err) != NFSERR_BAD_STATEID)    &&  \
 ((err) != NFSERR_BAD_SEQID)      &&  \
 ((err) != NFSERR_BAD_XDR)        &&  \
 ((err) != NFSERR_RESOURCE)       &&  \
 ((err) != NFSERR_NOFILEHANDLE))

enum nfs4_client_state {
41
	NFS4CLNT_MANAGER_RUNNING  = 0,
42
	NFS4CLNT_CHECK_LEASE,
43
	NFS4CLNT_LEASE_EXPIRED,
44 45
	NFS4CLNT_RECLAIM_REBOOT,
	NFS4CLNT_RECLAIM_NOGRACE,
46
	NFS4CLNT_DELEGRETURN,
47
	NFS4CLNT_SESSION_SETUP,
48 49
};

50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
/*
 * struct rpc_sequence ensures that RPC calls are sent in the exact
 * order that they appear on the list.
 */
struct rpc_sequence {
	struct rpc_wait_queue	wait;	/* RPC call delay queue */
	spinlock_t lock;		/* Protects the list */
	struct list_head list;		/* Defines sequence of RPC calls */
};

#define NFS_SEQID_CONFIRMED 1
struct nfs_seqid_counter {
	struct rpc_sequence *sequence;
	int flags;
	u32 counter;
};

struct nfs_seqid {
	struct nfs_seqid_counter *sequence;
69
	struct list_head list;
70 71 72 73 74 75 76 77
};

static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
{
	if (seqid_mutating_err(-status))
		seqid->flags |= NFS_SEQID_CONFIRMED;
}

78 79 80 81 82
struct nfs_unique_id {
	struct rb_node rb_node;
	__u64 id;
};

83 84 85 86 87 88
/*
 * NFS4 state_owners and lock_owners are simply labels for ordered
 * sequences of RPC calls. Their sole purpose is to provide once-only
 * semantics by allowing the server to identify replayed requests.
 */
struct nfs4_state_owner {
89
	struct nfs_unique_id so_owner_id;
90
	struct nfs_client    *so_client;
91
	struct nfs_server    *so_server;
92
	struct rb_node	     so_client_node;
93 94

	struct rpc_cred	     *so_cred;	 /* Associated cred */
95 96 97

	spinlock_t	     so_lock;
	atomic_t	     so_count;
98
	unsigned long	     so_flags;
99 100
	struct list_head     so_states;
	struct list_head     so_delegations;
101 102
	struct nfs_seqid_counter so_seqid;
	struct rpc_sequence  so_sequence;
103 104
};

105 106 107 108 109
enum {
	NFS_OWNER_RECLAIM_REBOOT,
	NFS_OWNER_RECLAIM_NOGRACE
};

110 111 112 113 114 115 116 117 118 119 120 121 122 123
/*
 * struct nfs4_state maintains the client-side state for a given
 * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
 *
 * OPEN:
 * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
 * we need to know how many files are open for reading or writing on a
 * given inode. This information too is stored here.
 *
 * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
 */

struct nfs4_lock_state {
	struct list_head	ls_locks;	/* Other lock stateids */
124
	struct nfs4_state *	ls_state;	/* Pointer to open state */
125 126 127
	fl_owner_t		ls_owner;	/* POSIX lock owner */
#define NFS_LOCK_INITIALIZED 1
	int			ls_flags;
128
	struct nfs_seqid_counter	ls_seqid;
129
	struct rpc_sequence	ls_sequence;
130
	struct nfs_unique_id	ls_id;
131 132 133 134 135 136 137
	nfs4_stateid		ls_stateid;
	atomic_t		ls_count;
};

/* bits for nfs4_state->flags */
enum {
	LK_STATE_IN_USE,
138 139 140 141
	NFS_DELEGATED_STATE,		/* Current stateid is delegation */
	NFS_O_RDONLY_STATE,		/* OPEN stateid has read-only state */
	NFS_O_WRONLY_STATE,		/* OPEN stateid has write-only state */
	NFS_O_RDWR_STATE,		/* OPEN stateid has read/write state */
142 143
	NFS_STATE_RECLAIM_REBOOT,	/* OPEN stateid server rebooted */
	NFS_STATE_RECLAIM_NOGRACE,	/* OPEN stateid needs to recover state */
144 145 146 147 148 149 150 151 152 153 154
};

struct nfs4_state {
	struct list_head open_states;	/* List of states for the same state_owner */
	struct list_head inode_states;	/* List of states for the same inode */
	struct list_head lock_states;	/* List of subservient lock stateids */

	struct nfs4_state_owner *owner;	/* Pointer to the open owner */
	struct inode *inode;		/* Pointer to the inode */

	unsigned long flags;		/* Do we hold any locks? */
155
	spinlock_t state_lock;		/* Protects the lock_states list */
156

157
	seqlock_t seqlock;		/* Protects the stateid/open_stateid */
158 159
	nfs4_stateid stateid;		/* Current stateid: may be delegation */
	nfs4_stateid open_stateid;	/* OPEN stateid */
160

161
	/* The following 3 fields are protected by owner->so_lock */
162 163 164
	unsigned int n_rdonly;		/* Number of read-only references */
	unsigned int n_wronly;		/* Number of write-only references */
	unsigned int n_rdwr;		/* Number of read/write references */
165
	fmode_t state;			/* State on the server (R,W, or RW) */
166 167 168 169 170 171 172
	atomic_t count;
};


struct nfs4_exception {
	long timeout;
	int retry;
173
	struct nfs4_state *state;
174 175 176
};

struct nfs4_state_recovery_ops {
177
	int owner_flag_bit;
178
	int state_flag_bit;
179 180
	int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
	int (*recover_lock)(struct nfs4_state *, struct file_lock *);
181
	int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
182
	struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
183 184
};

B
Benny Halevy 已提交
185 186
struct nfs4_state_maintenance_ops {
	int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *);
187
	struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
188
	int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
B
Benny Halevy 已提交
189 190
};

A
Al Viro 已提交
191
extern const struct dentry_operations nfs4_dentry_operations;
192
extern const struct inode_operations nfs4_dir_inode_operations;
193 194 195 196 197 198

/* inode.c */
extern ssize_t nfs4_getxattr(struct dentry *, const char *, void *, size_t);
extern int nfs4_setxattr(struct dentry *, const char *, const void *, size_t, int);
extern ssize_t nfs4_listxattr(struct dentry *, char *, size_t);

199 200

/* nfs4proc.c */
201 202 203 204
extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *);
extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct rpc_cred *);
extern int nfs4_proc_async_renew(struct nfs_client *, struct rpc_cred *);
extern int nfs4_proc_renew(struct nfs_client *, struct rpc_cred *);
205
extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
206
extern int nfs4_do_close(struct path *path, struct nfs4_state *state, int wait);
207 208
extern struct dentry *nfs4_atomic_open(struct inode *, struct dentry *, struct nameidata *);
extern int nfs4_open_revalidate(struct inode *, struct dentry *, int, struct nameidata *);
209
extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
210
extern int nfs4_proc_fs_locations(struct inode *dir, const struct qstr *name,
211
		struct nfs4_fs_locations *fs_locations, struct page *page);
212

213 214
extern struct nfs4_state_recovery_ops *nfs4_reboot_recovery_ops[];
extern struct nfs4_state_recovery_ops *nfs4_nograce_recovery_ops[];
215
#if defined(CONFIG_NFS_V4_1)
A
Andy Adamson 已提交
216 217 218
extern int nfs4_setup_sequence(struct nfs_client *clp,
		struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
		int cache_reply, struct rpc_task *task);
219 220
extern void nfs4_destroy_session(struct nfs4_session *session);
extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
221
extern int nfs4_proc_create_session(struct nfs_client *, int reset);
222
extern int nfs4_proc_destroy_session(struct nfs4_session *);
A
Andy Adamson 已提交
223 224 225 226 227 228 229
#else /* CONFIG_NFS_v4_1 */
static inline int nfs4_setup_sequence(struct nfs_client *clp,
		struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
		int cache_reply, struct rpc_task *task)
{
	return 0;
}
230
#endif /* CONFIG_NFS_V4_1 */
231

B
Benny Halevy 已提交
232 233
extern struct nfs4_state_maintenance_ops *nfs4_state_renewal_ops[];

234 235 236 237
extern const u32 nfs4_fattr_bitmap[2];
extern const u32 nfs4_statfs_bitmap[2];
extern const u32 nfs4_pathconf_bitmap[2];
extern const u32 nfs4_fsinfo_bitmap[2];
238
extern const u32 nfs4_fs_locations_bitmap[2];
239 240

/* nfs4renewd.c */
241
extern void nfs4_schedule_state_renewal(struct nfs_client *);
242
extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
243
extern void nfs4_kill_renewd(struct nfs_client *);
244
extern void nfs4_renew_state(struct work_struct *);
245 246

/* nfs4state.c */
247
struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
248
struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
249 250
#if defined(CONFIG_NFS_V4_1)
struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
251
struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
252
#endif /* CONFIG_NFS_V4_1 */
253 254 255 256 257

extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *);
extern void nfs4_put_state_owner(struct nfs4_state_owner *);
extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
extern void nfs4_put_open_state(struct nfs4_state *);
258 259 260
extern void nfs4_close_state(struct path *, struct nfs4_state *, fmode_t);
extern void nfs4_close_sync(struct path *, struct nfs4_state *, fmode_t);
extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
261
extern void nfs4_schedule_state_recovery(struct nfs_client *);
262
extern void nfs4_schedule_state_manager(struct nfs_client *);
263
extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *clp, struct nfs4_state *state);
264
extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
265
extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
266 267
extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t);

268 269 270 271 272 273
extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter);
extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
extern void nfs_free_seqid(struct nfs_seqid *seqid);

274 275 276
extern const nfs4_stateid zero_stateid;

/* nfs4xdr.c */
277
extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
278 279 280 281 282 283 284 285 286
extern struct rpc_procinfo nfs4_procedures[];

struct nfs4_mount_data;

/* callback_xdr.c */
extern struct svc_version nfs4_callback_version1;

#else

287
#define nfs4_close_state(a, b, c) do { } while (0)
288
#define nfs4_close_sync(a, b, c) do { } while (0)
289 290 291

#endif /* CONFIG_NFS_V4 */
#endif /* __LINUX_FS_NFS_NFS4_FS.H */