blob: 89ab137d379a3f6756b5b5616083862e8f22d88f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * Copyright (c) 2001 The Regents of the University of Michigan.
3 * All rights reserved.
4 *
5 * Kendrick Smith <kmsmith@umich.edu>
6 * Andy Adamson <andros@umich.edu>
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the University nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
22 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
28 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 *
33 */
34
35#ifndef _NFSD4_STATE_H
36#define _NFSD4_STATE_H
37
J. Bruce Fields38c2f4b2011-09-23 17:01:19 -040038#include <linux/idr.h>
J. Bruce Fields19cf5c02010-06-06 18:37:16 -040039#include <linux/sunrpc/svc_xprt.h>
Boaz Harrosh72579ac2009-12-03 20:28:59 +020040#include <linux/nfsd/nfsfh.h>
J. Bruce Fields1557aca2009-12-04 19:36:06 -050041#include "nfsfh.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Linus Torvalds1da177e2005-04-16 15:20:36 -070043typedef struct {
44 u32 cl_boot;
45 u32 cl_id;
46} clientid_t;
47
48typedef struct {
J. Bruce Fieldsd3b313a2011-09-15 15:02:41 -040049 clientid_t so_clid;
50 u32 so_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051} stateid_opaque_t;
52
53typedef struct {
54 u32 si_generation;
55 stateid_opaque_t si_opaque;
56} stateid_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
Benny Halevy8c10cbd2009-10-19 12:04:53 +020058#define STATEID_FMT "(%08x/%08x/%08x/%08x)"
59#define STATEID_VAL(s) \
J. Bruce Fieldsd3b313a2011-09-15 15:02:41 -040060 (s)->si_opaque.so_clid.cl_boot, \
61 (s)->si_opaque.so_clid.cl_id, \
62 (s)->si_opaque.so_id, \
Benny Halevy8c10cbd2009-10-19 12:04:53 +020063 (s)->si_generation
64
J. Bruce Fields227f98d92010-02-18 08:27:24 -080065struct nfsd4_callback {
J. Bruce Fieldsfb003922010-05-31 18:21:37 -040066 void *cb_op;
67 struct nfs4_client *cb_clp;
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -050068 struct list_head cb_per_client;
J. Bruce Fieldsfb003922010-05-31 18:21:37 -040069 u32 cb_minorversion;
J. Bruce Fields58784532010-05-16 16:47:08 -040070 struct rpc_message cb_msg;
71 const struct rpc_call_ops *cb_ops;
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -050072 struct work_struct cb_work;
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -050073 bool cb_done;
J. Bruce Fields227f98d92010-02-18 08:27:24 -080074};
75
J. Bruce Fieldsd5477a82011-09-08 12:07:44 -040076struct nfs4_stid {
77#define NFS4_OPEN_STID 1
78#define NFS4_LOCK_STID 2
79#define NFS4_DELEG_STID 4
J. Bruce Fieldsf7a4d872011-09-16 20:12:38 -040080/* For an open stateid kept around *only* to process close replays: */
81#define NFS4_CLOSED_STID 8
82 unsigned char sc_type;
J. Bruce Fieldsd5477a82011-09-08 12:07:44 -040083 stateid_t sc_stateid;
J. Bruce Fields2a74aba2011-09-23 17:20:02 -040084 struct nfs4_client *sc_client;
J. Bruce Fieldsd5477a82011-09-08 12:07:44 -040085};
86
Linus Torvalds1da177e2005-04-16 15:20:36 -070087struct nfs4_delegation {
J. Bruce Fields996e0932011-10-17 11:14:48 -040088 struct nfs4_stid dl_stid; /* must be first field */
NeilBrownea1da632005-06-23 22:04:17 -070089 struct list_head dl_perfile;
90 struct list_head dl_perclnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 struct list_head dl_recall_lru; /* delegation recalled */
92 atomic_t dl_count; /* ref count */
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 struct nfs4_file *dl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 u32 dl_type;
95 time_t dl_time;
J. Bruce Fieldsb53d40c2009-05-01 19:50:00 -040096/* For recall: */
J. Bruce Fieldsb53d40c2009-05-01 19:50:00 -040097 struct knfsd_fh dl_fh;
J. Bruce Fields3aea09d2009-05-01 20:11:12 -040098 int dl_retries;
J. Bruce Fields227f98d92010-02-18 08:27:24 -080099 struct nfsd4_callback dl_recall;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100};
101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102/* client delegation callback info */
J. Bruce Fieldsc237dc02009-04-29 19:09:19 -0400103struct nfs4_cb_conn {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 /* SETCLIENTID info */
Jeff Laytonaa9a4ec2009-08-14 12:57:57 -0400105 struct sockaddr_storage cb_addr;
Takuma Umeya6f3d7722010-12-15 14:09:01 +0900106 struct sockaddr_storage cb_saddr;
Jeff Laytonaa9a4ec2009-08-14 12:57:57 -0400107 size_t cb_addrlen;
J. Bruce Fields8b5ce5c2010-10-19 17:31:50 -0400108 u32 cb_prog; /* used only in 4.0 case;
109 per-session otherwise */
Andy Adamsonab52ae62009-06-16 04:20:53 +0300110 u32 cb_ident; /* minorversion 0 only */
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500111 struct svc_xprt *cb_xprt; /* minorversion 1 only */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112};
113
J. Bruce Fieldsf459e452011-09-09 09:06:12 -0400114static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
115{
116 return container_of(s, struct nfs4_delegation, dl_stid);
117}
118
Andy Adamsona6496372009-08-28 08:45:01 -0400119/* Maximum number of slots per session. 160 is useful for long haul TCP */
120#define NFSD_MAX_SLOTS_PER_SESSION 160
Andy Adamsonec6b5d72009-04-03 08:28:28 +0300121/* Maximum number of operations per session compound */
122#define NFSD_MAX_OPS_PER_COMPOUND 16
Andy Adamson557ce262009-08-28 08:45:04 -0400123/* Maximum session per slot cache size */
124#define NFSD_SLOT_CACHE_SIZE 1024
Andy Adamsona6496372009-08-28 08:45:01 -0400125/* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
126#define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32
127#define NFSD_MAX_MEM_PER_SESSION \
128 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
Andy Adamson074fe892009-04-03 08:28:15 +0300129
Andy Adamson7116ed62009-04-03 08:27:43 +0300130struct nfsd4_slot {
Andy Adamson557ce262009-08-28 08:45:04 -0400131 u32 sl_seqid;
132 __be32 sl_status;
133 u32 sl_datalen;
J. Bruce Fields73e79482012-02-13 16:39:00 -0500134 u16 sl_opcnt;
135#define NFSD4_SLOT_INUSE (1 << 0)
136#define NFSD4_SLOT_CACHETHIS (1 << 1)
J. Bruce Fieldsbf5c43c2012-02-13 16:56:19 -0500137#define NFSD4_SLOT_INITIALIZED (1 << 2)
J. Bruce Fields73e79482012-02-13 16:39:00 -0500138 u8 sl_flags;
Andy Adamson557ce262009-08-28 08:45:04 -0400139 char sl_data[];
Andy Adamson7116ed62009-04-03 08:27:43 +0300140};
141
Alexandros Batsakis6c18ba92009-06-16 04:19:13 +0300142struct nfsd4_channel_attrs {
143 u32 headerpadsz;
144 u32 maxreq_sz;
145 u32 maxresp_sz;
146 u32 maxresp_cached;
147 u32 maxops;
148 u32 maxreqs;
149 u32 nr_rdma_attrs;
150 u32 rdma_attrs;
151};
152
Andy Adamson49557cc2009-07-23 19:02:16 -0400153struct nfsd4_create_session {
154 clientid_t clientid;
155 struct nfs4_sessionid sessionid;
156 u32 seqid;
157 u32 flags;
158 struct nfsd4_channel_attrs fore_channel;
159 struct nfsd4_channel_attrs back_channel;
160 u32 callback_prog;
161 u32 uid;
162 u32 gid;
163};
164
J. Bruce Fields1d1bc8f2010-10-04 23:12:59 -0400165struct nfsd4_bind_conn_to_session {
166 struct nfs4_sessionid sessionid;
167 u32 dir;
168};
169
Andy Adamson49557cc2009-07-23 19:02:16 -0400170/* The single slot clientid cache structure */
171struct nfsd4_clid_slot {
172 u32 sl_seqid;
173 __be32 sl_status;
174 struct nfsd4_create_session sl_cr_ses;
175};
176
J. Bruce Fieldsc7662512010-06-06 18:12:14 -0400177struct nfsd4_conn {
178 struct list_head cn_persession;
179 struct svc_xprt *cn_xprt;
J. Bruce Fields19cf5c02010-06-06 18:37:16 -0400180 struct svc_xpt_user cn_xpt_user;
181 struct nfsd4_session *cn_session;
J. Bruce Fieldsc7662512010-06-06 18:12:14 -0400182/* CDFC4_FORE, CDFC4_BACK: */
183 unsigned char cn_flags;
184};
185
Andy Adamson7116ed62009-04-03 08:27:43 +0300186struct nfsd4_session {
187 struct kref se_ref;
188 struct list_head se_hash; /* hash by sessionid */
189 struct list_head se_perclnt;
190 u32 se_flags;
Benny Halevy07cd4902010-05-12 00:13:41 +0300191 struct nfs4_client *se_client;
Andy Adamson7116ed62009-04-03 08:27:43 +0300192 struct nfs4_sessionid se_sessionid;
Alexandros Batsakis6c18ba92009-06-16 04:19:13 +0300193 struct nfsd4_channel_attrs se_fchannel;
194 struct nfsd4_channel_attrs se_bchannel;
J. Bruce Fieldsc7662512010-06-06 18:12:14 -0400195 struct list_head se_conns;
J. Bruce Fields8b5ce5c2010-10-19 17:31:50 -0400196 u32 se_cb_prog;
J. Bruce Fieldsac7c46f2010-06-14 19:01:57 -0400197 u32 se_cb_seq_nr;
Andy Adamson557ce262009-08-28 08:45:04 -0400198 struct nfsd4_slot *se_slots[]; /* forward channel slots */
Andy Adamson7116ed62009-04-03 08:27:43 +0300199};
200
Benny Halevy508dc6e2012-02-23 17:40:52 -0800201extern void nfsd4_put_session(struct nfsd4_session *ses);
Andy Adamson7116ed62009-04-03 08:27:43 +0300202
Marc Eshel5282fd72009-04-03 08:27:52 +0300203/* formatted contents of nfs4_sessionid */
204struct nfsd4_sessionid {
205 clientid_t clientid;
206 u32 sequence;
207 u32 reserved;
208};
209
NeilBrowna55370a2005-06-23 22:03:52 -0700210#define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
211
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212/*
213 * struct nfs4_client - one per client. Clientids live here.
214 * o Each nfs4_client is hashed by clientid.
215 *
216 * o Each nfs4_clients is also hashed by name
217 * (the opaque quantity initially sent by the client to identify itself).
218 *
219 * o cl_perclient list is used to ensure no dangling stateowner references
220 * when we expire the nfs4_client
221 */
222struct nfs4_client {
223 struct list_head cl_idhash; /* hash by cl_clientid.id */
224 struct list_head cl_strhash; /* hash by cl_name */
NeilBrownea1da632005-06-23 22:04:17 -0700225 struct list_head cl_openowners;
J. Bruce Fields38c2f4b2011-09-23 17:01:19 -0400226 struct idr cl_stateids; /* stateid lookup */
NeilBrownea1da632005-06-23 22:04:17 -0700227 struct list_head cl_delegations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 struct list_head cl_lru; /* tail queue */
229 struct xdr_netobj cl_name; /* id generated by client */
NeilBrowna55370a2005-06-23 22:03:52 -0700230 char cl_recdir[HEXDIR_LEN]; /* recovery dir */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 nfs4_verifier cl_verifier; /* generated by client */
232 time_t cl_time; /* time of last lease renewal */
Jeff Layton363168b2009-08-14 12:57:56 -0400233 struct sockaddr_storage cl_addr; /* client ipaddress */
Olga Kornievskaia61054b12008-12-23 16:19:00 -0500234 u32 cl_flavor; /* setclientid pseudoflavor */
Olga Kornievskaia68e76ad2008-12-23 16:17:15 -0500235 char *cl_principal; /* setclientid principal name */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 struct svc_cred cl_cred; /* setclientid principal */
237 clientid_t cl_clientid; /* generated by server */
238 nfs4_verifier cl_confirm; /* generated by server */
J. Bruce Fields8323c3b2010-10-19 19:36:51 -0400239 u32 cl_minorversion;
Marc Eshel9fb87072009-04-03 08:27:46 +0300240
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500241 /* for v4.0 and v4.1 callbacks: */
242 struct nfs4_cb_conn cl_cb_conn;
Jeff Laytona52d7262012-03-21 09:52:02 -0400243#define NFSD4_CLIENT_CB_UPDATE (0)
244#define NFSD4_CLIENT_CB_KILL (1)
245#define NFSD4_CLIENT_STABLE (2) /* client on stable storage */
246#define NFSD4_CLIENT_RECLAIM_COMPLETE (3) /* reclaim_complete done */
247#define NFSD4_CLIENT_CB_FLAG_MASK (1 << NFSD4_CLIENT_CB_UPDATE | \
248 1 << NFSD4_CLIENT_CB_KILL)
249 unsigned long cl_flags;
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500250 struct rpc_clnt *cl_cb_client;
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400251 u32 cl_cb_ident;
J. Bruce Fields77a35692010-04-30 18:51:44 -0400252#define NFSD4_CB_UP 0
253#define NFSD4_CB_UNKNOWN 1
254#define NFSD4_CB_DOWN 2
Benny Halevy54237322011-10-19 19:12:58 -0700255#define NFSD4_CB_FAULT 3
J. Bruce Fields77a35692010-04-30 18:51:44 -0400256 int cl_cb_state;
J. Bruce Fieldscee277d2010-05-26 17:52:14 -0400257 struct nfsd4_callback cl_cb_null;
J. Bruce Fieldsedd76782010-06-14 22:26:31 -0400258 struct nfsd4_session *cl_cb_session;
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -0500259 struct list_head cl_callbacks; /* list of in-progress callbacks */
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500260
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400261 /* for all client information that callback code might need: */
262 spinlock_t cl_lock;
263
Marc Eshel9fb87072009-04-03 08:27:46 +0300264 /* for nfs41 */
265 struct list_head cl_sessions;
Andy Adamson49557cc2009-07-23 19:02:16 -0400266 struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
Andy Adamson0733d212009-04-03 08:28:01 +0300267 u32 cl_exchange_flags;
Benny Halevy46583e22010-05-12 00:13:29 +0300268 /* number of rpc's in progress over an associated session: */
269 atomic_t cl_refcount;
Andy Adamson38524ab2009-09-10 12:25:59 +0300270
271 /* for nfs41 callbacks */
Ricardo Labiaga199ff352009-09-10 12:26:25 +0300272 /* We currently support a single back channel with a single slot */
273 unsigned long cl_cb_slot_busy;
Ricardo Labiaga199ff352009-09-10 12:26:25 +0300274 struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */
275 /* wait here for slots */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276};
277
Benny Halevy07cd4902010-05-12 00:13:41 +0300278static inline void
279mark_client_expired(struct nfs4_client *clp)
280{
281 clp->cl_time = 0;
282}
283
284static inline bool
285is_client_expired(struct nfs4_client *clp)
286{
287 return clp->cl_time == 0;
288}
289
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290/* struct nfs4_client_reset
291 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
292 * upon lease reset, or from upcall to state_daemon (to read in state
293 * from non-volitile storage) upon reboot.
294 */
295struct nfs4_client_reclaim {
296 struct list_head cr_strhash; /* hash by cr_name */
NeilBrowna55370a2005-06-23 22:03:52 -0700297 char cr_recdir[HEXDIR_LEN]; /* recover dir */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298};
299
300static inline void
301update_stateid(stateid_t *stateid)
302{
303 stateid->si_generation++;
J. Bruce Fields81b82962011-08-23 11:03:29 -0400304 /* Wraparound recommendation from 3530bis-13 9.1.3.2: */
305 if (stateid->si_generation == 0)
306 stateid->si_generation = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307}
308
309/* A reasonable value for REPLAY_ISIZE was estimated as follows:
310 * The OPEN response, typically the largest, requires
311 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
312 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
313 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
314 */
315
316#define NFSD4_REPLAY_ISIZE 112
317
318/*
319 * Replay buffer, where the result of the last seqid-mutating operation
320 * is cached.
321 */
322struct nfs4_replay {
Al Virob37ad282006-10-19 23:28:59 -0700323 __be32 rp_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 unsigned int rp_buflen;
325 char *rp_buf;
J. Bruce Fieldsa4773c082009-02-02 17:23:10 -0500326 struct knfsd_fh rp_openfh;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 char rp_ibuf[NFSD4_REPLAY_ISIZE];
328};
329
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330struct nfs4_stateowner {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 struct list_head so_strhash; /* hash by op_name */
NeilBrownea1da632005-06-23 22:04:17 -0700332 struct list_head so_stateids;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 struct nfs4_client * so_client;
NeilBrown7fb64ce2005-07-07 17:59:20 -0700334 /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
335 * sequence id expected from the client: */
336 u32 so_seqid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 struct xdr_netobj so_owner; /* open owner name */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 struct nfs4_replay so_replay;
J. Bruce Fields3557e432011-10-12 16:58:21 -0400339 bool so_is_open_owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340};
341
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400342struct nfs4_openowner {
343 struct nfs4_stateowner oo_owner; /* must be first field */
344 struct list_head oo_perclient;
J. Bruce Fieldsb31b30e2011-09-28 11:47:20 -0400345 /*
346 * We keep around openowners a little while after last close,
347 * which saves clients from having to confirm, and allows us to
348 * handle close replays if they come soon enough. The close_lru
349 * is a list of such openowners, to be reaped by the laundromat
350 * thread eventually if they remain unused:
351 */
352 struct list_head oo_close_lru;
J. Bruce Fields38c387b2011-09-16 17:42:48 -0400353 struct nfs4_ol_stateid *oo_last_closed_stid;
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400354 time_t oo_time; /* time of placement on so_close_lru */
J. Bruce Fieldsdad1c062011-09-12 12:24:13 -0400355#define NFS4_OO_CONFIRMED 1
J. Bruce Fields38c387b2011-09-16 17:42:48 -0400356#define NFS4_OO_PURGE_CLOSE 2
J. Bruce Fieldsd29b20c2011-10-13 15:12:59 -0400357#define NFS4_OO_NEW 4
J. Bruce Fieldsdad1c062011-09-12 12:24:13 -0400358 unsigned char oo_flags;
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400359};
360
361struct nfs4_lockowner {
362 struct nfs4_stateowner lo_owner; /* must be first element */
J. Bruce Fields009673b2011-11-07 17:40:10 -0500363 struct list_head lo_owner_ino_hash; /* hash by owner,file */
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400364 struct list_head lo_perstateid; /* for lockowners only */
365 struct list_head lo_list; /* for temporary uses */
366};
367
368static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
369{
370 return container_of(so, struct nfs4_openowner, oo_owner);
371}
372
373static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
374{
375 return container_of(so, struct nfs4_lockowner, lo_owner);
376}
377
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378/*
379* nfs4_file: a file opened by some number of (open) nfs4_stateowners.
380* o fi_perfile list is used to search for conflicting
381* share_acces, share_deny on the file.
382*/
383struct nfs4_file {
J. Bruce Fields8b671b82009-02-22 14:51:34 -0800384 atomic_t fi_ref;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 struct list_head fi_hash; /* hash by "struct inode *" */
NeilBrown8beefa22005-06-23 22:03:08 -0700386 struct list_head fi_stateids;
387 struct list_head fi_delegations;
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400388 /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
389 struct file * fi_fds[3];
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400390 /*
J. Bruce Fields6409a5a2011-09-28 11:37:56 -0400391 * Each open or lock stateid contributes 0-4 to the counts
392 * below depending on which bits are set in st_access_bitmap:
393 * 1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
394 * + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
395 * + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400396 */
J. Bruce Fields9ae78bc2011-03-17 12:52:33 -0400397 atomic_t fi_access[2];
J. Bruce Fieldsacfdf5c2011-01-31 19:20:39 -0500398 struct file *fi_deleg_file;
399 struct file_lock *fi_lease;
400 atomic_t fi_delegees;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 struct inode *fi_inode;
Meelap Shah47f99402007-07-17 04:04:40 -0700402 bool fi_had_conflict;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403};
404
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400405/* XXX: for first cut may fall back on returning file that doesn't work
406 * at all? */
407static inline struct file *find_writeable_file(struct nfs4_file *f)
408{
J. Bruce Fields7d947842010-08-20 18:09:31 -0400409 if (f->fi_fds[O_WRONLY])
410 return f->fi_fds[O_WRONLY];
411 return f->fi_fds[O_RDWR];
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400412}
413
414static inline struct file *find_readable_file(struct nfs4_file *f)
415{
J. Bruce Fields7d947842010-08-20 18:09:31 -0400416 if (f->fi_fds[O_RDONLY])
417 return f->fi_fds[O_RDONLY];
418 return f->fi_fds[O_RDWR];
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400419}
420
421static inline struct file *find_any_file(struct nfs4_file *f)
422{
423 if (f->fi_fds[O_RDWR])
424 return f->fi_fds[O_RDWR];
J. Bruce Fields18608ad2010-08-20 18:06:26 -0400425 else if (f->fi_fds[O_WRONLY])
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400426 return f->fi_fds[O_WRONLY];
427 else
428 return f->fi_fds[O_RDONLY];
429}
430
J. Bruce Fieldsd5477a82011-09-08 12:07:44 -0400431/* "ol" stands for "Open or Lock". Better suggestions welcome. */
J. Bruce Fieldsdcef0412011-09-07 16:06:42 -0400432struct nfs4_ol_stateid {
J. Bruce Fields996e0932011-10-17 11:14:48 -0400433 struct nfs4_stid st_stid; /* must be first field */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 struct list_head st_perfile;
NeilBrownea1da632005-06-23 22:04:17 -0700435 struct list_head st_perstateowner;
436 struct list_head st_lockowners;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 struct nfs4_stateowner * st_stateowner;
438 struct nfs4_file * st_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 unsigned long st_access_bmap;
440 unsigned long st_deny_bmap;
J. Bruce Fieldsdcef0412011-09-07 16:06:42 -0400441 struct nfs4_ol_stateid * st_openstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442};
443
J. Bruce Fieldsdcef0412011-09-07 16:06:42 -0400444static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
445{
446 return container_of(s, struct nfs4_ol_stateid, st_stid);
447}
448
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449/* flags for preprocess_seqid_op() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450#define RD_STATE 0x00000010
451#define WR_STATE 0x00000020
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452
Benny Halevydd453df2009-04-03 08:28:41 +0300453struct nfsd4_compound_state;
454
455extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 stateid_t *stateid, int flags, struct file **filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457extern void nfs4_lock_state(void);
458extern void nfs4_unlock_state(void);
459extern int nfs4_in_grace(void);
Jeff Layton2a4317c2012-03-21 16:42:43 -0400460extern void nfs4_release_reclaim(void);
461extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(struct nfs4_client *crp);
Al Virob37ad282006-10-19 23:28:59 -0700462extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400463extern void nfs4_free_openowner(struct nfs4_openowner *);
464extern void nfs4_free_lockowner(struct nfs4_lockowner *);
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400465extern int set_callback_cred(void);
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400466extern void nfsd4_probe_callback(struct nfs4_client *clp);
J. Bruce Fields84f5f7c2010-12-09 15:52:19 -0500467extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400468extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500469extern void nfsd4_do_callback_rpc(struct work_struct *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500471extern int nfsd4_create_callback_queue(void);
472extern void nfsd4_destroy_callback_queue(void);
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400473extern void nfsd4_shutdown_callback(struct nfs4_client *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474extern void nfs4_put_delegation(struct nfs4_delegation *dp);
Al Virob37ad282006-10-19 23:28:59 -0700475extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
NeilBrown190e4fb2005-06-23 22:04:25 -0700476extern int nfs4_client_to_reclaim(const char *name);
Andy Adamsona1bcecd2009-04-03 08:28:05 +0300477extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
Benny Halevyd7682982010-05-12 00:13:54 +0300478extern void release_session_client(struct nfsd4_session *);
J. Bruce Fields38c2f4b2011-09-23 17:01:19 -0400479extern __be32 nfs4_validate_stateid(struct nfs4_client *, stateid_t *);
J. Bruce Fields38c387b2011-09-16 17:42:48 -0400480extern void nfsd4_purge_closed_stateid(struct nfs4_stateowner *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481
Jeff Layton2a4317c2012-03-21 16:42:43 -0400482/* nfs4recover operations */
483extern int nfsd4_client_tracking_init(struct net *net);
484extern void nfsd4_client_tracking_exit(struct net *net);
485extern void nfsd4_client_record_create(struct nfs4_client *clp);
486extern void nfsd4_client_record_remove(struct nfs4_client *clp);
487extern int nfsd4_client_record_check(struct nfs4_client *clp);
488extern void nfsd4_record_grace_done(struct net *net, time_t boot_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489#endif /* NFSD4_STATE_H */