blob: d1c229feed52c129402655ad32f294054f296206 [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
J. Bruce Fieldsacb28872012-03-27 14:50:26 -0400153struct nfsd4_cb_sec {
J. Bruce Fields12fc3e92012-11-05 16:01:48 -0500154 u32 flavor; /* (u32)(-1) used to mean "no valid flavor" */
J. Bruce Fieldsacb28872012-03-27 14:50:26 -0400155 u32 uid;
156 u32 gid;
157};
158
Andy Adamson49557cc2009-07-23 19:02:16 -0400159struct nfsd4_create_session {
160 clientid_t clientid;
161 struct nfs4_sessionid sessionid;
162 u32 seqid;
163 u32 flags;
164 struct nfsd4_channel_attrs fore_channel;
165 struct nfsd4_channel_attrs back_channel;
166 u32 callback_prog;
J. Bruce Fieldsacb28872012-03-27 14:50:26 -0400167 struct nfsd4_cb_sec cb_sec;
Andy Adamson49557cc2009-07-23 19:02:16 -0400168};
169
J. Bruce Fieldscb73a9f2012-11-01 18:09:48 -0400170struct nfsd4_backchannel_ctl {
171 u32 bc_cb_program;
172 struct nfsd4_cb_sec bc_cb_sec;
173};
174
J. Bruce Fields1d1bc8f2010-10-04 23:12:59 -0400175struct nfsd4_bind_conn_to_session {
176 struct nfs4_sessionid sessionid;
177 u32 dir;
178};
179
Andy Adamson49557cc2009-07-23 19:02:16 -0400180/* The single slot clientid cache structure */
181struct nfsd4_clid_slot {
182 u32 sl_seqid;
183 __be32 sl_status;
184 struct nfsd4_create_session sl_cr_ses;
185};
186
J. Bruce Fieldsc7662512010-06-06 18:12:14 -0400187struct nfsd4_conn {
188 struct list_head cn_persession;
189 struct svc_xprt *cn_xprt;
J. Bruce Fields19cf5c02010-06-06 18:37:16 -0400190 struct svc_xpt_user cn_xpt_user;
191 struct nfsd4_session *cn_session;
J. Bruce Fieldsc7662512010-06-06 18:12:14 -0400192/* CDFC4_FORE, CDFC4_BACK: */
193 unsigned char cn_flags;
194};
195
Andy Adamson7116ed62009-04-03 08:27:43 +0300196struct nfsd4_session {
197 struct kref se_ref;
198 struct list_head se_hash; /* hash by sessionid */
199 struct list_head se_perclnt;
200 u32 se_flags;
Benny Halevy07cd4902010-05-12 00:13:41 +0300201 struct nfs4_client *se_client;
Andy Adamson7116ed62009-04-03 08:27:43 +0300202 struct nfs4_sessionid se_sessionid;
Alexandros Batsakis6c18ba92009-06-16 04:19:13 +0300203 struct nfsd4_channel_attrs se_fchannel;
204 struct nfsd4_channel_attrs se_bchannel;
J. Bruce Fieldsacb28872012-03-27 14:50:26 -0400205 struct nfsd4_cb_sec se_cb_sec;
J. Bruce Fieldsc7662512010-06-06 18:12:14 -0400206 struct list_head se_conns;
J. Bruce Fields8b5ce5c2010-10-19 17:31:50 -0400207 u32 se_cb_prog;
J. Bruce Fieldsac7c46f2010-06-14 19:01:57 -0400208 u32 se_cb_seq_nr;
Andy Adamson557ce262009-08-28 08:45:04 -0400209 struct nfsd4_slot *se_slots[]; /* forward channel slots */
Andy Adamson7116ed62009-04-03 08:27:43 +0300210};
211
Benny Halevy508dc6e2012-02-23 17:40:52 -0800212extern void nfsd4_put_session(struct nfsd4_session *ses);
Andy Adamson7116ed62009-04-03 08:27:43 +0300213
Marc Eshel5282fd72009-04-03 08:27:52 +0300214/* formatted contents of nfs4_sessionid */
215struct nfsd4_sessionid {
216 clientid_t clientid;
217 u32 sequence;
218 u32 reserved;
219};
220
NeilBrowna55370a2005-06-23 22:03:52 -0700221#define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
222
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223/*
224 * struct nfs4_client - one per client. Clientids live here.
225 * o Each nfs4_client is hashed by clientid.
226 *
227 * o Each nfs4_clients is also hashed by name
228 * (the opaque quantity initially sent by the client to identify itself).
229 *
230 * o cl_perclient list is used to ensure no dangling stateowner references
231 * when we expire the nfs4_client
232 */
233struct nfs4_client {
234 struct list_head cl_idhash; /* hash by cl_clientid.id */
Jeff Laytonac55fdc2012-11-12 15:00:56 -0500235 struct rb_node cl_namenode; /* link into by-name trees */
NeilBrownea1da632005-06-23 22:04:17 -0700236 struct list_head cl_openowners;
J. Bruce Fields38c2f4b2011-09-23 17:01:19 -0400237 struct idr cl_stateids; /* stateid lookup */
NeilBrownea1da632005-06-23 22:04:17 -0700238 struct list_head cl_delegations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 struct list_head cl_lru; /* tail queue */
240 struct xdr_netobj cl_name; /* id generated by client */
241 nfs4_verifier cl_verifier; /* generated by client */
242 time_t cl_time; /* time of last lease renewal */
Jeff Layton363168b2009-08-14 12:57:56 -0400243 struct sockaddr_storage cl_addr; /* client ipaddress */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 struct svc_cred cl_cred; /* setclientid principal */
245 clientid_t cl_clientid; /* generated by server */
246 nfs4_verifier cl_confirm; /* generated by server */
J. Bruce Fields8323c3b2010-10-19 19:36:51 -0400247 u32 cl_minorversion;
Marc Eshel9fb87072009-04-03 08:27:46 +0300248
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500249 /* for v4.0 and v4.1 callbacks: */
250 struct nfs4_cb_conn cl_cb_conn;
Jeff Laytona52d7262012-03-21 09:52:02 -0400251#define NFSD4_CLIENT_CB_UPDATE (0)
252#define NFSD4_CLIENT_CB_KILL (1)
253#define NFSD4_CLIENT_STABLE (2) /* client on stable storage */
254#define NFSD4_CLIENT_RECLAIM_COMPLETE (3) /* reclaim_complete done */
Jeff Laytonac55fdc2012-11-12 15:00:56 -0500255#define NFSD4_CLIENT_CONFIRMED (4) /* client is confirmed */
Jeff Laytona52d7262012-03-21 09:52:02 -0400256#define NFSD4_CLIENT_CB_FLAG_MASK (1 << NFSD4_CLIENT_CB_UPDATE | \
257 1 << NFSD4_CLIENT_CB_KILL)
258 unsigned long cl_flags;
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -0400259 struct rpc_cred *cl_cb_cred;
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500260 struct rpc_clnt *cl_cb_client;
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400261 u32 cl_cb_ident;
J. Bruce Fields77a35692010-04-30 18:51:44 -0400262#define NFSD4_CB_UP 0
263#define NFSD4_CB_UNKNOWN 1
264#define NFSD4_CB_DOWN 2
Benny Halevy54237322011-10-19 19:12:58 -0700265#define NFSD4_CB_FAULT 3
J. Bruce Fields77a35692010-04-30 18:51:44 -0400266 int cl_cb_state;
J. Bruce Fieldscee277d2010-05-26 17:52:14 -0400267 struct nfsd4_callback cl_cb_null;
J. Bruce Fieldsedd76782010-06-14 22:26:31 -0400268 struct nfsd4_session *cl_cb_session;
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -0500269 struct list_head cl_callbacks; /* list of in-progress callbacks */
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500270
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400271 /* for all client information that callback code might need: */
272 spinlock_t cl_lock;
273
Marc Eshel9fb87072009-04-03 08:27:46 +0300274 /* for nfs41 */
275 struct list_head cl_sessions;
Andy Adamson49557cc2009-07-23 19:02:16 -0400276 struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
Andy Adamson0733d212009-04-03 08:28:01 +0300277 u32 cl_exchange_flags;
Benny Halevy46583e22010-05-12 00:13:29 +0300278 /* number of rpc's in progress over an associated session: */
279 atomic_t cl_refcount;
Andy Adamson38524ab2009-09-10 12:25:59 +0300280
281 /* for nfs41 callbacks */
Ricardo Labiaga199ff352009-09-10 12:26:25 +0300282 /* We currently support a single back channel with a single slot */
283 unsigned long cl_cb_slot_busy;
Ricardo Labiaga199ff352009-09-10 12:26:25 +0300284 struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */
285 /* wait here for slots */
Stanislav Kinsburskyc212cec2012-11-14 18:21:10 +0300286 struct net *net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287};
288
Benny Halevy07cd4902010-05-12 00:13:41 +0300289static inline void
290mark_client_expired(struct nfs4_client *clp)
291{
292 clp->cl_time = 0;
293}
294
295static inline bool
296is_client_expired(struct nfs4_client *clp)
297{
298 return clp->cl_time == 0;
299}
300
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301/* struct nfs4_client_reset
302 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
303 * upon lease reset, or from upcall to state_daemon (to read in state
304 * from non-volitile storage) upon reboot.
305 */
306struct nfs4_client_reclaim {
307 struct list_head cr_strhash; /* hash by cr_name */
Jeff Layton0ce0c2b2012-11-12 15:00:55 -0500308 struct nfs4_client *cr_clp; /* pointer to associated clp */
NeilBrowna55370a2005-06-23 22:03:52 -0700309 char cr_recdir[HEXDIR_LEN]; /* recover dir */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310};
311
312static inline void
313update_stateid(stateid_t *stateid)
314{
315 stateid->si_generation++;
J. Bruce Fields81b82962011-08-23 11:03:29 -0400316 /* Wraparound recommendation from 3530bis-13 9.1.3.2: */
317 if (stateid->si_generation == 0)
318 stateid->si_generation = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319}
320
321/* A reasonable value for REPLAY_ISIZE was estimated as follows:
322 * The OPEN response, typically the largest, requires
323 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
324 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
325 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
326 */
327
328#define NFSD4_REPLAY_ISIZE 112
329
330/*
331 * Replay buffer, where the result of the last seqid-mutating operation
332 * is cached.
333 */
334struct nfs4_replay {
Al Virob37ad282006-10-19 23:28:59 -0700335 __be32 rp_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 unsigned int rp_buflen;
337 char *rp_buf;
J. Bruce Fieldsa4773c082009-02-02 17:23:10 -0500338 struct knfsd_fh rp_openfh;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 char rp_ibuf[NFSD4_REPLAY_ISIZE];
340};
341
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342struct nfs4_stateowner {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 struct list_head so_strhash; /* hash by op_name */
NeilBrownea1da632005-06-23 22:04:17 -0700344 struct list_head so_stateids;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 struct nfs4_client * so_client;
NeilBrown7fb64ce2005-07-07 17:59:20 -0700346 /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
347 * sequence id expected from the client: */
348 u32 so_seqid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 struct xdr_netobj so_owner; /* open owner name */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 struct nfs4_replay so_replay;
J. Bruce Fields3557e432011-10-12 16:58:21 -0400351 bool so_is_open_owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352};
353
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400354struct nfs4_openowner {
355 struct nfs4_stateowner oo_owner; /* must be first field */
356 struct list_head oo_perclient;
J. Bruce Fieldsb31b30e2011-09-28 11:47:20 -0400357 /*
358 * We keep around openowners a little while after last close,
359 * which saves clients from having to confirm, and allows us to
360 * handle close replays if they come soon enough. The close_lru
361 * is a list of such openowners, to be reaped by the laundromat
362 * thread eventually if they remain unused:
363 */
364 struct list_head oo_close_lru;
J. Bruce Fields38c387b2011-09-16 17:42:48 -0400365 struct nfs4_ol_stateid *oo_last_closed_stid;
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400366 time_t oo_time; /* time of placement on so_close_lru */
J. Bruce Fieldsdad1c062011-09-12 12:24:13 -0400367#define NFS4_OO_CONFIRMED 1
J. Bruce Fields38c387b2011-09-16 17:42:48 -0400368#define NFS4_OO_PURGE_CLOSE 2
J. Bruce Fieldsd29b20c2011-10-13 15:12:59 -0400369#define NFS4_OO_NEW 4
J. Bruce Fieldsdad1c062011-09-12 12:24:13 -0400370 unsigned char oo_flags;
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400371};
372
373struct nfs4_lockowner {
374 struct nfs4_stateowner lo_owner; /* must be first element */
J. Bruce Fields009673b2011-11-07 17:40:10 -0500375 struct list_head lo_owner_ino_hash; /* hash by owner,file */
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400376 struct list_head lo_perstateid; /* for lockowners only */
377 struct list_head lo_list; /* for temporary uses */
378};
379
380static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
381{
382 return container_of(so, struct nfs4_openowner, oo_owner);
383}
384
385static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
386{
387 return container_of(so, struct nfs4_lockowner, lo_owner);
388}
389
Jeff Layton1696c472012-08-06 11:00:27 -0400390/* nfs4_file: a file opened by some number of (open) nfs4_stateowners. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391struct nfs4_file {
J. Bruce Fields8b671b82009-02-22 14:51:34 -0800392 atomic_t fi_ref;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 struct list_head fi_hash; /* hash by "struct inode *" */
NeilBrown8beefa22005-06-23 22:03:08 -0700394 struct list_head fi_stateids;
395 struct list_head fi_delegations;
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400396 /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
397 struct file * fi_fds[3];
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400398 /*
J. Bruce Fields6409a5a2011-09-28 11:37:56 -0400399 * Each open or lock stateid contributes 0-4 to the counts
400 * below depending on which bits are set in st_access_bitmap:
401 * 1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
402 * + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
403 * + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400404 */
J. Bruce Fields9ae78bc2011-03-17 12:52:33 -0400405 atomic_t fi_access[2];
J. Bruce Fieldsacfdf5c2011-01-31 19:20:39 -0500406 struct file *fi_deleg_file;
407 struct file_lock *fi_lease;
408 atomic_t fi_delegees;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 struct inode *fi_inode;
Meelap Shah47f99402007-07-17 04:04:40 -0700410 bool fi_had_conflict;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411};
412
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400413/* XXX: for first cut may fall back on returning file that doesn't work
414 * at all? */
415static inline struct file *find_writeable_file(struct nfs4_file *f)
416{
J. Bruce Fields7d947842010-08-20 18:09:31 -0400417 if (f->fi_fds[O_WRONLY])
418 return f->fi_fds[O_WRONLY];
419 return f->fi_fds[O_RDWR];
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400420}
421
422static inline struct file *find_readable_file(struct nfs4_file *f)
423{
J. Bruce Fields7d947842010-08-20 18:09:31 -0400424 if (f->fi_fds[O_RDONLY])
425 return f->fi_fds[O_RDONLY];
426 return f->fi_fds[O_RDWR];
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400427}
428
429static inline struct file *find_any_file(struct nfs4_file *f)
430{
431 if (f->fi_fds[O_RDWR])
432 return f->fi_fds[O_RDWR];
J. Bruce Fields18608ad2010-08-20 18:06:26 -0400433 else if (f->fi_fds[O_WRONLY])
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400434 return f->fi_fds[O_WRONLY];
435 else
436 return f->fi_fds[O_RDONLY];
437}
438
J. Bruce Fieldsd5477a82011-09-08 12:07:44 -0400439/* "ol" stands for "Open or Lock". Better suggestions welcome. */
J. Bruce Fieldsdcef0412011-09-07 16:06:42 -0400440struct nfs4_ol_stateid {
J. Bruce Fields996e0932011-10-17 11:14:48 -0400441 struct nfs4_stid st_stid; /* must be first field */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 struct list_head st_perfile;
NeilBrownea1da632005-06-23 22:04:17 -0700443 struct list_head st_perstateowner;
444 struct list_head st_lockowners;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 struct nfs4_stateowner * st_stateowner;
446 struct nfs4_file * st_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 unsigned long st_access_bmap;
448 unsigned long st_deny_bmap;
J. Bruce Fieldsdcef0412011-09-07 16:06:42 -0400449 struct nfs4_ol_stateid * st_openstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450};
451
J. Bruce Fieldsdcef0412011-09-07 16:06:42 -0400452static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
453{
454 return container_of(s, struct nfs4_ol_stateid, st_stid);
455}
456
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457/* flags for preprocess_seqid_op() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458#define RD_STATE 0x00000010
459#define WR_STATE 0x00000020
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
Benny Halevydd453df2009-04-03 08:28:41 +0300461struct nfsd4_compound_state;
Stanislav Kinsbursky2c142ba2012-07-25 16:57:45 +0400462struct nfsd_net;
Benny Halevydd453df2009-04-03 08:28:41 +0300463
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400464extern __be32 nfs4_preprocess_stateid_op(struct net *net,
465 struct nfsd4_compound_state *cstate,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 stateid_t *stateid, int flags, struct file **filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467extern void nfs4_lock_state(void);
468extern void nfs4_unlock_state(void);
Stanislav Kinsbursky52e19c02012-11-14 18:21:16 +0300469void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *);
470extern void nfs4_release_reclaim(struct nfsd_net *);
471extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(const char *recdir,
472 struct nfsd_net *nn);
Stanislav Kinsbursky3320fef192012-11-14 18:22:07 +0300473extern __be32 nfs4_check_open_reclaim(clientid_t *clid, bool sessions, struct nfsd_net *nn);
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400474extern void nfs4_free_openowner(struct nfs4_openowner *);
475extern void nfs4_free_lockowner(struct nfs4_lockowner *);
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400476extern int set_callback_cred(void);
J. Bruce Fields57725152012-11-05 15:10:26 -0500477extern void nfsd4_init_callback(struct nfsd4_callback *);
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400478extern void nfsd4_probe_callback(struct nfs4_client *clp);
J. Bruce Fields84f5f7c2010-12-09 15:52:19 -0500479extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400480extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500482extern int nfsd4_create_callback_queue(void);
483extern void nfsd4_destroy_callback_queue(void);
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400484extern void nfsd4_shutdown_callback(struct nfs4_client *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485extern void nfs4_put_delegation(struct nfs4_delegation *dp);
Stanislav Kinsbursky52e19c02012-11-14 18:21:16 +0300486extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(const char *name,
487 struct nfsd_net *nn);
488extern bool nfs4_has_reclaimed_state(const char *name, struct nfsd_net *nn);
Benny Halevyd7682982010-05-12 00:13:54 +0300489extern void release_session_client(struct nfsd4_session *);
J. Bruce Fields38c387b2011-09-16 17:42:48 -0400490extern void nfsd4_purge_closed_stateid(struct nfs4_stateowner *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491
Jeff Layton2a4317c2012-03-21 16:42:43 -0400492/* nfs4recover operations */
493extern int nfsd4_client_tracking_init(struct net *net);
494extern void nfsd4_client_tracking_exit(struct net *net);
495extern void nfsd4_client_record_create(struct nfs4_client *clp);
496extern void nfsd4_client_record_remove(struct nfs4_client *clp);
497extern int nfsd4_client_record_check(struct nfs4_client *clp);
Stanislav Kinsbursky12760c62012-11-14 18:22:12 +0300498extern void nfsd4_record_grace_done(struct nfsd_net *nn, time_t boot_time);
Bryan Schumakerf3c75212012-11-27 09:35:10 -0500499
500/* nfs fault injection functions */
501#ifdef CONFIG_NFSD_FAULT_INJECTION
502int nfsd_fault_inject_init(void);
503void nfsd_fault_inject_cleanup(void);
Bryan Schumaker8ce54e02012-11-29 11:40:43 -0500504u64 nfsd_for_n_state(u64, u64 (*)(struct nfs4_client *, u64));
Bryan Schumaker6c1e82a2012-11-29 11:40:46 -0500505struct nfs4_client *nfsd_find_client(struct sockaddr_storage *, size_t);
Bryan Schumaker8ce54e02012-11-29 11:40:43 -0500506
507u64 nfsd_forget_client(struct nfs4_client *, u64);
508u64 nfsd_forget_client_locks(struct nfs4_client*, u64);
509u64 nfsd_forget_client_openowners(struct nfs4_client *, u64);
510u64 nfsd_forget_client_delegations(struct nfs4_client *, u64);
511u64 nfsd_recall_client_delegations(struct nfs4_client *, u64);
Bryan Schumaker184c1842012-11-29 11:40:44 -0500512
513u64 nfsd_print_client(struct nfs4_client *, u64);
514u64 nfsd_print_client_locks(struct nfs4_client *, u64);
515u64 nfsd_print_client_openowners(struct nfs4_client *, u64);
516u64 nfsd_print_client_delegations(struct nfs4_client *, u64);
Bryan Schumakerf3c75212012-11-27 09:35:10 -0500517#else /* CONFIG_NFSD_FAULT_INJECTION */
518static inline int nfsd_fault_inject_init(void) { return 0; }
519static inline void nfsd_fault_inject_cleanup(void) {}
520#endif /* CONFIG_NFSD_FAULT_INJECTION */
521
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522#endif /* NFSD4_STATE_H */