xref: /openbmc/linux/fs/nfs/nfs4_fs.h (revision 22246614)
1 /*
2  * linux/fs/nfs/nfs4_fs.h
3  *
4  * Copyright (C) 2005 Trond Myklebust
5  *
6  * NFSv4-specific filesystem definitions and declarations
7  */
8 
9 #ifndef __LINUX_FS_NFS_NFS4_FS_H
10 #define __LINUX_FS_NFS_NFS4_FS_H
11 
12 #ifdef CONFIG_NFS_V4
13 
14 struct idmap;
15 
16 /*
17  * In a seqid-mutating op, this macro controls which error return
18  * values trigger incrementation of the seqid.
19  *
20  * from rfc 3010:
21  * The client MUST monotonically increment the sequence number for the
22  * CLOSE, LOCK, LOCKU, OPEN, OPEN_CONFIRM, and OPEN_DOWNGRADE
23  * operations.  This is true even in the event that the previous
24  * operation that used the sequence number received an error.  The only
25  * exception to this rule is if the previous operation received one of
26  * the following errors: NFSERR_STALE_CLIENTID, NFSERR_STALE_STATEID,
27  * NFSERR_BAD_STATEID, NFSERR_BAD_SEQID, NFSERR_BADXDR,
28  * NFSERR_RESOURCE, NFSERR_NOFILEHANDLE.
29  *
30  */
31 #define seqid_mutating_err(err)       \
32 (((err) != NFSERR_STALE_CLIENTID) &&  \
33  ((err) != NFSERR_STALE_STATEID)  &&  \
34  ((err) != NFSERR_BAD_STATEID)    &&  \
35  ((err) != NFSERR_BAD_SEQID)      &&  \
36  ((err) != NFSERR_BAD_XDR)        &&  \
37  ((err) != NFSERR_RESOURCE)       &&  \
38  ((err) != NFSERR_NOFILEHANDLE))
39 
40 enum nfs4_client_state {
41 	NFS4CLNT_STATE_RECOVER  = 0,
42 	NFS4CLNT_LEASE_EXPIRED,
43 };
44 
45 /*
46  * struct rpc_sequence ensures that RPC calls are sent in the exact
47  * order that they appear on the list.
48  */
49 struct rpc_sequence {
50 	struct rpc_wait_queue	wait;	/* RPC call delay queue */
51 	spinlock_t lock;		/* Protects the list */
52 	struct list_head list;		/* Defines sequence of RPC calls */
53 };
54 
55 #define NFS_SEQID_CONFIRMED 1
56 struct nfs_seqid_counter {
57 	struct rpc_sequence *sequence;
58 	int flags;
59 	u32 counter;
60 };
61 
62 struct nfs_seqid {
63 	struct nfs_seqid_counter *sequence;
64 	struct list_head list;
65 };
66 
67 static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
68 {
69 	if (seqid_mutating_err(-status))
70 		seqid->flags |= NFS_SEQID_CONFIRMED;
71 }
72 
73 struct nfs_unique_id {
74 	struct rb_node rb_node;
75 	__u64 id;
76 };
77 
78 /*
79  * NFS4 state_owners and lock_owners are simply labels for ordered
80  * sequences of RPC calls. Their sole purpose is to provide once-only
81  * semantics by allowing the server to identify replayed requests.
82  */
83 struct nfs4_state_owner {
84 	struct nfs_unique_id so_owner_id;
85 	struct nfs_client    *so_client;
86 	struct nfs_server    *so_server;
87 	struct rb_node	     so_client_node;
88 
89 	struct rpc_cred	     *so_cred;	 /* Associated cred */
90 
91 	spinlock_t	     so_lock;
92 	atomic_t	     so_count;
93 	struct list_head     so_states;
94 	struct list_head     so_delegations;
95 	struct nfs_seqid_counter so_seqid;
96 	struct rpc_sequence  so_sequence;
97 };
98 
99 /*
100  * struct nfs4_state maintains the client-side state for a given
101  * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
102  *
103  * OPEN:
104  * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
105  * we need to know how many files are open for reading or writing on a
106  * given inode. This information too is stored here.
107  *
108  * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
109  */
110 
111 struct nfs4_lock_state {
112 	struct list_head	ls_locks;	/* Other lock stateids */
113 	struct nfs4_state *	ls_state;	/* Pointer to open state */
114 	fl_owner_t		ls_owner;	/* POSIX lock owner */
115 #define NFS_LOCK_INITIALIZED 1
116 	int			ls_flags;
117 	struct nfs_seqid_counter	ls_seqid;
118 	struct rpc_sequence	ls_sequence;
119 	struct nfs_unique_id	ls_id;
120 	nfs4_stateid		ls_stateid;
121 	atomic_t		ls_count;
122 };
123 
124 /* bits for nfs4_state->flags */
125 enum {
126 	LK_STATE_IN_USE,
127 	NFS_DELEGATED_STATE,		/* Current stateid is delegation */
128 	NFS_O_RDONLY_STATE,		/* OPEN stateid has read-only state */
129 	NFS_O_WRONLY_STATE,		/* OPEN stateid has write-only state */
130 	NFS_O_RDWR_STATE,		/* OPEN stateid has read/write state */
131 };
132 
133 struct nfs4_state {
134 	struct list_head open_states;	/* List of states for the same state_owner */
135 	struct list_head inode_states;	/* List of states for the same inode */
136 	struct list_head lock_states;	/* List of subservient lock stateids */
137 
138 	struct nfs4_state_owner *owner;	/* Pointer to the open owner */
139 	struct inode *inode;		/* Pointer to the inode */
140 
141 	unsigned long flags;		/* Do we hold any locks? */
142 	spinlock_t state_lock;		/* Protects the lock_states list */
143 
144 	seqlock_t seqlock;		/* Protects the stateid/open_stateid */
145 	nfs4_stateid stateid;		/* Current stateid: may be delegation */
146 	nfs4_stateid open_stateid;	/* OPEN stateid */
147 
148 	/* The following 3 fields are protected by owner->so_lock */
149 	unsigned int n_rdonly;		/* Number of read-only references */
150 	unsigned int n_wronly;		/* Number of write-only references */
151 	unsigned int n_rdwr;		/* Number of read/write references */
152 	int state;			/* State on the server (R,W, or RW) */
153 	atomic_t count;
154 };
155 
156 
157 struct nfs4_exception {
158 	long timeout;
159 	int retry;
160 };
161 
162 struct nfs4_state_recovery_ops {
163 	int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
164 	int (*recover_lock)(struct nfs4_state *, struct file_lock *);
165 };
166 
167 extern struct dentry_operations nfs4_dentry_operations;
168 extern const struct inode_operations nfs4_dir_inode_operations;
169 
170 /* inode.c */
171 extern ssize_t nfs4_getxattr(struct dentry *, const char *, void *, size_t);
172 extern int nfs4_setxattr(struct dentry *, const char *, const void *, size_t, int);
173 extern ssize_t nfs4_listxattr(struct dentry *, char *, size_t);
174 
175 
176 /* nfs4proc.c */
177 extern int nfs4_map_errors(int err);
178 extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *);
179 extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct rpc_cred *);
180 extern int nfs4_proc_async_renew(struct nfs_client *, struct rpc_cred *);
181 extern int nfs4_proc_renew(struct nfs_client *, struct rpc_cred *);
182 extern int nfs4_do_close(struct path *path, struct nfs4_state *state, int wait);
183 extern struct dentry *nfs4_atomic_open(struct inode *, struct dentry *, struct nameidata *);
184 extern int nfs4_open_revalidate(struct inode *, struct dentry *, int, struct nameidata *);
185 extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
186 extern int nfs4_proc_fs_locations(struct inode *dir, const struct qstr *name,
187 		struct nfs4_fs_locations *fs_locations, struct page *page);
188 
189 extern struct nfs4_state_recovery_ops nfs4_reboot_recovery_ops;
190 extern struct nfs4_state_recovery_ops nfs4_network_partition_recovery_ops;
191 
192 extern const u32 nfs4_fattr_bitmap[2];
193 extern const u32 nfs4_statfs_bitmap[2];
194 extern const u32 nfs4_pathconf_bitmap[2];
195 extern const u32 nfs4_fsinfo_bitmap[2];
196 extern const u32 nfs4_fs_locations_bitmap[2];
197 
198 /* nfs4renewd.c */
199 extern void nfs4_schedule_state_renewal(struct nfs_client *);
200 extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
201 extern void nfs4_kill_renewd(struct nfs_client *);
202 extern void nfs4_renew_state(struct work_struct *);
203 
204 /* nfs4state.c */
205 struct rpc_cred *nfs4_get_renew_cred(struct nfs_client *clp);
206 
207 extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *);
208 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
209 extern void nfs4_drop_state_owner(struct nfs4_state_owner *);
210 extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
211 extern void nfs4_put_open_state(struct nfs4_state *);
212 extern void nfs4_close_state(struct path *, struct nfs4_state *, mode_t);
213 extern void nfs4_close_sync(struct path *, struct nfs4_state *, mode_t);
214 extern void nfs4_state_set_mode_locked(struct nfs4_state *, mode_t);
215 extern void nfs4_schedule_state_recovery(struct nfs_client *);
216 extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
217 extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
218 extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t);
219 
220 extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter);
221 extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
222 extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
223 extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
224 extern void nfs_free_seqid(struct nfs_seqid *seqid);
225 
226 extern const nfs4_stateid zero_stateid;
227 
228 /* nfs4xdr.c */
229 extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
230 extern struct rpc_procinfo nfs4_procedures[];
231 
232 struct nfs4_mount_data;
233 
234 /* callback_xdr.c */
235 extern struct svc_version nfs4_callback_version1;
236 
237 #else
238 
239 #define nfs4_close_state(a, b, c) do { } while (0)
240 #define nfs4_close_sync(a, b, c) do { } while (0)
241 
242 #endif /* CONFIG_NFS_V4 */
243 #endif /* __LINUX_FS_NFS_NFS4_FS.H */
244